STM32F3: flash_api typos

Author: bcostm

targets/TARGET_STM/TARGET_STM32F3/flash_api.c

@@ -21,14 +21,28 @@
 #include "mbed_assert.h"
 #include "cmsis.h"
 
-#define NUM_PAGES_IN_SECTOR  (1U)
-#define FLASH_SIZE           (uint32_t)(*((uint16_t *)FLASHSIZE_BASE) * 1024U)
+#ifndef FLASH_SIZE
+#define FLASH_SIZE (uint32_t)(*((uint16_t *)FLASHSIZE_BASE) * 1024U)
+#endif
+
+// Minimum number of bytes to be programmed at a time
+#define MIN_PROG_SIZE (4U)
 
+/** Initialize the flash peripheral and the flash_t object
+ *
+ * @param obj The flash object
+ * @return 0 for success, -1 for error
+ */
 int32_t flash_init(flash_t *obj)
 {
     return 0;
 }
 
+/** Uninitialize the flash peripheral and the flash_t object
+ *
+ * @param obj The flash object
+ * @return 0 for success, -1 for error
+ */
 int32_t flash_free(flash_t *obj)
 {
     return 0;
@@ -55,6 +69,13 @@ static int32_t flash_lock(void)
     }
 }
 
+/** Erase one sector starting at defined address
+ *
+ * The address should be at sector boundary. This function does not do any check for address alignments
+ * @param obj The flash object
+ * @param address The sector starting address
+ * @return 0 for success, -1 for error
+ */
 int32_t flash_erase_sector(flash_t *obj, uint32_t address)
 {
     uint32_t PAGEError = 0;
@@ -70,11 +91,12 @@ int32_t flash_erase_sector(flash_t *obj, uint32_t address)
     }
 
     __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_EOP | FLASH_FLAG_WRPERR);
+
     /* MBED HAL erases 1 sector at a time */
     /* Fill EraseInit structure*/
     EraseInitStruct.TypeErase   = FLASH_TYPEERASE_PAGES;
     EraseInitStruct.PageAddress = address;
-    EraseInitStruct.NbPages     = NUM_PAGES_IN_SECTOR;
+    EraseInitStruct.NbPages     = 1;
 
     /* Note: If an erase operation in Flash memory also concerns data in the data or instruction cache,
      you have to make sure that these data are rewritten before they are accessed during code
@@ -88,9 +110,19 @@ int32_t flash_erase_sector(flash_t *obj, uint32_t address)
     flash_lock();
 
     return status;
-
 }
 
+/** Program one page starting at defined address
+ *
+ * The page should be at page boundary, should not cross multiple sectors.
+ * This function does not do any check for address alignments or if size
+ * is aligned to a page size.
+ * @param obj The flash object
+ * @param address The sector starting address
+ * @param data The data buffer to be programmed
+ * @param size The number of bytes to program
+ * @return 0 for success, -1 for error
+ */
 int32_t flash_program_page(flash_t *obj, uint32_t address,
         const uint8_t *data, uint32_t size)
 {
@@ -101,8 +133,7 @@ int32_t flash_program_page(flash_t *obj, uint32_t address,
         return -1;
     }
 
-    if ((size % 4) != 0) {
-        /* F3 flash devices can only be programmed 32bits/4 bytes at a time */
+    if ((size % MIN_PROG_SIZE) != 0) {
         return -1;
     }
 
@@ -113,27 +144,27 @@ int32_t flash_program_page(flash_t *obj, uint32_t address,
     /* Program the user Flash area word by word */
     StartAddress = address;
 
-    /*  HW needs an aligned address to program flash, which data
-     *  parameters doesn't ensure  */
+    /* HW needs an aligned address to program flash, which data parameter doesn't ensure */
     if ((uint32_t) data % 4 != 0) {
+
         volatile uint32_t data32;
         while (address < (StartAddress + size) && (status == 0)) {
-            for (uint8_t i =0; i < 4; i++) {
+            for (uint8_t i = 0; i < MIN_PROG_SIZE; i++) {
                 *(((uint8_t *) &data32) + i) = *(data + i);
             }
 
             if (HAL_FLASH_Program(FLASH_TYPEPROGRAM_WORD, address, data32) == HAL_OK) {
-                address = address + 4;
-                data = data + 4;
+                address = address + MIN_PROG_SIZE;
+                data = data + MIN_PROG_SIZE;
             } else {
                 status = -1;
             }
         }
     } else { /*  case where data is aligned, so let's avoid any copy */
         while ((address < (StartAddress + size)) && (status == 0)) {
             if (HAL_FLASH_Program(FLASH_TYPEPROGRAM_WORD, address, *((uint32_t*) data)) == HAL_OK) {
-                address = address + 4;
-                data = data + 4;
+                address = address + MIN_PROG_SIZE;
+                data = data + MIN_PROG_SIZE;
             } else {
                 status = -1;
             }
@@ -145,26 +176,47 @@ int32_t flash_program_page(flash_t *obj, uint32_t address,
     return status;
 }
 
+/** Get sector size
+ *
+ * @param obj The flash object
+ * @param address The sector starting address
+ * @return The size of a sector (in our case considering 1 sector = 1 page)
+ */
 uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address) 
 {
     if (!(IS_FLASH_PROGRAM_ADDRESS(address))) {
         return MBED_FLASH_INVALID_SIZE;
     } else {
-        return (NUM_PAGES_IN_SECTOR * FLASH_PAGE_SIZE);
+        return FLASH_PAGE_SIZE;
     }
 }
 
+/** Get page size
+ *
+ * @param obj The flash object
+ * @param address The page starting address
+ * @return The size of a page (in our case the minimum programmable size)
+ */
 uint32_t flash_get_page_size(const flash_t *obj)
 {
-    /* Page size is the minimum programmable size, which is 4 bytes */
-    return 4;
+    return MIN_PROG_SIZE;
 }
 
+/** Get start address for the flash region
+ *
+ * @param obj The flash object
+ * @return The start address for the flash region
+ */
 uint32_t flash_get_start_address(const flash_t *obj) 
 {
     return FLASH_BASE;
 }
 
+/** Get the flash region size
+ *
+ * @param obj The flash object
+ * @return The flash region size
+ */
 uint32_t flash_get_size(const flash_t *obj) 
 {
     return FLASH_SIZE;