1 /*
2  * Copyright 2012 Red Hat Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: Ben Skeggs
23  */
24 #include "priv.h"
25 
26 #include <core/memory.h>
27 #include <subdev/bar.h>
28 
29 /******************************************************************************
30  * instmem object base implementation
31  *****************************************************************************/
32 #define nvkm_instobj(p) container_of((p), struct nvkm_instobj, memory)
33 
34 struct nvkm_instobj {
35 	struct nvkm_memory memory;
36 	struct nvkm_memory *parent;
37 	struct nvkm_instmem *imem;
38 	struct list_head head;
39 	u32 *suspend;
40 	void __iomem *map;
41 };
42 
43 static enum nvkm_memory_target
44 nvkm_instobj_target(struct nvkm_memory *memory)
45 {
46 	memory = nvkm_instobj(memory)->parent;
47 	return nvkm_memory_target(memory);
48 }
49 
50 static u64
51 nvkm_instobj_addr(struct nvkm_memory *memory)
52 {
53 	memory = nvkm_instobj(memory)->parent;
54 	return nvkm_memory_addr(memory);
55 }
56 
57 static u64
58 nvkm_instobj_size(struct nvkm_memory *memory)
59 {
60 	memory = nvkm_instobj(memory)->parent;
61 	return nvkm_memory_size(memory);
62 }
63 
64 static void
65 nvkm_instobj_release(struct nvkm_memory *memory)
66 {
67 	struct nvkm_instobj *iobj = nvkm_instobj(memory);
68 	struct nvkm_bar *bar = iobj->imem->subdev.device->bar;
69 	if (bar && bar->flush)
70 		bar->flush(bar);
71 }
72 
73 static void __iomem *
74 nvkm_instobj_acquire(struct nvkm_memory *memory)
75 {
76 	return nvkm_instobj(memory)->map;
77 }
78 
79 static u32
80 nvkm_instobj_rd32(struct nvkm_memory *memory, u64 offset)
81 {
82 	return ioread32_native(nvkm_instobj(memory)->map + offset);
83 }
84 
85 static void
86 nvkm_instobj_wr32(struct nvkm_memory *memory, u64 offset, u32 data)
87 {
88 	iowrite32_native(data, nvkm_instobj(memory)->map + offset);
89 }
90 
91 static void
92 nvkm_instobj_map(struct nvkm_memory *memory, struct nvkm_vma *vma, u64 offset)
93 {
94 	memory = nvkm_instobj(memory)->parent;
95 	nvkm_memory_map(memory, vma, offset);
96 }
97 
98 static void *
99 nvkm_instobj_dtor(struct nvkm_memory *memory)
100 {
101 	struct nvkm_instobj *iobj = nvkm_instobj(memory);
102 	list_del(&iobj->head);
103 	nvkm_memory_del(&iobj->parent);
104 	return iobj;
105 }
106 
107 const struct nvkm_memory_func
108 nvkm_instobj_func = {
109 	.dtor = nvkm_instobj_dtor,
110 	.target = nvkm_instobj_target,
111 	.addr = nvkm_instobj_addr,
112 	.size = nvkm_instobj_size,
113 	.acquire = nvkm_instobj_acquire,
114 	.release = nvkm_instobj_release,
115 	.rd32 = nvkm_instobj_rd32,
116 	.wr32 = nvkm_instobj_wr32,
117 	.map = nvkm_instobj_map,
118 };
119 
120 static void
121 nvkm_instobj_boot(struct nvkm_memory *memory, struct nvkm_vm *vm)
122 {
123 	memory = nvkm_instobj(memory)->parent;
124 	nvkm_memory_boot(memory, vm);
125 }
126 
127 static void
128 nvkm_instobj_release_slow(struct nvkm_memory *memory)
129 {
130 	struct nvkm_instobj *iobj = nvkm_instobj(memory);
131 	nvkm_instobj_release(memory);
132 	nvkm_done(iobj->parent);
133 }
134 
135 static void __iomem *
136 nvkm_instobj_acquire_slow(struct nvkm_memory *memory)
137 {
138 	struct nvkm_instobj *iobj = nvkm_instobj(memory);
139 	iobj->map = nvkm_kmap(iobj->parent);
140 	if (iobj->map)
141 		memory->func = &nvkm_instobj_func;
142 	return iobj->map;
143 }
144 
145 static u32
146 nvkm_instobj_rd32_slow(struct nvkm_memory *memory, u64 offset)
147 {
148 	struct nvkm_instobj *iobj = nvkm_instobj(memory);
149 	return nvkm_ro32(iobj->parent, offset);
150 }
151 
152 static void
153 nvkm_instobj_wr32_slow(struct nvkm_memory *memory, u64 offset, u32 data)
154 {
155 	struct nvkm_instobj *iobj = nvkm_instobj(memory);
156 	return nvkm_wo32(iobj->parent, offset, data);
157 }
158 
159 const struct nvkm_memory_func
160 nvkm_instobj_func_slow = {
161 	.dtor = nvkm_instobj_dtor,
162 	.target = nvkm_instobj_target,
163 	.addr = nvkm_instobj_addr,
164 	.size = nvkm_instobj_size,
165 	.boot = nvkm_instobj_boot,
166 	.acquire = nvkm_instobj_acquire_slow,
167 	.release = nvkm_instobj_release_slow,
168 	.rd32 = nvkm_instobj_rd32_slow,
169 	.wr32 = nvkm_instobj_wr32_slow,
170 	.map = nvkm_instobj_map,
171 };
172 
173 static int
174 nvkm_instobj_new(struct nvkm_instmem *imem, u32 size, u32 align, bool zero,
175 		 struct nvkm_memory **pmemory)
176 {
177 	struct nvkm_instmem_impl *impl = (void *)imem->subdev.object.oclass;
178 	struct nvkm_memory *memory;
179 	struct nvkm_instobj *iobj;
180 	u32 offset;
181 	int ret;
182 
183 	ret = impl->memory_new(imem, size, align, zero, &memory);
184 	if (ret)
185 		goto done;
186 
187 	if (!impl->persistent) {
188 		if (!(iobj = kzalloc(sizeof(*iobj), GFP_KERNEL))) {
189 			ret = -ENOMEM;
190 			goto done;
191 		}
192 
193 		nvkm_memory_ctor(&nvkm_instobj_func_slow, &iobj->memory);
194 		iobj->parent = memory;
195 		iobj->imem = imem;
196 		list_add_tail(&iobj->head, &imem->list);
197 		memory = &iobj->memory;
198 	}
199 
200 	if (!impl->zero && zero) {
201 		void __iomem *map = nvkm_kmap(memory);
202 		if (unlikely(!map)) {
203 			for (offset = 0; offset < size; offset += 4)
204 				nvkm_wo32(memory, offset, 0x00000000);
205 		} else {
206 			memset_io(map, 0x00, size);
207 		}
208 		nvkm_done(memory);
209 	}
210 
211 done:
212 	if (ret)
213 		nvkm_memory_del(&memory);
214 	*pmemory = memory;
215 	return ret;
216 }
217 
218 /******************************************************************************
219  * instmem subdev base implementation
220  *****************************************************************************/
221 
222 int
223 _nvkm_instmem_fini(struct nvkm_object *object, bool suspend)
224 {
225 	struct nvkm_instmem *imem = (void *)object;
226 	struct nvkm_instobj *iobj;
227 	int i;
228 
229 	if (suspend) {
230 		list_for_each_entry(iobj, &imem->list, head) {
231 			struct nvkm_memory *memory = iobj->parent;
232 			u64 size = nvkm_memory_size(memory);
233 
234 			iobj->suspend = vmalloc(size);
235 			if (!iobj->suspend)
236 				return -ENOMEM;
237 
238 			for (i = 0; i < size; i += 4)
239 				iobj->suspend[i / 4] = nvkm_ro32(memory, i);
240 		}
241 	}
242 
243 	return nvkm_subdev_fini_old(&imem->subdev, suspend);
244 }
245 
246 int
247 _nvkm_instmem_init(struct nvkm_object *object)
248 {
249 	struct nvkm_instmem *imem = (void *)object;
250 	struct nvkm_instobj *iobj;
251 	int ret, i;
252 
253 	ret = nvkm_subdev_init_old(&imem->subdev);
254 	if (ret)
255 		return ret;
256 
257 	list_for_each_entry(iobj, &imem->list, head) {
258 		if (iobj->suspend) {
259 			struct nvkm_memory *memory = iobj->parent;
260 			u64 size = nvkm_memory_size(memory);
261 			for (i = 0; i < size; i += 4)
262 				nvkm_wo32(memory, i, iobj->suspend[i / 4]);
263 			vfree(iobj->suspend);
264 			iobj->suspend = NULL;
265 		}
266 	}
267 
268 	return 0;
269 }
270 
271 int
272 nvkm_instmem_create_(struct nvkm_object *parent, struct nvkm_object *engine,
273 		     struct nvkm_oclass *oclass, int length, void **pobject)
274 {
275 	struct nvkm_device *device = (void *)parent;
276 	struct nvkm_instmem *imem;
277 	int ret;
278 
279 	ret = nvkm_subdev_create_(parent, engine, oclass, 0, "INSTMEM",
280 				  "instmem", length, pobject);
281 	imem = *pobject;
282 	if (ret)
283 		return ret;
284 
285 	device->imem = imem;
286 
287 	INIT_LIST_HEAD(&imem->list);
288 	imem->alloc = nvkm_instobj_new;
289 	return 0;
290 }
291