Documnent changes and adding const to get_type method

ARMmbed · Dec 23, 2018 · b17d13e · b17d13e
1 parent 9590441
commit b17d13e
Show file tree

Hide file tree

Showing 34 changed files with 43 additions and 36 deletions.
diff --git a/components/storage/blockdevice/COMPONENT_DATAFLASH/DataFlashBlockDevice.cpp b/components/storage/blockdevice/COMPONENT_DATAFLASH/DataFlashBlockDevice.cpp
@@ -527,7 +527,7 @@ bd_size_t DataFlashBlockDevice::size() const
     return device_size;
 }
 
-const char *DataFlashBlockDevice::get_type()
+const char *DataFlashBlockDevice::get_type() const
 {
     return "DATAFLASH";
 }

diff --git a/components/storage/blockdevice/COMPONENT_DATAFLASH/DataFlashBlockDevice.h b/components/storage/blockdevice/COMPONENT_DATAFLASH/DataFlashBlockDevice.h
@@ -157,7 +157,7 @@ class DataFlashBlockDevice : public mbed::BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     // Master side hardware

diff --git a/components/storage/blockdevice/COMPONENT_FLASHIAP/FlashIAPBlockDevice.cpp b/components/storage/blockdevice/COMPONENT_FLASHIAP/FlashIAPBlockDevice.cpp
@@ -248,7 +248,7 @@ bd_size_t FlashIAPBlockDevice::size() const
     return _size;
 }
 
-const char *FlashIAPBlockDevice::get_type()
+const char *FlashIAPBlockDevice::get_type() const
 {
     return "FLASHIAP";
 }

diff --git a/components/storage/blockdevice/COMPONENT_FLASHIAP/FlashIAPBlockDevice.h b/components/storage/blockdevice/COMPONENT_FLASHIAP/FlashIAPBlockDevice.h
@@ -125,7 +125,7 @@ class FlashIAPBlockDevice : public mbed::BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     // Device configuration

diff --git a/components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.cpp b/components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.cpp
@@ -477,7 +477,7 @@ bd_size_t QSPIFBlockDevice::get_erase_size() const
     return _min_common_erase_size;
 }
 
-const char *QSPIFBlockDevice::get_type()
+const char *QSPIFBlockDevice::get_type() const
 {
     return "QSPIF";
 }

diff --git a/components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.h b/components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.h
@@ -215,7 +215,7 @@ class QSPIFBlockDevice : public mbed::BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     // Internal functions

diff --git a/components/storage/blockdevice/COMPONENT_RSPIF/SPIFReducedBlockDevice.cpp b/components/storage/blockdevice/COMPONENT_RSPIF/SPIFReducedBlockDevice.cpp
@@ -344,7 +344,7 @@ bd_size_t SPIFReducedBlockDevice::size() const
     return _size;
 }
 
-const char *SPIFReducedBlockDevice::get_type()
+const char *SPIFReducedBlockDevice::get_type() const
 {
     return "SPIFR";
 }

diff --git a/components/storage/blockdevice/COMPONENT_RSPIF/SPIFReducedBlockDevice.h b/components/storage/blockdevice/COMPONENT_RSPIF/SPIFReducedBlockDevice.h
@@ -159,7 +159,7 @@ class SPIFReducedBlockDevice : public mbed::BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     // Master side hardware

diff --git a/components/storage/blockdevice/COMPONENT_SD/SDBlockDevice.cpp b/components/storage/blockdevice/COMPONENT_SD/SDBlockDevice.cpp
@@ -632,7 +632,7 @@ bd_size_t SDBlockDevice::size() const
     return _block_size * _sectors;
 }
 
-const char *SDBlockDevice::get_type()
+const char *SDBlockDevice::get_type() const
 {
     return "SD";
 }

diff --git a/components/storage/blockdevice/COMPONENT_SD/SDBlockDevice.h b/components/storage/blockdevice/COMPONENT_SD/SDBlockDevice.h
@@ -120,7 +120,7 @@ class SDBlockDevice : public mbed::BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     /* Commands : Listed below are commands supported

diff --git a/components/storage/blockdevice/COMPONENT_SPIF/SPIFBlockDevice.cpp b/components/storage/blockdevice/COMPONENT_SPIF/SPIFBlockDevice.cpp
@@ -472,7 +472,7 @@ int SPIFBlockDevice::get_erase_value() const
     return 0xFF;
 }
 
-const char *SPIFBlockDevice::get_type()
+const char *SPIFBlockDevice::get_type() const
 {
     return "SPIF";
 }

diff --git a/components/storage/blockdevice/COMPONENT_SPIF/SPIFBlockDevice.h b/components/storage/blockdevice/COMPONENT_SPIF/SPIFBlockDevice.h
@@ -193,7 +193,7 @@ class SPIFBlockDevice : public mbed::BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
 

diff --git a/docs/design-documents/features/storage/BlockDevices/get_type_method.md b/docs/design-documents/features/storage/BlockDevices/get_type_method.md
@@ -34,23 +34,23 @@ In fact it might be worth to consider adding the get_type to any interface with
 ## Dive into details
 we should add the following method to BlockDevice interface class.
 
-```virtual const char * get_type() = 0;```
+```virtual const char * get_type() const = 0;```
 
 then every physical BlockDevice class which implements the interface should also implement this method and return a string 
 representing its type. Furthermore, a nonphysical BlockDevice like SlicingBlockDevice should return the underlying physical 
 BlockDevice type.
 
 ### Physical BlockDevice:
 ```
-const char * HeapBlockDevice::get_type()
+const char * HeapBlockDevice::get_type() const
 {
     return "HEAP";
 }
 ```
 
 ### Logical BlockDevice:
 ```
-const char * SlicingBlockDevice::get_type()
+const char * SlicingBlockDevice::get_type() const
 {
     if (_bd != NULL) {
      return _bd->get_type();
@@ -60,6 +60,12 @@ const char * SlicingBlockDevice::get_type()
 }
 ```
 
+### Open issue
+The ChainingBlockDevice which chains different type of physical block devices into one block device is unable
+to return the underneath physical as it contains two or more types. Therefore it will return CHAINING as its 
+identity and its left for the user to decide how the application will treat this information.
+
+
 The below table describes physical BlockDevice and its tyep names
 
 
@@ -72,3 +78,4 @@ The below table describes physical BlockDevice and its tyep names
 | SDBlockDevice               | "SD"               |
 | FlashIAPBlockDevice         | "FLASHIAP"         |
 | DataFlashBlockDevice        | "DATAFLASH"        |
+| ChainingBlockDevice         | "CHAINING"         |
diff --git a/features/storage/blockdevice/BlockDevice.h b/features/storage/blockdevice/BlockDevice.h
@@ -238,7 +238,7 @@ class BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type() = 0;
+    virtual const char *get_type() const = 0;
 };
 
 } // namespace mbed

diff --git a/features/storage/blockdevice/BufferedBlockDevice.cpp b/features/storage/blockdevice/BufferedBlockDevice.cpp
@@ -330,7 +330,7 @@ bd_size_t BufferedBlockDevice::size() const
     return _bd_size;
 }
 
-const char *BufferedBlockDevice::get_type()
+const char *BufferedBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/BufferedBlockDevice.h b/features/storage/blockdevice/BufferedBlockDevice.h
@@ -156,7 +156,7 @@ class BufferedBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 protected:
     BlockDevice *_bd;

diff --git a/features/storage/blockdevice/ChainingBlockDevice.cpp b/features/storage/blockdevice/ChainingBlockDevice.cpp
@@ -283,7 +283,7 @@ bd_size_t ChainingBlockDevice::size() const
     return _size;
 }
 
-const char *ChainingBlockDevice::get_type()
+const char *ChainingBlockDevice::get_type() const
 {
     return "CHAINING";
 }

diff --git a/features/storage/blockdevice/ChainingBlockDevice.h b/features/storage/blockdevice/ChainingBlockDevice.h
@@ -176,7 +176,7 @@ class ChainingBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 protected:
     BlockDevice **_bds;

diff --git a/features/storage/blockdevice/ExhaustibleBlockDevice.cpp b/features/storage/blockdevice/ExhaustibleBlockDevice.cpp
@@ -194,7 +194,7 @@ bd_size_t ExhaustibleBlockDevice::size() const
     return _bd->size();
 }
 
-const char *ExhaustibleBlockDevice::get_type()
+const char *ExhaustibleBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/ExhaustibleBlockDevice.h b/features/storage/blockdevice/ExhaustibleBlockDevice.h
@@ -158,7 +158,7 @@ class ExhaustibleBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     BlockDevice *_bd;

diff --git a/features/storage/blockdevice/FlashSimBlockDevice.cpp b/features/storage/blockdevice/FlashSimBlockDevice.cpp
@@ -212,7 +212,7 @@ int FlashSimBlockDevice::get_erase_value() const
     return _erase_value;
 }
 
-const char *FlashSimBlockDevice::get_type()
+const char *FlashSimBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/FlashSimBlockDevice.h b/features/storage/blockdevice/FlashSimBlockDevice.h
@@ -140,7 +140,7 @@ class FlashSimBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     uint8_t _erase_value;

diff --git a/features/storage/blockdevice/HeapBlockDevice.cpp b/features/storage/blockdevice/HeapBlockDevice.cpp
@@ -183,7 +183,7 @@ int HeapBlockDevice::erase(bd_addr_t addr, bd_size_t size)
     return 0;
 }
 
-const char *HeapBlockDevice::get_type()
+const char *HeapBlockDevice::get_type() const
 {
     return "HEAP";
 }

diff --git a/features/storage/blockdevice/HeapBlockDevice.h b/features/storage/blockdevice/HeapBlockDevice.h
@@ -154,7 +154,7 @@ class HeapBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     bd_size_t _read_size;

diff --git a/features/storage/blockdevice/MBRBlockDevice.cpp b/features/storage/blockdevice/MBRBlockDevice.cpp
@@ -423,7 +423,7 @@ int MBRBlockDevice::get_partition_number() const
     return _part;
 }
 
-const char *MBRBlockDevice::get_type()
+const char *MBRBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/MBRBlockDevice.h b/features/storage/blockdevice/MBRBlockDevice.h
@@ -253,7 +253,7 @@ class MBRBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 protected:
     BlockDevice *_bd;

diff --git a/features/storage/blockdevice/ObservingBlockDevice.cpp b/features/storage/blockdevice/ObservingBlockDevice.cpp
@@ -111,7 +111,7 @@ bd_size_t ObservingBlockDevice::size() const
     return _bd->size();
 }
 
-const char *ObservingBlockDevice::get_type()
+const char *ObservingBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/ObservingBlockDevice.h b/features/storage/blockdevice/ObservingBlockDevice.h
@@ -144,7 +144,7 @@ class ObservingBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     BlockDevice *_bd;

diff --git a/features/storage/blockdevice/ProfilingBlockDevice.cpp b/features/storage/blockdevice/ProfilingBlockDevice.cpp
@@ -121,7 +121,7 @@ bd_size_t ProfilingBlockDevice::get_erase_count() const
     return _erase_count;
 }
 
-const char *ProfilingBlockDevice::get_type()
+const char *ProfilingBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/ProfilingBlockDevice.h b/features/storage/blockdevice/ProfilingBlockDevice.h
@@ -183,7 +183,7 @@ class ProfilingBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     BlockDevice *_bd;

diff --git a/features/storage/blockdevice/ReadOnlyBlockDevice.cpp b/features/storage/blockdevice/ReadOnlyBlockDevice.cpp
@@ -101,7 +101,7 @@ bd_size_t ReadOnlyBlockDevice::size() const
     return _bd->size();
 }
 
-const char *ReadOnlyBlockDevice::get_type()
+const char *ReadOnlyBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/ReadOnlyBlockDevice.h b/features/storage/blockdevice/ReadOnlyBlockDevice.h
@@ -137,7 +137,7 @@ class ReadOnlyBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 private:
     BlockDevice *_bd;

diff --git a/features/storage/blockdevice/SlicingBlockDevice.cpp b/features/storage/blockdevice/SlicingBlockDevice.cpp
@@ -121,7 +121,7 @@ bd_size_t SlicingBlockDevice::size() const
     return _stop - _start;
 }
 
-const char *SlicingBlockDevice::get_type()
+const char *SlicingBlockDevice::get_type() const
 {
     if (_bd != NULL) {
         return _bd->get_type();

diff --git a/features/storage/blockdevice/SlicingBlockDevice.h b/features/storage/blockdevice/SlicingBlockDevice.h
@@ -167,7 +167,7 @@ class SlicingBlockDevice : public BlockDevice {
      *
      *  @return         A string represent the BlockDevice class type.
      */
-    virtual const char *get_type();
+    virtual const char *get_type() const;
 
 protected:
     BlockDevice *_bd;