diff mbox series

[08/26] video: Add a comment for struct video_uc_platdata

Message ID 20200519231058.19945-9-sjg@chromium.org
State Superseded
Headers show
Series x86: video: Speed up the framebuffer | expand

Commit Message

Simon Glass May 19, 2020, 11:10 p.m. UTC 
Add a few notes to explain the purpose of each member of this struct.

Signed-off-by: Simon Glass <sjg at chromium.org>
---

 include/video.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Anatolij Gustschin May 22, 2020, 2:12 p.m. UTC | #1 
On Tue, 19 May 2020 17:10:40 -0600
Simon Glass sjg at chromium.org wrote:

> Add a few notes to explain the purpose of each member of this struct.
> 
> Signed-off-by: Simon Glass <sjg at chromium.org>

Reviewed-by: Anatolij Gustschin <agust at denx.de>
diff mbox series

Patch

diff --git a/include/video.h b/include/video.h
index e7c58e86cb..813b5653b0 100644
--- a/include/video.h
+++ b/include/video.h
@@ -19,6 +19,18 @@ 
 
 struct udevice;
 
+/**
+ * struct video_uc_platdata - uclass platform data for a video device
+ *
+ * This holds information that the uclass needs to know about each device. It
+ * is accessed using dev_get_uclass_platdata(dev). See 'Theory of operation' at
+ * the top of video-uclass.c for details on how this information is set.
+ *
+ * @align: Frame-buffer alignment, indicating the memory boundary the frame
+ *	buffer should start on. If 0, 1MB is assumed
+ * @size: Frame-buffer size, in bytes
+ * @base: Base address of frame buffer, 0 if not yet known
+ */
 struct video_uc_platdata {
 	uint align;
 	uint size;