3 Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>
4 This program and the accompanying materials are licensed and made available
5 under the terms and conditions of the BSD License which accompanies this
6 distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 Routines dealing with file open
30 OUT FAT_IFILE
**PtrIFile
36 Create an Open instance for the existing OFile.
37 The IFile of the newly opened file is passed out.
41 OFile - The file that serves as a starting reference point.
42 PtrIFile - The newly generated IFile instance.
46 EFI_OUT_OF_RESOURCES - Can not allocate the memory for the IFile
47 EFI_SUCCESS - Create the new IFile for the OFile successfully
53 ASSERT_VOLUME_LOCKED (OFile
->Volume
);
56 // Allocate a new open instance
58 IFile
= AllocateZeroPool (sizeof (FAT_IFILE
));
60 return EFI_OUT_OF_RESOURCES
;
63 IFile
->Signature
= FAT_IFILE_SIGNATURE
;
65 CopyMem (&(IFile
->Handle
), &FatFileInterface
, sizeof (EFI_FILE_PROTOCOL
));
68 // Report the correct revision number based on the DiskIo2 availability
70 if (OFile
->Volume
->DiskIo2
!= NULL
) {
71 IFile
->Handle
.Revision
= EFI_FILE_PROTOCOL_REVISION2
;
73 IFile
->Handle
.Revision
= EFI_FILE_PROTOCOL_REVISION
;
77 InsertTailList (&OFile
->Opens
, &IFile
->Link
);
78 InitializeListHead (&IFile
->Tasks
);
87 OUT FAT_IFILE
**NewIFile
,
96 Open a file for a file name relative to an existing OFile.
97 The IFile of the newly opened file is passed out.
101 OFile - The file that serves as a starting reference point.
102 NewIFile - The newly generated IFile instance.
103 FileName - The file name relative to the OFile.
104 OpenMode - Open mode.
105 Attributes - Attributes to set if the file is created.
109 EFI_SUCCESS - Open the file successfully.
110 EFI_INVALID_PARAMETER - The open mode is conflict with the attributes
111 or the file name is not valid.
112 EFI_NOT_FOUND - Conficts between dir intention and attribute.
113 EFI_WRITE_PROTECTED - Can't open for write if the volume is read only.
114 EFI_ACCESS_DENIED - If the file's attribute is read only, and the
115 open is for read-write fail it.
116 EFI_OUT_OF_RESOURCES - Can not allocate the memory.
122 CHAR16 NewFileName
[EFI_PATH_STRING_LENGTH
];
124 UINT8 FileAttributes
;
128 Volume
= OFile
->Volume
;
129 ASSERT_VOLUME_LOCKED (Volume
);
130 WriteMode
= (BOOLEAN
) (OpenMode
& EFI_FILE_MODE_WRITE
);
131 if (Volume
->ReadOnly
&& WriteMode
) {
132 return EFI_WRITE_PROTECTED
;
135 // Verify the source file handle isn't in an error state
137 Status
= OFile
->Error
;
138 if (EFI_ERROR (Status
)) {
142 // Get new OFile for the file
144 Status
= FatLocateOFile (&OFile
, FileName
, Attributes
, NewFileName
);
145 if (EFI_ERROR (Status
)) {
149 if (*NewFileName
!= 0) {
151 // If there's a remaining part of the name, then we had
152 // better be creating the file in the directory
154 if ((OpenMode
& EFI_FILE_MODE_CREATE
) == 0) {
155 return EFI_NOT_FOUND
;
158 Status
= FatCreateDirEnt (OFile
, NewFileName
, Attributes
, &DirEnt
);
159 if (EFI_ERROR (Status
)) {
163 ASSERT (DirEnt
!= NULL
);
164 Status
= FatOpenDirEnt (OFile
, DirEnt
);
165 if (EFI_ERROR (Status
)) {
169 OFile
= DirEnt
->OFile
;
170 if (OFile
->ODir
!= NULL
) {
172 // If we just created a directory, we need to create "." and ".."
174 Status
= FatCreateDotDirEnts (OFile
);
175 if (EFI_ERROR (Status
)) {
181 // If the file's attribute is read only, and the open is for
182 // read-write, then the access is denied.
184 FileAttributes
= OFile
->DirEnt
->Entry
.Attributes
;
185 if ((FileAttributes
& EFI_FILE_READ_ONLY
) != 0 && (FileAttributes
& FAT_ATTRIBUTE_DIRECTORY
) == 0 && WriteMode
) {
186 return EFI_ACCESS_DENIED
;
189 // Create an open instance of the OFile
191 Status
= FatAllocateIFile (OFile
, NewIFile
);
192 if (EFI_ERROR (Status
)) {
196 (*NewIFile
)->ReadOnly
= (BOOLEAN
)!WriteMode
;
198 DEBUG ((EFI_D_INFO
, "FSOpen: Open '%S' %r\n", FileName
, Status
));
199 return FatOFileFlush (OFile
);
205 IN EFI_FILE_PROTOCOL
*FHand
,
206 OUT EFI_FILE_PROTOCOL
**NewHandle
,
209 IN UINT64 Attributes
,
210 IN OUT EFI_FILE_IO_TOKEN
*Token
215 Implements OpenEx() of Simple File System Protocol.
219 FHand - File handle of the file serves as a starting reference point.
220 NewHandle - Handle of the file that is newly opened.
221 FileName - File name relative to FHand.
222 OpenMode - Open mode.
223 Attributes - Attributes to set if the file is created.
224 Token - A pointer to the token associated with the transaction.
228 EFI_INVALID_PARAMETER - The FileName is NULL or the file string is empty.
229 The OpenMode is not supported.
230 The Attributes is not the valid attributes.
231 EFI_OUT_OF_RESOURCES - Can not allocate the memory for file string.
232 EFI_SUCCESS - Open the file successfully.
233 Others - The status of open file.
244 // Perform some parameter checking
246 if (FileName
== NULL
) {
247 return EFI_INVALID_PARAMETER
;
250 // Check for a valid mode
253 case EFI_FILE_MODE_READ
:
254 case EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
:
255 case EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
:
259 return EFI_INVALID_PARAMETER
;
263 // Check for valid Attributes for file creation case.
265 if (((OpenMode
& EFI_FILE_MODE_CREATE
) != 0) && (Attributes
& (EFI_FILE_READ_ONLY
| (~EFI_FILE_VALID_ATTR
))) != 0) {
266 return EFI_INVALID_PARAMETER
;
269 IFile
= IFILE_FROM_FHAND (FHand
);
270 OFile
= IFile
->OFile
;
274 FatWaitNonblockingTask (IFile
);
277 // Caller shouldn't call the non-blocking interfaces if the low layer doesn't support DiskIo2.
278 // But if it calls, the below check can avoid crash.
280 if (FHand
->Revision
< EFI_FILE_PROTOCOL_REVISION2
) {
281 return EFI_UNSUPPORTED
;
283 Task
= FatCreateTask (IFile
, Token
);
285 return EFI_OUT_OF_RESOURCES
;
297 Status
= FatOFileOpen (OFile
, &NewIFile
, FileName
, OpenMode
, (UINT8
) Attributes
);
300 // If the file was opened, return the handle to the caller
302 if (!EFI_ERROR (Status
)) {
303 *NewHandle
= &NewIFile
->Handle
;
308 Status
= FatCleanupVolume (OFile
->Volume
, NULL
, Status
, Task
);
312 if (!EFI_ERROR (Status
)) {
313 Status
= FatQueueTask (IFile
, Task
);
315 FatDestroyTask (Task
);
325 IN EFI_FILE_PROTOCOL
*FHand
,
326 OUT EFI_FILE_PROTOCOL
**NewHandle
,
334 Implements Open() of Simple File System Protocol.
338 FHand - File handle of the file serves as a starting reference point.
339 NewHandle - Handle of the file that is newly opened.
340 FileName - File name relative to FHand.
341 OpenMode - Open mode.
342 Attributes - Attributes to set if the file is created.
346 EFI_INVALID_PARAMETER - The FileName is NULL or the file string is empty.
347 The OpenMode is not supported.
348 The Attributes is not the valid attributes.
349 EFI_OUT_OF_RESOURCES - Can not allocate the memory for file string.
350 EFI_SUCCESS - Open the file successfully.
351 Others - The status of open file.
355 return FatOpenEx (FHand
, NewHandle
, FileName
, OpenMode
, Attributes
, NULL
);