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 void __iomem *screen_base = NULL; 155 struct drm_plane *primary_plane; 156 struct drm_crtc *crtc; 157 struct drm_encoder *encoder; 158 struct drm_connector *connector; 159 unsigned long max_width, max_height; 160 size_t nformats; 161 int ret; 162 163 dpy = dev_get_platdata(&pdev->dev); 164 if (!dpy) 165 return ERR_PTR(-ENODEV); 166 si = &dpy->screen; 167 168 if (screen_info_video_type(si) != VIDEO_TYPE_EFI) 169 return ERR_PTR(-ENODEV); 170 171 /* 172 * EFI DRM driver 173 */ 174 175 efi = devm_drm_dev_alloc(&pdev->dev, drv, struct efidrm_device, sysfb.dev); 176 if (IS_ERR(efi)) 177 return ERR_CAST(efi); 178 sysfb = &efi->sysfb; 179 dev = &sysfb->dev; 180 platform_set_drvdata(pdev, dev); 181 182 /* 183 * Hardware settings 184 */ 185 186 format = efidrm_get_format_si(dev, si); 187 if (!format) 188 return ERR_PTR(-EINVAL); 189 width = drm_sysfb_get_width_si(dev, si); 190 if (width < 0) 191 return ERR_PTR(width); 192 height = drm_sysfb_get_height_si(dev, si); 193 if (height < 0) 194 return ERR_PTR(height); 195 res = drm_sysfb_get_memory_si(dev, si, &resbuf); 196 if (!res) 197 return ERR_PTR(-EINVAL); 198 stride = drm_sysfb_get_stride_si(dev, si, format, width, height, resource_size(res)); 199 if (stride < 0) 200 return ERR_PTR(stride); 201 vsize = drm_sysfb_get_visible_size_si(dev, si, height, stride, resource_size(res)); 202 if (!vsize) 203 return ERR_PTR(-EINVAL); 204 205 drm_dbg(dev, "framebuffer format=%p4cc, size=%dx%d, stride=%d bytes\n", 206 &format->format, width, height, stride); 207 208 #if defined(CONFIG_FIRMWARE_EDID) 209 if (drm_edid_header_is_valid(dpy->edid.dummy) == 8) 210 sysfb->edid = dpy->edid.dummy; 211 #endif 212 sysfb->fb_mode = drm_sysfb_mode(width, height, 0, 0); 213 sysfb->fb_format = format; 214 sysfb->fb_pitch = stride; 215 216 /* 217 * Memory management 218 */ 219 220 ret = devm_aperture_acquire_for_platform_device(pdev, res->start, vsize); 221 if (ret) { 222 drm_err(dev, "could not acquire memory range %pr: %d\n", res, ret); 223 return ERR_PTR(ret); 224 } 225 226 drm_dbg(dev, "using I/O memory framebuffer at %pr\n", res); 227 228 mem = devm_request_mem_region(&pdev->dev, res->start, vsize, drv->name); 229 if (!mem) { 230 /* 231 * We cannot make this fatal. Sometimes this comes from magic 232 * spaces our resource handlers simply don't know about. Use 233 * the I/O-memory resource as-is and try to map that instead. 234 */ 235 drm_warn(dev, "could not acquire memory region %pr\n", res); 236 mem = res; 237 } 238 239 mem_flags = efidrm_get_mem_flags(dev, res->start, vsize); 240 241 if (mem_flags & EFI_MEMORY_WC) 242 screen_base = devm_ioremap_wc(&pdev->dev, mem->start, resource_size(mem)); 243 else if (mem_flags & EFI_MEMORY_UC) 244 screen_base = devm_ioremap(&pdev->dev, mem->start, resource_size(mem)); 245 else if (mem_flags & EFI_MEMORY_WT) 246 screen_base = devm_memremap(&pdev->dev, mem->start, resource_size(mem), 247 MEMREMAP_WT); 248 else if (mem_flags & EFI_MEMORY_WB) 249 screen_base = devm_memremap(&pdev->dev, mem->start, resource_size(mem), 250 MEMREMAP_WB); 251 else 252 drm_err(dev, "invalid mem_flags: 0x%llx\n", mem_flags); 253 if (!screen_base) 254 return ERR_PTR(-ENOMEM); 255 iosys_map_set_vaddr_iomem(&sysfb->fb_addr, screen_base); 256 257 /* 258 * Modesetting 259 */ 260 261 ret = drmm_mode_config_init(dev); 262 if (ret) 263 return ERR_PTR(ret); 264 265 max_width = max_t(unsigned long, width, DRM_SHADOW_PLANE_MAX_WIDTH); 266 max_height = max_t(unsigned long, height, DRM_SHADOW_PLANE_MAX_HEIGHT); 267 268 dev->mode_config.min_width = width; 269 dev->mode_config.max_width = max_width; 270 dev->mode_config.min_height = height; 271 dev->mode_config.max_height = max_height; 272 dev->mode_config.preferred_depth = format->depth; 273 dev->mode_config.funcs = &efidrm_mode_config_funcs; 274 275 /* Primary plane */ 276 277 nformats = drm_sysfb_build_fourcc_list(dev, &format->format, 1, 278 efi->formats, ARRAY_SIZE(efi->formats)); 279 280 primary_plane = &efi->primary_plane; 281 ret = drm_universal_plane_init(dev, primary_plane, 0, &efidrm_primary_plane_funcs, 282 efi->formats, nformats, 283 efidrm_primary_plane_format_modifiers, 284 DRM_PLANE_TYPE_PRIMARY, NULL); 285 if (ret) 286 return ERR_PTR(ret); 287 drm_plane_helper_add(primary_plane, &efidrm_primary_plane_helper_funcs); 288 drm_plane_enable_fb_damage_clips(primary_plane); 289 290 /* CRTC */ 291 292 crtc = &efi->crtc; 293 ret = drm_crtc_init_with_planes(dev, crtc, primary_plane, NULL, 294 &efidrm_crtc_funcs, NULL); 295 if (ret) 296 return ERR_PTR(ret); 297 drm_crtc_helper_add(crtc, &efidrm_crtc_helper_funcs); 298 299 /* Encoder */ 300 301 encoder = &efi->encoder; 302 ret = drm_encoder_init(dev, encoder, &efidrm_encoder_funcs, 303 DRM_MODE_ENCODER_NONE, NULL); 304 if (ret) 305 return ERR_PTR(ret); 306 encoder->possible_crtcs = drm_crtc_mask(crtc); 307 308 /* Connector */ 309 310 connector = &efi->connector; 311 ret = drm_connector_init(dev, connector, &efidrm_connector_funcs, 312 DRM_MODE_CONNECTOR_Unknown); 313 if (ret) 314 return ERR_PTR(ret); 315 drm_connector_helper_add(connector, &efidrm_connector_helper_funcs); 316 drm_connector_set_panel_orientation_with_quirk(connector, 317 DRM_MODE_PANEL_ORIENTATION_UNKNOWN, 318 width, height); 319 if (sysfb->edid) 320 drm_connector_attach_edid_property(connector); 321 322 ret = drm_connector_attach_encoder(connector, encoder); 323 if (ret) 324 return ERR_PTR(ret); 325 326 drm_mode_config_reset(dev); 327 328 return efi; 329 } 330 331 /* 332 * DRM driver 333 */ 334 335 DEFINE_DRM_GEM_FOPS(efidrm_fops); 336 337 static struct drm_driver efidrm_driver = { 338 DRM_GEM_SHMEM_DRIVER_OPS, 339 DRM_FBDEV_SHMEM_DRIVER_OPS, 340 .name = DRIVER_NAME, 341 .desc = DRIVER_DESC, 342 .major = DRIVER_MAJOR, 343 .minor = DRIVER_MINOR, 344 .driver_features = DRIVER_ATOMIC | DRIVER_GEM | DRIVER_MODESET, 345 .fops = &efidrm_fops, 346 }; 347 348 /* 349 * Platform driver 350 */ 351 352 static int efidrm_probe(struct platform_device *pdev) 353 { 354 struct efidrm_device *efi; 355 struct drm_sysfb_device *sysfb; 356 struct drm_device *dev; 357 int ret; 358 359 efi = efidrm_device_create(&efidrm_driver, pdev); 360 if (IS_ERR(efi)) 361 return PTR_ERR(efi); 362 sysfb = &efi->sysfb; 363 dev = &sysfb->dev; 364 365 ret = drm_dev_register(dev, 0); 366 if (ret) 367 return ret; 368 369 drm_client_setup(dev, sysfb->fb_format); 370 371 return 0; 372 } 373 374 static void efidrm_remove(struct platform_device *pdev) 375 { 376 struct drm_device *dev = platform_get_drvdata(pdev); 377 378 drm_dev_unplug(dev); 379 } 380 381 static struct platform_driver efidrm_platform_driver = { 382 .driver = { 383 .name = "efi-framebuffer", 384 }, 385 .probe = efidrm_probe, 386 .remove = efidrm_remove, 387 }; 388 389 module_platform_driver(efidrm_platform_driver); 390 391 MODULE_DESCRIPTION(DRIVER_DESC); 392 MODULE_LICENSE("GPL"); 393