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

#ifndef MMIOTRACE_H
#define MMIOTRACE_H

#include <asm/types.h>

#ifdef __KERNEL__

#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 void reference_kmmio(void);
extern void unreference_kmmio(void);
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 /* __KERNEL__ */

#endif /* MMIOTRACE_H */
Commit	Line	Data
8b7d89d0 PP	1	#ifndef MMIOTRACE_H
	2	#define MMIOTRACE_H
	3
	4	#include <asm/types.h>
	5
0fd0e3da PP	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 {
d61fc448	19	struct list_head list; /* kmmio internal list */
0fd0e3da PP	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 */
d61fc448	24	void *user_data;
0fd0e3da PP	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
d61fc448 PP	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
bd8ac686 PP	57	enum mm_io_opcode {
	58	MMIO_READ = 0x1, /* struct mmiotrace_rw */
	59	MMIO_WRITE = 0x2, /* struct mmiotrace_rw */
	60	MMIO_PROBE = 0x3, /* struct mmiotrace_map */
	61	MMIO_UNPROBE = 0x4, /* struct mmiotrace_map */
8b7d89d0	62	MMIO_MARKER = 0x5, /* raw char data */
bd8ac686	63	MMIO_UNKNOWN_OP = 0x6, /* struct mmiotrace_rw */
8b7d89d0 PP	64	};
8b7d89d0 PP	65
bd8ac686 PP	66	struct mmiotrace_rw {
	67	unsigned long phys; /* PCI address of register */
	68	unsigned long value;
	69	unsigned long pc; /* optional program counter */
	70	int map_id;
	71	unsigned char opcode; /* one of MMIO_{READ,WRITE,UNKNOWN_OP} */
	72	unsigned char width; /* size of register access in bytes */
8b7d89d0 PP	73	};
8b7d89d0 PP	74
bd8ac686 PP	75	struct mmiotrace_map {
	76	unsigned long phys; /* base address in PCI space */
	77	unsigned long virt; /* base virtual address */
	78	unsigned long len; /* mapping size */
	79	int map_id;
	80	unsigned char opcode; /* MMIO_PROBE or MMIO_UNPROBE */
8b7d89d0 PP	81	};
8b7d89d0 PP	82
bd8ac686 PP	83	/* in kernel/trace/trace_mmiotrace.c */
	84	extern void enable_mmiotrace(void);
	85	extern void disable_mmiotrace(void);
	86	extern void mmio_trace_rw(struct mmiotrace_rw *rw);
	87	extern void mmio_trace_mapping(struct mmiotrace_map *map);
8b7d89d0	88
bd8ac686	89	#endif /* __KERNEL__ */
8b7d89d0 PP	90
8b7d89d0 PP	91	#endif /* MMIOTRACE_H */