git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/FreeRTOS-Plus-FAT/include/ff_fat.h

   1 /*\r
   2  * FreeRTOS+FAT build 191128 - Note:  FreeRTOS+FAT is still in the lab!\r
   3  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  * Authors include James Walmsley, Hein Tibosch and Richard Barry\r
   5  *\r
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   7  * this software and associated documentation files (the "Software"), to deal in\r
   8  * the Software without restriction, including without limitation the rights to\r
   9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
  10  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  11  * subject to the following conditions:\r
  12  *\r
  13  * The above copyright notice and this permission notice shall be included in all\r
  14  * copies or substantial portions of the Software.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * https://www.FreeRTOS.org\r
  24  *\r
  25  */\r
  26 \r
  27 /**\r
  28  *      @file           ff_fat.h\r
  29  *      @ingroup        FAT\r
  30  **/\r
  31 \r
  32 #ifndef _FF_FAT_H_\r
  33 #define _FF_FAT_H_\r
  34 \r
  35 #ifndef PLUS_FAT_H\r
  36         #error this header will be included from "plusfat.h"\r
  37 #endif\r
  38 \r
  39 /*---------- ERROR CODES */\r
  40 \r
  41 \r
  42 /*---------- PROTOTYPES */\r
  43 \r
  44 /* HT statistics Will be taken away after testing: */\r
  45 #if( ffconfigFAT_USES_STAT != 0 )\r
  46 struct SFatStat\r
  47 {\r
  48         unsigned initCount;\r
  49         unsigned clearCount;\r
  50         unsigned getCount[2];   /* Index 0 for READ counts, index 1 for WRITE counts. */\r
  51         unsigned reuseCount[2];\r
  52         unsigned missCount[2];\r
  53 };\r
  54 \r
  55 extern struct SFatStat fatStat;\r
  56 #endif\r
  57 \r
  58 #if( ffconfigWRITE_BOTH_FATS != 0 )\r
  59         #define ffconfigBUF_STORE_COUNT 2\r
  60 #else\r
  61         #define ffconfigBUF_STORE_COUNT 1\r
  62 #endif\r
  63 \r
  64 typedef struct _FatBuffers\r
  65 {\r
  66         FF_Buffer_t *pxBuffers[ffconfigBUF_STORE_COUNT];\r
  67         uint8_t ucMode; /* FF_MODE_READ or WRITE. */\r
  68 } FF_FATBuffers_t;\r
  69 \r
  70 uint32_t FF_getClusterPosition( FF_IOManager_t *pxIOManager, uint32_t ulEntry, uint32_t ulEntrySize );\r
  71 uint32_t FF_getClusterChainNumber( FF_IOManager_t *pxIOManager, uint32_t ulEntry, uint32_t ulEntrySize );\r
  72 uint32_t FF_getMajorBlockNumber( FF_IOManager_t *pxIOManager, uint32_t ulEntry, uint32_t ulEntrySize );\r
  73 uint32_t FF_getMinorBlockNumber( FF_IOManager_t *pxIOManager, uint32_t ulEntry, uint32_t ulEntrySize );\r
  74 uint32_t FF_getMinorBlockEntry( FF_IOManager_t *pxIOManager, uint32_t ulEntry, uint32_t ulEntrySize );\r
  75 \r
  76 /* A partition may define a block size larger than 512 bytes (at offset 0x0B of the PBR).\r
  77 This function translates a block address to an address based on 'pxIOManager->usBlkSize',\r
  78 which is usually 512 bytes.\r
  79 */\r
  80 static portINLINE uint32_t FF_getRealLBA( FF_IOManager_t *pxIOManager, uint32_t LBA )\r
  81 {\r
  82         return LBA * pxIOManager->xPartition.ucBlkFactor;\r
  83 }\r
  84 \r
  85 uint32_t FF_Cluster2LBA( FF_IOManager_t *pxIOManager, uint32_t ulCluster );\r
  86 uint32_t FF_LBA2Cluster( FF_IOManager_t *pxIOManager, uint32_t ulAddress );\r
  87 uint32_t FF_getFATEntry( FF_IOManager_t *pxIOManager, uint32_t ulCluster, FF_Error_t *pxError, FF_FATBuffers_t *pxFATBuffers );\r
  88 FF_Error_t FF_putFATEntry( FF_IOManager_t *pxIOManager, uint32_t ulCluster, uint32_t ulValue, FF_FATBuffers_t *pxFATBuffers );\r
  89 BaseType_t FF_isEndOfChain( FF_IOManager_t *pxIOManager, uint32_t ulFatEntry );\r
  90 uint32_t FF_FindFreeCluster( FF_IOManager_t *pxIOManager, FF_Error_t *pxError, BaseType_t aDoClaim );\r
  91 uint32_t FF_ExtendClusterChain( FF_IOManager_t *pxIOManager, uint32_t ulStartCluster, uint32_t ulCount );\r
  92 FF_Error_t FF_UnlinkClusterChain( FF_IOManager_t *pxIOManager, uint32_t ulStartCluster, BaseType_t xDoTruncate );\r
  93 uint32_t FF_TraverseFAT( FF_IOManager_t *pxIOManager, uint32_t ulStart, uint32_t ulCount, FF_Error_t *pxError );\r
  94 uint32_t FF_CreateClusterChain( FF_IOManager_t *pxIOManager, FF_Error_t *pxError );\r
  95 uint32_t FF_GetChainLength( FF_IOManager_t *pxIOManager, uint32_t pa_nStartCluster, uint32_t *piEndOfChain, FF_Error_t *pxError );\r
  96 uint32_t FF_FindEndOfChain( FF_IOManager_t *pxIOManager, uint32_t Start, FF_Error_t *pxError );\r
  97 FF_Error_t FF_ClearCluster( FF_IOManager_t *pxIOManager, uint32_t ulCluster  );\r
  98 \r
  99 #if( ffconfig64_NUM_SUPPORT != 0 )\r
 100         uint64_t FF_GetFreeSize( FF_IOManager_t *pxIOManager, FF_Error_t *pxError );\r
 101 #else\r
 102         uint32_t FF_GetFreeSize( FF_IOManager_t *pxIOManager, FF_Error_t *pxError );\r
 103 #endif\r
 104 \r
 105 /* WARNING: If this prototype changes, it must be updated in ff_ioman.c also! */\r
 106 uint32_t FF_CountFreeClusters( FF_IOManager_t *pxIOManager, FF_Error_t *pxError );\r
 107 \r
 108 FF_Error_t FF_ReleaseFATBuffers( FF_IOManager_t *pxIOManager, FF_FATBuffers_t *pxFATBuffers );\r
 109 \r
 110 static portINLINE void FF_InitFATBuffers( FF_FATBuffers_t *pxFATBuffers, uint8_t ucMode )\r
 111 {\r
 112         pxFATBuffers->pxBuffers[ 0 ] = NULL;\r
 113 #if ffconfigBUF_STORE_COUNT > 1\r
 114         pxFATBuffers->pxBuffers[ 1 ] = NULL;\r
 115 #endif\r
 116 #if ffconfigBUF_STORE_COUNT > 2\r
 117         #error Please check this code, maybe it is time to use memset\r
 118 #endif\r
 119         pxFATBuffers->ucMode = ucMode; /* FF_MODE_READ/WRITE */\r
 120         #if ffconfigFAT_USES_STAT\r
 121         {\r
 122                 fatStat.initCount++;\r
 123         }\r
 124         #endif\r
 125 }\r
 126 \r
 127 #endif\r
 128 \r