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 }; 50 51 return drm_sysfb_get_format_si(dev, formats, ARRAY_SIZE(formats), si); 52 } 53 54 /* 55 * VESA device 56 */ 57 58 struct vesadrm_device { 59 struct drm_sysfb_device sysfb; 60 61 #if defined(CONFIG_X86_32) 62 /* VESA Protected Mode interface */ 63 struct { 64 const u8 *PrimaryPalette; 65 } pmi; 66 #endif 67 68 void (*cmap_write)(struct vesadrm_device *vesa, unsigned int index, 69 u16 red, u16 green, u16 blue); 70 71 /* modesetting */ 72 u32 formats[DRM_SYSFB_PLANE_NFORMATS(1)]; 73 struct drm_plane primary_plane; 74 struct drm_crtc crtc; 75 struct drm_encoder encoder; 76 struct drm_connector connector; 77 }; 78 79 static struct vesadrm_device *to_vesadrm_device(struct drm_device *dev) 80 { 81 return container_of(to_drm_sysfb_device(dev), struct vesadrm_device, sysfb); 82 } 83 84 /* 85 * Palette 86 */ 87 88 static void vesadrm_vga_cmap_write(struct vesadrm_device *vesa, unsigned int index, 89 u16 red, u16 green, u16 blue) 90 { 91 u8 i8 = index; 92 u8 r8 = red >> 8; 93 u8 g8 = green >> 8; 94 u8 b8 = blue >> 8; 95 96 outb_p(i8, VGA_PEL_IW); 97 outb_p(r8, VGA_PEL_D); 98 outb_p(g8, VGA_PEL_D); 99 outb_p(b8, VGA_PEL_D); 100 } 101 102 #if defined(CONFIG_X86_32) 103 static void vesadrm_pmi_cmap_write(struct vesadrm_device *vesa, unsigned int index, 104 u16 red, u16 green, u16 blue) 105 { 106 u32 i32 = index; 107 struct { 108 u8 b8; 109 u8 g8; 110 u8 r8; 111 u8 x8; 112 } PaletteEntry = { 113 blue >> 8, 114 green >> 8, 115 red >> 8, 116 0x00, 117 }; 118 119 __asm__ __volatile__ ( 120 "call *(%%esi)" 121 : /* no return value */ 122 : "a" (0x4f09), 123 "b" (0), 124 "c" (1), 125 "d" (i32), 126 "D" (&PaletteEntry), 127 "S" (&vesa->pmi.PrimaryPalette)); 128 } 129 #endif 130 131 static void vesadrm_set_gamma_lut(struct drm_crtc *crtc, unsigned int index, 132 u16 red, u16 green, u16 blue) 133 { 134 struct drm_device *dev = crtc->dev; 135 struct vesadrm_device *vesa = to_vesadrm_device(dev); 136 u8 i8 = index & 0xff; 137 138 if (drm_WARN_ON_ONCE(dev, index != i8)) 139 return; /* driver bug */ 140 141 vesa->cmap_write(vesa, i8, red, green, blue); 142 } 143 144 static void vesadrm_fill_gamma_lut(struct vesadrm_device *vesa, 145 const struct drm_format_info *format) 146 { 147 struct drm_device *dev = &vesa->sysfb.dev; 148 struct drm_crtc *crtc = &vesa->crtc; 149 150 switch (format->format) { 151 case DRM_FORMAT_XRGB1555: 152 drm_crtc_fill_gamma_555(crtc, vesadrm_set_gamma_lut); 153 break; 154 case DRM_FORMAT_RGB565: 155 drm_crtc_fill_gamma_565(crtc, vesadrm_set_gamma_lut); 156 break; 157 case DRM_FORMAT_RGB888: 158 case DRM_FORMAT_XRGB8888: 159 case DRM_FORMAT_BGRX8888: 160 drm_crtc_fill_gamma_888(crtc, vesadrm_set_gamma_lut); 161 break; 162 default: 163 drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n", 164 &format->format); 165 break; 166 } 167 } 168 169 static void vesadrm_load_gamma_lut(struct vesadrm_device *vesa, 170 const struct drm_format_info *format, 171 struct drm_color_lut *lut) 172 { 173 struct drm_device *dev = &vesa->sysfb.dev; 174 struct drm_crtc *crtc = &vesa->crtc; 175 176 switch (format->format) { 177 case DRM_FORMAT_XRGB1555: 178 drm_crtc_load_gamma_555_from_888(crtc, lut, vesadrm_set_gamma_lut); 179 break; 180 case DRM_FORMAT_RGB565: 181 drm_crtc_load_gamma_565_from_888(crtc, lut, vesadrm_set_gamma_lut); 182 break; 183 case DRM_FORMAT_RGB888: 184 case DRM_FORMAT_XRGB8888: 185 case DRM_FORMAT_BGRX8888: 186 drm_crtc_load_gamma_888(crtc, lut, vesadrm_set_gamma_lut); 187 break; 188 default: 189 drm_warn_once(dev, "Unsupported format %p4cc for gamma correction\n", 190 &format->format); 191 break; 192 } 193 } 194 195 /* 196 * Modesetting 197 */ 198 199 static const u64 vesadrm_primary_plane_format_modifiers[] = { 200 DRM_SYSFB_PLANE_FORMAT_MODIFIERS, 201 }; 202 203 static const struct drm_plane_helper_funcs vesadrm_primary_plane_helper_funcs = { 204 DRM_SYSFB_PLANE_HELPER_FUNCS, 205 }; 206 207 static const struct drm_plane_funcs vesadrm_primary_plane_funcs = { 208 DRM_SYSFB_PLANE_FUNCS, 209 .destroy = drm_plane_cleanup, 210 }; 211 212 static void vesadrm_crtc_helper_atomic_flush(struct drm_crtc *crtc, 213 struct drm_atomic_state *state) 214 { 215 struct drm_device *dev = crtc->dev; 216 struct drm_sysfb_device *sysfb = to_drm_sysfb_device(dev); 217 struct vesadrm_device *vesa = to_vesadrm_device(dev); 218 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc); 219 struct drm_sysfb_crtc_state *sysfb_crtc_state = to_drm_sysfb_crtc_state(crtc_state); 220 221 /* 222 * The gamma LUT has to be reloaded after changing the primary 223 * plane's color format. 224 */ 225 if (crtc_state->enable && crtc_state->color_mgmt_changed) { 226 if (sysfb_crtc_state->format == sysfb->fb_format) { 227 if (crtc_state->gamma_lut) 228 vesadrm_load_gamma_lut(vesa, 229 sysfb_crtc_state->format, 230 crtc_state->gamma_lut->data); 231 else 232 vesadrm_fill_gamma_lut(vesa, sysfb_crtc_state->format); 233 } else { 234 vesadrm_fill_gamma_lut(vesa, sysfb_crtc_state->format); 235 } 236 } 237 } 238 239 static const struct drm_crtc_helper_funcs vesadrm_crtc_helper_funcs = { 240 DRM_SYSFB_CRTC_HELPER_FUNCS, 241 .atomic_flush = vesadrm_crtc_helper_atomic_flush, 242 }; 243 244 static const struct drm_crtc_funcs vesadrm_crtc_funcs = { 245 DRM_SYSFB_CRTC_FUNCS, 246 .destroy = drm_crtc_cleanup, 247 }; 248 249 static const struct drm_encoder_funcs vesadrm_encoder_funcs = { 250 .destroy = drm_encoder_cleanup, 251 }; 252 253 static const struct drm_connector_helper_funcs vesadrm_connector_helper_funcs = { 254 DRM_SYSFB_CONNECTOR_HELPER_FUNCS, 255 }; 256 257 static const struct drm_connector_funcs vesadrm_connector_funcs = { 258 DRM_SYSFB_CONNECTOR_FUNCS, 259 .destroy = drm_connector_cleanup, 260 }; 261 262 static const struct drm_mode_config_funcs vesadrm_mode_config_funcs = { 263 DRM_SYSFB_MODE_CONFIG_FUNCS, 264 }; 265 266 /* 267 * Init / Cleanup 268 */ 269 270 static struct vesadrm_device *vesadrm_device_create(struct drm_driver *drv, 271 struct platform_device *pdev) 272 { 273 const struct screen_info *si; 274 const struct drm_format_info *format; 275 int width, height, stride; 276 u64 vsize; 277 struct resource resbuf; 278 struct resource *res; 279 struct vesadrm_device *vesa; 280 struct drm_sysfb_device *sysfb; 281 struct drm_device *dev; 282 struct resource *mem = NULL; 283 void __iomem *screen_base; 284 struct drm_plane *primary_plane; 285 struct drm_crtc *crtc; 286 struct drm_encoder *encoder; 287 struct drm_connector *connector; 288 unsigned long max_width, max_height; 289 size_t nformats; 290 int ret; 291 292 si = dev_get_platdata(&pdev->dev); 293 if (!si) 294 return ERR_PTR(-ENODEV); 295 if (screen_info_video_type(si) != VIDEO_TYPE_VLFB) 296 return ERR_PTR(-ENODEV); 297 298 /* 299 * VESA DRM driver 300 */ 301 302 vesa = devm_drm_dev_alloc(&pdev->dev, drv, struct vesadrm_device, sysfb.dev); 303 if (IS_ERR(vesa)) 304 return ERR_CAST(vesa); 305 sysfb = &vesa->sysfb; 306 dev = &sysfb->dev; 307 platform_set_drvdata(pdev, dev); 308 309 /* 310 * Hardware settings 311 */ 312 313 format = vesadrm_get_format_si(dev, si); 314 if (!format) 315 return ERR_PTR(-EINVAL); 316 width = drm_sysfb_get_width_si(dev, si); 317 if (width < 0) 318 return ERR_PTR(width); 319 height = drm_sysfb_get_height_si(dev, si); 320 if (height < 0) 321 return ERR_PTR(height); 322 res = drm_sysfb_get_memory_si(dev, si, &resbuf); 323 if (!res) 324 return ERR_PTR(-EINVAL); 325 stride = drm_sysfb_get_stride_si(dev, si, format, width, height, resource_size(res)); 326 if (stride < 0) 327 return ERR_PTR(stride); 328 vsize = drm_sysfb_get_visible_size_si(dev, si, height, stride, resource_size(res)); 329 if (!vsize) 330 return ERR_PTR(-EINVAL); 331 332 drm_dbg(dev, "framebuffer format=%p4cc, size=%dx%d, stride=%d bytes\n", 333 &format->format, width, height, stride); 334 335 if (!__screen_info_vbe_mode_nonvga(si)) { 336 vesa->cmap_write = vesadrm_vga_cmap_write; 337 #if defined(CONFIG_X86_32) 338 } else { 339 phys_addr_t pmi_base = __screen_info_vesapm_info_base(si); 340 const u16 *pmi_addr = phys_to_virt(pmi_base); 341 342 vesa->pmi.PrimaryPalette = (u8 *)pmi_addr + pmi_addr[2]; 343 vesa->cmap_write = vesadrm_pmi_cmap_write; 344 #endif 345 } 346 347 #if defined(CONFIG_FIRMWARE_EDID) 348 if (drm_edid_header_is_valid(edid_info.dummy) == 8) 349 sysfb->edid = edid_info.dummy; 350 #endif 351 sysfb->fb_mode = drm_sysfb_mode(width, height, 0, 0); 352 sysfb->fb_format = format; 353 sysfb->fb_pitch = stride; 354 if (vesa->cmap_write) 355 sysfb->fb_gamma_lut_size = VESADRM_GAMMA_LUT_SIZE; 356 357 /* 358 * Memory management 359 */ 360 361 ret = devm_aperture_acquire_for_platform_device(pdev, res->start, vsize); 362 if (ret) { 363 drm_err(dev, "could not acquire memory range %pr: %d\n", res, ret); 364 return ERR_PTR(ret); 365 } 366 367 drm_dbg(dev, "using I/O memory framebuffer at %pr\n", res); 368 369 mem = devm_request_mem_region(&pdev->dev, res->start, vsize, drv->name); 370 if (!mem) { 371 /* 372 * We cannot make this fatal. Sometimes this comes from magic 373 * spaces our resource handlers simply don't know about. Use 374 * the I/O-memory resource as-is and try to map that instead. 375 */ 376 drm_warn(dev, "could not acquire memory region %pr\n", res); 377 mem = res; 378 } 379 380 screen_base = devm_ioremap_wc(&pdev->dev, mem->start, resource_size(mem)); 381 if (!screen_base) 382 return ERR_PTR(-ENOMEM); 383 iosys_map_set_vaddr_iomem(&sysfb->fb_addr, screen_base); 384 385 /* 386 * Modesetting 387 */ 388 389 ret = drmm_mode_config_init(dev); 390 if (ret) 391 return ERR_PTR(ret); 392 393 max_width = max_t(unsigned long, width, DRM_SHADOW_PLANE_MAX_WIDTH); 394 max_height = max_t(unsigned long, height, DRM_SHADOW_PLANE_MAX_HEIGHT); 395 396 dev->mode_config.min_width = width; 397 dev->mode_config.max_width = max_width; 398 dev->mode_config.min_height = height; 399 dev->mode_config.max_height = max_height; 400 dev->mode_config.preferred_depth = format->depth; 401 dev->mode_config.funcs = &vesadrm_mode_config_funcs; 402 403 /* Primary plane */ 404 405 nformats = drm_sysfb_build_fourcc_list(dev, &format->format, 1, 406 vesa->formats, ARRAY_SIZE(vesa->formats)); 407 408 primary_plane = &vesa->primary_plane; 409 ret = drm_universal_plane_init(dev, primary_plane, 0, &vesadrm_primary_plane_funcs, 410 vesa->formats, nformats, 411 vesadrm_primary_plane_format_modifiers, 412 DRM_PLANE_TYPE_PRIMARY, NULL); 413 if (ret) 414 return ERR_PTR(ret); 415 drm_plane_helper_add(primary_plane, &vesadrm_primary_plane_helper_funcs); 416 drm_plane_enable_fb_damage_clips(primary_plane); 417 418 /* CRTC */ 419 420 crtc = &vesa->crtc; 421 ret = drm_crtc_init_with_planes(dev, crtc, primary_plane, NULL, 422 &vesadrm_crtc_funcs, NULL); 423 if (ret) 424 return ERR_PTR(ret); 425 drm_crtc_helper_add(crtc, &vesadrm_crtc_helper_funcs); 426 427 if (sysfb->fb_gamma_lut_size) { 428 ret = drm_mode_crtc_set_gamma_size(crtc, sysfb->fb_gamma_lut_size); 429 if (!ret) 430 drm_crtc_enable_color_mgmt(crtc, 0, false, sysfb->fb_gamma_lut_size); 431 } 432 433 /* Encoder */ 434 435 encoder = &vesa->encoder; 436 ret = drm_encoder_init(dev, encoder, &vesadrm_encoder_funcs, 437 DRM_MODE_ENCODER_NONE, NULL); 438 if (ret) 439 return ERR_PTR(ret); 440 encoder->possible_crtcs = drm_crtc_mask(crtc); 441 442 /* Connector */ 443 444 connector = &vesa->connector; 445 ret = drm_connector_init(dev, connector, &vesadrm_connector_funcs, 446 DRM_MODE_CONNECTOR_Unknown); 447 if (ret) 448 return ERR_PTR(ret); 449 drm_connector_helper_add(connector, &vesadrm_connector_helper_funcs); 450 drm_connector_set_panel_orientation_with_quirk(connector, 451 DRM_MODE_PANEL_ORIENTATION_UNKNOWN, 452 width, height); 453 if (sysfb->edid) 454 drm_connector_attach_edid_property(connector); 455 456 ret = drm_connector_attach_encoder(connector, encoder); 457 if (ret) 458 return ERR_PTR(ret); 459 460 drm_mode_config_reset(dev); 461 462 return vesa; 463 } 464 465 /* 466 * DRM driver 467 */ 468 469 DEFINE_DRM_GEM_FOPS(vesadrm_fops); 470 471 static struct drm_driver vesadrm_driver = { 472 DRM_GEM_SHMEM_DRIVER_OPS, 473 DRM_FBDEV_SHMEM_DRIVER_OPS, 474 .name = DRIVER_NAME, 475 .desc = DRIVER_DESC, 476 .major = DRIVER_MAJOR, 477 .minor = DRIVER_MINOR, 478 .driver_features = DRIVER_ATOMIC | DRIVER_GEM | DRIVER_MODESET, 479 .fops = &vesadrm_fops, 480 }; 481 482 /* 483 * Platform driver 484 */ 485 486 static int vesadrm_probe(struct platform_device *pdev) 487 { 488 struct vesadrm_device *vesa; 489 struct drm_sysfb_device *sysfb; 490 struct drm_device *dev; 491 int ret; 492 493 vesa = vesadrm_device_create(&vesadrm_driver, pdev); 494 if (IS_ERR(vesa)) 495 return PTR_ERR(vesa); 496 sysfb = &vesa->sysfb; 497 dev = &sysfb->dev; 498 499 ret = drm_dev_register(dev, 0); 500 if (ret) 501 return ret; 502 503 drm_client_setup(dev, sysfb->fb_format); 504 505 return 0; 506 } 507 508 static void vesadrm_remove(struct platform_device *pdev) 509 { 510 struct drm_device *dev = platform_get_drvdata(pdev); 511 512 drm_dev_unplug(dev); 513 } 514 515 static struct platform_driver vesadrm_platform_driver = { 516 .driver = { 517 .name = "vesa-framebuffer", 518 }, 519 .probe = vesadrm_probe, 520 .remove = vesadrm_remove, 521 }; 522 523 module_platform_driver(vesadrm_platform_driver); 524 525 MODULE_DESCRIPTION(DRIVER_DESC); 526 MODULE_LICENSE("GPL"); 527