1 // SPDX-License-Identifier: GPL-2.0-only 2 3 #include <linux/aperture.h> 4 #include <linux/efi.h> 5 #include <linux/limits.h> 6 #include <linux/platform_device.h> 7 #include <linux/sysfb.h> 8 #include <linux/pm.h> 9 10 #include <drm/clients/drm_client_setup.h> 11 #include <drm/drm_atomic.h> 12 #include <drm/drm_atomic_state_helper.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.h> 25 #include <drm/drm_modeset_helper_vtables.h> 26 #include <drm/drm_print.h> 27 #include <drm/drm_probe_helper.h> 28 29 #include <video/pixel_format.h> 30 31 #include "drm_sysfb_helper.h" 32 33 #define DRIVER_NAME "efidrm" 34 #define DRIVER_DESC "DRM driver for EFI platform devices" 35 #define DRIVER_MAJOR 1 36 #define DRIVER_MINOR 0 37 38 static const struct drm_format_info *efidrm_get_format_si(struct drm_device *dev, 39 const struct screen_info *si) 40 { 41 static const struct drm_sysfb_format formats[] = { 42 { PIXEL_FORMAT_XRGB1555, DRM_FORMAT_XRGB1555, }, 43 { PIXEL_FORMAT_RGB565, DRM_FORMAT_RGB565, }, 44 { PIXEL_FORMAT_RGB888, DRM_FORMAT_RGB888, }, 45 { PIXEL_FORMAT_XRGB8888, DRM_FORMAT_XRGB8888, }, 46 { PIXEL_FORMAT_XBGR8888, DRM_FORMAT_XBGR8888, }, 47 { PIXEL_FORMAT_XRGB2101010, DRM_FORMAT_XRGB2101010, }, 48 }; 49 struct pixel_format pixel; 50 int ret; 51 52 ret = screen_info_pixel_format(si, &pixel); 53 if (ret) 54 return NULL; 55 56 return drm_sysfb_get_format(dev, formats, ARRAY_SIZE(formats), &pixel); 57 } 58 59 static u64 efidrm_get_mem_flags(struct drm_device *dev, resource_size_t start, 60 resource_size_t len) 61 { 62 u64 attribute = EFI_MEMORY_UC | EFI_MEMORY_WC | 63 EFI_MEMORY_WT | EFI_MEMORY_WB; 64 u64 mem_flags = EFI_MEMORY_WC | EFI_MEMORY_UC; 65 resource_size_t end = start + len; 66 efi_memory_desc_t md; 67 u64 md_end; 68 69 if (!efi_enabled(EFI_MEMMAP) || efi_mem_desc_lookup(start, &md)) 70 goto out; 71 72 md_end = md.phys_addr + (md.num_pages << EFI_PAGE_SHIFT); 73 if (end > md_end) 74 goto out; 75 76 attribute &= md.attribute; 77 if (attribute) { 78 mem_flags |= EFI_MEMORY_WT | EFI_MEMORY_WB; 79 mem_flags &= attribute; 80 } 81 82 out: 83 return mem_flags; 84 } 85 86 /* 87 * EFI device 88 */ 89 90 struct efidrm_device { 91 struct drm_sysfb_device sysfb; 92 93 /* modesetting */ 94 u32 formats[DRM_SYSFB_PLANE_NFORMATS(1)]; 95 struct drm_plane primary_plane; 96 struct drm_crtc crtc; 97 struct drm_encoder encoder; 98 struct drm_connector connector; 99 }; 100 101 /* 102 * Modesetting 103 */ 104 105 static const u64 efidrm_primary_plane_format_modifiers[] = { 106 DRM_SYSFB_PLANE_FORMAT_MODIFIERS, 107 }; 108 109 static const struct drm_plane_helper_funcs efidrm_primary_plane_helper_funcs = { 110 DRM_SYSFB_PLANE_HELPER_FUNCS, 111 }; 112 113 static const struct drm_plane_funcs efidrm_primary_plane_funcs = { 114 DRM_SYSFB_PLANE_FUNCS, 115 .destroy = drm_plane_cleanup, 116 }; 117 118 static const struct drm_crtc_helper_funcs efidrm_crtc_helper_funcs = { 119 DRM_SYSFB_CRTC_HELPER_FUNCS, 120 }; 121 122 static const struct drm_crtc_funcs efidrm_crtc_funcs = { 123 DRM_SYSFB_CRTC_FUNCS, 124 .destroy = drm_crtc_cleanup, 125 }; 126 127 static const struct drm_encoder_funcs efidrm_encoder_funcs = { 128 .destroy = drm_encoder_cleanup, 129 }; 130 131 static const struct drm_connector_helper_funcs efidrm_connector_helper_funcs = { 132 DRM_SYSFB_CONNECTOR_HELPER_FUNCS, 133 }; 134 135 static const struct drm_connector_funcs efidrm_connector_funcs = { 136 DRM_SYSFB_CONNECTOR_FUNCS, 137 .destroy = drm_connector_cleanup, 138 }; 139 140 static const struct drm_mode_config_funcs efidrm_mode_config_funcs = { 141 DRM_SYSFB_MODE_CONFIG_FUNCS, 142 }; 143 144 /* 145 * Init / Cleanup 146 */ 147 148 static struct efidrm_device *efidrm_device_create(struct drm_driver *drv, 149 struct platform_device *pdev) 150 { 151 const struct sysfb_display_info *dpy; 152 const struct screen_info *si; 153 const struct drm_format_info *format; 154 int width, height, stride; 155 u64 vsize, mem_flags; 156 struct resource resbuf; 157 struct resource *res; 158 struct efidrm_device *efi; 159 struct drm_sysfb_device *sysfb; 160 struct drm_device *dev; 161 struct resource *mem = NULL; 162 struct drm_plane *primary_plane; 163 struct drm_crtc *crtc; 164 struct drm_encoder *encoder; 165 struct drm_connector *connector; 166 unsigned long max_width, max_height; 167 size_t nformats; 168 int ret; 169 170 dpy = dev_get_platdata(&pdev->dev); 171 if (!dpy) 172 return ERR_PTR(-ENODEV); 173 si = &dpy->screen; 174 175 if (screen_info_video_type(si) != VIDEO_TYPE_EFI) 176 return ERR_PTR(-ENODEV); 177 178 /* 179 * EFI DRM driver 180 */ 181 182 efi = devm_drm_dev_alloc(&pdev->dev, drv, struct efidrm_device, sysfb.dev); 183 if (IS_ERR(efi)) 184 return ERR_CAST(efi); 185 sysfb = &efi->sysfb; 186 dev = &sysfb->dev; 187 platform_set_drvdata(pdev, dev); 188 189 /* 190 * Hardware settings 191 */ 192 193 format = efidrm_get_format_si(dev, si); 194 if (!format) 195 return ERR_PTR(-EINVAL); 196 width = drm_sysfb_get_width_si(dev, si); 197 if (width < 0) 198 return ERR_PTR(width); 199 height = drm_sysfb_get_height_si(dev, si); 200 if (height < 0) 201 return ERR_PTR(height); 202 res = drm_sysfb_get_memory_si(dev, si, &resbuf); 203 if (!res) 204 return ERR_PTR(-EINVAL); 205 stride = drm_sysfb_get_stride_si(dev, si, format, width, height, resource_size(res)); 206 if (stride < 0) 207 return ERR_PTR(stride); 208 vsize = drm_sysfb_get_visible_size_si(dev, si, height, stride, resource_size(res)); 209 if (!vsize) 210 return ERR_PTR(-EINVAL); 211 212 drm_dbg(dev, "framebuffer format=%p4cc, size=%dx%d, stride=%d bytes\n", 213 &format->format, width, height, stride); 214 215 #if defined(CONFIG_FIRMWARE_EDID) 216 if (drm_edid_header_is_valid(dpy->edid.dummy) == 8) 217 sysfb->edid = dpy->edid.dummy; 218 #endif 219 sysfb->fb_mode = drm_sysfb_mode(width, height, 0, 0); 220 sysfb->fb_format = format; 221 sysfb->fb_pitch = stride; 222 223 /* 224 * Memory management 225 */ 226 227 ret = devm_aperture_acquire_for_platform_device(pdev, res->start, vsize); 228 if (ret) { 229 drm_err(dev, "could not acquire memory range %pr: %d\n", res, ret); 230 return ERR_PTR(ret); 231 } 232 233 drm_dbg(dev, "using I/O memory framebuffer at %pr\n", res); 234 235 mem = devm_request_mem_region(&pdev->dev, res->start, vsize, drv->name); 236 if (!mem) { 237 /* 238 * We cannot make this fatal. Sometimes this comes from magic 239 * spaces our resource handlers simply don't know about. Use 240 * the I/O-memory resource as-is and try to map that instead. 241 */ 242 drm_warn(dev, "could not acquire memory region %pr\n", res); 243 mem = res; 244 } 245 246 mem_flags = efidrm_get_mem_flags(dev, res->start, vsize); 247 248 if (mem_flags & EFI_MEMORY_WC) { 249 void __iomem *screen_base = devm_ioremap_wc(&pdev->dev, mem->start, 250 resource_size(mem)); 251 252 if (!screen_base) 253 return ERR_PTR(-ENXIO); 254 iosys_map_set_vaddr_iomem(&sysfb->fb_addr, screen_base); 255 } else if (mem_flags & EFI_MEMORY_UC) { 256 void __iomem *screen_base = devm_ioremap(&pdev->dev, mem->start, 257 resource_size(mem)); 258 259 if (!screen_base) 260 return ERR_PTR(-ENXIO); 261 iosys_map_set_vaddr_iomem(&sysfb->fb_addr, screen_base); 262 } else if (mem_flags & EFI_MEMORY_WT) { 263 void *screen_base = devm_memremap(&pdev->dev, mem->start, 264 resource_size(mem), MEMREMAP_WT); 265 266 if (IS_ERR(screen_base)) 267 return ERR_CAST(screen_base); 268 iosys_map_set_vaddr(&sysfb->fb_addr, screen_base); 269 } else if (mem_flags & EFI_MEMORY_WB) { 270 void *screen_base = devm_memremap(&pdev->dev, mem->start, 271 resource_size(mem), MEMREMAP_WB); 272 273 if (IS_ERR(screen_base)) 274 return ERR_CAST(screen_base); 275 iosys_map_set_vaddr(&sysfb->fb_addr, screen_base); 276 } else { 277 drm_err(dev, "invalid mem_flags: 0x%llx\n", mem_flags); 278 return ERR_PTR(-EINVAL); 279 } 280 281 /* 282 * Modesetting 283 */ 284 285 ret = drmm_mode_config_init(dev); 286 if (ret) 287 return ERR_PTR(ret); 288 289 max_width = max_t(unsigned long, width, DRM_SHADOW_PLANE_MAX_WIDTH); 290 max_height = max_t(unsigned long, height, DRM_SHADOW_PLANE_MAX_HEIGHT); 291 292 dev->mode_config.min_width = width; 293 dev->mode_config.max_width = max_width; 294 dev->mode_config.min_height = height; 295 dev->mode_config.max_height = max_height; 296 dev->mode_config.preferred_depth = format->depth; 297 dev->mode_config.funcs = &efidrm_mode_config_funcs; 298 299 /* Primary plane */ 300 301 nformats = drm_sysfb_build_fourcc_list(dev, &format->format, 1, 302 efi->formats, ARRAY_SIZE(efi->formats)); 303 304 primary_plane = &efi->primary_plane; 305 ret = drm_universal_plane_init(dev, primary_plane, 0, &efidrm_primary_plane_funcs, 306 efi->formats, nformats, 307 efidrm_primary_plane_format_modifiers, 308 DRM_PLANE_TYPE_PRIMARY, NULL); 309 if (ret) 310 return ERR_PTR(ret); 311 drm_plane_helper_add(primary_plane, &efidrm_primary_plane_helper_funcs); 312 drm_plane_enable_fb_damage_clips(primary_plane); 313 314 /* CRTC */ 315 316 crtc = &efi->crtc; 317 ret = drm_crtc_init_with_planes(dev, crtc, primary_plane, NULL, 318 &efidrm_crtc_funcs, NULL); 319 if (ret) 320 return ERR_PTR(ret); 321 drm_crtc_helper_add(crtc, &efidrm_crtc_helper_funcs); 322 323 /* Encoder */ 324 325 encoder = &efi->encoder; 326 ret = drm_encoder_init(dev, encoder, &efidrm_encoder_funcs, 327 DRM_MODE_ENCODER_NONE, NULL); 328 if (ret) 329 return ERR_PTR(ret); 330 encoder->possible_crtcs = drm_crtc_mask(crtc); 331 332 /* Connector */ 333 334 connector = &efi->connector; 335 ret = drm_connector_init(dev, connector, &efidrm_connector_funcs, 336 DRM_MODE_CONNECTOR_Unknown); 337 if (ret) 338 return ERR_PTR(ret); 339 drm_connector_helper_add(connector, &efidrm_connector_helper_funcs); 340 drm_connector_set_panel_orientation_with_quirk(connector, 341 DRM_MODE_PANEL_ORIENTATION_UNKNOWN, 342 width, height); 343 if (sysfb->edid) 344 drm_connector_attach_edid_property(connector); 345 346 ret = drm_connector_attach_encoder(connector, encoder); 347 if (ret) 348 return ERR_PTR(ret); 349 350 drm_mode_config_reset(dev); 351 352 return efi; 353 } 354 355 /* 356 * DRM driver 357 */ 358 359 DEFINE_DRM_GEM_FOPS(efidrm_fops); 360 361 static struct drm_driver efidrm_driver = { 362 DRM_GEM_SHMEM_DRIVER_OPS, 363 DRM_FBDEV_SHMEM_DRIVER_OPS, 364 .name = DRIVER_NAME, 365 .desc = DRIVER_DESC, 366 .major = DRIVER_MAJOR, 367 .minor = DRIVER_MINOR, 368 .driver_features = DRIVER_ATOMIC | DRIVER_GEM | DRIVER_MODESET, 369 .fops = &efidrm_fops, 370 }; 371 372 /* 373 * Platform driver 374 */ 375 376 static int efidrm_pm_suspend(struct device *dev) 377 { 378 struct drm_device *drm = dev_get_drvdata(dev); 379 380 return drm_mode_config_helper_suspend(drm); 381 } 382 383 static int efidrm_pm_resume(struct device *dev) 384 { 385 struct drm_device *drm = dev_get_drvdata(dev); 386 387 return drm_mode_config_helper_resume(drm); 388 } 389 390 static DEFINE_SIMPLE_DEV_PM_OPS(efidrm_pm_ops, efidrm_pm_suspend, efidrm_pm_resume); 391 392 static int efidrm_probe(struct platform_device *pdev) 393 { 394 struct efidrm_device *efi; 395 struct drm_sysfb_device *sysfb; 396 struct drm_device *dev; 397 int ret; 398 399 efi = efidrm_device_create(&efidrm_driver, pdev); 400 if (IS_ERR(efi)) 401 return PTR_ERR(efi); 402 sysfb = &efi->sysfb; 403 dev = &sysfb->dev; 404 405 ret = drm_dev_register(dev, 0); 406 if (ret) 407 return ret; 408 409 drm_client_setup(dev, sysfb->fb_format); 410 411 return 0; 412 } 413 414 static void efidrm_remove(struct platform_device *pdev) 415 { 416 struct drm_device *dev = platform_get_drvdata(pdev); 417 418 drm_dev_unplug(dev); 419 } 420 421 static struct platform_driver efidrm_platform_driver = { 422 .driver = { 423 .name = "efi-framebuffer", 424 .pm = pm_sleep_ptr(&efidrm_pm_ops), 425 }, 426 .probe = efidrm_probe, 427 .remove = efidrm_remove, 428 }; 429 430 module_platform_driver(efidrm_platform_driver); 431 432 MODULE_DESCRIPTION(DRIVER_DESC); 433 MODULE_LICENSE("GPL"); 434