1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Copyright (C) 2015 Free Electrons 4 * Copyright (C) 2015 NextThing Co 5 * 6 * Maxime Ripard <maxime.ripard@free-electrons.com> 7 */ 8 9 #include <linux/component.h> 10 #include <linux/dma-mapping.h> 11 #include <linux/kfifo.h> 12 #include <linux/module.h> 13 #include <linux/of_graph.h> 14 #include <linux/of_reserved_mem.h> 15 #include <linux/platform_device.h> 16 17 #include <drm/drm_aperture.h> 18 #include <drm/drm_atomic_helper.h> 19 #include <drm/drm_drv.h> 20 #include <drm/drm_fbdev_generic.h> 21 #include <drm/drm_gem_dma_helper.h> 22 #include <drm/drm_module.h> 23 #include <drm/drm_of.h> 24 #include <drm/drm_probe_helper.h> 25 #include <drm/drm_vblank.h> 26 27 #include "sun4i_drv.h" 28 #include "sun4i_frontend.h" 29 #include "sun4i_framebuffer.h" 30 #include "sun4i_tcon.h" 31 #include "sun8i_tcon_top.h" 32 33 static int drm_sun4i_gem_dumb_create(struct drm_file *file_priv, 34 struct drm_device *drm, 35 struct drm_mode_create_dumb *args) 36 { 37 /* The hardware only allows even pitches for YUV buffers. */ 38 args->pitch = ALIGN(DIV_ROUND_UP(args->width * args->bpp, 8), 2); 39 40 return drm_gem_dma_dumb_create_internal(file_priv, drm, args); 41 } 42 43 DEFINE_DRM_GEM_DMA_FOPS(sun4i_drv_fops); 44 45 static const struct drm_driver sun4i_drv_driver = { 46 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC, 47 48 /* Generic Operations */ 49 .fops = &sun4i_drv_fops, 50 .name = "sun4i-drm", 51 .desc = "Allwinner sun4i Display Engine", 52 .date = "20150629", 53 .major = 1, 54 .minor = 0, 55 56 /* GEM Operations */ 57 DRM_GEM_DMA_DRIVER_OPS_WITH_DUMB_CREATE(drm_sun4i_gem_dumb_create), 58 }; 59 60 static int sun4i_drv_bind(struct device *dev) 61 { 62 struct drm_device *drm; 63 struct sun4i_drv *drv; 64 int ret; 65 66 drm = drm_dev_alloc(&sun4i_drv_driver, dev); 67 if (IS_ERR(drm)) 68 return PTR_ERR(drm); 69 70 drv = devm_kzalloc(dev, sizeof(*drv), GFP_KERNEL); 71 if (!drv) { 72 ret = -ENOMEM; 73 goto free_drm; 74 } 75 76 drm->dev_private = drv; 77 INIT_LIST_HEAD(&drv->frontend_list); 78 INIT_LIST_HEAD(&drv->engine_list); 79 INIT_LIST_HEAD(&drv->tcon_list); 80 81 ret = of_reserved_mem_device_init(dev); 82 if (ret && ret != -ENODEV) { 83 dev_err(drm->dev, "Couldn't claim our memory region\n"); 84 goto free_drm; 85 } 86 87 drm_mode_config_init(drm); 88 89 ret = component_bind_all(drm->dev, drm); 90 if (ret) { 91 dev_err(drm->dev, "Couldn't bind all pipelines components\n"); 92 goto cleanup_mode_config; 93 } 94 95 /* drm_vblank_init calls kcalloc, which can fail */ 96 ret = drm_vblank_init(drm, drm->mode_config.num_crtc); 97 if (ret) 98 goto cleanup_mode_config; 99 100 /* Remove early framebuffers (ie. simplefb) */ 101 ret = drm_aperture_remove_framebuffers(false, &sun4i_drv_driver); 102 if (ret) 103 goto cleanup_mode_config; 104 105 sun4i_framebuffer_init(drm); 106 107 /* Enable connectors polling */ 108 drm_kms_helper_poll_init(drm); 109 110 ret = drm_dev_register(drm, 0); 111 if (ret) 112 goto finish_poll; 113 114 drm_fbdev_generic_setup(drm, 32); 115 116 dev_set_drvdata(dev, drm); 117 118 return 0; 119 120 finish_poll: 121 drm_kms_helper_poll_fini(drm); 122 cleanup_mode_config: 123 drm_mode_config_cleanup(drm); 124 of_reserved_mem_device_release(dev); 125 free_drm: 126 drm_dev_put(drm); 127 return ret; 128 } 129 130 static void sun4i_drv_unbind(struct device *dev) 131 { 132 struct drm_device *drm = dev_get_drvdata(dev); 133 134 dev_set_drvdata(dev, NULL); 135 drm_dev_unregister(drm); 136 drm_kms_helper_poll_fini(drm); 137 drm_atomic_helper_shutdown(drm); 138 drm_mode_config_cleanup(drm); 139 140 component_unbind_all(dev, NULL); 141 of_reserved_mem_device_release(dev); 142 143 drm_dev_put(drm); 144 } 145 146 static const struct component_master_ops sun4i_drv_master_ops = { 147 .bind = sun4i_drv_bind, 148 .unbind = sun4i_drv_unbind, 149 }; 150 151 static bool sun4i_drv_node_is_connector(struct device_node *node) 152 { 153 return of_device_is_compatible(node, "hdmi-connector"); 154 } 155 156 static bool sun4i_drv_node_is_frontend(struct device_node *node) 157 { 158 return of_device_is_compatible(node, "allwinner,sun4i-a10-display-frontend") || 159 of_device_is_compatible(node, "allwinner,sun5i-a13-display-frontend") || 160 of_device_is_compatible(node, "allwinner,sun6i-a31-display-frontend") || 161 of_device_is_compatible(node, "allwinner,sun7i-a20-display-frontend") || 162 of_device_is_compatible(node, "allwinner,sun8i-a23-display-frontend") || 163 of_device_is_compatible(node, "allwinner,sun8i-a33-display-frontend") || 164 of_device_is_compatible(node, "allwinner,sun9i-a80-display-frontend"); 165 } 166 167 static bool sun4i_drv_node_is_deu(struct device_node *node) 168 { 169 return of_device_is_compatible(node, "allwinner,sun9i-a80-deu"); 170 } 171 172 static bool sun4i_drv_node_is_supported_frontend(struct device_node *node) 173 { 174 if (IS_ENABLED(CONFIG_DRM_SUN4I_BACKEND)) 175 return !!of_match_node(sun4i_frontend_of_table, node); 176 177 return false; 178 } 179 180 static bool sun4i_drv_node_is_tcon(struct device_node *node) 181 { 182 return !!of_match_node(sun4i_tcon_of_table, node); 183 } 184 185 static bool sun4i_drv_node_is_tcon_with_ch0(struct device_node *node) 186 { 187 const struct of_device_id *match; 188 189 match = of_match_node(sun4i_tcon_of_table, node); 190 if (match) { 191 struct sun4i_tcon_quirks *quirks; 192 193 quirks = (struct sun4i_tcon_quirks *)match->data; 194 195 return quirks->has_channel_0; 196 } 197 198 return false; 199 } 200 201 static bool sun4i_drv_node_is_tcon_top(struct device_node *node) 202 { 203 return IS_ENABLED(CONFIG_DRM_SUN8I_TCON_TOP) && 204 !!of_match_node(sun8i_tcon_top_of_table, node); 205 } 206 207 /* 208 * The encoder drivers use drm_of_find_possible_crtcs to get upstream 209 * crtcs from the device tree using of_graph. For the results to be 210 * correct, encoders must be probed/bound after _all_ crtcs have been 211 * created. The existing code uses a depth first recursive traversal 212 * of the of_graph, which means the encoders downstream of the TCON 213 * get add right after the first TCON. The second TCON or CRTC will 214 * never be properly associated with encoders connected to it. 215 * 216 * Also, in a dual display pipeline setup, both frontends can feed 217 * either backend, and both backends can feed either TCON, we want 218 * all components of the same type to be added before the next type 219 * in the pipeline. Fortunately, the pipelines are perfectly symmetric, 220 * i.e. components of the same type are at the same depth when counted 221 * from the frontend. The only exception is the third pipeline in 222 * the A80 SoC, which we do not support anyway. 223 * 224 * Hence we can use a breadth first search traversal order to add 225 * components. We do not need to check for duplicates. The component 226 * matching system handles this for us. 227 */ 228 struct endpoint_list { 229 DECLARE_KFIFO(fifo, struct device_node *, 16); 230 }; 231 232 static void sun4i_drv_traverse_endpoints(struct endpoint_list *list, 233 struct device_node *node, 234 int port_id) 235 { 236 struct device_node *ep, *remote, *port; 237 238 port = of_graph_get_port_by_id(node, port_id); 239 if (!port) { 240 DRM_DEBUG_DRIVER("No output to bind on port %d\n", port_id); 241 return; 242 } 243 244 for_each_available_child_of_node(port, ep) { 245 remote = of_graph_get_remote_port_parent(ep); 246 if (!remote) { 247 DRM_DEBUG_DRIVER("Error retrieving the output node\n"); 248 continue; 249 } 250 251 if (sun4i_drv_node_is_tcon(node)) { 252 /* 253 * TCON TOP is always probed before TCON. However, TCON 254 * points back to TCON TOP when it is source for HDMI. 255 * We have to skip it here to prevent infinite looping 256 * between TCON TOP and TCON. 257 */ 258 if (sun4i_drv_node_is_tcon_top(remote)) { 259 DRM_DEBUG_DRIVER("TCON output endpoint is TCON TOP... skipping\n"); 260 of_node_put(remote); 261 continue; 262 } 263 264 /* 265 * If the node is our TCON with channel 0, the first 266 * port is used for panel or bridges, and will not be 267 * part of the component framework. 268 */ 269 if (sun4i_drv_node_is_tcon_with_ch0(node)) { 270 struct of_endpoint endpoint; 271 272 if (of_graph_parse_endpoint(ep, &endpoint)) { 273 DRM_DEBUG_DRIVER("Couldn't parse endpoint\n"); 274 of_node_put(remote); 275 continue; 276 } 277 278 if (!endpoint.id) { 279 DRM_DEBUG_DRIVER("Endpoint is our panel... skipping\n"); 280 of_node_put(remote); 281 continue; 282 } 283 } 284 } 285 286 kfifo_put(&list->fifo, remote); 287 } 288 } 289 290 static int sun4i_drv_add_endpoints(struct device *dev, 291 struct endpoint_list *list, 292 struct component_match **match, 293 struct device_node *node) 294 { 295 int count = 0; 296 297 /* 298 * The frontend has been disabled in some of our old device 299 * trees. If we find a node that is the frontend and is 300 * disabled, we should just follow through and parse its 301 * child, but without adding it to the component list. 302 * Otherwise, we obviously want to add it to the list. 303 */ 304 if (!sun4i_drv_node_is_frontend(node) && 305 !of_device_is_available(node)) 306 return 0; 307 308 /* 309 * The connectors will be the last nodes in our pipeline, we 310 * can just bail out. 311 */ 312 if (sun4i_drv_node_is_connector(node)) 313 return 0; 314 315 /* 316 * If the device is either just a regular device, or an 317 * enabled frontend supported by the driver, we add it to our 318 * component list. 319 */ 320 if (!(sun4i_drv_node_is_frontend(node) || 321 sun4i_drv_node_is_deu(node)) || 322 (sun4i_drv_node_is_supported_frontend(node) && 323 of_device_is_available(node))) { 324 /* Add current component */ 325 DRM_DEBUG_DRIVER("Adding component %pOF\n", node); 326 drm_of_component_match_add(dev, match, component_compare_of, node); 327 count++; 328 } 329 330 /* each node has at least one output */ 331 sun4i_drv_traverse_endpoints(list, node, 1); 332 333 /* TCON TOP has second and third output */ 334 if (sun4i_drv_node_is_tcon_top(node)) { 335 sun4i_drv_traverse_endpoints(list, node, 3); 336 sun4i_drv_traverse_endpoints(list, node, 5); 337 } 338 339 return count; 340 } 341 342 #ifdef CONFIG_PM_SLEEP 343 static int sun4i_drv_drm_sys_suspend(struct device *dev) 344 { 345 struct drm_device *drm = dev_get_drvdata(dev); 346 347 return drm_mode_config_helper_suspend(drm); 348 } 349 350 static int sun4i_drv_drm_sys_resume(struct device *dev) 351 { 352 struct drm_device *drm = dev_get_drvdata(dev); 353 354 return drm_mode_config_helper_resume(drm); 355 } 356 #endif 357 358 static const struct dev_pm_ops sun4i_drv_drm_pm_ops = { 359 SET_SYSTEM_SLEEP_PM_OPS(sun4i_drv_drm_sys_suspend, 360 sun4i_drv_drm_sys_resume) 361 }; 362 363 static int sun4i_drv_probe(struct platform_device *pdev) 364 { 365 struct component_match *match = NULL; 366 struct device_node *np = pdev->dev.of_node, *endpoint; 367 struct endpoint_list list; 368 int i, ret, count = 0; 369 370 INIT_KFIFO(list.fifo); 371 372 /* 373 * DE2 and DE3 cores actually supports 40-bit addresses, but 374 * driver does not. 375 */ 376 dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32)); 377 dma_set_max_seg_size(&pdev->dev, UINT_MAX); 378 379 for (i = 0;; i++) { 380 struct device_node *pipeline = of_parse_phandle(np, 381 "allwinner,pipelines", 382 i); 383 if (!pipeline) 384 break; 385 386 kfifo_put(&list.fifo, pipeline); 387 } 388 389 while (kfifo_get(&list.fifo, &endpoint)) { 390 /* process this endpoint */ 391 ret = sun4i_drv_add_endpoints(&pdev->dev, &list, &match, 392 endpoint); 393 394 /* sun4i_drv_add_endpoints can fail to allocate memory */ 395 if (ret < 0) 396 return ret; 397 398 count += ret; 399 } 400 401 if (count) 402 return component_master_add_with_match(&pdev->dev, 403 &sun4i_drv_master_ops, 404 match); 405 else 406 return 0; 407 } 408 409 static int sun4i_drv_remove(struct platform_device *pdev) 410 { 411 component_master_del(&pdev->dev, &sun4i_drv_master_ops); 412 413 return 0; 414 } 415 416 static const struct of_device_id sun4i_drv_of_table[] = { 417 { .compatible = "allwinner,sun4i-a10-display-engine" }, 418 { .compatible = "allwinner,sun5i-a10s-display-engine" }, 419 { .compatible = "allwinner,sun5i-a13-display-engine" }, 420 { .compatible = "allwinner,sun6i-a31-display-engine" }, 421 { .compatible = "allwinner,sun6i-a31s-display-engine" }, 422 { .compatible = "allwinner,sun7i-a20-display-engine" }, 423 { .compatible = "allwinner,sun8i-a23-display-engine" }, 424 { .compatible = "allwinner,sun8i-a33-display-engine" }, 425 { .compatible = "allwinner,sun8i-a83t-display-engine" }, 426 { .compatible = "allwinner,sun8i-h3-display-engine" }, 427 { .compatible = "allwinner,sun8i-r40-display-engine" }, 428 { .compatible = "allwinner,sun8i-v3s-display-engine" }, 429 { .compatible = "allwinner,sun9i-a80-display-engine" }, 430 { .compatible = "allwinner,sun20i-d1-display-engine" }, 431 { .compatible = "allwinner,sun50i-a64-display-engine" }, 432 { .compatible = "allwinner,sun50i-h6-display-engine" }, 433 { } 434 }; 435 MODULE_DEVICE_TABLE(of, sun4i_drv_of_table); 436 437 static struct platform_driver sun4i_drv_platform_driver = { 438 .probe = sun4i_drv_probe, 439 .remove = sun4i_drv_remove, 440 .driver = { 441 .name = "sun4i-drm", 442 .of_match_table = sun4i_drv_of_table, 443 .pm = &sun4i_drv_drm_pm_ops, 444 }, 445 }; 446 drm_module_platform_driver(sun4i_drv_platform_driver); 447 448 MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>"); 449 MODULE_AUTHOR("Maxime Ripard <maxime.ripard@free-electrons.com>"); 450 MODULE_DESCRIPTION("Allwinner A10 Display Engine DRM/KMS Driver"); 451 MODULE_LICENSE("GPL"); 452