accel/ivpu: Add GEM buffer object management
[linux-2.6-microblaze.git] / drivers / accel / ivpu / ivpu_gem.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2020-2023 Intel Corporation
4  */
5 #ifndef __IVPU_GEM_H__
6 #define __IVPU_GEM_H__
7
8 #include <drm/drm_gem.h>
9 #include <drm/drm_mm.h>
10
11 struct dma_buf;
12 struct ivpu_bo_ops;
13 struct ivpu_file_priv;
14
15 struct ivpu_bo {
16         struct drm_gem_object base;
17         const struct ivpu_bo_ops *ops;
18
19         struct ivpu_mmu_context *ctx;
20         struct list_head ctx_node;
21         struct drm_mm_node mm_node;
22
23         struct mutex lock; /* Protects: pages, sgt, mmu_mapped */
24         struct sg_table *sgt;
25         struct page **pages;
26         bool mmu_mapped;
27
28         void *kvaddr;
29         u64 vpu_addr;
30         u32 handle;
31         u32 flags;
32         uintptr_t user_ptr;
33 };
34
35 enum ivpu_bo_type {
36         IVPU_BO_TYPE_SHMEM = 1,
37         IVPU_BO_TYPE_INTERNAL,
38         IVPU_BO_TYPE_PRIME,
39 };
40
41 struct ivpu_bo_ops {
42         enum ivpu_bo_type type;
43         const char *name;
44         int (*alloc_pages)(struct ivpu_bo *bo);
45         void (*free_pages)(struct ivpu_bo *bo);
46         int (*map_pages)(struct ivpu_bo *bo);
47         void (*unmap_pages)(struct ivpu_bo *bo);
48 };
49
50 int ivpu_bo_pin(struct ivpu_bo *bo);
51 void ivpu_bo_remove_all_bos_from_context(struct ivpu_mmu_context *ctx);
52 void ivpu_bo_list(struct drm_device *dev, struct drm_printer *p);
53 void ivpu_bo_list_print(struct drm_device *dev);
54
55 struct ivpu_bo *
56 ivpu_bo_alloc_internal(struct ivpu_device *vdev, u64 vpu_addr, u64 size, u32 flags);
57 void ivpu_bo_free_internal(struct ivpu_bo *bo);
58 struct drm_gem_object *ivpu_gem_prime_import(struct drm_device *dev, struct dma_buf *dma_buf);
59 void ivpu_bo_unmap_sgt_and_remove_from_context(struct ivpu_bo *bo);
60
61 int ivpu_bo_create_ioctl(struct drm_device *dev, void *data, struct drm_file *file);
62 int ivpu_bo_info_ioctl(struct drm_device *dev, void *data, struct drm_file *file);
63 int ivpu_bo_wait_ioctl(struct drm_device *dev, void *data, struct drm_file *file);
64
65 static inline struct ivpu_bo *to_ivpu_bo(struct drm_gem_object *obj)
66 {
67         return container_of(obj, struct ivpu_bo, base);
68 }
69
70 static inline struct page *ivpu_bo_get_page(struct ivpu_bo *bo, u64 offset)
71 {
72         if (offset > bo->base.size || !bo->pages)
73                 return NULL;
74
75         return bo->pages[offset / PAGE_SIZE];
76 }
77
78 static inline u32 ivpu_bo_cache_mode(struct ivpu_bo *bo)
79 {
80         return bo->flags & DRM_IVPU_BO_CACHE_MASK;
81 }
82
83 static inline bool ivpu_bo_is_snooped(struct ivpu_bo *bo)
84 {
85         return ivpu_bo_cache_mode(bo) == DRM_IVPU_BO_CACHED;
86 }
87
88 static inline pgprot_t ivpu_bo_pgprot(struct ivpu_bo *bo, pgprot_t prot)
89 {
90         if (bo->flags & DRM_IVPU_BO_WC)
91                 return pgprot_writecombine(prot);
92
93         if (bo->flags & DRM_IVPU_BO_UNCACHED)
94                 return pgprot_noncached(prot);
95
96         return prot;
97 }
98
99 static inline struct ivpu_device *ivpu_bo_to_vdev(struct ivpu_bo *bo)
100 {
101         return to_ivpu_device(bo->base.dev);
102 }
103
104 static inline void *ivpu_to_cpu_addr(struct ivpu_bo *bo, u32 vpu_addr)
105 {
106         if (vpu_addr < bo->vpu_addr)
107                 return NULL;
108
109         if (vpu_addr >= (bo->vpu_addr + bo->base.size))
110                 return NULL;
111
112         return bo->kvaddr + (vpu_addr - bo->vpu_addr);
113 }
114
115 static inline u32 cpu_to_vpu_addr(struct ivpu_bo *bo, void *cpu_addr)
116 {
117         if (cpu_addr < bo->kvaddr)
118                 return 0;
119
120         if (cpu_addr >= (bo->kvaddr + bo->base.size))
121                 return 0;
122
123         return bo->vpu_addr + (cpu_addr - bo->kvaddr);
124 }
125
126 #endif /* __IVPU_GEM_H__ */