1 // SPDX-License-Identifier: MIT
2 /*
3  * Copyright © 2021 Intel Corporation
4  */
5 #include <drm/ttm/ttm_bo_driver.h>
6 #include <drm/ttm/ttm_device.h>
7 #include <drm/ttm/ttm_range_manager.h>
8 
9 #include "i915_drv.h"
10 #include "i915_scatterlist.h"
11 #include "i915_ttm_buddy_manager.h"
12 
13 #include "intel_region_ttm.h"
14 
15 #include "gem/i915_gem_ttm.h" /* For the funcs/ops export only */
16 /**
17  * DOC: TTM support structure
18  *
19  * The code in this file deals with setting up memory managers for TTM
20  * LMEM and MOCK regions and converting the output from
21  * the managers to struct sg_table, Basically providing the mapping from
22  * i915 GEM regions to TTM memory types and resource managers.
23  */
24 
25 /**
26  * intel_region_ttm_device_init - Initialize a TTM device
27  * @dev_priv: Pointer to an i915 device private structure.
28  *
29  * Return: 0 on success, negative error code on failure.
30  */
31 int intel_region_ttm_device_init(struct drm_i915_private *dev_priv)
32 {
33 	struct drm_device *drm = &dev_priv->drm;
34 
35 	return ttm_device_init(&dev_priv->bdev, i915_ttm_driver(),
36 			       drm->dev, drm->anon_inode->i_mapping,
37 			       drm->vma_offset_manager, false, false);
38 }
39 
40 /**
41  * intel_region_ttm_device_fini - Finalize a TTM device
42  * @dev_priv: Pointer to an i915 device private structure.
43  */
44 void intel_region_ttm_device_fini(struct drm_i915_private *dev_priv)
45 {
46 	ttm_device_fini(&dev_priv->bdev);
47 }
48 
49 /*
50  * Map the i915 memory regions to TTM memory types. We use the
51  * driver-private types for now, reserving TTM_PL_VRAM for stolen
52  * memory and TTM_PL_TT for GGTT use if decided to implement this.
53  */
54 int intel_region_to_ttm_type(const struct intel_memory_region *mem)
55 {
56 	int type;
57 
58 	GEM_BUG_ON(mem->type != INTEL_MEMORY_LOCAL &&
59 		   mem->type != INTEL_MEMORY_MOCK &&
60 		   mem->type != INTEL_MEMORY_SYSTEM);
61 
62 	if (mem->type == INTEL_MEMORY_SYSTEM)
63 		return TTM_PL_SYSTEM;
64 
65 	type = mem->instance + TTM_PL_PRIV;
66 	GEM_BUG_ON(type >= TTM_NUM_MEM_TYPES);
67 
68 	return type;
69 }
70 
71 /**
72  * intel_region_ttm_init - Initialize a memory region for TTM.
73  * @mem: The region to initialize.
74  *
75  * This function initializes a suitable TTM resource manager for the
76  * region, and if it's a LMEM region type, attaches it to the TTM
77  * device. MOCK regions are NOT attached to the TTM device, since we don't
78  * have one for the mock selftests.
79  *
80  * Return: 0 on success, negative error code on failure.
81  */
82 int intel_region_ttm_init(struct intel_memory_region *mem)
83 {
84 	struct ttm_device *bdev = &mem->i915->bdev;
85 	int mem_type = intel_region_to_ttm_type(mem);
86 	int ret;
87 
88 	ret = i915_ttm_buddy_man_init(bdev, mem_type, false,
89 				      resource_size(&mem->region), PAGE_SIZE);
90 	if (ret)
91 		return ret;
92 
93 	mem->region_private = ttm_manager_type(bdev, mem_type);
94 
95 	return 0;
96 }
97 
98 /**
99  * intel_region_ttm_fini - Finalize a TTM region.
100  * @mem: The memory region
101  *
102  * This functions takes down the TTM resource manager associated with the
103  * memory region, and if it was registered with the TTM device,
104  * removes that registration.
105  */
106 void intel_region_ttm_fini(struct intel_memory_region *mem)
107 {
108 	int ret;
109 
110 	ret = i915_ttm_buddy_man_fini(&mem->i915->bdev,
111 				      intel_region_to_ttm_type(mem));
112 	GEM_WARN_ON(ret);
113 	mem->region_private = NULL;
114 }
115 
116 /**
117  * intel_region_ttm_resource_to_st - Convert an opaque TTM resource manager resource
118  * to an sg_table.
119  * @mem: The memory region.
120  * @res: The resource manager resource obtained from the TTM resource manager.
121  *
122  * The gem backends typically use sg-tables for operations on the underlying
123  * io_memory. So provide a way for the backends to translate the
124  * nodes they are handed from TTM to sg-tables.
125  *
126  * Return: A malloced sg_table on success, an error pointer on failure.
127  */
128 struct sg_table *intel_region_ttm_resource_to_st(struct intel_memory_region *mem,
129 						 struct ttm_resource *res)
130 {
131 	if (mem->is_range_manager) {
132 		struct ttm_range_mgr_node *range_node =
133 			to_ttm_range_mgr_node(res);
134 
135 		return i915_sg_from_mm_node(&range_node->mm_nodes[0],
136 					    mem->region.start);
137 	} else {
138 		return i915_sg_from_buddy_resource(res, mem->region.start);
139 	}
140 }
141 
142 #ifdef CONFIG_DRM_I915_SELFTEST
143 /**
144  * intel_region_ttm_node_alloc - Allocate memory resources from a region
145  * @mem: The memory region,
146  * @size: The requested size in bytes
147  * @flags: Allocation flags
148  *
149  * This functionality is provided only for callers that need to allocate
150  * memory from standalone TTM range managers, without the TTM eviction
151  * functionality. Don't use if you are not completely sure that's the
152  * case. The returned opaque node can be converted to an sg_table using
153  * intel_region_ttm_node_to_st(), and can be freed using
154  * intel_region_ttm_node_free().
155  *
156  * Return: A valid pointer on success, an error pointer on failure.
157  */
158 struct ttm_resource *
159 intel_region_ttm_resource_alloc(struct intel_memory_region *mem,
160 				resource_size_t size,
161 				unsigned int flags)
162 {
163 	struct ttm_resource_manager *man = mem->region_private;
164 	struct ttm_place place = {};
165 	struct ttm_buffer_object mock_bo = {};
166 	struct ttm_resource *res;
167 	int ret;
168 
169 	mock_bo.base.size = size;
170 	mock_bo.page_alignment = mem->min_page_size >> PAGE_SHIFT;
171 	place.flags = flags;
172 
173 	ret = man->func->alloc(man, &mock_bo, &place, &res);
174 	if (ret == -ENOSPC)
175 		ret = -ENXIO;
176 	return ret ? ERR_PTR(ret) : res;
177 }
178 
179 #endif
180 
181 void intel_region_ttm_node_free(struct intel_memory_region *mem,
182 				struct ttm_resource *res)
183 {
184 	struct ttm_resource_manager *man = mem->region_private;
185 
186 	man->func->free(man, res);
187 }
188 
189 /**
190  * intel_region_ttm_resource_free - Free a resource allocated from a resource manager
191  * @mem: The region the resource was allocated from.
192  * @res: The opaque resource representing an allocation.
193  */
194 void intel_region_ttm_resource_free(struct intel_memory_region *mem,
195 				    struct ttm_resource *res)
196 {
197 	struct ttm_resource_manager *man = mem->region_private;
198 
199 	man->func->free(man, res);
200 }
201