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_damage_helper.h>
18 #include <drm/drm_debugfs.h>
19 #include <drm/drm_drv.h>
20 #include <drm/drm_fb_helper.h>
21 #include <drm/drm_fourcc.h>
22 #include <drm/drm_gem_atomic_helper.h>
23 #include <drm/drm_gem_framebuffer_helper.h>
24 #include <drm/drm_gem_shmem_helper.h>
25 #include <drm/drm_managed.h>
26 #include <drm/drm_print.h>
27 #include <drm/drm_probe_helper.h>
28 #include <drm/drm_simple_kms_helper.h>
31 #include "gud_internal.h"
33 /* Only used internally */
34 static const struct drm_format_info gud_drm_format_r1 = {
35 .format = GUD_DRM_FORMAT_R1,
37 .char_per_block = { 1, 0, 0 },
38 .block_w = { 8, 0, 0 },
39 .block_h = { 1, 0, 0 },
44 static const struct drm_format_info gud_drm_format_xrgb1111 = {
45 .format = GUD_DRM_FORMAT_XRGB1111,
47 .char_per_block = { 1, 0, 0 },
48 .block_w = { 2, 0, 0 },
49 .block_h = { 1, 0, 0 },
54 static int gud_usb_control_msg(struct usb_interface *intf, bool in,
55 u8 request, u16 value, void *buf, size_t len)
57 u8 requesttype = USB_TYPE_VENDOR | USB_RECIP_INTERFACE;
58 u8 ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
59 struct usb_device *usb = interface_to_usbdev(intf);
66 pipe = usb_rcvctrlpipe(usb, 0);
67 requesttype |= USB_DIR_IN;
69 pipe = usb_sndctrlpipe(usb, 0);
70 requesttype |= USB_DIR_OUT;
73 return usb_control_msg(usb, pipe, request, requesttype, value,
74 ifnum, buf, len, USB_CTRL_GET_TIMEOUT);
77 static int gud_get_display_descriptor(struct usb_interface *intf,
78 struct gud_display_descriptor_req *desc)
83 buf = kmalloc(sizeof(*desc), GFP_KERNEL);
87 ret = gud_usb_control_msg(intf, true, GUD_REQ_GET_DESCRIPTOR, 0, buf, sizeof(*desc));
88 memcpy(desc, buf, sizeof(*desc));
92 if (ret != sizeof(*desc))
95 if (desc->magic != le32_to_cpu(GUD_DISPLAY_MAGIC))
98 DRM_DEV_DEBUG_DRIVER(&intf->dev,
99 "version=%u flags=0x%x compression=0x%x max_buffer_size=%u\n",
100 desc->version, le32_to_cpu(desc->flags), desc->compression,
101 le32_to_cpu(desc->max_buffer_size));
103 if (!desc->version || !desc->max_width || !desc->max_height ||
104 le32_to_cpu(desc->min_width) > le32_to_cpu(desc->max_width) ||
105 le32_to_cpu(desc->min_height) > le32_to_cpu(desc->max_height))
111 static int gud_status_to_errno(u8 status)
116 case GUD_STATUS_BUSY:
118 case GUD_STATUS_REQUEST_NOT_SUPPORTED:
120 case GUD_STATUS_PROTOCOL_ERROR:
122 case GUD_STATUS_INVALID_PARAMETER:
124 case GUD_STATUS_ERROR:
131 static int gud_usb_get_status(struct usb_interface *intf)
133 int ret, status = -EIO;
136 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
140 ret = gud_usb_control_msg(intf, true, GUD_REQ_GET_STATUS, 0, buf, sizeof(*buf));
141 if (ret == sizeof(*buf))
142 status = gud_status_to_errno(*buf);
151 static int gud_usb_transfer(struct gud_device *gdrm, bool in, u8 request, u16 index,
152 void *buf, size_t len)
154 struct usb_interface *intf = to_usb_interface(gdrm->drm.dev);
157 drm_dbg(&gdrm->drm, "%s: request=0x%x index=%u len=%zu\n",
158 in ? "get" : "set", request, index, len);
160 if (!drm_dev_enter(&gdrm->drm, &idx))
163 mutex_lock(&gdrm->ctrl_lock);
165 ret = gud_usb_control_msg(intf, in, request, index, buf, len);
166 if (ret == -EPIPE || ((gdrm->flags & GUD_DISPLAY_FLAG_STATUS_ON_SET) && !in && ret >= 0)) {
169 status = gud_usb_get_status(intf);
172 } else if (ret < 0) {
173 dev_err_once(gdrm->drm.dev,
174 "Unexpected status OK for failed transfer\n");
180 drm_dbg(&gdrm->drm, "ret=%d\n", ret);
181 gdrm->stats_num_errors++;
184 mutex_unlock(&gdrm->ctrl_lock);
191 * @buf cannot be allocated on the stack.
192 * Returns number of bytes received or negative error code on failure.
194 int gud_usb_get(struct gud_device *gdrm, u8 request, u16 index, void *buf, size_t max_len)
196 return gud_usb_transfer(gdrm, true, request, index, buf, max_len);
200 * @buf can be allocated on the stack or NULL.
201 * Returns zero on success or negative error code on failure.
203 int gud_usb_set(struct gud_device *gdrm, u8 request, u16 index, void *buf, size_t len)
209 trbuf = kmemdup(buf, len, GFP_KERNEL);
214 ret = gud_usb_transfer(gdrm, false, request, index, trbuf, len);
219 return ret != len ? -EIO : 0;
223 * @val can be allocated on the stack.
224 * Returns zero on success or negative error code on failure.
226 int gud_usb_get_u8(struct gud_device *gdrm, u8 request, u16 index, u8 *val)
231 buf = kmalloc(sizeof(*val), GFP_KERNEL);
235 ret = gud_usb_get(gdrm, request, index, buf, sizeof(*val));
241 return ret != sizeof(*val) ? -EIO : 0;
244 /* Returns zero on success or negative error code on failure. */
245 int gud_usb_set_u8(struct gud_device *gdrm, u8 request, u8 val)
247 return gud_usb_set(gdrm, request, 0, &val, sizeof(val));
250 static int gud_get_properties(struct gud_device *gdrm)
252 struct gud_property_req *properties;
253 unsigned int i, num_properties;
256 properties = kcalloc(GUD_PROPERTIES_MAX_NUM, sizeof(*properties), GFP_KERNEL);
260 ret = gud_usb_get(gdrm, GUD_REQ_GET_PROPERTIES, 0,
261 properties, GUD_PROPERTIES_MAX_NUM * sizeof(*properties));
264 if (ret % sizeof(*properties)) {
269 num_properties = ret / sizeof(*properties);
272 gdrm->properties = drmm_kcalloc(&gdrm->drm, num_properties, sizeof(*gdrm->properties),
274 if (!gdrm->properties) {
279 for (i = 0; i < num_properties; i++) {
280 u16 prop = le16_to_cpu(properties[i].prop);
281 u64 val = le64_to_cpu(properties[i].val);
284 case GUD_PROPERTY_ROTATION:
286 * DRM UAPI matches the protocol so use the value directly,
287 * but mask out any additions on future devices.
289 val &= GUD_ROTATION_MASK;
290 ret = drm_plane_create_rotation_property(&gdrm->pipe.plane,
291 DRM_MODE_ROTATE_0, val);
294 /* New ones might show up in future devices, skip those we don't know. */
295 drm_dbg(&gdrm->drm, "Ignoring unknown property: %u\n", prop);
302 gdrm->properties[gdrm->num_properties++] = prop;
311 * FIXME: Dma-buf sharing requires DMA support by the importing device.
312 * This function is a workaround to make USB devices work as well.
313 * See todo.rst for how to fix the issue in the dma-buf framework.
315 static struct drm_gem_object *gud_gem_prime_import(struct drm_device *drm, struct dma_buf *dma_buf)
317 struct gud_device *gdrm = to_gud_device(drm);
320 return ERR_PTR(-ENODEV);
322 return drm_gem_prime_import_dev(drm, dma_buf, gdrm->dmadev);
325 static int gud_stats_debugfs(struct seq_file *m, void *data)
327 struct drm_info_node *node = m->private;
328 struct gud_device *gdrm = to_gud_device(node->minor->dev);
331 string_get_size(gdrm->bulk_len, 1, STRING_UNITS_2, buf, sizeof(buf));
332 seq_printf(m, "Max buffer size: %s\n", buf);
333 seq_printf(m, "Number of errors: %u\n", gdrm->stats_num_errors);
335 seq_puts(m, "Compression: ");
336 if (gdrm->compression & GUD_COMPRESSION_LZ4)
338 if (!gdrm->compression)
339 seq_puts(m, " none");
342 if (gdrm->compression) {
344 u64 ratio = div64_u64_rem(gdrm->stats_length, gdrm->stats_actual_length,
346 u64 ratio_frac = div64_u64(remainder * 10, gdrm->stats_actual_length);
348 seq_printf(m, "Compression ratio: %llu.%llu\n", ratio, ratio_frac);
354 static const struct drm_info_list gud_debugfs_list[] = {
355 { "stats", gud_stats_debugfs, 0, NULL },
358 static void gud_debugfs_init(struct drm_minor *minor)
360 drm_debugfs_create_files(gud_debugfs_list, ARRAY_SIZE(gud_debugfs_list),
361 minor->debugfs_root, minor);
364 static const struct drm_simple_display_pipe_funcs gud_pipe_funcs = {
365 .check = gud_pipe_check,
366 .update = gud_pipe_update,
369 static const struct drm_mode_config_funcs gud_mode_config_funcs = {
370 .fb_create = drm_gem_fb_create_with_dirty,
371 .atomic_check = drm_atomic_helper_check,
372 .atomic_commit = drm_atomic_helper_commit,
375 static const u64 gud_pipe_modifiers[] = {
376 DRM_FORMAT_MOD_LINEAR,
377 DRM_FORMAT_MOD_INVALID
380 DEFINE_DRM_GEM_FOPS(gud_fops);
382 static const struct drm_driver gud_drm_driver = {
383 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
385 DRM_GEM_SHMEM_DRIVER_OPS,
386 .gem_prime_import = gud_gem_prime_import,
387 .debugfs_init = gud_debugfs_init,
390 .desc = "Generic USB Display",
396 static int gud_alloc_bulk_buffer(struct gud_device *gdrm)
398 unsigned int i, num_pages;
403 gdrm->bulk_buf = vmalloc_32(gdrm->bulk_len);
407 num_pages = DIV_ROUND_UP(gdrm->bulk_len, PAGE_SIZE);
408 pages = kmalloc_array(num_pages, sizeof(struct page *), GFP_KERNEL);
412 for (i = 0, ptr = gdrm->bulk_buf; i < num_pages; i++, ptr += PAGE_SIZE)
413 pages[i] = vmalloc_to_page(ptr);
415 ret = sg_alloc_table_from_pages(&gdrm->bulk_sgt, pages, num_pages,
416 0, gdrm->bulk_len, GFP_KERNEL);
422 static void gud_free_buffers_and_mutex(void *data)
424 struct gud_device *gdrm = data;
426 vfree(gdrm->compress_buf);
427 gdrm->compress_buf = NULL;
428 sg_free_table(&gdrm->bulk_sgt);
429 vfree(gdrm->bulk_buf);
430 gdrm->bulk_buf = NULL;
431 mutex_destroy(&gdrm->ctrl_lock);
434 static int gud_probe(struct usb_interface *intf, const struct usb_device_id *id)
436 const struct drm_format_info *xrgb8888_emulation_format = NULL;
437 bool rgb565_supported = false, xrgb8888_supported = false;
438 unsigned int num_formats_dev, num_formats = 0;
439 struct usb_endpoint_descriptor *bulk_out;
440 struct gud_display_descriptor_req desc;
441 struct device *dev = &intf->dev;
442 size_t max_buffer_size = 0;
443 struct gud_device *gdrm;
444 struct drm_device *drm;
449 ret = usb_find_bulk_out_endpoint(intf->cur_altsetting, &bulk_out);
453 ret = gud_get_display_descriptor(intf, &desc);
455 DRM_DEV_DEBUG_DRIVER(dev, "Not a display interface: ret=%d\n", ret);
459 if (desc.version > 1) {
460 dev_err(dev, "Protocol version %u is not supported\n", desc.version);
464 gdrm = devm_drm_dev_alloc(dev, &gud_drm_driver, struct gud_device, drm);
466 return PTR_ERR(gdrm);
469 drm->mode_config.funcs = &gud_mode_config_funcs;
470 ret = drmm_mode_config_init(drm);
474 gdrm->flags = le32_to_cpu(desc.flags);
475 gdrm->compression = desc.compression & GUD_COMPRESSION_LZ4;
477 if (gdrm->flags & GUD_DISPLAY_FLAG_FULL_UPDATE && gdrm->compression)
480 mutex_init(&gdrm->ctrl_lock);
481 mutex_init(&gdrm->damage_lock);
482 INIT_WORK(&gdrm->work, gud_flush_work);
483 gud_clear_damage(gdrm);
485 ret = devm_add_action(dev, gud_free_buffers_and_mutex, gdrm);
489 drm->mode_config.min_width = le32_to_cpu(desc.min_width);
490 drm->mode_config.max_width = le32_to_cpu(desc.max_width);
491 drm->mode_config.min_height = le32_to_cpu(desc.min_height);
492 drm->mode_config.max_height = le32_to_cpu(desc.max_height);
494 formats_dev = devm_kmalloc(dev, GUD_FORMATS_MAX_NUM, GFP_KERNEL);
495 /* Add room for emulated XRGB8888 */
496 formats = devm_kmalloc_array(dev, GUD_FORMATS_MAX_NUM + 1, sizeof(*formats), GFP_KERNEL);
497 if (!formats_dev || !formats)
500 ret = gud_usb_get(gdrm, GUD_REQ_GET_FORMATS, 0, formats_dev, GUD_FORMATS_MAX_NUM);
504 num_formats_dev = ret;
505 for (i = 0; i < num_formats_dev; i++) {
506 const struct drm_format_info *info;
510 format = gud_to_fourcc(formats_dev[i]);
512 drm_dbg(drm, "Unsupported format: 0x%02x\n", formats_dev[i]);
516 if (format == GUD_DRM_FORMAT_R1)
517 info = &gud_drm_format_r1;
518 else if (format == GUD_DRM_FORMAT_XRGB1111)
519 info = &gud_drm_format_xrgb1111;
521 info = drm_format_info(format);
524 case GUD_DRM_FORMAT_R1:
528 case GUD_DRM_FORMAT_XRGB1111:
530 case DRM_FORMAT_RGB332:
532 case DRM_FORMAT_RGB888:
533 if (!xrgb8888_emulation_format)
534 xrgb8888_emulation_format = info;
536 case DRM_FORMAT_RGB565:
537 rgb565_supported = true;
538 if (!xrgb8888_emulation_format)
539 xrgb8888_emulation_format = info;
541 case DRM_FORMAT_XRGB8888:
542 xrgb8888_supported = true;
546 fmt_buf_size = drm_format_info_min_pitch(info, 0, drm->mode_config.max_width) *
547 drm->mode_config.max_height;
548 max_buffer_size = max(max_buffer_size, fmt_buf_size);
550 if (format == GUD_DRM_FORMAT_R1 || format == GUD_DRM_FORMAT_XRGB1111)
551 continue; /* Internal not for userspace */
553 formats[num_formats++] = format;
556 if (!num_formats && !xrgb8888_emulation_format) {
557 dev_err(dev, "No supported pixel formats found\n");
561 /* Prefer speed over color depth */
562 if (rgb565_supported)
563 drm->mode_config.preferred_depth = 16;
565 if (!xrgb8888_supported && xrgb8888_emulation_format) {
566 gdrm->xrgb8888_emulation_format = xrgb8888_emulation_format;
567 formats[num_formats++] = DRM_FORMAT_XRGB8888;
570 if (desc.max_buffer_size)
571 max_buffer_size = le32_to_cpu(desc.max_buffer_size);
572 /* Prevent a misbehaving device from allocating loads of RAM. 4096x4096@XRGB8888 = 64 MB */
573 if (max_buffer_size > SZ_64M)
574 max_buffer_size = SZ_64M;
576 gdrm->bulk_pipe = usb_sndbulkpipe(interface_to_usbdev(intf), usb_endpoint_num(bulk_out));
577 gdrm->bulk_len = max_buffer_size;
579 ret = gud_alloc_bulk_buffer(gdrm);
583 if (gdrm->compression & GUD_COMPRESSION_LZ4) {
584 gdrm->lz4_comp_mem = devm_kmalloc(dev, LZ4_MEM_COMPRESS, GFP_KERNEL);
585 if (!gdrm->lz4_comp_mem)
588 gdrm->compress_buf = vmalloc(gdrm->bulk_len);
589 if (!gdrm->compress_buf)
593 ret = drm_simple_display_pipe_init(drm, &gdrm->pipe, &gud_pipe_funcs,
594 formats, num_formats,
595 gud_pipe_modifiers, NULL);
599 devm_kfree(dev, formats);
600 devm_kfree(dev, formats_dev);
602 ret = gud_get_properties(gdrm);
604 dev_err(dev, "Failed to get properties (error=%d)\n", ret);
608 drm_plane_enable_fb_damage_clips(&gdrm->pipe.plane);
610 ret = gud_get_connectors(gdrm);
612 dev_err(dev, "Failed to get connectors (error=%d)\n", ret);
616 drm_mode_config_reset(drm);
618 usb_set_intfdata(intf, gdrm);
620 gdrm->dmadev = usb_intf_get_dma_device(intf);
622 dev_warn(dev, "buffer sharing not supported");
624 ret = drm_dev_register(drm, 0);
626 put_device(gdrm->dmadev);
630 drm_kms_helper_poll_init(drm);
632 drm_fbdev_generic_setup(drm, 0);
637 static void gud_disconnect(struct usb_interface *interface)
639 struct gud_device *gdrm = usb_get_intfdata(interface);
640 struct drm_device *drm = &gdrm->drm;
642 drm_dbg(drm, "%s:\n", __func__);
644 drm_kms_helper_poll_fini(drm);
646 drm_atomic_helper_shutdown(drm);
647 put_device(gdrm->dmadev);
651 static int gud_suspend(struct usb_interface *intf, pm_message_t message)
653 struct gud_device *gdrm = usb_get_intfdata(intf);
655 return drm_mode_config_helper_suspend(&gdrm->drm);
658 static int gud_resume(struct usb_interface *intf)
660 struct gud_device *gdrm = usb_get_intfdata(intf);
662 drm_mode_config_helper_resume(&gdrm->drm);
667 static const struct usb_device_id gud_id_table[] = {
668 { USB_DEVICE_INTERFACE_CLASS(0x1d50, 0x614d, USB_CLASS_VENDOR_SPEC) },
669 { USB_DEVICE_INTERFACE_CLASS(0x16d0, 0x10a9, USB_CLASS_VENDOR_SPEC) },
673 MODULE_DEVICE_TABLE(usb, gud_id_table);
675 static struct usb_driver gud_usb_driver = {
678 .disconnect = gud_disconnect,
679 .id_table = gud_id_table,
680 .suspend = gud_suspend,
681 .resume = gud_resume,
682 .reset_resume = gud_resume,
685 module_usb_driver(gud_usb_driver);
687 MODULE_AUTHOR("Noralf Trønnes");
688 MODULE_LICENSE("Dual MIT/GPL");