mcumgr: img_mgmt: cut down

removed bm unneeded stuff

Signed-off-by: Mateusz Michalek <mateusz.michalek@nordicsemi.no>

Author: michalek-no

doc/nrf-bm/release_notes/release_notes_changelog.rst

@@ -58,7 +58,7 @@ Build system
 DFU
 ===
 
-Image upload NVM writes are handled in synchronization with SD.
+* Updated the image upload NVM writes to be handled in synchronization with SD.
 
 Interrupts
 ==========

subsys/mgmt/mcumgr/grp/img_mgmt/Kconfig

@@ -167,8 +167,8 @@ config MCUMGR_GRP_IMG_IMAGE_BUFFER_CHUNK_SZ
 	default 2048
 	range 16 4096
 	help
-	  This sets how much data is buffered before passing to non volatile memory.
-	  It has to be multiple of NVM write block size.
+	  This sets how much data is buffered before passing to non-volatile memory.
+	  It has to be a multiple of the NVM write block size.
 
 module = MCUMGR_GRP_IMG
 module-str = MCUMGR_GRP_IMG

subsys/mgmt/mcumgr/grp/img_mgmt/include/img_mgmt.h

@@ -191,16 +191,16 @@ enum img_mgmt_id_upload_t {
 };
 
 extern int boot_current_slot;
-extern struct img_mgmt_state g_img_mgmt_state;
+extern struct img_mgmt_state img_mgmt_state;
 
 /** Represents an individual upload request. */
 struct img_mgmt_upload_req {
-	uint32_t image;	/* 0 by default */
-	size_t off;	/* SIZE_MAX if unspecified */
-	size_t size;	/* SIZE_MAX if unspecified */
+	uint32_t image;			/**< 0 by default */
+	size_t off;			/**< SIZE_MAX if unspecified */
+	size_t size;			/**< SIZE_MAX if unspecified */
 	struct zcbor_string img_data;
 	struct zcbor_string data_sha;
-	bool upgrade;			/* Only allow greater version numbers. */
+	bool upgrade;			/**< Only allow greater version numbers. */
 };
 
 /** Global state for upload in progress. */
@@ -235,21 +235,21 @@ struct img_mgmt_upload_action {
 };
 
 /*
- * @brief Read info of an image at the specified slot number
+ * @brief Read info of an image at the specified slot number.
  *
- * @param image_slot	image slot number
- * @param ver		output buffer for image version
- * @param hash		output buffer for image hash
- * @param flags		output buffer for image flags
+ * @param image_slot	Image slot number.
+ * @param ver		Output buffer for image version.
+ * @param hash		Output buffer for image hash.
+ * @param flags		Output buffer for image flags.
  *
  * @return 0 on success, non-zero on failure.
  */
 int img_mgmt_read_info(int image_slot, struct image_version *ver, uint8_t *hash, uint32_t *flags);
 
 /**
- * @brief Get the image version of the currently running application.
+ * @brief Get the image version of the application running currently.
  *
- * @param ver		output buffer for an image version information object.
+ * @param ver		Output buffer for an image version information object.
  *
  * @return 0 on success, non-zero on failure.
  */
@@ -258,26 +258,26 @@ int img_mgmt_my_version(struct image_version *ver);
 /**
  * @brief Format version string from struct image_version
  *
- * @param ver		pointer to image_version object
- * @param dst		output buffer for image version string
+ * @param ver		Pointer to image_version object.
+ * @param dst		Output buffer for image version string.
  *
  * @return Non-negative on success, negative value on error.
  */
 int img_mgmt_ver_str(const struct image_version *ver, char *dst);
 
 /**
- * @brief Get active, running application slot number for an image
+ * @brief Get active, running application slot number for an image.
  *
- * @param image		image number to get active slot for.
+ * @param image		Image number to get active slot for.
  *
  * @return Non-negative slot number
  */
 int img_mgmt_active_slot(int image);
 
 /**
- * @brief Get active image number
+ * @brief Get active image number.
  *
- * Gets 0 based number for running application.
+ * Gets zero-based number for running application.
  *
  * @return Non-negative image number.
  */
@@ -286,11 +286,11 @@ int img_mgmt_active_image(void);
 /**
  * @brief Check if the image slot is in use.
  *
- * The check is based on MCUboot flags, not image contents. This means that
- * slot with image in it, but no bootable flags set, is considered empty.
+ * The check is based on MCUboot flags, not image contents. This means that the
+ * slot with an image in it, but no bootable flags set, is considered empty.
  * Active slot is always in use.
  *
- * @param slot		slot number
+ * @param slot		Slot number.
  *
  * @return 0 if slot is not used, non-0 otherwise.
  */
@@ -307,7 +307,7 @@ int img_mgmt_slot_in_use(int slot);
 int img_mgmt_state_any_pending(void);
 
 /**
- * @brief Returns state flags set to slot.
+ * @brief Return state flags set to the slot.
  *
  * Flags are translated from MCUboot image state flags.
  * Returned value is zero if no flags are set or a combination of:
@@ -316,29 +316,29 @@ int img_mgmt_state_any_pending(void);
  *  IMG_MGMT_STATE_F_ACTIVE
  *  IMG_MGMT_STATE_F_PERMANENT
  *
- * @param query_slot	slot number
+ * @param query_slot	Slot number.
  *
- * @return return the state flags.
+ * @return the state flags.
  *
  */
 uint8_t img_mgmt_state_flags(int query_slot);
 
 /**
- * @brief Sets the pending flag for the specified image slot.
+ * @brief Set the pending flag for the specified image slot.
  *
- * Sets specified image slot to be used as active slot during next boot,
- * either for test or permanently. Non-permanent image will be reverted
- * unless image confirms itself during next boot.
+ * Sets the specified image slot to be used as the active slot during next boot,
+ * either for test or permanently. A non-permanent image will be reverted
+ * unless the image confirms itself during next boot.
  *
- * @param slot		slot number
- * @param permanent	permanent or test only
+ * @param slot		Slot number.
+ * @param permanent	Permanent or test only.
  *
  * @return 0 on success, non-zero on failure
  */
 int img_mgmt_state_set_pending(int slot, int permanent);
 
 /**
- * @brief Confirms the current image state.
+ * @brief Confirm the current image state.
  *
  * Prevents a fallback from occurring on the next reboot if the active image
  * is currently being tested.
@@ -348,10 +348,10 @@ int img_mgmt_state_set_pending(int slot, int permanent);
 int img_mgmt_state_confirm(void);
 
 /**
- * Compares two image version numbers in a semver-compatible way.
+ * Compare two image version numbers in a semver-compatible way.
  *
- * @param a	The first version to compare
- * @param b	The second version to compare
+ * @param a	The first version to compare.
+ * @param b	The second version to compare.
  *
  * @return	-1 if a < b
  * @return	0 if a = b

subsys/mgmt/mcumgr/grp/img_mgmt/include/mgmt/mcumgr/grp/img_mgmt/img_mgmt_priv.h

@@ -27,37 +27,7 @@ extern "C" {
 #endif
 
 /**
- * @brief Ensures the spare slot (slot 1) is fully erased.
- *
- * @param slot		A slot to erase.
- *
- * @return 0 on success, MGMT_ERR_[...] code on failure.
- */
-int img_mgmt_erase_slot(int slot);
-
-/**
- * @brief Marks the image in the specified slot as pending. On the next reboot,
- * the system will perform a boot of the specified image.
- *
- * @param slot		The slot to mark as pending.  In the typical use case, this is 1.
- * @param permanent	Whether the image should be used permanently or only tested once:
- *				0=run image once, then confirm or revert.
- *				1=run image forever.
- *
- * @return 0 on success, MGMT_ERR_[...] code on failure.
- */
-int img_mgmt_write_pending(int slot, bool permanent);
-
-/**
- * @brief Marks the image in slot 0 as confirmed. The system will continue
- * booting into the image in slot 0 until told to boot from a different slot.
- *
- * @return 0 on success, MGMT_ERR_[...] code on failure.
- */
-int img_mgmt_write_confirmed(void);
-
-/**
- * @brief Reads the specified chunk of data from an image slot.
+ * @brief Read the specified chunk of data from an image slot.
  *
  * @param slot		The index of the slot to read from.
  * @param offset	The offset within the slot to read from.
@@ -69,7 +39,7 @@ int img_mgmt_write_confirmed(void);
 int img_mgmt_read(int slot, unsigned int offset, void *dst, unsigned int num_bytes);
 
 /**
- * @brief Writes the specified chunk of image data to slot 1.
+ * @brief Write the specified chunk of image data to slot 1.
  *
  * @param offset	The offset within slot 1 to write to.
  * @param data		The image data to write.
@@ -84,35 +54,9 @@ int img_mgmt_write_image_data(unsigned int offset, const void *data, unsigned in
 			      bool last);
 
 /**
- * @brief Indicates the type of swap operation that will occur on the next
- * reboot, if any, between provided slot and it's pair.
- * Querying any slots of the same pair will give the same result.
- *
- * @param slot                  An slot number;
- *
- * @return                      An IMG_MGMT_SWAP_TYPE_[...] code.
- */
-int img_mgmt_swap_type(int slot);
-
-/**
- * @brief Returns image that the given slot belongs to.
+ * @brief Get the slot number of an alternate (inactive) image pair.
  *
- * @param slot			A slot number.
- *
- * @return 0 based image number.
- */
-static inline int img_mgmt_slot_to_image(int slot)
-{
-	__ASSERT(slot >= 0 && slot < (CONFIG_MCUMGR_GRP_IMG_UPDATABLE_IMAGE_NUMBER << 1),
-		 "Impossible slot number");
-
-	return (slot >> 1);
-}
-
-/**
- * @brief Get slot number of alternate (inactive) image pair
- *
- * @param slot			A slot number.
+ * @param slot	A slot number.
  *
  * @return Number of other slot in pair
  */
@@ -137,27 +81,27 @@ enum img_mgmt_next_boot_type {
 };
 
 /**
- * @brief Get next boot slot number for a given image.
+ * @brief Get the next boot slot number for a given image.
  *
  * @param image			An image number.
- * @param type			Type of next boot
+ * @param type			Type of next boot.
  *
  * @return Number of slot, from pair of slots assigned to image, that will
- * boot on next reset. User needs to compare this slot against active slot
- * to check whether application image will change for the next boot.
- * @return -1 in case when next boot slot can not be established.
+ * boot on next reset. You need to compare this slot against an active slot
+ * to check whether the application image will change for the next boot.
+ * @return -1 if the next boot slot cannot be established.
  */
 int img_mgmt_get_next_boot_slot(int image, enum img_mgmt_next_boot_type *type);
 
 /**
- * Collects information about the specified image slot.
+ * Collect information about the specified image slot.
  *
  * @return Flags of the specified image slot
  */
 uint8_t img_mgmt_state_flags(int query_slot);
 
 /**
- * Erases image data at given offset
+ * Erase the image data at given offset.
  *
  * @param offset	The offset within slot 1 to erase at.
  * @param num_bytes	The number of bytes to erase.
@@ -167,24 +111,9 @@ uint8_t img_mgmt_state_flags(int query_slot);
 int img_mgmt_erase_image_data(unsigned int off, unsigned int num_bytes);
 
 /**
- * Erases a flash sector as image upload crosses a sector boundary.
- * Erasing the entire flash size at one time can take significant time,
- *   causing a bluetooth disconnect or significant battery sag.
- * Instead we will erase immediately prior to crossing a sector.
- * We could check for empty to increase efficiency, but instead we always erase
- *   for consistency and simplicity.
- *
- * @param off		Offset that is about to be written
- * @param len		Number of bytes to be written
- *
- * @return 0 if success ERROR_CODE if could not erase sector
- */
-int img_mgmt_erase_if_needed(uint32_t off, uint32_t len);
-
-/**
- * Verifies an upload request and indicates the actions that should be taken
+ * Verifies an upload request and indicates the actions to be taken
  * during processing of the request.  This is a "read only" function in the
- * sense that it doesn't write anything to flash and doesn't modify any global
+ * sense that it does not write anything to flash or modify any global
  * variables.
  *
  * @param req		The upload request to inspect.
@@ -197,26 +126,9 @@ int img_mgmt_erase_if_needed(uint32_t off, uint32_t len);
 int img_mgmt_upload_inspect(const struct img_mgmt_upload_req *req,
 			    struct img_mgmt_upload_action *action);
 
-/**
- * @brief	Takes the image management lock (if enabled) to prevent other
- *		threads interfering with an ongoing operation.
- */
-void img_mgmt_take_lock(void);
-
-/**
- * @brief	Releases the held image management lock (if enabled) to allow
- *		other threads to use image management operations.
- */
-void img_mgmt_release_lock(void);
-
 #define ERASED_VAL_32(x) (((x) << 24) | ((x) << 16) | ((x) << 8) | (x))
-int img_mgmt_erased_val(int slot, uint8_t *erased_val);
 
-int img_mgmt_find_by_hash(uint8_t *find, struct image_version *ver);
-int img_mgmt_find_by_ver(struct image_version *find, uint8_t *hash);
 int img_mgmt_state_read(struct smp_streamer *ctxt);
-int img_mgmt_state_write(struct smp_streamer *njb);
-int img_mgmt_flash_area_id(int slot);
 
 #ifdef __cplusplus
 }