1 // SPDX-License-Identifier: MIT
3 * Copyright 2020 Noralf Trønnes
8 #include <linux/vmalloc.h>
9 #include <linux/workqueue.h>
11 #include <drm/drm_atomic.h>
12 #include <drm/drm_connector.h>
13 #include <drm/drm_damage_helper.h>
14 #include <drm/drm_drv.h>
15 #include <drm/drm_format_helper.h>
16 #include <drm/drm_fourcc.h>
17 #include <drm/drm_framebuffer.h>
18 #include <drm/drm_gem.h>
19 #include <drm/drm_gem_atomic_helper.h>
20 #include <drm/drm_gem_framebuffer_helper.h>
21 #include <drm/drm_print.h>
22 #include <drm/drm_rect.h>
23 #include <drm/drm_simple_kms_helper.h>
26 #include "gud_internal.h"
29 * Some userspace rendering loops run all displays in the same loop.
30 * This means that a fast display will have to wait for a slow one.
31 * Such users might want to enable this module parameter.
33 static bool gud_async_flush;
34 module_param_named(async_flush, gud_async_flush, bool, 0644);
35 MODULE_PARM_DESC(async_flush, "Enable asynchronous flushing [default=0]");
38 * FIXME: The driver is probably broken on Big Endian machines.
40 * https://lore.kernel.org/dri-devel/CAKb7UvihLX0hgBOP3VBG7O+atwZcUVCPVuBdfmDMpg0NjXe-cQ@mail.gmail.com/
43 static bool gud_is_big_endian(void)
45 #if defined(__BIG_ENDIAN)
52 static size_t gud_xrgb8888_to_r124(u8 *dst, const struct drm_format_info *format,
53 void *src, struct drm_framebuffer *fb,
54 struct drm_rect *rect,
55 struct drm_format_conv_state *fmtcnv_state)
57 unsigned int block_width = drm_format_info_block_width(format, 0);
58 unsigned int bits_per_pixel = 8 / block_width;
59 unsigned int x, y, width, height;
60 u8 pix, *pix8, *block = dst; /* Assign to silence compiler warning */
61 struct iosys_map dst_map, vmap;
65 WARN_ON_ONCE(format->char_per_block[0] != 1);
67 /* Start on a byte boundary */
68 rect->x1 = ALIGN_DOWN(rect->x1, block_width);
69 width = drm_rect_width(rect);
70 height = drm_rect_height(rect);
71 len = drm_format_info_min_pitch(format, 0, width) * height;
73 buf = kmalloc(width * height, GFP_KERNEL);
77 iosys_map_set_vaddr(&dst_map, buf);
78 iosys_map_set_vaddr(&vmap, src);
79 drm_fb_xrgb8888_to_gray8(&dst_map, NULL, &vmap, fb, rect, fmtcnv_state);
82 for (y = 0; y < height; y++) {
83 for (x = 0; x < width; x++) {
84 unsigned int pixpos = x % block_width; /* within byte from the left */
85 unsigned int pixshift = (block_width - pixpos - 1) * bits_per_pixel;
92 pix = (*pix8++) >> (8 - bits_per_pixel);
93 *block |= pix << pixshift;
102 static size_t gud_xrgb8888_to_color(u8 *dst, const struct drm_format_info *format,
103 void *src, struct drm_framebuffer *fb,
104 struct drm_rect *rect)
106 unsigned int block_width = drm_format_info_block_width(format, 0);
107 unsigned int bits_per_pixel = 8 / block_width;
108 u8 r, g, b, pix, *block = dst; /* Assign to silence compiler warning */
109 unsigned int x, y, width;
114 /* Start on a byte boundary */
115 rect->x1 = ALIGN_DOWN(rect->x1, block_width);
116 width = drm_rect_width(rect);
117 len = drm_format_info_min_pitch(format, 0, width) * drm_rect_height(rect);
119 for (y = rect->y1; y < rect->y2; y++) {
120 sbuf32 = src + (y * fb->pitches[0]);
123 for (x = 0; x < width; x++) {
124 unsigned int pixpos = x % block_width; /* within byte from the left */
125 unsigned int pixshift = (block_width - pixpos - 1) * bits_per_pixel;
132 pix32 = le32_to_cpu(*sbuf32++);
137 switch (format->format) {
138 case GUD_DRM_FORMAT_XRGB1111:
139 pix = ((r >> 7) << 2) | ((g >> 7) << 1) | (b >> 7);
146 *block |= pix << pixshift;
153 static int gud_prep_flush(struct gud_device *gdrm, struct drm_framebuffer *fb,
154 const struct iosys_map *src, bool cached_reads,
155 const struct drm_format_info *format, struct drm_rect *rect,
156 struct gud_set_buffer_req *req,
157 struct drm_format_conv_state *fmtcnv_state)
159 u8 compression = gdrm->compression;
160 struct iosys_map dst;
164 pitch = drm_format_info_min_pitch(format, 0, drm_rect_width(rect));
165 len = pitch * drm_rect_height(rect);
166 if (len > gdrm->bulk_len)
169 vaddr = src[0].vaddr;
172 buf = gdrm->compress_buf;
174 buf = gdrm->bulk_buf;
175 iosys_map_set_vaddr(&dst, buf);
178 * Imported buffers are assumed to be write-combined and thus uncached
179 * with slow reads (at least on ARM).
181 if (format != fb->format) {
182 if (format->format == GUD_DRM_FORMAT_R1) {
183 len = gud_xrgb8888_to_r124(buf, format, vaddr, fb, rect, fmtcnv_state);
186 } else if (format->format == DRM_FORMAT_R8) {
187 drm_fb_xrgb8888_to_gray8(&dst, NULL, src, fb, rect, fmtcnv_state);
188 } else if (format->format == DRM_FORMAT_RGB332) {
189 drm_fb_xrgb8888_to_rgb332(&dst, NULL, src, fb, rect, fmtcnv_state);
190 } else if (format->format == DRM_FORMAT_RGB565) {
191 drm_fb_xrgb8888_to_rgb565(&dst, NULL, src, fb, rect, fmtcnv_state,
192 gud_is_big_endian());
193 } else if (format->format == DRM_FORMAT_RGB888) {
194 drm_fb_xrgb8888_to_rgb888(&dst, NULL, src, fb, rect, fmtcnv_state);
196 len = gud_xrgb8888_to_color(buf, format, vaddr, fb, rect);
198 } else if (gud_is_big_endian() && format->cpp[0] > 1) {
199 drm_fb_swab(&dst, NULL, src, fb, rect, cached_reads, fmtcnv_state);
200 } else if (compression && cached_reads && pitch == fb->pitches[0]) {
201 /* can compress directly from the framebuffer */
202 buf = vaddr + rect->y1 * pitch;
204 drm_fb_memcpy(&dst, NULL, src, fb, rect);
207 memset(req, 0, sizeof(*req));
208 req->x = cpu_to_le32(rect->x1);
209 req->y = cpu_to_le32(rect->y1);
210 req->width = cpu_to_le32(drm_rect_width(rect));
211 req->height = cpu_to_le32(drm_rect_height(rect));
212 req->length = cpu_to_le32(len);
214 if (compression & GUD_COMPRESSION_LZ4) {
217 complen = LZ4_compress_default(buf, gdrm->bulk_buf, len, len, gdrm->lz4_comp_mem);
223 req->compression = GUD_COMPRESSION_LZ4;
224 req->compressed_length = cpu_to_le32(complen);
230 struct gud_usb_bulk_context {
231 struct timer_list timer;
232 struct usb_sg_request sgr;
235 static void gud_usb_bulk_timeout(struct timer_list *t)
237 struct gud_usb_bulk_context *ctx = from_timer(ctx, t, timer);
239 usb_sg_cancel(&ctx->sgr);
242 static int gud_usb_bulk(struct gud_device *gdrm, size_t len)
244 struct gud_usb_bulk_context ctx;
247 ret = usb_sg_init(&ctx.sgr, gud_to_usb_device(gdrm), gdrm->bulk_pipe, 0,
248 gdrm->bulk_sgt.sgl, gdrm->bulk_sgt.nents, len, GFP_KERNEL);
252 timer_setup_on_stack(&ctx.timer, gud_usb_bulk_timeout, 0);
253 mod_timer(&ctx.timer, jiffies + msecs_to_jiffies(3000));
255 usb_sg_wait(&ctx.sgr);
257 if (!del_timer_sync(&ctx.timer))
259 else if (ctx.sgr.status < 0)
260 ret = ctx.sgr.status;
261 else if (ctx.sgr.bytes != len)
264 destroy_timer_on_stack(&ctx.timer);
269 static int gud_flush_rect(struct gud_device *gdrm, struct drm_framebuffer *fb,
270 const struct iosys_map *src, bool cached_reads,
271 const struct drm_format_info *format, struct drm_rect *rect,
272 struct drm_format_conv_state *fmtcnv_state)
274 struct gud_set_buffer_req req;
278 drm_dbg(&gdrm->drm, "Flushing [FB:%d] " DRM_RECT_FMT "\n", fb->base.id, DRM_RECT_ARG(rect));
280 ret = gud_prep_flush(gdrm, fb, src, cached_reads, format, rect, &req, fmtcnv_state);
284 len = le32_to_cpu(req.length);
287 trlen = le32_to_cpu(req.compressed_length);
291 gdrm->stats_length += len;
292 /* Did it wrap around? */
293 if (gdrm->stats_length <= len && gdrm->stats_actual_length) {
294 gdrm->stats_length = len;
295 gdrm->stats_actual_length = 0;
297 gdrm->stats_actual_length += trlen;
299 if (!(gdrm->flags & GUD_DISPLAY_FLAG_FULL_UPDATE) || gdrm->prev_flush_failed) {
300 ret = gud_usb_set(gdrm, GUD_REQ_SET_BUFFER, 0, &req, sizeof(req));
305 ret = gud_usb_bulk(gdrm, trlen);
307 gdrm->stats_num_errors++;
312 void gud_clear_damage(struct gud_device *gdrm)
314 gdrm->damage.x1 = INT_MAX;
315 gdrm->damage.y1 = INT_MAX;
320 static void gud_flush_damage(struct gud_device *gdrm, struct drm_framebuffer *fb,
321 const struct iosys_map *src, bool cached_reads,
322 struct drm_rect *damage)
324 struct drm_format_conv_state fmtcnv_state = DRM_FORMAT_CONV_STATE_INIT;
325 const struct drm_format_info *format;
326 unsigned int i, lines;
331 if (format->format == DRM_FORMAT_XRGB8888 && gdrm->xrgb8888_emulation_format)
332 format = gdrm->xrgb8888_emulation_format;
334 /* Split update if it's too big */
335 pitch = drm_format_info_min_pitch(format, 0, drm_rect_width(damage));
336 lines = drm_rect_height(damage);
338 if (gdrm->bulk_len < lines * pitch)
339 lines = gdrm->bulk_len / pitch;
341 for (i = 0; i < DIV_ROUND_UP(drm_rect_height(damage), lines); i++) {
342 struct drm_rect rect = *damage;
344 rect.y1 += i * lines;
345 rect.y2 = min_t(u32, rect.y1 + lines, damage->y2);
347 ret = gud_flush_rect(gdrm, fb, src, cached_reads, format, &rect, &fmtcnv_state);
349 if (ret != -ENODEV && ret != -ECONNRESET &&
350 ret != -ESHUTDOWN && ret != -EPROTO)
351 dev_err_ratelimited(fb->dev->dev,
352 "Failed to flush framebuffer: error=%d\n", ret);
353 gdrm->prev_flush_failed = true;
358 drm_format_conv_state_release(&fmtcnv_state);
361 void gud_flush_work(struct work_struct *work)
363 struct gud_device *gdrm = container_of(work, struct gud_device, work);
364 struct iosys_map shadow_map;
365 struct drm_framebuffer *fb;
366 struct drm_rect damage;
369 if (!drm_dev_enter(&gdrm->drm, &idx))
372 mutex_lock(&gdrm->damage_lock);
375 iosys_map_set_vaddr(&shadow_map, gdrm->shadow_buf);
376 damage = gdrm->damage;
377 gud_clear_damage(gdrm);
378 mutex_unlock(&gdrm->damage_lock);
383 gud_flush_damage(gdrm, fb, &shadow_map, true, &damage);
385 drm_framebuffer_put(fb);
390 static int gud_fb_queue_damage(struct gud_device *gdrm, struct drm_framebuffer *fb,
391 const struct iosys_map *src, struct drm_rect *damage)
393 struct drm_framebuffer *old_fb = NULL;
394 struct iosys_map shadow_map;
396 mutex_lock(&gdrm->damage_lock);
398 if (!gdrm->shadow_buf) {
399 gdrm->shadow_buf = vcalloc(fb->pitches[0], fb->height);
400 if (!gdrm->shadow_buf) {
401 mutex_unlock(&gdrm->damage_lock);
406 iosys_map_set_vaddr(&shadow_map, gdrm->shadow_buf);
407 iosys_map_incr(&shadow_map, drm_fb_clip_offset(fb->pitches[0], fb->format, damage));
408 drm_fb_memcpy(&shadow_map, fb->pitches, src, fb, damage);
410 if (fb != gdrm->fb) {
412 drm_framebuffer_get(fb);
416 gdrm->damage.x1 = min(gdrm->damage.x1, damage->x1);
417 gdrm->damage.y1 = min(gdrm->damage.y1, damage->y1);
418 gdrm->damage.x2 = max(gdrm->damage.x2, damage->x2);
419 gdrm->damage.y2 = max(gdrm->damage.y2, damage->y2);
421 mutex_unlock(&gdrm->damage_lock);
423 queue_work(system_long_wq, &gdrm->work);
426 drm_framebuffer_put(old_fb);
431 static void gud_fb_handle_damage(struct gud_device *gdrm, struct drm_framebuffer *fb,
432 const struct iosys_map *src, struct drm_rect *damage)
436 if (gdrm->flags & GUD_DISPLAY_FLAG_FULL_UPDATE)
437 drm_rect_init(damage, 0, 0, fb->width, fb->height);
439 if (gud_async_flush) {
440 ret = gud_fb_queue_damage(gdrm, fb, src, damage);
445 /* Imported buffers are assumed to be WriteCombined with uncached reads */
446 gud_flush_damage(gdrm, fb, src, !fb->obj[0]->import_attach, damage);
449 int gud_pipe_check(struct drm_simple_display_pipe *pipe,
450 struct drm_plane_state *new_plane_state,
451 struct drm_crtc_state *new_crtc_state)
453 struct gud_device *gdrm = to_gud_device(pipe->crtc.dev);
454 struct drm_plane_state *old_plane_state = pipe->plane.state;
455 const struct drm_display_mode *mode = &new_crtc_state->mode;
456 struct drm_atomic_state *state = new_plane_state->state;
457 struct drm_framebuffer *old_fb = old_plane_state->fb;
458 struct drm_connector_state *connector_state = NULL;
459 struct drm_framebuffer *fb = new_plane_state->fb;
460 const struct drm_format_info *format = fb->format;
461 struct drm_connector *connector;
462 unsigned int i, num_properties;
463 struct gud_state_req *req;
467 if (WARN_ON_ONCE(!fb))
470 if (old_plane_state->rotation != new_plane_state->rotation)
471 new_crtc_state->mode_changed = true;
473 if (old_fb && old_fb->format != format)
474 new_crtc_state->mode_changed = true;
476 if (!new_crtc_state->mode_changed && !new_crtc_state->connectors_changed)
479 /* Only one connector is supported */
480 if (hweight32(new_crtc_state->connector_mask) != 1)
483 if (format->format == DRM_FORMAT_XRGB8888 && gdrm->xrgb8888_emulation_format)
484 format = gdrm->xrgb8888_emulation_format;
486 for_each_new_connector_in_state(state, connector, connector_state, i) {
487 if (connector_state->crtc)
492 * DRM_IOCTL_MODE_OBJ_SETPROPERTY on the rotation property will not have
493 * the connector included in the state.
495 if (!connector_state) {
496 struct drm_connector_list_iter conn_iter;
498 drm_connector_list_iter_begin(pipe->crtc.dev, &conn_iter);
499 drm_for_each_connector_iter(connector, &conn_iter) {
500 if (connector->state->crtc) {
501 connector_state = connector->state;
505 drm_connector_list_iter_end(&conn_iter);
508 if (WARN_ON_ONCE(!connector_state))
511 len = struct_size(req, properties,
512 size_add(GUD_PROPERTIES_MAX_NUM, GUD_CONNECTOR_PROPERTIES_MAX_NUM));
513 req = kzalloc(len, GFP_KERNEL);
517 gud_from_display_mode(&req->mode, mode);
519 req->format = gud_from_fourcc(format->format);
520 if (WARN_ON_ONCE(!req->format)) {
525 req->connector = drm_connector_index(connector_state->connector);
527 ret = gud_connector_fill_properties(connector_state, req->properties);
531 num_properties = ret;
532 for (i = 0; i < gdrm->num_properties; i++) {
533 u16 prop = gdrm->properties[i];
537 case GUD_PROPERTY_ROTATION:
538 /* DRM UAPI matches the protocol so use value directly */
539 val = new_plane_state->rotation;
547 req->properties[num_properties + i].prop = cpu_to_le16(prop);
548 req->properties[num_properties + i].val = cpu_to_le64(val);
552 if (drm_dev_enter(fb->dev, &idx)) {
553 len = struct_size(req, properties, num_properties);
554 ret = gud_usb_set(gdrm, GUD_REQ_SET_STATE_CHECK, 0, req, len);
565 void gud_pipe_update(struct drm_simple_display_pipe *pipe,
566 struct drm_plane_state *old_state)
568 struct drm_device *drm = pipe->crtc.dev;
569 struct gud_device *gdrm = to_gud_device(drm);
570 struct drm_plane_state *state = pipe->plane.state;
571 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(state);
572 struct drm_framebuffer *fb = state->fb;
573 struct drm_crtc *crtc = &pipe->crtc;
574 struct drm_rect damage;
577 if (crtc->state->mode_changed || !crtc->state->enable) {
578 cancel_work_sync(&gdrm->work);
579 mutex_lock(&gdrm->damage_lock);
581 drm_framebuffer_put(gdrm->fb);
584 gud_clear_damage(gdrm);
585 vfree(gdrm->shadow_buf);
586 gdrm->shadow_buf = NULL;
587 mutex_unlock(&gdrm->damage_lock);
590 if (!drm_dev_enter(drm, &idx))
594 gud_usb_set_u8(gdrm, GUD_REQ_SET_CONTROLLER_ENABLE, 1);
596 if (fb && (crtc->state->mode_changed || crtc->state->connectors_changed))
597 gud_usb_set(gdrm, GUD_REQ_SET_STATE_COMMIT, 0, NULL, 0);
599 if (crtc->state->active_changed)
600 gud_usb_set_u8(gdrm, GUD_REQ_SET_DISPLAY_ENABLE, crtc->state->active);
605 ret = drm_gem_fb_begin_cpu_access(fb, DMA_FROM_DEVICE);
609 if (drm_atomic_helper_damage_merged(old_state, state, &damage))
610 gud_fb_handle_damage(gdrm, fb, &shadow_plane_state->data[0], &damage);
612 drm_gem_fb_end_cpu_access(fb, DMA_FROM_DEVICE);
615 if (!crtc->state->enable)
616 gud_usb_set_u8(gdrm, GUD_REQ_SET_CONTROLLER_ENABLE, 0);