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