1 // SPDX-License-Identifier: MIT 2 /* 3 * Copyright 2020 Noralf Trønnes 4 */ 5 6 #include <linux/lz4.h> 7 #include <linux/usb.h> 8 #include <linux/workqueue.h> 9 10 #include <drm/drm_atomic.h> 11 #include <drm/drm_connector.h> 12 #include <drm/drm_damage_helper.h> 13 #include <drm/drm_drv.h> 14 #include <drm/drm_format_helper.h> 15 #include <drm/drm_fourcc.h> 16 #include <drm/drm_framebuffer.h> 17 #include <drm/drm_gem.h> 18 #include <drm/drm_gem_atomic_helper.h> 19 #include <drm/drm_gem_framebuffer_helper.h> 20 #include <drm/drm_print.h> 21 #include <drm/drm_rect.h> 22 #include <drm/drm_simple_kms_helper.h> 23 #include <drm/gud.h> 24 25 #include "gud_internal.h" 26 27 /* 28 * Some userspace rendering loops runs all displays in the same loop. 29 * This means that a fast display will have to wait for a slow one. 30 * For this reason gud does flushing asynchronous by default. 31 * The down side is that in e.g. a single display setup userspace thinks 32 * the display is insanely fast since the driver reports back immediately 33 * that the flush/pageflip is done. This wastes CPU and power. 34 * Such users might want to set this module parameter to false. 35 */ 36 static bool gud_async_flush = true; 37 module_param_named(async_flush, gud_async_flush, bool, 0644); 38 MODULE_PARM_DESC(async_flush, "Enable asynchronous flushing [default=true]"); 39 40 /* 41 * FIXME: The driver is probably broken on Big Endian machines. 42 * See discussion: 43 * https://lore.kernel.org/dri-devel/CAKb7UvihLX0hgBOP3VBG7O+atwZcUVCPVuBdfmDMpg0NjXe-cQ@mail.gmail.com/ 44 */ 45 46 static bool gud_is_big_endian(void) 47 { 48 #if defined(__BIG_ENDIAN) 49 return true; 50 #else 51 return false; 52 #endif 53 } 54 55 static size_t gud_xrgb8888_to_r124(u8 *dst, const struct drm_format_info *format, 56 void *src, struct drm_framebuffer *fb, 57 struct drm_rect *rect) 58 { 59 unsigned int block_width = drm_format_info_block_width(format, 0); 60 unsigned int bits_per_pixel = 8 / block_width; 61 unsigned int x, y, width, height; 62 u8 pix, *pix8, *block = dst; /* Assign to silence compiler warning */ 63 struct iosys_map dst_map, vmap; 64 size_t len; 65 void *buf; 66 67 WARN_ON_ONCE(format->char_per_block[0] != 1); 68 69 /* Start on a byte boundary */ 70 rect->x1 = ALIGN_DOWN(rect->x1, block_width); 71 width = drm_rect_width(rect); 72 height = drm_rect_height(rect); 73 len = drm_format_info_min_pitch(format, 0, width) * height; 74 75 buf = kmalloc(width * height, GFP_KERNEL); 76 if (!buf) 77 return 0; 78 79 iosys_map_set_vaddr(&dst_map, buf); 80 iosys_map_set_vaddr(&vmap, src); 81 drm_fb_xrgb8888_to_gray8(&dst_map, NULL, &vmap, fb, rect); 82 pix8 = buf; 83 84 for (y = 0; y < height; y++) { 85 for (x = 0; x < width; x++) { 86 unsigned int pixpos = x % block_width; /* within byte from the left */ 87 unsigned int pixshift = (block_width - pixpos - 1) * bits_per_pixel; 88 89 if (!pixpos) { 90 block = dst++; 91 *block = 0; 92 } 93 94 pix = (*pix8++) >> (8 - bits_per_pixel); 95 *block |= pix << pixshift; 96 } 97 } 98 99 kfree(buf); 100 101 return len; 102 } 103 104 static size_t gud_xrgb8888_to_color(u8 *dst, const struct drm_format_info *format, 105 void *src, struct drm_framebuffer *fb, 106 struct drm_rect *rect) 107 { 108 unsigned int block_width = drm_format_info_block_width(format, 0); 109 unsigned int bits_per_pixel = 8 / block_width; 110 u8 r, g, b, pix, *block = dst; /* Assign to silence compiler warning */ 111 unsigned int x, y, width; 112 __le32 *sbuf32; 113 u32 pix32; 114 size_t len; 115 116 /* Start on a byte boundary */ 117 rect->x1 = ALIGN_DOWN(rect->x1, block_width); 118 width = drm_rect_width(rect); 119 len = drm_format_info_min_pitch(format, 0, width) * drm_rect_height(rect); 120 121 for (y = rect->y1; y < rect->y2; y++) { 122 sbuf32 = src + (y * fb->pitches[0]); 123 sbuf32 += rect->x1; 124 125 for (x = 0; x < width; x++) { 126 unsigned int pixpos = x % block_width; /* within byte from the left */ 127 unsigned int pixshift = (block_width - pixpos - 1) * bits_per_pixel; 128 129 if (!pixpos) { 130 block = dst++; 131 *block = 0; 132 } 133 134 pix32 = le32_to_cpu(*sbuf32++); 135 r = pix32 >> 16; 136 g = pix32 >> 8; 137 b = pix32; 138 139 switch (format->format) { 140 case GUD_DRM_FORMAT_XRGB1111: 141 pix = ((r >> 7) << 2) | ((g >> 7) << 1) | (b >> 7); 142 break; 143 default: 144 WARN_ON_ONCE(1); 145 return len; 146 } 147 148 *block |= pix << pixshift; 149 } 150 } 151 152 return len; 153 } 154 155 static int gud_prep_flush(struct gud_device *gdrm, struct drm_framebuffer *fb, 156 const struct iosys_map *src, bool cached_reads, 157 const struct drm_format_info *format, struct drm_rect *rect, 158 struct gud_set_buffer_req *req) 159 { 160 u8 compression = gdrm->compression; 161 struct iosys_map dst; 162 void *vaddr, *buf; 163 size_t pitch, len; 164 165 pitch = drm_format_info_min_pitch(format, 0, drm_rect_width(rect)); 166 len = pitch * drm_rect_height(rect); 167 if (len > gdrm->bulk_len) 168 return -E2BIG; 169 170 vaddr = src[0].vaddr; 171 retry: 172 if (compression) 173 buf = gdrm->compress_buf; 174 else 175 buf = gdrm->bulk_buf; 176 iosys_map_set_vaddr(&dst, buf); 177 178 /* 179 * Imported buffers are assumed to be write-combined and thus uncached 180 * with slow reads (at least on ARM). 181 */ 182 if (format != fb->format) { 183 if (format->format == GUD_DRM_FORMAT_R1) { 184 len = gud_xrgb8888_to_r124(buf, format, vaddr, fb, rect); 185 if (!len) 186 return -ENOMEM; 187 } else if (format->format == DRM_FORMAT_R8) { 188 drm_fb_xrgb8888_to_gray8(&dst, NULL, src, fb, rect); 189 } else if (format->format == DRM_FORMAT_RGB332) { 190 drm_fb_xrgb8888_to_rgb332(&dst, NULL, src, fb, rect); 191 } else if (format->format == DRM_FORMAT_RGB565) { 192 drm_fb_xrgb8888_to_rgb565(&dst, NULL, src, fb, rect, 193 gud_is_big_endian()); 194 } else if (format->format == DRM_FORMAT_RGB888) { 195 drm_fb_xrgb8888_to_rgb888(&dst, NULL, src, fb, rect); 196 } else { 197 len = gud_xrgb8888_to_color(buf, format, vaddr, fb, rect); 198 } 199 } else if (gud_is_big_endian() && format->cpp[0] > 1) { 200 drm_fb_swab(&dst, NULL, src, fb, rect, cached_reads); 201 } else if (compression && cached_reads && pitch == fb->pitches[0]) { 202 /* can compress directly from the framebuffer */ 203 buf = vaddr + rect->y1 * pitch; 204 } else { 205 drm_fb_memcpy(&dst, NULL, src, fb, rect); 206 } 207 208 memset(req, 0, sizeof(*req)); 209 req->x = cpu_to_le32(rect->x1); 210 req->y = cpu_to_le32(rect->y1); 211 req->width = cpu_to_le32(drm_rect_width(rect)); 212 req->height = cpu_to_le32(drm_rect_height(rect)); 213 req->length = cpu_to_le32(len); 214 215 if (compression & GUD_COMPRESSION_LZ4) { 216 int complen; 217 218 complen = LZ4_compress_default(buf, gdrm->bulk_buf, len, len, gdrm->lz4_comp_mem); 219 if (complen <= 0) { 220 compression = 0; 221 goto retry; 222 } 223 224 req->compression = GUD_COMPRESSION_LZ4; 225 req->compressed_length = cpu_to_le32(complen); 226 } 227 228 return 0; 229 } 230 231 struct gud_usb_bulk_context { 232 struct timer_list timer; 233 struct usb_sg_request sgr; 234 }; 235 236 static void gud_usb_bulk_timeout(struct timer_list *t) 237 { 238 struct gud_usb_bulk_context *ctx = from_timer(ctx, t, timer); 239 240 usb_sg_cancel(&ctx->sgr); 241 } 242 243 static int gud_usb_bulk(struct gud_device *gdrm, size_t len) 244 { 245 struct gud_usb_bulk_context ctx; 246 int ret; 247 248 ret = usb_sg_init(&ctx.sgr, gud_to_usb_device(gdrm), gdrm->bulk_pipe, 0, 249 gdrm->bulk_sgt.sgl, gdrm->bulk_sgt.nents, len, GFP_KERNEL); 250 if (ret) 251 return ret; 252 253 timer_setup_on_stack(&ctx.timer, gud_usb_bulk_timeout, 0); 254 mod_timer(&ctx.timer, jiffies + msecs_to_jiffies(3000)); 255 256 usb_sg_wait(&ctx.sgr); 257 258 if (!del_timer_sync(&ctx.timer)) 259 ret = -ETIMEDOUT; 260 else if (ctx.sgr.status < 0) 261 ret = ctx.sgr.status; 262 else if (ctx.sgr.bytes != len) 263 ret = -EIO; 264 265 destroy_timer_on_stack(&ctx.timer); 266 267 return ret; 268 } 269 270 static int gud_flush_rect(struct gud_device *gdrm, struct drm_framebuffer *fb, 271 const struct iosys_map *src, bool cached_reads, 272 const struct drm_format_info *format, struct drm_rect *rect) 273 { 274 struct gud_set_buffer_req req; 275 size_t len, trlen; 276 int ret; 277 278 drm_dbg(&gdrm->drm, "Flushing [FB:%d] " DRM_RECT_FMT "\n", fb->base.id, DRM_RECT_ARG(rect)); 279 280 ret = gud_prep_flush(gdrm, fb, src, cached_reads, format, rect, &req); 281 if (ret) 282 return ret; 283 284 len = le32_to_cpu(req.length); 285 286 if (req.compression) 287 trlen = le32_to_cpu(req.compressed_length); 288 else 289 trlen = len; 290 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; 296 } 297 gdrm->stats_actual_length += trlen; 298 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)); 301 if (ret) 302 return ret; 303 } 304 305 ret = gud_usb_bulk(gdrm, trlen); 306 if (ret) 307 gdrm->stats_num_errors++; 308 309 return ret; 310 } 311 312 void gud_clear_damage(struct gud_device *gdrm) 313 { 314 gdrm->damage.x1 = INT_MAX; 315 gdrm->damage.y1 = INT_MAX; 316 gdrm->damage.x2 = 0; 317 gdrm->damage.y2 = 0; 318 } 319 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) 323 { 324 const struct drm_format_info *format; 325 unsigned int i, lines; 326 size_t pitch; 327 int ret; 328 329 format = fb->format; 330 if (format->format == DRM_FORMAT_XRGB8888 && gdrm->xrgb8888_emulation_format) 331 format = gdrm->xrgb8888_emulation_format; 332 333 /* Split update if it's too big */ 334 pitch = drm_format_info_min_pitch(format, 0, drm_rect_width(damage)); 335 lines = drm_rect_height(damage); 336 337 if (gdrm->bulk_len < lines * pitch) 338 lines = gdrm->bulk_len / pitch; 339 340 for (i = 0; i < DIV_ROUND_UP(drm_rect_height(damage), lines); i++) { 341 struct drm_rect rect = *damage; 342 343 rect.y1 += i * lines; 344 rect.y2 = min_t(u32, rect.y1 + lines, damage->y2); 345 346 ret = gud_flush_rect(gdrm, fb, src, cached_reads, format, &rect); 347 if (ret) { 348 if (ret != -ENODEV && ret != -ECONNRESET && 349 ret != -ESHUTDOWN && ret != -EPROTO) 350 dev_err_ratelimited(fb->dev->dev, 351 "Failed to flush framebuffer: error=%d\n", ret); 352 gdrm->prev_flush_failed = true; 353 break; 354 } 355 } 356 } 357 358 void gud_flush_work(struct work_struct *work) 359 { 360 struct gud_device *gdrm = container_of(work, struct gud_device, work); 361 struct iosys_map shadow_map; 362 struct drm_framebuffer *fb; 363 struct drm_rect damage; 364 int idx; 365 366 if (!drm_dev_enter(&gdrm->drm, &idx)) 367 return; 368 369 mutex_lock(&gdrm->damage_lock); 370 fb = gdrm->fb; 371 gdrm->fb = NULL; 372 iosys_map_set_vaddr(&shadow_map, gdrm->shadow_buf); 373 damage = gdrm->damage; 374 gud_clear_damage(gdrm); 375 mutex_unlock(&gdrm->damage_lock); 376 377 if (!fb) 378 goto out; 379 380 gud_flush_damage(gdrm, fb, &shadow_map, true, &damage); 381 382 drm_framebuffer_put(fb); 383 out: 384 drm_dev_exit(idx); 385 } 386 387 static int gud_fb_queue_damage(struct gud_device *gdrm, struct drm_framebuffer *fb, 388 const struct iosys_map *src, struct drm_rect *damage) 389 { 390 struct drm_framebuffer *old_fb = NULL; 391 struct iosys_map shadow_map; 392 393 mutex_lock(&gdrm->damage_lock); 394 395 if (!gdrm->shadow_buf) { 396 gdrm->shadow_buf = vzalloc(fb->pitches[0] * fb->height); 397 if (!gdrm->shadow_buf) { 398 mutex_unlock(&gdrm->damage_lock); 399 return -ENOMEM; 400 } 401 } 402 403 iosys_map_set_vaddr(&shadow_map, gdrm->shadow_buf); 404 iosys_map_incr(&shadow_map, drm_fb_clip_offset(fb->pitches[0], fb->format, damage)); 405 drm_fb_memcpy(&shadow_map, fb->pitches, src, fb, damage); 406 407 if (fb != gdrm->fb) { 408 old_fb = gdrm->fb; 409 drm_framebuffer_get(fb); 410 gdrm->fb = fb; 411 } 412 413 gdrm->damage.x1 = min(gdrm->damage.x1, damage->x1); 414 gdrm->damage.y1 = min(gdrm->damage.y1, damage->y1); 415 gdrm->damage.x2 = max(gdrm->damage.x2, damage->x2); 416 gdrm->damage.y2 = max(gdrm->damage.y2, damage->y2); 417 418 mutex_unlock(&gdrm->damage_lock); 419 420 queue_work(system_long_wq, &gdrm->work); 421 422 if (old_fb) 423 drm_framebuffer_put(old_fb); 424 425 return 0; 426 } 427 428 static void gud_fb_handle_damage(struct gud_device *gdrm, struct drm_framebuffer *fb, 429 const struct iosys_map *src, struct drm_rect *damage) 430 { 431 int ret; 432 433 if (gdrm->flags & GUD_DISPLAY_FLAG_FULL_UPDATE) 434 drm_rect_init(damage, 0, 0, fb->width, fb->height); 435 436 if (gud_async_flush) { 437 ret = gud_fb_queue_damage(gdrm, fb, src, damage); 438 if (ret != -ENOMEM) 439 return; 440 } 441 442 /* Imported buffers are assumed to be WriteCombined with uncached reads */ 443 gud_flush_damage(gdrm, fb, src, !fb->obj[0]->import_attach, damage); 444 } 445 446 int gud_pipe_check(struct drm_simple_display_pipe *pipe, 447 struct drm_plane_state *new_plane_state, 448 struct drm_crtc_state *new_crtc_state) 449 { 450 struct gud_device *gdrm = to_gud_device(pipe->crtc.dev); 451 struct drm_plane_state *old_plane_state = pipe->plane.state; 452 const struct drm_display_mode *mode = &new_crtc_state->mode; 453 struct drm_atomic_state *state = new_plane_state->state; 454 struct drm_framebuffer *old_fb = old_plane_state->fb; 455 struct drm_connector_state *connector_state = NULL; 456 struct drm_framebuffer *fb = new_plane_state->fb; 457 const struct drm_format_info *format = fb->format; 458 struct drm_connector *connector; 459 unsigned int i, num_properties; 460 struct gud_state_req *req; 461 int idx, ret; 462 size_t len; 463 464 if (WARN_ON_ONCE(!fb)) 465 return -EINVAL; 466 467 if (old_plane_state->rotation != new_plane_state->rotation) 468 new_crtc_state->mode_changed = true; 469 470 if (old_fb && old_fb->format != format) 471 new_crtc_state->mode_changed = true; 472 473 if (!new_crtc_state->mode_changed && !new_crtc_state->connectors_changed) 474 return 0; 475 476 /* Only one connector is supported */ 477 if (hweight32(new_crtc_state->connector_mask) != 1) 478 return -EINVAL; 479 480 if (format->format == DRM_FORMAT_XRGB8888 && gdrm->xrgb8888_emulation_format) 481 format = gdrm->xrgb8888_emulation_format; 482 483 for_each_new_connector_in_state(state, connector, connector_state, i) { 484 if (connector_state->crtc) 485 break; 486 } 487 488 /* 489 * DRM_IOCTL_MODE_OBJ_SETPROPERTY on the rotation property will not have 490 * the connector included in the state. 491 */ 492 if (!connector_state) { 493 struct drm_connector_list_iter conn_iter; 494 495 drm_connector_list_iter_begin(pipe->crtc.dev, &conn_iter); 496 drm_for_each_connector_iter(connector, &conn_iter) { 497 if (connector->state->crtc) { 498 connector_state = connector->state; 499 break; 500 } 501 } 502 drm_connector_list_iter_end(&conn_iter); 503 } 504 505 if (WARN_ON_ONCE(!connector_state)) 506 return -ENOENT; 507 508 len = struct_size(req, properties, 509 GUD_PROPERTIES_MAX_NUM + GUD_CONNECTOR_PROPERTIES_MAX_NUM); 510 req = kzalloc(len, GFP_KERNEL); 511 if (!req) 512 return -ENOMEM; 513 514 gud_from_display_mode(&req->mode, mode); 515 516 req->format = gud_from_fourcc(format->format); 517 if (WARN_ON_ONCE(!req->format)) { 518 ret = -EINVAL; 519 goto out; 520 } 521 522 req->connector = drm_connector_index(connector_state->connector); 523 524 ret = gud_connector_fill_properties(connector_state, req->properties); 525 if (ret < 0) 526 goto out; 527 528 num_properties = ret; 529 for (i = 0; i < gdrm->num_properties; i++) { 530 u16 prop = gdrm->properties[i]; 531 u64 val; 532 533 switch (prop) { 534 case GUD_PROPERTY_ROTATION: 535 /* DRM UAPI matches the protocol so use value directly */ 536 val = new_plane_state->rotation; 537 break; 538 default: 539 WARN_ON_ONCE(1); 540 ret = -EINVAL; 541 goto out; 542 } 543 544 req->properties[num_properties + i].prop = cpu_to_le16(prop); 545 req->properties[num_properties + i].val = cpu_to_le64(val); 546 num_properties++; 547 } 548 549 if (drm_dev_enter(fb->dev, &idx)) { 550 len = struct_size(req, properties, num_properties); 551 ret = gud_usb_set(gdrm, GUD_REQ_SET_STATE_CHECK, 0, req, len); 552 drm_dev_exit(idx); 553 } else { 554 ret = -ENODEV; 555 } 556 out: 557 kfree(req); 558 559 return ret; 560 } 561 562 void gud_pipe_update(struct drm_simple_display_pipe *pipe, 563 struct drm_plane_state *old_state) 564 { 565 struct drm_device *drm = pipe->crtc.dev; 566 struct gud_device *gdrm = to_gud_device(drm); 567 struct drm_plane_state *state = pipe->plane.state; 568 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(state); 569 struct drm_framebuffer *fb = state->fb; 570 struct drm_crtc *crtc = &pipe->crtc; 571 struct drm_rect damage; 572 int ret, idx; 573 574 if (crtc->state->mode_changed || !crtc->state->enable) { 575 cancel_work_sync(&gdrm->work); 576 mutex_lock(&gdrm->damage_lock); 577 if (gdrm->fb) { 578 drm_framebuffer_put(gdrm->fb); 579 gdrm->fb = NULL; 580 } 581 gud_clear_damage(gdrm); 582 vfree(gdrm->shadow_buf); 583 gdrm->shadow_buf = NULL; 584 mutex_unlock(&gdrm->damage_lock); 585 } 586 587 if (!drm_dev_enter(drm, &idx)) 588 return; 589 590 if (!old_state->fb) 591 gud_usb_set_u8(gdrm, GUD_REQ_SET_CONTROLLER_ENABLE, 1); 592 593 if (fb && (crtc->state->mode_changed || crtc->state->connectors_changed)) 594 gud_usb_set(gdrm, GUD_REQ_SET_STATE_COMMIT, 0, NULL, 0); 595 596 if (crtc->state->active_changed) 597 gud_usb_set_u8(gdrm, GUD_REQ_SET_DISPLAY_ENABLE, crtc->state->active); 598 599 if (!fb) 600 goto ctrl_disable; 601 602 ret = drm_gem_fb_begin_cpu_access(fb, DMA_FROM_DEVICE); 603 if (ret) 604 goto ctrl_disable; 605 606 if (drm_atomic_helper_damage_merged(old_state, state, &damage)) 607 gud_fb_handle_damage(gdrm, fb, &shadow_plane_state->data[0], &damage); 608 609 drm_gem_fb_end_cpu_access(fb, DMA_FROM_DEVICE); 610 611 ctrl_disable: 612 if (!crtc->state->enable) 613 gud_usb_set_u8(gdrm, GUD_REQ_SET_CONTROLLER_ENABLE, 0); 614 615 drm_dev_exit(idx); 616 } 617