[mirror_ubuntu-bionic-kernel.git] / include / linux / mmiotrace.h

#ifndef MMIOTRACE_H
#define MMIOTRACE_H

#include <linux/types.h>

#include <linux/list.h>

struct kmmio_probe;
struct pt_regs;

typedef void (*kmmio_pre_handler_t)(struct kmmio_probe *,
				struct pt_regs *, unsigned long addr);
typedef void (*kmmio_post_handler_t)(struct kmmio_probe *,
				unsigned long condition, struct pt_regs *);

struct kmmio_probe {
	struct list_head list; /* kmmio internal list */
	unsigned long addr; /* start location of the probe point */
	unsigned long len; /* length of the probe region */
	kmmio_pre_handler_t pre_handler; /* Called before addr is executed. */
	kmmio_post_handler_t post_handler; /* Called after addr is executed */
	void *user_data;
};

/* kmmio is active by some kmmio_probes? */
static inline int is_kmmio_active(void)
{
	extern unsigned int kmmio_count;
	return kmmio_count;
}

extern int register_kmmio_probe(struct kmmio_probe *p);
extern void unregister_kmmio_probe(struct kmmio_probe *p);

/* Called from page fault handler. */
extern int kmmio_handler(struct pt_regs *regs, unsigned long addr);

/* Called from ioremap.c */
#ifdef CONFIG_MMIOTRACE
extern void
mmiotrace_ioremap(unsigned long offset, unsigned long size, void __iomem *addr);
extern void mmiotrace_iounmap(volatile void __iomem *addr);
#else
static inline void
mmiotrace_ioremap(unsigned long offset, unsigned long size, void __iomem *addr)
{
}
static inline void mmiotrace_iounmap(volatile void __iomem *addr)
{
}
#endif /* CONFIG_MMIOTRACE_HOOKS */

enum mm_io_opcode {
	MMIO_READ = 0x1,     /* struct mmiotrace_rw */
	MMIO_WRITE = 0x2,    /* struct mmiotrace_rw */
	MMIO_PROBE = 0x3,    /* struct mmiotrace_map */
	MMIO_UNPROBE = 0x4,  /* struct mmiotrace_map */
	MMIO_MARKER = 0x5,   /* raw char data */
	MMIO_UNKNOWN_OP = 0x6, /* struct mmiotrace_rw */
};

struct mmiotrace_rw {
	unsigned long phys;	/* PCI address of register */
	unsigned long value;
	unsigned long pc;	/* optional program counter */
	int map_id;
	unsigned char opcode;	/* one of MMIO_{READ,WRITE,UNKNOWN_OP} */
	unsigned char width;	/* size of register access in bytes */
};

struct mmiotrace_map {
	unsigned long phys;	/* base address in PCI space */
	unsigned long virt;	/* base virtual address */
	unsigned long len;	/* mapping size */
	int map_id;
	unsigned char opcode;	/* MMIO_PROBE or MMIO_UNPROBE */
};

/* in kernel/trace/trace_mmiotrace.c */
extern void enable_mmiotrace(void);
extern void disable_mmiotrace(void);
extern void mmio_trace_rw(struct mmiotrace_rw *rw);
extern void mmio_trace_mapping(struct mmiotrace_map *map);

#endif /* MMIOTRACE_H */
Commit	Line	Data
8b7d89d0 PP	1	#ifndef MMIOTRACE_H
	2	#define MMIOTRACE_H
	3
970e6fa0	4	#include <linux/types.h>
0fd0e3da PP	5
	6	#include <linux/list.h>
	7
	8	struct kmmio_probe;
	9	struct pt_regs;
	10
	11	typedef void (kmmio_pre_handler_t)(struct kmmio_probe ,
	12	struct pt_regs *, unsigned long addr);
	13	typedef void (kmmio_post_handler_t)(struct kmmio_probe ,
	14	unsigned long condition, struct pt_regs *);
	15
	16	struct kmmio_probe {
d61fc448	17	struct list_head list; /* kmmio internal list */
0fd0e3da PP	18	unsigned long addr; /* start location of the probe point */
	19	unsigned long len; /* length of the probe region */
	20	kmmio_pre_handler_t pre_handler; /* Called before addr is executed. */
	21	kmmio_post_handler_t post_handler; /* Called after addr is executed */
d61fc448	22	void *user_data;
0fd0e3da PP	23	};
	24
	25	/* kmmio is active by some kmmio_probes? */
	26	static inline int is_kmmio_active(void)
	27	{
	28	extern unsigned int kmmio_count;
	29	return kmmio_count;
	30	}
	31
0fd0e3da PP	32	extern int register_kmmio_probe(struct kmmio_probe *p);
	33	extern void unregister_kmmio_probe(struct kmmio_probe *p);
	34
	35	/* Called from page fault handler. */
	36	extern int kmmio_handler(struct pt_regs *regs, unsigned long addr);
	37
d61fc448 PP	38	/* Called from ioremap.c */
	39	#ifdef CONFIG_MMIOTRACE
	40	extern void
	41	mmiotrace_ioremap(unsigned long offset, unsigned long size, void __iomem *addr);
	42	extern void mmiotrace_iounmap(volatile void __iomem *addr);
	43	#else
	44	static inline void
	45	mmiotrace_ioremap(unsigned long offset, unsigned long size, void __iomem *addr)
	46	{
	47	}
	48	static inline void mmiotrace_iounmap(volatile void __iomem *addr)
	49	{
	50	}
	51	#endif /* CONFIG_MMIOTRACE_HOOKS */
	52
bd8ac686 PP	53	enum mm_io_opcode {
	54	MMIO_READ = 0x1, /* struct mmiotrace_rw */
	55	MMIO_WRITE = 0x2, /* struct mmiotrace_rw */
	56	MMIO_PROBE = 0x3, /* struct mmiotrace_map */
	57	MMIO_UNPROBE = 0x4, /* struct mmiotrace_map */
8b7d89d0	58	MMIO_MARKER = 0x5, /* raw char data */
bd8ac686	59	MMIO_UNKNOWN_OP = 0x6, /* struct mmiotrace_rw */
8b7d89d0 PP	60	};
8b7d89d0 PP	61
bd8ac686 PP	62	struct mmiotrace_rw {
	63	unsigned long phys; /* PCI address of register */
	64	unsigned long value;
	65	unsigned long pc; /* optional program counter */
	66	int map_id;
	67	unsigned char opcode; /* one of MMIO_{READ,WRITE,UNKNOWN_OP} */
	68	unsigned char width; /* size of register access in bytes */
8b7d89d0 PP	69	};
8b7d89d0 PP	70
bd8ac686 PP	71	struct mmiotrace_map {
	72	unsigned long phys; /* base address in PCI space */
	73	unsigned long virt; /* base virtual address */
	74	unsigned long len; /* mapping size */
	75	int map_id;
	76	unsigned char opcode; /* MMIO_PROBE or MMIO_UNPROBE */
8b7d89d0 PP	77	};
8b7d89d0 PP	78
bd8ac686 PP	79	/* in kernel/trace/trace_mmiotrace.c */
	80	extern void enable_mmiotrace(void);
	81	extern void disable_mmiotrace(void);
	82	extern void mmio_trace_rw(struct mmiotrace_rw *rw);
	83	extern void mmio_trace_mapping(struct mmiotrace_map *map);
8b7d89d0	84
8b7d89d0	85	#endif /* MMIOTRACE_H */