From: Simon Glass <sjg@chromium.org>
Date: Mon, 3 Feb 2020 14:36:08 +0000 (-0700)
Subject: sandbox: Add comments to the sdl struct
X-Git-Tag: v2020.04-rc2~2^2~10
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=c127f191a8dbfddc480a425bbca14730dfc4d441;p=oweals%2Fu-boot.git

sandbox: Add comments to the sdl struct

Add comments for each struct member. Drop frequency since it is not used.

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

diff --git a/arch/sandbox/cpu/sdl.c b/arch/sandbox/cpu/sdl.c
index 080c7c8d74..dad059f257 100644
--- a/arch/sandbox/cpu/sdl.c
+++ b/arch/sandbox/cpu/sdl.c
@@ -24,13 +24,28 @@ struct buf_info {
 	uint8_t *data;
 };
 
+/**
+ * struct sdl_info - Information about our use of the SDL library
+ *
+ * @screen: Surface used to draw on the screen
+ * @width: Width of simulated LCD display
+ * @height: Height of simulated LCD display
+ * @depth: Depth of the display in bits per pixel (16 or 32)
+ * @pitch: Number of bytes per line of the display
+ * @sample_rate: Current sample rate for audio
+ * @audio_active: true if audio can be used
+ * @inited: true if this module is initialised
+ * @cur_buf: Current audio buffer being used by sandbox_sdl_fill_audio (0 or 1)
+ * @buf: The two available audio buffers. SDL can be reading from one while we
+ *	are setting up the next
+ * @running: true if audio is running
+ */
 static struct sdl_info {
 	SDL_Surface *screen;
 	int width;
 	int height;
 	int depth;
 	int pitch;
-	uint frequency;
 	uint sample_rate;
 	bool audio_active;
 	bool inited;