feat(Examples): Add CLI Library to MSDK

Examples/MAX78000/SDHC_FTHR/.vscode/settings.json

@@ -69,10 +69,20 @@
         "${config:MAXIM_PATH}/Libraries/SDHC/ff14/Source"
     ],
     "C_Cpp.default.defines": [
-
+        "${config:board}",
+        "TARGET=${config:target}",
+        "TARGET_REV=0x4131",
+        "__GNUC__"
     ],
-    "C_Cpp.default.forcedInclude": [
-        "${workspaceFolder}/build/project_defines.h"
-    ]
+    "files.associations": {
+        "stdint.h": "c",
+        "cli.h": "c",
+        "sdhc.h": "c",
+        "user-cli.h": "c",
+        "uart.h": "c",
+        "nvic_table.h": "c",
+        "cstdlib": "c",
+        "adc_reva.h": "c"
+    }
 }
 

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,92 @@ 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.
+$ Help
+
+Size --> Find the Size of the SD Card and Free Space
+Format --> Format the Card
+Mount --> Manually Mount Card
+ls --> list the contents of the current directory
+mkdir --> Create a directory
+file_create --> Create a file of random data
+cd --> Move into a directory
+add_data --> Add random Data to an Existing File
+Del --> Delete a file
+FatFs --> Format Card and Run Example of FatFS Operations
+Unmount --> Unmount card
+Help --> Prints a help message with info about all of the supported commands.
+$ SIZE
+SD card mounted.
+Disk Size: 31163072 bytes
+Available: 31163008 bytes
+$ Format
+
+
+*****THE DRIVE WILL BE FORMATTED IN 5 SECONDS*****
+**************PRESS ANY KEY TO ABORT**************
+
+FORMATTING DRIVE
+Drive formatted.
+SD card mounted.
+SD card unmounted.
+$ mount
+SD card mounted.
+$ mkdir Analog_Devices
+Creating directory...
+Directory Analog_Devices created.
+$ cd Analog_Devices
+Changed to Analog_Devices
+$ file_create Maxim 30
+Creating file Maxim with length 30
+File opened!
+30 bytes written to file!
+File Closed!
+$ add_data Maxim 25
+File opened!
+25 bytes written to file
+File closed.
+$ ls
+Listing Contents of 0:/Analog_Devices -
+0:/Analog_Devices/Maxim
+
+Finished listing contents
+$ Del Maxim
+Deleted file Maxim
+$ 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: StiUH7-HxP!fffB,q.DqMnI2nvSnchst.ZaLTpG'w8I7Tg0,l6VVkEsehp#IHSMZN94WDc'N#-0qkBlAil,'#DvMJZ!zzf,j?Lm,H5cbfFfVNHUlPF9GsTWbrop0EG7VV57qZZzjdvzJH5Xh2'82'fz9t#R,kzoaqYBJVRhrlD5W1mZItggYqyIICUvWOOppJQIVvt.BR0Vy4#YwqiNYj'jYnX8j7ePtuzJO?t-sTCGvibwYn81?Sutq'Q0s7udL
+File Closed!
+$ unmount
+SD card unmounted.
+```
+

Examples/MAX78000/SDHC_FTHR/include/sdhc.h

@@ -0,0 +1,85 @@
+/******************************************************************************
+ * 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"
+#include "cli.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