1 // SPDX-License-Identifier: GPL-2.0-only
3 #include <linux/of_address.h>
5 #include <linux/platform_device.h>
7 #include <drm/drm_aperture.h>
8 #include <drm/drm_atomic.h>
9 #include <drm/drm_atomic_state_helper.h>
10 #include <drm/drm_connector.h>
11 #include <drm/drm_damage_helper.h>
12 #include <drm/drm_device.h>
13 #include <drm/drm_drv.h>
14 #include <drm/drm_fbdev_generic.h>
15 #include <drm/drm_format_helper.h>
16 #include <drm/drm_framebuffer.h>
17 #include <drm/drm_gem_atomic_helper.h>
18 #include <drm/drm_gem_framebuffer_helper.h>
19 #include <drm/drm_gem_shmem_helper.h>
20 #include <drm/drm_managed.h>
21 #include <drm/drm_modeset_helper_vtables.h>
22 #include <drm/drm_plane_helper.h>
23 #include <drm/drm_probe_helper.h>
24 #include <drm/drm_simple_kms_helper.h>
26 #define DRIVER_NAME "ofdrm"
27 #define DRIVER_DESC "DRM driver for OF platform devices"
28 #define DRIVER_DATE "20220501"
29 #define DRIVER_MAJOR 1
30 #define DRIVER_MINOR 0
32 #define PCI_VENDOR_ID_ATI_R520 0x7100
33 #define PCI_VENDOR_ID_ATI_R600 0x9400
35 #define OFDRM_GAMMA_LUT_SIZE 256
37 /* Definitions used by the Avivo palette */
38 #define AVIVO_DC_LUT_RW_SELECT 0x6480
39 #define AVIVO_DC_LUT_RW_MODE 0x6484
40 #define AVIVO_DC_LUT_RW_INDEX 0x6488
41 #define AVIVO_DC_LUT_SEQ_COLOR 0x648c
42 #define AVIVO_DC_LUT_PWL_DATA 0x6490
43 #define AVIVO_DC_LUT_30_COLOR 0x6494
44 #define AVIVO_DC_LUT_READ_PIPE_SELECT 0x6498
45 #define AVIVO_DC_LUT_WRITE_EN_MASK 0x649c
46 #define AVIVO_DC_LUT_AUTOFILL 0x64a0
47 #define AVIVO_DC_LUTA_CONTROL 0x64c0
48 #define AVIVO_DC_LUTA_BLACK_OFFSET_BLUE 0x64c4
49 #define AVIVO_DC_LUTA_BLACK_OFFSET_GREEN 0x64c8
50 #define AVIVO_DC_LUTA_BLACK_OFFSET_RED 0x64cc
51 #define AVIVO_DC_LUTA_WHITE_OFFSET_BLUE 0x64d0
52 #define AVIVO_DC_LUTA_WHITE_OFFSET_GREEN 0x64d4
53 #define AVIVO_DC_LUTA_WHITE_OFFSET_RED 0x64d8
54 #define AVIVO_DC_LUTB_CONTROL 0x6cc0
55 #define AVIVO_DC_LUTB_BLACK_OFFSET_BLUE 0x6cc4
56 #define AVIVO_DC_LUTB_BLACK_OFFSET_GREEN 0x6cc8
57 #define AVIVO_DC_LUTB_BLACK_OFFSET_RED 0x6ccc
58 #define AVIVO_DC_LUTB_WHITE_OFFSET_BLUE 0x6cd0
59 #define AVIVO_DC_LUTB_WHITE_OFFSET_GREEN 0x6cd4
60 #define AVIVO_DC_LUTB_WHITE_OFFSET_RED 0x6cd8
64 OFDRM_MODEL_MACH64, /* ATI Mach64 */
65 OFDRM_MODEL_RAGE128, /* ATI Rage128 */
66 OFDRM_MODEL_RAGE_M3A, /* ATI Rage Mobility M3 Head A */
67 OFDRM_MODEL_RAGE_M3B, /* ATI Rage Mobility M3 Head B */
68 OFDRM_MODEL_RADEON, /* ATI Radeon */
69 OFDRM_MODEL_GXT2000, /* IBM GXT2000 */
70 OFDRM_MODEL_AVIVO, /* ATI R5xx */
71 OFDRM_MODEL_QEMU, /* QEMU VGA */
75 * Helpers for display nodes
78 static int display_get_validated_int(struct drm_device *dev, const char *name, uint32_t value)
80 if (value > INT_MAX) {
81 drm_err(dev, "invalid framebuffer %s of %u\n", name, value);
87 static int display_get_validated_int0(struct drm_device *dev, const char *name, uint32_t value)
90 drm_err(dev, "invalid framebuffer %s of %u\n", name, value);
93 return display_get_validated_int(dev, name, value);
96 static const struct drm_format_info *display_get_validated_format(struct drm_device *dev,
97 u32 depth, bool big_endian)
99 const struct drm_format_info *info;
104 format = drm_mode_legacy_fb_format(8, 8);
108 format = drm_mode_legacy_fb_format(16, depth);
111 format = drm_mode_legacy_fb_format(32, 24);
114 drm_err(dev, "unsupported framebuffer depth %u\n", depth);
115 return ERR_PTR(-EINVAL);
119 * DRM formats assume little-endian byte order. Update the format
120 * if the scanout buffer uses big-endian ordering.
124 case DRM_FORMAT_XRGB8888:
125 format = DRM_FORMAT_BGRX8888;
127 case DRM_FORMAT_ARGB8888:
128 format = DRM_FORMAT_BGRA8888;
130 case DRM_FORMAT_RGB565:
131 format = DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN;
133 case DRM_FORMAT_XRGB1555:
134 format = DRM_FORMAT_XRGB1555 | DRM_FORMAT_BIG_ENDIAN;
141 info = drm_format_info(format);
143 drm_err(dev, "cannot find framebuffer format for depth %u\n", depth);
144 return ERR_PTR(-EINVAL);
150 static int display_read_u32_of(struct drm_device *dev, struct device_node *of_node,
151 const char *name, u32 *value)
153 int ret = of_property_read_u32(of_node, name, value);
156 drm_err(dev, "cannot parse framebuffer %s: error %d\n", name, ret);
160 static bool display_get_big_endian_of(struct drm_device *dev, struct device_node *of_node)
166 if (of_get_property(of_node, "little-endian", NULL))
170 if (of_get_property(of_node, "big-endian", NULL))
177 static int display_get_width_of(struct drm_device *dev, struct device_node *of_node)
180 int ret = display_read_u32_of(dev, of_node, "width", &width);
184 return display_get_validated_int0(dev, "width", width);
187 static int display_get_height_of(struct drm_device *dev, struct device_node *of_node)
190 int ret = display_read_u32_of(dev, of_node, "height", &height);
194 return display_get_validated_int0(dev, "height", height);
197 static int display_get_depth_of(struct drm_device *dev, struct device_node *of_node)
200 int ret = display_read_u32_of(dev, of_node, "depth", &depth);
204 return display_get_validated_int0(dev, "depth", depth);
207 static int display_get_linebytes_of(struct drm_device *dev, struct device_node *of_node)
210 int ret = display_read_u32_of(dev, of_node, "linebytes", &linebytes);
214 return display_get_validated_int(dev, "linebytes", linebytes);
217 static u64 display_get_address_of(struct drm_device *dev, struct device_node *of_node)
223 * Not all devices provide an address property, it's not
224 * a bug if this fails. The driver will try to find the
225 * framebuffer base address from the device's memory regions.
227 ret = of_property_read_u32(of_node, "address", &address);
234 static bool is_avivo(u32 vendor, u32 device)
236 /* This will match most R5xx */
237 return (vendor == PCI_VENDOR_ID_ATI) &&
238 ((device >= PCI_VENDOR_ID_ATI_R520 && device < 0x7800) ||
239 (PCI_VENDOR_ID_ATI_R600 >= 0x9400));
242 static enum ofdrm_model display_get_model_of(struct drm_device *dev, struct device_node *of_node)
244 enum ofdrm_model model = OFDRM_MODEL_UNKNOWN;
246 if (of_node_name_prefix(of_node, "ATY,Rage128")) {
247 model = OFDRM_MODEL_RAGE128;
248 } else if (of_node_name_prefix(of_node, "ATY,RageM3pA") ||
249 of_node_name_prefix(of_node, "ATY,RageM3p12A")) {
250 model = OFDRM_MODEL_RAGE_M3A;
251 } else if (of_node_name_prefix(of_node, "ATY,RageM3pB")) {
252 model = OFDRM_MODEL_RAGE_M3B;
253 } else if (of_node_name_prefix(of_node, "ATY,Rage6")) {
254 model = OFDRM_MODEL_RADEON;
255 } else if (of_node_name_prefix(of_node, "ATY,")) {
256 return OFDRM_MODEL_MACH64;
257 } else if (of_device_is_compatible(of_node, "pci1014,b7") ||
258 of_device_is_compatible(of_node, "pci1014,21c")) {
259 model = OFDRM_MODEL_GXT2000;
260 } else if (of_node_name_prefix(of_node, "vga,Display-")) {
261 struct device_node *of_parent;
262 const __be32 *vendor_p, *device_p;
264 /* Look for AVIVO initialized by SLOF */
265 of_parent = of_get_parent(of_node);
266 vendor_p = of_get_property(of_parent, "vendor-id", NULL);
267 device_p = of_get_property(of_parent, "device-id", NULL);
268 if (vendor_p && device_p) {
269 u32 vendor = be32_to_cpup(vendor_p);
270 u32 device = be32_to_cpup(device_p);
272 if (is_avivo(vendor, device))
273 model = OFDRM_MODEL_AVIVO;
275 of_node_put(of_parent);
276 } else if (of_device_is_compatible(of_node, "qemu,std-vga")) {
277 model = OFDRM_MODEL_QEMU;
284 * Open Firmware display device
289 struct ofdrm_device_funcs {
290 void __iomem *(*cmap_ioremap)(struct ofdrm_device *odev,
291 struct device_node *of_node,
293 void (*cmap_write)(struct ofdrm_device *odev, unsigned char index,
294 unsigned char r, unsigned char g, unsigned char b);
297 struct ofdrm_device {
298 struct drm_device dev;
299 struct platform_device *pdev;
301 const struct ofdrm_device_funcs *funcs;
303 /* firmware-buffer settings */
304 struct iosys_map screen_base;
305 struct drm_display_mode mode;
306 const struct drm_format_info *format;
310 void __iomem *cmap_base;
314 struct drm_plane primary_plane;
315 struct drm_crtc crtc;
316 struct drm_encoder encoder;
317 struct drm_connector connector;
320 static struct ofdrm_device *ofdrm_device_of_dev(struct drm_device *dev)
322 return container_of(dev, struct ofdrm_device, dev);
329 #if defined(CONFIG_PCI)
330 static struct pci_dev *display_get_pci_dev_of(struct drm_device *dev, struct device_node *of_node)
332 const __be32 *vendor_p, *device_p;
334 struct pci_dev *pcidev;
336 vendor_p = of_get_property(of_node, "vendor-id", NULL);
338 return ERR_PTR(-ENODEV);
339 vendor = be32_to_cpup(vendor_p);
341 device_p = of_get_property(of_node, "device-id", NULL);
343 return ERR_PTR(-ENODEV);
344 device = be32_to_cpup(device_p);
346 pcidev = pci_get_device(vendor, device, NULL);
348 return ERR_PTR(-ENODEV);
353 static void ofdrm_pci_release(void *data)
355 struct pci_dev *pcidev = data;
357 pci_disable_device(pcidev);
360 static int ofdrm_device_init_pci(struct ofdrm_device *odev)
362 struct drm_device *dev = &odev->dev;
363 struct platform_device *pdev = to_platform_device(dev->dev);
364 struct device_node *of_node = pdev->dev.of_node;
365 struct pci_dev *pcidev;
369 * Never use pcim_ or other managed helpers on the returned PCI
370 * device. Otherwise, probing the native driver will fail for
371 * resource conflicts. PCI-device management has to be tied to
372 * the lifetime of the platform device until the native driver
375 pcidev = display_get_pci_dev_of(dev, of_node);
377 return 0; /* no PCI device found; ignore the error */
379 ret = pci_enable_device(pcidev);
381 drm_err(dev, "pci_enable_device(%s) failed: %d\n",
382 dev_name(&pcidev->dev), ret);
385 ret = devm_add_action_or_reset(&pdev->dev, ofdrm_pci_release, pcidev);
392 static int ofdrm_device_init_pci(struct ofdrm_device *odev)
399 * OF display settings
402 static struct resource *ofdrm_find_fb_resource(struct ofdrm_device *odev,
403 struct resource *fb_res)
405 struct platform_device *pdev = to_platform_device(odev->dev.dev);
406 struct resource *res, *max_res = NULL;
409 for (i = 0; pdev->num_resources; ++i) {
410 res = platform_get_resource(pdev, IORESOURCE_MEM, i);
412 break; /* all resources processed */
413 if (resource_size(res) < resource_size(fb_res))
414 continue; /* resource too small */
415 if (fb_res->start && resource_contains(res, fb_res))
416 return res; /* resource contains framebuffer */
417 if (!max_res || resource_size(res) > resource_size(max_res))
418 max_res = res; /* store largest resource as fallback */
428 static void __iomem *get_cmap_address_of(struct ofdrm_device *odev, struct device_node *of_node,
429 int bar_no, unsigned long offset, unsigned long size)
431 struct drm_device *dev = &odev->dev;
432 const __be32 *addr_p;
433 u64 max_size, address;
437 addr_p = of_get_pci_address(of_node, bar_no, &max_size, &flags);
439 addr_p = of_get_address(of_node, bar_no, &max_size, &flags);
441 return IOMEM_ERR_PTR(-ENODEV);
443 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
444 return IOMEM_ERR_PTR(-ENODEV);
446 if ((offset + size) >= max_size)
447 return IOMEM_ERR_PTR(-ENODEV);
449 address = of_translate_address(of_node, addr_p);
450 if (address == OF_BAD_ADDR)
451 return IOMEM_ERR_PTR(-ENODEV);
453 mem = devm_ioremap(dev->dev, address + offset, size);
455 return IOMEM_ERR_PTR(-ENOMEM);
460 static void __iomem *ofdrm_mach64_cmap_ioremap(struct ofdrm_device *odev,
461 struct device_node *of_node,
464 struct drm_device *dev = &odev->dev;
466 void __iomem *cmap_base;
468 address = fb_base & 0xff000000ul;
471 cmap_base = devm_ioremap(dev->dev, address, 0x1000);
473 return IOMEM_ERR_PTR(-ENOMEM);
478 static void ofdrm_mach64_cmap_write(struct ofdrm_device *odev, unsigned char index,
479 unsigned char r, unsigned char g, unsigned char b)
481 void __iomem *addr = odev->cmap_base + 0xcc0;
482 void __iomem *data = odev->cmap_base + 0xcc0 + 1;
490 static void __iomem *ofdrm_rage128_cmap_ioremap(struct ofdrm_device *odev,
491 struct device_node *of_node,
494 return get_cmap_address_of(odev, of_node, 2, 0, 0x1fff);
497 static void ofdrm_rage128_cmap_write(struct ofdrm_device *odev, unsigned char index,
498 unsigned char r, unsigned char g, unsigned char b)
500 void __iomem *addr = odev->cmap_base + 0xb0;
501 void __iomem *data = odev->cmap_base + 0xb4;
502 u32 color = (r << 16) | (g << 8) | b;
508 static void __iomem *ofdrm_rage_m3a_cmap_ioremap(struct ofdrm_device *odev,
509 struct device_node *of_node,
512 return get_cmap_address_of(odev, of_node, 2, 0, 0x1fff);
515 static void ofdrm_rage_m3a_cmap_write(struct ofdrm_device *odev, unsigned char index,
516 unsigned char r, unsigned char g, unsigned char b)
518 void __iomem *dac_ctl = odev->cmap_base + 0x58;
519 void __iomem *addr = odev->cmap_base + 0xb0;
520 void __iomem *data = odev->cmap_base + 0xb4;
521 u32 color = (r << 16) | (g << 8) | b;
524 /* Clear PALETTE_ACCESS_CNTL in DAC_CNTL */
525 val = readl(dac_ctl);
527 writel(val, dac_ctl);
529 /* Set color at palette index */
534 static void __iomem *ofdrm_rage_m3b_cmap_ioremap(struct ofdrm_device *odev,
535 struct device_node *of_node,
538 return get_cmap_address_of(odev, of_node, 2, 0, 0x1fff);
541 static void ofdrm_rage_m3b_cmap_write(struct ofdrm_device *odev, unsigned char index,
542 unsigned char r, unsigned char g, unsigned char b)
544 void __iomem *dac_ctl = odev->cmap_base + 0x58;
545 void __iomem *addr = odev->cmap_base + 0xb0;
546 void __iomem *data = odev->cmap_base + 0xb4;
547 u32 color = (r << 16) | (g << 8) | b;
550 /* Set PALETTE_ACCESS_CNTL in DAC_CNTL */
551 val = readl(dac_ctl);
553 writel(val, dac_ctl);
555 /* Set color at palette index */
560 static void __iomem *ofdrm_radeon_cmap_ioremap(struct ofdrm_device *odev,
561 struct device_node *of_node,
564 return get_cmap_address_of(odev, of_node, 1, 0, 0x1fff);
567 static void __iomem *ofdrm_gxt2000_cmap_ioremap(struct ofdrm_device *odev,
568 struct device_node *of_node,
571 return get_cmap_address_of(odev, of_node, 0, 0x6000, 0x1000);
574 static void ofdrm_gxt2000_cmap_write(struct ofdrm_device *odev, unsigned char index,
575 unsigned char r, unsigned char g, unsigned char b)
577 void __iomem *data = ((unsigned int __iomem *)odev->cmap_base) + index;
578 u32 color = (r << 16) | (g << 8) | b;
583 static void __iomem *ofdrm_avivo_cmap_ioremap(struct ofdrm_device *odev,
584 struct device_node *of_node,
587 struct device_node *of_parent;
588 void __iomem *cmap_base;
590 of_parent = of_get_parent(of_node);
591 cmap_base = get_cmap_address_of(odev, of_parent, 0, 0, 0x10000);
592 of_node_put(of_parent);
597 static void ofdrm_avivo_cmap_write(struct ofdrm_device *odev, unsigned char index,
598 unsigned char r, unsigned char g, unsigned char b)
600 void __iomem *lutsel = odev->cmap_base + AVIVO_DC_LUT_RW_SELECT;
601 void __iomem *addr = odev->cmap_base + AVIVO_DC_LUT_RW_INDEX;
602 void __iomem *data = odev->cmap_base + AVIVO_DC_LUT_30_COLOR;
603 u32 color = (r << 22) | (g << 12) | (b << 2);
605 /* Write to both LUTs for now */
616 static void __iomem *ofdrm_qemu_cmap_ioremap(struct ofdrm_device *odev,
617 struct device_node *of_node,
620 static const __be32 io_of_addr[3] = {
621 cpu_to_be32(0x01000000),
626 struct drm_device *dev = &odev->dev;
628 void __iomem *cmap_base;
630 address = of_translate_address(of_node, io_of_addr);
631 if (address == OF_BAD_ADDR)
632 return IOMEM_ERR_PTR(-ENODEV);
634 cmap_base = devm_ioremap(dev->dev, address + 0x3c8, 2);
636 return IOMEM_ERR_PTR(-ENOMEM);
641 static void ofdrm_qemu_cmap_write(struct ofdrm_device *odev, unsigned char index,
642 unsigned char r, unsigned char g, unsigned char b)
644 void __iomem *addr = odev->cmap_base;
645 void __iomem *data = odev->cmap_base + 1;
653 static void ofdrm_device_set_gamma_linear(struct ofdrm_device *odev,
654 const struct drm_format_info *format)
656 struct drm_device *dev = &odev->dev;
659 switch (format->format) {
660 case DRM_FORMAT_RGB565:
661 case DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN:
662 /* Use better interpolation, to take 32 values from 0 to 255 */
663 for (i = 0; i < OFDRM_GAMMA_LUT_SIZE / 8; i++) {
664 unsigned char r = i * 8 + i / 4;
665 unsigned char g = i * 4 + i / 16;
666 unsigned char b = i * 8 + i / 4;
668 odev->funcs->cmap_write(odev, i, r, g, b);
670 /* Green has one more bit, so add padding with 0 for red and blue. */
671 for (i = OFDRM_GAMMA_LUT_SIZE / 8; i < OFDRM_GAMMA_LUT_SIZE / 4; i++) {
673 unsigned char g = i * 4 + i / 16;
676 odev->funcs->cmap_write(odev, i, r, g, b);
679 case DRM_FORMAT_XRGB8888:
680 case DRM_FORMAT_BGRX8888:
681 for (i = 0; i < OFDRM_GAMMA_LUT_SIZE; i++)
682 odev->funcs->cmap_write(odev, i, i, i, i);
685 drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n",
691 static void ofdrm_device_set_gamma(struct ofdrm_device *odev,
692 const struct drm_format_info *format,
693 struct drm_color_lut *lut)
695 struct drm_device *dev = &odev->dev;
698 switch (format->format) {
699 case DRM_FORMAT_RGB565:
700 case DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN:
701 /* Use better interpolation, to take 32 values from lut[0] to lut[255] */
702 for (i = 0; i < OFDRM_GAMMA_LUT_SIZE / 8; i++) {
703 unsigned char r = lut[i * 8 + i / 4].red >> 8;
704 unsigned char g = lut[i * 4 + i / 16].green >> 8;
705 unsigned char b = lut[i * 8 + i / 4].blue >> 8;
707 odev->funcs->cmap_write(odev, i, r, g, b);
709 /* Green has one more bit, so add padding with 0 for red and blue. */
710 for (i = OFDRM_GAMMA_LUT_SIZE / 8; i < OFDRM_GAMMA_LUT_SIZE / 4; i++) {
712 unsigned char g = lut[i * 4 + i / 16].green >> 8;
715 odev->funcs->cmap_write(odev, i, r, g, b);
718 case DRM_FORMAT_XRGB8888:
719 case DRM_FORMAT_BGRX8888:
720 for (i = 0; i < OFDRM_GAMMA_LUT_SIZE; i++) {
721 unsigned char r = lut[i].red >> 8;
722 unsigned char g = lut[i].green >> 8;
723 unsigned char b = lut[i].blue >> 8;
725 odev->funcs->cmap_write(odev, i, r, g, b);
729 drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n",
739 struct ofdrm_crtc_state {
740 struct drm_crtc_state base;
742 /* Primary-plane format; required for color mgmt. */
743 const struct drm_format_info *format;
746 static struct ofdrm_crtc_state *to_ofdrm_crtc_state(struct drm_crtc_state *base)
748 return container_of(base, struct ofdrm_crtc_state, base);
751 static void ofdrm_crtc_state_destroy(struct ofdrm_crtc_state *ofdrm_crtc_state)
753 __drm_atomic_helper_crtc_destroy_state(&ofdrm_crtc_state->base);
754 kfree(ofdrm_crtc_state);
758 * Support all formats of OF display and maybe more; in order
759 * of preference. The display's update function will do any
760 * conversion necessary.
762 * TODO: Add blit helpers for remaining formats and uncomment
765 static const uint32_t ofdrm_primary_plane_formats[] = {
768 //DRM_FORMAT_XRGB1555,
770 /* Big-endian formats below */
772 DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN,
775 static const uint64_t ofdrm_primary_plane_format_modifiers[] = {
776 DRM_FORMAT_MOD_LINEAR,
777 DRM_FORMAT_MOD_INVALID
780 static int ofdrm_primary_plane_helper_atomic_check(struct drm_plane *plane,
781 struct drm_atomic_state *new_state)
783 struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(new_state, plane);
784 struct drm_framebuffer *new_fb = new_plane_state->fb;
785 struct drm_crtc *new_crtc = new_plane_state->crtc;
786 struct drm_crtc_state *new_crtc_state = NULL;
787 struct ofdrm_crtc_state *new_ofdrm_crtc_state;
791 new_crtc_state = drm_atomic_get_new_crtc_state(new_state, new_plane_state->crtc);
793 ret = drm_atomic_helper_check_plane_state(new_plane_state, new_crtc_state,
794 DRM_PLANE_NO_SCALING,
795 DRM_PLANE_NO_SCALING,
799 else if (!new_plane_state->visible)
802 new_crtc_state = drm_atomic_get_new_crtc_state(new_state, new_plane_state->crtc);
804 new_ofdrm_crtc_state = to_ofdrm_crtc_state(new_crtc_state);
805 new_ofdrm_crtc_state->format = new_fb->format;
810 static void ofdrm_primary_plane_helper_atomic_update(struct drm_plane *plane,
811 struct drm_atomic_state *state)
813 struct drm_device *dev = plane->dev;
814 struct ofdrm_device *odev = ofdrm_device_of_dev(dev);
815 struct drm_plane_state *plane_state = drm_atomic_get_new_plane_state(state, plane);
816 struct drm_plane_state *old_plane_state = drm_atomic_get_old_plane_state(state, plane);
817 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(plane_state);
818 struct drm_framebuffer *fb = plane_state->fb;
819 unsigned int dst_pitch = odev->pitch;
820 const struct drm_format_info *dst_format = odev->format;
821 struct drm_atomic_helper_damage_iter iter;
822 struct drm_rect damage;
825 ret = drm_gem_fb_begin_cpu_access(fb, DMA_FROM_DEVICE);
829 if (!drm_dev_enter(dev, &idx))
830 goto out_drm_gem_fb_end_cpu_access;
832 drm_atomic_helper_damage_iter_init(&iter, old_plane_state, plane_state);
833 drm_atomic_for_each_plane_damage(&iter, &damage) {
834 struct iosys_map dst = odev->screen_base;
835 struct drm_rect dst_clip = plane_state->dst;
837 if (!drm_rect_intersect(&dst_clip, &damage))
840 iosys_map_incr(&dst, drm_fb_clip_offset(dst_pitch, dst_format, &dst_clip));
841 drm_fb_blit(&dst, &dst_pitch, dst_format->format, shadow_plane_state->data, fb,
846 out_drm_gem_fb_end_cpu_access:
847 drm_gem_fb_end_cpu_access(fb, DMA_FROM_DEVICE);
850 static void ofdrm_primary_plane_helper_atomic_disable(struct drm_plane *plane,
851 struct drm_atomic_state *state)
853 struct drm_device *dev = plane->dev;
854 struct ofdrm_device *odev = ofdrm_device_of_dev(dev);
855 struct iosys_map dst = odev->screen_base;
856 struct drm_plane_state *plane_state = drm_atomic_get_new_plane_state(state, plane);
857 void __iomem *dst_vmap = dst.vaddr_iomem; /* TODO: Use mapping abstraction */
858 unsigned int dst_pitch = odev->pitch;
859 const struct drm_format_info *dst_format = odev->format;
860 struct drm_rect dst_clip;
861 unsigned long lines, linepixels, i;
864 drm_rect_init(&dst_clip,
865 plane_state->src_x >> 16, plane_state->src_y >> 16,
866 plane_state->src_w >> 16, plane_state->src_h >> 16);
868 lines = drm_rect_height(&dst_clip);
869 linepixels = drm_rect_width(&dst_clip);
871 if (!drm_dev_enter(dev, &idx))
874 /* Clear buffer to black if disabled */
875 dst_vmap += drm_fb_clip_offset(dst_pitch, dst_format, &dst_clip);
876 for (i = 0; i < lines; ++i) {
877 memset_io(dst_vmap, 0, linepixels * dst_format->cpp[0]);
878 dst_vmap += dst_pitch;
884 static const struct drm_plane_helper_funcs ofdrm_primary_plane_helper_funcs = {
885 DRM_GEM_SHADOW_PLANE_HELPER_FUNCS,
886 .atomic_check = ofdrm_primary_plane_helper_atomic_check,
887 .atomic_update = ofdrm_primary_plane_helper_atomic_update,
888 .atomic_disable = ofdrm_primary_plane_helper_atomic_disable,
891 static const struct drm_plane_funcs ofdrm_primary_plane_funcs = {
892 .update_plane = drm_atomic_helper_update_plane,
893 .disable_plane = drm_atomic_helper_disable_plane,
894 .destroy = drm_plane_cleanup,
895 DRM_GEM_SHADOW_PLANE_FUNCS,
898 static enum drm_mode_status ofdrm_crtc_helper_mode_valid(struct drm_crtc *crtc,
899 const struct drm_display_mode *mode)
901 struct ofdrm_device *odev = ofdrm_device_of_dev(crtc->dev);
903 return drm_crtc_helper_mode_valid_fixed(crtc, mode, &odev->mode);
906 static int ofdrm_crtc_helper_atomic_check(struct drm_crtc *crtc,
907 struct drm_atomic_state *new_state)
909 static const size_t gamma_lut_length = OFDRM_GAMMA_LUT_SIZE * sizeof(struct drm_color_lut);
911 struct drm_device *dev = crtc->dev;
912 struct drm_crtc_state *new_crtc_state = drm_atomic_get_new_crtc_state(new_state, crtc);
915 if (!new_crtc_state->enable)
918 ret = drm_atomic_helper_check_crtc_primary_plane(new_crtc_state);
922 if (new_crtc_state->color_mgmt_changed) {
923 struct drm_property_blob *gamma_lut = new_crtc_state->gamma_lut;
925 if (gamma_lut && (gamma_lut->length != gamma_lut_length)) {
926 drm_dbg(dev, "Incorrect gamma_lut length %zu\n", gamma_lut->length);
934 static void ofdrm_crtc_helper_atomic_flush(struct drm_crtc *crtc, struct drm_atomic_state *state)
936 struct ofdrm_device *odev = ofdrm_device_of_dev(crtc->dev);
937 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
938 struct ofdrm_crtc_state *ofdrm_crtc_state = to_ofdrm_crtc_state(crtc_state);
940 if (crtc_state->enable && crtc_state->color_mgmt_changed) {
941 const struct drm_format_info *format = ofdrm_crtc_state->format;
943 if (crtc_state->gamma_lut)
944 ofdrm_device_set_gamma(odev, format, crtc_state->gamma_lut->data);
946 ofdrm_device_set_gamma_linear(odev, format);
951 * The CRTC is always enabled. Screen updates are performed by
952 * the primary plane's atomic_update function. Disabling clears
953 * the screen in the primary plane's atomic_disable function.
955 static const struct drm_crtc_helper_funcs ofdrm_crtc_helper_funcs = {
956 .mode_valid = ofdrm_crtc_helper_mode_valid,
957 .atomic_check = ofdrm_crtc_helper_atomic_check,
958 .atomic_flush = ofdrm_crtc_helper_atomic_flush,
961 static void ofdrm_crtc_reset(struct drm_crtc *crtc)
963 struct ofdrm_crtc_state *ofdrm_crtc_state =
964 kzalloc(sizeof(*ofdrm_crtc_state), GFP_KERNEL);
967 ofdrm_crtc_state_destroy(to_ofdrm_crtc_state(crtc->state));
969 if (ofdrm_crtc_state)
970 __drm_atomic_helper_crtc_reset(crtc, &ofdrm_crtc_state->base);
972 __drm_atomic_helper_crtc_reset(crtc, NULL);
975 static struct drm_crtc_state *ofdrm_crtc_atomic_duplicate_state(struct drm_crtc *crtc)
977 struct drm_device *dev = crtc->dev;
978 struct drm_crtc_state *crtc_state = crtc->state;
979 struct ofdrm_crtc_state *new_ofdrm_crtc_state;
980 struct ofdrm_crtc_state *ofdrm_crtc_state;
982 if (drm_WARN_ON(dev, !crtc_state))
985 new_ofdrm_crtc_state = kzalloc(sizeof(*new_ofdrm_crtc_state), GFP_KERNEL);
986 if (!new_ofdrm_crtc_state)
989 ofdrm_crtc_state = to_ofdrm_crtc_state(crtc_state);
991 __drm_atomic_helper_crtc_duplicate_state(crtc, &new_ofdrm_crtc_state->base);
992 new_ofdrm_crtc_state->format = ofdrm_crtc_state->format;
994 return &new_ofdrm_crtc_state->base;
997 static void ofdrm_crtc_atomic_destroy_state(struct drm_crtc *crtc,
998 struct drm_crtc_state *crtc_state)
1000 ofdrm_crtc_state_destroy(to_ofdrm_crtc_state(crtc_state));
1003 static const struct drm_crtc_funcs ofdrm_crtc_funcs = {
1004 .reset = ofdrm_crtc_reset,
1005 .destroy = drm_crtc_cleanup,
1006 .set_config = drm_atomic_helper_set_config,
1007 .page_flip = drm_atomic_helper_page_flip,
1008 .atomic_duplicate_state = ofdrm_crtc_atomic_duplicate_state,
1009 .atomic_destroy_state = ofdrm_crtc_atomic_destroy_state,
1012 static int ofdrm_connector_helper_get_modes(struct drm_connector *connector)
1014 struct ofdrm_device *odev = ofdrm_device_of_dev(connector->dev);
1016 return drm_connector_helper_get_modes_fixed(connector, &odev->mode);
1019 static const struct drm_connector_helper_funcs ofdrm_connector_helper_funcs = {
1020 .get_modes = ofdrm_connector_helper_get_modes,
1023 static const struct drm_connector_funcs ofdrm_connector_funcs = {
1024 .reset = drm_atomic_helper_connector_reset,
1025 .fill_modes = drm_helper_probe_single_connector_modes,
1026 .destroy = drm_connector_cleanup,
1027 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
1028 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
1031 static const struct drm_mode_config_funcs ofdrm_mode_config_funcs = {
1032 .fb_create = drm_gem_fb_create_with_dirty,
1033 .atomic_check = drm_atomic_helper_check,
1034 .atomic_commit = drm_atomic_helper_commit,
1041 static const struct ofdrm_device_funcs ofdrm_unknown_device_funcs = {
1044 static const struct ofdrm_device_funcs ofdrm_mach64_device_funcs = {
1045 .cmap_ioremap = ofdrm_mach64_cmap_ioremap,
1046 .cmap_write = ofdrm_mach64_cmap_write,
1049 static const struct ofdrm_device_funcs ofdrm_rage128_device_funcs = {
1050 .cmap_ioremap = ofdrm_rage128_cmap_ioremap,
1051 .cmap_write = ofdrm_rage128_cmap_write,
1054 static const struct ofdrm_device_funcs ofdrm_rage_m3a_device_funcs = {
1055 .cmap_ioremap = ofdrm_rage_m3a_cmap_ioremap,
1056 .cmap_write = ofdrm_rage_m3a_cmap_write,
1059 static const struct ofdrm_device_funcs ofdrm_rage_m3b_device_funcs = {
1060 .cmap_ioremap = ofdrm_rage_m3b_cmap_ioremap,
1061 .cmap_write = ofdrm_rage_m3b_cmap_write,
1064 static const struct ofdrm_device_funcs ofdrm_radeon_device_funcs = {
1065 .cmap_ioremap = ofdrm_radeon_cmap_ioremap,
1066 .cmap_write = ofdrm_rage128_cmap_write, /* same as Rage128 */
1069 static const struct ofdrm_device_funcs ofdrm_gxt2000_device_funcs = {
1070 .cmap_ioremap = ofdrm_gxt2000_cmap_ioremap,
1071 .cmap_write = ofdrm_gxt2000_cmap_write,
1074 static const struct ofdrm_device_funcs ofdrm_avivo_device_funcs = {
1075 .cmap_ioremap = ofdrm_avivo_cmap_ioremap,
1076 .cmap_write = ofdrm_avivo_cmap_write,
1079 static const struct ofdrm_device_funcs ofdrm_qemu_device_funcs = {
1080 .cmap_ioremap = ofdrm_qemu_cmap_ioremap,
1081 .cmap_write = ofdrm_qemu_cmap_write,
1084 static struct drm_display_mode ofdrm_mode(unsigned int width, unsigned int height)
1087 * Assume a monitor resolution of 96 dpi to
1088 * get a somewhat reasonable screen size.
1090 const struct drm_display_mode mode = {
1091 DRM_MODE_INIT(60, width, height,
1092 DRM_MODE_RES_MM(width, 96ul),
1093 DRM_MODE_RES_MM(height, 96ul))
1099 static struct ofdrm_device *ofdrm_device_create(struct drm_driver *drv,
1100 struct platform_device *pdev)
1102 struct device_node *of_node = pdev->dev.of_node;
1103 struct ofdrm_device *odev;
1104 struct drm_device *dev;
1105 enum ofdrm_model model;
1107 int width, height, depth, linebytes;
1108 const struct drm_format_info *format;
1110 resource_size_t fb_size, fb_base, fb_pgbase, fb_pgsize;
1111 struct resource *res, *mem;
1112 void __iomem *screen_base;
1113 struct drm_plane *primary_plane;
1114 struct drm_crtc *crtc;
1115 struct drm_encoder *encoder;
1116 struct drm_connector *connector;
1117 unsigned long max_width, max_height;
1121 odev = devm_drm_dev_alloc(&pdev->dev, drv, struct ofdrm_device, dev);
1123 return ERR_CAST(odev);
1125 platform_set_drvdata(pdev, dev);
1127 ret = ofdrm_device_init_pci(odev);
1129 return ERR_PTR(ret);
1132 * OF display-node settings
1135 model = display_get_model_of(dev, of_node);
1136 drm_dbg(dev, "detected model %d\n", model);
1139 case OFDRM_MODEL_UNKNOWN:
1140 odev->funcs = &ofdrm_unknown_device_funcs;
1142 case OFDRM_MODEL_MACH64:
1143 odev->funcs = &ofdrm_mach64_device_funcs;
1145 case OFDRM_MODEL_RAGE128:
1146 odev->funcs = &ofdrm_rage128_device_funcs;
1148 case OFDRM_MODEL_RAGE_M3A:
1149 odev->funcs = &ofdrm_rage_m3a_device_funcs;
1151 case OFDRM_MODEL_RAGE_M3B:
1152 odev->funcs = &ofdrm_rage_m3b_device_funcs;
1154 case OFDRM_MODEL_RADEON:
1155 odev->funcs = &ofdrm_radeon_device_funcs;
1157 case OFDRM_MODEL_GXT2000:
1158 odev->funcs = &ofdrm_gxt2000_device_funcs;
1160 case OFDRM_MODEL_AVIVO:
1161 odev->funcs = &ofdrm_avivo_device_funcs;
1163 case OFDRM_MODEL_QEMU:
1164 odev->funcs = &ofdrm_qemu_device_funcs;
1168 big_endian = display_get_big_endian_of(dev, of_node);
1170 width = display_get_width_of(dev, of_node);
1172 return ERR_PTR(width);
1173 height = display_get_height_of(dev, of_node);
1175 return ERR_PTR(height);
1176 depth = display_get_depth_of(dev, of_node);
1178 return ERR_PTR(depth);
1179 linebytes = display_get_linebytes_of(dev, of_node);
1181 return ERR_PTR(linebytes);
1183 format = display_get_validated_format(dev, depth, big_endian);
1185 return ERR_CAST(format);
1187 linebytes = drm_format_info_min_pitch(format, 0, width);
1188 if (drm_WARN_ON(dev, !linebytes))
1189 return ERR_PTR(-EINVAL);
1192 fb_size = linebytes * height;
1195 * Try to figure out the address of the framebuffer. Unfortunately, Open
1196 * Firmware doesn't provide a standard way to do so. All we can do is a
1197 * dodgy heuristic that happens to work in practice.
1199 * On most machines, the "address" property contains what we need, though
1200 * not on Matrox cards found in IBM machines. What appears to give good
1201 * results is to go through the PCI ranges and pick one that encloses the
1202 * "address" property. If none match, we pick the largest.
1204 address = display_get_address_of(dev, of_node);
1205 if (address != OF_BAD_ADDR) {
1206 struct resource fb_res = DEFINE_RES_MEM(address, fb_size);
1208 res = ofdrm_find_fb_resource(odev, &fb_res);
1210 return ERR_PTR(-EINVAL);
1211 if (resource_contains(res, &fb_res))
1214 fb_base = res->start;
1216 struct resource fb_res = DEFINE_RES_MEM(0u, fb_size);
1218 res = ofdrm_find_fb_resource(odev, &fb_res);
1220 return ERR_PTR(-EINVAL);
1221 fb_base = res->start;
1228 fb_pgbase = round_down(fb_base, PAGE_SIZE);
1229 fb_pgsize = fb_base - fb_pgbase + round_up(fb_size, PAGE_SIZE);
1231 ret = devm_aperture_acquire_from_firmware(dev, fb_pgbase, fb_pgsize);
1233 drm_err(dev, "could not acquire memory range %pr: error %d\n", &res, ret);
1234 return ERR_PTR(ret);
1237 mem = devm_request_mem_region(&pdev->dev, fb_pgbase, fb_pgsize, drv->name);
1239 drm_warn(dev, "could not acquire memory region %pr\n", &res);
1240 return ERR_PTR(-ENOMEM);
1243 screen_base = devm_ioremap(&pdev->dev, mem->start, resource_size(mem));
1245 return ERR_PTR(-ENOMEM);
1247 if (odev->funcs->cmap_ioremap) {
1248 void __iomem *cmap_base = odev->funcs->cmap_ioremap(odev, of_node, fb_base);
1250 if (IS_ERR(cmap_base)) {
1251 /* Don't fail; continue without colormap */
1252 drm_warn(dev, "could not find colormap: error %ld\n", PTR_ERR(cmap_base));
1254 odev->cmap_base = cmap_base;
1259 * Firmware framebuffer
1262 iosys_map_set_vaddr_iomem(&odev->screen_base, screen_base);
1263 odev->mode = ofdrm_mode(width, height);
1264 odev->format = format;
1265 odev->pitch = linebytes;
1267 drm_dbg(dev, "display mode={" DRM_MODE_FMT "}\n", DRM_MODE_ARG(&odev->mode));
1268 drm_dbg(dev, "framebuffer format=%p4cc, size=%dx%d, linebytes=%d byte\n",
1269 &format->format, width, height, linebytes);
1272 * Mode-setting pipeline
1275 ret = drmm_mode_config_init(dev);
1277 return ERR_PTR(ret);
1279 max_width = max_t(unsigned long, width, DRM_SHADOW_PLANE_MAX_WIDTH);
1280 max_height = max_t(unsigned long, height, DRM_SHADOW_PLANE_MAX_HEIGHT);
1282 dev->mode_config.min_width = width;
1283 dev->mode_config.max_width = max_width;
1284 dev->mode_config.min_height = height;
1285 dev->mode_config.max_height = max_height;
1286 dev->mode_config.funcs = &ofdrm_mode_config_funcs;
1287 dev->mode_config.preferred_depth = format->depth;
1288 dev->mode_config.quirk_addfb_prefer_host_byte_order = true;
1292 nformats = drm_fb_build_fourcc_list(dev, &format->format, 1,
1293 ofdrm_primary_plane_formats,
1294 ARRAY_SIZE(ofdrm_primary_plane_formats),
1295 odev->formats, ARRAY_SIZE(odev->formats));
1297 primary_plane = &odev->primary_plane;
1298 ret = drm_universal_plane_init(dev, primary_plane, 0, &ofdrm_primary_plane_funcs,
1299 odev->formats, nformats,
1300 ofdrm_primary_plane_format_modifiers,
1301 DRM_PLANE_TYPE_PRIMARY, NULL);
1303 return ERR_PTR(ret);
1304 drm_plane_helper_add(primary_plane, &ofdrm_primary_plane_helper_funcs);
1305 drm_plane_enable_fb_damage_clips(primary_plane);
1310 ret = drm_crtc_init_with_planes(dev, crtc, primary_plane, NULL,
1311 &ofdrm_crtc_funcs, NULL);
1313 return ERR_PTR(ret);
1314 drm_crtc_helper_add(crtc, &ofdrm_crtc_helper_funcs);
1316 if (odev->cmap_base) {
1317 drm_mode_crtc_set_gamma_size(crtc, OFDRM_GAMMA_LUT_SIZE);
1318 drm_crtc_enable_color_mgmt(crtc, 0, false, OFDRM_GAMMA_LUT_SIZE);
1323 encoder = &odev->encoder;
1324 ret = drm_simple_encoder_init(dev, encoder, DRM_MODE_ENCODER_NONE);
1326 return ERR_PTR(ret);
1327 encoder->possible_crtcs = drm_crtc_mask(crtc);
1331 connector = &odev->connector;
1332 ret = drm_connector_init(dev, connector, &ofdrm_connector_funcs,
1333 DRM_MODE_CONNECTOR_Unknown);
1335 return ERR_PTR(ret);
1336 drm_connector_helper_add(connector, &ofdrm_connector_helper_funcs);
1337 drm_connector_set_panel_orientation_with_quirk(connector,
1338 DRM_MODE_PANEL_ORIENTATION_UNKNOWN,
1341 ret = drm_connector_attach_encoder(connector, encoder);
1343 return ERR_PTR(ret);
1345 drm_mode_config_reset(dev);
1354 DEFINE_DRM_GEM_FOPS(ofdrm_fops);
1356 static struct drm_driver ofdrm_driver = {
1357 DRM_GEM_SHMEM_DRIVER_OPS,
1358 .name = DRIVER_NAME,
1359 .desc = DRIVER_DESC,
1360 .date = DRIVER_DATE,
1361 .major = DRIVER_MAJOR,
1362 .minor = DRIVER_MINOR,
1363 .driver_features = DRIVER_ATOMIC | DRIVER_GEM | DRIVER_MODESET,
1364 .fops = &ofdrm_fops,
1371 static int ofdrm_probe(struct platform_device *pdev)
1373 struct ofdrm_device *odev;
1374 struct drm_device *dev;
1377 odev = ofdrm_device_create(&ofdrm_driver, pdev);
1379 return PTR_ERR(odev);
1382 ret = drm_dev_register(dev, 0);
1386 drm_fbdev_generic_setup(dev, drm_format_info_bpp(odev->format, 0));
1391 static int ofdrm_remove(struct platform_device *pdev)
1393 struct drm_device *dev = platform_get_drvdata(pdev);
1395 drm_dev_unplug(dev);
1400 static const struct of_device_id ofdrm_of_match_display[] = {
1401 { .compatible = "display", },
1404 MODULE_DEVICE_TABLE(of, ofdrm_of_match_display);
1406 static struct platform_driver ofdrm_platform_driver = {
1408 .name = "of-display",
1409 .of_match_table = ofdrm_of_match_display,
1411 .probe = ofdrm_probe,
1412 .remove = ofdrm_remove,
1415 module_platform_driver(ofdrm_platform_driver);
1417 MODULE_DESCRIPTION(DRIVER_DESC);
1418 MODULE_LICENSE("GPL");