//***************************************************************************** // // sd_card.c - Example program for reading files from an SD card. // // Copyright (c) 2011-2014 Texas Instruments Incorporated. All rights reserved. // Software License Agreement // // Texas Instruments (TI) is supplying this software for use solely and // exclusively on TI's microcontroller products. The software is owned by // TI and/or its suppliers, and is protected under applicable copyright // laws. You may not combine this software with "viral" open-source // software in order to form a larger program. // // THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS. // NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT // NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY // CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL // DAMAGES, FOR ANY REASON WHATSOEVER. // // This is part of revision 2.1.0.12573 of the EK-LM4F232 Firmware Package. // //***************************************************************************** #include #include #include #include "inc/hw_memmap.h" #include "driverlib/fpu.h" #include "driverlib/gpio.h" #include "driverlib/interrupt.h" #include "driverlib/pin_map.h" #include "driverlib/rom.h" #include "driverlib/sysctl.h" #include "driverlib/systick.h" #include "driverlib/uart.h" #include "grlib/grlib.h" #include "utils/cmdline.h" #include "utils/uartstdio.h" #include "fatfs/src/ff.h" #include "fatfs/src/diskio.h" #include "drivers/cfal96x64x16.h" //***************************************************************************** // //! \addtogroup example_list //!

SD card using FAT file system (sd_card)

//! //! This example application demonstrates reading a file system from an SD //! card. It makes use of FatFs, a FAT file system driver. It provides a //! simple command console via a serial port for issuing commands to view and //! navigate the file system on the SD card. //! //! The first UART, which is connected to the USB debug virtual serial port on //! the evaluation board, is configured for 115,200 bits per second, and 8-N-1 //! mode. When the program is started a message will be printed to the //! terminal. Type ``help'' for command help. //! //! For additional details about FatFs, see the following site: //! http://elm-chan.org/fsw/ff/00index_e.html // //***************************************************************************** //***************************************************************************** // // Defines the size of the buffers that hold the path, or temporary data from // the SD card. There are two buffers allocated of this size. The buffer size // must be large enough to hold the longest expected full path name, including // the file name, and a trailing null character. // //***************************************************************************** #define PATH_BUF_SIZE 80 //***************************************************************************** // // Defines the size of the buffer that holds the command line. // //***************************************************************************** #define CMD_BUF_SIZE 64 //***************************************************************************** // // This buffer holds the full path to the current working directory. Initially // it is root ("/"). // //***************************************************************************** static char g_pcCwdBuf[PATH_BUF_SIZE] = "/"; //***************************************************************************** // // A temporary data buffer used when manipulating file paths, or reading data // from the SD card. // //***************************************************************************** static char g_pcTmpBuf[PATH_BUF_SIZE]; //***************************************************************************** // // The buffer that holds the command line. // //***************************************************************************** static char g_pcCmdBuf[CMD_BUF_SIZE]; //***************************************************************************** // // The following are data structures used by FatFs. // //***************************************************************************** static FATFS g_sFatFs; static DIR g_sDirObject; static FILINFO g_sFileInfo; static FIL g_sFileObject; //***************************************************************************** // // A structure that holds a mapping between an FRESULT numerical code, and a // string representation. FRESULT codes are returned from the FatFs FAT file // system driver. // //***************************************************************************** typedef struct { FRESULT iFResult; char *pcResultStr; } tFResultString; //***************************************************************************** // // A macro to make it easy to add result codes to the table. // //***************************************************************************** #define FRESULT_ENTRY(f) { (f), (#f) } //***************************************************************************** // // A table that holds a mapping between the numerical FRESULT code and it's // name as a string. This is used for looking up error codes for printing to // the console. // //***************************************************************************** tFResultString g_psFResultStrings[] = { FRESULT_ENTRY(FR_OK), FRESULT_ENTRY(FR_DISK_ERR), FRESULT_ENTRY(FR_INT_ERR), FRESULT_ENTRY(FR_NOT_READY), FRESULT_ENTRY(FR_NO_FILE), FRESULT_ENTRY(FR_NO_PATH), FRESULT_ENTRY(FR_INVALID_NAME), FRESULT_ENTRY(FR_DENIED), FRESULT_ENTRY(FR_EXIST), FRESULT_ENTRY(FR_INVALID_OBJECT), FRESULT_ENTRY(FR_WRITE_PROTECTED), FRESULT_ENTRY(FR_INVALID_DRIVE), FRESULT_ENTRY(FR_NOT_ENABLED), FRESULT_ENTRY(FR_NO_FILESYSTEM), FRESULT_ENTRY(FR_MKFS_ABORTED), FRESULT_ENTRY(FR_TIMEOUT), FRESULT_ENTRY(FR_LOCKED), FRESULT_ENTRY(FR_NOT_ENOUGH_CORE), FRESULT_ENTRY(FR_TOO_MANY_OPEN_FILES), FRESULT_ENTRY(FR_INVALID_PARAMETER), }; //***************************************************************************** // // A macro that holds the number of result codes. // //***************************************************************************** #define NUM_FRESULT_CODES (sizeof(g_psFResultStrings) / \ sizeof(tFResultString)) //***************************************************************************** // // Graphics context used to show text on the CSTN display. // //***************************************************************************** tContext g_sContext; //***************************************************************************** // // This function returns a string representation of an error code that was // returned from a function call to FatFs. It can be used for printing human // readable error messages. // //***************************************************************************** const char * StringFromFResult(FRESULT iFResult) { uint_fast8_t ui8Idx; // // Enter a loop to search the error code table for a matching error code. // for(ui8Idx = 0; ui8Idx < NUM_FRESULT_CODES; ui8Idx++) { // // If a match is found, then return the string name of the error code. // if(g_psFResultStrings[ui8Idx].iFResult == iFResult) { return(g_psFResultStrings[ui8Idx].pcResultStr); } } // // At this point no matching code was found, so return a string indicating // an unknown error. // return("UNKNOWN ERROR CODE"); } //***************************************************************************** // // This is the handler for this SysTick interrupt. FatFs requires a timer tick // every 10 ms for internal timing purposes. // //***************************************************************************** void SysTickHandler(void) { // // Call the FatFs tick timer. // disk_timerproc(); } //***************************************************************************** // // This function implements the "ls" command. It opens the current directory // and enumerates through the contents, and prints a line for each item it // finds. It shows details such as file attributes, time and date, and the // file size, along with the name. It shows a summary of file sizes at the end // along with free space. // //***************************************************************************** int Cmd_ls(int argc, char *argv[]) { uint32_t ui32TotalSize; uint32_t ui32FileCount; uint32_t ui32DirCount; FRESULT iFResult; FATFS *psFatFs; char *pcFileName; #if _USE_LFN char pucLfn[_MAX_LFN + 1]; g_sFileInfo.lfname = pucLfn; g_sFileInfo.lfsize = sizeof(pucLfn); #endif // // Open the current directory for access. // iFResult = f_opendir(&g_sDirObject, g_pcCwdBuf); // // Check for error and return if there is a problem. // if(iFResult != FR_OK) { return((int)iFResult); } ui32TotalSize = 0; ui32FileCount = 0; ui32DirCount = 0; // // Give an extra blank line before the listing. // UARTprintf("\n"); // // Enter loop to enumerate through all directory entries. // for(;;) { // // Read an entry from the directory. // iFResult = f_readdir(&g_sDirObject, &g_sFileInfo); // // Check for error and return if there is a problem. // if(iFResult != FR_OK) { return((int)iFResult); } // // If the file name is blank, then this is the end of the listing. // if(!g_sFileInfo.fname[0]) { break; } // // If the attribue is directory, then increment the directory count. // if(g_sFileInfo.fattrib & AM_DIR) { ui32DirCount++; } // // Otherwise, it is a file. Increment the file count, and add in the // file size to the total. // else { ui32FileCount++; ui32TotalSize += g_sFileInfo.fsize; } #if _USE_LFN pcFileName = ((*g_sFileInfo.lfname)?g_sFileInfo.lfname:g_sFileInfo.fname); #else pcFileName = g_sFileInfo.fname; #endif // // Print the entry information on a single line with formatting to show // the attributes, date, time, size, and name. // UARTprintf("%c%c%c%c%c %u/%02u/%02u %02u:%02u %9u %s\n", (g_sFileInfo.fattrib & AM_DIR) ? 'D' : '-', (g_sFileInfo.fattrib & AM_RDO) ? 'R' : '-', (g_sFileInfo.fattrib & AM_HID) ? 'H' : '-', (g_sFileInfo.fattrib & AM_SYS) ? 'S' : '-', (g_sFileInfo.fattrib & AM_ARC) ? 'A' : '-', (g_sFileInfo.fdate >> 9) + 1980, (g_sFileInfo.fdate >> 5) & 15, g_sFileInfo.fdate & 31, (g_sFileInfo.ftime >> 11), (g_sFileInfo.ftime >> 5) & 63, g_sFileInfo.fsize, pcFileName); } // // Print summary lines showing the file, dir, and size totals. // UARTprintf("\n%4u File(s),%10u bytes total\n%4u Dir(s)", ui32FileCount, ui32TotalSize, ui32DirCount); // // Get the free space. // iFResult = f_getfree("/", (DWORD *)&ui32TotalSize, &psFatFs); // // Check for error and return if there is a problem. // if(iFResult != FR_OK) { return((int)iFResult); } // // Display the amount of free space that was calculated. // UARTprintf(", %10uK bytes free\n", (ui32TotalSize * psFatFs->free_clust / 2)); // // Made it to here, return with no errors. // return(0); } //***************************************************************************** // // This function implements the "cd" command. It takes an argument that // specifies the directory to make the current working directory. Path // separators must use a forward slash "/". The argument to cd can be one of // the following: // // * root ("/") // * a fully specified path ("/my/path/to/mydir") // * a single directory name that is in the current directory ("mydir") // * parent directory ("..") // // It does not understand relative paths, so dont try something like this: // ("../my/new/path") // // Once the new directory is specified, it attempts to open the directory to // make sure it exists. If the new path is opened successfully, then the // current working directory (cwd) is changed to the new path. // //***************************************************************************** int Cmd_cd(int argc, char *argv[]) { uint_fast8_t ui8Idx; FRESULT iFResult; // // Copy the current working path into a temporary buffer so it can be // manipulated. // strcpy(g_pcTmpBuf, g_pcCwdBuf); // // If the first character is /, then this is a fully specified path, and it // should just be used as-is. // if(argv[1][0] == '/') { // // Make sure the new path is not bigger than the cwd buffer. // if(strlen(argv[1]) + 1 > sizeof(g_pcCwdBuf)) { UARTprintf("Resulting path name is too long\n"); return(0); } // // If the new path name (in argv[1]) is not too long, then copy it // into the temporary buffer so it can be checked. // else { strncpy(g_pcTmpBuf, argv[1], sizeof(g_pcTmpBuf)); } } // // If the argument is .. then attempt to remove the lowest level on the // CWD. // else if(!strcmp(argv[1], "..")) { // // Get the index to the last character in the current path. // ui8Idx = strlen(g_pcTmpBuf) - 1; // // Back up from the end of the path name until a separator (/) is // found, or until we bump up to the start of the path. // while((g_pcTmpBuf[ui8Idx] != '/') && (ui8Idx > 1)) { // // Back up one character. // ui8Idx--; } // // Now we are either at the lowest level separator in the current path, // or at the beginning of the string (root). So set the new end of // string here, effectively removing that last part of the path. // g_pcTmpBuf[ui8Idx] = 0; } // // Otherwise this is just a normal path name from the current directory, // and it needs to be appended to the current path. // else { // // Test to make sure that when the new additional path is added on to // the current path, there is room in the buffer for the full new path. // It needs to include a new separator, and a trailing null character. // if(strlen(g_pcTmpBuf) + strlen(argv[1]) + 1 + 1 > sizeof(g_pcCwdBuf)) { UARTprintf("Resulting path name is too long\n"); return(0); } // // The new path is okay, so add the separator and then append the new // directory to the path. // else { // // If not already at the root level, then append a / // if(strcmp(g_pcTmpBuf, "/")) { strcat(g_pcTmpBuf, "/"); } // // Append the new directory to the path. // strcat(g_pcTmpBuf, argv[1]); } } // // At this point, a candidate new directory path is in chTmpBuf. Try to // open it to make sure it is valid. // iFResult = f_opendir(&g_sDirObject, g_pcTmpBuf); // // If it can't be opened, then it is a bad path. Inform the user and // return. // if(iFResult != FR_OK) { UARTprintf("cd: %s\n", g_pcTmpBuf); return((int)iFResult); } // // Otherwise, it is a valid new path, so copy it into the CWD. // else { strncpy(g_pcCwdBuf, g_pcTmpBuf, sizeof(g_pcCwdBuf)); } // // Return success. // return(0); } //***************************************************************************** // // This function implements the "pwd" command. It simply prints the current // working directory. // //***************************************************************************** int Cmd_pwd(int argc, char *argv[]) { // // Print the CWD to the console. // UARTprintf("%s\n", g_pcCwdBuf); // // Return success. // return(0); } //***************************************************************************** // // This function implements the "cat" command. It reads the contents of a file // and prints it to the console. This should only be used on text files. If // it is used on a binary file, then a bunch of garbage is likely to printed on // the console. // //***************************************************************************** int Cmd_cat(int argc, char *argv[]) { FRESULT iFResult; uint32_t ui32BytesRead; // // First, check to make sure that the current path (CWD), plus the file // name, plus a separator and trailing null, will all fit in the temporary // buffer that will be used to hold the file name. The file name must be // fully specified, with path, to FatFs. // if(strlen(g_pcCwdBuf) + strlen(argv[1]) + 1 + 1 > sizeof(g_pcTmpBuf)) { UARTprintf("Resulting path name is too long\n"); return(0); } // // Copy the current path to the temporary buffer so it can be manipulated. // strcpy(g_pcTmpBuf, g_pcCwdBuf); // // If not already at the root level, then append a separator. // if(strcmp("/", g_pcCwdBuf)) { strcat(g_pcTmpBuf, "/"); } // // Now finally, append the file name to result in a fully specified file. // strcat(g_pcTmpBuf, argv[1]); // // Open the file for reading. // iFResult = f_open(&g_sFileObject, g_pcTmpBuf, FA_READ); // // If there was some problem opening the file, then return an error. // if(iFResult != FR_OK) { return((int)iFResult); } // // Enter a loop to repeatedly read data from the file and display it, until // the end of the file is reached. // do { // // Read a block of data from the file. Read as much as can fit in the // temporary buffer, including a space for the trailing null. // iFResult = f_read(&g_sFileObject, g_pcTmpBuf, sizeof(g_pcTmpBuf) - 1, (UINT *)&ui32BytesRead); // // If there was an error reading, then print a newline and return the // error to the user. // if(iFResult != FR_OK) { UARTprintf("\n"); return((int)iFResult); } // // Null terminate the last block that was read to make it a null // terminated string that can be used with printf. // g_pcTmpBuf[ui32BytesRead] = 0; // // Print the last chunk of the file that was received. // UARTprintf("%s", g_pcTmpBuf); } while(ui32BytesRead == sizeof(g_pcTmpBuf) - 1); // // Return success. // return(0); } //***************************************************************************** // // This function implements the "help" command. It prints a simple list of the // available commands with a brief description. // //***************************************************************************** int Cmd_help(int argc, char *argv[]) { tCmdLineEntry *psEntry; // // Print some header text. // UARTprintf("\nAvailable commands\n"); UARTprintf("------------------\n"); // // Point at the beginning of the command table. // psEntry = &g_psCmdTable[0]; // // Enter a loop to read each entry from the command table. The end of the // table has been reached when the command name is NULL. // while(psEntry->pcCmd) { // // Print the command name and the brief description. // UARTprintf("%6s: %s\n", psEntry->pcCmd, psEntry->pcHelp); // // Advance to the next entry in the table. // psEntry++; } // // Return success. // return(0); } //***************************************************************************** // // This is the table that holds the command names, implementing functions, and // brief description. // //***************************************************************************** tCmdLineEntry g_psCmdTable[] = { { "help", Cmd_help, "Display list of commands" }, { "h", Cmd_help, "alias for help" }, { "?", Cmd_help, "alias for help" }, { "ls", Cmd_ls, "Display list of files" }, { "chdir", Cmd_cd, "Change directory" }, { "cd", Cmd_cd, "alias for chdir" }, { "pwd", Cmd_pwd, "Show current working directory" }, { "cat", Cmd_cat, "Show contents of a text file" }, { 0, 0, 0 } }; //***************************************************************************** // // The error routine that is called if the driver library encounters an error. // //***************************************************************************** #ifdef DEBUG void __error__(char *pcFilename, uint32_t ui32Line) { } #endif //***************************************************************************** // // Configure the UART and its pins. This must be called before UARTprintf(). // //***************************************************************************** void ConfigureUART(void) { // // Enable the GPIO Peripheral used by the UART. // ROM_SysCtlPeripheralEnable(SYSCTL_PERIPH_GPIOA); // // Enable UART0 // ROM_SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0); // // Configure GPIO Pins for UART mode. // ROM_GPIOPinConfigure(GPIO_PA0_U0RX); ROM_GPIOPinConfigure(GPIO_PA1_U0TX); ROM_GPIOPinTypeUART(GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1); // // Initialize the UART for console I/O. // UARTStdioConfig(0, 115200, ROM_SysCtlClockGet()); } //***************************************************************************** // // The program main function. It performs initialization, then runs a command // processing loop to read commands from the console. // //***************************************************************************** int main(void) { int nStatus; FRESULT iFResult; tRectangle sRect; // // Enable lazy stacking for interrupt handlers. This allows floating-point // instructions to be used within interrupt handlers, but at the expense of // extra stack usage. // ROM_FPULazyStackingEnable(); // // Set the system clock to run at 50MHz from the PLL. // ROM_SysCtlClockSet(SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_16MHZ); // // Enable the peripherals used by this example. // ROM_SysCtlPeripheralEnable(SYSCTL_PERIPH_SSI0); // // Configure SysTick for a 100Hz interrupt. The FatFs driver wants a 10 ms // tick. // ROM_SysTickPeriodSet(ROM_SysCtlClockGet() / 100); ROM_SysTickEnable(); ROM_SysTickIntEnable(); // // Enable Interrupts // ROM_IntMasterEnable(); // // Initialize the UART as a console for text I/O. // ConfigureUART(); // // Initialize the display driver. // CFAL96x64x16Init(); // // Initialize the graphics context. // GrContextInit(&g_sContext, &g_sCFAL96x64x16); // // Fill the top part of the screen with blue to create the banner. // sRect.i16XMin = 0; sRect.i16YMin = 0; sRect.i16XMax = GrContextDpyWidthGet(&g_sContext) - 1; sRect.i16YMax = 9; GrContextForegroundSet(&g_sContext, ClrDarkBlue); GrRectFill(&g_sContext, &sRect); // // Change foreground for white text. // GrContextForegroundSet(&g_sContext, ClrWhite); // // Put the application name in the middle of the banner. // GrContextFontSet(&g_sContext, g_psFontFixed6x8); GrStringDrawCentered(&g_sContext, "sd_card", -1, GrContextDpyWidthGet(&g_sContext) / 2, 4, 0); // // Show some instructions on the display // GrContextFontSet(&g_sContext, g_psFontFixed6x8); GrStringDrawCentered(&g_sContext, "Connect a", -1, GrContextDpyWidthGet(&g_sContext) / 2, 20, false); GrStringDrawCentered(&g_sContext, "terminal", -1, GrContextDpyWidthGet(&g_sContext) / 2, 30, false); GrStringDrawCentered(&g_sContext, "to UART0.", -1, GrContextDpyWidthGet(&g_sContext) / 2, 40, false); GrStringDrawCentered(&g_sContext, "115000,N,8,1", -1, GrContextDpyWidthGet(&g_sContext) / 2, 50, false); // // Print hello message to user. // UARTprintf("\n\nSD Card Example Program\n"); UARTprintf("Type \'help\' for help.\n"); // // Mount the file system, using logical disk 0. // iFResult = f_mount(0, &g_sFatFs); if(iFResult != FR_OK) { UARTprintf("f_mount error: %s\n", StringFromFResult(iFResult)); return(1); } // // Enter an infinite loop for reading and processing commands from the // user. // while(1) { // // Print a prompt to the console. Show the CWD. // UARTprintf("\n%s> ", g_pcCwdBuf); // // Get a line of text from the user. // UARTgets(g_pcCmdBuf, sizeof(g_pcCmdBuf)); // // Pass the line from the user to the command processor. It will be // parsed and valid commands executed. // nStatus = CmdLineProcess(g_pcCmdBuf); // // Handle the case of bad command. // if(nStatus == CMDLINE_BAD_CMD) { UARTprintf("Bad command!\n"); } // // Handle the case of too many arguments. // else if(nStatus == CMDLINE_TOO_MANY_ARGS) { UARTprintf("Too many arguments for command processor!\n"); } // // Otherwise the command was executed. Print the error code if one was // returned. // else if(nStatus != 0) { UARTprintf("Command returned error code %s\n", StringFromFResult((FRESULT)nStatus)); } } }