xref: /freebsd/sys/sys/memrange.h (revision 4e8d558c)
1 /*
2  * Memory range attribute operations, performed on /dev/mem
3  *
4  * $FreeBSD$
5  */
6 
7 #ifndef _SYS_MEMRANGE_H_
8 #define	_SYS_MEMRANGE_H_
9 
10 #include <sys/ioccom.h>
11 
12 /* Memory range attributes */
13 #define MDF_UNCACHEABLE		(1<<0)	/* region not cached */
14 #define MDF_WRITECOMBINE	(1<<1)	/* region supports "write combine" action */
15 #define MDF_WRITETHROUGH	(1<<2)	/* write-through cached */
16 #define MDF_WRITEBACK		(1<<3)	/* write-back cached */
17 #define MDF_WRITEPROTECT	(1<<4)	/* read-only region */
18 #define MDF_UNKNOWN		(1<<5)	/* any state we don't understand */
19 #define MDF_ATTRMASK		(0x00ffffff)
20 
21 #define MDF_FIXBASE		(1<<24)	/* fixed base */
22 #define MDF_FIXLEN		(1<<25)	/* fixed length */
23 #define MDF_FIRMWARE		(1<<26)	/* set by firmware (XXX not useful?) */
24 #define MDF_ACTIVE		(1<<27)	/* currently active */
25 #define MDF_BOGUS		(1<<28)	/* we don't like it */
26 #define MDF_FIXACTIVE		(1<<29)	/* can't be turned off */
27 #define MDF_BUSY		(1<<30)	/* range is in use */
28 #define MDF_FORCE		(1<<31)	/* force risky changes */
29 
30 struct mem_range_desc
31 {
32 	u_int64_t	mr_base;
33 	u_int64_t	mr_len;
34 	int		mr_flags;
35 	char		mr_owner[8];
36 };
37 
38 struct mem_range_op
39 {
40 	struct mem_range_desc	*mo_desc;
41 	int			mo_arg[2];
42 #define MEMRANGE_SET_UPDATE	0
43 #define MEMRANGE_SET_REMOVE	1
44 	/* XXX want a flag that says "set and undo when I exit" */
45 };
46 
47 #define MEMRANGE_GET	_IOWR('m', 50, struct mem_range_op)
48 #define MEMRANGE_SET	_IOW('m', 51, struct mem_range_op)
49 
50 #define	ME_STATE_INVALID	0
51 #define	ME_STATE_VALID		1
52 #define	ME_STATE_MAPPED		2
53 
54 struct mem_extract {
55 	uint64_t	me_vaddr;
56 	uint64_t	me_paddr;
57 	int		me_domain;
58 	int		me_state;
59 	uint64_t	pad1[5];
60 };
61 
62 #define	MEM_EXTRACT_PADDR	_IOWR('m', 52, struct mem_extract)
63 
64 struct mem_livedump_arg {
65 	int		fd;
66 	int		flags;
67 	uint8_t		compression;
68 	uint8_t		pad1[7];
69 	uint64_t	pad2[2];
70 };
71 
72 #define	MEM_KERNELDUMP	_IOW('m', 53, struct mem_livedump_arg)
73 
74 #ifdef _KERNEL
75 
76 MALLOC_DECLARE(M_MEMDESC);
77 
78 struct mem_range_softc;
79 struct mem_range_ops
80 {
81 	void	(*init)(struct mem_range_softc *sc);
82 	int	(*set)(struct mem_range_softc *sc, struct mem_range_desc *mrd, int *arg);
83     	void	(*initAP)(struct mem_range_softc *sc);
84     	void	(*reinit)(struct mem_range_softc *sc);
85 };
86 
87 struct mem_range_softc
88 {
89 	struct mem_range_ops	*mr_op;
90 	int			mr_cap;
91 	int			mr_ndesc;
92 	struct mem_range_desc 	*mr_desc;
93 };
94 
95 extern struct mem_range_softc mem_range_softc;
96 
97 extern void	mem_range_init(void);
98 extern void	mem_range_destroy(void);
99 
100 extern int	mem_range_attr_get(struct mem_range_desc *mrd, int *arg);
101 extern int	mem_range_attr_set(struct mem_range_desc *mrd, int *arg);
102 
103 #endif /* _KERNEL */
104 
105 #endif /* _SYS_MEMRANGE_H_ */
106