Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

libled: Add more API details #160

Merged
merged 1 commit into from
Aug 30, 2023
Merged

libled: Add more API details #160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/lib/include/led/libled.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,10 +314,11 @@ void LED_SYM_PUBLIC led_log_level_set(struct led_ctx *ctx, enum led_log_level_en
led_status_t LED_SYM_PUBLIC led_scan(struct led_ctx *ctx);

/**
* @brief Used to lookup a block device node to name used by library
* @brief Used to lookup a block device node to name used by library. This function should be
* called with its output being used as input for functions: led_is_management_supported, led_set.
*
* @param[in] name Device node to lookup
* @param[out] normalized_name Normalized device name
* @param[out] normalized_name Normalized device name, size >= PATH_MAX
* @return led_status_t LED_STATUS_SUCCESS on success, else error reason.
*
* Note: both parameters are expected to have a size of PATH_MAX
Expand All @@ -328,7 +329,7 @@ led_status_t LED_SYM_PUBLIC led_device_name_lookup(const char *name, char *norma
* @brief Given a block device path, returns if it has LED hardware support via library
*
* @param[in] ctx Library context
* @param[in] path Device path
* @param[in] path Device path, this is the result of led_device_name_lookup
* @return enum led_cntrl_type which indicates which controller supports this device path,
* LED_CNTRL_TYPE_UNKNOWN if not supported
*/
Expand All @@ -338,7 +339,7 @@ enum led_cntrl_type led_is_management_supported(struct led_ctx *ctx, const char
* @brief Set the ibpi pattern for the specified device
*
* @param[in] ctx Library context
* @param[in] path Device path
* @param[in] path Device path, this is the result of led_device_name_lookup
* @param[in] ibpi Current ibpi value
* @return led_status_t LED_STATUS_SUCCESS on success, else error reason.
*
Expand All @@ -348,7 +349,8 @@ led_status_t LED_SYM_PUBLIC led_set(struct led_ctx *ctx, const char *path,
enum led_ibpi_pattern ibpi);

/**
* @brief Flush the changes to hardware
* @brief Flush the changes to hardware, this function is required after calling 1 or more calls
* to led_set for the changes to take effect. This function is not needed when using the slot API.
*
* @param[in] ctx Library context
*/
Expand Down