1#ifndef _LINUX_MMIOTRACE_H
2#define _LINUX_MMIOTRACE_H
3
4#include <linux/types.h>
5#include <linux/list.h>
6
7struct kmmio_probe;
8struct pt_regs;
9
10typedef void (*kmmio_pre_handler_t)(struct kmmio_probe *,
11				struct pt_regs *, unsigned long addr);
12typedef void (*kmmio_post_handler_t)(struct kmmio_probe *,
13				unsigned long condition, struct pt_regs *);
14
15struct kmmio_probe {
16	/* kmmio internal list: */
17	struct list_head	list;
18	/* start location of the probe point: */
19	unsigned long		addr;
20	/* length of the probe region: */
21	unsigned long		len;
22	/* Called before addr is executed: */
23	kmmio_pre_handler_t	pre_handler;
24	/* Called after addr is executed: */
25	kmmio_post_handler_t	post_handler;
26	void			*private;
27};
28
29extern unsigned int kmmio_count;
30
31extern int register_kmmio_probe(struct kmmio_probe *p);
32extern void unregister_kmmio_probe(struct kmmio_probe *p);
33extern int kmmio_init(void);
34extern void kmmio_cleanup(void);
35
36#ifdef CONFIG_MMIOTRACE
37/* kmmio is active by some kmmio_probes? */
38static inline int is_kmmio_active(void)
39{
40	return kmmio_count;
41}
42
43/* Called from page fault handler. */
44extern int kmmio_handler(struct pt_regs *regs, unsigned long addr);
45
46/* Called from ioremap.c */
47extern void mmiotrace_ioremap(resource_size_t offset, unsigned long size,
48							void __iomem *addr);
49extern void mmiotrace_iounmap(volatile void __iomem *addr);
50
51/* For anyone to insert markers. Remember trailing newline. */
52extern __printf(1, 2) int mmiotrace_printk(const char *fmt, ...);
53#else /* !CONFIG_MMIOTRACE: */
54static inline int is_kmmio_active(void)
55{
56	return 0;
57}
58
59static inline int kmmio_handler(struct pt_regs *regs, unsigned long addr)
60{
61	return 0;
62}
63
64static inline void mmiotrace_ioremap(resource_size_t offset,
65					unsigned long size, void __iomem *addr)
66{
67}
68
69static inline void mmiotrace_iounmap(volatile void __iomem *addr)
70{
71}
72
73static inline __printf(1, 2) int mmiotrace_printk(const char *fmt, ...)
74{
75	return 0;
76}
77#endif /* CONFIG_MMIOTRACE */
78
79enum mm_io_opcode {
80	MMIO_READ	= 0x1,	/* struct mmiotrace_rw */
81	MMIO_WRITE	= 0x2,	/* struct mmiotrace_rw */
82	MMIO_PROBE	= 0x3,	/* struct mmiotrace_map */
83	MMIO_UNPROBE	= 0x4,	/* struct mmiotrace_map */
84	MMIO_UNKNOWN_OP = 0x5,	/* struct mmiotrace_rw */
85};
86
87struct mmiotrace_rw {
88	resource_size_t	phys;	/* PCI address of register */
89	unsigned long	value;
90	unsigned long	pc;	/* optional program counter */
91	int		map_id;
92	unsigned char	opcode;	/* one of MMIO_{READ,WRITE,UNKNOWN_OP} */
93	unsigned char	width;	/* size of register access in bytes */
94};
95
96struct mmiotrace_map {
97	resource_size_t	phys;	/* base address in PCI space */
98	unsigned long	virt;	/* base virtual address */
99	unsigned long	len;	/* mapping size */
100	int		map_id;
101	unsigned char	opcode;	/* MMIO_PROBE or MMIO_UNPROBE */
102};
103
104/* in kernel/trace/trace_mmiotrace.c */
105extern void enable_mmiotrace(void);
106extern void disable_mmiotrace(void);
107extern void mmio_trace_rw(struct mmiotrace_rw *rw);
108extern void mmio_trace_mapping(struct mmiotrace_map *map);
109extern int mmio_trace_printk(const char *fmt, va_list args);
110
111#endif /* _LINUX_MMIOTRACE_H */
112