View source for Unit FATFS

Return to [[Unit_Reference|Unit Reference]]


=== Description ===
----

'''Ultibo FAT12/16/32/exFAT interface unit'''

''Notes:''

Based on information from numerous sources, primarily the document fatgen103.pdf from Microsoft. FAT Disk Blocks are based on reading a group of sectors into a block at once. The BlockNo of each block is therefore the FAT entry no of the first FAT in the block.

The use of IsEightDotThree and GenerateShortName(Ex) from the UltiboUtils unit should be replaced by internal routines optimised for maximum performance. All Block and Entry Offsets have been expanded to 32bit to avoid 16bit overflow on 64K clusters.

=== Constants ===
----


<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''FATFS specific constants''' <code> fat* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>fatFAT12 = 0;</code>
| &nbsp;
|-
| <code>fatFAT16 = 1;</code>
| &nbsp;
|-
| <code>fatFAT32 = 2;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fatDotName = '.';</code>
| &nbsp;
|-
| <code>fatDotDotName = '..';</code>
| &nbsp;
|-
| <code>fatBlankName= '';</code>
| &nbsp;
|-
| <code>fatNameCount = 8;</code>
| &nbsp;
|-
| <code>fatExtCount = 3;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fatLabelMask = '*';</code>
| &nbsp;
|-
| <code>fatLabelCount = 11;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fatOemName = 'MSWIN4.1';</code>
| &nbsp;
|-
| <code>fatDefaultName = 'NO NAME';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fatFlagNone = $00;</code>
| &nbsp;
|-
| <code>fatFlagName = $08;</code>
| &nbsp;
|-
| <code>fatFlagExt = $10;</code>
| &nbsp;
|-
| <code>fatFlagBoth = $18;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>lfnMaxName = 2048;</code>
| Buffer size for lfn handling
|-
| <code>lfnMaxAlias = 999999;</code>
| Max number of lfn aliases (ie ~999999)
|-
| <code>lfnMaxNameAlias = 4;</code>
| &nbsp;
|-
| <code>lfnMaxHashAlias = 999;</code>
| &nbsp;
|-
| <code>lfnMaxHashShift = 16;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fatMaxFileSize = 4294967295;</code>
| Max size in bytes of a File (4GB)
|-
| <code>fatMaxDirectorySize = 2097152;</code>
| Max size in bytes of a Directory (2MB = 65536 * 32)
|-
|colspan="2"|&nbsp;
|-
| <code>fatMinClusterSize = 512;</code>
| &nbsp;
|-
| <code>fatMaxClusterSize = 65536;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fat12MinClusters = 3;</code>
| &nbsp;
|-
| <code>fat16MinClusters = 4085;</code>
| Smallest Number of Clusters on a FAT16 volume, is FAT12 if less
|-
| <code>fat32MinClusters = 65525;</code>
| Smallest Number of Clusters on a FAT32 volume, is FAT16 if less
|-
|colspan="2"|&nbsp;
|-
| <code>fat12MinSectors = 6;</code>
| Number of Sectors at which we cannot create a FAT12 (Not possible due to 512 Root entries)
|-
| <code>fat12MinSectors = 798;</code>
| Number of Sectors at which we cannot create a FAT12
|-
| <code>fat12MaxSectors = 32623;</code>
| Number of Sectors at which we insist on creating FAT16
|-
|colspan="2"|&nbsp;
|-
| <code>fat16MinSectors = 8400;</code>
| Number of Sectors at which we cannot create a FAT16
|-
| <code>fat16MaxSectors = 1048576;</code>
| Number of Sectors at which we insist on creating FAT32
|-
|colspan="2"|&nbsp;
|-
| <code>fat32MinSectors = 66600;</code>
| Number of Sectors at which we cannot create a FAT32
|-
| <code>fat32MaxSectors = $FFFFFFFF;</code>
| No limit on maximum size of a FAT32
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|Note: In FAT12 EOC will be >= $0FF0 due to Media ID on Floppy
|-
| <code>fat12EndOfFile = $0FF0;</code>
| Some Code sets values from $0FF0 - $0FFF as EOF
|-
| <code>fat12EndOfFile = $0FF8;</code>
| Some Code sets values from $0FF8 - $0FFF as EOF
|-
| <code>fat12EndOfCluster = $0FFF;</code>
| EOF Mark, Check for >= $0FF0 - See Above
|-
| <code>fat12FreeCluster = $0000;</code>
| Available for Use
|-
| <code>fat12BadCluster = $0FF7;</code>
| Bad Cluster Mark - Do Not Use
|-
| <code>fat12MediaCluster = $0F00;</code>
| First Cluster - $0F00 + MediaID from BPB Usually $0FF8
|-
| <code>fat12Reserved0 = $0FF0;</code>
| Reserved Cluster Nos - Do Not Use (Due to Media ID on Floppy)
|-
| <code>fat12Reserved1 = $0FF1;</code>
| &nbsp;
|-
| <code>fat12Reserved2 = $0FF2;</code>
| &nbsp;
|-
| <code>fat12Reserved3 = $0FF3;</code>
| &nbsp;
|-
| <code>fat12Reserved4 = $0FF4;</code>
| &nbsp;
|-
| <code>fat12Reserved5 = $0FF5;</code>
| &nbsp;
|-
| <code>fat12Reserved6 = $0FF6;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fat16EndOfFile = $FFF8;</code>
| Some Code sets values from $FFF8 - $FFFF as EOF
|-
| <code>fat16EndOfCluster = $FFFF;</code>
| EOF Mark, Check for >= $FFF8 - See Above
|-
| <code>fat16FreeCluster = $0000;</code>
| Available for Use
|-
| <code>fat16BadCluster = $FFF7;</code>
| Bad Cluster Mark - Do Not Use
|-
| <code>fat16MediaCluster = $FF00;</code>
| First Cluster - $FF00 + MediaID from BPB Usually $FFF8
|-
|colspan="2"|&nbsp;
|-
| <code>fat32EndOfFile = $0FFFFFF8;</code>
| Some Code sets values from $0FFFFFF8 - $0FFFFFFF as EOF
|-
| <code>fat32EndOfCluster = $0FFFFFFF;</code>
| EOF Mark, Check for >= $0FFFFFF8 - See Above
|-
| <code>fat32FreeCluster = $00000000;</code>
| Available for Use
|-
| <code>fat32BadCluster = $0FFFFFF7;</code>
| Bad Cluster Mark - Do Not Use
|-
| <code>fat32MediaCluster = $0FFFFF00;</code>
| First Cluster - $0FFFFF00 + MediaID from BPB Usually $0FFFFFF8
|-
|colspan="2"|&nbsp;
|-
| <code>fat16CleanShutdown = $8000;</code>
| Second Cluster - EndOfCluster + Bits
|-
| <code>fat16HardError = $4000;</code>
| Second Cluster - EndOfCluster + Bits
|-
|colspan="2"|&nbsp;
|-
| <code>fat32CleanShutdown = $08000000;</code>
| Second Cluster - EndOfCluster + Bits
|-
| <code>fat32HardError = $04000000;</code>
| Second Cluster - EndOfCluster + Bits
|-
| <code>fat32ReservedBits = $F0000000;</code>
| Bits 31-29 must be preserved on FAT32
|-
|colspan="2"|&nbsp;
|-
| <code>fatBootSector = 0;</code>
| &nbsp;
|-
| <code>fatFreeCluster = 0;</code>
| &nbsp;
|-
| <code>fatStartCluster = 2;</code>
| Lowest allocatable cluster number
|-
| <code>fatUnevenCluster = $00000001;</code>
| &nbsp;
|-
| <code>fatUnknownCluster = $FFFFFFFF;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>fatEntryFree = $E5;</code>
| &nbsp;
|-
| <code>fatEntryFreeAll = $00;</code>
| &nbsp;
|-
| <code>fatEntrySpecial = $05;</code>
| If real first char is $E5
|-
| <code>fatEntryPadding = $20;</code>
| Padded with spaces (32)
|-
|colspan="2"|&nbsp;
|-
| <code>fatEntrySize = 32;</code>
| Size of a FAT Directory Entry (or LFNDirectoryEntry)
|-
|colspan="2"|&nbsp;
|-
| <code>lfnEntryMax= $3F;</code>
| Maximum count of an LFN entry
|-
| <code>lfnEntryLast = $40;</code>
| Marker for LFN last entry
|-
| <code>lfnEntryMask = $BF;</code>
| Mask for LFN entry count
|-
| <code>lfnEntryChars = 13;</code>
| Number of characters per LFN entry
|-
|colspan="2"|&nbsp;
|-
| <code>lfnEntryNull = $0000;</code>
| Null terminator on LFN when applicable
|-
| <code>lfnEntryPadding = $FFFF;</code>
| Empty LFN chars padded with (65535)
|-
|colspan="2"|&nbsp;
|-
| <code>lfnAttributeMask = (faReadOnly or faHidden or faSysFile or faVolumeID);</code>
| Not Used - See faLongName
|-
|colspan="2"|&nbsp;
|-
| <code>fat32LeadSignature = $41615252;</code>
| RRaA
|-
| <code>fat32StructSignature = $61417272;</code>
| rrAa
|-
| <code>fat32TrailSignature = $AA550000;</code>
| Standard Boot Sector signature
|-
|colspan="2"|&nbsp;
|-
| <code>fatDotChar:Byte = $2E;</code>
| Checked separately from Invalid chars due to . and .. entries
|-
| <code>fatSpaceChar:Byte = $20;</code>
| &nbsp;
|-
| <code>fatBaseChars:set of Byte = [$00..$19];</code>
| 0..31 (Dont include $20 as that is checked separately)
|-
| <code>fatInvalidChars:set of Byte = [$22,$2A,$2B,$2C,$2F,$3A,$3B,$3C,$3D,$3E,$3F,$5B,$5C,$5D,$7C];</code>
| 34,42,43,44,47,58,59,60,61,62,63,91,92,93,124 (Dont include $2E as that is checked separately)
|-
| <code>fatLowercaseChars:set of Byte = [$61..$7A];</code>
| 97..122 (These dont account for the code page)
|-
|}
</div></div>
<br />

=== Type definitions ===
----

'''FATFS specific types'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>TFATType = (ftNONE,ftFAT12,ftFAT16,ftFAT32);</code>
| style="width: 40%;"|
|-
|} 

'''FATFS params''' 

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TFATParams = record </code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: (Not Packed) Block values for various Sector sizes.
|-
| <code>SectorSize:Word;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>FATType:TFATType;</code>
| &nbsp;
|-
| <code>BlockShiftCount:Word;</code>
| &nbsp;
|-
| <code>EntriesPerBlock:LongWord;</code>
| &nbsp;
|-
| <code>SectorsPerBlock:LongWord;</code>
| &nbsp;
|-
|}
</div></div>  
 
'''FATFS geometry'''  

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TFATGeometry = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: (Not Packed) FAT12 values for various Floppy Types.
|-
| <code>FloppyType:TFloppyType;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>SectorsPerFat:LongWord;</code>
| &nbsp;
|-
| <code>SectorsPerCluster:LongWord;</code>
| &nbsp;
|-
| <code>RootEntryCount:LongWord;</code>
| &nbsp;
|-
| <code>MediaId:Byte;</code>
| &nbsp;
|-
|}
</div></div>
 
'''FATFS cluster size''' 

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TFATClusterSize = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: (Not Packed) Sectors per Cluster for various disk sizes (Fixed Disk only).
|-
| <code>SectorCount:LongWord;</code>
| Based on 512 bytes per sector only
|-
| <code>SectorsPerCluster:LongWord;</code>
| &nbsp;
|-
|}
</div></div>

'''FATFS partition type''' 

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TFATPartitionType = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: (Not Packed) Partition Type for various disk sizes (Fixed Disk only).
|-
| <code>Excluded:Boolean;</code>
| Entry is excluded from FAT Partition Type check
|-
| <code>Extended:Boolean;</code>
| &nbsp;
|-
| <code>SectorCount:LongWord;</code>
| Based on 512 bytes per sector only
|-
| <code>PartitionId:Byte;</code>
| &nbsp;
|-
| <code>LBAType:Byte;</code>
| &nbsp;
|-
|}
</div></div>

'''FATFS name''' 

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PFATName = ^TFATName;</code>

<code>TFATName = packed record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: 11 Bytes
|-
| <code>Name:array[0..7] of Char;</code>
| File Name
|-
| <code>Ext:array[0..2] of Char;</code>
| File Extension
|-
|}
</div></div>

'''FATSFS directory''' 

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PFATDirectory = ^TFATDirectory;</code>

<code>TFATDirectory = packed record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: 32 Bytes
|-
| <code>Name:array[0..7] of Char;</code>
| File Name
|-
| <code>Ext:array[0..2] of Char;</code>
| File Extension
|-
| <code>Attribute:Byte;</code>
| File Attributes - See Standard Values
|-
| <code>Reserved:Byte;</code>
| Always 0 (See below)
|-
| <code>CaseFlags:Byte;</code>
| Set to $08 if Name, $10 if Extension or $18 if both
|-
| <code>CreateTimeMsecs:Byte;</code>
| &nbsp;
|-
| <code>CreateTime:Word;</code>
| &nbsp;
|-
| <code>CreateDate:Word;</code>
| &nbsp;
|-
| <code>LastAccessDate:Word;</code>
| &nbsp;
|-
| <code>FirstClusterHigh:Word;</code>
| High word of the start cluster (FAT32 Only)
|-
| <code>WriteTime:Word;</code>
| &nbsp;
|-
| <code>WriteDate:Word;</code>
| &nbsp;
|-
| <code>FirstClusterLow:Word;</code>
| Low Word of Start Cluster all versions
|-
| <code>Length:LongWord;</code>
| &nbsp;
|-
|}
</div></div>  
 
'''LFN directory'''  

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PLFNDirectory = ^TLFNDirectory;</code>

<code>TLFNDirectory = packed record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: 32 Bytes
|-
| <code>Order:Byte;</code>
| Bit 6 = 1 if last LFN in chain, Bits 5-0 = Order of LFN chunks for this File
|-
| <code>Name1:array[0..4] of WideChar;</code>
| First 5 Characters in this chunk
|-
| <code>Attribute:Byte;</code>
| Always 0Fh - Volume, System, Hidden, ReadOnly
|-
| <code>FileType:Byte;</code>
| Usually 00h
|-
| <code>Checksum:Byte;</code>
| Checksum calculated on 8.3 name
|-
| <code>Name2:array[0..5] of WideChar;</code>
| Next 6 Characters in this chunk
|-
| <code>Reserved:Word;</code>
| Always 0000h - FirstCluster in Standard Entry
|-
| <code>Name3:array[0..1] of WideChar;</code>
| Next 2 Characters in this chunk
|-
|}
</div></div>

'''FATFS info sector'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PFATInfoSector = ^TFATInfoSector;</code>

<code>TFATInfoSector = packed record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>LeadSignature:LongWord;</code>
| Signature "RRaA" or 41615252h
|-
| <code>Reserved1:array[0..479] of Byte;</code>
| Always 0
|-
| <code>StructureSignature:LongWord;</code>
| Signature "rrAa" or 61417272h
|-
| <code>FreeClusterCount:LongWord;</code>
| Free Clusters $FFFFFFFF if unknown
|-
| <code>LastFreeCluster:LongWord;</code>
| Most recently allocated cluster $FFFFFFFF if unknown
|-
| <code>Reserved2:array[0..11] of Byte;</code>
| Always 0
|-
| <code>TrailSignature:LongWord;</code>
| Signature AA550000h
|-
|}
</div></div>
<br />

=== Class definitions ===
----

''To be documented''

=== Public variables ===
----

''None defined''

=== Function declarations ===
----


'''Initialization functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure FATFSInit;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! '''Note'''
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure FATFSQuit;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! '''Note'''
| None documented
|-
|}
</div></div>
<br />

'''FATFS helper functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function FATTypeToString(AType:TFATType):String;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! '''Note'''
| None documented
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]