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