[U-Boot] [PATCH 1/2] rockchip: video: document externally visible functions for rk_hdmi

Documents the externally visible functions shared between the HDMI drivers for the RK3288 and RK3399.
Signed-off-by: Philipp Tomsich philipp.tomsich@theobroma-systems.com ---
drivers/video/rockchip/rk_hdmi.h | 44 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+)
diff --git a/drivers/video/rockchip/rk_hdmi.h b/drivers/video/rockchip/rk_hdmi.h index 501ed3a..9e165ae 100644 --- a/drivers/video/rockchip/rk_hdmi.h +++ b/drivers/video/rockchip/rk_hdmi.h @@ -23,10 +23,54 @@ struct rk_hdmi_priv { void *grf; };
+/** + * rk_hdmi_read_edid() - read the attached HDMI/DVI monitor's EDID + * + * N.B.: The buffer should be large enough to hold 2 EDID blocks, as + * this function calls dw_hdmi_read_edid, which ignores buf_size + * argument and assumes that there's always enough space for 2 + * EDID blocks. + * + * @dev: device + * @buf: output buffer for the EDID + * @buf_size: number of bytes in the buffer + * @return number of bytes read if OK, -ve if something went wrong + */ int rk_hdmi_read_edid(struct udevice *dev, u8 *buf, int buf_size); + +/** + * rk_hdmi_probe_regulators() - probe (autoset + enable) regulators + * + * Probes a list of regulators by performaing autoset and enable + * operations on them. The list of regulators is an array of string + * pointers and any indivudal regulator-probe may fail without + * counting as an error. + * + * @dev: device + * @names: array of string-pointers to regulator names to probe + * @cnt: number of elements in the 'names' array + */ void rk_hdmi_probe_regulators(struct udevice *dev, const char * const *names, int cnt); +/** + * rk_hdmi_ofdata_to_platdata() - common ofdata_to_platdata implementation + * + * @dev: device + * @return 0 if OK, -ve if something went wrong + */ int rk_hdmi_ofdata_to_platdata(struct udevice *dev); + +/** + * rk_hdmi_probe() - common probe implementation + * + * Performs the following, common initialisation steps: + * 1. checks for HPD (i.e. a HDMI monitor being attached) + * 2. initialises the Designware HDMI core + * 3. initialises the Designware HDMI PHY + * + * @dev: device + * @return 0 if OK, -ve if something went wrong + */ int rk_hdmi_probe(struct udevice *dev);
#endif

Documents the externally visible functions shared between the VOP drivers for the RK3288 and RK3399.
Signed-off-by: Philipp Tomsich philipp.tomsich@theobroma-systems.com ---
drivers/video/rockchip/rk_vop.h | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
diff --git a/drivers/video/rockchip/rk_vop.h b/drivers/video/rockchip/rk_vop.h index f65ac17..84d9d0f 100644 --- a/drivers/video/rockchip/rk_vop.h +++ b/drivers/video/rockchip/rk_vop.h @@ -24,8 +24,42 @@ struct rkvop_driverdata { void (*set_pin_polarity)(struct udevice *, enum vop_modes, u32); };
+/** + * rk_vop_probe() - common probe implementation + * + * Performs the rk_display_init on each port-subnode until finding a + * working port (or returning an error if none of the ports could be + * successfully initialised). + * + * @dev: device + * @return 0 if OK, -ve if something went wrong + */ int rk_vop_probe(struct udevice *dev); + +/** + * rk_vop_bind() - common bind implementation + * + * Sets the plat->size field to the amount of memory to be reserved for + * the framebuffer: this is always + * (32 BPP) x VIDEO_ROCKCHIP_MAX_XRES x VIDEO_ROCKCHIP_MAX_YRES + * + * @dev: device + * @return 0 (always OK) + */ int rk_vop_bind(struct udevice *dev); + +/** + * rk_vop_probe_regulators() - probe (autoset + enable) regulators + * + * Probes a list of regulators by performaing autoset and enable + * operations on them. The list of regulators is an array of string + * pointers and any indivudal regulator-probe may fail without + * counting as an error. + * + * @dev: device + * @names: array of string-pointers to regulator names to probe + * @cnt: number of elements in the 'names' array + */ void rk_vop_probe_regulators(struct udevice *dev, const char * const *names, int cnt);

On 2 June 2017 at 08:06, Philipp Tomsich philipp.tomsich@theobroma-systems.com wrote:
Documents the externally visible functions shared between the VOP drivers for the RK3288 and RK3399.
Signed-off-by: Philipp Tomsich philipp.tomsich@theobroma-systems.com
drivers/video/rockchip/rk_vop.h | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
Reviewed-by: Simon Glass sjg@chromium.org

On Fri, 2 Jun 2017 16:06:18 +0200 Philipp Tomsich philipp.tomsich@theobroma-systems.com wrote:
Documents the externally visible functions shared between the VOP drivers for the RK3288 and RK3399.
Signed-off-by: Philipp Tomsich philipp.tomsich@theobroma-systems.com
drivers/video/rockchip/rk_vop.h | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
with minor typo fixes, applied to u-boot-video/master, thanks!
-- Anatolij

On 2 June 2017 at 08:06, Philipp Tomsich philipp.tomsich@theobroma-systems.com wrote:
Documents the externally visible functions shared between the HDMI drivers for the RK3288 and RK3399.
Signed-off-by: Philipp Tomsich philipp.tomsich@theobroma-systems.com
drivers/video/rockchip/rk_hdmi.h | 44 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+)
Reviewed-by: Simon Glass sjg@chromium.org

On Fri, 2 Jun 2017 16:06:17 +0200 Philipp Tomsich philipp.tomsich@theobroma-systems.com wrote:
Documents the externally visible functions shared between the HDMI drivers for the RK3288 and RK3399.
Signed-off-by: Philipp Tomsich philipp.tomsich@theobroma-systems.com
drivers/video/rockchip/rk_hdmi.h | 44 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+)
Applied to u-boot-video/master, with s/performaing/performing/. Thanks!
-- Anatolij
participants (3)
-
Anatolij Gustschin
-
Philipp Tomsich
-
Simon Glass