feat(Examples): Add CLI Library to MSDK

Examples/MAX78000/SDHC_FTHR/Makefile

@@ -72,7 +72,7 @@ TARGET_LC := $(subst M,m,$(subst A,a,$(subst X,x,$(TARGET))))
 endif
 
 # Default board.
-BOARD ?= FTHR_RevA
+BOARD ?= EvKit_V1
 
 # *******************************************************************************
 # Locate the MaximSDK

Examples/MAX78000/SDHC_FTHR/README.md

@@ -1,5 +1,7 @@
 ## Description
 
+This example demonstrates the SDHC FAT Filesystem. The terminal prompts with a list of user-selectable tasks to run on the inserted Micro SD Card.
+
 ## Software
 
 ### Project Usage
@@ -8,4 +10,149 @@ Universal instructions on building, flashing, and debugging this project can be
 
 ### Project-Specific Build Notes
 
-* This project comes pre-configured for the MAX78000EVKIT.  See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the UG for instructions on changing the target board.
+* This project comes pre-configured for the MAX78000FTHR.  See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the UG for instructions on changing the target board.
+
+## Required Connections
+
+-   Connect a USB cable between the PC and the CN1 (USB/PWR) connector.
+-   Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1.
+-   Insert the SD card into the Micro SD Card Connector.
+
+## Expected Output
+
+```
+***** MAX78000 SDHC FAT Filesystem Example *****
+Card inserted.
+CLI Initialized! Enter 'help' to see a list of available commands.
+
+$ help
+help
+
+size:
+  Usage: size
+  Description: Find the Size of the SD Card and Free Space
+
+format:
+  Usage: format
+  Description: Format the Card
+
+mount:
+  Usage: mount
+  Description: Manually Mount Card
+
+ls:
+  Usage: ls
+  Description: list the contents of the current directory
+
+mkdir:
+  Usage: mkdir <directory name>
+  Description: Create a directory
+
+file_create:
+  Usage: file_create <file name> <number of bytes to add>
+  Description: Create a file of random data
+
+cd:
+  Usage: cd <directory name>
+  Description: Move into a directory
+
+add_data:
+  Usage: add_data <file name> <number of bytes to add>
+  Description: Add random Data to an Existing File
+
+del:
+  Usage: del <file name>
+  Description: Delete a file
+
+fatfs:
+  Usage: fatfs
+  Description: Format Card and Run Example of FatFS Operations
+
+unmount:
+  Usage: unmount
+  Description: Unmount card
+
+
+$ format
+format
+
+
+*****THE DRIVE WILL BE FORMATTED IN 5 SECONDS*****
+**************PRESS ANY KEY TO ABORT**************
+
+FORMATTING DRIVE
+Drive formatted.
+SD card mounted.
+SD card unmounted.
+
+$ size
+size
+SD card mounted.
+Disk Size: 7760896 bytes
+Available: 7760864 bytes
+
+$ mount
+mount
+SD card mounted.
+
+$ mkdir Analog_Devices
+mkdir Analog_Devices
+Creating directory...
+Directory Analog_Devices created.
+
+$ cd Analog_Devices
+cd Analog_Devices
+Changed to Analog_Devices
+
+$ file_create ADI 30
+file_create ADI 30
+Creating file ADI with length 30
+File opened!
+30 bytes written to file!
+File Closed!
+
+$ add_data ADI 25
+add_data ADI 25
+File opened!
+25 bytes written to file
+File closed.
+
+$ ls
+ls
+Listing Contents of 0:/Analog_Devices -
+0:/Analog_Devices/ADI
+
+Finished listing contents
+
+$ del ADI
+del ADI
+Deleted file ADI
+
+$ fatfs
+fatfs
+
+
+*****THE DRIVE WILL BE FORMATTED IN 5 SECONDS*****
+**************PRESS ANY KEY TO ABORT**************
+
+FORMATTING DRIVE
+Drive formatted.
+SD card mounted.
+SD card unmounted.
+SD card mounted.
+SD Card Opened!
+File opened!
+256 bytes written to file!
+File Closed!
+Creating Directory...
+Renaming File...
+Attempting to read back file...
+Read Back 256 bytes
+Message: sjVNXdwfl-owoXGcTZ,5z,Sy8lfsNqDGrzio'O6vntRMoWODcIKP!C'y7tF.'W88ZjR81BpiibPhokQfa3w'cvmnr0EgE1MNDIhXKfBJGP6b?0tvHEPK-WNc7yuPdFNL6FPq10',Q,GSf3jSyY?MU0wv'FToTI!ct.E6Q4nbVuavg6h'48D5sR5mcepxf1l!MesddI7aZ9s?KIVnybRwZ.UBJpX1b?5oXP9wLKZcgW-k,gZ5HMIMwAcy!n9S?E57Analog_Devices
+File Closed!
+
+$ unmount
+unmount
+SD card unmounted.
+```
+

Examples/MAX78000/SDHC_FTHR/include/sdhc.h

@@ -0,0 +1,83 @@
+/******************************************************************************
+ * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+ * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Except as contained in this notice, the name of Maxim Integrated
+ * Products, Inc. shall not be used except as stated in the Maxim Integrated
+ * Products, Inc. Branding Policy.
+ *
+ * The mere transfer of this software does not imply any licenses
+ * of trade secrets, proprietary technology, copyrights, patents,
+ * trademarks, maskwork rights, or any other form of intellectual
+ * property whatsoever. Maxim Integrated Products, Inc. retains all
+ * ownership rights.
+ *
+ ******************************************************************************/
+#ifndef SDHC_HEADER
+#define SDHC_HEADER
+
+/***** Includes *****/
+#include <stdio.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "board.h"
+#include "mxc_delay.h"
+#include "mxc_device.h"
+#include "gpio.h"
+#include "uart.h"
+#include "ff.h"
+
+/***** Definitions *****/
+
+#define STRINGIFY(x) #x
+#define TOSTRING(x) STRINGIFY(x)
+#define MAXLEN 256
+
+/***** FUNCTION PROTOTYPES *****/
+
+void generateMessage(unsigned length);
+
+int mount();
+
+int umount();
+
+int formatSDHC();
+
+int getSize();
+
+int ls();
+
+int createFile(char *file_name, unsigned int length);
+
+int appendFile(char *file_name, unsigned int length);
+
+int mkdir(char *dir_name);
+
+int cd(char *dir_name);
+
+int delete (char *file_name);
+
+int example();
+
+void waitCardInserted();
+
+#endif //SDHC_HEADER

Examples/MAX78000/SDHC_FTHR/include/user-cli.h

@@ -0,0 +1,69 @@
+/******************************************************************************
+ * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+ * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Except as contained in this notice, the name of Maxim Integrated
+ * Products, Inc. shall not be used except as stated in the Maxim Integrated
+ * Products, Inc. Branding Policy.
+ *
+ * The mere transfer of this software does not imply any licenses
+ * of trade secrets, proprietary technology, copyrights, patents,
+ * trademarks, maskwork rights, or any other form of intellectual
+ * property whatsoever. Maxim Integrated Products, Inc. retains all
+ * ownership rights.
+ *
+ ******************************************************************************/
+#ifndef USER_CLI_H
+#define USER_CLI_H
+
+/* -------------------------------------------------- */
+//                GLOBAL VARIABLE
+/* -------------------------------------------------- */
+extern const command_t user_commands[];
+extern const unsigned int num_user_commands;
+
+/* -------------------------------------------------- */
+//             FUNCTION PROTOTYPES
+/* -------------------------------------------------- */
+void CLI_IRQHandler(void);
+
+int handle_size(int argc, char *argv[]);
+
+int handle_format(int argc, char *argv[]);
+
+int handle_mount(int argc, char *argv[]);
+
+int handle_ls(int argc, char *argv[]);
+
+int handle_mkdir(int argc, char *argv[]);
+
+int handle_createfile(int argc, char *argv[]);
+
+int handle_cd(int argc, char *argv[]);
+
+int handle_add_data(int argc, char *argv[]);
+
+int handle_del(int argc, char *argv[]);
+
+int handle_fatfs(int argc, char *argv[]);
+
+int handle_unmount(int argc, char *argv[]);
+
+#endif /* USER_CLI_H */