GNU Linux-libre 4.14.290-gnu1
[releases.git] / drivers / gpu / drm / nouveau / include / nvkm / core / memory.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __NVKM_MEMORY_H__
3 #define __NVKM_MEMORY_H__
4 #include <core/os.h>
5 struct nvkm_device;
6 struct nvkm_vma;
7 struct nvkm_vm;
8
9 enum nvkm_memory_target {
10         NVKM_MEM_TARGET_INST, /* instance memory */
11         NVKM_MEM_TARGET_VRAM, /* video memory */
12         NVKM_MEM_TARGET_HOST, /* coherent system memory */
13         NVKM_MEM_TARGET_NCOH, /* non-coherent system memory */
14 };
15
16 struct nvkm_memory {
17         const struct nvkm_memory_func *func;
18 };
19
20 struct nvkm_memory_func {
21         void *(*dtor)(struct nvkm_memory *);
22         enum nvkm_memory_target (*target)(struct nvkm_memory *);
23         u64 (*addr)(struct nvkm_memory *);
24         u64 (*size)(struct nvkm_memory *);
25         void (*boot)(struct nvkm_memory *, struct nvkm_vm *);
26         void __iomem *(*acquire)(struct nvkm_memory *);
27         void (*release)(struct nvkm_memory *);
28         u32 (*rd32)(struct nvkm_memory *, u64 offset);
29         void (*wr32)(struct nvkm_memory *, u64 offset, u32 data);
30         void (*map)(struct nvkm_memory *, struct nvkm_vma *, u64 offset);
31 };
32
33 void nvkm_memory_ctor(const struct nvkm_memory_func *, struct nvkm_memory *);
34 int nvkm_memory_new(struct nvkm_device *, enum nvkm_memory_target,
35                     u64 size, u32 align, bool zero, struct nvkm_memory **);
36 void nvkm_memory_del(struct nvkm_memory **);
37 #define nvkm_memory_target(p) (p)->func->target(p)
38 #define nvkm_memory_addr(p) (p)->func->addr(p)
39 #define nvkm_memory_size(p) (p)->func->size(p)
40 #define nvkm_memory_boot(p,v) (p)->func->boot((p),(v))
41 #define nvkm_memory_map(p,v,o) (p)->func->map((p),(v),(o))
42
43 /* accessor macros - kmap()/done() must bracket use of the other accessor
44  * macros to guarantee correct behaviour across all chipsets
45  */
46 #define nvkm_kmap(o)     (o)->func->acquire(o)
47 #define nvkm_ro32(o,a)   (o)->func->rd32((o), (a))
48 #define nvkm_wo32(o,a,d) (o)->func->wr32((o), (a), (d))
49 #define nvkm_mo32(o,a,m,d) ({                                                  \
50         u32 _addr = (a), _data = nvkm_ro32((o), _addr);                        \
51         nvkm_wo32((o), _addr, (_data & ~(m)) | (d));                           \
52         _data;                                                                 \
53 })
54 #define nvkm_done(o)     (o)->func->release(o)
55 #endif