1 // SPDX-License-Identifier: MIT 2 3 #include <linux/fb.h> 4 5 #include <drm/drm_crtc_helper.h> 6 #include <drm/drm_drv.h> 7 #include <drm/drm_fb_helper.h> 8 #include <drm/drm_framebuffer.h> 9 #include <drm/drm_gem_dma_helper.h> 10 11 #include <drm/drm_fbdev_dma.h> 12 13 /* 14 * struct fb_ops 15 */ 16 17 static int drm_fbdev_dma_fb_open(struct fb_info *info, int user) 18 { 19 struct drm_fb_helper *fb_helper = info->par; 20 21 /* No need to take a ref for fbcon because it unbinds on unregister */ 22 if (user && !try_module_get(fb_helper->dev->driver->fops->owner)) 23 return -ENODEV; 24 25 return 0; 26 } 27 28 static int drm_fbdev_dma_fb_release(struct fb_info *info, int user) 29 { 30 struct drm_fb_helper *fb_helper = info->par; 31 32 if (user) 33 module_put(fb_helper->dev->driver->fops->owner); 34 35 return 0; 36 } 37 38 static void drm_fbdev_dma_fb_destroy(struct fb_info *info) 39 { 40 struct drm_fb_helper *fb_helper = info->par; 41 42 if (!fb_helper->dev) 43 return; 44 45 drm_fb_helper_fini(fb_helper); 46 47 drm_client_buffer_vunmap(fb_helper->buffer); 48 drm_client_framebuffer_delete(fb_helper->buffer); 49 drm_client_release(&fb_helper->client); 50 drm_fb_helper_unprepare(fb_helper); 51 kfree(fb_helper); 52 } 53 54 static int drm_fbdev_dma_fb_mmap(struct fb_info *info, struct vm_area_struct *vma) 55 { 56 struct drm_fb_helper *fb_helper = info->par; 57 58 return drm_gem_prime_mmap(fb_helper->buffer->gem, vma); 59 } 60 61 static const struct fb_ops drm_fbdev_dma_fb_ops = { 62 .owner = THIS_MODULE, 63 .fb_open = drm_fbdev_dma_fb_open, 64 .fb_release = drm_fbdev_dma_fb_release, 65 __FB_DEFAULT_SYS_OPS_RDWR, 66 DRM_FB_HELPER_DEFAULT_OPS, 67 __FB_DEFAULT_SYS_OPS_DRAW, 68 .fb_mmap = drm_fbdev_dma_fb_mmap, 69 .fb_destroy = drm_fbdev_dma_fb_destroy, 70 }; 71 72 /* 73 * struct drm_fb_helper 74 */ 75 76 static int drm_fbdev_dma_helper_fb_probe(struct drm_fb_helper *fb_helper, 77 struct drm_fb_helper_surface_size *sizes) 78 { 79 struct drm_client_dev *client = &fb_helper->client; 80 struct drm_device *dev = fb_helper->dev; 81 struct drm_client_buffer *buffer; 82 struct drm_gem_dma_object *dma_obj; 83 struct drm_framebuffer *fb; 84 struct fb_info *info; 85 u32 format; 86 struct iosys_map map; 87 int ret; 88 89 drm_dbg_kms(dev, "surface width(%d), height(%d) and bpp(%d)\n", 90 sizes->surface_width, sizes->surface_height, 91 sizes->surface_bpp); 92 93 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth); 94 buffer = drm_client_framebuffer_create(client, sizes->surface_width, 95 sizes->surface_height, format); 96 if (IS_ERR(buffer)) 97 return PTR_ERR(buffer); 98 dma_obj = to_drm_gem_dma_obj(buffer->gem); 99 100 fb = buffer->fb; 101 if (drm_WARN_ON(dev, fb->funcs->dirty)) { 102 ret = -ENODEV; /* damage handling not supported; use generic emulation */ 103 goto err_drm_client_buffer_delete; 104 } 105 106 ret = drm_client_buffer_vmap(buffer, &map); 107 if (ret) { 108 goto err_drm_client_buffer_delete; 109 } else if (drm_WARN_ON(dev, map.is_iomem)) { 110 ret = -ENODEV; /* I/O memory not supported; use generic emulation */ 111 goto err_drm_client_buffer_delete; 112 } 113 114 fb_helper->buffer = buffer; 115 fb_helper->fb = buffer->fb; 116 117 info = drm_fb_helper_alloc_info(fb_helper); 118 if (IS_ERR(info)) { 119 ret = PTR_ERR(info); 120 goto err_drm_client_buffer_vunmap; 121 } 122 123 drm_fb_helper_fill_info(info, fb_helper, sizes); 124 125 info->fbops = &drm_fbdev_dma_fb_ops; 126 info->flags = FBINFO_DEFAULT; 127 128 /* screen */ 129 info->flags |= FBINFO_VIRTFB; /* system memory */ 130 if (dma_obj->map_noncoherent) 131 info->flags |= FBINFO_READS_FAST; /* signal caching */ 132 info->screen_size = sizes->surface_height * fb->pitches[0]; 133 info->screen_buffer = map.vaddr; 134 info->fix.smem_start = page_to_phys(virt_to_page(info->screen_buffer)); 135 info->fix.smem_len = info->screen_size; 136 137 return 0; 138 139 err_drm_client_buffer_vunmap: 140 fb_helper->fb = NULL; 141 fb_helper->buffer = NULL; 142 drm_client_buffer_vunmap(buffer); 143 err_drm_client_buffer_delete: 144 drm_client_framebuffer_delete(buffer); 145 return ret; 146 } 147 148 static const struct drm_fb_helper_funcs drm_fbdev_dma_helper_funcs = { 149 .fb_probe = drm_fbdev_dma_helper_fb_probe, 150 }; 151 152 /* 153 * struct drm_client_funcs 154 */ 155 156 static void drm_fbdev_dma_client_unregister(struct drm_client_dev *client) 157 { 158 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client); 159 160 if (fb_helper->info) { 161 drm_fb_helper_unregister_info(fb_helper); 162 } else { 163 drm_client_release(&fb_helper->client); 164 drm_fb_helper_unprepare(fb_helper); 165 kfree(fb_helper); 166 } 167 } 168 169 static int drm_fbdev_dma_client_restore(struct drm_client_dev *client) 170 { 171 drm_fb_helper_lastclose(client->dev); 172 173 return 0; 174 } 175 176 static int drm_fbdev_dma_client_hotplug(struct drm_client_dev *client) 177 { 178 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client); 179 struct drm_device *dev = client->dev; 180 int ret; 181 182 if (dev->fb_helper) 183 return drm_fb_helper_hotplug_event(dev->fb_helper); 184 185 ret = drm_fb_helper_init(dev, fb_helper); 186 if (ret) 187 goto err_drm_err; 188 189 if (!drm_drv_uses_atomic_modeset(dev)) 190 drm_helper_disable_unused_functions(dev); 191 192 ret = drm_fb_helper_initial_config(fb_helper); 193 if (ret) 194 goto err_drm_fb_helper_fini; 195 196 return 0; 197 198 err_drm_fb_helper_fini: 199 drm_fb_helper_fini(fb_helper); 200 err_drm_err: 201 drm_err(dev, "fbdev-dma: Failed to setup generic emulation (ret=%d)\n", ret); 202 return ret; 203 } 204 205 static const struct drm_client_funcs drm_fbdev_dma_client_funcs = { 206 .owner = THIS_MODULE, 207 .unregister = drm_fbdev_dma_client_unregister, 208 .restore = drm_fbdev_dma_client_restore, 209 .hotplug = drm_fbdev_dma_client_hotplug, 210 }; 211 212 /** 213 * drm_fbdev_dma_setup() - Setup fbdev emulation for GEM DMA helpers 214 * @dev: DRM device 215 * @preferred_bpp: Preferred bits per pixel for the device. 216 * @dev->mode_config.preferred_depth is used if this is zero. 217 * 218 * This function sets up fbdev emulation for GEM DMA drivers that support 219 * dumb buffers with a virtual address and that can be mmap'ed. 220 * drm_fbdev_dma_setup() shall be called after the DRM driver registered 221 * the new DRM device with drm_dev_register(). 222 * 223 * Restore, hotplug events and teardown are all taken care of. Drivers that do 224 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves. 225 * Simple drivers might use drm_mode_config_helper_suspend(). 226 * 227 * This function is safe to call even when there are no connectors present. 228 * Setup will be retried on the next hotplug event. 229 * 230 * The fbdev is destroyed by drm_dev_unregister(). 231 */ 232 void drm_fbdev_dma_setup(struct drm_device *dev, unsigned int preferred_bpp) 233 { 234 struct drm_fb_helper *fb_helper; 235 int ret; 236 237 drm_WARN(dev, !dev->registered, "Device has not been registered.\n"); 238 drm_WARN(dev, dev->fb_helper, "fb_helper is already set!\n"); 239 240 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL); 241 if (!fb_helper) 242 return; 243 drm_fb_helper_prepare(dev, fb_helper, preferred_bpp, &drm_fbdev_dma_helper_funcs); 244 245 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_dma_client_funcs); 246 if (ret) { 247 drm_err(dev, "Failed to register client: %d\n", ret); 248 goto err_drm_client_init; 249 } 250 251 ret = drm_fbdev_dma_client_hotplug(&fb_helper->client); 252 if (ret) 253 drm_dbg_kms(dev, "client hotplug ret=%d\n", ret); 254 255 drm_client_register(&fb_helper->client); 256 257 return; 258 259 err_drm_client_init: 260 drm_fb_helper_unprepare(fb_helper); 261 kfree(fb_helper); 262 } 263 EXPORT_SYMBOL(drm_fbdev_dma_setup); 264