1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2009 Rui Paulo <rpaulo@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $FreeBSD$
29 */
30
31#ifndef _MACHINE_PMC_MDEP_H_
32#define	_MACHINE_PMC_MDEP_H_
33
34#define	PMC_MDEP_CLASS_INDEX_XSCALE	1
35#define	PMC_MDEP_CLASS_INDEX_ARMV7	1
36/*
37 * On the ARM platform we support the following PMCs.
38 *
39 * XSCALE	Intel XScale processors
40 * ARMV7	ARM Cortex-A processors
41 */
42#include <dev/hwpmc/hwpmc_xscale.h>
43#include <dev/hwpmc/hwpmc_armv7.h>
44
45union pmc_md_op_pmcallocate {
46	uint64_t	__pad[4];
47};
48
49/* Logging */
50#define	PMCLOG_READADDR		PMCLOG_READ32
51#define	PMCLOG_EMITADDR		PMCLOG_EMIT32
52
53#ifdef	_KERNEL
54union pmc_md_pmc {
55	struct pmc_md_xscale_pmc	pm_xscale;
56	struct pmc_md_armv7_pmc		pm_armv7;
57};
58
59#define	PMC_IN_KERNEL_STACK(S,START,END)		\
60	((S) >= (START) && (S) < (END))
61#define	PMC_IN_KERNEL(va)	INKERNEL((va))
62
63#define	PMC_IN_USERSPACE(va) ((va) <= VM_MAXUSER_ADDRESS)
64
65#define	PMC_TRAPFRAME_TO_PC(TF)		((TF)->tf_pc)
66#define	PMC_TRAPFRAME_TO_FP(TF)		((TF)->tf_r11)
67#define	PMC_TRAPFRAME_TO_SVC_SP(TF)	((TF)->tf_svc_sp)
68#define	PMC_TRAPFRAME_TO_USR_SP(TF)	((TF)->tf_usr_sp)
69#define	PMC_TRAPFRAME_TO_SVC_LR(TF)	((TF)->tf_svc_lr)
70#define	PMC_TRAPFRAME_TO_USR_LR(TF)	((TF)->tf_usr_lr)
71
72/* Build a fake kernel trapframe from current instruction pointer. */
73#define PMC_FAKE_TRAPFRAME(TF)						\
74	do {								\
75	(TF)->tf_spsr = PSR_SVC32_MODE;					\
76	__asm __volatile("mov %0, pc" : "=r" ((TF)->tf_pc));		\
77	__asm __volatile("mov %0, r11" : "=r" ((TF)->tf_r11));		\
78	} while (0)
79
80/*
81 * Prototypes
82 */
83struct pmc_mdep *pmc_xscale_initialize(void);
84void		pmc_xscale_finalize(struct pmc_mdep *_md);
85struct pmc_mdep *pmc_armv7_initialize(void);
86void		pmc_armv7_finalize(struct pmc_mdep *_md);
87#endif /* _KERNEL */
88
89#endif /* !_MACHINE_PMC_MDEP_H_ */
90