diff options
Diffstat (limited to 'include/eoption.h')
| -rw-r--r-- | include/eoption.h | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/include/eoption.h b/include/eoption.h index 76b765505d..e1810f3f60 100644 --- a/include/eoption.h +++ b/include/eoption.h @@ -15,13 +15,27 @@ enum eoption_bool { EOPTION_BOOL_TEST = 0, /* Test option */ }; -/* Initialize the module. */ -int eoption_init(void); +/** + * Initialize the module. + */ +void eoption_init(void); -/* Return the current value of a boolean option. */ +/** + * Return the current value of a boolean option. + * + * @param opt Option to return + * @return 0 if option is false, 1 if true. + */ int eoption_get_bool(enum eoption_bool opt); -/* Set the value of a boolean option (0 = clear, non-zero=set). */ +/** + * Set the value of a boolean option + * + * @param opt Option to set + * @param value New value for option + * + * @return EC_SUCCESS, or non-zero if error. + */ int eoption_set_bool(enum eoption_bool opt, int value); #endif /* __CROS_EC_EOPTION_H */ |