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
  7struct nouveau_channel;
  8struct nouveau_fence;
  9struct nvkm_vma;
 10
 11struct 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
 29	unsigned contig:1;
 30	unsigned page:5;
 31	unsigned kind:8;
 32	unsigned comp:3;
 33	unsigned zeta:3;
 34	unsigned mode;
 35
 36	struct nouveau_drm_tile *tile;
 37
 38	/* Only valid if allocated via nouveau_gem_new() and iff you hold a
 39	 * gem reference to it! For debugging, use gem.filp != NULL to test
 40	 * whether it is valid. */
 41	struct drm_gem_object gem;
 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	*pnvbo = ref ? nouveau_bo(ttm_bo_reference(&ref->bo)) : NULL;
 65	if (prev) {
 66		struct ttm_buffer_object *bo = &prev->bo;
 67
 68		ttm_bo_unref(&bo);
 69	}
 70
 71	return 0;
 72}
 73
 74extern struct ttm_bo_driver nouveau_bo_driver;
 75
 76void nouveau_bo_move_init(struct nouveau_drm *);
 77int  nouveau_bo_new(struct nouveau_cli *, u64 size, int align, u32 flags,
 78		    u32 tile_mode, u32 tile_flags, struct sg_table *sg,
 79		    struct reservation_object *robj,
 80		    struct nouveau_bo **);
 81int  nouveau_bo_pin(struct nouveau_bo *, u32 flags, bool contig);
 82int  nouveau_bo_unpin(struct nouveau_bo *);
 83int  nouveau_bo_map(struct nouveau_bo *);
 84void nouveau_bo_unmap(struct nouveau_bo *);
 85void nouveau_bo_placement_set(struct nouveau_bo *, u32 type, u32 busy);
 86void nouveau_bo_wr16(struct nouveau_bo *, unsigned index, u16 val);
 87u32  nouveau_bo_rd32(struct nouveau_bo *, unsigned index);
 88void nouveau_bo_wr32(struct nouveau_bo *, unsigned index, u32 val);
 89void nouveau_bo_fence(struct nouveau_bo *, struct nouveau_fence *, bool exclusive);
 90int  nouveau_bo_validate(struct nouveau_bo *, bool interruptible,
 91			 bool no_wait_gpu);
 92void nouveau_bo_sync_for_device(struct nouveau_bo *nvbo);
 93void nouveau_bo_sync_for_cpu(struct nouveau_bo *nvbo);
 94
 95/* TODO: submit equivalent to TTM generic API upstream? */
 96static inline void __iomem *
 97nvbo_kmap_obj_iovirtual(struct nouveau_bo *nvbo)
 98{
 99	bool is_iomem;
100	void __iomem *ioptr = (void __force __iomem *)ttm_kmap_obj_virtual(
101						&nvbo->kmap, &is_iomem);
102	WARN_ON_ONCE(ioptr && !is_iomem);
103	return ioptr;
104}
105
106static inline void
107nouveau_bo_unmap_unpin_unref(struct nouveau_bo **pnvbo)
108{
109	if (*pnvbo) {
110		nouveau_bo_unmap(*pnvbo);
111		nouveau_bo_unpin(*pnvbo);
112		nouveau_bo_ref(NULL, pnvbo);
113	}
114}
115
116static inline int
117nouveau_bo_new_pin_map(struct nouveau_cli *cli, u64 size, int align, u32 flags,
118		       struct nouveau_bo **pnvbo)
119{
120	int ret = nouveau_bo_new(cli, size, align, flags,
121				 0, 0, NULL, NULL, pnvbo);
122	if (ret == 0) {
123		ret = nouveau_bo_pin(*pnvbo, flags, true);
124		if (ret == 0) {
125			ret = nouveau_bo_map(*pnvbo);
126			if (ret == 0)
127				return ret;
128			nouveau_bo_unpin(*pnvbo);
129		}
130		nouveau_bo_ref(NULL, pnvbo);
131	}
132	return ret;
133}
134#endif