Deprecated 2 functions.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@15587 27425a3e-05d8-49a3-a47f-9c15f0e5edd8

os/hal/include/hal_flash.h

@@ -388,9 +388,9 @@ extern "C" {
   flash_error_t  flashWaitErase(BaseFlash *devp);
   flash_offset_t flashGetSectorOffset(BaseFlash *devp, flash_sector_t sector);
   uint32_t       flashGetSectorSize(BaseFlash *devp, flash_sector_t sector);
+  flash_sector_t flashGetOffsetSector(BaseFlash *devp, flash_offset_t offset);
   void *         flashGetOffsetAddress(BaseFlash *devp, flash_offset_t offset);
   flash_offset_t flashGetAddressOffset(BaseFlash *devp, void * addr);
-  flash_sector_t flashGetOffsetSector(BaseFlash *devp, flash_offset_t offset);
 #ifdef __cplusplus
 }
 #endif

os/hal/src/hal_flash.c

@@ -55,6 +55,8 @@
  * @retval FLASH_NO_ERROR if there is no erase operation in progress.
  * @retval FLASH_ERROR_ERASE if the erase operation failed.
  * @retval FLASH_ERROR_HW_FAILURE if access to the memory failed.
+ *
+ * @api
  */
 flash_error_t flashWaitErase(BaseFlash *devp) {
 
@@ -78,8 +80,9 @@ flash_error_t flashWaitErase(BaseFlash *devp) {
  *
  * @param[in] devp      pointer to a @p BaseFlash object
  * @param[in] sector    flash sector number
+ * @return              Sector offset.
  *
- * @return the offset of the sector
+ * @api
  */
 flash_offset_t flashGetSectorOffset(BaseFlash *devp,
                                     flash_sector_t sector) {
@@ -103,8 +106,9 @@ flash_offset_t flashGetSectorOffset(BaseFlash *devp,
  *
  * @param[in] devp      pointer to a @p BaseFlash object
  * @param[in] sector    flash sector number
+ * @return              Sector size.
  *
- * @return the size of the sector
+ * @api
  */
 uint32_t flashGetSectorSize(BaseFlash *devp,
                             flash_sector_t sector) {
@@ -123,56 +127,16 @@ uint32_t flashGetSectorSize(BaseFlash *devp,
   return size;
 }
 
-/**
- * @brief   Get absolute address from offset
- *
- * @param[in] ip                    pointer to a @p BaseFlash or derived class
- * @param[in] offset                offset
- * @return                          A pointer to the offset
- *
- * @api
- */
-void * flashGetOffsetAddress(BaseFlash *devp, flash_offset_t offset) {
-    osalDbgCheck(devp != NULL);
-
-    const flash_descriptor_t *descriptor = flashGetDescriptor(devp);
-    osalDbgAssert(offset < descriptor->size, "invalid offset");
-
-    return (void *)((flash_offset_t)descriptor->address + offset);
-}
-
-/**
- * @brief   Get offset from absolute address
- *
- * @param[in] ip                    pointer to a @p BaseFlash or derived class
- * @param[in] addr                  pointer
- * @return                          offset
- *
- * @api
- */
-flash_offset_t flashGetAddressOffset(BaseFlash *devp, void * addr) {
-    osalDbgCheck(devp != NULL);
-
-    const flash_descriptor_t *descriptor = flashGetDescriptor(devp);
-    osalDbgAssert(((flash_offset_t)addr >=
-                (flash_offset_t)descriptor->address)
-            && ((flash_offset_t)addr <= (flash_offset_t)descriptor->address +
-                descriptor->size),
-            "invalid address");
-
-    return (flash_offset_t)addr - (flash_offset_t)descriptor->address;
-}
-
 /**
  * @brief   Returns the sector of an offset.
  *
  * @param[in] devp      pointer to a @p BaseFlash object
  * @param[in] offset    flash offset
+ * @return              Flash sector.
  *
- * @return the sector of the offset
+ * @api
  */
-flash_sector_t flashGetOffsetSector(BaseFlash *devp,
+flash_sector_t flashGetOffsetSector(BaseFlash *devp, flash_offset_t offset) {
-                                    flash_offset_t offset) {
   flash_sector_t sector, i;
   const flash_descriptor_t *descriptor = flashGetDescriptor(devp);
 
@@ -191,7 +155,7 @@ flash_sector_t flashGetOffsetSector(BaseFlash *devp,
     }
   }
   else {
-      sector = offset/descriptor->sectors_size;
+    sector = offset / descriptor->sectors_size;
     return sector;
   }
 
@@ -199,4 +163,42 @@ flash_sector_t flashGetOffsetSector(BaseFlash *devp,
 
   return 0;
 }
+
+/**
+ * @brief   Get absolute address from offset
+ *
+ * @param[in] ip                    pointer to a @p BaseFlash or derived class
+ * @param[in] offset                flash offset
+ * @return                          A pointer to the offset.
+ *
+ * @deprecated
+ */
+void *flashGetOffsetAddress(BaseFlash *devp, flash_offset_t offset) {
+  const flash_descriptor_t *descriptor = flashGetDescriptor(devp);
+
+  osalDbgAssert(offset < descriptor->size, "invalid offset");
+
+  return (void *)((flash_offset_t)descriptor->address + offset);
+}
+
+/**
+ * @brief   Get offset from absolute address
+ *
+ * @param[in] ip                    pointer to a @p BaseFlash or derived class
+ * @param[in] addr                  pointer
+ * @return                          flash offset
+ *
+ * @deprecated
+ */
+flash_offset_t flashGetAddressOffset(BaseFlash *devp, void *addr) {
+  const flash_descriptor_t *descriptor = flashGetDescriptor(devp);
+
+  osalDbgAssert(((flash_offset_t)addr >= (flash_offset_t)descriptor->address) &&
+                ((flash_offset_t)addr <= (flash_offset_t)descriptor->address +
+                                         descriptor->size),
+                "invalid address");
+
+  return (flash_offset_t)addr - (flash_offset_t)descriptor->address;
+}
+
 /** @} */