Orange Pi5 kernel

^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2)  * Copyright (C) 2013, NVIDIA Corporation.  All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4)  * Permission is hereby granted, free of charge, to any person obtaining a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5)  * copy of this software and associated documentation files (the "Software"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6)  * to deal in the Software without restriction, including without limitation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7)  * the rights to use, copy, modify, merge, publish, distribute, sub license,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8)  * and/or sell copies of the Software, and to permit persons to whom the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9)  * Software is furnished to do so, subject to the following conditions:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11)  * The above copyright notice and this permission notice (including the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12)  * next paragraph) shall be included in all copies or substantial portions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13)  * of the Software.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15)  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16)  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17)  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18)  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19)  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20)  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21)  * DEALINGS IN THE SOFTWARE.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22)  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24) #ifndef __DRM_PANEL_H__
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25) #define __DRM_PANEL_H__
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27) #include <linux/err.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28) #include <linux/errno.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29) #include <linux/list.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31) struct backlight_device;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32) struct device_node;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33) struct drm_connector;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34) struct drm_device;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35) struct drm_panel;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36) struct display_timing;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38) enum drm_panel_orientation;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41)  * struct drm_panel_funcs - perform operations on a given panel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43)  * The .prepare() function is typically called before the display controller
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44)  * starts to transmit video data. Panel drivers can use this to turn the panel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45)  * on and wait for it to become ready. If additional configuration is required
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46)  * (via a control bus such as I2C, SPI or DSI for example) this is a good time
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47)  * to do that.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49)  * After the display controller has started transmitting video data, it's safe
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50)  * to call the .enable() function. This will typically enable the backlight to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51)  * make the image on screen visible. Some panels require a certain amount of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52)  * time or frames before the image is displayed. This function is responsible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53)  * for taking this into account before enabling the backlight to avoid visual
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54)  * glitches.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56)  * Before stopping video transmission from the display controller it can be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57)  * necessary to turn off the panel to avoid visual glitches. This is done in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58)  * the .disable() function. Analogously to .enable() this typically involves
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59)  * turning off the backlight and waiting for some time to make sure no image
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60)  * is visible on the panel. It is then safe for the display controller to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61)  * cease transmission of video data.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63)  * To save power when no video data is transmitted, a driver can power down
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64)  * the panel. This is the job of the .unprepare() function.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66)  * Backlight can be handled automatically if configured using
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67)  * drm_panel_of_backlight(). Then the driver does not need to implement the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68)  * functionality to enable/disable backlight.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69)  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70) struct drm_panel_funcs {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72) 	 * @prepare:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74) 	 * Turn on panel and perform set up.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76) 	 * This function is optional.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78) 	int (*prepare)(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81) 	 * @enable:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83) 	 * Enable panel (turn on back light, etc.).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85) 	 * This function is optional.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87) 	int (*enable)(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90) 	 * @disable:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92) 	 * Disable panel (turn off back light, etc.).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94) 	 * This function is optional.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96) 	int (*disable)(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99) 	 * @unprepare:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) 	 * Turn off panel.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) 	 * This function is optional.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) 	int (*unprepare)(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) 	 * @get_modes:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) 	 * Add modes to the connector that the panel is attached to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) 	 * and returns the number of modes added.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) 	 * This function is mandatory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) 	int (*get_modes)(struct drm_panel *panel,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) 			 struct drm_connector *connector);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) 	 * @get_timings:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) 	 * Copy display timings into the provided array and return
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) 	 * the number of display timings available.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) 	 * This function is optional.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) 	int (*get_timings)(struct drm_panel *panel, unsigned int num_timings,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) 			   struct display_timing *timings);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)  * struct drm_panel - DRM panel object
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) struct drm_panel {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) 	 * @dev:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) 	 * Parent device of the panel.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) 	struct device *dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) 	 * @backlight:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) 	 * Backlight device, used to turn on backlight after the call
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) 	 * to enable(), and to turn off backlight before the call to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) 	 * disable().
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) 	 * backlight is set by drm_panel_of_backlight() and drivers
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) 	 * shall not assign it.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) 	struct backlight_device *backlight;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) 	 * @funcs:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) 	 * Operations that can be performed on the panel.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) 	const struct drm_panel_funcs *funcs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) 	 * @connector_type:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) 	 * Type of the panel as a DRM_MODE_CONNECTOR_* value. This is used to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) 	 * initialise the drm_connector corresponding to the panel with the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) 	 * correct connector type.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) 	int connector_type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) 	/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) 	 * @list:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) 	 *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) 	 * Panel entry in registry.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) 	 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) 	struct list_head list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) void drm_panel_init(struct drm_panel *panel, struct device *dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) 		    const struct drm_panel_funcs *funcs,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) 		    int connector_type);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) void drm_panel_add(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) void drm_panel_remove(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) int drm_panel_prepare(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) int drm_panel_unprepare(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) int drm_panel_enable(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) int drm_panel_disable(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) int drm_panel_get_modes(struct drm_panel *panel, struct drm_connector *connector);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) #if defined(CONFIG_OF) && defined(CONFIG_DRM_PANEL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) struct drm_panel *of_drm_find_panel(const struct device_node *np);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) int of_drm_get_panel_orientation(const struct device_node *np,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) 				 enum drm_panel_orientation *orientation);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) static inline struct drm_panel *of_drm_find_panel(const struct device_node *np)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) 	return ERR_PTR(-ENODEV);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) static inline int of_drm_get_panel_orientation(const struct device_node *np,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) 					       enum drm_panel_orientation *orientation)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) 	return -ENODEV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) #if IS_ENABLED(CONFIG_DRM_PANEL) && (IS_BUILTIN(CONFIG_BACKLIGHT_CLASS_DEVICE) || \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) 	(IS_MODULE(CONFIG_DRM) && IS_MODULE(CONFIG_BACKLIGHT_CLASS_DEVICE)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) int drm_panel_of_backlight(struct drm_panel *panel);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) static inline int drm_panel_of_backlight(struct drm_panel *panel)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) 	return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) #endif