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