Skip to content

Commit

Permalink
mgmt: hawkbit: some doc improvements
Browse files Browse the repository at this point in the history
some doc improvements in hawkbit.h.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
  • Loading branch information
maass-hamburg committed Apr 25, 2024
1 parent 15e4803 commit 55c4cdf
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions include/zephyr/mgmt/hawkbit.h
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,16 @@ typedef int (*hawkbit_config_device_data_cb_handler_t)(const char *device_id, ui
*
* @param cb The callback function.
*
* @return 0 on success.
* @return -EINVAL if the callback is NULL.
* @retval 0 on success.
* @retval -EINVAL if the callback is NULL.
*/
int hawkbit_set_custom_data_cb(hawkbit_config_device_data_cb_handler_t cb);

/**
* @brief Init the flash partition
*
* @return 0 on success, negative on error.
* @retval 0 on success.
* @retval -errno if init fails.
*/
int hawkbit_init(void);

Expand Down Expand Up @@ -139,12 +140,15 @@ int hawkbit_autohandler_set_delay(k_timeout_t timeout, bool if_bigger);
/**
* @brief The hawkBit probe verify if there is some update to be performed.
*
* @return HAWKBIT_UPDATE_INSTALLED has an update available.
* @return HAWKBIT_NO_UPDATE no update available.
* @return HAWKBIT_NETWORKING_ERROR fail to connect to the hawkBit server.
* @return HAWKBIT_METADATA_ERROR fail to parse or to encode the metadata.
* @return HAWKBIT_OK if success.
* @return HAWKBIT_DOWNLOAD_ERROR fail while downloading the update package.
* @retval HAWKBIT_OK if success.
* @retval HAWKBIT_NETWORKING_ERROR fail to connect to the hawkBit server.
* @retval HAWKBIT_UNCONFIRMED_IMAGE image is unconfirmed.
* @retval HAWKBIT_PERMISSION_ERROR fail to get the permission to access the hawkBit server.
* @retval HAWKBIT_METADATA_ERROR fail to parse or to encode the metadata.
* @retval HAWKBIT_DOWNLOAD_ERROR fail while downloading the update package.
* @retval HAWKBIT_UPDATE_INSTALLED has an update available.
* @retval HAWKBIT_NO_UPDATE no update available.
* @retval HAWKBIT_CANCEL_UPDATE update was cancelled.
*/
enum hawkbit_response hawkbit_probe(void);

Expand All @@ -168,8 +172,8 @@ typedef bool (*hawkbit_get_device_identity_cb_handler_t)(char *id, int id_max_le
*
* @param cb The callback function.
*
* @return 0 on success.
* @return -EINVAL if the callback is NULL.
* @retval 0 on success.
* @retval -EINVAL if the callback is NULL.
*/
int hawkbit_set_device_identity_cb(hawkbit_get_device_identity_cb_handler_t cb);

Expand Down

0 comments on commit 55c4cdf

Please sign in to comment.