aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorHeinrich Schuchardt <xypron.glpk@gmx.de>2019-09-05 20:37:13 +0200
committerHeinrich Schuchardt <xypron.glpk@gmx.de>2019-09-05 23:18:52 +0200
commitfe1a81c1a47737d3ce6b6855a05468b7546d4982 (patch)
treef463d4e65bc5bec09c7cf6ee8a01991e441841e1 /lib
parentcda9b352726117779bf2e7a26e19026d42a6cd1f (diff)
downloadu-boot-fe1a81c1a47737d3ce6b6855a05468b7546d4982.zip
u-boot-fe1a81c1a47737d3ce6b6855a05468b7546d4982.tar.gz
u-boot-fe1a81c1a47737d3ce6b6855a05468b7546d4982.tar.bz2
doc: UEFI API documentation
Add some more files to the UEFI API documentation. Correct some Sphinx comments. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'lib')
-rw-r--r--lib/efi_loader/efi_console.c11
-rw-r--r--lib/efi_loader/efi_gop.c2
-rw-r--r--lib/efi_loader/efi_net.c9
3 files changed, 13 insertions, 9 deletions
diff --git a/lib/efi_loader/efi_console.c b/lib/efi_loader/efi_console.c
index 5109017..a55e4b3 100644
--- a/lib/efi_loader/efi_console.c
+++ b/lib/efi_loader/efi_console.c
@@ -219,9 +219,9 @@ static bool cout_mode_matches(struct cout_mode *mode, int rows, int cols)
/**
* query_console_serial() - query console size
*
- * @rows pointer to return number of rows
- * @columns pointer to return number of columns
- * Returns 0 on success
+ * @rows: pointer to return number of rows
+ * @cols: pointer to return number of columns
+ * Returns: 0 on success
*/
static int query_console_serial(int *rows, int *cols)
{
@@ -464,7 +464,7 @@ struct efi_simple_text_output_protocol efi_con_out = {
* struct efi_cin_notify_function - registered console input notify function
*
* @link: link to list
- * @data: key to notify
+ * @key: key to notify
* @function: function to call
*/
struct efi_cin_notify_function {
@@ -482,6 +482,7 @@ static LIST_HEAD(cin_notify_functions);
* set_shift_mask() - set shift mask
*
* @mod: Xterm shift mask
+ * @key_state: receives the state of the shift, alt, control, and logo keys
*/
void set_shift_mask(int mod, struct efi_key_state *key_state)
{
@@ -504,7 +505,7 @@ void set_shift_mask(int mod, struct efi_key_state *key_state)
*
* This gets called when we have already parsed CSI.
*
- * @modifiers: bit mask (shift, alt, ctrl)
+ * @key_state: receives the state of the shift, alt, control, and logo keys
* @return: the unmodified code
*/
static int analyze_modifiers(struct efi_key_state *key_state)
diff --git a/lib/efi_loader/efi_gop.c b/lib/efi_loader/efi_gop.c
index cad509b..1511e3b 100644
--- a/lib/efi_loader/efi_gop.c
+++ b/lib/efi_loader/efi_gop.c
@@ -319,7 +319,7 @@ static efi_status_t gop_blt_vid_to_buf(struct efi_gop *this,
* details.
*
* @this: the graphical output protocol
- * @model_number: the mode to be set
+ * @mode_number: the mode to be set
* Return: status code
*/
static efi_status_t EFIAPI gop_set_mode(struct efi_gop *this, u32 mode_number)
diff --git a/lib/efi_loader/efi_net.c b/lib/efi_loader/efi_net.c
index cff6332..82d2595 100644
--- a/lib/efi_loader/efi_net.c
+++ b/lib/efi_loader/efi_net.c
@@ -399,7 +399,7 @@ out:
* Protocol. See the UEFI spec for details.
*
* @this: the instance of the Simple Network Protocol
- * @readwrite: true for read, false for write
+ * @read_write: true for read, false for write
* @offset: offset in NVRAM
* @buffer_size: size of buffer
* @buffer: buffer
@@ -639,6 +639,9 @@ out:
* efi_net_set_dhcp_ack() - take note of a selected DHCP IP address
*
* This function is called by dhcp_handler().
+ *
+ * @pkt: packet received by dhcp_handler()
+ * @len: length of the packet received
*/
void efi_net_set_dhcp_ack(void *pkt, int len)
{
@@ -668,8 +671,8 @@ static void efi_net_push(void *pkt, int len)
*
* This notification function is called in every timer cycle.
*
- * @event the event for which this notification function is registered
- * @context event context - not used in this function
+ * @event: the event for which this notification function is registered
+ * @context: event context - not used in this function
*/
static void EFIAPI efi_network_timer_notify(struct efi_event *event,
void *context)