1/*-
 2 * Copyright (c) 2009 Rui Paulo <rpaulo@FreeBSD.org>
 3 * All rights reserved.
 4 *
 5 * Redistribution and use in source and binary forms, with or without
 6 * modification, are permitted provided that the following conditions
 7 * are met:
 8 * 1. Redistributions of source code must retain the above copyright
 9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
18 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 * POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#ifndef _MACHINE_PMC_MDEP_H_
28#define	_MACHINE_PMC_MDEP_H_
29
30#define	PMC_MDEP_CLASS_INDEX_ARMV8	1
31#define	PMC_MDEP_CLASS_INDEX_DMC620_CD2 2
32#define	PMC_MDEP_CLASS_INDEX_DMC620_C	3
33#define	PMC_MDEP_CLASS_INDEX_CMN600 	4
34/*
35 * On the ARMv8 platform we support the following PMCs.
36 *
37 * ARMV8	ARM Cortex-A53/57/72 processors
38 */
39#include <dev/hwpmc/hwpmc_arm64.h>
40#include <dev/hwpmc/hwpmc_cmn600.h>
41#include <dev/hwpmc/hwpmc_dmc620.h>
42#include <dev/hwpmc/pmu_dmc620_reg.h>
43#include <machine/cmn600_reg.h>
44
45union pmc_md_op_pmcallocate {
46	struct {
47		uint32_t	pm_md_config;
48	};
49	struct pmc_md_cmn600_pmu_op_pmcallocate	pm_cmn600;
50	struct pmc_md_dmc620_pmu_op_pmcallocate	pm_dmc620;
51	uint64_t		__pad[4];
52};
53
54/* Logging */
55#define	PMCLOG_READADDR		PMCLOG_READ64
56#define	PMCLOG_EMITADDR		PMCLOG_EMIT64
57
58#ifdef	_KERNEL
59union pmc_md_pmc {
60	struct pmc_md_arm64_pmc		pm_arm64;
61	struct pmc_md_cmn600_pmc	pm_cmn600;
62	struct pmc_md_dmc620_pmc	pm_dmc620;
63};
64
65#define	PMC_IN_KERNEL_STACK(va)	kstack_contains(curthread, (va), sizeof(va))
66#define	PMC_IN_KERNEL(va)	INKERNEL((va))
67#define	PMC_IN_USERSPACE(va)	((va) <= VM_MAXUSER_ADDRESS)
68#define	PMC_TRAPFRAME_TO_PC(TF)	((TF)->tf_elr)
69#define	PMC_TRAPFRAME_TO_FP(TF)	((TF)->tf_x[29])
70
71/*
72 * Prototypes
73 */
74struct pmc_mdep *pmc_arm64_initialize(void);
75void	pmc_arm64_finalize(struct pmc_mdep *_md);
76
77/* Optional class for CMN-600 controler's PMU. */
78int pmc_cmn600_initialize(struct pmc_mdep *md);
79void	pmc_cmn600_finalize(struct pmc_mdep *_md);
80int pmc_cmn600_nclasses(void);
81
82/* Optional class for DMC-620 controler's PMU. */
83int pmc_dmc620_initialize_cd2(struct pmc_mdep *md);
84void	pmc_dmc620_finalize_cd2(struct pmc_mdep *_md);
85int pmc_dmc620_initialize_c(struct pmc_mdep *md);
86void	pmc_dmc620_finalize_c(struct pmc_mdep *_md);
87int pmc_dmc620_nclasses(void);
88
89#endif /* _KERNEL */
90
91#endif /* !_MACHINE_PMC_MDEP_H_ */