Linux Audio

Check our new training course

In-person Linux kernel drivers training

Jun 16-20, 2025
Register
Loading...
Note: File does not exist in v6.13.7.
  1/*
  2 * This program is free software; you can redistribute it and/or modify
  3 * it under the terms of the GNU General Public License as published by
  4 * the Free Software Foundation; either version 2 of the License, or
  5 * (at your option) any later version.
  6 */
  7
  8#include "bochs.h"
  9
 10static void bochs_ttm_placement(struct bochs_bo *bo, int domain);
 11
 12/* ---------------------------------------------------------------------- */
 13
 14static inline struct bochs_device *bochs_bdev(struct ttm_bo_device *bd)
 15{
 16	return container_of(bd, struct bochs_device, ttm.bdev);
 17}
 18
 19static int bochs_ttm_mem_global_init(struct drm_global_reference *ref)
 20{
 21	return ttm_mem_global_init(ref->object);
 22}
 23
 24static void bochs_ttm_mem_global_release(struct drm_global_reference *ref)
 25{
 26	ttm_mem_global_release(ref->object);
 27}
 28
 29static int bochs_ttm_global_init(struct bochs_device *bochs)
 30{
 31	struct drm_global_reference *global_ref;
 32	int r;
 33
 34	global_ref = &bochs->ttm.mem_global_ref;
 35	global_ref->global_type = DRM_GLOBAL_TTM_MEM;
 36	global_ref->size = sizeof(struct ttm_mem_global);
 37	global_ref->init = &bochs_ttm_mem_global_init;
 38	global_ref->release = &bochs_ttm_mem_global_release;
 39	r = drm_global_item_ref(global_ref);
 40	if (r != 0) {
 41		DRM_ERROR("Failed setting up TTM memory accounting "
 42			  "subsystem.\n");
 43		return r;
 44	}
 45
 46	bochs->ttm.bo_global_ref.mem_glob =
 47		bochs->ttm.mem_global_ref.object;
 48	global_ref = &bochs->ttm.bo_global_ref.ref;
 49	global_ref->global_type = DRM_GLOBAL_TTM_BO;
 50	global_ref->size = sizeof(struct ttm_bo_global);
 51	global_ref->init = &ttm_bo_global_init;
 52	global_ref->release = &ttm_bo_global_release;
 53	r = drm_global_item_ref(global_ref);
 54	if (r != 0) {
 55		DRM_ERROR("Failed setting up TTM BO subsystem.\n");
 56		drm_global_item_unref(&bochs->ttm.mem_global_ref);
 57		return r;
 58	}
 59
 60	return 0;
 61}
 62
 63static void bochs_ttm_global_release(struct bochs_device *bochs)
 64{
 65	if (bochs->ttm.mem_global_ref.release == NULL)
 66		return;
 67
 68	drm_global_item_unref(&bochs->ttm.bo_global_ref.ref);
 69	drm_global_item_unref(&bochs->ttm.mem_global_ref);
 70	bochs->ttm.mem_global_ref.release = NULL;
 71}
 72
 73
 74static void bochs_bo_ttm_destroy(struct ttm_buffer_object *tbo)
 75{
 76	struct bochs_bo *bo;
 77
 78	bo = container_of(tbo, struct bochs_bo, bo);
 79	drm_gem_object_release(&bo->gem);
 80	kfree(bo);
 81}
 82
 83static bool bochs_ttm_bo_is_bochs_bo(struct ttm_buffer_object *bo)
 84{
 85	if (bo->destroy == &bochs_bo_ttm_destroy)
 86		return true;
 87	return false;
 88}
 89
 90static int bochs_bo_init_mem_type(struct ttm_bo_device *bdev, uint32_t type,
 91				  struct ttm_mem_type_manager *man)
 92{
 93	switch (type) {
 94	case TTM_PL_SYSTEM:
 95		man->flags = TTM_MEMTYPE_FLAG_MAPPABLE;
 96		man->available_caching = TTM_PL_MASK_CACHING;
 97		man->default_caching = TTM_PL_FLAG_CACHED;
 98		break;
 99	case TTM_PL_VRAM:
100		man->func = &ttm_bo_manager_func;
101		man->flags = TTM_MEMTYPE_FLAG_FIXED |
102			TTM_MEMTYPE_FLAG_MAPPABLE;
103		man->available_caching = TTM_PL_FLAG_UNCACHED |
104			TTM_PL_FLAG_WC;
105		man->default_caching = TTM_PL_FLAG_WC;
106		break;
107	default:
108		DRM_ERROR("Unsupported memory type %u\n", (unsigned)type);
109		return -EINVAL;
110	}
111	return 0;
112}
113
114static void
115bochs_bo_evict_flags(struct ttm_buffer_object *bo, struct ttm_placement *pl)
116{
117	struct bochs_bo *bochsbo = bochs_bo(bo);
118
119	if (!bochs_ttm_bo_is_bochs_bo(bo))
120		return;
121
122	bochs_ttm_placement(bochsbo, TTM_PL_FLAG_SYSTEM);
123	*pl = bochsbo->placement;
124}
125
126static int bochs_bo_verify_access(struct ttm_buffer_object *bo,
127				  struct file *filp)
128{
129	struct bochs_bo *bochsbo = bochs_bo(bo);
130
131	return drm_vma_node_verify_access(&bochsbo->gem.vma_node, filp);
132}
133
134static int bochs_ttm_io_mem_reserve(struct ttm_bo_device *bdev,
135				    struct ttm_mem_reg *mem)
136{
137	struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
138	struct bochs_device *bochs = bochs_bdev(bdev);
139
140	mem->bus.addr = NULL;
141	mem->bus.offset = 0;
142	mem->bus.size = mem->num_pages << PAGE_SHIFT;
143	mem->bus.base = 0;
144	mem->bus.is_iomem = false;
145	if (!(man->flags & TTM_MEMTYPE_FLAG_MAPPABLE))
146		return -EINVAL;
147	switch (mem->mem_type) {
148	case TTM_PL_SYSTEM:
149		/* system memory */
150		return 0;
151	case TTM_PL_VRAM:
152		mem->bus.offset = mem->start << PAGE_SHIFT;
153		mem->bus.base = bochs->fb_base;
154		mem->bus.is_iomem = true;
155		break;
156	default:
157		return -EINVAL;
158		break;
159	}
160	return 0;
161}
162
163static void bochs_ttm_io_mem_free(struct ttm_bo_device *bdev,
164				  struct ttm_mem_reg *mem)
165{
166}
167
168static int bochs_bo_move(struct ttm_buffer_object *bo,
169			 bool evict, bool interruptible,
170			 bool no_wait_gpu,
171			 struct ttm_mem_reg *new_mem)
172{
173	return ttm_bo_move_memcpy(bo, evict, no_wait_gpu, new_mem);
174}
175
176
177static void bochs_ttm_backend_destroy(struct ttm_tt *tt)
178{
179	ttm_tt_fini(tt);
180	kfree(tt);
181}
182
183static struct ttm_backend_func bochs_tt_backend_func = {
184	.destroy = &bochs_ttm_backend_destroy,
185};
186
187static struct ttm_tt *bochs_ttm_tt_create(struct ttm_bo_device *bdev,
188					  unsigned long size,
189					  uint32_t page_flags,
190					  struct page *dummy_read_page)
191{
192	struct ttm_tt *tt;
193
194	tt = kzalloc(sizeof(struct ttm_tt), GFP_KERNEL);
195	if (tt == NULL)
196		return NULL;
197	tt->func = &bochs_tt_backend_func;
198	if (ttm_tt_init(tt, bdev, size, page_flags, dummy_read_page)) {
199		kfree(tt);
200		return NULL;
201	}
202	return tt;
203}
204
205struct ttm_bo_driver bochs_bo_driver = {
206	.ttm_tt_create = bochs_ttm_tt_create,
207	.ttm_tt_populate = ttm_pool_populate,
208	.ttm_tt_unpopulate = ttm_pool_unpopulate,
209	.init_mem_type = bochs_bo_init_mem_type,
210	.evict_flags = bochs_bo_evict_flags,
211	.move = bochs_bo_move,
212	.verify_access = bochs_bo_verify_access,
213	.io_mem_reserve = &bochs_ttm_io_mem_reserve,
214	.io_mem_free = &bochs_ttm_io_mem_free,
215};
216
217int bochs_mm_init(struct bochs_device *bochs)
218{
219	struct ttm_bo_device *bdev = &bochs->ttm.bdev;
220	int ret;
221
222	ret = bochs_ttm_global_init(bochs);
223	if (ret)
224		return ret;
225
226	ret = ttm_bo_device_init(&bochs->ttm.bdev,
227				 bochs->ttm.bo_global_ref.ref.object,
228				 &bochs_bo_driver,
229				 bochs->dev->anon_inode->i_mapping,
230				 DRM_FILE_PAGE_OFFSET,
231				 true);
232	if (ret) {
233		DRM_ERROR("Error initialising bo driver; %d\n", ret);
234		return ret;
235	}
236
237	ret = ttm_bo_init_mm(bdev, TTM_PL_VRAM,
238			     bochs->fb_size >> PAGE_SHIFT);
239	if (ret) {
240		DRM_ERROR("Failed ttm VRAM init: %d\n", ret);
241		return ret;
242	}
243
244	bochs->ttm.initialized = true;
245	return 0;
246}
247
248void bochs_mm_fini(struct bochs_device *bochs)
249{
250	if (!bochs->ttm.initialized)
251		return;
252
253	ttm_bo_device_release(&bochs->ttm.bdev);
254	bochs_ttm_global_release(bochs);
255	bochs->ttm.initialized = false;
256}
257
258static void bochs_ttm_placement(struct bochs_bo *bo, int domain)
259{
260	u32 c = 0;
261	bo->placement.fpfn = 0;
262	bo->placement.lpfn = 0;
263	bo->placement.placement = bo->placements;
264	bo->placement.busy_placement = bo->placements;
265	if (domain & TTM_PL_FLAG_VRAM) {
266		bo->placements[c++] = TTM_PL_FLAG_WC | TTM_PL_FLAG_UNCACHED
267			| TTM_PL_FLAG_VRAM;
268	}
269	if (domain & TTM_PL_FLAG_SYSTEM) {
270		bo->placements[c++] = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM;
271	}
272	if (!c) {
273		bo->placements[c++] = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM;
274	}
275	bo->placement.num_placement = c;
276	bo->placement.num_busy_placement = c;
277}
278
279static inline u64 bochs_bo_gpu_offset(struct bochs_bo *bo)
280{
281	return bo->bo.offset;
282}
283
284int bochs_bo_pin(struct bochs_bo *bo, u32 pl_flag, u64 *gpu_addr)
285{
286	int i, ret;
287
288	if (bo->pin_count) {
289		bo->pin_count++;
290		if (gpu_addr)
291			*gpu_addr = bochs_bo_gpu_offset(bo);
292		return 0;
293	}
294
295	bochs_ttm_placement(bo, pl_flag);
296	for (i = 0; i < bo->placement.num_placement; i++)
297		bo->placements[i] |= TTM_PL_FLAG_NO_EVICT;
298	ret = ttm_bo_validate(&bo->bo, &bo->placement, false, false);
299	if (ret)
300		return ret;
301
302	bo->pin_count = 1;
303	if (gpu_addr)
304		*gpu_addr = bochs_bo_gpu_offset(bo);
305	return 0;
306}
307
308int bochs_bo_unpin(struct bochs_bo *bo)
309{
310	int i, ret;
311
312	if (!bo->pin_count) {
313		DRM_ERROR("unpin bad %p\n", bo);
314		return 0;
315	}
316	bo->pin_count--;
317
318	if (bo->pin_count)
319		return 0;
320
321	for (i = 0; i < bo->placement.num_placement; i++)
322		bo->placements[i] &= ~TTM_PL_FLAG_NO_EVICT;
323	ret = ttm_bo_validate(&bo->bo, &bo->placement, false, false);
324	if (ret)
325		return ret;
326
327	return 0;
328}
329
330int bochs_mmap(struct file *filp, struct vm_area_struct *vma)
331{
332	struct drm_file *file_priv;
333	struct bochs_device *bochs;
334
335	if (unlikely(vma->vm_pgoff < DRM_FILE_PAGE_OFFSET))
336		return drm_mmap(filp, vma);
337
338	file_priv = filp->private_data;
339	bochs = file_priv->minor->dev->dev_private;
340	return ttm_bo_mmap(filp, vma, &bochs->ttm.bdev);
341}
342
343/* ---------------------------------------------------------------------- */
344
345static int bochs_bo_create(struct drm_device *dev, int size, int align,
346			   uint32_t flags, struct bochs_bo **pbochsbo)
347{
348	struct bochs_device *bochs = dev->dev_private;
349	struct bochs_bo *bochsbo;
350	size_t acc_size;
351	int ret;
352
353	bochsbo = kzalloc(sizeof(struct bochs_bo), GFP_KERNEL);
354	if (!bochsbo)
355		return -ENOMEM;
356
357	ret = drm_gem_object_init(dev, &bochsbo->gem, size);
358	if (ret) {
359		kfree(bochsbo);
360		return ret;
361	}
362
363	bochsbo->bo.bdev = &bochs->ttm.bdev;
364	bochsbo->bo.bdev->dev_mapping = dev->anon_inode->i_mapping;
365
366	bochs_ttm_placement(bochsbo, TTM_PL_FLAG_VRAM | TTM_PL_FLAG_SYSTEM);
367
368	acc_size = ttm_bo_dma_acc_size(&bochs->ttm.bdev, size,
369				       sizeof(struct bochs_bo));
370
371	ret = ttm_bo_init(&bochs->ttm.bdev, &bochsbo->bo, size,
372			  ttm_bo_type_device, &bochsbo->placement,
373			  align >> PAGE_SHIFT, false, NULL, acc_size,
374			  NULL, bochs_bo_ttm_destroy);
375	if (ret)
376		return ret;
377
378	*pbochsbo = bochsbo;
379	return 0;
380}
381
382int bochs_gem_create(struct drm_device *dev, u32 size, bool iskernel,
383		     struct drm_gem_object **obj)
384{
385	struct bochs_bo *bochsbo;
386	int ret;
387
388	*obj = NULL;
389
390	size = ALIGN(size, PAGE_SIZE);
391	if (size == 0)
392		return -EINVAL;
393
394	ret = bochs_bo_create(dev, size, 0, 0, &bochsbo);
395	if (ret) {
396		if (ret != -ERESTARTSYS)
397			DRM_ERROR("failed to allocate GEM object\n");
398		return ret;
399	}
400	*obj = &bochsbo->gem;
401	return 0;
402}
403
404int bochs_dumb_create(struct drm_file *file, struct drm_device *dev,
405		      struct drm_mode_create_dumb *args)
406{
407	struct drm_gem_object *gobj;
408	u32 handle;
409	int ret;
410
411	args->pitch = args->width * ((args->bpp + 7) / 8);
412	args->size = args->pitch * args->height;
413
414	ret = bochs_gem_create(dev, args->size, false,
415			       &gobj);
416	if (ret)
417		return ret;
418
419	ret = drm_gem_handle_create(file, gobj, &handle);
420	drm_gem_object_unreference_unlocked(gobj);
421	if (ret)
422		return ret;
423
424	args->handle = handle;
425	return 0;
426}
427
428static void bochs_bo_unref(struct bochs_bo **bo)
429{
430	struct ttm_buffer_object *tbo;
431
432	if ((*bo) == NULL)
433		return;
434
435	tbo = &((*bo)->bo);
436	ttm_bo_unref(&tbo);
437	if (tbo == NULL)
438		*bo = NULL;
439
440}
441
442void bochs_gem_free_object(struct drm_gem_object *obj)
443{
444	struct bochs_bo *bochs_bo = gem_to_bochs_bo(obj);
445
446	if (!bochs_bo)
447		return;
448	bochs_bo_unref(&bochs_bo);
449}
450
451int bochs_dumb_mmap_offset(struct drm_file *file, struct drm_device *dev,
452			   uint32_t handle, uint64_t *offset)
453{
454	struct drm_gem_object *obj;
455	int ret;
456	struct bochs_bo *bo;
457
458	mutex_lock(&dev->struct_mutex);
459	obj = drm_gem_object_lookup(dev, file, handle);
460	if (obj == NULL) {
461		ret = -ENOENT;
462		goto out_unlock;
463	}
464
465	bo = gem_to_bochs_bo(obj);
466	*offset = bochs_bo_mmap_offset(bo);
467
468	drm_gem_object_unreference(obj);
469	ret = 0;
470out_unlock:
471	mutex_unlock(&dev->struct_mutex);
472	return ret;
473
474}
475
476/* ---------------------------------------------------------------------- */
477
478static void bochs_user_framebuffer_destroy(struct drm_framebuffer *fb)
479{
480	struct bochs_framebuffer *bochs_fb = to_bochs_framebuffer(fb);
481	if (bochs_fb->obj)
482		drm_gem_object_unreference_unlocked(bochs_fb->obj);
483	drm_framebuffer_cleanup(fb);
484	kfree(fb);
485}
486
487static const struct drm_framebuffer_funcs bochs_fb_funcs = {
488	.destroy = bochs_user_framebuffer_destroy,
489};
490
491int bochs_framebuffer_init(struct drm_device *dev,
492			   struct bochs_framebuffer *gfb,
493			   struct drm_mode_fb_cmd2 *mode_cmd,
494			   struct drm_gem_object *obj)
495{
496	int ret;
497
498	drm_helper_mode_fill_fb_struct(&gfb->base, mode_cmd);
499	gfb->obj = obj;
500	ret = drm_framebuffer_init(dev, &gfb->base, &bochs_fb_funcs);
501	if (ret) {
502		DRM_ERROR("drm_framebuffer_init failed: %d\n", ret);
503		return ret;
504	}
505	return 0;
506}
507
508static struct drm_framebuffer *
509bochs_user_framebuffer_create(struct drm_device *dev,
510			      struct drm_file *filp,
511			      struct drm_mode_fb_cmd2 *mode_cmd)
512{
513	struct drm_gem_object *obj;
514	struct bochs_framebuffer *bochs_fb;
515	int ret;
516
517	DRM_DEBUG_DRIVER("%dx%d, format %c%c%c%c\n",
518	       mode_cmd->width, mode_cmd->height,
519	       (mode_cmd->pixel_format)       & 0xff,
520	       (mode_cmd->pixel_format >> 8)  & 0xff,
521	       (mode_cmd->pixel_format >> 16) & 0xff,
522	       (mode_cmd->pixel_format >> 24) & 0xff);
523
524	if (mode_cmd->pixel_format != DRM_FORMAT_XRGB8888)
525		return ERR_PTR(-ENOENT);
526
527	obj = drm_gem_object_lookup(dev, filp, mode_cmd->handles[0]);
528	if (obj == NULL)
529		return ERR_PTR(-ENOENT);
530
531	bochs_fb = kzalloc(sizeof(*bochs_fb), GFP_KERNEL);
532	if (!bochs_fb) {
533		drm_gem_object_unreference_unlocked(obj);
534		return ERR_PTR(-ENOMEM);
535	}
536
537	ret = bochs_framebuffer_init(dev, bochs_fb, mode_cmd, obj);
538	if (ret) {
539		drm_gem_object_unreference_unlocked(obj);
540		kfree(bochs_fb);
541		return ERR_PTR(ret);
542	}
543	return &bochs_fb->base;
544}
545
546const struct drm_mode_config_funcs bochs_mode_funcs = {
547	.fb_create = bochs_user_framebuffer_create,
548};