radio/src/sdcard.h

   1 /*
   2  * Copyright (C) OpenTX
   3  *
   4  * Based on code named
   5  *   th9x - http://code.google.com/p/th9x
   6  *   er9x - http://code.google.com/p/er9x
   7  *   gruvin9x - http://code.google.com/p/gruvin9x
   8  *
   9  * License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  */
  20
  21 #ifndef _SDCARD_H_
  22 #define _SDCARD_H_
  23
  24 #include "ff.h"
  25
  26 #define ROOT_PATH           "/"
  27 #define MODELS_PATH         ROOT_PATH "MODELS"      // no trailing slash = important
  28 #define RADIO_PATH          ROOT_PATH "RADIO"       // no trailing slash = important
  29 #define LOGS_PATH           ROOT_PATH "LOGS"
  30 #define SCREENSHOTS_PATH    ROOT_PATH "SCREENSHOTS"
  31 #define SOUNDS_PATH         ROOT_PATH "SOUNDS/en"
  32 #define SOUNDS_PATH_LNG_OFS (sizeof(SOUNDS_PATH)-3)
  33 #define SYSTEM_SUBDIR       "SYSTEM"
  34 #define BITMAPS_PATH        ROOT_PATH "IMAGES"
  35 #define FIRMWARES_PATH      ROOT_PATH "FIRMWARE"
  36 #define EEPROMS_PATH        ROOT_PATH "EEPROM"
  37 #define SCRIPTS_PATH        ROOT_PATH "SCRIPTS"
  38 #define WIZARD_PATH         SCRIPTS_PATH "/WIZARD"
  39 #define THEMES_PATH         ROOT_PATH "THEMES"
  40 #define LAYOUTS_PATH        ROOT_PATH "LAYOUTS"
  41 #define WIDGETS_PATH        ROOT_PATH "WIDGETS"
  42 #define WIZARD_NAME         "wizard.lua"
  43 #define TEMPLATES_PATH      SCRIPTS_PATH "/TEMPLATES"
  44 #define SCRIPTS_MIXES_PATH  SCRIPTS_PATH "/MIXES"
  45 #define SCRIPTS_FUNCS_PATH  SCRIPTS_PATH "/FUNCTIONS"
  46 #define SCRIPTS_TELEM_PATH  SCRIPTS_PATH "/TELEMETRY"
  47
  48 #define LEN_FILE_PATH_MAX   (sizeof(SCRIPTS_TELEM_PATH)+1)  // longest + "/"
  49
  50 #if defined(COLORLCD)
  51 const char RADIO_MODELSLIST_PATH[] = RADIO_PATH "/models.txt";
  52 const char RADIO_SETTINGS_PATH[] = RADIO_PATH "/radio.bin";
  53 #endif
  54
  55 #define MODELS_EXT          ".bin"
  56 #define LOGS_EXT            ".csv"
  57 #define SOUNDS_EXT          ".wav"
  58 #define BMP_EXT             ".bmp"
  59 #define PNG_EXT             ".png"
  60 #define JPG_EXT             ".jpg"
  61 #define SCRIPT_EXT          ".lua"
  62 #define SCRIPT_BIN_EXT      ".luac"
  63 #define TEXT_EXT            ".txt"
  64 #define FIRMWARE_EXT        ".bin"
  65 #define EEPROM_EXT          ".bin"
  66 #define SPORT_FIRMWARE_EXT  ".frk"
  67
  68 #define LEN_FILE_EXTENSION_MAX  5  // longest used, including the dot, excluding null term.
  69
  70 #if defined(PCBHORUS)
  71 #define BITMAPS_EXT         BMP_EXT JPG_EXT PNG_EXT
  72 #define LEN_BITMAPS_EXT     4
  73 #else
  74 #define BITMAPS_EXT         BMP_EXT
  75 #endif
  76
  77 #ifdef LUA_COMPILER
  78   #define SCRIPTS_EXT         SCRIPT_BIN_EXT SCRIPT_EXT
  79 #else
  80   #define SCRIPTS_EXT         SCRIPT_EXT
  81 #endif
  82
  83 #define GET_FILENAME(filename, path, var, ext) \
  84   char filename[sizeof(path) + sizeof(var) + sizeof(ext)]; \
  85   memcpy(filename, path, sizeof(path) - 1); \
  86   filename[sizeof(path) - 1] = '/'; \
  87   memcpy(&filename[sizeof(path)], var, sizeof(var)); \
  88   filename[sizeof(path)+sizeof(var)] = '\0'; \
  89   strcat(&filename[sizeof(path)], ext)
  90
  91 extern FATFS g_FATFS_Obj;
  92 extern FIL g_oLogFile;
  93
  94 extern uint8_t logDelay;
  95 void logsInit();
  96 void logsClose();
  97 void logsWrite();
  98
  99 uint32_t sdGetNoSectors();
 100 uint32_t sdGetSize();
 101 uint32_t sdGetFreeSectors();
 102 const char * sdCheckAndCreateDirectory(const char * path);
 103
 104 #if !defined(BOOT)
 105 inline const pm_char * SDCARD_ERROR(FRESULT result)
 106 {
 107   if (result == FR_NOT_READY)
 108     return STR_NO_SDCARD;
 109   else
 110     return STR_SDCARD_ERROR;
 111 }
 112 #endif
 113
 114 // NOTE: 'size' must = 0 or be a valid character position within 'filename' array -- it is NOT validated
 115 const char * getFileExtension(const char * filename, uint8_t size=0, uint8_t extMaxLen=0, uint8_t *fnlen=NULL, uint8_t *extlen=NULL);
 116
 117 // TODO REMOVE THE O9X FOURCC in 2.3
 118 #if defined(PCBHORUS)
 119   #define OTX_FOURCC 0x3478746F // otx for Horus
 120   #define O9X_FOURCC 0x3178396F // we forgot it in 2.2 RC ..
 121 #elif defined(PCBX9E)
 122   #define OTX_FOURCC 0x3578746F // otx for Taranis X9E
 123   #define O9X_FOURCC 0x3378396F // o9x for Taranis X9E
 124 #elif defined(PCBX7)
 125   #define OTX_FOURCC 0x3678746F // otx for Taranis X7
 126   #define O9X_FOURCC 0x3378396F // o9x for Taranis X7
 127 #elif defined(PCBTARANIS)
 128   #define OTX_FOURCC 0x3378746F // otx for Taranis X9D
 129   #define O9X_FOURCC 0x3378396F // o9x for Taranis X9D
 130 #elif defined(PCBSKY9X)
 131   #define OTX_FOURCC 0x3278746F // otx for sky9x
 132   #define O9X_FOURCC 0x3278396F // o9x for sky9x
 133 #elif defined(PCBGRUVIN9X) || defined(PCBMEGA2560)
 134   #define OTX_FOURCC 0x3178746F // otx for gruvin9x/MEGA2560
 135   #define O9X_FOURCC 0x3178396F // o9x for gruvin9x/MEGA2560
 136 #endif
 137
 138 bool isFileAvailable(const char * filename, bool exclDir = false);
 139 int findNextFileIndex(char * filename, uint8_t size, const char * directory);
 140 bool isExtensionMatching(const char * extension, const char * pattern, char * match = NULL);
 141
 142 const char * sdCopyFile(const char * src, const char * dest);
 143 const char * sdCopyFile(const char * srcFilename, const char * srcDir, const char * destFilename, const char * destDir);
 144
 145 #define LIST_NONE_SD_FILE   1
 146 #define LIST_SD_FILE_EXT    2
 147 bool sdListFiles(const char * path, const char * extension, const uint8_t maxlen, const char * selection, uint8_t flags=0);
 148
 149 bool isCwdAtRoot();
 150 FRESULT sdReadDir(DIR * dir, FILINFO * fno, bool & firstTime);
 151
 152 #endif // _SDCARD_H_