Rename to DeviceNames enum to StorageDevices

Author: Alrik Vidstrom

extras/tests/Arduino_POSIXStorage_Test/Arduino_POSIXStorage_Test.ino

@@ -41,7 +41,7 @@ void usbCallback()
 
 void setup() {
   bool allTestsOk = true;
-  enum DeviceNames deviceName;
+  enum StorageDevices deviceName;
   int fileDescriptor = 0;
   int retVal = -1;
 

src/Arduino_POSIXStorage.cpp

@@ -235,7 +235,7 @@ enum BoardTypes detectBoardType()
 #endif
 }   // End of detectBoardType()
 
-void deleteDevice(const enum DeviceNames deviceName, struct DeviceFileSystemCombination * const deviceFileSystemCombination)
+void deleteDevice(const enum StorageDevices deviceName, struct DeviceFileSystemCombination * const deviceFileSystemCombination)
 {
   // The USBHostMSD class for the H7 doesn't correctly support object destruction, so we only delete
   // the device object on other platforms or if the device is an SD Card -->
@@ -258,7 +258,7 @@ void deleteDevice(const enum DeviceNames deviceName, struct DeviceFileSystemComb
 }   // End of deleteDevice()
 
 // WARNING: Don't set errno and return -1 in this function - just return 0 for success or the errno code!
-int mountOrFormatFileSystemOnDevice(const enum DeviceNames deviceName,
+int mountOrFormatFileSystemOnDevice(const enum StorageDevices deviceName,
                                     struct DeviceFileSystemCombination * const deviceFileSystemCombination,
                                     const enum FileSystems fileSystem,
                                     const char * const mountPoint,
@@ -476,7 +476,7 @@ int mountOrFormatUSBDevice(const enum FileSystems fileSystem,
 }   // End of mountOrFormatUSB()
 
 // WARNING: Don't set errno and return -1 in this function - just return 0 for success or the errno code!
-int mountOrFormat(const enum DeviceNames deviceName,
+int mountOrFormat(const enum StorageDevices deviceName,
                   const enum FileSystems fileSystem,
                   const enum ActionTypes mountOrFormat)
 {
@@ -509,7 +509,7 @@ int mountOrFormat(const enum DeviceNames deviceName,
 *********************************************************************************************************
 */
 
-int mount(const enum DeviceNames deviceName,
+int mount(const enum StorageDevices deviceName,
           const enum FileSystems fileSystem,
           const enum MountFlags mountFlags)
 {
@@ -528,7 +528,7 @@ int mount(const enum DeviceNames deviceName,
   return 0;
 }   // End of mount()
 
-int mkfs(const enum DeviceNames deviceName, const enum FileSystems fileSystem)
+int mkfs(const enum StorageDevices deviceName, const enum FileSystems fileSystem)
 {
   const int mountOrFormatReturn = mountOrFormat(deviceName, fileSystem, ACTION_FORMAT);
   if (0 != mountOrFormatReturn)
@@ -539,7 +539,7 @@ int mkfs(const enum DeviceNames deviceName, const enum FileSystems fileSystem)
   return 0;
 }   // End of mkfs()
 
-int umount(const enum DeviceNames deviceName)
+int umount(const enum StorageDevices deviceName)
 {
   struct DeviceFileSystemCombination *deviceFileSystemCombination = nullptr;
 
@@ -579,7 +579,7 @@ int umount(const enum DeviceNames deviceName)
   }
 }   // End of umount()
 
-int register_hotplug_callback(const enum DeviceNames deviceName, void (* const callbackFunction)())
+int register_hotplug_callback(const enum StorageDevices deviceName, void (* const callbackFunction)())
 {
   if (true == hotplugCallbackAlreadyRegistered)
   {
@@ -641,7 +641,7 @@ int register_hotplug_callback(const enum DeviceNames deviceName, void (* const c
 }   // End of hotplug_register_callback()
 
 // Not supported by the layer below on these platforms, but might be on other platforms
-int deregister_hotplug_callback(const enum DeviceNames deviceName)
+int deregister_hotplug_callback(const enum StorageDevices deviceName)
 {
   (void) deviceName;    // Remove when implemented, only here to silence -Wunused-parameter
   errno = ENOSYS;

src/Arduino_POSIXStorage.h

@@ -88,7 +88,7 @@
 *********************************************************************************************************
 */
 
-enum DeviceNames : uint8_t
+enum StorageDevices : uint8_t
 {
   DEV_SDCARD, ///< SD Card
   DEV_USB    ///< USB Thumb Drive
@@ -119,7 +119,7 @@ enum MountFlags : uint8_t
 * @param mountFlags The only valid flag at this time: MNT_DEFAULT.
 * @return On success: 0. On failure: -1 with an error code in the errno variable.
 */
-int mount(const enum DeviceNames deviceName,
+int mount(const enum StorageDevices deviceName,
           const enum FileSystems fileSystem,
           const enum MountFlags mountFlags);
 
@@ -128,29 +128,29 @@ int mount(const enum DeviceNames deviceName,
 * @param deviceName The device to remove from: DEV_SDCARD or DEV_USB.
 * @return On success: 0. On failure: -1 with an error code in the errno variable.
 */
-int umount(const enum DeviceNames deviceName);
+int umount(const enum StorageDevices deviceName);
 
 /**
 * @brief Register a hotplug callback function. Currently only supported for DEV_USB on Portenta C33.
 * @param deviceName The device to register for: DEV_SDCARD or DEV_USB.
 * @param callbackFunction A function pointer to the callback.
 * @return On success: 0. On failure: -1 with an error code in the errno variable.
 */
-int register_hotplug_callback(const enum DeviceNames deviceName, void (* const callbackFunction)());
+int register_hotplug_callback(const enum StorageDevices deviceName, void (* const callbackFunction)());
 
 /**
 * @brief Deregister a previously registered hotplug callback function. Not currently supported on any platform.
 * @param deviceName The device to deregister for: DEV_SDCARD or DEV_USB.
 * @return On success: 0. On failure: -1 with an error code in the errno variable.
 */
-int deregister_hotplug_callback(const enum DeviceNames deviceName);
+int deregister_hotplug_callback(const enum StorageDevices deviceName);
 
 /**
 * @brief Format a device (make file system).
 * @param deviceName The device to format: DEV_SDCARD or DEV_USB.
 * @param fileSystem The file system type to format: FS_FAT or FS_LITTLEFS. FS_FAT is probably the better choice for both SD Cards and USB thumb drives in most cases.
 * @return On success: 0. On failure: -1 with an error code in the errno variable.
 */
-int mkfs(const enum DeviceNames deviceName, const enum FileSystems fileSystem);
+int mkfs(const enum StorageDevices deviceName, const enum FileSystems fileSystem);
 
 #endif  // Arduino_POSIXStorage_H