]> git.proxmox.com Git - mirror_edk2.git/blame - FatPkg/EnhancedFatDxe/FatFileSystem.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
FatPkg: Refine casting expression result to bigger size
[mirror_edk2.git] / FatPkg / EnhancedFatDxe / FatFileSystem.h
CommitLineData
cae7420b
DB		 1/** @file\r
2 Definitions for on-disk FAT structures.\r
b9ec9330 3\r
4c5ee6a6 4Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>\r
6163cc98 5This program and the accompanying materials are licensed and made available\r
b9ec9330
QH		 6under the terms and conditions of the BSD License which accompanies this\r
7distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13\r
cae7420b 14**/\r
b9ec9330
QH		 15\r
16#ifndef _FATFILESYSTEM_H_\r
17#define _FATFILESYSTEM_H_\r
18\r
19#pragma pack(1)\r
20//\r
21// FAT info signature\r
22//\r
23#define FAT_INFO_SIGNATURE 0x41615252\r
24#define FAT_INFO_BEGIN_SIGNATURE 0x61417272\r
25#define FAT_INFO_END_SIGNATURE 0xAA550000\r
26//\r
27// FAT entry values\r
28//\r
4c5ee6a6 29#define FAT_CLUSTER_SPECIAL_EXT (MAX_UINTN & (~0xF))\r
b9ec9330
QH		 30#define FAT_CLUSTER_SPECIAL ((FAT_CLUSTER_SPECIAL_EXT) | 0x07)\r
31#define FAT_CLUSTER_FREE 0\r
32#define FAT_CLUSTER_RESERVED (FAT_CLUSTER_SPECIAL)\r
33#define FAT_CLUSTER_BAD (FAT_CLUSTER_SPECIAL)\r
34#define FAT_CLUSTER_LAST (-1)\r
35#define FAT_END_OF_FAT_CHAIN(Cluster) ((Cluster) > (FAT_CLUSTER_SPECIAL))\r
36#define FAT_MIN_CLUSTER 2\r
37#define FAT_MAX_FAT12_CLUSTER 0xFF5\r
38#define FAT_MAX_FAT16_CLUSTER 0xFFF5\r
39#define FAT_CLUSTER_SPECIAL_FAT12 0xFF7\r
40#define FAT_CLUSTER_SPECIAL_FAT16 0xFFF7\r
41#define FAT_CLUSTER_SPECIAL_FAT32 0x0FFFFFF7\r
42#define FAT_CLUSTER_MASK_FAT12 0xFFF\r
43#define FAT_CLUSTER_UNMASK_FAT12 0xF000\r
44#define FAT_CLUSTER_MASK_FAT32 0x0FFFFFFF\r
45#define FAT_CLUSTER_UNMASK_FAT32 0xF0000000\r
46#define FAT_POS_FAT12(a) ((a) * 3 / 2)\r
47#define FAT_POS_FAT16(a) ((a) * 2)\r
48#define FAT_POS_FAT32(a) ((a) * 4)\r
49#define FAT_ODD_CLUSTER_FAT12(a) (((a) & 1) != 0)\r
50\r
51\r
52//\r
53// FAT attribute define\r
54//\r
55#define FAT_ATTRIBUTE_READ_ONLY 0x01\r
56#define FAT_ATTRIBUTE_HIDDEN 0x02\r
57#define FAT_ATTRIBUTE_SYSTEM 0x04\r
58#define FAT_ATTRIBUTE_VOLUME_ID 0x08\r
59#define FAT_ATTRIBUTE_DIRECTORY 0x10\r
60#define FAT_ATTRIBUTE_ARCHIVE 0x20\r
61#define FAT_ATTRIBUTE_DEVICE 0x40\r
62#define FAT_ATTRIBUTE_LFN 0x0F\r
63//\r
64// Some Long File Name definitions\r
65//\r
66#define FAT_LFN_LAST 0x40 // Ordinal field\r
67#define MAX_LFN_ENTRIES 20\r
68#define LFN_CHAR1_LEN 5\r
69#define LFN_CHAR2_LEN 6\r
70#define LFN_CHAR3_LEN 2\r
71#define LFN_CHAR_TOTAL (LFN_CHAR1_LEN + LFN_CHAR2_LEN + LFN_CHAR3_LEN)\r
72#define LFN_ENTRY_NUMBER(a) (((a) + LFN_CHAR_TOTAL - 1) / LFN_CHAR_TOTAL)\r
73//\r
74// Some 8.3 File Name definitions\r
75//\r
76#define FAT_MAIN_NAME_LEN 8\r
77#define FAT_EXTEND_NAME_LEN 3\r
78#define FAT_NAME_LEN (FAT_MAIN_NAME_LEN + FAT_EXTEND_NAME_LEN)\r
79//\r
80// Some directory entry information\r
81//\r
82#define FAT_ENTRY_INFO_OFFSET 13\r
83#define DELETE_ENTRY_MARK 0xE5\r
84#define EMPTY_ENTRY_MARK 0x00\r
85\r
86//\r
87// Volume dirty Mask\r
88//\r
89#define FAT16_DIRTY_MASK 0x7fff\r
90#define FAT32_DIRTY_MASK 0xf7ffffff\r
91//\r
92// internal flag\r
93//\r
94#define FAT_CASE_MIXED 0x01\r
95#define FAT_CASE_NAME_LOWER 0x08\r
96#define FAT_CASE_EXT_LOWER 0x10\r
97\r
98typedef struct {\r
99 UINT8 Ia32Jump[3];\r
100 CHAR8 OemId[8];\r
101 UINT16 SectorSize;\r
102 UINT8 SectorsPerCluster;\r
103 UINT16 ReservedSectors;\r
104 UINT8 NumFats;\r
105 UINT16 RootEntries; // < FAT32, root dir is fixed size\r
106 UINT16 Sectors;\r
107 UINT8 Media;\r
108 UINT16 SectorsPerFat; // < FAT32\r
109 UINT16 SectorsPerTrack; // (ignored)\r
110 UINT16 Heads; // (ignored)\r
111 UINT32 HiddenSectors; // (ignored)\r
112 UINT32 LargeSectors; // Used if Sectors==0\r
113} FAT_BOOT_SECTOR_BASIC;\r
114\r
115typedef struct {\r
116 UINT8 PhysicalDriveNumber; // (ignored)\r
117 UINT8 CurrentHead; // holds boot_sector_dirty bit\r
118 UINT8 Signature; // (ignored)\r
119 CHAR8 Id[4];\r
120 CHAR8 FatLabel[11];\r
121 CHAR8 SystemId[8];\r
122} FAT_BOOT_SECTOR_EXT;\r
123\r
124typedef struct {\r
125 UINT32 LargeSectorsPerFat; // FAT32\r
126 UINT16 ExtendedFlags; // FAT32 (ignored)\r
127 UINT16 FsVersion; // FAT32 (ignored)\r
128 UINT32 RootDirFirstCluster; // FAT32\r
129 UINT16 FsInfoSector; // FAT32\r
130 UINT16 BackupBootSector; // FAT32\r
131 UINT8 Reserved[12]; // FAT32 (ignored)\r
132 UINT8 PhysicalDriveNumber; // (ignored)\r
133 UINT8 CurrentHead; // holds boot_sector_dirty bit\r
134 UINT8 Signature; // (ignored)\r
135 CHAR8 Id[4];\r
136 CHAR8 FatLabel[11];\r
137 CHAR8 SystemId[8];\r
138} FAT32_BOOT_SECTOR_EXT;\r
139\r
6b7e4498 140typedef union {\r
b9ec9330
QH		 141 FAT_BOOT_SECTOR_EXT FatBse;\r
142 FAT32_BOOT_SECTOR_EXT Fat32Bse;\r
6b7e4498
DB		 143 } FAT_BSE;\r
144\r
145typedef struct {\r
146 FAT_BOOT_SECTOR_BASIC FatBsb;\r
147 FAT_BSE FatBse;\r
b9ec9330
QH		 148} FAT_BOOT_SECTOR;\r
149\r
150//\r
151// FAT Info Structure\r
152//\r
153typedef struct {\r
154 UINT32 ClusterCount;\r
155 UINT32 NextCluster;\r
156} FAT_FREE_INFO;\r
157\r
158typedef struct {\r
159 UINT32 Signature;\r
160 UINT8 ExtraBootCode[480];\r
161 UINT32 InfoBeginSignature;\r
162 FAT_FREE_INFO FreeInfo;\r
163 UINT8 Reserved[12];\r
164 UINT32 InfoEndSignature;\r
165} FAT_INFO_SECTOR;\r
166\r
167//\r
168// Directory Entry\r
169//\r
170#define FAT_MAX_YEAR_FROM_1980 0x7f\r
171typedef struct {\r
172 UINT16 Day : 5;\r
173 UINT16 Month : 4;\r
174 UINT16 Year : 7; // From 1980\r
175} FAT_DATE;\r
176\r
177typedef struct {\r
178 UINT16 DoubleSecond : 5;\r
179 UINT16 Minute : 6;\r
180 UINT16 Hour : 5;\r
181} FAT_TIME;\r
182\r
183typedef struct {\r
184 FAT_TIME Time;\r
185 FAT_DATE Date;\r
186} FAT_DATE_TIME;\r
187\r
188typedef struct {\r
189 CHAR8 FileName[11]; // 8.3 filename\r
190 UINT8 Attributes;\r
191 UINT8 CaseFlag;\r
192 UINT8 CreateMillisecond; // (creation milliseconds - ignored)\r
193 FAT_DATE_TIME FileCreateTime;\r
194 FAT_DATE FileLastAccess;\r
195 UINT16 FileClusterHigh; // >= FAT32\r
196 FAT_DATE_TIME FileModificationTime;\r
197 UINT16 FileCluster;\r
198 UINT32 FileSize;\r
199} FAT_DIRECTORY_ENTRY;\r
200\r
201typedef struct {\r
202 UINT8 Ordinal;\r
203 CHAR8 Name1[10]; // (Really 5 chars, but not WCHAR aligned)\r
204 UINT8 Attributes;\r
205 UINT8 Type;\r
206 UINT8 Checksum;\r
207 CHAR16 Name2[6];\r
208 UINT16 MustBeZero;\r
209 CHAR16 Name3[2];\r
210} FAT_DIRECTORY_LFN;\r
211\r
212#pragma pack()\r
213\r
214#endif\r
EFI Development Kit II mirror for PVE