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