storage: bm_storage: use errno instead of nrf_error

Use errnos for BM storage as it is not a BLE library or BLE subsystem.
Correct return values for BM ZMS.

Signed-off-by: Eivind Jølsgard <[email protected]>

Author: eivindj-nordic

doc/nrf-bm/release_notes/release_notes_changelog.rst

@@ -116,6 +116,11 @@ Libraries
      * All instances of ``pm_failure_evt_t`` to struct :c:struct:`pm_failure_evt` and removed the ``pm_failure_evt_t`` type.
      * All instances of ``pm_evt_t`` to struct :c:struct:`pm_evt` and removed the ``pm_evt_t`` type.
 
+* Storage library:
+
+  * Updated to use errno instead of nrf_errors.
+
+
 Samples
 =======
 

include/bm/storage/bm_storage.h

@@ -52,8 +52,8 @@ struct bm_storage_evt {
 	/* Specifies if the operation was performed synchronously or asynchronously. */
 	enum bm_storage_evt_dispatch_type dispatch_type;
 	/* Result of the operation.
-	 * NRF_SUCCESS on success.
-	 * A positive NRF error otherwise.
+	 * 0 on success.
+	 * A negative errno otherwise.
 	 */
 	uint32_t result;
 	/* Destination address where the operation was performed. */
@@ -143,12 +143,12 @@ struct bm_storage {
  *
  * @param[in] storage Storage instance to initialize.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_NULL If @p storage is @c NULL.
- * @retval NRF_ERROR_BUSY If the implementation-specific resource is busy.
- * @retval NRF_ERROR_INTERNAL If an implementation-specific internal error occurred.
+ * @retval 0 on success.
+ * @retval -EFAULT If @p storage is @c NULL.
+ * @retval -EBUSY If the implementation-specific resource is busy.
+ * @retval -EIO If an implementation-specific internal error occurred.
  */
-uint32_t bm_storage_init(struct bm_storage *storage);
+int bm_storage_init(struct bm_storage *storage);
 
 /**
  * @brief Uninitialize a storage instance.
@@ -158,13 +158,13 @@ uint32_t bm_storage_init(struct bm_storage *storage);
  *
  * @param[in] storage Storage instance to uninitialize.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_NULL If @p storage is @c NULL.
- * @retval NRF_ERROR_INVALID_STATE If @p storage is in an invalid state.
- * @retval NRF_ERROR_BUSY If the implementation-specific backend is busy with an ongoing operation.
- * @retval NRF_ERROR_NOT_SUPPORTED If the backend does not support uninitialization.
+ * @retval 0 on success.
+ * @retval -EFAULT If @p storage is @c NULL.
+ * @retval -EPERM If @p storage is in an invalid state.
+ * @retval -EBUSY If the implementation-specific backend is busy with an ongoing operation.
+ * @retval -ENOTSUP If the backend does not support uninitialization.
  */
-uint32_t bm_storage_uninit(struct bm_storage *storage);
+int bm_storage_uninit(struct bm_storage *storage);
 
 /**
  * @brief Read data from a storage instance.
@@ -174,16 +174,14 @@ uint32_t bm_storage_uninit(struct bm_storage *storage);
  * @param[out] dest Destination where the data will be copied to.
  * @param[in] len Length of the data to copy (in bytes).
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_NULL If @p storage is @c NULL.
- * @retval NRF_ERROR_INVALID_STATE If @p storage is in an invalid state.
- * @retval NRF_ERROR_INVALID_LENGTH If @p len is zero or not a multiple of
- *                                  @ref bm_storage_info.program_unit.
- * @retval NRF_ERROR_INVALID_ADDR If @p dest or @p src are not 32-bit word aligned, or if they are
- *                                outside the bounds of the memory region configured in @p storage.
- * @retval NRF_ERROR_FORBIDDEN If the implementation-specific backend has not been initialized.
+ * @retval 0 on success.
+ * @retval -EFAULT If @p storage is @c NULL or if @p dest or @p src are not 32-bit word aligned,
+ *                 or if they are outside the bounds of the memory region configured in @p storage.
+ * @retval -EPERM If @p storage is in an invalid state or if the implementation-specific backend
+ *                has not been initialized.
+ * @retval -EINVAL If @p len is zero or not a multiple of @ref bm_storage_info.program_unit.
  */
-uint32_t bm_storage_read(const struct bm_storage *storage, uint32_t src, void *dest, uint32_t len);
+int bm_storage_read(const struct bm_storage *storage, uint32_t src, void *dest, uint32_t len);
 
 /**
  * @brief Write data to a storage instance.
@@ -195,19 +193,17 @@ uint32_t bm_storage_read(const struct bm_storage *storage, uint32_t src, void *d
  * @param[in] ctx Pointer to user data, passed to the implementation-specific API function call.
  *                Can be NULL.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_NULL If @p storage is @c NULL.
- * @retval NRF_ERROR_INVALID_STATE If @p storage is in an invalid state.
- * @retval NRF_ERROR_INVALID_LENGTH If @p len is zero or not a multiple of
- *                                  @ref bm_storage_info.program_unit.
- * @retval NRF_ERROR_INVALID_ADDR If @p dest or @p src are not 32-bit word aligned, or if they are
- *                                outside the bounds of the memory region configured in @p storage.
- * @retval NRF_ERROR_FORBIDDEN If the implementation-specific backend has not been initialized.
- * @retval NRF_ERROR_BUSY If the implementation-specific backend is busy with an ongoing operation.
- * @retval NRF_ERROR_INTERNAL If an implementation-specific internal error occurred.
+ * @retval 0 on success.
+ * @retval -EFAULT If @p storage is @c NULL or if @p dest or @p src are not 32-bit word aligned,
+ *                 or if they are outside the bounds of the memory region configured in @p storage.
+ * @retval -EPERM If @p storage is in an invalid state or if the implementation-specific backend
+ *                has not been initialized.
+ * @retval -EINVAL If @p len is zero or not a multiple of @ref bm_storage_info.program_unit.
+ * @retval -EBUSY If the implementation-specific backend is busy with an ongoing operation.
+ * @retval -EIO If an implementation-specific internal error occurred.
  */
-uint32_t bm_storage_write(const struct bm_storage *storage, uint32_t dest, const void *src,
-			  uint32_t len, void *ctx);
+int bm_storage_write(const struct bm_storage *storage, uint32_t dest, const void *src,
+		     uint32_t len, void *ctx);
 
 /**
  * @brief Erase data in a storage instance.
@@ -216,19 +212,16 @@ uint32_t bm_storage_write(const struct bm_storage *storage, uint32_t dest, const
  * @param[in] ctx Pointer to user data, passed to the implementation-specific API function call.
  *                Can be NULL.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_NULL If @p storage is @c NULL.
- * @retval NRF_ERROR_INVALID_STATE If @p storage is in an invalid state.
- * @retval NRF_ERROR_INVALID_LENGTH If @p len is zero or not a multiple of
- *                                  @ref bm_storage_info.erase_unit.
- * @retval NRF_ERROR_INVALID_ADDR If @p addr is outside the bounds of the memory region configured
- *                                in @p storage.
- * @retval NRF_ERROR_FORBIDDEN If the implementation-specific backend has not been initialized.
- * @retval NRF_ERROR_BUSY If the implementation-specific backend is busy with an ongoing operation.
- * @retval NRF_ERROR_NOT_SUPPORTED If the implementation-specific backend does not implement this
- *                                 function.
+ * @retval 0 on success.
+ * @retval -EFAULT If @p storage is @c NULL or if @p addr is outside the bounds of the memory region
+ *                 configured in @p storage.
+ * @retval -EPERM If @p storage is in an invalid state or if the implementation-specific backend
+ *                has not been initialized.
+ * @retval -EINVAL If @p len is zero or not a multiple of @ref bm_storage_info.erase_unit.
+ * @retval -EBUSY If the implementation-specific backend is busy with an ongoing operation.
+ * @retval -ENOTSUP If the implementation-specific backend does not implement this function.
  */
-uint32_t bm_storage_erase(const struct bm_storage *storage, uint32_t addr, uint32_t len, void *ctx);
+int bm_storage_erase(const struct bm_storage *storage, uint32_t addr, uint32_t len, void *ctx);
 
 /**
  * @brief Query the status of a storage instance.

include/bm/storage/bm_storage_backend.h

@@ -24,57 +24,57 @@ extern "C" {
  *
  * @note This function must be defined by the backend.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_BUSY If the implementation-specific resource is busy.
- * @retval NRF_ERROR_INTERNAL If an implementation-specific internal error occurred.
+ * @retval 0 on success.
+ * @retval -EBUSY If the implementation-specific resource is busy.
+ * @retval -EIO If an implementation-specific internal error occurred.
  */
-uint32_t bm_storage_backend_init(struct bm_storage *storage);
+int bm_storage_backend_init(struct bm_storage *storage);
 /**
  * @brief Uninitialize the storage peripheral.
  *
  * @note This function is optional. If not defined in the backend, a weak implementation will return
- * NRF_ERROR_NOT_SUPPORTED.
+ * -ENOTSUP.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_BUSY If the implementation-specific backend is busy with an ongoing operation.
- * @retval NRF_ERROR_NOT_SUPPORTED If the backend does not support uninitialization.
+ * @retval 0 on success.
+ * @retval -EBUSY If the implementation-specific backend is busy with an ongoing operation.
+ * @retval -ENOTSUP If the backend does not support uninitialization.
  */
-uint32_t bm_storage_backend_uninit(struct bm_storage *storage);
+int bm_storage_backend_uninit(struct bm_storage *storage);
 /**
  * @brief Read data from non-volatile memory.
  *
  * @note This function must be defined by the backend.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_FORBIDDEN If the implementation-specific backend has not been initialized.
+ * @retval 0 on success.
+ * @retval -EPERM If the implementation-specific backend has not been initialized.
  */
-uint32_t bm_storage_backend_read(const struct bm_storage *storage, uint32_t src, void *dest,
-				 uint32_t len);
+int bm_storage_backend_read(const struct bm_storage *storage, uint32_t src, void *dest,
+			    uint32_t len);
 /**
  * @brief Write bytes to non-volatile memory.
  *
  * @note This function must be defined by the backend.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_FORBIDDEN If the implementation-specific backend has not been initialized.
- * @retval NRF_ERROR_BUSY If the implementation-specific backend is busy with an ongoing operation.
- * @retval NRF_ERROR_INTERNAL If an implementation-specific internal error occurred.
+ * @retval 0 on success.
+ * @retval -EPERM If the implementation-specific backend has not been initialized.
+ * @retval -EBUSY If the implementation-specific backend is busy with an ongoing operation.
+ * @retval -EIO If an implementation-specific internal error occurred.
  */
-uint32_t bm_storage_backend_write(const struct bm_storage *storage, uint32_t dest, const void *src,
-				  uint32_t len, void *ctx);
+int bm_storage_backend_write(const struct bm_storage *storage, uint32_t dest, const void *src,
+			     uint32_t len, void *ctx);
 /**
  * @brief Erase the non-volatile memory.
  *
  * @note This function is optional. If not defined in the backend, a weak implementation will return
- * NRF_ERROR_NOT_SUPPORTED.
+ * -ENOTSUP.
  *
- * @retval NRF_SUCCESS on success.
- * @retval NRF_ERROR_FORBIDDEN If the implementation-specific backend has not been initialized.
- * @retval NRF_ERROR_BUSY If the implementation-specific backend is busy with an ongoing operation.
- * @retval NRF_ERROR_NOT_SUPPORTED If the backend does not support erase.
+ * @retval 0 on success.
+ * @retval -EPERM If the implementation-specific backend has not been initialized.
+ * @retval -EBUSY If the implementation-specific backend is busy with an ongoing operation.
+ * @retval -ENOTSUP If the backend does not support erase.
  */
-uint32_t bm_storage_backend_erase(const struct bm_storage *storage, uint32_t addr, uint32_t len,
-				  void *ctx);
+int bm_storage_backend_erase(const struct bm_storage *storage, uint32_t addr, uint32_t len,
+			     void *ctx);
 /**
  * @brief Check if there are any pending operations.
  *

lib/bluetooth/ble_adv/ble_adv_data.c

@@ -391,7 +391,9 @@ static uint32_t manuf_specific_data_encode(const struct ble_adv_data_manufacture
 		return NRF_ERROR_DATA_SIZE;
 	}
 
-	/* There is only 1 byte intended to encode length which is (data_size + AD_TYPE_FIELD_SIZE) */
+	/* There is only 1 byte intended to encode length which is
+	 * (data_size + AD_TYPE_FIELD_SIZE)
+	 */
 	if (data_size > (0x00FF - AD_TYPE_FIELD_SIZE)) {
 		return NRF_ERROR_DATA_SIZE;
 	}