xref: /openbsd-src/sys/dev/pci/drm/i915/intel_memory_region.h (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1 /* SPDX-License-Identifier: MIT */
2 /*
3  * Copyright © 2019 Intel Corporation
4  */
5 
6 #ifndef __INTEL_MEMORY_REGION_H__
7 #define __INTEL_MEMORY_REGION_H__
8 
9 #include <linux/ioport.h>
10 #include <linux/mutex.h>
11 #include <linux/io-mapping.h>
12 #include <drm/drm_mm.h>
13 #include <uapi/drm/i915_drm.h>
14 
15 #define drm_i915_private inteldrm_softc
16 
17 struct drm_i915_private;
18 struct drm_i915_gem_object;
19 struct drm_printer;
20 struct intel_memory_region;
21 struct sg_table;
22 struct ttm_resource;
23 
24 enum intel_memory_type {
25 	INTEL_MEMORY_SYSTEM = I915_MEMORY_CLASS_SYSTEM,
26 	INTEL_MEMORY_LOCAL = I915_MEMORY_CLASS_DEVICE,
27 	INTEL_MEMORY_STOLEN_SYSTEM,
28 	INTEL_MEMORY_STOLEN_LOCAL,
29 	INTEL_MEMORY_MOCK,
30 };
31 
32 enum intel_region_id {
33 	INTEL_REGION_SMEM = 0,
34 	INTEL_REGION_LMEM_0,
35 	INTEL_REGION_LMEM_1,
36 	INTEL_REGION_LMEM_2,
37 	INTEL_REGION_LMEM_3,
38 	INTEL_REGION_STOLEN_SMEM,
39 	INTEL_REGION_STOLEN_LMEM,
40 	INTEL_REGION_UNKNOWN, /* Should be last */
41 };
42 
43 #define REGION_SMEM     BIT(INTEL_REGION_SMEM)
44 #define REGION_LMEM     BIT(INTEL_REGION_LMEM_0)
45 #define REGION_STOLEN_SMEM   BIT(INTEL_REGION_STOLEN_SMEM)
46 #define REGION_STOLEN_LMEM   BIT(INTEL_REGION_STOLEN_LMEM)
47 
48 #define I915_ALLOC_CONTIGUOUS     BIT(0)
49 
50 #define for_each_memory_region(mr, i915, id) \
51 	for (id = 0; id < ARRAY_SIZE((i915)->mm.regions); id++) \
52 		for_each_if((mr) = (i915)->mm.regions[id])
53 
54 struct intel_memory_region_ops {
55 	unsigned int flags;
56 
57 	int (*init)(struct intel_memory_region *mem);
58 	int (*release)(struct intel_memory_region *mem);
59 
60 	int (*init_object)(struct intel_memory_region *mem,
61 			   struct drm_i915_gem_object *obj,
62 			   resource_size_t offset,
63 			   resource_size_t size,
64 			   resource_size_t page_size,
65 			   unsigned int flags);
66 };
67 
68 struct intel_memory_region {
69 	struct drm_i915_private *i915;
70 
71 	const struct intel_memory_region_ops *ops;
72 
73 #ifdef notyet
74 	struct io_mapping iomap;
75 #endif
76 	struct resource region;
77 
78 	resource_size_t io_start;
79 	resource_size_t io_size;
80 	resource_size_t min_page_size;
81 	resource_size_t total;
82 
83 	u16 type;
84 	u16 instance;
85 	enum intel_region_id id;
86 	char name[16];
87 	bool private; /* not for userspace */
88 
89 	struct {
90 		struct rwlock lock; /* Protects access to objects */
91 		struct list_head list;
92 	} objects;
93 
94 	bool is_range_manager;
95 
96 	void *region_private;
97 };
98 
99 struct intel_memory_region *
100 intel_memory_region_lookup(struct drm_i915_private *i915,
101 			   u16 class, u16 instance);
102 
103 struct intel_memory_region *
104 intel_memory_region_create(struct drm_i915_private *i915,
105 			   resource_size_t start,
106 			   resource_size_t size,
107 			   resource_size_t min_page_size,
108 			   resource_size_t io_start,
109 			   resource_size_t io_size,
110 			   u16 type,
111 			   u16 instance,
112 			   const struct intel_memory_region_ops *ops);
113 
114 void intel_memory_region_destroy(struct intel_memory_region *mem);
115 
116 int intel_memory_regions_hw_probe(struct drm_i915_private *i915);
117 void intel_memory_regions_driver_release(struct drm_i915_private *i915);
118 struct intel_memory_region *
119 intel_memory_region_by_type(struct drm_i915_private *i915,
120 			    enum intel_memory_type mem_type);
121 
122 __printf(2, 3) void
123 intel_memory_region_set_name(struct intel_memory_region *mem,
124 			     const char *fmt, ...);
125 
126 int intel_memory_region_reserve(struct intel_memory_region *mem,
127 				resource_size_t offset,
128 				resource_size_t size);
129 
130 void intel_memory_region_debug(struct intel_memory_region *mr,
131 			       struct drm_printer *printer);
132 
133 void intel_memory_region_avail(struct intel_memory_region *mr,
134 			       u64 *avail, u64 *visible_avail);
135 
136 struct intel_memory_region *
137 i915_gem_ttm_system_setup(struct drm_i915_private *i915,
138 			  u16 type, u16 instance);
139 struct intel_memory_region *
140 i915_gem_shmem_setup(struct drm_i915_private *i915,
141 		     u16 type, u16 instance);
142 
143 #endif
144