diff mbox

[U-Boot,2/2] rockchip: video: document externally visible functions for rk_vop

Message ID 1496412378-29837-2-git-send-email-philipp.tomsich@theobroma-systems.com
State Accepted
Delegated to: Anatolij Gustschin
Headers show

Commit Message

Philipp Tomsich June 2, 2017, 2:06 p.m. UTC 
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(+)

Comments

Simon Glass June 2, 2017, 11:59 p.m. UTC | #1 
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>
Anatolij Gustschin June 9, 2017, 1:58 p.m. UTC | #2 
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
diff mbox

Patch

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);