Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
drm/ttm: Update the struct ttm_operation_ctx kerneldoc
Update the kerneldoc with a more elaborate description of some members,
including the gfp_retry_mayfail member. Use inline kerneldoc.
Suggested-by: Simona Vetter <simona.vetter@ffwll.ch>
Signed-off-by: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Reviewed-by: Maarten Lankhorst <dev@lankhorst.se>
Acked-by: Christian König <christian.koening@amd.com>
Link: https://patch.msgid.link/20260317141856.237876-4-thomas.hellstrom@linux.intel.com
+19
-9
+19
-9
include/drm/ttm/ttm_bo.h
+19
-9
include/drm/ttm/ttm_bo.h
···
167
167
/**
168
168
* struct ttm_operation_ctx
169
169
*
170
-
* @interruptible: Sleep interruptible if sleeping.
171
-
* @no_wait_gpu: Return immediately if the GPU is busy.
172
-
* @gfp_retry_mayfail: Set the __GFP_RETRY_MAYFAIL when allocation pages.
173
-
* @allow_res_evict: Allow eviction of reserved BOs. Can be used when multiple
174
-
* BOs share the same reservation object.
175
-
* faults. Should only be used by TTM internally.
176
-
* @resv: Reservation object to allow reserved evictions with.
177
-
* @bytes_moved: Statistics on how many bytes have been moved.
178
-
*
179
170
* Context for TTM operations like changing buffer placement or general memory
180
171
* allocation.
181
172
*/
182
173
struct ttm_operation_ctx {
174
+
/** @interruptible: Sleep interruptible if sleeping. */
183
175
bool interruptible;
176
+
/** @no_wait_gpu: Return immediately if the GPU is busy. */
184
177
bool no_wait_gpu;
178
+
/**
179
+
* @gfp_retry_mayfail: Use __GFP_RETRY_MAYFAIL | __GFP_NOWARN
180
+
* when allocation pages. This is to avoid invoking the OOM
181
+
* killer when populating a buffer object, in order to
182
+
* forward the error for it to be dealt with.
183
+
*/
185
184
bool gfp_retry_mayfail;
185
+
/**
186
+
* @allow_res_evict: Allow eviction of reserved BOs. Can be used
187
+
* when multiple BOs share the same reservation object @resv.
188
+
*/
186
189
bool allow_res_evict;
190
+
/**
191
+
* @resv: Reservation object to be used together with
192
+
* @allow_res_evict.
193
+
*/
187
194
struct dma_resv *resv;
195
+
/**
196
+
* @bytes_moved: Statistics on how many bytes have been moved.
197
+
*/
188
198
uint64_t bytes_moved;
189
199
};
190
200