1 // SPDX-License-Identifier: GPL-2.0-only 2 3 #include <linux/aperture.h> 4 #include <linux/ioport.h> 5 #include <linux/limits.h> 6 #include <linux/platform_device.h> 7 #include <linux/screen_info.h> 8 9 #include <drm/clients/drm_client_setup.h> 10 #include <drm/drm_atomic.h> 11 #include <drm/drm_atomic_state_helper.h> 12 #include <drm/drm_color_mgmt.h> 13 #include <drm/drm_connector.h> 14 #include <drm/drm_damage_helper.h> 15 #include <drm/drm_device.h> 16 #include <drm/drm_drv.h> 17 #include <drm/drm_edid.h> 18 #include <drm/drm_fbdev_shmem.h> 19 #include <drm/drm_framebuffer.h> 20 #include <drm/drm_gem_atomic_helper.h> 21 #include <drm/drm_gem_framebuffer_helper.h> 22 #include <drm/drm_gem_shmem_helper.h> 23 #include <drm/drm_managed.h> 24 #include <drm/drm_modeset_helper_vtables.h> 25 #include <drm/drm_probe_helper.h> 26 27 #include <video/edid.h> 28 #include <video/pixel_format.h> 29 #include <video/vga.h> 30 31 #include "drm_sysfb_helper.h" 32 33 #define DRIVER_NAME "vesadrm" 34 #define DRIVER_DESC "DRM driver for VESA platform devices" 35 #define DRIVER_MAJOR 1 36 #define DRIVER_MINOR 0 37 38 #define VESADRM_GAMMA_LUT_SIZE 256 39 40 static const struct drm_format_info *vesadrm_get_format_si(struct drm_device *dev, 41 const struct screen_info *si) 42 { 43 static const struct drm_sysfb_format formats[] = { 44 { PIXEL_FORMAT_XRGB1555, DRM_FORMAT_XRGB1555, }, 45 { PIXEL_FORMAT_RGB565, DRM_FORMAT_RGB565, }, 46 { PIXEL_FORMAT_RGB888, DRM_FORMAT_RGB888, }, 47 { PIXEL_FORMAT_XRGB8888, DRM_FORMAT_XRGB8888, }, 48 { PIXEL_FORMAT_XBGR8888, DRM_FORMAT_XBGR8888, }, 49 { PIXEL_FORMAT_C8, DRM_FORMAT_C8, }, 50 }; 51 52 return drm_sysfb_get_format_si(dev, formats, ARRAY_SIZE(formats), si); 53 } 54 55 /* 56 * VESA device 57 */ 58 59 struct vesadrm_device { 60 struct drm_sysfb_device sysfb; 61 62 #if defined(CONFIG_X86_32) 63 /* VESA Protected Mode interface */ 64 struct { 65 const u8 *PrimaryPalette; 66 } pmi; 67 #endif 68 69 void (*cmap_write)(struct vesadrm_device *vesa, unsigned int index, 70 u16 red, u16 green, u16 blue); 71 72 /* modesetting */ 73 u32 formats[DRM_SYSFB_PLANE_NFORMATS(1)]; 74 struct drm_plane primary_plane; 75 struct drm_crtc crtc; 76 struct drm_encoder encoder; 77 struct drm_connector connector; 78 }; 79 80 static struct vesadrm_device *to_vesadrm_device(struct drm_device *dev) 81 { 82 return container_of(to_drm_sysfb_device(dev), struct vesadrm_device, sysfb); 83 } 84 85 /* 86 * Color LUT 87 */ 88 89 static void vesadrm_vga_cmap_write(struct vesadrm_device *vesa, unsigned int index, 90 u16 red, u16 green, u16 blue) 91 { 92 u8 i8 = index; 93 u8 r8 = red >> 8; 94 u8 g8 = green >> 8; 95 u8 b8 = blue >> 8; 96 97 outb_p(i8, VGA_PEL_IW); 98 outb_p(r8, VGA_PEL_D); 99 outb_p(g8, VGA_PEL_D); 100 outb_p(b8, VGA_PEL_D); 101 } 102 103 #if defined(CONFIG_X86_32) 104 static void vesadrm_pmi_cmap_write(struct vesadrm_device *vesa, unsigned int index, 105 u16 red, u16 green, u16 blue) 106 { 107 u32 i32 = index; 108 struct { 109 u8 b8; 110 u8 g8; 111 u8 r8; 112 u8 x8; 113 } PaletteEntry = { 114 blue >> 8, 115 green >> 8, 116 red >> 8, 117 0x00, 118 }; 119 120 __asm__ __volatile__ ( 121 "call *(%%esi)" 122 : /* no return value */ 123 : "a" (0x4f09), 124 "b" (0), 125 "c" (1), 126 "d" (i32), 127 "D" (&PaletteEntry), 128 "S" (&vesa->pmi.PrimaryPalette)); 129 } 130 #endif 131 132 static void vesadrm_set_color_lut(struct drm_crtc *crtc, unsigned int index, 133 u16 red, u16 green, u16 blue) 134 { 135 struct drm_device *dev = crtc->dev; 136 struct vesadrm_device *vesa = to_vesadrm_device(dev); 137 u8 i8 = index & 0xff; 138 139 if (drm_WARN_ON_ONCE(dev, index != i8)) 140 return; /* driver bug */ 141 142 vesa->cmap_write(vesa, i8, red, green, blue); 143 } 144 145 static void vesadrm_fill_gamma_lut(struct vesadrm_device *vesa, 146 const struct drm_format_info *format) 147 { 148 struct drm_device *dev = &vesa->sysfb.dev; 149 struct drm_crtc *crtc = &vesa->crtc; 150 151 switch (format->format) { 152 case DRM_FORMAT_XRGB1555: 153 drm_crtc_fill_gamma_555(crtc, vesadrm_set_color_lut); 154 break; 155 case DRM_FORMAT_RGB565: 156 drm_crtc_fill_gamma_565(crtc, vesadrm_set_color_lut); 157 break; 158 case DRM_FORMAT_RGB888: 159 case DRM_FORMAT_XRGB8888: 160 case DRM_FORMAT_BGRX8888: 161 drm_crtc_fill_gamma_888(crtc, vesadrm_set_color_lut); 162 break; 163 default: 164 drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n", 165 &format->format); 166 break; 167 } 168 } 169 170 static void vesadrm_load_gamma_lut(struct vesadrm_device *vesa, 171 const struct drm_format_info *format, 172 struct drm_color_lut *lut) 173 { 174 struct drm_device *dev = &vesa->sysfb.dev; 175 struct drm_crtc *crtc = &vesa->crtc; 176 177 switch (format->format) { 178 case DRM_FORMAT_XRGB1555: 179 drm_crtc_load_gamma_555_from_888(crtc, lut, vesadrm_set_color_lut); 180 break; 181 case DRM_FORMAT_RGB565: 182 drm_crtc_load_gamma_565_from_888(crtc, lut, vesadrm_set_color_lut); 183 break; 184 case DRM_FORMAT_RGB888: 185 case DRM_FORMAT_XRGB8888: 186 case DRM_FORMAT_BGRX8888: 187 drm_crtc_load_gamma_888(crtc, lut, vesadrm_set_color_lut); 188 break; 189 default: 190 drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n", 191 &format->format); 192 break; 193 } 194 } 195 196 static void vesadrm_fill_palette_lut(struct vesadrm_device *vesa, 197 const struct drm_format_info *format) 198 { 199 struct drm_device *dev = &vesa->sysfb.dev; 200 struct drm_crtc *crtc = &vesa->crtc; 201 202 switch (format->format) { 203 case DRM_FORMAT_C8: 204 drm_crtc_fill_palette_8(crtc, vesadrm_set_color_lut); 205 break; 206 case DRM_FORMAT_RGB332: 207 drm_crtc_fill_palette_332(crtc, vesadrm_set_color_lut); 208 break; 209 default: 210 drm_warn_once(dev, "Unsupported format %p4cc for palette\n", 211 &format->format); 212 break; 213 } 214 } 215 216 static void vesadrm_load_palette_lut(struct vesadrm_device *vesa, 217 const struct drm_format_info *format, 218 struct drm_color_lut *lut) 219 { 220 struct drm_device *dev = &vesa->sysfb.dev; 221 struct drm_crtc *crtc = &vesa->crtc; 222 223 switch (format->format) { 224 case DRM_FORMAT_C8: 225 drm_crtc_load_palette_8(crtc, lut, vesadrm_set_color_lut); 226 break; 227 default: 228 drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n", 229 &format->format); 230 break; 231 } 232 } 233 234 /* 235 * Modesetting 236 */ 237 238 static const u64 vesadrm_primary_plane_format_modifiers[] = { 239 DRM_SYSFB_PLANE_FORMAT_MODIFIERS, 240 }; 241 242 static int vesadrm_primary_plane_helper_atomic_check(struct drm_plane *plane, 243 struct drm_atomic_state *new_state) 244 { 245 struct drm_sysfb_device *sysfb = to_drm_sysfb_device(plane->dev); 246 struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(new_state, plane); 247 struct drm_framebuffer *new_fb = new_plane_state->fb; 248 struct drm_crtc_state *new_crtc_state; 249 struct drm_sysfb_crtc_state *new_sysfb_crtc_state; 250 int ret; 251 252 ret = drm_sysfb_plane_helper_atomic_check(plane, new_state); 253 if (ret) 254 return ret; 255 else if (!new_plane_state->visible) 256 return 0; 257 258 /* 259 * Fix up format conversion for specific cases 260 */ 261 262 switch (sysfb->fb_format->format) { 263 case DRM_FORMAT_C8: 264 new_crtc_state = drm_atomic_get_new_crtc_state(new_state, new_plane_state->crtc); 265 new_sysfb_crtc_state = to_drm_sysfb_crtc_state(new_crtc_state); 266 267 switch (new_fb->format->format) { 268 case DRM_FORMAT_XRGB8888: 269 /* 270 * Reduce XRGB8888 to RGB332. Each resulting pixel is an index 271 * into the C8 hardware palette, which stores RGB332 colors. 272 */ 273 if (new_sysfb_crtc_state->format->format != DRM_FORMAT_RGB332) { 274 new_sysfb_crtc_state->format = 275 drm_format_info(DRM_FORMAT_RGB332); 276 new_crtc_state->color_mgmt_changed = true; 277 } 278 break; 279 case DRM_FORMAT_C8: 280 /* 281 * Restore original output. Emulation of XRGB8888 set RBG332 282 * output format and hardware palette. This needs to be undone 283 * when we switch back to DRM_FORMAT_C8. 284 */ 285 if (new_sysfb_crtc_state->format->format == DRM_FORMAT_RGB332) { 286 new_sysfb_crtc_state->format = sysfb->fb_format; 287 new_crtc_state->color_mgmt_changed = true; 288 } 289 break; 290 } 291 break; 292 }; 293 294 return 0; 295 } 296 297 static const struct drm_plane_helper_funcs vesadrm_primary_plane_helper_funcs = { 298 DRM_GEM_SHADOW_PLANE_HELPER_FUNCS, 299 .atomic_check = vesadrm_primary_plane_helper_atomic_check, 300 .atomic_update = drm_sysfb_plane_helper_atomic_update, 301 .atomic_disable = drm_sysfb_plane_helper_atomic_disable, 302 .get_scanout_buffer = drm_sysfb_plane_helper_get_scanout_buffer, 303 }; 304 305 static const struct drm_plane_funcs vesadrm_primary_plane_funcs = { 306 DRM_SYSFB_PLANE_FUNCS, 307 .destroy = drm_plane_cleanup, 308 }; 309 310 static void vesadrm_crtc_helper_atomic_flush(struct drm_crtc *crtc, 311 struct drm_atomic_state *state) 312 { 313 struct drm_device *dev = crtc->dev; 314 struct drm_sysfb_device *sysfb = to_drm_sysfb_device(dev); 315 struct vesadrm_device *vesa = to_vesadrm_device(dev); 316 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc); 317 struct drm_sysfb_crtc_state *sysfb_crtc_state = to_drm_sysfb_crtc_state(crtc_state); 318 319 /* 320 * The gamma LUT has to be reloaded after changing the primary 321 * plane's color format. 322 */ 323 if (crtc_state->enable && crtc_state->color_mgmt_changed) { 324 switch (sysfb->fb_format->format) { 325 /* 326 * Index formats 327 */ 328 case DRM_FORMAT_C8: 329 if (sysfb_crtc_state->format->format == DRM_FORMAT_RGB332) { 330 vesadrm_fill_palette_lut(vesa, sysfb_crtc_state->format); 331 } else if (crtc->state->gamma_lut) { 332 vesadrm_load_palette_lut(vesa, 333 sysfb_crtc_state->format, 334 crtc_state->gamma_lut->data); 335 } else { 336 vesadrm_fill_palette_lut(vesa, sysfb_crtc_state->format); 337 } 338 break; 339 /* 340 * Component formats 341 */ 342 default: 343 if (sysfb_crtc_state->format == sysfb->fb_format) { 344 if (crtc_state->gamma_lut) 345 vesadrm_load_gamma_lut(vesa, 346 sysfb_crtc_state->format, 347 crtc_state->gamma_lut->data); 348 else 349 vesadrm_fill_gamma_lut(vesa, sysfb_crtc_state->format); 350 } else { 351 vesadrm_fill_gamma_lut(vesa, sysfb_crtc_state->format); 352 } 353 break; 354 } 355 } 356 } 357 358 static const struct drm_crtc_helper_funcs vesadrm_crtc_helper_funcs = { 359 DRM_SYSFB_CRTC_HELPER_FUNCS, 360 .atomic_flush = vesadrm_crtc_helper_atomic_flush, 361 }; 362 363 static const struct drm_crtc_funcs vesadrm_crtc_funcs = { 364 DRM_SYSFB_CRTC_FUNCS, 365 .destroy = drm_crtc_cleanup, 366 }; 367 368 static const struct drm_encoder_funcs vesadrm_encoder_funcs = { 369 .destroy = drm_encoder_cleanup, 370 }; 371 372 static const struct drm_connector_helper_funcs vesadrm_connector_helper_funcs = { 373 DRM_SYSFB_CONNECTOR_HELPER_FUNCS, 374 }; 375 376 static const struct drm_connector_funcs vesadrm_connector_funcs = { 377 DRM_SYSFB_CONNECTOR_FUNCS, 378 .destroy = drm_connector_cleanup, 379 }; 380 381 static const struct drm_mode_config_funcs vesadrm_mode_config_funcs = { 382 DRM_SYSFB_MODE_CONFIG_FUNCS, 383 }; 384 385 /* 386 * Init / Cleanup 387 */ 388 389 static struct vesadrm_device *vesadrm_device_create(struct drm_driver *drv, 390 struct platform_device *pdev) 391 { 392 const struct screen_info *si; 393 const struct drm_format_info *format; 394 int width, height, stride; 395 u64 vsize; 396 struct resource resbuf; 397 struct resource *res; 398 struct vesadrm_device *vesa; 399 struct drm_sysfb_device *sysfb; 400 struct drm_device *dev; 401 struct resource *mem = NULL; 402 void __iomem *screen_base; 403 struct drm_plane *primary_plane; 404 struct drm_crtc *crtc; 405 struct drm_encoder *encoder; 406 struct drm_connector *connector; 407 unsigned long max_width, max_height; 408 size_t nformats; 409 int ret; 410 411 si = dev_get_platdata(&pdev->dev); 412 if (!si) 413 return ERR_PTR(-ENODEV); 414 if (screen_info_video_type(si) != VIDEO_TYPE_VLFB) 415 return ERR_PTR(-ENODEV); 416 417 /* 418 * VESA DRM driver 419 */ 420 421 vesa = devm_drm_dev_alloc(&pdev->dev, drv, struct vesadrm_device, sysfb.dev); 422 if (IS_ERR(vesa)) 423 return ERR_CAST(vesa); 424 sysfb = &vesa->sysfb; 425 dev = &sysfb->dev; 426 platform_set_drvdata(pdev, dev); 427 428 /* 429 * Hardware settings 430 */ 431 432 format = vesadrm_get_format_si(dev, si); 433 if (!format) 434 return ERR_PTR(-EINVAL); 435 width = drm_sysfb_get_width_si(dev, si); 436 if (width < 0) 437 return ERR_PTR(width); 438 height = drm_sysfb_get_height_si(dev, si); 439 if (height < 0) 440 return ERR_PTR(height); 441 res = drm_sysfb_get_memory_si(dev, si, &resbuf); 442 if (!res) 443 return ERR_PTR(-EINVAL); 444 stride = drm_sysfb_get_stride_si(dev, si, format, width, height, resource_size(res)); 445 if (stride < 0) 446 return ERR_PTR(stride); 447 vsize = drm_sysfb_get_visible_size_si(dev, si, height, stride, resource_size(res)); 448 if (!vsize) 449 return ERR_PTR(-EINVAL); 450 451 drm_dbg(dev, "framebuffer format=%p4cc, size=%dx%d, stride=%d bytes\n", 452 &format->format, width, height, stride); 453 454 if (!__screen_info_vbe_mode_nonvga(si)) { 455 vesa->cmap_write = vesadrm_vga_cmap_write; 456 } else { 457 #if defined(CONFIG_X86_32) 458 phys_addr_t pmi_base = __screen_info_vesapm_info_base(si); 459 460 if (pmi_base) { 461 const u16 *pmi_addr = phys_to_virt(pmi_base); 462 463 vesa->pmi.PrimaryPalette = (u8 *)pmi_addr + pmi_addr[2]; 464 vesa->cmap_write = vesadrm_pmi_cmap_write; 465 } else 466 #endif 467 if (format->is_color_indexed) 468 drm_warn(dev, "hardware palette is unchangeable, colors may be incorrect\n"); 469 } 470 471 #if defined(CONFIG_FIRMWARE_EDID) 472 if (drm_edid_header_is_valid(edid_info.dummy) == 8) 473 sysfb->edid = edid_info.dummy; 474 #endif 475 sysfb->fb_mode = drm_sysfb_mode(width, height, 0, 0); 476 sysfb->fb_format = format; 477 sysfb->fb_pitch = stride; 478 if (vesa->cmap_write) 479 sysfb->fb_gamma_lut_size = VESADRM_GAMMA_LUT_SIZE; 480 481 /* 482 * Memory management 483 */ 484 485 ret = devm_aperture_acquire_for_platform_device(pdev, res->start, vsize); 486 if (ret) { 487 drm_err(dev, "could not acquire memory range %pr: %d\n", res, ret); 488 return ERR_PTR(ret); 489 } 490 491 drm_dbg(dev, "using I/O memory framebuffer at %pr\n", res); 492 493 mem = devm_request_mem_region(&pdev->dev, res->start, vsize, drv->name); 494 if (!mem) { 495 /* 496 * We cannot make this fatal. Sometimes this comes from magic 497 * spaces our resource handlers simply don't know about. Use 498 * the I/O-memory resource as-is and try to map that instead. 499 */ 500 drm_warn(dev, "could not acquire memory region %pr\n", res); 501 mem = res; 502 } 503 504 screen_base = devm_ioremap_wc(&pdev->dev, mem->start, resource_size(mem)); 505 if (!screen_base) 506 return ERR_PTR(-ENOMEM); 507 iosys_map_set_vaddr_iomem(&sysfb->fb_addr, screen_base); 508 509 /* 510 * Modesetting 511 */ 512 513 ret = drmm_mode_config_init(dev); 514 if (ret) 515 return ERR_PTR(ret); 516 517 max_width = max_t(unsigned long, width, DRM_SHADOW_PLANE_MAX_WIDTH); 518 max_height = max_t(unsigned long, height, DRM_SHADOW_PLANE_MAX_HEIGHT); 519 520 dev->mode_config.min_width = width; 521 dev->mode_config.max_width = max_width; 522 dev->mode_config.min_height = height; 523 dev->mode_config.max_height = max_height; 524 dev->mode_config.preferred_depth = format->depth; 525 dev->mode_config.funcs = &vesadrm_mode_config_funcs; 526 527 /* Primary plane */ 528 529 nformats = drm_sysfb_build_fourcc_list(dev, &format->format, 1, 530 vesa->formats, ARRAY_SIZE(vesa->formats)); 531 532 primary_plane = &vesa->primary_plane; 533 ret = drm_universal_plane_init(dev, primary_plane, 0, &vesadrm_primary_plane_funcs, 534 vesa->formats, nformats, 535 vesadrm_primary_plane_format_modifiers, 536 DRM_PLANE_TYPE_PRIMARY, NULL); 537 if (ret) 538 return ERR_PTR(ret); 539 drm_plane_helper_add(primary_plane, &vesadrm_primary_plane_helper_funcs); 540 drm_plane_enable_fb_damage_clips(primary_plane); 541 542 /* CRTC */ 543 544 crtc = &vesa->crtc; 545 ret = drm_crtc_init_with_planes(dev, crtc, primary_plane, NULL, 546 &vesadrm_crtc_funcs, NULL); 547 if (ret) 548 return ERR_PTR(ret); 549 drm_crtc_helper_add(crtc, &vesadrm_crtc_helper_funcs); 550 551 if (sysfb->fb_gamma_lut_size) { 552 ret = drm_mode_crtc_set_gamma_size(crtc, sysfb->fb_gamma_lut_size); 553 if (!ret) 554 drm_crtc_enable_color_mgmt(crtc, 0, false, sysfb->fb_gamma_lut_size); 555 } 556 557 /* Encoder */ 558 559 encoder = &vesa->encoder; 560 ret = drm_encoder_init(dev, encoder, &vesadrm_encoder_funcs, 561 DRM_MODE_ENCODER_NONE, NULL); 562 if (ret) 563 return ERR_PTR(ret); 564 encoder->possible_crtcs = drm_crtc_mask(crtc); 565 566 /* Connector */ 567 568 connector = &vesa->connector; 569 ret = drm_connector_init(dev, connector, &vesadrm_connector_funcs, 570 DRM_MODE_CONNECTOR_Unknown); 571 if (ret) 572 return ERR_PTR(ret); 573 drm_connector_helper_add(connector, &vesadrm_connector_helper_funcs); 574 drm_connector_set_panel_orientation_with_quirk(connector, 575 DRM_MODE_PANEL_ORIENTATION_UNKNOWN, 576 width, height); 577 if (sysfb->edid) 578 drm_connector_attach_edid_property(connector); 579 580 ret = drm_connector_attach_encoder(connector, encoder); 581 if (ret) 582 return ERR_PTR(ret); 583 584 drm_mode_config_reset(dev); 585 586 return vesa; 587 } 588 589 /* 590 * DRM driver 591 */ 592 593 DEFINE_DRM_GEM_FOPS(vesadrm_fops); 594 595 static struct drm_driver vesadrm_driver = { 596 DRM_GEM_SHMEM_DRIVER_OPS, 597 DRM_FBDEV_SHMEM_DRIVER_OPS, 598 .name = DRIVER_NAME, 599 .desc = DRIVER_DESC, 600 .major = DRIVER_MAJOR, 601 .minor = DRIVER_MINOR, 602 .driver_features = DRIVER_ATOMIC | DRIVER_GEM | DRIVER_MODESET, 603 .fops = &vesadrm_fops, 604 }; 605 606 /* 607 * Platform driver 608 */ 609 610 static int vesadrm_probe(struct platform_device *pdev) 611 { 612 struct vesadrm_device *vesa; 613 struct drm_sysfb_device *sysfb; 614 struct drm_device *dev; 615 int ret; 616 617 vesa = vesadrm_device_create(&vesadrm_driver, pdev); 618 if (IS_ERR(vesa)) 619 return PTR_ERR(vesa); 620 sysfb = &vesa->sysfb; 621 dev = &sysfb->dev; 622 623 ret = drm_dev_register(dev, 0); 624 if (ret) 625 return ret; 626 627 drm_client_setup(dev, sysfb->fb_format); 628 629 return 0; 630 } 631 632 static void vesadrm_remove(struct platform_device *pdev) 633 { 634 struct drm_device *dev = platform_get_drvdata(pdev); 635 636 drm_dev_unplug(dev); 637 } 638 639 static struct platform_driver vesadrm_platform_driver = { 640 .driver = { 641 .name = "vesa-framebuffer", 642 }, 643 .probe = vesadrm_probe, 644 .remove = vesadrm_remove, 645 }; 646 647 module_platform_driver(vesadrm_platform_driver); 648 649 MODULE_DESCRIPTION(DRIVER_DESC); 650 MODULE_LICENSE("GPL"); 651