1 /*	$NetBSD: memory.h,v 1.5 2021/12/19 10:51:56 riastradh Exp $	*/
2 
3 /* SPDX-License-Identifier: MIT */
4 #ifndef __NVKM_MEMORY_H__
5 #define __NVKM_MEMORY_H__
6 #include <core/os.h>
7 struct nvkm_device;
8 struct nvkm_vma;
9 struct nvkm_vmm;
10 
11 struct nvkm_tags {
12 	struct nvkm_mm_node *mn;
13 	refcount_t refcount;
14 };
15 
16 enum nvkm_memory_target {
17 	NVKM_MEM_TARGET_INST, /* instance memory */
18 	NVKM_MEM_TARGET_VRAM, /* video memory */
19 	NVKM_MEM_TARGET_HOST, /* coherent system memory */
20 	NVKM_MEM_TARGET_NCOH, /* non-coherent system memory */
21 };
22 
23 struct nvkm_memory {
24 	const struct nvkm_memory_func *func;
25 	const struct nvkm_memory_ptrs *ptrs;
26 	struct kref kref;
27 	struct nvkm_tags *tags;
28 };
29 
30 #ifdef __NetBSD__
31 #  define	__nvkm_memory_iomem
32 #  define	__iomem			__nvkm_memory_iomem
33 #endif
34 
35 struct nvkm_memory_func {
36 	void *(*dtor)(struct nvkm_memory *);
37 	enum nvkm_memory_target (*target)(struct nvkm_memory *);
38 	u8 (*page)(struct nvkm_memory *);
39 	u64 (*bar2)(struct nvkm_memory *);
40 	u64 (*addr)(struct nvkm_memory *);
41 	u64 (*size)(struct nvkm_memory *);
42 	void (*boot)(struct nvkm_memory *, struct nvkm_vmm *);
43 	void __iomem *(*acquire)(struct nvkm_memory *);
44 	void (*release)(struct nvkm_memory *);
45 	int (*map)(struct nvkm_memory *, u64 offset, struct nvkm_vmm *,
46 		   struct nvkm_vma *, void *argv, u32 argc);
47 };
48 
49 struct nvkm_memory_ptrs {
50 	u32 (*rd32)(struct nvkm_memory *, u64 offset);
51 	void (*wr32)(struct nvkm_memory *, u64 offset, u32 data);
52 };
53 
54 #ifdef __NetBSD__
55 #  undef	__iomem
56 #endif
57 
58 void nvkm_memory_ctor(const struct nvkm_memory_func *, struct nvkm_memory *);
59 int nvkm_memory_new(struct nvkm_device *, enum nvkm_memory_target,
60 		    u64 size, u32 align, bool zero, struct nvkm_memory **);
61 struct nvkm_memory *nvkm_memory_ref(struct nvkm_memory *);
62 void nvkm_memory_unref(struct nvkm_memory **);
63 int nvkm_memory_tags_get(struct nvkm_memory *, struct nvkm_device *, u32 tags,
64 			 void (*clear)(struct nvkm_device *, u32, u32),
65 			 struct nvkm_tags **);
66 void nvkm_memory_tags_put(struct nvkm_memory *, struct nvkm_device *,
67 			  struct nvkm_tags **);
68 
69 #define nvkm_memory_target(p) (p)->func->target(p)
70 #define nvkm_memory_page(p) (p)->func->page(p)
71 #define nvkm_memory_bar2(p) (p)->func->bar2(p)
72 #define nvkm_memory_addr(p) (p)->func->addr(p)
73 #define nvkm_memory_size(p) (p)->func->size(p)
74 #define nvkm_memory_boot(p,v) (p)->func->boot((p),(v))
75 #define nvkm_memory_map(p,o,vm,va,av,ac)                                       \
76 	(p)->func->map((p),(o),(vm),(va),(av),(ac))
77 
78 /* accessor macros - kmap()/done() must bracket use of the other accessor
79  * macros to guarantee correct behaviour across all chipsets
80  */
81 #define nvkm_kmap(o)     (o)->func->acquire(o)
82 #define nvkm_done(o)     (o)->func->release(o)
83 
84 #define nvkm_ro32(o,a)   (o)->ptrs->rd32((o), (a))
85 #define nvkm_wo32(o,a,d) (o)->ptrs->wr32((o), (a), (d))
86 #define nvkm_mo32(o,a,m,d) ({                                                  \
87 	u32 _addr = (a), _data = nvkm_ro32((o), _addr);                        \
88 	nvkm_wo32((o), _addr, (_data & ~(m)) | (d));                           \
89 	_data;                                                                 \
90 })
91 
92 #define nvkm_wo64(o,a,d) do {                                                  \
93 	u64 __a = (a), __d = (d);                                              \
94 	nvkm_wo32((o), __a + 0, lower_32_bits(__d));                           \
95 	nvkm_wo32((o), __a + 4, upper_32_bits(__d));                           \
96 } while(0)
97 
98 #define nvkm_robj(o,a,p,s) do {                                                \
99 	u32 _addr = (a), _size = (s) >> 2, *_data = (void *)(p);               \
100 	while (_size--) {                                                      \
101 		*(_data++) = nvkm_ro32((o), _addr);                            \
102 		_addr += 4;                                                    \
103 	}                                                                      \
104 } while(0)
105 
106 #define nvkm_wobj(o,a,p,s) do {                                                \
107 	u32 _addr = (a), _size = (s) >> 2;                                     \
108 	const u32 *_data = (const void *)(p);                                  \
109 	while (_size--) {                                                      \
110 		nvkm_wo32((o), _addr, *(_data++));                             \
111 		_addr += 4;                                                    \
112 	}                                                                      \
113 } while(0)
114 
115 #ifdef __NetBSD__		/* XXX */
116 #define nvkm_fill(t,s,o,a,d,c) do {                                            \
117 	u64 _a = (a), _c = (c), _d = (d);                                      \
118 	(void)nvkm_kmap(o);                                                    \
119 	for (; _c; _c--, _a += BIT(s))                                         \
120 		nvkm_wo##t((o), _a, _d);                                       \
121 	nvkm_done(o);                                                          \
122 } while(0)
123 #else
124 #define nvkm_fill(t,s,o,a,d,c) do {                                            \
125 	u64 _a = (a), _c = (c), _d = (d), _o = _a >> s, _s = _c << s;          \
126 	u##t __iomem *_m = nvkm_kmap(o);                                       \
127 	if (likely(_m)) {                                                      \
128 		if (_d) {                                                      \
129 			while (_c--)                                           \
130 				iowrite##t##_native(_d, &_m[_o++]);            \
131 		} else {                                                       \
132 			memset_io(&_m[_o], _d, _s);                            \
133 		}                                                              \
134 	} else {                                                               \
135 		for (; _c; _c--, _a += BIT(s))                                 \
136 			nvkm_wo##t((o), _a, _d);                               \
137 	}                                                                      \
138 	nvkm_done(o);                                                          \
139 } while(0)
140 #endif
141 #define nvkm_fo32(o,a,d,c) nvkm_fill(32, 2, (o), (a), (d), (c))
142 #define nvkm_fo64(o,a,d,c) nvkm_fill(64, 3, (o), (a), (d), (c))
143 #endif
144