diff options
| author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2018-07-29 10:41:02 +0200 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2018-08-10 13:45:32 -0400 |
| commit | 938b05a5d796045a93a98ec17606c434c1339881 (patch) | |
| tree | c06b7d6f8cf250ed912be36ed4eed7b14a0763c2 /drivers/serial/serial.c | |
| parent | f43674cf8261ad5f39d8cb5f4316e559b876aa22 (diff) | |
drivers: serial: document on_baudrate()
Add parameter description.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'drivers/serial/serial.c')
| -rw-r--r-- | drivers/serial/serial.c | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/drivers/serial/serial.c b/drivers/serial/serial.c index c489deac2b..c499601f00 100644 --- a/drivers/serial/serial.c +++ b/drivers/serial/serial.c @@ -36,7 +36,15 @@ static void serial_null(void) /** * on_baudrate() - Update the actual baudrate when the env var changes * + * @name: changed environment variable + * @value: new value of the environment variable + * @op: operation (create, overwrite, or delete) + * @flags: attributes of environment variable change, + * see flags H_* in include/search.h + * * This will check for a valid baudrate and only apply it if valid. + * + * Return: 0 on success, 1 on error */ static int on_baudrate(const char *name, const char *value, enum env_op op, int flags) |