xref: /linux/drivers/gpu/drm/sysfb/ofdrm.c (revision 8d2b0853add1d7534dc0794e3c8e0b9e8c4ec640)
1 // SPDX-License-Identifier: GPL-2.0-only
2 
3 #include <linux/aperture.h>
4 #include <linux/of_address.h>
5 #include <linux/pci.h>
6 #include <linux/platform_device.h>
7 
8 #include <drm/clients/drm_client_setup.h>
9 #include <drm/drm_atomic.h>
10 #include <drm/drm_atomic_state_helper.h>
11 #include <drm/drm_color_mgmt.h>
12 #include <drm/drm_connector.h>
13 #include <drm/drm_damage_helper.h>
14 #include <drm/drm_device.h>
15 #include <drm/drm_drv.h>
16 #include <drm/drm_edid.h>
17 #include <drm/drm_fbdev_shmem.h>
18 #include <drm/drm_framebuffer.h>
19 #include <drm/drm_gem_atomic_helper.h>
20 #include <drm/drm_gem_framebuffer_helper.h>
21 #include <drm/drm_gem_shmem_helper.h>
22 #include <drm/drm_managed.h>
23 #include <drm/drm_modeset_helper_vtables.h>
24 #include <drm/drm_probe_helper.h>
25 
26 #include "drm_sysfb_helper.h"
27 
28 #define DRIVER_NAME	"ofdrm"
29 #define DRIVER_DESC	"DRM driver for OF platform devices"
30 #define DRIVER_MAJOR	1
31 #define DRIVER_MINOR	0
32 
33 #define PCI_VENDOR_ID_ATI_R520	0x7100
34 #define PCI_VENDOR_ID_ATI_R600	0x9400
35 
36 #define OFDRM_GAMMA_LUT_SIZE	256
37 
38 /* Definitions used by the Avivo palette  */
39 #define AVIVO_DC_LUT_RW_SELECT                  0x6480
40 #define AVIVO_DC_LUT_RW_MODE                    0x6484
41 #define AVIVO_DC_LUT_RW_INDEX                   0x6488
42 #define AVIVO_DC_LUT_SEQ_COLOR                  0x648c
43 #define AVIVO_DC_LUT_PWL_DATA                   0x6490
44 #define AVIVO_DC_LUT_30_COLOR                   0x6494
45 #define AVIVO_DC_LUT_READ_PIPE_SELECT           0x6498
46 #define AVIVO_DC_LUT_WRITE_EN_MASK              0x649c
47 #define AVIVO_DC_LUT_AUTOFILL                   0x64a0
48 #define AVIVO_DC_LUTA_CONTROL                   0x64c0
49 #define AVIVO_DC_LUTA_BLACK_OFFSET_BLUE         0x64c4
50 #define AVIVO_DC_LUTA_BLACK_OFFSET_GREEN        0x64c8
51 #define AVIVO_DC_LUTA_BLACK_OFFSET_RED          0x64cc
52 #define AVIVO_DC_LUTA_WHITE_OFFSET_BLUE         0x64d0
53 #define AVIVO_DC_LUTA_WHITE_OFFSET_GREEN        0x64d4
54 #define AVIVO_DC_LUTA_WHITE_OFFSET_RED          0x64d8
55 #define AVIVO_DC_LUTB_CONTROL                   0x6cc0
56 #define AVIVO_DC_LUTB_BLACK_OFFSET_BLUE         0x6cc4
57 #define AVIVO_DC_LUTB_BLACK_OFFSET_GREEN        0x6cc8
58 #define AVIVO_DC_LUTB_BLACK_OFFSET_RED          0x6ccc
59 #define AVIVO_DC_LUTB_WHITE_OFFSET_BLUE         0x6cd0
60 #define AVIVO_DC_LUTB_WHITE_OFFSET_GREEN        0x6cd4
61 #define AVIVO_DC_LUTB_WHITE_OFFSET_RED          0x6cd8
62 
63 enum ofdrm_model {
64 	OFDRM_MODEL_UNKNOWN,
65 	OFDRM_MODEL_MACH64, /* ATI Mach64 */
66 	OFDRM_MODEL_RAGE128, /* ATI Rage128 */
67 	OFDRM_MODEL_RAGE_M3A, /* ATI Rage Mobility M3 Head A */
68 	OFDRM_MODEL_RAGE_M3B, /* ATI Rage Mobility M3 Head B */
69 	OFDRM_MODEL_RADEON, /* ATI Radeon */
70 	OFDRM_MODEL_GXT2000, /* IBM GXT2000 */
71 	OFDRM_MODEL_AVIVO, /* ATI R5xx */
72 	OFDRM_MODEL_QEMU, /* QEMU VGA */
73 };
74 
75 /*
76  * Helpers for display nodes
77  */
78 
79 static int display_get_validated_int(struct drm_device *dev, const char *name, uint32_t value)
80 {
81 	return drm_sysfb_get_validated_int(dev, name, value, INT_MAX);
82 }
83 
84 static int display_get_validated_int0(struct drm_device *dev, const char *name, uint32_t value)
85 {
86 	return drm_sysfb_get_validated_int0(dev, name, value, INT_MAX);
87 }
88 
89 static const struct drm_format_info *display_get_validated_format(struct drm_device *dev,
90 								  u32 depth, bool big_endian)
91 {
92 	const struct drm_format_info *info;
93 	u32 format;
94 
95 	switch (depth) {
96 	case 8:
97 		format = drm_mode_legacy_fb_format(8, 8);
98 		break;
99 	case 15:
100 	case 16:
101 		format = drm_mode_legacy_fb_format(16, depth);
102 		break;
103 	case 32:
104 		format = drm_mode_legacy_fb_format(32, 24);
105 		break;
106 	default:
107 		drm_err(dev, "unsupported framebuffer depth %u\n", depth);
108 		return ERR_PTR(-EINVAL);
109 	}
110 
111 	/*
112 	 * DRM formats assume little-endian byte order. Update the format
113 	 * if the scanout buffer uses big-endian ordering.
114 	 */
115 	if (big_endian) {
116 		switch (format) {
117 		case DRM_FORMAT_XRGB8888:
118 			format = DRM_FORMAT_BGRX8888;
119 			break;
120 		case DRM_FORMAT_ARGB8888:
121 			format = DRM_FORMAT_BGRA8888;
122 			break;
123 		case DRM_FORMAT_RGB565:
124 			format = DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN;
125 			break;
126 		case DRM_FORMAT_XRGB1555:
127 			format = DRM_FORMAT_XRGB1555 | DRM_FORMAT_BIG_ENDIAN;
128 			break;
129 		default:
130 			break;
131 		}
132 	}
133 
134 	info = drm_format_info(format);
135 	if (!info) {
136 		drm_err(dev, "cannot find framebuffer format for depth %u\n", depth);
137 		return ERR_PTR(-EINVAL);
138 	}
139 
140 	return info;
141 }
142 
143 static int display_read_u32_of(struct drm_device *dev, struct device_node *of_node,
144 			       const char *name, u32 *value)
145 {
146 	int ret = of_property_read_u32(of_node, name, value);
147 
148 	if (ret)
149 		drm_err(dev, "cannot parse framebuffer %s: error %d\n", name, ret);
150 	return ret;
151 }
152 
153 static bool display_get_big_endian_of(struct drm_device *dev, struct device_node *of_node)
154 {
155 	bool big_endian;
156 
157 #ifdef __BIG_ENDIAN
158 	big_endian = !of_property_read_bool(of_node, "little-endian");
159 #else
160 	big_endian = of_property_read_bool(of_node, "big-endian");
161 #endif
162 
163 	return big_endian;
164 }
165 
166 static int display_get_width_of(struct drm_device *dev, struct device_node *of_node)
167 {
168 	u32 width;
169 	int ret = display_read_u32_of(dev, of_node, "width", &width);
170 
171 	if (ret)
172 		return ret;
173 	return display_get_validated_int0(dev, "width", width);
174 }
175 
176 static int display_get_height_of(struct drm_device *dev, struct device_node *of_node)
177 {
178 	u32 height;
179 	int ret = display_read_u32_of(dev, of_node, "height", &height);
180 
181 	if (ret)
182 		return ret;
183 	return display_get_validated_int0(dev, "height", height);
184 }
185 
186 static int display_get_depth_of(struct drm_device *dev, struct device_node *of_node)
187 {
188 	u32 depth;
189 	int ret = display_read_u32_of(dev, of_node, "depth", &depth);
190 
191 	if (ret)
192 		return ret;
193 	return display_get_validated_int0(dev, "depth", depth);
194 }
195 
196 static int display_get_linebytes_of(struct drm_device *dev, struct device_node *of_node)
197 {
198 	u32 linebytes;
199 	int ret = display_read_u32_of(dev, of_node, "linebytes", &linebytes);
200 
201 	if (ret)
202 		return ret;
203 	return display_get_validated_int(dev, "linebytes", linebytes);
204 }
205 
206 static u64 display_get_address_of(struct drm_device *dev, struct device_node *of_node)
207 {
208 	u32 address;
209 	int ret;
210 
211 	/*
212 	 * Not all devices provide an address property, it's not
213 	 * a bug if this fails. The driver will try to find the
214 	 * framebuffer base address from the device's memory regions.
215 	 */
216 	ret = of_property_read_u32(of_node, "address", &address);
217 	if (ret)
218 		return OF_BAD_ADDR;
219 
220 	return address;
221 }
222 
223 static const u8 *display_get_edid_of(struct drm_device *dev, struct device_node *of_node,
224 				     u8 buf[EDID_LENGTH])
225 {
226 	int ret = of_property_read_u8_array(of_node, "EDID", buf, EDID_LENGTH);
227 
228 	if (ret)
229 		return NULL;
230 	return buf;
231 }
232 
233 static bool is_avivo(u32 vendor, u32 device)
234 {
235 	/* This will match most R5xx */
236 	return (vendor == PCI_VENDOR_ID_ATI) &&
237 	       ((device >= PCI_VENDOR_ID_ATI_R520 && device < 0x7800) ||
238 		(PCI_VENDOR_ID_ATI_R600 >= 0x9400));
239 }
240 
241 static enum ofdrm_model display_get_model_of(struct drm_device *dev, struct device_node *of_node)
242 {
243 	enum ofdrm_model model = OFDRM_MODEL_UNKNOWN;
244 
245 	if (of_node_name_prefix(of_node, "ATY,Rage128")) {
246 		model = OFDRM_MODEL_RAGE128;
247 	} else if (of_node_name_prefix(of_node, "ATY,RageM3pA") ||
248 		   of_node_name_prefix(of_node, "ATY,RageM3p12A")) {
249 		model = OFDRM_MODEL_RAGE_M3A;
250 	} else if (of_node_name_prefix(of_node, "ATY,RageM3pB")) {
251 		model = OFDRM_MODEL_RAGE_M3B;
252 	} else if (of_node_name_prefix(of_node, "ATY,Rage6")) {
253 		model = OFDRM_MODEL_RADEON;
254 	} else if (of_node_name_prefix(of_node, "ATY,")) {
255 		return OFDRM_MODEL_MACH64;
256 	} else if (of_device_is_compatible(of_node, "pci1014,b7") ||
257 		   of_device_is_compatible(of_node, "pci1014,21c")) {
258 		model = OFDRM_MODEL_GXT2000;
259 	} else if (of_node_name_prefix(of_node, "vga,Display-")) {
260 		struct device_node *of_parent;
261 		const __be32 *vendor_p, *device_p;
262 
263 		/* Look for AVIVO initialized by SLOF */
264 		of_parent = of_get_parent(of_node);
265 		vendor_p = of_get_property(of_parent, "vendor-id", NULL);
266 		device_p = of_get_property(of_parent, "device-id", NULL);
267 		if (vendor_p && device_p) {
268 			u32 vendor = be32_to_cpup(vendor_p);
269 			u32 device = be32_to_cpup(device_p);
270 
271 			if (is_avivo(vendor, device))
272 				model = OFDRM_MODEL_AVIVO;
273 		}
274 		of_node_put(of_parent);
275 	} else if (of_device_is_compatible(of_node, "qemu,std-vga")) {
276 		model = OFDRM_MODEL_QEMU;
277 	}
278 
279 	return model;
280 }
281 
282 /*
283  * Open Firmware display device
284  */
285 
286 struct ofdrm_device;
287 
288 struct ofdrm_device_funcs {
289 	void __iomem *(*cmap_ioremap)(struct ofdrm_device *odev,
290 				      struct device_node *of_node,
291 				      u64 fb_bas);
292 	void (*cmap_write)(struct ofdrm_device *odev, unsigned char index,
293 			   unsigned char r, unsigned char g, unsigned char b);
294 };
295 
296 struct ofdrm_device {
297 	struct drm_sysfb_device sysfb;
298 
299 	const struct ofdrm_device_funcs *funcs;
300 
301 	/* colormap */
302 	void __iomem *cmap_base;
303 
304 	u8 edid[EDID_LENGTH];
305 
306 	/* modesetting */
307 	u32 formats[DRM_SYSFB_PLANE_NFORMATS(1)];
308 	struct drm_plane primary_plane;
309 	struct drm_crtc crtc;
310 	struct drm_encoder encoder;
311 	struct drm_connector connector;
312 };
313 
314 static struct ofdrm_device *ofdrm_device_of_dev(struct drm_device *dev)
315 {
316 	return container_of(to_drm_sysfb_device(dev), struct ofdrm_device, sysfb);
317 }
318 
319 /*
320  * Hardware
321  */
322 
323 #if defined(CONFIG_PCI)
324 static struct pci_dev *display_get_pci_dev_of(struct drm_device *dev, struct device_node *of_node)
325 {
326 	const __be32 *vendor_p, *device_p;
327 	u32 vendor, device;
328 	struct pci_dev *pcidev;
329 
330 	vendor_p = of_get_property(of_node, "vendor-id", NULL);
331 	if (!vendor_p)
332 		return ERR_PTR(-ENODEV);
333 	vendor = be32_to_cpup(vendor_p);
334 
335 	device_p = of_get_property(of_node, "device-id", NULL);
336 	if (!device_p)
337 		return ERR_PTR(-ENODEV);
338 	device = be32_to_cpup(device_p);
339 
340 	pcidev = pci_get_device(vendor, device, NULL);
341 	if (!pcidev)
342 		return ERR_PTR(-ENODEV);
343 
344 	return pcidev;
345 }
346 
347 static void ofdrm_pci_release(void *data)
348 {
349 	struct pci_dev *pcidev = data;
350 
351 	pci_disable_device(pcidev);
352 }
353 
354 static int ofdrm_device_init_pci(struct ofdrm_device *odev)
355 {
356 	struct drm_device *dev = &odev->sysfb.dev;
357 	struct platform_device *pdev = to_platform_device(dev->dev);
358 	struct device_node *of_node = pdev->dev.of_node;
359 	struct pci_dev *pcidev;
360 	int ret;
361 
362 	/*
363 	 * Never use pcim_ or other managed helpers on the returned PCI
364 	 * device. Otherwise, probing the native driver will fail for
365 	 * resource conflicts. PCI-device management has to be tied to
366 	 * the lifetime of the platform device until the native driver
367 	 * takes over.
368 	 */
369 	pcidev = display_get_pci_dev_of(dev, of_node);
370 	if (IS_ERR(pcidev))
371 		return 0; /* no PCI device found; ignore the error */
372 
373 	ret = pci_enable_device(pcidev);
374 	if (ret) {
375 		drm_err(dev, "pci_enable_device(%s) failed: %d\n",
376 			dev_name(&pcidev->dev), ret);
377 		return ret;
378 	}
379 	ret = devm_add_action_or_reset(&pdev->dev, ofdrm_pci_release, pcidev);
380 	if (ret)
381 		return ret;
382 
383 	return 0;
384 }
385 #else
386 static int ofdrm_device_init_pci(struct ofdrm_device *odev)
387 {
388 	return 0;
389 }
390 #endif
391 
392 /*
393  *  OF display settings
394  */
395 
396 static struct resource *ofdrm_find_fb_resource(struct ofdrm_device *odev,
397 					       struct resource *fb_res)
398 {
399 	struct platform_device *pdev = to_platform_device(odev->sysfb.dev.dev);
400 	struct resource *res, *max_res = NULL;
401 	u32 i;
402 
403 	for (i = 0; pdev->num_resources; ++i) {
404 		res = platform_get_resource(pdev, IORESOURCE_MEM, i);
405 		if (!res)
406 			break; /* all resources processed */
407 		if (resource_size(res) < resource_size(fb_res))
408 			continue; /* resource too small */
409 		if (fb_res->start && resource_contains(res, fb_res))
410 			return res; /* resource contains framebuffer */
411 		if (!max_res || resource_size(res) > resource_size(max_res))
412 			max_res = res; /* store largest resource as fallback */
413 	}
414 
415 	return max_res;
416 }
417 
418 /*
419  * Colormap / Palette
420  */
421 
422 static void __iomem *get_cmap_address_of(struct ofdrm_device *odev, struct device_node *of_node,
423 					 int bar_no, unsigned long offset, unsigned long size)
424 {
425 	struct drm_device *dev = &odev->sysfb.dev;
426 	const __be32 *addr_p;
427 	u64 max_size, address;
428 	unsigned int flags;
429 	void __iomem *mem;
430 
431 	addr_p = of_get_pci_address(of_node, bar_no, &max_size, &flags);
432 	if (!addr_p)
433 		addr_p = of_get_address(of_node, bar_no, &max_size, &flags);
434 	if (!addr_p)
435 		return IOMEM_ERR_PTR(-ENODEV);
436 
437 	if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
438 		return IOMEM_ERR_PTR(-ENODEV);
439 
440 	if ((offset + size) >= max_size)
441 		return IOMEM_ERR_PTR(-ENODEV);
442 
443 	address = of_translate_address(of_node, addr_p);
444 	if (address == OF_BAD_ADDR)
445 		return IOMEM_ERR_PTR(-ENODEV);
446 
447 	mem = devm_ioremap(dev->dev, address + offset, size);
448 	if (!mem)
449 		return IOMEM_ERR_PTR(-ENOMEM);
450 
451 	return mem;
452 }
453 
454 static void __iomem *ofdrm_mach64_cmap_ioremap(struct ofdrm_device *odev,
455 					       struct device_node *of_node,
456 					       u64 fb_base)
457 {
458 	struct drm_device *dev = &odev->sysfb.dev;
459 	u64 address;
460 	void __iomem *cmap_base;
461 
462 	address = fb_base & 0xff000000ul;
463 	address += 0x7ff000;
464 
465 	cmap_base = devm_ioremap(dev->dev, address, 0x1000);
466 	if (!cmap_base)
467 		return IOMEM_ERR_PTR(-ENOMEM);
468 
469 	return cmap_base;
470 }
471 
472 static void ofdrm_mach64_cmap_write(struct ofdrm_device *odev, unsigned char index,
473 				    unsigned char r, unsigned char g, unsigned char b)
474 {
475 	void __iomem *addr = odev->cmap_base + 0xcc0;
476 	void __iomem *data = odev->cmap_base + 0xcc0 + 1;
477 
478 	writeb(index, addr);
479 	writeb(r, data);
480 	writeb(g, data);
481 	writeb(b, data);
482 }
483 
484 static void __iomem *ofdrm_rage128_cmap_ioremap(struct ofdrm_device *odev,
485 						struct device_node *of_node,
486 						u64 fb_base)
487 {
488 	return get_cmap_address_of(odev, of_node, 2, 0, 0x1fff);
489 }
490 
491 static void ofdrm_rage128_cmap_write(struct ofdrm_device *odev, unsigned char index,
492 				     unsigned char r, unsigned char g, unsigned char b)
493 {
494 	void __iomem *addr = odev->cmap_base + 0xb0;
495 	void __iomem *data = odev->cmap_base + 0xb4;
496 	u32 color = (r << 16) | (g << 8) | b;
497 
498 	writeb(index, addr);
499 	writel(color, data);
500 }
501 
502 static void __iomem *ofdrm_rage_m3a_cmap_ioremap(struct ofdrm_device *odev,
503 						 struct device_node *of_node,
504 						 u64 fb_base)
505 {
506 	return get_cmap_address_of(odev, of_node, 2, 0, 0x1fff);
507 }
508 
509 static void ofdrm_rage_m3a_cmap_write(struct ofdrm_device *odev, unsigned char index,
510 				      unsigned char r, unsigned char g, unsigned char b)
511 {
512 	void __iomem *dac_ctl = odev->cmap_base + 0x58;
513 	void __iomem *addr = odev->cmap_base + 0xb0;
514 	void __iomem *data = odev->cmap_base + 0xb4;
515 	u32 color = (r << 16) | (g << 8) | b;
516 	u32 val;
517 
518 	/* Clear PALETTE_ACCESS_CNTL in DAC_CNTL */
519 	val = readl(dac_ctl);
520 	val &= ~0x20;
521 	writel(val, dac_ctl);
522 
523 	/* Set color at palette index */
524 	writeb(index, addr);
525 	writel(color, data);
526 }
527 
528 static void __iomem *ofdrm_rage_m3b_cmap_ioremap(struct ofdrm_device *odev,
529 						 struct device_node *of_node,
530 						 u64 fb_base)
531 {
532 	return get_cmap_address_of(odev, of_node, 2, 0, 0x1fff);
533 }
534 
535 static void ofdrm_rage_m3b_cmap_write(struct ofdrm_device *odev, unsigned char index,
536 				      unsigned char r, unsigned char g, unsigned char b)
537 {
538 	void __iomem *dac_ctl = odev->cmap_base + 0x58;
539 	void __iomem *addr = odev->cmap_base + 0xb0;
540 	void __iomem *data = odev->cmap_base + 0xb4;
541 	u32 color = (r << 16) | (g << 8) | b;
542 	u32 val;
543 
544 	/* Set PALETTE_ACCESS_CNTL in DAC_CNTL */
545 	val = readl(dac_ctl);
546 	val |= 0x20;
547 	writel(val, dac_ctl);
548 
549 	/* Set color at palette index */
550 	writeb(index, addr);
551 	writel(color, data);
552 }
553 
554 static void __iomem *ofdrm_radeon_cmap_ioremap(struct ofdrm_device *odev,
555 					       struct device_node *of_node,
556 					       u64 fb_base)
557 {
558 	return get_cmap_address_of(odev, of_node, 1, 0, 0x1fff);
559 }
560 
561 static void __iomem *ofdrm_gxt2000_cmap_ioremap(struct ofdrm_device *odev,
562 						struct device_node *of_node,
563 						u64 fb_base)
564 {
565 	return get_cmap_address_of(odev, of_node, 0, 0x6000, 0x1000);
566 }
567 
568 static void ofdrm_gxt2000_cmap_write(struct ofdrm_device *odev, unsigned char index,
569 				     unsigned char r, unsigned char g, unsigned char b)
570 {
571 	void __iomem *data = ((unsigned int __iomem *)odev->cmap_base) + index;
572 	u32 color = (r << 16) | (g << 8) | b;
573 
574 	writel(color, data);
575 }
576 
577 static void __iomem *ofdrm_avivo_cmap_ioremap(struct ofdrm_device *odev,
578 					      struct device_node *of_node,
579 					      u64 fb_base)
580 {
581 	struct device_node *of_parent;
582 	void __iomem *cmap_base;
583 
584 	of_parent = of_get_parent(of_node);
585 	cmap_base = get_cmap_address_of(odev, of_parent, 0, 0, 0x10000);
586 	of_node_put(of_parent);
587 
588 	return cmap_base;
589 }
590 
591 static void ofdrm_avivo_cmap_write(struct ofdrm_device *odev, unsigned char index,
592 				   unsigned char r, unsigned char g, unsigned char b)
593 {
594 	void __iomem *lutsel = odev->cmap_base + AVIVO_DC_LUT_RW_SELECT;
595 	void __iomem *addr = odev->cmap_base + AVIVO_DC_LUT_RW_INDEX;
596 	void __iomem *data = odev->cmap_base + AVIVO_DC_LUT_30_COLOR;
597 	u32 color = (r << 22) | (g << 12) | (b << 2);
598 
599 	/* Write to both LUTs for now */
600 
601 	writel(1, lutsel);
602 	writeb(index, addr);
603 	writel(color, data);
604 
605 	writel(0, lutsel);
606 	writeb(index, addr);
607 	writel(color, data);
608 }
609 
610 static void __iomem *ofdrm_qemu_cmap_ioremap(struct ofdrm_device *odev,
611 					     struct device_node *of_node,
612 					     u64 fb_base)
613 {
614 	static const __be32 io_of_addr[3] = {
615 		cpu_to_be32(0x01000000),
616 		cpu_to_be32(0x00),
617 		cpu_to_be32(0x00),
618 	};
619 
620 	struct drm_device *dev = &odev->sysfb.dev;
621 	u64 address;
622 	void __iomem *cmap_base;
623 
624 	address = of_translate_address(of_node, io_of_addr);
625 	if (address == OF_BAD_ADDR)
626 		return IOMEM_ERR_PTR(-ENODEV);
627 
628 	cmap_base = devm_ioremap(dev->dev, address + 0x3c8, 2);
629 	if (!cmap_base)
630 		return IOMEM_ERR_PTR(-ENOMEM);
631 
632 	return cmap_base;
633 }
634 
635 static void ofdrm_qemu_cmap_write(struct ofdrm_device *odev, unsigned char index,
636 				  unsigned char r, unsigned char g, unsigned char b)
637 {
638 	void __iomem *addr = odev->cmap_base;
639 	void __iomem *data = odev->cmap_base + 1;
640 
641 	writeb(index, addr);
642 	writeb(r, data);
643 	writeb(g, data);
644 	writeb(b, data);
645 }
646 
647 static void ofdrm_set_gamma_lut(struct drm_crtc *crtc, unsigned int index,
648 				u16 red, u16 green, u16 blue)
649 {
650 	struct drm_device *dev = crtc->dev;
651 	struct ofdrm_device *odev = ofdrm_device_of_dev(dev);
652 	u8 i8 = index & 0xff;
653 	u8 r8 = red >> 8;
654 	u8 g8 = green >> 8;
655 	u8 b8 = blue >> 8;
656 
657 	if (drm_WARN_ON_ONCE(dev, index != i8))
658 		return; /* driver bug */
659 
660 	odev->funcs->cmap_write(odev, i8, r8, g8, b8);
661 }
662 
663 static void ofdrm_device_fill_gamma(struct ofdrm_device *odev,
664 				    const struct drm_format_info *format)
665 {
666 	struct drm_device *dev = &odev->sysfb.dev;
667 	struct drm_crtc *crtc = &odev->crtc;
668 
669 	switch (format->format) {
670 	case DRM_FORMAT_RGB565:
671 	case DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN:
672 		drm_crtc_fill_gamma_565(crtc, ofdrm_set_gamma_lut);
673 		break;
674 	case DRM_FORMAT_XRGB8888:
675 	case DRM_FORMAT_BGRX8888:
676 		drm_crtc_fill_gamma_888(crtc, ofdrm_set_gamma_lut);
677 		break;
678 	default:
679 		drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n",
680 			      &format->format);
681 		break;
682 	}
683 }
684 
685 static void ofdrm_device_load_gamma(struct ofdrm_device *odev,
686 				    const struct drm_format_info *format,
687 				    struct drm_color_lut *lut)
688 {
689 	struct drm_device *dev = &odev->sysfb.dev;
690 	struct drm_crtc *crtc = &odev->crtc;
691 
692 	switch (format->format) {
693 	case DRM_FORMAT_RGB565:
694 	case DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN:
695 		drm_crtc_load_gamma_565_from_888(crtc, lut, ofdrm_set_gamma_lut);
696 		break;
697 	case DRM_FORMAT_XRGB8888:
698 	case DRM_FORMAT_BGRX8888:
699 		drm_crtc_load_gamma_888(crtc, lut, ofdrm_set_gamma_lut);
700 		break;
701 	default:
702 		drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n",
703 			      &format->format);
704 		break;
705 	}
706 }
707 
708 /*
709  * Modesetting
710  */
711 
712 static const u64 ofdrm_primary_plane_format_modifiers[] = {
713 	DRM_SYSFB_PLANE_FORMAT_MODIFIERS,
714 };
715 
716 static const struct drm_plane_helper_funcs ofdrm_primary_plane_helper_funcs = {
717 	DRM_SYSFB_PLANE_HELPER_FUNCS,
718 };
719 
720 static const struct drm_plane_funcs ofdrm_primary_plane_funcs = {
721 	DRM_SYSFB_PLANE_FUNCS,
722 	.destroy = drm_plane_cleanup,
723 };
724 
725 static void ofdrm_crtc_helper_atomic_flush(struct drm_crtc *crtc, struct drm_atomic_state *state)
726 {
727 	struct ofdrm_device *odev = ofdrm_device_of_dev(crtc->dev);
728 	struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
729 	struct drm_sysfb_crtc_state *sysfb_crtc_state = to_drm_sysfb_crtc_state(crtc_state);
730 
731 	if (crtc_state->enable && crtc_state->color_mgmt_changed) {
732 		const struct drm_format_info *format = sysfb_crtc_state->format;
733 
734 		if (crtc_state->gamma_lut)
735 			ofdrm_device_load_gamma(odev, format, crtc_state->gamma_lut->data);
736 		else
737 			ofdrm_device_fill_gamma(odev, format);
738 	}
739 }
740 
741 static const struct drm_crtc_helper_funcs ofdrm_crtc_helper_funcs = {
742 	DRM_SYSFB_CRTC_HELPER_FUNCS,
743 	.atomic_flush = ofdrm_crtc_helper_atomic_flush,
744 };
745 
746 static const struct drm_crtc_funcs ofdrm_crtc_funcs = {
747 	DRM_SYSFB_CRTC_FUNCS,
748 	.destroy = drm_crtc_cleanup,
749 };
750 
751 static const struct drm_encoder_funcs ofdrm_encoder_funcs = {
752 	.destroy = drm_encoder_cleanup,
753 };
754 
755 static const struct drm_connector_helper_funcs ofdrm_connector_helper_funcs = {
756 	DRM_SYSFB_CONNECTOR_HELPER_FUNCS,
757 };
758 
759 static const struct drm_connector_funcs ofdrm_connector_funcs = {
760 	DRM_SYSFB_CONNECTOR_FUNCS,
761 	.destroy = drm_connector_cleanup,
762 };
763 
764 static const struct drm_mode_config_funcs ofdrm_mode_config_funcs = {
765 	DRM_SYSFB_MODE_CONFIG_FUNCS,
766 };
767 
768 /*
769  * Init / Cleanup
770  */
771 
772 static const struct ofdrm_device_funcs ofdrm_unknown_device_funcs = {
773 };
774 
775 static const struct ofdrm_device_funcs ofdrm_mach64_device_funcs = {
776 	.cmap_ioremap = ofdrm_mach64_cmap_ioremap,
777 	.cmap_write = ofdrm_mach64_cmap_write,
778 };
779 
780 static const struct ofdrm_device_funcs ofdrm_rage128_device_funcs = {
781 	.cmap_ioremap = ofdrm_rage128_cmap_ioremap,
782 	.cmap_write = ofdrm_rage128_cmap_write,
783 };
784 
785 static const struct ofdrm_device_funcs ofdrm_rage_m3a_device_funcs = {
786 	.cmap_ioremap = ofdrm_rage_m3a_cmap_ioremap,
787 	.cmap_write = ofdrm_rage_m3a_cmap_write,
788 };
789 
790 static const struct ofdrm_device_funcs ofdrm_rage_m3b_device_funcs = {
791 	.cmap_ioremap = ofdrm_rage_m3b_cmap_ioremap,
792 	.cmap_write = ofdrm_rage_m3b_cmap_write,
793 };
794 
795 static const struct ofdrm_device_funcs ofdrm_radeon_device_funcs = {
796 	.cmap_ioremap = ofdrm_radeon_cmap_ioremap,
797 	.cmap_write = ofdrm_rage128_cmap_write, /* same as Rage128 */
798 };
799 
800 static const struct ofdrm_device_funcs ofdrm_gxt2000_device_funcs = {
801 	.cmap_ioremap = ofdrm_gxt2000_cmap_ioremap,
802 	.cmap_write = ofdrm_gxt2000_cmap_write,
803 };
804 
805 static const struct ofdrm_device_funcs ofdrm_avivo_device_funcs = {
806 	.cmap_ioremap = ofdrm_avivo_cmap_ioremap,
807 	.cmap_write = ofdrm_avivo_cmap_write,
808 };
809 
810 static const struct ofdrm_device_funcs ofdrm_qemu_device_funcs = {
811 	.cmap_ioremap = ofdrm_qemu_cmap_ioremap,
812 	.cmap_write = ofdrm_qemu_cmap_write,
813 };
814 
815 static struct ofdrm_device *ofdrm_device_create(struct drm_driver *drv,
816 						struct platform_device *pdev)
817 {
818 	struct device_node *of_node = pdev->dev.of_node;
819 	struct ofdrm_device *odev;
820 	struct drm_sysfb_device *sysfb;
821 	struct drm_device *dev;
822 	enum ofdrm_model model;
823 	bool big_endian;
824 	int width, height, depth, linebytes;
825 	const struct drm_format_info *format;
826 	u64 address;
827 	const u8 *edid;
828 	resource_size_t fb_size, fb_base, fb_pgbase, fb_pgsize;
829 	struct resource *res, *mem;
830 	void __iomem *screen_base;
831 	struct drm_plane *primary_plane;
832 	struct drm_crtc *crtc;
833 	struct drm_encoder *encoder;
834 	struct drm_connector *connector;
835 	unsigned long max_width, max_height;
836 	size_t nformats;
837 	int ret;
838 
839 	odev = devm_drm_dev_alloc(&pdev->dev, drv, struct ofdrm_device, sysfb.dev);
840 	if (IS_ERR(odev))
841 		return ERR_CAST(odev);
842 	sysfb = &odev->sysfb;
843 	dev = &sysfb->dev;
844 	platform_set_drvdata(pdev, dev);
845 
846 	ret = ofdrm_device_init_pci(odev);
847 	if (ret)
848 		return ERR_PTR(ret);
849 
850 	/*
851 	 * OF display-node settings
852 	 */
853 
854 	model = display_get_model_of(dev, of_node);
855 	drm_dbg(dev, "detected model %d\n", model);
856 
857 	switch (model) {
858 	case OFDRM_MODEL_UNKNOWN:
859 		odev->funcs = &ofdrm_unknown_device_funcs;
860 		break;
861 	case OFDRM_MODEL_MACH64:
862 		odev->funcs = &ofdrm_mach64_device_funcs;
863 		break;
864 	case OFDRM_MODEL_RAGE128:
865 		odev->funcs = &ofdrm_rage128_device_funcs;
866 		break;
867 	case OFDRM_MODEL_RAGE_M3A:
868 		odev->funcs = &ofdrm_rage_m3a_device_funcs;
869 		break;
870 	case OFDRM_MODEL_RAGE_M3B:
871 		odev->funcs = &ofdrm_rage_m3b_device_funcs;
872 		break;
873 	case OFDRM_MODEL_RADEON:
874 		odev->funcs = &ofdrm_radeon_device_funcs;
875 		break;
876 	case OFDRM_MODEL_GXT2000:
877 		odev->funcs = &ofdrm_gxt2000_device_funcs;
878 		break;
879 	case OFDRM_MODEL_AVIVO:
880 		odev->funcs = &ofdrm_avivo_device_funcs;
881 		break;
882 	case OFDRM_MODEL_QEMU:
883 		odev->funcs = &ofdrm_qemu_device_funcs;
884 		break;
885 	}
886 
887 	big_endian = display_get_big_endian_of(dev, of_node);
888 
889 	width = display_get_width_of(dev, of_node);
890 	if (width < 0)
891 		return ERR_PTR(width);
892 	height = display_get_height_of(dev, of_node);
893 	if (height < 0)
894 		return ERR_PTR(height);
895 	depth = display_get_depth_of(dev, of_node);
896 	if (depth < 0)
897 		return ERR_PTR(depth);
898 	linebytes = display_get_linebytes_of(dev, of_node);
899 	if (linebytes < 0)
900 		return ERR_PTR(linebytes);
901 
902 	format = display_get_validated_format(dev, depth, big_endian);
903 	if (IS_ERR(format))
904 		return ERR_CAST(format);
905 	if (!linebytes) {
906 		linebytes = drm_format_info_min_pitch(format, 0, width);
907 		if (drm_WARN_ON(dev, !linebytes))
908 			return ERR_PTR(-EINVAL);
909 	}
910 
911 	fb_size = linebytes * height;
912 
913 	/*
914 	 * Try to figure out the address of the framebuffer. Unfortunately, Open
915 	 * Firmware doesn't provide a standard way to do so. All we can do is a
916 	 * dodgy heuristic that happens to work in practice.
917 	 *
918 	 * On most machines, the "address" property contains what we need, though
919 	 * not on Matrox cards found in IBM machines. What appears to give good
920 	 * results is to go through the PCI ranges and pick one that encloses the
921 	 * "address" property. If none match, we pick the largest.
922 	 */
923 	address = display_get_address_of(dev, of_node);
924 	if (address != OF_BAD_ADDR) {
925 		struct resource fb_res = DEFINE_RES_MEM(address, fb_size);
926 
927 		res = ofdrm_find_fb_resource(odev, &fb_res);
928 		if (!res)
929 			return ERR_PTR(-EINVAL);
930 		if (resource_contains(res, &fb_res))
931 			fb_base = address;
932 		else
933 			fb_base = res->start;
934 	} else {
935 		struct resource fb_res = DEFINE_RES_MEM(0u, fb_size);
936 
937 		res = ofdrm_find_fb_resource(odev, &fb_res);
938 		if (!res)
939 			return ERR_PTR(-EINVAL);
940 		fb_base = res->start;
941 	}
942 
943 	/*
944 	 * I/O resources
945 	 */
946 
947 	fb_pgbase = round_down(fb_base, PAGE_SIZE);
948 	fb_pgsize = fb_base - fb_pgbase + round_up(fb_size, PAGE_SIZE);
949 
950 	ret = devm_aperture_acquire_for_platform_device(pdev, fb_pgbase, fb_pgsize);
951 	if (ret) {
952 		drm_err(dev, "could not acquire memory range %pr: error %d\n", &res, ret);
953 		return ERR_PTR(ret);
954 	}
955 
956 	mem = devm_request_mem_region(&pdev->dev, fb_pgbase, fb_pgsize, drv->name);
957 	if (!mem) {
958 		drm_warn(dev, "could not acquire memory region %pr\n", &res);
959 		return ERR_PTR(-ENOMEM);
960 	}
961 
962 	screen_base = devm_ioremap(&pdev->dev, mem->start, resource_size(mem));
963 	if (!screen_base)
964 		return ERR_PTR(-ENOMEM);
965 
966 	if (odev->funcs->cmap_ioremap) {
967 		void __iomem *cmap_base = odev->funcs->cmap_ioremap(odev, of_node, fb_base);
968 
969 		if (IS_ERR(cmap_base)) {
970 			/* Don't fail; continue without colormap */
971 			drm_warn(dev, "could not find colormap: error %ld\n", PTR_ERR(cmap_base));
972 		} else {
973 			odev->cmap_base = cmap_base;
974 		}
975 	}
976 
977 	/* EDID is optional */
978 	edid = display_get_edid_of(dev, of_node, odev->edid);
979 
980 	/*
981 	 * Firmware framebuffer
982 	 */
983 
984 	iosys_map_set_vaddr_iomem(&sysfb->fb_addr, screen_base);
985 	sysfb->fb_mode = drm_sysfb_mode(width, height, 0, 0);
986 	sysfb->fb_format = format;
987 	sysfb->fb_pitch = linebytes;
988 	if (odev->cmap_base)
989 		sysfb->fb_gamma_lut_size = OFDRM_GAMMA_LUT_SIZE;
990 	sysfb->edid = edid;
991 
992 	drm_dbg(dev, "display mode={" DRM_MODE_FMT "}\n", DRM_MODE_ARG(&sysfb->fb_mode));
993 	drm_dbg(dev, "framebuffer format=%p4cc, size=%dx%d, linebytes=%d byte\n",
994 		&format->format, width, height, linebytes);
995 
996 	/*
997 	 * Mode-setting pipeline
998 	 */
999 
1000 	ret = drmm_mode_config_init(dev);
1001 	if (ret)
1002 		return ERR_PTR(ret);
1003 
1004 	max_width = max_t(unsigned long, width, DRM_SHADOW_PLANE_MAX_WIDTH);
1005 	max_height = max_t(unsigned long, height, DRM_SHADOW_PLANE_MAX_HEIGHT);
1006 
1007 	dev->mode_config.min_width = width;
1008 	dev->mode_config.max_width = max_width;
1009 	dev->mode_config.min_height = height;
1010 	dev->mode_config.max_height = max_height;
1011 	dev->mode_config.funcs = &ofdrm_mode_config_funcs;
1012 	dev->mode_config.preferred_depth = format->depth;
1013 	dev->mode_config.quirk_addfb_prefer_host_byte_order = true;
1014 
1015 	/* Primary plane */
1016 
1017 	nformats = drm_sysfb_build_fourcc_list(dev, &format->format, 1,
1018 					       odev->formats, ARRAY_SIZE(odev->formats));
1019 
1020 	primary_plane = &odev->primary_plane;
1021 	ret = drm_universal_plane_init(dev, primary_plane, 0, &ofdrm_primary_plane_funcs,
1022 				       odev->formats, nformats,
1023 				       ofdrm_primary_plane_format_modifiers,
1024 				       DRM_PLANE_TYPE_PRIMARY, NULL);
1025 	if (ret)
1026 		return ERR_PTR(ret);
1027 	drm_plane_helper_add(primary_plane, &ofdrm_primary_plane_helper_funcs);
1028 	drm_plane_enable_fb_damage_clips(primary_plane);
1029 
1030 	/* CRTC */
1031 
1032 	crtc = &odev->crtc;
1033 	ret = drm_crtc_init_with_planes(dev, crtc, primary_plane, NULL,
1034 					&ofdrm_crtc_funcs, NULL);
1035 	if (ret)
1036 		return ERR_PTR(ret);
1037 	drm_crtc_helper_add(crtc, &ofdrm_crtc_helper_funcs);
1038 
1039 	if (sysfb->fb_gamma_lut_size) {
1040 		ret = drm_mode_crtc_set_gamma_size(crtc, sysfb->fb_gamma_lut_size);
1041 		if (!ret)
1042 			drm_crtc_enable_color_mgmt(crtc, 0, false, sysfb->fb_gamma_lut_size);
1043 	}
1044 
1045 	/* Encoder */
1046 
1047 	encoder = &odev->encoder;
1048 	ret = drm_encoder_init(dev, encoder, &ofdrm_encoder_funcs, DRM_MODE_ENCODER_NONE, NULL);
1049 	if (ret)
1050 		return ERR_PTR(ret);
1051 	encoder->possible_crtcs = drm_crtc_mask(crtc);
1052 
1053 	/* Connector */
1054 
1055 	connector = &odev->connector;
1056 	ret = drm_connector_init(dev, connector, &ofdrm_connector_funcs,
1057 				 DRM_MODE_CONNECTOR_Unknown);
1058 	if (ret)
1059 		return ERR_PTR(ret);
1060 	drm_connector_helper_add(connector, &ofdrm_connector_helper_funcs);
1061 	drm_connector_set_panel_orientation_with_quirk(connector,
1062 						       DRM_MODE_PANEL_ORIENTATION_UNKNOWN,
1063 						       width, height);
1064 	if (edid)
1065 		drm_connector_attach_edid_property(connector);
1066 
1067 	ret = drm_connector_attach_encoder(connector, encoder);
1068 	if (ret)
1069 		return ERR_PTR(ret);
1070 
1071 	drm_mode_config_reset(dev);
1072 
1073 	return odev;
1074 }
1075 
1076 /*
1077  * DRM driver
1078  */
1079 
1080 DEFINE_DRM_GEM_FOPS(ofdrm_fops);
1081 
1082 static struct drm_driver ofdrm_driver = {
1083 	DRM_GEM_SHMEM_DRIVER_OPS,
1084 	DRM_FBDEV_SHMEM_DRIVER_OPS,
1085 	.name			= DRIVER_NAME,
1086 	.desc			= DRIVER_DESC,
1087 	.major			= DRIVER_MAJOR,
1088 	.minor			= DRIVER_MINOR,
1089 	.driver_features	= DRIVER_ATOMIC | DRIVER_GEM | DRIVER_MODESET,
1090 	.fops			= &ofdrm_fops,
1091 };
1092 
1093 /*
1094  * Platform driver
1095  */
1096 
1097 static int ofdrm_probe(struct platform_device *pdev)
1098 {
1099 	struct ofdrm_device *odev;
1100 	struct drm_sysfb_device *sysfb;
1101 	struct drm_device *dev;
1102 	int ret;
1103 
1104 	odev = ofdrm_device_create(&ofdrm_driver, pdev);
1105 	if (IS_ERR(odev))
1106 		return PTR_ERR(odev);
1107 	sysfb = &odev->sysfb;
1108 	dev = &sysfb->dev;
1109 
1110 	ret = drm_dev_register(dev, 0);
1111 	if (ret)
1112 		return ret;
1113 
1114 	drm_client_setup(dev, sysfb->fb_format);
1115 
1116 	return 0;
1117 }
1118 
1119 static void ofdrm_remove(struct platform_device *pdev)
1120 {
1121 	struct drm_device *dev = platform_get_drvdata(pdev);
1122 
1123 	drm_dev_unplug(dev);
1124 }
1125 
1126 static const struct of_device_id ofdrm_of_match_display[] = {
1127 	{ .compatible = "display", },
1128 	{ },
1129 };
1130 MODULE_DEVICE_TABLE(of, ofdrm_of_match_display);
1131 
1132 static struct platform_driver ofdrm_platform_driver = {
1133 	.driver = {
1134 		.name = "of-display",
1135 		.of_match_table = ofdrm_of_match_display,
1136 	},
1137 	.probe = ofdrm_probe,
1138 	.remove = ofdrm_remove,
1139 };
1140 
1141 module_platform_driver(ofdrm_platform_driver);
1142 
1143 MODULE_DESCRIPTION(DRIVER_DESC);
1144 MODULE_LICENSE("GPL");
1145