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