xref: /openbmc/linux/drivers/gpu/drm/nouveau/nouveau_bo.h (revision b24413180f5600bcb3bb70fbed5cf186b60864bd)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __NOUVEAU_BO_H__
3 #define __NOUVEAU_BO_H__
4 
5 #include <drm/drm_gem.h>
6 
7 struct nouveau_channel;
8 struct nouveau_fence;
9 struct nvkm_vma;
10 
11 struct nouveau_bo {
12 	struct ttm_buffer_object bo;
13 	struct ttm_placement placement;
14 	u32 valid_domains;
15 	struct ttm_place placements[3];
16 	struct ttm_place busy_placements[3];
17 	bool force_coherent;
18 	struct ttm_bo_kmap_obj kmap;
19 	struct list_head head;
20 
21 	/* protected by ttm_bo_reserve() */
22 	struct drm_file *reserved_by;
23 	struct list_head entry;
24 	int pbbo_index;
25 	bool validate_mapped;
26 
27 	struct list_head vma_list;
28 	unsigned page_shift;
29 
30 	struct nouveau_cli *cli;
31 
32 	u32 tile_mode;
33 	u32 tile_flags;
34 	struct nouveau_drm_tile *tile;
35 
36 	/* Only valid if allocated via nouveau_gem_new() and iff you hold a
37 	 * gem reference to it! For debugging, use gem.filp != NULL to test
38 	 * whether it is valid. */
39 	struct drm_gem_object gem;
40 
41 	/* protect by the ttm reservation lock */
42 	int pin_refcnt;
43 
44 	struct ttm_bo_kmap_obj dma_buf_vmap;
45 };
46 
47 static inline struct nouveau_bo *
48 nouveau_bo(struct ttm_buffer_object *bo)
49 {
50 	return container_of(bo, struct nouveau_bo, bo);
51 }
52 
53 static inline int
54 nouveau_bo_ref(struct nouveau_bo *ref, struct nouveau_bo **pnvbo)
55 {
56 	struct nouveau_bo *prev;
57 
58 	if (!pnvbo)
59 		return -EINVAL;
60 	prev = *pnvbo;
61 
62 	*pnvbo = ref ? nouveau_bo(ttm_bo_reference(&ref->bo)) : NULL;
63 	if (prev) {
64 		struct ttm_buffer_object *bo = &prev->bo;
65 
66 		ttm_bo_unref(&bo);
67 	}
68 
69 	return 0;
70 }
71 
72 extern struct ttm_bo_driver nouveau_bo_driver;
73 
74 void nouveau_bo_move_init(struct nouveau_drm *);
75 int  nouveau_bo_new(struct nouveau_cli *, u64 size, int align, u32 flags,
76 		    u32 tile_mode, u32 tile_flags, struct sg_table *sg,
77 		    struct reservation_object *robj,
78 		    struct nouveau_bo **);
79 int  nouveau_bo_pin(struct nouveau_bo *, u32 flags, bool contig);
80 int  nouveau_bo_unpin(struct nouveau_bo *);
81 int  nouveau_bo_map(struct nouveau_bo *);
82 void nouveau_bo_unmap(struct nouveau_bo *);
83 void nouveau_bo_placement_set(struct nouveau_bo *, u32 type, u32 busy);
84 void nouveau_bo_wr16(struct nouveau_bo *, unsigned index, u16 val);
85 u32  nouveau_bo_rd32(struct nouveau_bo *, unsigned index);
86 void nouveau_bo_wr32(struct nouveau_bo *, unsigned index, u32 val);
87 void nouveau_bo_fence(struct nouveau_bo *, struct nouveau_fence *, bool exclusive);
88 int  nouveau_bo_validate(struct nouveau_bo *, bool interruptible,
89 			 bool no_wait_gpu);
90 void nouveau_bo_sync_for_device(struct nouveau_bo *nvbo);
91 void nouveau_bo_sync_for_cpu(struct nouveau_bo *nvbo);
92 
93 struct nvkm_vma *
94 nouveau_bo_vma_find(struct nouveau_bo *, struct nvkm_vm *);
95 
96 int  nouveau_bo_vma_add(struct nouveau_bo *, struct nvkm_vm *,
97 			struct nvkm_vma *);
98 void nouveau_bo_vma_del(struct nouveau_bo *, struct nvkm_vma *);
99 
100 /* TODO: submit equivalent to TTM generic API upstream? */
101 static inline void __iomem *
102 nvbo_kmap_obj_iovirtual(struct nouveau_bo *nvbo)
103 {
104 	bool is_iomem;
105 	void __iomem *ioptr = (void __force __iomem *)ttm_kmap_obj_virtual(
106 						&nvbo->kmap, &is_iomem);
107 	WARN_ON_ONCE(ioptr && !is_iomem);
108 	return ioptr;
109 }
110 
111 #endif
112