include/drm/drm_panel.h

   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 #ifndef __DRM_PANEL_H__
  25 #define __DRM_PANEL_H__
  26
  27 #include <linux/list.h>
  28
  29 struct drm_connector;
  30 struct drm_device;
  31 struct drm_panel;
  32 struct display_timing;
  33
  34 /**
  35  * struct drm_panel_funcs - perform operations on a given panel
  36  * @loader_protect: protect loader logo panel's power
  37  * @disable: disable panel (turn off back light, etc.)
  38  * @unprepare: turn off panel
  39  * @prepare: turn on panel and perform set up
  40  * @enable: enable panel (turn on back light, etc.)
  41  * @get_modes: add modes to the connector that the panel is attached to and
  42  * return the number of modes added
  43  * @get_timings: copy display timings into the provided array and return
  44  * the number of display timings available
  45  *
  46  * The .prepare() function is typically called before the display controller
  47  * starts to transmit video data. Panel drivers can use this to turn the panel
  48  * on and wait for it to become ready. If additional configuration is required
  49  * (via a control bus such as I2C, SPI or DSI for example) this is a good time
  50  * to do that.
  51  *
  52  * After the display controller has started transmitting video data, it's safe
  53  * to call the .enable() function. This will typically enable the backlight to
  54  * make the image on screen visible. Some panels require a certain amount of
  55  * time or frames before the image is displayed. This function is responsible
  56  * for taking this into account before enabling the backlight to avoid visual
  57  * glitches.
  58  *
  59  * Before stopping video transmission from the display controller it can be
  60  * necessary to turn off the panel to avoid visual glitches. This is done in
  61  * the .disable() function. Analogously to .enable() this typically involves
  62  * turning off the backlight and waiting for some time to make sure no image
  63  * is visible on the panel. It is then safe for the display controller to
  64  * cease transmission of video data.
  65  *
  66  * To save power when no video data is transmitted, a driver can power down
  67  * the panel. This is the job of the .unprepare() function.
  68  */
  69 struct drm_panel_funcs {
  70         int (*loader_protect)(struct drm_panel *panel, bool on);
  71         int (*disable)(struct drm_panel *panel);
  72         int (*unprepare)(struct drm_panel *panel);
  73         int (*prepare)(struct drm_panel *panel);
  74         int (*enable)(struct drm_panel *panel);
  75         int (*get_modes)(struct drm_panel *panel);
  76         int (*get_timings)(struct drm_panel *panel, unsigned int num_timings,
  77                            struct display_timing *timings);
  78 };
  79
  80 struct drm_panel {
  81         struct drm_device *drm;
  82         struct drm_connector *connector;
  83         struct device *dev;
  84
  85         const struct drm_panel_funcs *funcs;
  86
  87         struct list_head list;
  88 };
  89
  90 static inline int drm_panel_unprepare(struct drm_panel *panel)
  91 {
  92         if (panel && panel->funcs && panel->funcs->unprepare)
  93                 return panel->funcs->unprepare(panel);
  94
  95         return panel ? -ENOSYS : -EINVAL;
  96 }
  97
  98 static inline int drm_panel_disable(struct drm_panel *panel)
  99 {
 100         if (panel && panel->funcs && panel->funcs->disable)
 101                 return panel->funcs->disable(panel);
 102
 103         return panel ? -ENOSYS : -EINVAL;
 104 }
 105
 106 static inline int drm_panel_loader_protect(struct drm_panel *panel, bool on)
 107 {
 108         if (panel && panel->funcs && panel->funcs->loader_protect)
 109                 return panel->funcs->loader_protect(panel, on);
 110
 111         return panel ? -ENOSYS : -EINVAL;
 112 }
 113
 114 static inline int drm_panel_prepare(struct drm_panel *panel)
 115 {
 116         if (panel && panel->funcs && panel->funcs->prepare)
 117                 return panel->funcs->prepare(panel);
 118
 119         return panel ? -ENOSYS : -EINVAL;
 120 }
 121
 122 static inline int drm_panel_enable(struct drm_panel *panel)
 123 {
 124         if (panel && panel->funcs && panel->funcs->enable)
 125                 return panel->funcs->enable(panel);
 126
 127         return panel ? -ENOSYS : -EINVAL;
 128 }
 129
 130 static inline int drm_panel_get_modes(struct drm_panel *panel)
 131 {
 132         if (panel && panel->funcs && panel->funcs->get_modes)
 133                 return panel->funcs->get_modes(panel);
 134
 135         return panel ? -ENOSYS : -EINVAL;
 136 }
 137
 138 void drm_panel_init(struct drm_panel *panel);
 139
 140 int drm_panel_add(struct drm_panel *panel);
 141 void drm_panel_remove(struct drm_panel *panel);
 142
 143 int drm_panel_attach(struct drm_panel *panel, struct drm_connector *connector);
 144 int drm_panel_detach(struct drm_panel *panel);
 145
 146 #ifdef CONFIG_OF
 147 struct drm_panel *of_drm_find_panel(struct device_node *np);
 148 #else
 149 static inline struct drm_panel *of_drm_find_panel(struct device_node *np)
 150 {
 151         return NULL;
 152 }
 153 #endif
 154
 155 #endif