[mirror_edk2.git] / FatPkg / EnhancedFatDxe / Misc.c

/*++\r
\r
Copyright (c) 2005 - 2010, Intel Corporation\r
All rights reserved. This program and the accompanying materials are licensed and made available\r
under the terms and conditions of the BSD License which accompanies this\r
distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
Module Name:\r
\r
  Misc.c\r
\r
Abstract:\r
\r
  Miscellaneous functions\r
\r
Revision History\r
\r
--*/\r
\r
#include "Fat.h"\r
\r
EFI_STATUS\r
FatAccessVolumeDirty (\r
  IN FAT_VOLUME       *Volume,\r
  IN IO_MODE          IoMode,\r
  IN VOID             *DirtyValue\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Set the volume as dirty or not\r
\r
Arguments:\r
\r
  Volume                - FAT file system volume.\r
  IoMode                - The access mode.\r
  DirtyValue            - Set the volume as dirty or not.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Set the new FAT entry value sucessfully.\r
  other                 - An error occurred when operation the FAT entries.\r
\r
--*/\r
{\r
  UINTN WriteCount;\r
\r
  WriteCount = Volume->FatEntrySize;\r
  return FatDiskIo (Volume, IoMode, Volume->FatPos + WriteCount, WriteCount, DirtyValue);\r
}\r
\r
EFI_STATUS\r
FatDiskIo (\r
  IN     FAT_VOLUME       *Volume,\r
  IN     IO_MODE          IoMode,\r
  IN     UINT64           Offset,\r
  IN     UINTN            BufferSize,\r
  IN OUT VOID             *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  General disk access function\r
\r
Arguments:\r
\r
  Volume                - FAT file system volume.\r
  IoMode                - The access mode (disk read/write or cache access).\r
  Offset                - The starting byte offset to read from.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing read data.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - The operation is performed successfully.\r
  EFI_VOLUME_CORRUPTED  - The accesss is\r
  Others                - The status of read/write the disk\r
\r
--*/\r
{\r
  EFI_STATUS            Status;\r
  EFI_DISK_IO_PROTOCOL  *DiskIo;\r
  EFI_DISK_READ         IoFunction;\r
\r
  //\r
  // Verify the IO is in devices range\r
  //\r
  Status = EFI_VOLUME_CORRUPTED;\r
  if (Offset + BufferSize <= Volume->VolumeSize) {\r
    if (CACHE_ENABLED (IoMode)) {\r
      //\r
      // Access cache\r
      //\r
      Status = FatAccessCache (Volume, CACHE_TYPE (IoMode), RAW_ACCESS (IoMode), Offset, BufferSize, Buffer);\r
    } else {\r
      //\r
      // Access disk directly\r
      //\r
      DiskIo      = Volume->DiskIo;\r
      IoFunction  = (IoMode == READ_DISK) ? DiskIo->ReadDisk : DiskIo->WriteDisk;\r
      Status      = IoFunction (DiskIo, Volume->MediaId, Offset, BufferSize, Buffer);\r
    }\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    Volume->DiskError = TRUE;\r
    DEBUG ((EFI_D_INFO, "FatDiskIo: error %r\n", Status));\r
  }\r
\r
  return Status;\r
}\r
\r
VOID\r
FatAcquireLock (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Lock the volume.\r
\r
Arguments:\r
\r
  None.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  EfiAcquireLock (&FatFsLock);\r
}\r
\r
EFI_STATUS\r
FatAcquireLockOrFail (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Lock the volume.\r
  If the lock is already in the acquired state, then EFI_ACCESS_DENIED is returned.\r
  Otherwise, EFI_SUCCESS is returned.\r
\r
Arguments:\r
\r
  None.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - The volume is locked.\r
  EFI_ACCESS_DENIED     - The volume could not be locked because it is already locked.\r
\r
--*/\r
{\r
  return EfiAcquireLockOrFail (&FatFsLock);\r
}\r
\r
VOID\r
FatReleaseLock (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Unlock the volume.\r
\r
Arguments:\r
\r
  Null.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  EfiReleaseLock (&FatFsLock);\r
}\r
\r
VOID\r
FatFreeDirEnt (\r
  IN FAT_DIRENT       *DirEnt\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Free directory entry.\r
\r
Arguments:\r
\r
  DirEnt                - The directory entry to be freed.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  if (DirEnt->FileString != NULL) {\r
    FreePool (DirEnt->FileString);\r
  }\r
\r
  FreePool (DirEnt);\r
}\r
\r
VOID\r
FatFreeVolume (\r
  IN FAT_VOLUME       *Volume\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Free volume structure (including the contents of directory cache and disk cache).\r
\r
Arguments:\r
\r
  Volume                - The volume structure to be freed.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  //\r
  // Free disk cache\r
  //\r
  if (Volume->CacheBuffer != NULL) {\r
    FreePool (Volume->CacheBuffer);\r
  }\r
  //\r
  // Free directory cache\r
  //\r
  FatCleanupODirCache (Volume);\r
  FreePool (Volume);\r
}\r
\r
VOID\r
FatEfiTimeToFatTime (\r
  IN  EFI_TIME        *ETime,\r
  OUT FAT_DATE_TIME   *FTime\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Translate EFI time to FAT time.\r
\r
Arguments:\r
\r
  ETime                 - The time of EFI_TIME.\r
  FTime                 - The time of FAT_DATE_TIME.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  //\r
  // ignores timezone info in source ETime\r
  //\r
  if (ETime->Year > 1980) {\r
    FTime->Date.Year = (UINT16) (ETime->Year - 1980);\r
  }\r
\r
  if (ETime->Year >= 1980 + FAT_MAX_YEAR_FROM_1980) {\r
    FTime->Date.Year = FAT_MAX_YEAR_FROM_1980;\r
  }\r
\r
  FTime->Date.Month         = ETime->Month;\r
  FTime->Date.Day           = ETime->Day;\r
  FTime->Time.Hour          = ETime->Hour;\r
  FTime->Time.Minute        = ETime->Minute;\r
  FTime->Time.DoubleSecond  = (UINT16) (ETime->Second / 2);\r
}\r
\r
VOID\r
FatFatTimeToEfiTime (\r
  IN  FAT_DATE_TIME     *FTime,\r
  OUT EFI_TIME          *ETime\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Translate Fat time to EFI time.\r
\r
Arguments:\r
\r
  FTime                 - The time of FAT_DATE_TIME.\r
  ETime                 - The time of EFI_TIME.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  ETime->Year       = (UINT16) (FTime->Date.Year + 1980);\r
  ETime->Month      = (UINT8) FTime->Date.Month;\r
  ETime->Day        = (UINT8) FTime->Date.Day;\r
  ETime->Hour       = (UINT8) FTime->Time.Hour;\r
  ETime->Minute     = (UINT8) FTime->Time.Minute;\r
  ETime->Second     = (UINT8) (FTime->Time.DoubleSecond * 2);\r
  ETime->Nanosecond = 0;\r
  ETime->TimeZone   = EFI_UNSPECIFIED_TIMEZONE;\r
  ETime->Daylight   = 0;\r
}\r
\r
VOID\r
FatGetCurrentFatTime (\r
  OUT FAT_DATE_TIME   *FatNow\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Get Current FAT time.\r
\r
Arguments:\r
\r
  FatNow                - Current FAT time.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  EFI_TIME  Now;\r
  gRT->GetTime (&Now, NULL);\r
  FatEfiTimeToFatTime (&Now, FatNow);\r
}\r
\r
BOOLEAN\r
FatIsValidTime (\r
  IN EFI_TIME         *Time\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Check whether a time is valid.\r
\r
Arguments:\r
\r
  Time                  - The time of EFI_TIME.\r
\r
Returns:\r
\r
  TRUE                  - The time is valid.\r
  FALSE                 - The time is not valid.\r
\r
--*/\r
{\r
  static UINT8  MonthDays[] = { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };\r
  UINTN         Day;\r
  BOOLEAN       ValidTime;\r
\r
  ValidTime = TRUE;\r
\r
  //\r
  // Check the fields for range problems\r
  // Fat can only support from 1980\r
  //\r
  if (Time->Year < 1980 ||\r
      Time->Month < 1 ||\r
      Time->Month > 12 ||\r
      Time->Day < 1 ||\r
      Time->Day > 31 ||\r
      Time->Hour > 23 ||\r
      Time->Minute > 59 ||\r
      Time->Second > 59 ||\r
      Time->Nanosecond > 999999999\r
      ) {\r
\r
    ValidTime = FALSE;\r
\r
  } else {\r
    //\r
    // Perform a more specific check of the day of the month\r
    //\r
    Day = MonthDays[Time->Month - 1];\r
    if (Time->Month == 2 && IS_LEAP_YEAR (Time->Year)) {\r
      Day += 1;\r
      //\r
      // 1 extra day this month\r
      //\r
    }\r
    if (Time->Day > Day) {\r
      ValidTime = FALSE;\r
    }\r
  }\r
\r
  return ValidTime;\r
}\r
Commit	Line	Data
b9ec9330 QH	1	/*++\r
b9ec9330 QH	2	\r
25ce9b1f	3	Copyright (c) 2005 - 2010, Intel Corporation\r
b9ec9330 QH	4	All rights reserved. This program and the accompanying materials are licensed and made available\r
	5	under the terms and conditions of the BSD License which accompanies this\r
	6	distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	\r
	13	Module Name:\r
	14	\r
	15	Misc.c\r
	16	\r
	17	Abstract:\r
	18	\r
	19	Miscellaneous functions\r
	20	\r
	21	Revision History\r
	22	\r
	23	--*/\r
	24	\r
	25	#include "Fat.h"\r
	26	\r
	27	EFI_STATUS\r
	28	FatAccessVolumeDirty (\r
	29	IN FAT_VOLUME *Volume,\r
	30	IN IO_MODE IoMode,\r
	31	IN VOID *DirtyValue\r
	32	)\r
	33	/*++\r
	34	\r
	35	Routine Description:\r
	36	\r
	37	Set the volume as dirty or not\r
	38	\r
	39	Arguments:\r
	40	\r
	41	Volume - FAT file system volume.\r
	42	IoMode - The access mode.\r
	43	DirtyValue - Set the volume as dirty or not.\r
	44	\r
	45	Returns:\r
	46	\r
	47	EFI_SUCCESS - Set the new FAT entry value sucessfully.\r
	48	other - An error occurred when operation the FAT entries.\r
	49	\r
	50	--*/\r
	51	{\r
	52	UINTN WriteCount;\r
	53	\r
	54	WriteCount = Volume->FatEntrySize;\r
	55	return FatDiskIo (Volume, IoMode, Volume->FatPos + WriteCount, WriteCount, DirtyValue);\r
	56	}\r
	57	\r
	58	EFI_STATUS\r
	59	FatDiskIo (\r
	60	IN FAT_VOLUME *Volume,\r
	61	IN IO_MODE IoMode,\r
	62	IN UINT64 Offset,\r
	63	IN UINTN BufferSize,\r
	64	IN OUT VOID *Buffer\r
	65	)\r
	66	/*++\r
	67	\r
68	Routine Description:\r
69	\r
70	General disk access function\r
71	\r
72	Arguments:\r
73	\r
74	Volume - FAT file system volume.\r
75	IoMode - The access mode (disk read/write or cache access).\r
76	Offset - The starting byte offset to read from.\r
77	BufferSize - Size of Buffer.\r
78	Buffer - Buffer containing read data.\r
79	\r
80	Returns:\r
81	\r
82	EFI_SUCCESS - The operation is performed successfully.\r
83	EFI_VOLUME_CORRUPTED - The accesss is\r
84	Others - The status of read/write the disk\r
85	\r
86	--*/\r
87	{\r
88	EFI_STATUS Status;\r
89	EFI_DISK_IO_PROTOCOL *DiskIo;\r
90	EFI_DISK_READ IoFunction;\r
91	\r
92	//\r
93	// Verify the IO is in devices range\r
94	//\r
95	Status = EFI_VOLUME_CORRUPTED;\r
96	if (Offset + BufferSize <= Volume->VolumeSize) {\r
97	if (CACHE_ENABLED (IoMode)) {\r
98	//\r
99	// Access cache\r
100	//\r
101	Status = FatAccessCache (Volume, CACHE_TYPE (IoMode), RAW_ACCESS (IoMode), Offset, BufferSize, Buffer);\r
102	} else {\r
103	//\r
104	// Access disk directly\r
105	//\r
106	DiskIo = Volume->DiskIo;\r
107	IoFunction = (IoMode == READ_DISK) ? DiskIo->ReadDisk : DiskIo->WriteDisk;\r
108	Status = IoFunction (DiskIo, Volume->MediaId, Offset, BufferSize, Buffer);\r
109	}\r
110	}\r
111	\r
112	if (EFI_ERROR (Status)) {\r
113	Volume->DiskError = TRUE;\r
114	DEBUG ((EFI_D_INFO, "FatDiskIo: error %r\n", Status));\r
115	}\r
116	\r
117	return Status;\r
118	}\r
119	\r
120	VOID\r
121	FatAcquireLock (\r
122	VOID\r
123	)\r
124	/*++\r
125	\r
126	Routine Description:\r
127	\r
128	Lock the volume.\r
129	\r
130	Arguments:\r
131	\r
132	None.\r
133	\r
134	Returns:\r
135	\r
136	None.\r
137	\r
138	--*/\r
139	{\r
140	EfiAcquireLock (&FatFsLock);\r
141	}\r
142	\r
25ce9b1f QH	143	EFI_STATUS\r
25ce9b1f QH	144	FatAcquireLockOrFail (\r
b9ec9330 QH	145	VOID\r
	146	)\r
	147	/*++\r
	148	\r
	149	Routine Description:\r
	150	\r
25ce9b1f QH	151	Lock the volume.\r
	152	If the lock is already in the acquired state, then EFI_ACCESS_DENIED is returned.\r
	153	Otherwise, EFI_SUCCESS is returned.\r
b9ec9330 QH	154	\r
	155	Arguments:\r
	156	\r
	157	None.\r
	158	\r
	159	Returns:\r
	160	\r
25ce9b1f QH	161	EFI_SUCCESS - The volume is locked.\r
25ce9b1f QH	162	EFI_ACCESS_DENIED - The volume could not be locked because it is already locked.\r
b9ec9330 QH	163	\r
	164	--*/\r
	165	{\r
25ce9b1f	166	return EfiAcquireLockOrFail (&FatFsLock);\r
b9ec9330 QH	167	}\r
	168	\r
	169	VOID\r
	170	FatReleaseLock (\r
	171	VOID\r
	172	)\r
	173	/*++\r
	174	\r
	175	Routine Description:\r
	176	\r
	177	Unlock the volume.\r
	178	\r
	179	Arguments:\r
	180	\r
	181	Null.\r
	182	\r
	183	Returns:\r
	184	\r
	185	None.\r
	186	\r
	187	--*/\r
	188	{\r
	189	EfiReleaseLock (&FatFsLock);\r
	190	}\r
	191	\r
	192	VOID\r
	193	FatFreeDirEnt (\r
	194	IN FAT_DIRENT *DirEnt\r
	195	)\r
	196	/*++\r
	197	\r
	198	Routine Description:\r
	199	\r
	200	Free directory entry.\r
	201	\r
	202	Arguments:\r
	203	\r
	204	DirEnt - The directory entry to be freed.\r
	205	\r
	206	Returns:\r
	207	\r
	208	None.\r
	209	\r
	210	--*/\r
	211	{\r
	212	if (DirEnt->FileString != NULL) {\r
	213	FreePool (DirEnt->FileString);\r
	214	}\r
	215	\r
	216	FreePool (DirEnt);\r
	217	}\r
	218	\r
	219	VOID\r
	220	FatFreeVolume (\r
	221	IN FAT_VOLUME *Volume\r
	222	)\r
	223	/*++\r
	224	\r
	225	Routine Description:\r
	226	\r
	227	Free volume structure (including the contents of directory cache and disk cache).\r
	228	\r
	229	Arguments:\r
	230	\r
231	Volume - The volume structure to be freed.\r
232	\r
233	Returns:\r
234	\r
235	None.\r
236	\r
237	--*/\r
238	{\r
239	//\r
240	// Free disk cache\r
241	//\r
242	if (Volume->CacheBuffer != NULL) {\r
243	FreePool (Volume->CacheBuffer);\r
244	}\r
245	//\r
246	// Free directory cache\r
247	//\r
248	FatCleanupODirCache (Volume);\r
249	FreePool (Volume);\r
250	}\r
251	\r
252	VOID\r
253	FatEfiTimeToFatTime (\r
254	IN EFI_TIME *ETime,\r
255	OUT FAT_DATE_TIME *FTime\r
256	)\r
257	/*++\r
258	\r
259	Routine Description:\r
260	\r
261	Translate EFI time to FAT time.\r
262	\r
263	Arguments:\r
264	\r
265	ETime - The time of EFI_TIME.\r
266	FTime - The time of FAT_DATE_TIME.\r
267	\r
268	Returns:\r
269	\r
270	None.\r
271	\r
272	--*/\r
273	{\r
274	//\r
275	// ignores timezone info in source ETime\r
276	//\r
277	if (ETime->Year > 1980) {\r
278	FTime->Date.Year = (UINT16) (ETime->Year - 1980);\r
279	}\r
280	\r
281	if (ETime->Year >= 1980 + FAT_MAX_YEAR_FROM_1980) {\r
282	FTime->Date.Year = FAT_MAX_YEAR_FROM_1980;\r
283	}\r
284	\r
285	FTime->Date.Month = ETime->Month;\r
286	FTime->Date.Day = ETime->Day;\r
287	FTime->Time.Hour = ETime->Hour;\r
288	FTime->Time.Minute = ETime->Minute;\r
289	FTime->Time.DoubleSecond = (UINT16) (ETime->Second / 2);\r
290	}\r
291	\r
292	VOID\r
293	FatFatTimeToEfiTime (\r
294	IN FAT_DATE_TIME *FTime,\r
295	OUT EFI_TIME *ETime\r
296	)\r
297	/*++\r
298	\r
299	Routine Description:\r
300	\r
301	Translate Fat time to EFI time.\r
302	\r
303	Arguments:\r
304	\r
305	FTime - The time of FAT_DATE_TIME.\r
306	ETime - The time of EFI_TIME.\r
307	\r
308	Returns:\r
309	\r
310	None.\r
311	\r
312	--*/\r
313	{\r
314	ETime->Year = (UINT16) (FTime->Date.Year + 1980);\r
315	ETime->Month = (UINT8) FTime->Date.Month;\r
316	ETime->Day = (UINT8) FTime->Date.Day;\r
317	ETime->Hour = (UINT8) FTime->Time.Hour;\r
318	ETime->Minute = (UINT8) FTime->Time.Minute;\r
319	ETime->Second = (UINT8) (FTime->Time.DoubleSecond * 2);\r
320	ETime->Nanosecond = 0;\r
321	ETime->TimeZone = EFI_UNSPECIFIED_TIMEZONE;\r
322	ETime->Daylight = 0;\r
323	}\r
324	\r
325	VOID\r
326	FatGetCurrentFatTime (\r
327	OUT FAT_DATE_TIME *FatNow\r
328	)\r
329	/*++\r
330	\r
331	Routine Description:\r
332	\r
333	Get Current FAT time.\r
334	\r
335	Arguments:\r
336	\r
337	FatNow - Current FAT time.\r
338	\r
339	Returns:\r
340	\r
341	None.\r
342	\r
343	--*/\r
344	{\r
345	EFI_TIME Now;\r
346	gRT->GetTime (&Now, NULL);\r
347	FatEfiTimeToFatTime (&Now, FatNow);\r
348	}\r
349	\r
350	BOOLEAN\r
351	FatIsValidTime (\r
352	IN EFI_TIME *Time\r
353	)\r
354	/*++\r
355	\r
356	Routine Description:\r
357	\r
358	Check whether a time is valid.\r
359	\r
360	Arguments:\r
361	\r
362	Time - The time of EFI_TIME.\r
363	\r
364	Returns:\r
365	\r
366	TRUE - The time is valid.\r
367	FALSE - The time is not valid.\r
368	\r
369	--*/\r
370	{\r
371	static UINT8 MonthDays[] = { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };\r
372	UINTN Day;\r
373	BOOLEAN ValidTime;\r
374	\r
375	ValidTime = TRUE;\r
376	\r
377	//\r
378	// Check the fields for range problems\r
379	// Fat can only support from 1980\r
380	//\r
381	if (Time->Year < 1980 \|\|\r
382	Time->Month < 1 \|\|\r
383	Time->Month > 12 \|\|\r
384	Time->Day < 1 \|\|\r
385	Time->Day > 31 \|\|\r
386	Time->Hour > 23 \|\|\r
387	Time->Minute > 59 \|\|\r
388	Time->Second > 59 \|\|\r
389	Time->Nanosecond > 999999999\r
390	) {\r
391	\r
392	ValidTime = FALSE;\r
393	\r
394	} else {\r
395	//\r
396	// Perform a more specific check of the day of the month\r
397	//\r
398	Day = MonthDays[Time->Month - 1];\r
399	if (Time->Month == 2 && IS_LEAP_YEAR (Time->Year)) {\r
400	Day += 1;\r
401	//\r
402	// 1 extra day this month\r
403	//\r
404	}\r
405	if (Time->Day > Day) {\r
406	ValidTime = FALSE;\r
407	}\r
408	}\r
409	\r
410	return ValidTime;\r
411	}\r