Commit 938b05a5d796045a93a98ec17606c434c1339881

Authored by Heinrich Schuchardt
Committed by Tom Rini
1 parent f43674cf82

drivers: serial: document on_baudrate()

Add parameter description.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Showing 1 changed file with 8 additions and 0 deletions Side-by-side Diff

drivers/serial/serial.c
... ... @@ -36,7 +36,15 @@
36 36 /**
37 37 * on_baudrate() - Update the actual baudrate when the env var changes
38 38 *
  39 + * @name: changed environment variable
  40 + * @value: new value of the environment variable
  41 + * @op: operation (create, overwrite, or delete)
  42 + * @flags: attributes of environment variable change,
  43 + * see flags H_* in include/search.h
  44 + *
39 45 * This will check for a valid baudrate and only apply it if valid.
  46 + *
  47 + * Return: 0 on success, 1 on error
40 48 */
41 49 static int on_baudrate(const char *name, const char *value, enum env_op op,
42 50 int flags)