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 I915_ALLOC_CONTIGUOUS     BIT(0)
44 
45 #define for_each_memory_region(mr, i915, id) \
46 	for (id = 0; id < ARRAY_SIZE((i915)->mm.regions); id++) \
47 		for_each_if((mr) = (i915)->mm.regions[id])
48 
49 struct intel_memory_region_ops {
50 	int (*init)(struct intel_memory_region *mem);
51 	int (*release)(struct intel_memory_region *mem);
52 
53 	int (*init_object)(struct intel_memory_region *mem,
54 			   struct drm_i915_gem_object *obj,
55 			   resource_size_t offset,
56 			   resource_size_t size,
57 			   resource_size_t page_size,
58 			   unsigned int flags);
59 };
60 
61 struct intel_memory_region {
62 	struct drm_i915_private *i915;
63 
64 	const struct intel_memory_region_ops *ops;
65 
66 	struct io_mapping iomap;
67 	struct resource region;
68 
69 	struct resource io;
70 	resource_size_t min_page_size;
71 	resource_size_t total;
72 
73 	u16 type;
74 	u16 instance;
75 	enum intel_region_id id;
76 	char name[16];
77 	char uabi_name[16];
78 	bool private; /* not for userspace */
79 
80 	struct {
81 		struct rwlock lock; /* Protects access to objects */
82 		struct list_head list;
83 	} objects;
84 
85 	bool is_range_manager;
86 
87 	void *region_private;
88 };
89 
90 struct intel_memory_region *
91 intel_memory_region_lookup(struct drm_i915_private *i915,
92 			   u16 class, u16 instance);
93 
94 struct intel_memory_region *
95 intel_memory_region_create(struct drm_i915_private *i915,
96 			   resource_size_t start,
97 			   resource_size_t size,
98 			   resource_size_t min_page_size,
99 			   resource_size_t io_start,
100 			   resource_size_t io_size,
101 			   u16 type,
102 			   u16 instance,
103 			   const struct intel_memory_region_ops *ops);
104 
105 void intel_memory_region_destroy(struct intel_memory_region *mem);
106 
107 int intel_memory_regions_hw_probe(struct drm_i915_private *i915);
108 void intel_memory_regions_driver_release(struct drm_i915_private *i915);
109 struct intel_memory_region *
110 intel_memory_region_by_type(struct drm_i915_private *i915,
111 			    enum intel_memory_type mem_type);
112 
113 __printf(2, 3) void
114 intel_memory_region_set_name(struct intel_memory_region *mem,
115 			     const char *fmt, ...);
116 
117 int intel_memory_region_reserve(struct intel_memory_region *mem,
118 				resource_size_t offset,
119 				resource_size_t size);
120 
121 void intel_memory_region_debug(struct intel_memory_region *mr,
122 			       struct drm_printer *printer);
123 
124 void intel_memory_region_avail(struct intel_memory_region *mr,
125 			       u64 *avail, u64 *visible_avail);
126 
127 struct intel_memory_region *
128 i915_gem_ttm_system_setup(struct drm_i915_private *i915,
129 			  u16 type, u16 instance);
130 struct intel_memory_region *
131 i915_gem_shmem_setup(struct drm_i915_private *i915,
132 		     u16 type, u16 instance);
133 
134 #endif
135