xref: /linux/drivers/gpu/drm/omapdrm/omap_fbdev.c (revision face6a3615a649456eb4549f6d474221d877d604)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2011 Texas Instruments Incorporated - https://www.ti.com/
4  * Author: Rob Clark <rob@ti.com>
5  */
6 
7 #include <linux/fb.h>
8 
9 #include <drm/clients/drm_client_setup.h>
10 #include <drm/drm_drv.h>
11 #include <drm/drm_crtc_helper.h>
12 #include <drm/drm_fb_helper.h>
13 #include <drm/drm_file.h>
14 #include <drm/drm_fourcc.h>
15 #include <drm/drm_framebuffer.h>
16 #include <drm/drm_gem_framebuffer_helper.h>
17 #include <drm/drm_managed.h>
18 #include <drm/drm_util.h>
19 
20 #include "omap_drv.h"
21 #include "omap_fbdev.h"
22 
23 MODULE_PARM_DESC(ywrap, "Enable ywrap scrolling (omap44xx and later, default 'y')");
24 static bool ywrap_enabled = true;
25 module_param_named(ywrap, ywrap_enabled, bool, 0644);
26 
27 /*
28  * fbdev funcs, to implement legacy fbdev interface on top of drm driver
29  */
30 
31 struct omap_fbdev {
32 	struct drm_device *dev;
33 	bool ywrap_enabled;
34 
35 	/* for deferred dmm roll when getting called in atomic ctx */
36 	struct work_struct work;
37 };
38 
39 static struct drm_fb_helper *get_fb(struct fb_info *fbi);
40 
41 static void pan_worker(struct work_struct *work)
42 {
43 	struct omap_fbdev *fbdev = container_of(work, struct omap_fbdev, work);
44 	struct drm_fb_helper *helper = fbdev->dev->fb_helper;
45 	struct fb_info *fbi = helper->info;
46 	struct drm_gem_object *bo = drm_gem_fb_get_obj(helper->fb, 0);
47 	int npages;
48 
49 	/* DMM roll shifts in 4K pages: */
50 	npages = fbi->fix.line_length >> PAGE_SHIFT;
51 	omap_gem_roll(bo, fbi->var.yoffset * npages);
52 }
53 
54 FB_GEN_DEFAULT_DEFERRED_DMAMEM_OPS(omap_fbdev,
55 				   drm_fb_helper_damage_range,
56 				   drm_fb_helper_damage_area)
57 
58 static int omap_fbdev_pan_display(struct fb_var_screeninfo *var, struct fb_info *fbi)
59 {
60 	struct drm_fb_helper *helper = get_fb(fbi);
61 	struct omap_drm_private *priv;
62 	struct omap_fbdev *fbdev;
63 
64 	if (!helper)
65 		goto fallback;
66 
67 	priv = helper->dev->dev_private;
68 	fbdev = priv->fbdev;
69 
70 	if (!fbdev->ywrap_enabled)
71 		goto fallback;
72 
73 	if (drm_can_sleep())
74 		pan_worker(&fbdev->work);
75 	else
76 		queue_work(priv->wq, &fbdev->work);
77 
78 	return 0;
79 
80 fallback:
81 	return drm_fb_helper_pan_display(var, fbi);
82 }
83 
84 static int omap_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
85 {
86 	vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
87 
88 	return fb_deferred_io_mmap(info, vma);
89 }
90 
91 static void omap_fbdev_fb_destroy(struct fb_info *info)
92 {
93 	struct drm_fb_helper *helper = info->par;
94 	struct drm_framebuffer *fb = helper->fb;
95 	struct drm_gem_object *bo = drm_gem_fb_get_obj(fb, 0);
96 
97 	DBG();
98 
99 	fb_deferred_io_cleanup(info);
100 	drm_fb_helper_fini(helper);
101 
102 	omap_gem_unpin(bo);
103 	drm_framebuffer_remove(fb);
104 
105 	drm_client_release(&helper->client);
106 }
107 
108 /*
109  * For now, we cannot use FB_DEFAULT_DEFERRED_OPS and fb_deferred_io_mmap()
110  * because we use write-combine.
111  */
112 static const struct fb_ops omap_fb_ops = {
113 	.owner = THIS_MODULE,
114 	__FB_DEFAULT_DEFERRED_OPS_RDWR(omap_fbdev),
115 	.fb_check_var	= drm_fb_helper_check_var,
116 	.fb_set_par	= drm_fb_helper_set_par,
117 	.fb_setcmap	= drm_fb_helper_setcmap,
118 	.fb_blank	= drm_fb_helper_blank,
119 	.fb_pan_display = omap_fbdev_pan_display,
120 	__FB_DEFAULT_DEFERRED_OPS_DRAW(omap_fbdev),
121 	.fb_ioctl	= drm_fb_helper_ioctl,
122 	.fb_mmap	= omap_fbdev_fb_mmap,
123 	.fb_destroy	= omap_fbdev_fb_destroy,
124 };
125 
126 static int omap_fbdev_dirty(struct drm_fb_helper *helper, struct drm_clip_rect *clip)
127 {
128 	if (!(clip->x1 < clip->x2 && clip->y1 < clip->y2))
129 		return 0;
130 
131 	if (helper->fb->funcs->dirty)
132 		return helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, clip, 1);
133 
134 	return 0;
135 }
136 
137 static const struct drm_fb_helper_funcs omap_fbdev_helper_funcs = {
138 	.fb_dirty = omap_fbdev_dirty,
139 };
140 
141 static struct drm_fb_helper *get_fb(struct fb_info *fbi)
142 {
143 	if (!fbi || strcmp(fbi->fix.id, MODULE_NAME)) {
144 		/* these are not the fb's you're looking for */
145 		return NULL;
146 	}
147 	return fbi->par;
148 }
149 
150 int omap_fbdev_driver_fbdev_probe(struct drm_fb_helper *helper,
151 				  struct drm_fb_helper_surface_size *sizes)
152 {
153 	struct drm_device *dev = helper->dev;
154 	struct omap_drm_private *priv = dev->dev_private;
155 	struct omap_fbdev *fbdev = priv->fbdev;
156 	struct drm_framebuffer *fb = NULL;
157 	union omap_gem_size gsize;
158 	struct fb_info *fbi = NULL;
159 	struct drm_mode_fb_cmd2 mode_cmd = {0};
160 	struct drm_gem_object *bo;
161 	dma_addr_t dma_addr;
162 	int ret;
163 
164 	sizes->surface_bpp = 32;
165 	sizes->surface_depth = 24;
166 
167 	DBG("create fbdev: %dx%d@%d (%dx%d)", sizes->surface_width,
168 			sizes->surface_height, sizes->surface_bpp,
169 			sizes->fb_width, sizes->fb_height);
170 
171 	mode_cmd.pixel_format = drm_mode_legacy_fb_format(sizes->surface_bpp,
172 			sizes->surface_depth);
173 
174 	mode_cmd.width = sizes->surface_width;
175 	mode_cmd.height = sizes->surface_height;
176 
177 	mode_cmd.pitches[0] =
178 			DIV_ROUND_UP(mode_cmd.width * sizes->surface_bpp, 8);
179 
180 	fbdev->ywrap_enabled = priv->has_dmm && ywrap_enabled;
181 	if (fbdev->ywrap_enabled) {
182 		/* need to align pitch to page size if using DMM scrolling */
183 		mode_cmd.pitches[0] = PAGE_ALIGN(mode_cmd.pitches[0]);
184 	}
185 
186 	/* allocate backing bo */
187 	gsize = (union omap_gem_size){
188 		.bytes = PAGE_ALIGN(mode_cmd.pitches[0] * mode_cmd.height),
189 	};
190 	DBG("allocating %d bytes for fb %d", gsize.bytes, dev->primary->index);
191 	bo = omap_gem_new(dev, gsize, OMAP_BO_SCANOUT | OMAP_BO_WC);
192 	if (!bo) {
193 		dev_err(dev->dev, "failed to allocate buffer object\n");
194 		ret = -ENOMEM;
195 		goto fail;
196 	}
197 
198 	fb = omap_framebuffer_init(dev,
199 				   drm_get_format_info(dev, mode_cmd.pixel_format,
200 						       mode_cmd.modifier[0]),
201 				   &mode_cmd, &bo);
202 	if (IS_ERR(fb)) {
203 		dev_err(dev->dev, "failed to allocate fb\n");
204 		/* note: if fb creation failed, we can't rely on fb destroy
205 		 * to unref the bo:
206 		 */
207 		drm_gem_object_put(bo);
208 		ret = PTR_ERR(fb);
209 		goto fail;
210 	}
211 
212 	/* note: this keeps the bo pinned.. which is perhaps not ideal,
213 	 * but is needed as long as we use fb_mmap() to mmap to userspace
214 	 * (since this happens using fix.smem_start).  Possibly we could
215 	 * implement our own mmap using GEM mmap support to avoid this
216 	 * (non-tiled buffer doesn't need to be pinned for fbcon to write
217 	 * to it).  Then we just need to be sure that we are able to re-
218 	 * pin it in case of an opps.
219 	 */
220 	ret = omap_gem_pin(bo, &dma_addr);
221 	if (ret) {
222 		dev_err(dev->dev, "could not pin framebuffer\n");
223 		ret = -ENOMEM;
224 		goto fail;
225 	}
226 
227 	fbi = drm_fb_helper_alloc_info(helper);
228 	if (IS_ERR(fbi)) {
229 		dev_err(dev->dev, "failed to allocate fb info\n");
230 		ret = PTR_ERR(fbi);
231 		goto fail;
232 	}
233 
234 	DBG("fbi=%p, dev=%p", fbi, dev);
235 
236 	helper->funcs = &omap_fbdev_helper_funcs;
237 	helper->fb = fb;
238 
239 	fbi->fbops = &omap_fb_ops;
240 
241 	drm_fb_helper_fill_info(fbi, helper, sizes);
242 
243 	fbi->flags |= FBINFO_VIRTFB;
244 	fbi->screen_buffer = omap_gem_vaddr(bo);
245 	fbi->screen_size = bo->size;
246 	fbi->fix.smem_start = dma_addr;
247 	fbi->fix.smem_len = bo->size;
248 
249 	/* deferred I/O */
250 	helper->fbdefio.delay = HZ / 20;
251 	helper->fbdefio.deferred_io = drm_fb_helper_deferred_io;
252 
253 	fbi->fbdefio = &helper->fbdefio;
254 	ret = fb_deferred_io_init(fbi);
255 	if (ret)
256 		goto fail;
257 
258 	/* if we have DMM, then we can use it for scrolling by just
259 	 * shuffling pages around in DMM rather than doing sw blit.
260 	 */
261 	if (fbdev->ywrap_enabled) {
262 		DRM_INFO("Enabling DMM ywrap scrolling\n");
263 		fbi->flags |= FBINFO_HWACCEL_YWRAP | FBINFO_READS_FAST;
264 		fbi->fix.ywrapstep = 1;
265 	}
266 
267 
268 	DBG("par=%p, %dx%d", fbi->par, fbi->var.xres, fbi->var.yres);
269 	DBG("allocated %dx%d fb", fb->width, fb->height);
270 
271 	return 0;
272 
273 fail:
274 
275 	if (ret) {
276 		if (fb)
277 			drm_framebuffer_remove(fb);
278 	}
279 
280 	return ret;
281 }
282 
283 void omap_fbdev_setup(struct drm_device *dev)
284 {
285 	struct omap_drm_private *priv = dev->dev_private;
286 	struct omap_fbdev *fbdev;
287 
288 	drm_WARN(dev, !dev->registered, "Device has not been registered.\n");
289 	drm_WARN(dev, dev->fb_helper, "fb_helper is already set!\n");
290 
291 	fbdev = drmm_kzalloc(dev, sizeof(*fbdev), GFP_KERNEL);
292 	if (!fbdev)
293 		return;
294 	fbdev->dev = dev;
295 	INIT_WORK(&fbdev->work, pan_worker);
296 
297 	priv->fbdev = fbdev;
298 
299 	drm_client_setup(dev, NULL);
300 }
301