drivers/gpu/drm/drm_panel.c

   1 /*
   2  * Copyright (C) 2013, NVIDIA Corporation.  All rights reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sub license,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the
  12  * next paragraph) shall be included in all copies or substantial portions
  13  * of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include <linux/backlight.h>
  25 #include <linux/err.h>
  26 #include <linux/module.h>
  27
  28 #include <drm/drm_crtc.h>
  29 #include <drm/drm_panel.h>
  30 #include <drm/drm_print.h>
  31
  32 static DEFINE_MUTEX(panel_lock);
  33 static LIST_HEAD(panel_list);
  34
  35 /**
  36  * DOC: drm panel
  37  *
  38  * The DRM panel helpers allow drivers to register panel objects with a
  39  * central registry and provide functions to retrieve those panels in display
  40  * drivers.
  41  *
  42  * For easy integration into drivers using the &drm_bridge infrastructure please
  43  * take look at drm_panel_bridge_add() and devm_drm_panel_bridge_add().
  44  */
  45
  46 /**
  47  * drm_panel_init - initialize a panel
  48  * @panel: DRM panel
  49  * @dev: parent device of the panel
  50  * @funcs: panel operations
  51  * @connector_type: the connector type (DRM_MODE_CONNECTOR_*) corresponding to
  52  *      the panel interface
  53  *
  54  * Initialize the panel structure for subsequent registration with
  55  * drm_panel_add().
  56  */
  57 void drm_panel_init(struct drm_panel *panel, struct device *dev,
  58                     const struct drm_panel_funcs *funcs, int connector_type)
  59 {
  60         INIT_LIST_HEAD(&panel->list);
  61         panel->dev = dev;
  62         panel->funcs = funcs;
  63         panel->connector_type = connector_type;
  64 }
  65 EXPORT_SYMBOL(drm_panel_init);
  66
  67 /**
  68  * drm_panel_add - add a panel to the global registry
  69  * @panel: panel to add
  70  *
  71  * Add a panel to the global registry so that it can be looked up by display
  72  * drivers.
  73  *
  74  * Return: 0 on success or a negative error code on failure.
  75  */
  76 int drm_panel_add(struct drm_panel *panel)
  77 {
  78         mutex_lock(&panel_lock);
  79         list_add_tail(&panel->list, &panel_list);
  80         mutex_unlock(&panel_lock);
  81
  82         return 0;
  83 }
  84 EXPORT_SYMBOL(drm_panel_add);
  85
  86 /**
  87  * drm_panel_remove - remove a panel from the global registry
  88  * @panel: DRM panel
  89  *
  90  * Removes a panel from the global registry.
  91  */
  92 void drm_panel_remove(struct drm_panel *panel)
  93 {
  94         mutex_lock(&panel_lock);
  95         list_del_init(&panel->list);
  96         mutex_unlock(&panel_lock);
  97 }
  98 EXPORT_SYMBOL(drm_panel_remove);
  99
 100 /**
 101  * drm_panel_attach - attach a panel to a connector
 102  * @panel: DRM panel
 103  * @connector: DRM connector
 104  *
 105  * After obtaining a pointer to a DRM panel a display driver calls this
 106  * function to attach a panel to a connector.
 107  *
 108  * An error is returned if the panel is already attached to another connector.
 109  *
 110  * When unloading, the driver should detach from the panel by calling
 111  * drm_panel_detach().
 112  *
 113  * Return: 0 on success or a negative error code on failure.
 114  */
 115 int drm_panel_attach(struct drm_panel *panel, struct drm_connector *connector)
 116 {
 117         if (panel->connector)
 118                 return -EBUSY;
 119
 120         panel->connector = connector;
 121         panel->drm = connector->dev;
 122
 123         return 0;
 124 }
 125 EXPORT_SYMBOL(drm_panel_attach);
 126
 127 /**
 128  * drm_panel_detach - detach a panel from a connector
 129  * @panel: DRM panel
 130  *
 131  * Detaches a panel from the connector it is attached to. If a panel is not
 132  * attached to any connector this is effectively a no-op.
 133  *
 134  * This function should not be called by the panel device itself. It
 135  * is only for the drm device that called drm_panel_attach().
 136  */
 137 void drm_panel_detach(struct drm_panel *panel)
 138 {
 139         panel->connector = NULL;
 140         panel->drm = NULL;
 141 }
 142 EXPORT_SYMBOL(drm_panel_detach);
 143
 144 /**
 145  * drm_panel_prepare - power on a panel
 146  * @panel: DRM panel
 147  *
 148  * Calling this function will enable power and deassert any reset signals to
 149  * the panel. After this has completed it is possible to communicate with any
 150  * integrated circuitry via a command bus.
 151  *
 152  * Return: 0 on success or a negative error code on failure.
 153  */
 154 int drm_panel_prepare(struct drm_panel *panel)
 155 {
 156         if (!panel)
 157                 return -EINVAL;
 158
 159         if (panel->funcs && panel->funcs->prepare)
 160                 return panel->funcs->prepare(panel);
 161
 162         return 0;
 163 }
 164 EXPORT_SYMBOL(drm_panel_prepare);
 165
 166 /**
 167  * drm_panel_unprepare - power off a panel
 168  * @panel: DRM panel
 169  *
 170  * Calling this function will completely power off a panel (assert the panel's
 171  * reset, turn off power supplies, ...). After this function has completed, it
 172  * is usually no longer possible to communicate with the panel until another
 173  * call to drm_panel_prepare().
 174  *
 175  * Return: 0 on success or a negative error code on failure.
 176  */
 177 int drm_panel_unprepare(struct drm_panel *panel)
 178 {
 179         if (!panel)
 180                 return -EINVAL;
 181
 182         if (panel->funcs && panel->funcs->unprepare)
 183                 return panel->funcs->unprepare(panel);
 184
 185         return 0;
 186 }
 187 EXPORT_SYMBOL(drm_panel_unprepare);
 188
 189 /**
 190  * drm_panel_enable - enable a panel
 191  * @panel: DRM panel
 192  *
 193  * Calling this function will cause the panel display drivers to be turned on
 194  * and the backlight to be enabled. Content will be visible on screen after
 195  * this call completes.
 196  *
 197  * Return: 0 on success or a negative error code on failure.
 198  */
 199 int drm_panel_enable(struct drm_panel *panel)
 200 {
 201         int ret;
 202
 203         if (!panel)
 204                 return -EINVAL;
 205
 206         if (panel->funcs && panel->funcs->enable) {
 207                 ret = panel->funcs->enable(panel);
 208                 if (ret < 0)
 209                         return ret;
 210         }
 211
 212         ret = backlight_enable(panel->backlight);
 213         if (ret < 0)
 214                 DRM_DEV_INFO(panel->dev, "failed to enable backlight: %d\n",
 215                              ret);
 216
 217         return 0;
 218 }
 219 EXPORT_SYMBOL(drm_panel_enable);
 220
 221 /**
 222  * drm_panel_disable - disable a panel
 223  * @panel: DRM panel
 224  *
 225  * This will typically turn off the panel's backlight or disable the display
 226  * drivers. For smart panels it should still be possible to communicate with
 227  * the integrated circuitry via any command bus after this call.
 228  *
 229  * Return: 0 on success or a negative error code on failure.
 230  */
 231 int drm_panel_disable(struct drm_panel *panel)
 232 {
 233         int ret;
 234
 235         if (!panel)
 236                 return -EINVAL;
 237
 238         ret = backlight_disable(panel->backlight);
 239         if (ret < 0)
 240                 DRM_DEV_INFO(panel->dev, "failed to disable backlight: %d\n",
 241                              ret);
 242
 243         if (panel->funcs && panel->funcs->disable)
 244                 return panel->funcs->disable(panel);
 245
 246         return 0;
 247 }
 248 EXPORT_SYMBOL(drm_panel_disable);
 249
 250 /**
 251  * drm_panel_get_modes - probe the available display modes of a panel
 252  * @panel: DRM panel
 253  *
 254  * The modes probed from the panel are automatically added to the connector
 255  * that the panel is attached to.
 256  *
 257  * Return: The number of modes available from the panel on success or a
 258  * negative error code on failure.
 259  */
 260 int drm_panel_get_modes(struct drm_panel *panel)
 261 {
 262         if (!panel)
 263                 return -EINVAL;
 264
 265         if (panel->funcs && panel->funcs->get_modes)
 266                 return panel->funcs->get_modes(panel, panel->connector);
 267
 268         return -EOPNOTSUPP;
 269 }
 270 EXPORT_SYMBOL(drm_panel_get_modes);
 271
 272 #ifdef CONFIG_OF
 273 /**
 274  * of_drm_find_panel - look up a panel using a device tree node
 275  * @np: device tree node of the panel
 276  *
 277  * Searches the set of registered panels for one that matches the given device
 278  * tree node. If a matching panel is found, return a pointer to it.
 279  *
 280  * Return: A pointer to the panel registered for the specified device tree
 281  * node or an ERR_PTR() if no panel matching the device tree node can be found.
 282  *
 283  * Possible error codes returned by this function:
 284  *
 285  * - EPROBE_DEFER: the panel device has not been probed yet, and the caller
 286  *   should retry later
 287  * - ENODEV: the device is not available (status != "okay" or "ok")
 288  */
 289 struct drm_panel *of_drm_find_panel(const struct device_node *np)
 290 {
 291         struct drm_panel *panel;
 292
 293         if (!of_device_is_available(np))
 294                 return ERR_PTR(-ENODEV);
 295
 296         mutex_lock(&panel_lock);
 297
 298         list_for_each_entry(panel, &panel_list, list) {
 299                 if (panel->dev->of_node == np) {
 300                         mutex_unlock(&panel_lock);
 301                         return panel;
 302                 }
 303         }
 304
 305         mutex_unlock(&panel_lock);
 306         return ERR_PTR(-EPROBE_DEFER);
 307 }
 308 EXPORT_SYMBOL(of_drm_find_panel);
 309 #endif
 310
 311 #ifdef CONFIG_BACKLIGHT_CLASS_DEVICE
 312 /**
 313  * drm_panel_of_backlight - use backlight device node for backlight
 314  * @panel: DRM panel
 315  *
 316  * Use this function to enable backlight handling if your panel
 317  * uses device tree and has a backlight phandle.
 318  *
 319  * When the panel is enabled backlight will be enabled after a
 320  * successful call to &drm_panel_funcs.enable()
 321  *
 322  * When the panel is disabled backlight will be disabled before the
 323  * call to &drm_panel_funcs.disable().
 324  *
 325  * A typical implementation for a panel driver supporting device tree
 326  * will call this function at probe time. Backlight will then be handled
 327  * transparently without requiring any intervention from the driver.
 328  * drm_panel_of_backlight() must be called after the call to drm_panel_init().
 329  *
 330  * Return: 0 on success or a negative error code on failure.
 331  */
 332 int drm_panel_of_backlight(struct drm_panel *panel)
 333 {
 334         struct backlight_device *backlight;
 335
 336         if (!panel || !panel->dev)
 337                 return -EINVAL;
 338
 339         backlight = devm_of_find_backlight(panel->dev);
 340
 341         if (IS_ERR(backlight))
 342                 return PTR_ERR(backlight);
 343
 344         panel->backlight = backlight;
 345         return 0;
 346 }
 347 EXPORT_SYMBOL(drm_panel_of_backlight);
 348 #endif
 349
 350 MODULE_AUTHOR("Thierry Reding <treding@nvidia.com>");
 351 MODULE_DESCRIPTION("DRM panel infrastructure");
 352 MODULE_LICENSE("GPL and additional rights");