1 // SPDX-License-Identifier: MIT
3 * Copyright 2020 Noralf Trønnes
6 #include <linux/dma-buf.h>
7 #include <linux/dma-mapping.h>
9 #include <linux/module.h>
10 #include <linux/platform_device.h>
11 #include <linux/string_helpers.h>
12 #include <linux/usb.h>
13 #include <linux/vmalloc.h>
14 #include <linux/workqueue.h>
16 #include <drm/drm_atomic_helper.h>
17 #include <drm/drm_blend.h>
18 #include <drm/drm_client_setup.h>
19 #include <drm/drm_damage_helper.h>
20 #include <drm/drm_debugfs.h>
21 #include <drm/drm_drv.h>
22 #include <drm/drm_fbdev_shmem.h>
23 #include <drm/drm_fourcc.h>
24 #include <drm/drm_gem_atomic_helper.h>
25 #include <drm/drm_gem_framebuffer_helper.h>
26 #include <drm/drm_gem_shmem_helper.h>
27 #include <drm/drm_managed.h>
28 #include <drm/drm_print.h>
29 #include <drm/drm_probe_helper.h>
30 #include <drm/drm_simple_kms_helper.h>
33 #include "gud_internal.h"
35 /* Only used internally */
36 static const struct drm_format_info gud_drm_format_r1 = {
37 .format = GUD_DRM_FORMAT_R1,
39 .char_per_block = { 1, 0, 0 },
40 .block_w = { 8, 0, 0 },
41 .block_h = { 1, 0, 0 },
46 static const struct drm_format_info gud_drm_format_xrgb1111 = {
47 .format = GUD_DRM_FORMAT_XRGB1111,
49 .char_per_block = { 1, 0, 0 },
50 .block_w = { 2, 0, 0 },
51 .block_h = { 1, 0, 0 },
56 static int gud_usb_control_msg(struct usb_interface *intf, bool in,
57 u8 request, u16 value, void *buf, size_t len)
59 u8 requesttype = USB_TYPE_VENDOR | USB_RECIP_INTERFACE;
60 u8 ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
61 struct usb_device *usb = interface_to_usbdev(intf);
68 pipe = usb_rcvctrlpipe(usb, 0);
69 requesttype |= USB_DIR_IN;
71 pipe = usb_sndctrlpipe(usb, 0);
72 requesttype |= USB_DIR_OUT;
75 return usb_control_msg(usb, pipe, request, requesttype, value,
76 ifnum, buf, len, USB_CTRL_GET_TIMEOUT);
79 static int gud_get_display_descriptor(struct usb_interface *intf,
80 struct gud_display_descriptor_req *desc)
85 buf = kmalloc(sizeof(*desc), GFP_KERNEL);
89 ret = gud_usb_control_msg(intf, true, GUD_REQ_GET_DESCRIPTOR, 0, buf, sizeof(*desc));
90 memcpy(desc, buf, sizeof(*desc));
94 if (ret != sizeof(*desc))
97 if (desc->magic != le32_to_cpu(GUD_DISPLAY_MAGIC))
100 DRM_DEV_DEBUG_DRIVER(&intf->dev,
101 "version=%u flags=0x%x compression=0x%x max_buffer_size=%u\n",
102 desc->version, le32_to_cpu(desc->flags), desc->compression,
103 le32_to_cpu(desc->max_buffer_size));
105 if (!desc->version || !desc->max_width || !desc->max_height ||
106 le32_to_cpu(desc->min_width) > le32_to_cpu(desc->max_width) ||
107 le32_to_cpu(desc->min_height) > le32_to_cpu(desc->max_height))
113 static int gud_status_to_errno(u8 status)
118 case GUD_STATUS_BUSY:
120 case GUD_STATUS_REQUEST_NOT_SUPPORTED:
122 case GUD_STATUS_PROTOCOL_ERROR:
124 case GUD_STATUS_INVALID_PARAMETER:
126 case GUD_STATUS_ERROR:
133 static int gud_usb_get_status(struct usb_interface *intf)
135 int ret, status = -EIO;
138 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
142 ret = gud_usb_control_msg(intf, true, GUD_REQ_GET_STATUS, 0, buf, sizeof(*buf));
143 if (ret == sizeof(*buf))
144 status = gud_status_to_errno(*buf);
153 static int gud_usb_transfer(struct gud_device *gdrm, bool in, u8 request, u16 index,
154 void *buf, size_t len)
156 struct usb_interface *intf = to_usb_interface(gdrm->drm.dev);
159 drm_dbg(&gdrm->drm, "%s: request=0x%x index=%u len=%zu\n",
160 in ? "get" : "set", request, index, len);
162 if (!drm_dev_enter(&gdrm->drm, &idx))
165 mutex_lock(&gdrm->ctrl_lock);
167 ret = gud_usb_control_msg(intf, in, request, index, buf, len);
168 if (ret == -EPIPE || ((gdrm->flags & GUD_DISPLAY_FLAG_STATUS_ON_SET) && !in && ret >= 0)) {
171 status = gud_usb_get_status(intf);
174 } else if (ret < 0) {
175 dev_err_once(gdrm->drm.dev,
176 "Unexpected status OK for failed transfer\n");
182 drm_dbg(&gdrm->drm, "ret=%d\n", ret);
183 gdrm->stats_num_errors++;
186 mutex_unlock(&gdrm->ctrl_lock);
193 * @buf cannot be allocated on the stack.
194 * Returns number of bytes received or negative error code on failure.
196 int gud_usb_get(struct gud_device *gdrm, u8 request, u16 index, void *buf, size_t max_len)
198 return gud_usb_transfer(gdrm, true, request, index, buf, max_len);
202 * @buf can be allocated on the stack or NULL.
203 * Returns zero on success or negative error code on failure.
205 int gud_usb_set(struct gud_device *gdrm, u8 request, u16 index, void *buf, size_t len)
211 trbuf = kmemdup(buf, len, GFP_KERNEL);
216 ret = gud_usb_transfer(gdrm, false, request, index, trbuf, len);
221 return ret != len ? -EIO : 0;
225 * @val can be allocated on the stack.
226 * Returns zero on success or negative error code on failure.
228 int gud_usb_get_u8(struct gud_device *gdrm, u8 request, u16 index, u8 *val)
233 buf = kmalloc(sizeof(*val), GFP_KERNEL);
237 ret = gud_usb_get(gdrm, request, index, buf, sizeof(*val));
243 return ret != sizeof(*val) ? -EIO : 0;
246 /* Returns zero on success or negative error code on failure. */
247 int gud_usb_set_u8(struct gud_device *gdrm, u8 request, u8 val)
249 return gud_usb_set(gdrm, request, 0, &val, sizeof(val));
252 static int gud_get_properties(struct gud_device *gdrm)
254 struct gud_property_req *properties;
255 unsigned int i, num_properties;
258 properties = kcalloc(GUD_PROPERTIES_MAX_NUM, sizeof(*properties), GFP_KERNEL);
262 ret = gud_usb_get(gdrm, GUD_REQ_GET_PROPERTIES, 0,
263 properties, GUD_PROPERTIES_MAX_NUM * sizeof(*properties));
266 if (ret % sizeof(*properties)) {
271 num_properties = ret / sizeof(*properties);
274 gdrm->properties = drmm_kcalloc(&gdrm->drm, num_properties, sizeof(*gdrm->properties),
276 if (!gdrm->properties) {
281 for (i = 0; i < num_properties; i++) {
282 u16 prop = le16_to_cpu(properties[i].prop);
283 u64 val = le64_to_cpu(properties[i].val);
286 case GUD_PROPERTY_ROTATION:
288 * DRM UAPI matches the protocol so use the value directly,
289 * but mask out any additions on future devices.
291 val &= GUD_ROTATION_MASK;
292 ret = drm_plane_create_rotation_property(&gdrm->pipe.plane,
293 DRM_MODE_ROTATE_0, val);
296 /* New ones might show up in future devices, skip those we don't know. */
297 drm_dbg(&gdrm->drm, "Ignoring unknown property: %u\n", prop);
304 gdrm->properties[gdrm->num_properties++] = prop;
313 * FIXME: Dma-buf sharing requires DMA support by the importing device.
314 * This function is a workaround to make USB devices work as well.
315 * See todo.rst for how to fix the issue in the dma-buf framework.
317 static struct drm_gem_object *gud_gem_prime_import(struct drm_device *drm, struct dma_buf *dma_buf)
319 struct gud_device *gdrm = to_gud_device(drm);
322 return ERR_PTR(-ENODEV);
324 return drm_gem_prime_import_dev(drm, dma_buf, gdrm->dmadev);
327 static int gud_stats_debugfs(struct seq_file *m, void *data)
329 struct drm_debugfs_entry *entry = m->private;
330 struct gud_device *gdrm = to_gud_device(entry->dev);
333 string_get_size(gdrm->bulk_len, 1, STRING_UNITS_2, buf, sizeof(buf));
334 seq_printf(m, "Max buffer size: %s\n", buf);
335 seq_printf(m, "Number of errors: %u\n", gdrm->stats_num_errors);
337 seq_puts(m, "Compression: ");
338 if (gdrm->compression & GUD_COMPRESSION_LZ4)
340 if (!gdrm->compression)
341 seq_puts(m, " none");
344 if (gdrm->compression) {
346 u64 ratio = div64_u64_rem(gdrm->stats_length, gdrm->stats_actual_length,
348 u64 ratio_frac = div64_u64(remainder * 10, gdrm->stats_actual_length);
350 seq_printf(m, "Compression ratio: %llu.%llu\n", ratio, ratio_frac);
356 static const struct drm_simple_display_pipe_funcs gud_pipe_funcs = {
357 .check = gud_pipe_check,
358 .update = gud_pipe_update,
359 DRM_GEM_SIMPLE_DISPLAY_PIPE_SHADOW_PLANE_FUNCS
362 static const struct drm_mode_config_funcs gud_mode_config_funcs = {
363 .fb_create = drm_gem_fb_create_with_dirty,
364 .atomic_check = drm_atomic_helper_check,
365 .atomic_commit = drm_atomic_helper_commit,
368 static const u64 gud_pipe_modifiers[] = {
369 DRM_FORMAT_MOD_LINEAR,
370 DRM_FORMAT_MOD_INVALID
373 DEFINE_DRM_GEM_FOPS(gud_fops);
375 static const struct drm_driver gud_drm_driver = {
376 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
378 DRM_GEM_SHMEM_DRIVER_OPS,
379 .gem_prime_import = gud_gem_prime_import,
380 DRM_FBDEV_SHMEM_DRIVER_OPS,
383 .desc = "Generic USB Display",
389 static int gud_alloc_bulk_buffer(struct gud_device *gdrm)
391 unsigned int i, num_pages;
396 gdrm->bulk_buf = vmalloc_32(gdrm->bulk_len);
400 num_pages = DIV_ROUND_UP(gdrm->bulk_len, PAGE_SIZE);
401 pages = kmalloc_array(num_pages, sizeof(struct page *), GFP_KERNEL);
405 for (i = 0, ptr = gdrm->bulk_buf; i < num_pages; i++, ptr += PAGE_SIZE)
406 pages[i] = vmalloc_to_page(ptr);
408 ret = sg_alloc_table_from_pages(&gdrm->bulk_sgt, pages, num_pages,
409 0, gdrm->bulk_len, GFP_KERNEL);
415 static void gud_free_buffers_and_mutex(void *data)
417 struct gud_device *gdrm = data;
419 vfree(gdrm->compress_buf);
420 gdrm->compress_buf = NULL;
421 sg_free_table(&gdrm->bulk_sgt);
422 vfree(gdrm->bulk_buf);
423 gdrm->bulk_buf = NULL;
424 mutex_destroy(&gdrm->ctrl_lock);
427 static int gud_probe(struct usb_interface *intf, const struct usb_device_id *id)
429 const struct drm_format_info *xrgb8888_emulation_format = NULL;
430 bool rgb565_supported = false, xrgb8888_supported = false;
431 unsigned int num_formats_dev, num_formats = 0;
432 struct usb_endpoint_descriptor *bulk_out;
433 struct gud_display_descriptor_req desc;
434 struct device *dev = &intf->dev;
435 size_t max_buffer_size = 0;
436 struct gud_device *gdrm;
437 struct drm_device *drm;
442 ret = usb_find_bulk_out_endpoint(intf->cur_altsetting, &bulk_out);
446 ret = gud_get_display_descriptor(intf, &desc);
448 DRM_DEV_DEBUG_DRIVER(dev, "Not a display interface: ret=%d\n", ret);
452 if (desc.version > 1) {
453 dev_err(dev, "Protocol version %u is not supported\n", desc.version);
457 gdrm = devm_drm_dev_alloc(dev, &gud_drm_driver, struct gud_device, drm);
459 return PTR_ERR(gdrm);
462 drm->mode_config.funcs = &gud_mode_config_funcs;
463 ret = drmm_mode_config_init(drm);
467 gdrm->flags = le32_to_cpu(desc.flags);
468 gdrm->compression = desc.compression & GUD_COMPRESSION_LZ4;
470 if (gdrm->flags & GUD_DISPLAY_FLAG_FULL_UPDATE && gdrm->compression)
473 mutex_init(&gdrm->ctrl_lock);
474 mutex_init(&gdrm->damage_lock);
475 INIT_WORK(&gdrm->work, gud_flush_work);
476 gud_clear_damage(gdrm);
478 ret = devm_add_action(dev, gud_free_buffers_and_mutex, gdrm);
482 drm->mode_config.min_width = le32_to_cpu(desc.min_width);
483 drm->mode_config.max_width = le32_to_cpu(desc.max_width);
484 drm->mode_config.min_height = le32_to_cpu(desc.min_height);
485 drm->mode_config.max_height = le32_to_cpu(desc.max_height);
487 formats_dev = devm_kmalloc(dev, GUD_FORMATS_MAX_NUM, GFP_KERNEL);
488 /* Add room for emulated XRGB8888 */
489 formats = devm_kmalloc_array(dev, GUD_FORMATS_MAX_NUM + 1, sizeof(*formats), GFP_KERNEL);
490 if (!formats_dev || !formats)
493 ret = gud_usb_get(gdrm, GUD_REQ_GET_FORMATS, 0, formats_dev, GUD_FORMATS_MAX_NUM);
497 num_formats_dev = ret;
498 for (i = 0; i < num_formats_dev; i++) {
499 const struct drm_format_info *info;
503 format = gud_to_fourcc(formats_dev[i]);
505 drm_dbg(drm, "Unsupported format: 0x%02x\n", formats_dev[i]);
509 if (format == GUD_DRM_FORMAT_R1)
510 info = &gud_drm_format_r1;
511 else if (format == GUD_DRM_FORMAT_XRGB1111)
512 info = &gud_drm_format_xrgb1111;
514 info = drm_format_info(format);
517 case GUD_DRM_FORMAT_R1:
521 case GUD_DRM_FORMAT_XRGB1111:
523 case DRM_FORMAT_RGB332:
525 case DRM_FORMAT_RGB888:
526 if (!xrgb8888_emulation_format)
527 xrgb8888_emulation_format = info;
529 case DRM_FORMAT_RGB565:
530 rgb565_supported = true;
531 if (!xrgb8888_emulation_format)
532 xrgb8888_emulation_format = info;
534 case DRM_FORMAT_XRGB8888:
535 xrgb8888_supported = true;
539 fmt_buf_size = drm_format_info_min_pitch(info, 0, drm->mode_config.max_width) *
540 drm->mode_config.max_height;
541 max_buffer_size = max(max_buffer_size, fmt_buf_size);
543 if (format == GUD_DRM_FORMAT_R1 || format == GUD_DRM_FORMAT_XRGB1111)
544 continue; /* Internal not for userspace */
546 formats[num_formats++] = format;
549 if (!num_formats && !xrgb8888_emulation_format) {
550 dev_err(dev, "No supported pixel formats found\n");
554 /* Prefer speed over color depth */
555 if (rgb565_supported)
556 drm->mode_config.preferred_depth = 16;
558 if (!xrgb8888_supported && xrgb8888_emulation_format) {
559 gdrm->xrgb8888_emulation_format = xrgb8888_emulation_format;
560 formats[num_formats++] = DRM_FORMAT_XRGB8888;
563 if (desc.max_buffer_size)
564 max_buffer_size = le32_to_cpu(desc.max_buffer_size);
565 /* Prevent a misbehaving device from allocating loads of RAM. 4096x4096@XRGB8888 = 64 MB */
566 if (max_buffer_size > SZ_64M)
567 max_buffer_size = SZ_64M;
569 gdrm->bulk_pipe = usb_sndbulkpipe(interface_to_usbdev(intf), usb_endpoint_num(bulk_out));
570 gdrm->bulk_len = max_buffer_size;
572 ret = gud_alloc_bulk_buffer(gdrm);
576 if (gdrm->compression & GUD_COMPRESSION_LZ4) {
577 gdrm->lz4_comp_mem = devm_kmalloc(dev, LZ4_MEM_COMPRESS, GFP_KERNEL);
578 if (!gdrm->lz4_comp_mem)
581 gdrm->compress_buf = vmalloc(gdrm->bulk_len);
582 if (!gdrm->compress_buf)
586 ret = drm_simple_display_pipe_init(drm, &gdrm->pipe, &gud_pipe_funcs,
587 formats, num_formats,
588 gud_pipe_modifiers, NULL);
592 devm_kfree(dev, formats);
593 devm_kfree(dev, formats_dev);
595 ret = gud_get_properties(gdrm);
597 dev_err(dev, "Failed to get properties (error=%d)\n", ret);
601 drm_plane_enable_fb_damage_clips(&gdrm->pipe.plane);
603 ret = gud_get_connectors(gdrm);
605 dev_err(dev, "Failed to get connectors (error=%d)\n", ret);
609 drm_mode_config_reset(drm);
611 usb_set_intfdata(intf, gdrm);
613 gdrm->dmadev = usb_intf_get_dma_device(intf);
615 dev_warn(dev, "buffer sharing not supported");
617 drm_debugfs_add_file(drm, "stats", gud_stats_debugfs, NULL);
619 ret = drm_dev_register(drm, 0);
621 put_device(gdrm->dmadev);
625 drm_kms_helper_poll_init(drm);
627 drm_client_setup(drm, NULL);
632 static void gud_disconnect(struct usb_interface *interface)
634 struct gud_device *gdrm = usb_get_intfdata(interface);
635 struct drm_device *drm = &gdrm->drm;
637 drm_dbg(drm, "%s:\n", __func__);
639 drm_kms_helper_poll_fini(drm);
641 drm_atomic_helper_shutdown(drm);
642 put_device(gdrm->dmadev);
646 static int gud_suspend(struct usb_interface *intf, pm_message_t message)
648 struct gud_device *gdrm = usb_get_intfdata(intf);
650 return drm_mode_config_helper_suspend(&gdrm->drm);
653 static int gud_resume(struct usb_interface *intf)
655 struct gud_device *gdrm = usb_get_intfdata(intf);
657 drm_mode_config_helper_resume(&gdrm->drm);
662 static const struct usb_device_id gud_id_table[] = {
663 { USB_DEVICE_INTERFACE_CLASS(0x1d50, 0x614d, USB_CLASS_VENDOR_SPEC) },
664 { USB_DEVICE_INTERFACE_CLASS(0x16d0, 0x10a9, USB_CLASS_VENDOR_SPEC) },
668 MODULE_DEVICE_TABLE(usb, gud_id_table);
670 static struct usb_driver gud_usb_driver = {
673 .disconnect = gud_disconnect,
674 .id_table = gud_id_table,
675 .suspend = gud_suspend,
676 .resume = gud_resume,
677 .reset_resume = gud_resume,
680 module_usb_driver(gud_usb_driver);
682 MODULE_AUTHOR("Noralf Trønnes");
683 MODULE_DESCRIPTION("GUD USB Display driver");
684 MODULE_LICENSE("Dual MIT/GPL");