1/* SPDX-License-Identifier: MIT */
2#ifndef __NOUVEAU_BO_H__
3#define __NOUVEAU_BO_H__
4#include <drm/ttm/ttm_bo_driver.h>
5#include <drm/drm_gem.h>
6
7struct nouveau_channel;
8struct nouveau_cli;
9struct nouveau_drm;
10struct nouveau_fence;
11
12struct nouveau_bo {
13	struct ttm_buffer_object bo;
14	struct ttm_placement placement;
15	u32 valid_domains;
16	struct ttm_place placements[3];
17	struct ttm_place busy_placements[3];
18	bool force_coherent;
19	struct ttm_bo_kmap_obj kmap;
20	struct list_head head;
21	struct list_head io_reserve_lru;
22
23	/* protected by ttm_bo_reserve() */
24	struct drm_file *reserved_by;
25	struct list_head entry;
26	int pbbo_index;
27	bool validate_mapped;
28
29	/* GPU address space is independent of CPU word size */
30	uint64_t offset;
31
32	struct list_head vma_list;
33
34	unsigned contig:1;
35	unsigned page:5;
36	unsigned kind:8;
37	unsigned comp:3;
38	unsigned zeta:3;
39	unsigned mode;
40
41	struct nouveau_drm_tile *tile;
42
43	/* protect by the ttm reservation lock */
44	int pin_refcnt;
45
46	struct ttm_bo_kmap_obj dma_buf_vmap;
47};
48
49static inline struct nouveau_bo *
50nouveau_bo(struct ttm_buffer_object *bo)
51{
52	return container_of(bo, struct nouveau_bo, bo);
53}
54
55static inline int
56nouveau_bo_ref(struct nouveau_bo *ref, struct nouveau_bo **pnvbo)
57{
58	struct nouveau_bo *prev;
59
60	if (!pnvbo)
61		return -EINVAL;
62	prev = *pnvbo;
63
64	if (ref) {
65		ttm_bo_get(&ref->bo);
66		*pnvbo = nouveau_bo(&ref->bo);
67	} else {
68		*pnvbo = NULL;
69	}
70	if (prev)
71		ttm_bo_put(&prev->bo);
72
73	return 0;
74}
75
76extern struct ttm_bo_driver nouveau_bo_driver;
77
78void nouveau_bo_move_init(struct nouveau_drm *);
79struct nouveau_bo *nouveau_bo_alloc(struct nouveau_cli *, u64 *size, int *align,
80				    u32 domain, u32 tile_mode, u32 tile_flags);
81int  nouveau_bo_init(struct nouveau_bo *, u64 size, int align, u32 domain,
82		     struct sg_table *sg, struct dma_resv *robj);
83int  nouveau_bo_new(struct nouveau_cli *, u64 size, int align, u32 domain,
84		    u32 tile_mode, u32 tile_flags, struct sg_table *sg,
85		    struct dma_resv *robj,
86		    struct nouveau_bo **);
87int  nouveau_bo_pin(struct nouveau_bo *, u32 flags, bool contig);
88int  nouveau_bo_unpin(struct nouveau_bo *);
89int  nouveau_bo_map(struct nouveau_bo *);
90void nouveau_bo_unmap(struct nouveau_bo *);
91void nouveau_bo_placement_set(struct nouveau_bo *, u32 type, u32 busy);
92void nouveau_bo_wr16(struct nouveau_bo *, unsigned index, u16 val);
93u32  nouveau_bo_rd32(struct nouveau_bo *, unsigned index);
94void nouveau_bo_wr32(struct nouveau_bo *, unsigned index, u32 val);
95void nouveau_bo_fence(struct nouveau_bo *, struct nouveau_fence *, bool exclusive);
96int  nouveau_bo_validate(struct nouveau_bo *, bool interruptible,
97			 bool no_wait_gpu);
98void nouveau_bo_sync_for_device(struct nouveau_bo *nvbo);
99void nouveau_bo_sync_for_cpu(struct nouveau_bo *nvbo);
100void nouveau_bo_add_io_reserve_lru(struct ttm_buffer_object *bo);
101void nouveau_bo_del_io_reserve_lru(struct ttm_buffer_object *bo);
102
103/* TODO: submit equivalent to TTM generic API upstream? */
104static inline void __iomem *
105nvbo_kmap_obj_iovirtual(struct nouveau_bo *nvbo)
106{
107	bool is_iomem;
108	void __iomem *ioptr = (void __force __iomem *)ttm_kmap_obj_virtual(
109						&nvbo->kmap, &is_iomem);
110	WARN_ON_ONCE(ioptr && !is_iomem);
111	return ioptr;
112}
113
114static inline void
115nouveau_bo_unmap_unpin_unref(struct nouveau_bo **pnvbo)
116{
117	if (*pnvbo) {
118		nouveau_bo_unmap(*pnvbo);
119		nouveau_bo_unpin(*pnvbo);
120		nouveau_bo_ref(NULL, pnvbo);
121	}
122}
123
124static inline int
125nouveau_bo_new_pin_map(struct nouveau_cli *cli, u64 size, int align, u32 domain,
126		       struct nouveau_bo **pnvbo)
127{
128	int ret = nouveau_bo_new(cli, size, align, domain,
129				 0, 0, NULL, NULL, pnvbo);
130	if (ret == 0) {
131		ret = nouveau_bo_pin(*pnvbo, domain, true);
132		if (ret == 0) {
133			ret = nouveau_bo_map(*pnvbo);
134			if (ret == 0)
135				return ret;
136			nouveau_bo_unpin(*pnvbo);
137		}
138		nouveau_bo_ref(NULL, pnvbo);
139	}
140	return ret;
141}
142
143int nv04_bo_move_init(struct nouveau_channel *, u32);
144int nv04_bo_move_m2mf(struct nouveau_channel *, struct ttm_buffer_object *,
145		      struct ttm_resource *, struct ttm_resource *);
146
147int nv50_bo_move_init(struct nouveau_channel *, u32);
148int nv50_bo_move_m2mf(struct nouveau_channel *, struct ttm_buffer_object *,
149		      struct ttm_resource *, struct ttm_resource *);
150
151int nv84_bo_move_exec(struct nouveau_channel *, struct ttm_buffer_object *,
152		      struct ttm_resource *, struct ttm_resource *);
153
154int nva3_bo_move_copy(struct nouveau_channel *, struct ttm_buffer_object *,
155		      struct ttm_resource *, struct ttm_resource *);
156
157int nvc0_bo_move_init(struct nouveau_channel *, u32);
158int nvc0_bo_move_m2mf(struct nouveau_channel *, struct ttm_buffer_object *,
159		      struct ttm_resource *, struct ttm_resource *);
160
161int nvc0_bo_move_copy(struct nouveau_channel *, struct ttm_buffer_object *,
162		      struct ttm_resource *, struct ttm_resource *);
163
164int nve0_bo_move_init(struct nouveau_channel *, u32);
165int nve0_bo_move_copy(struct nouveau_channel *, struct ttm_buffer_object *,
166		      struct ttm_resource *, struct ttm_resource *);
167
168#define NVBO_WR32_(b,o,dr,f) nouveau_bo_wr32((b), (o)/4 + (dr), (f))
169#define NVBO_RD32_(b,o,dr)   nouveau_bo_rd32((b), (o)/4 + (dr))
170#define NVBO_RD32(A...) DRF_RD(NVBO_RD32_,                  ##A)
171#define NVBO_RV32(A...) DRF_RV(NVBO_RD32_,                  ##A)
172#define NVBO_TV32(A...) DRF_TV(NVBO_RD32_,                  ##A)
173#define NVBO_TD32(A...) DRF_TD(NVBO_RD32_,                  ##A)
174#define NVBO_WR32(A...) DRF_WR(            NVBO_WR32_,      ##A)
175#define NVBO_WV32(A...) DRF_WV(            NVBO_WR32_,      ##A)
176#define NVBO_WD32(A...) DRF_WD(            NVBO_WR32_,      ##A)
177#define NVBO_MR32(A...) DRF_MR(NVBO_RD32_, NVBO_WR32_, u32, ##A)
178#define NVBO_MV32(A...) DRF_MV(NVBO_RD32_, NVBO_WR32_, u32, ##A)
179#define NVBO_MD32(A...) DRF_MD(NVBO_RD32_, NVBO_WR32_, u32, ##A)
180#endif
181