xref: /linux/drivers/gpu/drm/drm_fbdev_shmem.c (revision face6a3615a649456eb4549f6d474221d877d604)
1 // SPDX-License-Identifier: MIT
2 
3 #include <linux/export.h>
4 #include <linux/fb.h>
5 
6 #include <drm/drm_drv.h>
7 #include <drm/drm_fbdev_shmem.h>
8 #include <drm/drm_fb_helper.h>
9 #include <drm/drm_framebuffer.h>
10 #include <drm/drm_gem_framebuffer_helper.h>
11 #include <drm/drm_gem_shmem_helper.h>
12 
13 /*
14  * struct fb_ops
15  */
16 
17 static int drm_fbdev_shmem_fb_open(struct fb_info *info, int user)
18 {
19 	struct drm_fb_helper *fb_helper = info->par;
20 
21 	/* No need to take a ref for fbcon because it unbinds on unregister */
22 	if (user && !try_module_get(fb_helper->dev->driver->fops->owner))
23 		return -ENODEV;
24 
25 	return 0;
26 }
27 
28 static int drm_fbdev_shmem_fb_release(struct fb_info *info, int user)
29 {
30 	struct drm_fb_helper *fb_helper = info->par;
31 
32 	if (user)
33 		module_put(fb_helper->dev->driver->fops->owner);
34 
35 	return 0;
36 }
37 
38 FB_GEN_DEFAULT_DEFERRED_SYSMEM_OPS(drm_fbdev_shmem,
39 				   drm_fb_helper_damage_range,
40 				   drm_fb_helper_damage_area);
41 
42 static int drm_fbdev_shmem_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
43 {
44 	struct drm_fb_helper *fb_helper = info->par;
45 	struct drm_framebuffer *fb = fb_helper->fb;
46 	struct drm_gem_object *obj = drm_gem_fb_get_obj(fb, 0);
47 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
48 
49 	if (shmem->map_wc)
50 		vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
51 
52 	return fb_deferred_io_mmap(info, vma);
53 }
54 
55 static void drm_fbdev_shmem_fb_destroy(struct fb_info *info)
56 {
57 	struct drm_fb_helper *fb_helper = info->par;
58 
59 	if (!fb_helper->dev)
60 		return;
61 
62 	fb_deferred_io_cleanup(info);
63 	drm_fb_helper_fini(fb_helper);
64 
65 	drm_client_buffer_vunmap(fb_helper->buffer);
66 	drm_client_framebuffer_delete(fb_helper->buffer);
67 	drm_client_release(&fb_helper->client);
68 }
69 
70 static const struct fb_ops drm_fbdev_shmem_fb_ops = {
71 	.owner = THIS_MODULE,
72 	.fb_open = drm_fbdev_shmem_fb_open,
73 	.fb_release = drm_fbdev_shmem_fb_release,
74 	__FB_DEFAULT_DEFERRED_OPS_RDWR(drm_fbdev_shmem),
75 	DRM_FB_HELPER_DEFAULT_OPS,
76 	__FB_DEFAULT_DEFERRED_OPS_DRAW(drm_fbdev_shmem),
77 	.fb_mmap = drm_fbdev_shmem_fb_mmap,
78 	.fb_destroy = drm_fbdev_shmem_fb_destroy,
79 };
80 
81 static struct page *drm_fbdev_shmem_get_page(struct fb_info *info, unsigned long offset)
82 {
83 	struct drm_fb_helper *fb_helper = info->par;
84 	struct drm_framebuffer *fb = fb_helper->fb;
85 	struct drm_gem_object *obj = drm_gem_fb_get_obj(fb, 0);
86 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
87 	unsigned int i = offset >> PAGE_SHIFT;
88 	struct page *page;
89 
90 	if (fb_WARN_ON_ONCE(info, offset > obj->size))
91 		return NULL;
92 
93 	page = shmem->pages[i]; // protected by active vmap
94 	if (page)
95 		get_page(page);
96 	fb_WARN_ON_ONCE(info, !page);
97 
98 	return page;
99 }
100 
101 /*
102  * struct drm_fb_helper
103  */
104 
105 static int drm_fbdev_shmem_helper_fb_dirty(struct drm_fb_helper *helper,
106 					   struct drm_clip_rect *clip)
107 {
108 	struct drm_device *dev = helper->dev;
109 	int ret;
110 
111 	/* Call damage handlers only if necessary */
112 	if (!(clip->x1 < clip->x2 && clip->y1 < clip->y2))
113 		return 0;
114 
115 	if (helper->fb->funcs->dirty) {
116 		ret = helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, clip, 1);
117 		if (drm_WARN_ONCE(dev, ret, "Dirty helper failed: ret=%d\n", ret))
118 			return ret;
119 	}
120 
121 	return 0;
122 }
123 
124 static const struct drm_fb_helper_funcs drm_fbdev_shmem_helper_funcs = {
125 	.fb_dirty = drm_fbdev_shmem_helper_fb_dirty,
126 };
127 
128 /*
129  * struct drm_driver
130  */
131 
132 int drm_fbdev_shmem_driver_fbdev_probe(struct drm_fb_helper *fb_helper,
133 				       struct drm_fb_helper_surface_size *sizes)
134 {
135 	struct drm_client_dev *client = &fb_helper->client;
136 	struct drm_device *dev = fb_helper->dev;
137 	struct drm_client_buffer *buffer;
138 	struct drm_gem_shmem_object *shmem;
139 	struct drm_framebuffer *fb;
140 	struct fb_info *info;
141 	u32 format;
142 	struct iosys_map map;
143 	int ret;
144 
145 	drm_dbg_kms(dev, "surface width(%d), height(%d) and bpp(%d)\n",
146 		    sizes->surface_width, sizes->surface_height,
147 		    sizes->surface_bpp);
148 
149 	format = drm_driver_legacy_fb_format(dev, sizes->surface_bpp, sizes->surface_depth);
150 	buffer = drm_client_framebuffer_create(client, sizes->surface_width,
151 					       sizes->surface_height, format);
152 	if (IS_ERR(buffer))
153 		return PTR_ERR(buffer);
154 	shmem = to_drm_gem_shmem_obj(buffer->gem);
155 
156 	fb = buffer->fb;
157 
158 	ret = drm_client_buffer_vmap(buffer, &map);
159 	if (ret) {
160 		goto err_drm_client_buffer_delete;
161 	} else if (drm_WARN_ON(dev, map.is_iomem)) {
162 		ret = -ENODEV; /* I/O memory not supported; use generic emulation */
163 		goto err_drm_client_buffer_delete;
164 	}
165 
166 	fb_helper->funcs = &drm_fbdev_shmem_helper_funcs;
167 	fb_helper->buffer = buffer;
168 	fb_helper->fb = fb;
169 
170 	info = drm_fb_helper_alloc_info(fb_helper);
171 	if (IS_ERR(info)) {
172 		ret = PTR_ERR(info);
173 		goto err_drm_client_buffer_vunmap;
174 	}
175 
176 	drm_fb_helper_fill_info(info, fb_helper, sizes);
177 
178 	info->fbops = &drm_fbdev_shmem_fb_ops;
179 
180 	/* screen */
181 	info->flags |= FBINFO_VIRTFB; /* system memory */
182 	if (!shmem->map_wc)
183 		info->flags |= FBINFO_READS_FAST; /* signal caching */
184 	info->screen_size = sizes->surface_height * fb->pitches[0];
185 	info->screen_buffer = map.vaddr;
186 	info->fix.smem_len = info->screen_size;
187 
188 	/* deferred I/O */
189 	fb_helper->fbdefio.delay = HZ / 20;
190 	fb_helper->fbdefio.get_page = drm_fbdev_shmem_get_page;
191 	fb_helper->fbdefio.deferred_io = drm_fb_helper_deferred_io;
192 
193 	info->fbdefio = &fb_helper->fbdefio;
194 	ret = fb_deferred_io_init(info);
195 	if (ret)
196 		goto err_drm_fb_helper_release_info;
197 
198 	return 0;
199 
200 err_drm_fb_helper_release_info:
201 	drm_fb_helper_release_info(fb_helper);
202 err_drm_client_buffer_vunmap:
203 	fb_helper->fb = NULL;
204 	fb_helper->buffer = NULL;
205 	drm_client_buffer_vunmap(buffer);
206 err_drm_client_buffer_delete:
207 	drm_client_framebuffer_delete(buffer);
208 	return ret;
209 }
210 EXPORT_SYMBOL(drm_fbdev_shmem_driver_fbdev_probe);
211