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