x86: mmiotrace, preview 2
[linux-2.6.git] / include / linux / mmiotrace.h
1 #ifndef MMIOTRACE_H
2 #define MMIOTRACE_H
3
4 #include <asm/types.h>
5
6 #ifdef __KERNEL__
7
8 #include <linux/list.h>
9
10 struct kmmio_probe;
11 struct pt_regs;
12
13 typedef void (*kmmio_pre_handler_t)(struct kmmio_probe *,
14                                 struct pt_regs *, unsigned long addr);
15 typedef void (*kmmio_post_handler_t)(struct kmmio_probe *,
16                                 unsigned long condition, struct pt_regs *);
17
18 struct kmmio_probe {
19         struct list_head list; /* kmmio internal list */
20         unsigned long addr; /* start location of the probe point */
21         unsigned long len; /* length of the probe region */
22         kmmio_pre_handler_t pre_handler; /* Called before addr is executed. */
23         kmmio_post_handler_t post_handler; /* Called after addr is executed */
24         void *user_data;
25 };
26
27 /* kmmio is active by some kmmio_probes? */
28 static inline int is_kmmio_active(void)
29 {
30         extern unsigned int kmmio_count;
31         return kmmio_count;
32 }
33
34 extern void reference_kmmio(void);
35 extern void unreference_kmmio(void);
36 extern int register_kmmio_probe(struct kmmio_probe *p);
37 extern void unregister_kmmio_probe(struct kmmio_probe *p);
38
39 /* Called from page fault handler. */
40 extern int kmmio_handler(struct pt_regs *regs, unsigned long addr);
41
42 /* Called from ioremap.c */
43 #ifdef CONFIG_MMIOTRACE
44 extern void
45 mmiotrace_ioremap(unsigned long offset, unsigned long size, void __iomem *addr);
46 extern void mmiotrace_iounmap(volatile void __iomem *addr);
47 #else
48 static inline void
49 mmiotrace_ioremap(unsigned long offset, unsigned long size, void __iomem *addr)
50 {
51 }
52 static inline void mmiotrace_iounmap(volatile void __iomem *addr)
53 {
54 }
55 #endif /* CONFIG_MMIOTRACE_HOOKS */
56
57 #endif /* __KERNEL__ */
58
59
60 /*
61  * If you change anything here, you must bump MMIO_VERSION.
62  * This is the relay data format for user space.
63  */
64 #define MMIO_VERSION 0x04
65
66 /* mm_io_header.type */
67 #define MMIO_OPCODE_MASK 0xff
68 #define MMIO_OPCODE_SHIFT 0
69 #define MMIO_WIDTH_MASK 0xff00
70 #define MMIO_WIDTH_SHIFT 8
71 #define MMIO_MAGIC (0x6f000000 | (MMIO_VERSION<<16))
72 #define MMIO_MAGIC_MASK 0xffff0000
73
74 enum mm_io_opcode {          /* payload type: */
75         MMIO_READ = 0x1,     /* struct mm_io_rw */
76         MMIO_WRITE = 0x2,    /* struct mm_io_rw */
77         MMIO_PROBE = 0x3,    /* struct mm_io_map */
78         MMIO_UNPROBE = 0x4,  /* struct mm_io_map */
79         MMIO_MARKER = 0x5,   /* raw char data */
80         MMIO_UNKNOWN_OP = 0x6, /* struct mm_io_rw */
81 };
82
83 struct mm_io_header {
84         __u32 type;     /* see MMIO_* macros above */
85         __u32 sec;      /* timestamp */
86         __u32 nsec;
87         __u32 pid;      /* PID of the process, or 0 for kernel core */
88         __u16 data_len; /* length of the following payload */
89 };
90
91 struct mm_io_rw {
92         __u64 address; /* virtual address of register */
93         __u64 value;
94         __u64 pc;      /* optional program counter */
95 };
96
97 struct mm_io_map {
98         __u64 phys;  /* base address in PCI space */
99         __u64 addr;  /* base virtual address */
100         __u64 len;   /* mapping size */
101         __u64 pc;    /* optional program counter */
102 };
103
104
105 /*
106  * These structures are used to allow a single relay_write()
107  * call to write a full packet.
108  */
109
110 struct mm_io_header_rw {
111         struct mm_io_header header;
112         struct mm_io_rw rw;
113 } __attribute__((packed));
114
115 struct mm_io_header_map {
116         struct mm_io_header header;
117         struct mm_io_map map;
118 } __attribute__((packed));
119
120 #endif /* MMIOTRACE_H */