diff options
| author | Simon Glass <sjg@chromium.org> | 2020-07-02 21:12:19 -0600 |
|---|---|---|
| committer | Bin Meng <bmeng.cn@gmail.com> | 2020-07-09 12:33:24 +0800 |
| commit | 5a6cea37c672a6579338b60e74965210c785c0f3 (patch) | |
| tree | 49079290a32c2a22dd3a3a59ae63d151f09b0ce4 /include/video.h | |
| parent | 2d7c268b595de374556601048d5cc18c367020ac (diff) | |
| download | u-boot-5a6cea37c672a6579338b60e74965210c785c0f3.tar.gz | |
video: Add a comment for struct video_uc_platdata
Add a few notes to explain the purpose of each member of this struct.
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Anatolij Gustschin <agust@denx.de>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Diffstat (limited to 'include/video.h')
| -rw-r--r-- | include/video.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/include/video.h b/include/video.h index e7c58e86cb4..813b5653b03 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; |