1 /* $Id: fsw_efi.c 29125 2010-05-06 09:43:05Z vboxsync $ */
3 * fsw_efi.c - EFI host environment code.
7 * Copyright (C) 2010 Oracle Corporation
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19 * This code is based on:
21 * Copyright (c) 2006 Christoph Pfisterer
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions are
27 * * Redistributions of source code must retain the above copyright
28 * notice, this list of conditions and the following disclaimer.
30 * * Redistributions in binary form must reproduce the above copyright
31 * notice, this list of conditions and the following disclaimer in the
32 * documentation and/or other materials provided with the
35 * * Neither the name of Christoph Pfisterer nor the names of the
36 * contributors may be used to endorse or promote products derived
37 * from this software without specific prior written permission.
39 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
42 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
43 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
46 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
47 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
48 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
49 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 #ifdef __MAKEWITH_GNUEFI
55 #include "edk2/DriverBinding.h"
56 #include "edk2/ComponentName.h"
58 #include "../include/refit_call_wrapper.h"
63 #error FSTYPE must be defined!
69 #define DBG(x...) AsciiPrint(x)
71 #define DBG(x...) BootLog(x)
76 #define EFI_DISK_IO_PROTOCOL_GUID \
78 0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
81 #define EFI_BLOCK_IO_PROTOCOL_GUID \
83 0x964e5b21, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
86 #ifdef __MAKEWITH_GNUEFI
87 EFI_GUID gEfiDriverBindingProtocolGuid
= EFI_DRIVER_BINDING_PROTOCOL_GUID
;
88 EFI_GUID gEfiComponentNameProtocolGuid
= EFI_COMPONENT_NAME_PROTOCOL_GUID
;
89 EFI_GUID gEfiDiskIoProtocolGuid
= EFI_DISK_IO_PROTOCOL_GUID
;
90 EFI_GUID gEfiBlockIoProtocolGuid
= EFI_BLOCK_IO_PROTOCOL_GUID
;
91 EFI_GUID gEfiFileInfoGuid
= EFI_FILE_INFO_ID
;
92 EFI_GUID gEfiFileSystemInfoGuid
= EFI_FILE_SYSTEM_INFO_ID
;
93 EFI_GUID gEfiFileSystemVolumeLabelInfoIdGuid
= EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID
;
94 #define SimpleFileSystemProtocol FileSystemProtocol
97 /** Helper macro for stringification. */
98 #define FSW_EFI_STRINGIFY(x) #x
99 /** Expands to the EFI driver name given the file system type name. */
100 #define FSW_EFI_DRIVER_NAME(t) L"rEFInd 0.6.2 " FSW_EFI_STRINGIFY(t) L" File System Driver"
102 // function prototypes
104 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Supported(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
105 IN EFI_HANDLE ControllerHandle
,
106 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
);
107 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Start(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
108 IN EFI_HANDLE ControllerHandle
,
109 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
);
110 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Stop(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
111 IN EFI_HANDLE ControllerHandle
,
112 IN UINTN NumberOfChildren
,
113 IN EFI_HANDLE
*ChildHandleBuffer
);
115 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
117 OUT CHAR16
**DriverName
);
118 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
119 IN EFI_HANDLE ControllerHandle
,
120 IN EFI_HANDLE ChildHandle OPTIONAL
,
122 OUT CHAR16
**ControllerName
);
124 void fsw_efi_change_blocksize(struct fsw_volume
*vol
,
125 fsw_u32 old_phys_blocksize
, fsw_u32 old_log_blocksize
,
126 fsw_u32 new_phys_blocksize
, fsw_u32 new_log_blocksize
);
127 fsw_status_t
fsw_efi_read_block(struct fsw_volume
*vol
, fsw_u32 phys_bno
, void *buffer
);
129 EFI_STATUS
fsw_efi_map_status(fsw_status_t fsw_status
, FSW_VOLUME_DATA
*Volume
);
131 EFI_STATUS EFIAPI
fsw_efi_FileSystem_OpenVolume(IN EFI_FILE_IO_INTERFACE
*This
,
132 OUT EFI_FILE
**Root
);
133 EFI_STATUS
fsw_efi_dnode_to_FileHandle(IN
struct fsw_dnode
*dno
,
134 OUT EFI_FILE
**NewFileHandle
);
136 EFI_STATUS
fsw_efi_file_read(IN FSW_FILE_DATA
*File
,
137 IN OUT UINTN
*BufferSize
,
139 EFI_STATUS
fsw_efi_file_getpos(IN FSW_FILE_DATA
*File
,
140 OUT UINT64
*Position
);
141 EFI_STATUS
fsw_efi_file_setpos(IN FSW_FILE_DATA
*File
,
144 EFI_STATUS
fsw_efi_dir_open(IN FSW_FILE_DATA
*File
,
145 OUT EFI_FILE
**NewHandle
,
148 IN UINT64 Attributes
);
149 EFI_STATUS
fsw_efi_dir_read(IN FSW_FILE_DATA
*File
,
150 IN OUT UINTN
*BufferSize
,
152 EFI_STATUS
fsw_efi_dir_setpos(IN FSW_FILE_DATA
*File
,
155 EFI_STATUS
fsw_efi_dnode_getinfo(IN FSW_FILE_DATA
*File
,
156 IN EFI_GUID
*InformationType
,
157 IN OUT UINTN
*BufferSize
,
159 EFI_STATUS
fsw_efi_dnode_fill_FileInfo(IN FSW_VOLUME_DATA
*Volume
,
160 IN
struct fsw_dnode
*dno
,
161 IN OUT UINTN
*BufferSize
,
165 * Interface structure for the EFI Driver Binding protocol.
168 EFI_DRIVER_BINDING_PROTOCOL fsw_efi_DriverBinding_table
= {
169 fsw_efi_DriverBinding_Supported
,
170 fsw_efi_DriverBinding_Start
,
171 fsw_efi_DriverBinding_Stop
,
178 * Interface structure for the EFI Component Name protocol.
181 EFI_COMPONENT_NAME_PROTOCOL fsw_efi_ComponentName_table
= {
182 fsw_efi_ComponentName_GetDriverName
,
183 fsw_efi_ComponentName_GetControllerName
,
188 * Dispatch table for our FSW host driver.
191 struct fsw_host_table fsw_efi_host_table
= {
192 FSW_STRING_TYPE_UTF16
,
194 fsw_efi_change_blocksize
,
198 extern struct fsw_fstype_table
FSW_FSTYPE_TABLE_NAME(FSTYPE
);
200 //#include "OverrideFunctions-kabyl.edk2.c.include"
203 * Image entry point. Installs the Driver Binding and Component Name protocols
204 * on the image's handle. Actually mounting a file system is initiated through
205 * the Driver Binding protocol at the firmware's request.
207 EFI_STATUS EFIAPI
fsw_efi_main(IN EFI_HANDLE ImageHandle
,
208 IN EFI_SYSTEM_TABLE
*SystemTable
)
212 #ifndef HOST_EFI_EDK2
213 // Not available in EDK2 toolkit
214 InitializeLib(ImageHandle
, SystemTable
);
217 // complete Driver Binding protocol instance
218 fsw_efi_DriverBinding_table
.ImageHandle
= ImageHandle
;
219 fsw_efi_DriverBinding_table
.DriverBindingHandle
= ImageHandle
;
220 // install Driver Binding protocol
221 Status
= refit_call4_wrapper(BS
->InstallProtocolInterface
, &fsw_efi_DriverBinding_table
.DriverBindingHandle
,
222 &gEfiDriverBindingProtocolGuid
,
223 EFI_NATIVE_INTERFACE
,
224 &fsw_efi_DriverBinding_table
);
225 if (EFI_ERROR (Status
)) {
229 // install Component Name protocol
230 Status
= refit_call4_wrapper(BS
->InstallProtocolInterface
, &fsw_efi_DriverBinding_table
.DriverBindingHandle
,
231 &gEfiComponentNameProtocolGuid
,
232 EFI_NATIVE_INTERFACE
,
233 &fsw_efi_ComponentName_table
);
234 if (EFI_ERROR (Status
)) {
238 // OverrideFunctions();
241 // Status = BS->LocateProtocol(&gMsgLogProtocolGuid, NULL, (VOID **) &Msg);
242 // if (!EFI_ERROR(Status) && (Msg != NULL)) {
243 // msgCursor = Msg->Cursor;
244 // BootLog("MsgLog installed into VBoxFs\n");
250 #ifdef __MAKEWITH_GNUEFI
251 EFI_DRIVER_ENTRY_POINT(fsw_efi_main
)
255 * Driver Binding EFI protocol, Supported function. This function is called by EFI
256 * to test if this driver can handle a certain device. Our implementation only checks
257 * if the device is a disk (i.e. that it supports the Block I/O and Disk I/O protocols)
258 * and implicitly checks if the disk is already in use by another driver.
261 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Supported(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
262 IN EFI_HANDLE ControllerHandle
,
263 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
)
268 // we check for both DiskIO and BlockIO protocols
270 // first, open DiskIO
271 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
272 &PROTO_NAME(DiskIoProtocol
),
274 This
->DriverBindingHandle
,
276 EFI_OPEN_PROTOCOL_BY_DRIVER
);
277 if (EFI_ERROR(Status
))
280 // we were just checking, close it again
281 refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
282 &PROTO_NAME(DiskIoProtocol
),
283 This
->DriverBindingHandle
,
286 // next, check BlockIO without actually opening it
287 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
288 &PROTO_NAME(BlockIoProtocol
),
290 This
->DriverBindingHandle
,
292 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
297 * Driver Binding EFI protocol, Start function. This function is called by EFI
298 * to start driving the given device. It is still possible at this point to
299 * return EFI_UNSUPPORTED, and in fact we will do so if the file system driver
300 * cannot find the superblock signature (or equivalent) that it expects.
302 * This function allocates memory for a per-volume structure, opens the
303 * required protocols (just Disk I/O in our case, Block I/O is only looked
304 * at to get the MediaId field), and lets the FSW core mount the file system.
305 * If successful, an EFI Simple File System protocol is exported on the
309 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Start(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
310 IN EFI_HANDLE ControllerHandle
,
311 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
)
314 EFI_BLOCK_IO
*BlockIo
;
316 FSW_VOLUME_DATA
*Volume
;
319 Print(L
"fsw_efi_DriverBinding_Start\n");
322 // open consumed protocols
323 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
324 &PROTO_NAME(BlockIoProtocol
),
326 This
->DriverBindingHandle
,
328 EFI_OPEN_PROTOCOL_GET_PROTOCOL
); // NOTE: we only want to look at the MediaId
329 if (EFI_ERROR(Status
)) {
330 // Print(L"Fsw ERROR: OpenProtocol(BlockIo) returned %x\n", Status);
334 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
335 &PROTO_NAME(DiskIoProtocol
),
337 This
->DriverBindingHandle
,
339 EFI_OPEN_PROTOCOL_BY_DRIVER
);
340 if (EFI_ERROR(Status
)) {
341 Print(L
"Fsw ERROR: OpenProtocol(DiskIo) returned %r\n", Status
);
345 // allocate volume structure
346 Volume
= AllocateZeroPool(sizeof(FSW_VOLUME_DATA
));
347 Volume
->Signature
= FSW_VOLUME_DATA_SIGNATURE
;
348 Volume
->Handle
= ControllerHandle
;
349 Volume
->DiskIo
= DiskIo
;
350 Volume
->MediaId
= BlockIo
->Media
->MediaId
;
351 Volume
->LastIOStatus
= EFI_SUCCESS
;
353 // mount the filesystem
354 Status
= fsw_efi_map_status(fsw_mount(Volume
, &fsw_efi_host_table
,
355 &FSW_FSTYPE_TABLE_NAME(FSTYPE
), &Volume
->vol
),
358 if (!EFI_ERROR(Status
)) {
359 // register the SimpleFileSystem protocol
360 Volume
->FileSystem
.Revision
= EFI_FILE_IO_INTERFACE_REVISION
;
361 Volume
->FileSystem
.OpenVolume
= fsw_efi_FileSystem_OpenVolume
;
362 Status
= refit_call4_wrapper(BS
->InstallMultipleProtocolInterfaces
, &ControllerHandle
,
363 &PROTO_NAME(SimpleFileSystemProtocol
),
366 if (EFI_ERROR(Status
)) {
367 // Print(L"Fsw ERROR: InstallMultipleProtocolInterfaces returned %x\n", Status);
371 // on errors, close the opened protocols
372 if (EFI_ERROR(Status
)) {
373 if (Volume
->vol
!= NULL
)
374 fsw_unmount(Volume
->vol
);
377 refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
378 &PROTO_NAME(DiskIoProtocol
),
379 This
->DriverBindingHandle
,
387 * Driver Binding EFI protocol, Stop function. This function is called by EFI
388 * to stop the driver on the given device. This translates to an unmount
389 * call for the FSW core.
391 * We assume that all file handles on the volume have been closed before
392 * the driver is stopped. At least with the EFI shell, that is actually the
393 * case; it closes all file handles between commands.
396 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Stop(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
397 IN EFI_HANDLE ControllerHandle
,
398 IN UINTN NumberOfChildren
,
399 IN EFI_HANDLE
*ChildHandleBuffer
)
402 EFI_FILE_IO_INTERFACE
*FileSystem
;
403 FSW_VOLUME_DATA
*Volume
;
406 Print(L
"fsw_efi_DriverBinding_Stop\n");
409 // get the installed SimpleFileSystem interface
410 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
411 &PROTO_NAME(SimpleFileSystemProtocol
),
412 (VOID
**) &FileSystem
,
413 This
->DriverBindingHandle
,
415 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
416 if (EFI_ERROR(Status
))
417 return EFI_UNSUPPORTED
;
419 // get private data structure
420 Volume
= FSW_VOLUME_FROM_FILE_SYSTEM(FileSystem
);
422 // uninstall Simple File System protocol
423 Status
= refit_call4_wrapper(BS
->UninstallMultipleProtocolInterfaces
, ControllerHandle
,
424 &PROTO_NAME(SimpleFileSystemProtocol
), &Volume
->FileSystem
,
426 if (EFI_ERROR(Status
)) {
427 // Print(L"Fsw ERROR: UninstallMultipleProtocolInterfaces returned %x\n", Status);
431 Print(L
"fsw_efi_DriverBinding_Stop: protocol uninstalled successfully\n");
434 // release private data structure
435 if (Volume
->vol
!= NULL
)
436 fsw_unmount(Volume
->vol
);
439 // close the consumed protocols
440 Status
= refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
441 &PROTO_NAME(DiskIoProtocol
),
442 This
->DriverBindingHandle
,
449 * Component Name EFI protocol, GetDriverName function. Used by the EFI
450 * environment to inquire the name of this driver. The name returned is
451 * based on the file system type actually used in compilation.
454 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
456 OUT CHAR16
**DriverName
)
458 if (Language
== NULL
|| DriverName
== NULL
)
459 return EFI_INVALID_PARAMETER
;
461 if (Language
[0] == 'e' && Language
[1] == 'n' && Language
[2] == 'g' && Language
[3] == 0) {
462 *DriverName
= FSW_EFI_DRIVER_NAME(FSTYPE
);
465 return EFI_UNSUPPORTED
;
469 * Component Name EFI protocol, GetControllerName function. Not implemented
470 * because this is not a "bus" driver in the sense of the EFI Driver Model.
473 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
474 IN EFI_HANDLE ControllerHandle
,
475 IN EFI_HANDLE ChildHandle OPTIONAL
,
477 OUT CHAR16
**ControllerName
)
479 return EFI_UNSUPPORTED
;
483 * FSW interface function for block size changes. This function is called by the FSW core
484 * when the file system driver changes the block sizes for the volume.
487 void fsw_efi_change_blocksize(struct fsw_volume
*vol
,
488 fsw_u32 old_phys_blocksize
, fsw_u32 old_log_blocksize
,
489 fsw_u32 new_phys_blocksize
, fsw_u32 new_log_blocksize
)
495 * FSW interface function to read data blocks. This function is called by the FSW core
496 * to read a block of data from the device. The buffer is allocated by the core code.
499 fsw_status_t
fsw_efi_read_block(struct fsw_volume
*vol
, fsw_u32 phys_bno
, void *buffer
)
502 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)vol
->host_data
;
504 // FSW_MSG_DEBUGV((FSW_MSGSTR("fsw_efi_read_block: %d (%d)\n"), phys_bno, vol->phys_blocksize));
507 Status
= refit_call5_wrapper(Volume
->DiskIo
->ReadDisk
, Volume
->DiskIo
, Volume
->MediaId
,
508 (UINT64
)phys_bno
* vol
->phys_blocksize
,
511 Volume
->LastIOStatus
= Status
;
512 if (EFI_ERROR(Status
))
518 * Map FSW status codes to EFI status codes. The FSW_IO_ERROR code is only produced
519 * by fsw_efi_read_block, so we map it back to the EFI status code remembered from
520 * the last I/O operation.
523 EFI_STATUS
fsw_efi_map_status(fsw_status_t fsw_status
, FSW_VOLUME_DATA
*Volume
)
525 switch (fsw_status
) {
528 case FSW_OUT_OF_MEMORY
:
529 return EFI_VOLUME_CORRUPTED
;
531 return Volume
->LastIOStatus
;
532 case FSW_UNSUPPORTED
:
533 return EFI_UNSUPPORTED
;
535 return EFI_NOT_FOUND
;
536 case FSW_VOLUME_CORRUPTED
:
537 return EFI_VOLUME_CORRUPTED
;
539 return EFI_DEVICE_ERROR
;
544 * File System EFI protocol, OpenVolume function. Creates a file handle for
545 * the root directory and returns it. Note that this function may be called
546 * multiple times and returns a new file handle each time. Each returned
547 * handle is closed by the client using it.
550 EFI_STATUS EFIAPI
fsw_efi_FileSystem_OpenVolume(IN EFI_FILE_IO_INTERFACE
*This
,
554 FSW_VOLUME_DATA
*Volume
= FSW_VOLUME_FROM_FILE_SYSTEM(This
);
557 Print(L
"fsw_efi_FileSystem_OpenVolume\n");
560 Status
= fsw_efi_dnode_to_FileHandle(Volume
->vol
->root
, Root
);
566 * File Handle EFI protocol, Open function. Dispatches the call
567 * based on the kind of file handle.
570 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Open(IN EFI_FILE
*This
,
571 OUT EFI_FILE
**NewHandle
,
574 IN UINT64 Attributes
)
576 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
578 if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
579 return fsw_efi_dir_open(File
, NewHandle
, FileName
, OpenMode
, Attributes
);
580 // not supported for regular files
581 return EFI_UNSUPPORTED
;
585 * File Handle EFI protocol, Close function. Closes the FSW shandle
586 * and frees the memory used for the structure.
589 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Close(IN EFI_FILE
*This
)
591 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
594 Print(L
"fsw_efi_FileHandle_Close\n");
597 fsw_shandle_close(&File
->shand
);
604 * File Handle EFI protocol, Delete function. Calls through to Close
605 * and returns a warning because this driver is read-only.
608 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Delete(IN EFI_FILE
*This
)
612 Status
= refit_call1_wrapper(This
->Close
, This
);
613 if (Status
== EFI_SUCCESS
) {
614 // this driver is read-only
615 Status
= EFI_WARN_DELETE_FAILURE
;
622 * File Handle EFI protocol, Read function. Dispatches the call
623 * based on the kind of file handle.
626 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Read(IN EFI_FILE
*This
,
627 IN OUT UINTN
*BufferSize
,
630 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
632 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
633 return fsw_efi_file_read(File
, BufferSize
, Buffer
);
634 else if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
635 return fsw_efi_dir_read(File
, BufferSize
, Buffer
);
636 return EFI_UNSUPPORTED
;
640 * File Handle EFI protocol, Write function. Returns unsupported status
641 * because this driver is read-only.
644 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Write(IN EFI_FILE
*This
,
645 IN OUT UINTN
*BufferSize
,
648 // this driver is read-only
649 return EFI_WRITE_PROTECTED
;
653 * File Handle EFI protocol, GetPosition function. Dispatches the call
654 * based on the kind of file handle.
657 EFI_STATUS EFIAPI
fsw_efi_FileHandle_GetPosition(IN EFI_FILE
*This
,
658 OUT UINT64
*Position
)
660 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
662 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
663 return fsw_efi_file_getpos(File
, Position
);
664 // not defined for directories
665 return EFI_UNSUPPORTED
;
669 * File Handle EFI protocol, SetPosition function. Dispatches the call
670 * based on the kind of file handle.
673 EFI_STATUS EFIAPI
fsw_efi_FileHandle_SetPosition(IN EFI_FILE
*This
,
676 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
678 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
679 return fsw_efi_file_setpos(File
, Position
);
680 else if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
681 return fsw_efi_dir_setpos(File
, Position
);
682 return EFI_UNSUPPORTED
;
686 * File Handle EFI protocol, GetInfo function. Dispatches to the common
687 * function implementing this.
690 EFI_STATUS EFIAPI
fsw_efi_FileHandle_GetInfo(IN EFI_FILE
*This
,
691 IN EFI_GUID
*InformationType
,
692 IN OUT UINTN
*BufferSize
,
695 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
697 return fsw_efi_dnode_getinfo(File
, InformationType
, BufferSize
, Buffer
);
701 * File Handle EFI protocol, SetInfo function. Returns unsupported status
702 * because this driver is read-only.
705 EFI_STATUS EFIAPI
fsw_efi_FileHandle_SetInfo(IN EFI_FILE
*This
,
706 IN EFI_GUID
*InformationType
,
710 // this driver is read-only
711 return EFI_WRITE_PROTECTED
;
715 * File Handle EFI protocol, Flush function. Returns unsupported status
716 * because this driver is read-only.
719 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Flush(IN EFI_FILE
*This
)
721 // this driver is read-only
722 return EFI_WRITE_PROTECTED
;
726 * Set up a file handle for a dnode. This function allocates a data structure
727 * for a file handle, opens a FSW shandle and populates the EFI_FILE structure
728 * with the interface functions.
731 EFI_STATUS
fsw_efi_dnode_to_FileHandle(IN
struct fsw_dnode
*dno
,
732 OUT EFI_FILE
**NewFileHandle
)
737 // make sure the dnode has complete info
738 Status
= fsw_efi_map_status(fsw_dnode_fill(dno
), (FSW_VOLUME_DATA
*)dno
->vol
->host_data
);
739 if (EFI_ERROR(Status
))
743 if (dno
->type
!= FSW_DNODE_TYPE_FILE
&& dno
->type
!= FSW_DNODE_TYPE_DIR
)
744 return EFI_UNSUPPORTED
;
746 // allocate file structure
747 File
= AllocateZeroPool(sizeof(FSW_FILE_DATA
));
748 File
->Signature
= FSW_FILE_DATA_SIGNATURE
;
749 if (dno
->type
== FSW_DNODE_TYPE_FILE
)
750 File
->Type
= FSW_EFI_FILE_TYPE_FILE
;
751 else if (dno
->type
== FSW_DNODE_TYPE_DIR
)
752 File
->Type
= FSW_EFI_FILE_TYPE_DIR
;
755 Status
= fsw_efi_map_status(fsw_shandle_open(dno
, &File
->shand
),
756 (FSW_VOLUME_DATA
*)dno
->vol
->host_data
);
757 if (EFI_ERROR(Status
)) {
762 // populate the file handle
763 File
->FileHandle
.Revision
= EFI_FILE_HANDLE_REVISION
;
764 File
->FileHandle
.Open
= fsw_efi_FileHandle_Open
;
765 File
->FileHandle
.Close
= fsw_efi_FileHandle_Close
;
766 File
->FileHandle
.Delete
= fsw_efi_FileHandle_Delete
;
767 File
->FileHandle
.Read
= fsw_efi_FileHandle_Read
;
768 File
->FileHandle
.Write
= fsw_efi_FileHandle_Write
;
769 File
->FileHandle
.GetPosition
= fsw_efi_FileHandle_GetPosition
;
770 File
->FileHandle
.SetPosition
= fsw_efi_FileHandle_SetPosition
;
771 File
->FileHandle
.GetInfo
= fsw_efi_FileHandle_GetInfo
;
772 File
->FileHandle
.SetInfo
= fsw_efi_FileHandle_SetInfo
;
773 File
->FileHandle
.Flush
= fsw_efi_FileHandle_Flush
;
775 *NewFileHandle
= &File
->FileHandle
;
780 * Data read function for regular files. Calls through to fsw_shandle_read.
783 EFI_STATUS
fsw_efi_file_read(IN FSW_FILE_DATA
*File
,
784 IN OUT UINTN
*BufferSize
,
791 Print(L
"fsw_efi_file_read %d bytes\n", *BufferSize
);
794 buffer_size
= (fsw_u32
)*BufferSize
;
795 Status
= fsw_efi_map_status(fsw_shandle_read(&File
->shand
, &buffer_size
, Buffer
),
796 (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
);
797 *BufferSize
= buffer_size
;
803 * Get file position for regular files.
806 EFI_STATUS
fsw_efi_file_getpos(IN FSW_FILE_DATA
*File
,
807 OUT UINT64
*Position
)
809 *Position
= File
->shand
.pos
;
814 * Set file position for regular files. EFI specifies the all-ones value
815 * to be a special value for the end of the file.
818 EFI_STATUS
fsw_efi_file_setpos(IN FSW_FILE_DATA
*File
, IN UINT64 Position
)
820 if (Position
== 0xFFFFFFFFFFFFFFFFULL
)
821 File
->shand
.pos
= File
->shand
.dnode
->size
;
823 File
->shand
.pos
= Position
;
828 * Open function used to open new file handles relative to a directory.
829 * In EFI, the "open file" function is implemented by directory file handles
830 * and is passed a relative or volume-absolute path to the file or directory
831 * to open. We use fsw_dnode_lookup_path to find the node plus an additional
832 * call to fsw_dnode_resolve because EFI has no concept of symbolic links.
835 EFI_STATUS
fsw_efi_dir_open(IN FSW_FILE_DATA
*File
,
836 OUT EFI_FILE
**NewHandle
,
839 IN UINT64 Attributes
)
842 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
843 struct fsw_dnode
*dno
;
844 struct fsw_dnode
*target_dno
;
845 struct fsw_string lookup_path
;
848 Print(L
"fsw_efi_dir_open: '%s'\n", FileName
);
851 if (OpenMode
!= EFI_FILE_MODE_READ
)
852 return EFI_WRITE_PROTECTED
;
854 lookup_path
.type
= FSW_STRING_TYPE_UTF16
;
855 lookup_path
.len
= (int)StrLen(FileName
);
856 lookup_path
.size
= lookup_path
.len
* sizeof(fsw_u16
);
857 lookup_path
.data
= FileName
;
859 // resolve the path (symlinks along the way are automatically resolved)
860 Status
= fsw_efi_map_status(fsw_dnode_lookup_path(File
->shand
.dnode
, &lookup_path
, '\\', &dno
), Volume
);
861 if (EFI_ERROR(Status
))
864 // if the final node is a symlink, also resolve it
865 Status
= fsw_efi_map_status(fsw_dnode_resolve(dno
, &target_dno
), Volume
);
866 fsw_dnode_release(dno
);
867 if (EFI_ERROR(Status
))
871 // make a new EFI handle for the target dnode
872 Status
= fsw_efi_dnode_to_FileHandle(dno
, NewHandle
);
873 fsw_dnode_release(dno
);
878 * Read function for directories. A file handle read on a directory retrieves
879 * the next directory entry.
882 EFI_STATUS
fsw_efi_dir_read(IN FSW_FILE_DATA
*File
,
883 IN OUT UINTN
*BufferSize
,
887 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
888 struct fsw_dnode
*dno
;
891 Print(L
"fsw_efi_dir_read...\n");
894 // read the next entry
895 Status
= fsw_efi_map_status(fsw_dnode_dir_read(&File
->shand
, &dno
), Volume
);
896 if (Status
== EFI_NOT_FOUND
) {
900 Print(L
"...no more entries\n");
904 if (EFI_ERROR(Status
))
907 // get info into buffer
908 Status
= fsw_efi_dnode_fill_FileInfo(Volume
, dno
, BufferSize
, Buffer
);
909 fsw_dnode_release(dno
);
914 * Set file position for directories. The only allowed set position operation
915 * for directories is to rewind the directory completely by setting the
919 EFI_STATUS
fsw_efi_dir_setpos(IN FSW_FILE_DATA
*File
, IN UINT64 Position
)
925 // directories can only rewind to the start
926 return EFI_UNSUPPORTED
;
931 * Get file or volume information. This function implements the GetInfo call
932 * for all file handles. Control is dispatched according to the type of information
933 * requested by the caller.
936 EFI_STATUS
fsw_efi_dnode_getinfo(IN FSW_FILE_DATA
*File
,
937 IN EFI_GUID
*InformationType
,
938 IN OUT UINTN
*BufferSize
,
942 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
943 EFI_FILE_SYSTEM_INFO
*FSInfo
;
945 struct fsw_volume_stat vsb
;
948 if (CompareGuid(InformationType
, &gEfiFileInfoGuid
)) {
950 Print(L
"fsw_efi_dnode_getinfo: FILE_INFO\n");
953 Status
= fsw_efi_dnode_fill_FileInfo(Volume
, File
->shand
.dnode
, BufferSize
, Buffer
);
955 } else if (CompareGuid(InformationType
, &gEfiFileSystemInfoGuid
)) {
957 Print(L
"fsw_efi_dnode_getinfo: FILE_SYSTEM_INFO\n");
961 RequiredSize
= SIZE_OF_EFI_FILE_SYSTEM_INFO
+ fsw_efi_strsize(&Volume
->vol
->label
);
962 if (*BufferSize
< RequiredSize
) {
963 *BufferSize
= RequiredSize
;
964 return EFI_BUFFER_TOO_SMALL
;
968 FSInfo
= (EFI_FILE_SYSTEM_INFO
*)Buffer
;
969 FSInfo
->Size
= RequiredSize
;
970 FSInfo
->ReadOnly
= TRUE
;
971 FSInfo
->BlockSize
= Volume
->vol
->log_blocksize
;
972 fsw_efi_strcpy(FSInfo
->VolumeLabel
, &Volume
->vol
->label
);
974 // get the missing info from the fs driver
975 ZeroMem(&vsb
, sizeof(struct fsw_volume_stat
));
976 Status
= fsw_efi_map_status(fsw_volume_stat(Volume
->vol
, &vsb
), Volume
);
977 if (EFI_ERROR(Status
))
979 FSInfo
->VolumeSize
= vsb
.total_bytes
;
980 FSInfo
->FreeSpace
= vsb
.free_bytes
;
982 // prepare for return
983 *BufferSize
= RequiredSize
;
984 Status
= EFI_SUCCESS
;
986 } else if (CompareGuid(InformationType
, &gEfiFileSystemVolumeLabelInfoIdGuid
)) {
988 Print(L
"fsw_efi_dnode_getinfo: FILE_SYSTEM_VOLUME_LABEL\n");
992 RequiredSize
= SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL_INFO
+ fsw_efi_strsize(&Volume
->vol
->label
);
993 if (*BufferSize
< RequiredSize
) {
994 *BufferSize
= RequiredSize
;
995 return EFI_BUFFER_TOO_SMALL
;
999 fsw_efi_strcpy(((EFI_FILE_SYSTEM_VOLUME_LABEL_INFO
*)Buffer
)->VolumeLabel
, &Volume
->vol
->label
);
1001 // prepare for return
1002 *BufferSize
= RequiredSize
;
1003 Status
= EFI_SUCCESS
;
1006 Status
= EFI_UNSUPPORTED
;
1013 * Time mapping callback for the fsw_dnode_stat call. This function converts
1014 * a Posix style timestamp into an EFI_TIME structure and writes it to the
1015 * appropriate member of the EFI_FILE_INFO structure that we're filling.
1018 static void fsw_efi_store_time_posix(struct fsw_dnode_stat
*sb
, int which
, fsw_u32 posix_time
)
1020 EFI_FILE_INFO
*FileInfo
= (EFI_FILE_INFO
*)sb
->host_data
;
1022 if (which
== FSW_DNODE_STAT_CTIME
)
1023 fsw_efi_decode_time(&FileInfo
->CreateTime
, posix_time
);
1024 else if (which
== FSW_DNODE_STAT_MTIME
)
1025 fsw_efi_decode_time(&FileInfo
->ModificationTime
, posix_time
);
1026 else if (which
== FSW_DNODE_STAT_ATIME
)
1027 fsw_efi_decode_time(&FileInfo
->LastAccessTime
, posix_time
);
1031 * Mode mapping callback for the fsw_dnode_stat call. This function looks at
1032 * the Posix mode passed by the file system driver and makes appropriate
1033 * adjustments to the EFI_FILE_INFO structure that we're filling.
1036 static void fsw_efi_store_attr_posix(struct fsw_dnode_stat
*sb
, fsw_u16 posix_mode
)
1038 EFI_FILE_INFO
*FileInfo
= (EFI_FILE_INFO
*)sb
->host_data
;
1040 if ((posix_mode
& S_IWUSR
) == 0)
1041 FileInfo
->Attribute
|= EFI_FILE_READ_ONLY
;
1045 * Common function to fill an EFI_FILE_INFO with information about a dnode.
1048 EFI_STATUS
fsw_efi_dnode_fill_FileInfo(IN FSW_VOLUME_DATA
*Volume
,
1049 IN
struct fsw_dnode
*dno
,
1050 IN OUT UINTN
*BufferSize
,
1054 EFI_FILE_INFO
*FileInfo
;
1056 struct fsw_dnode_stat sb
;
1058 // make sure the dnode has complete info
1059 Status
= fsw_efi_map_status(fsw_dnode_fill(dno
), Volume
);
1060 if (EFI_ERROR(Status
))
1063 // TODO: check/assert that the dno's name is in UTF16
1065 // check buffer size
1066 RequiredSize
= SIZE_OF_EFI_FILE_INFO
+ fsw_efi_strsize(&dno
->name
);
1067 if (*BufferSize
< RequiredSize
) {
1068 // TODO: wind back the directory in this case
1071 Print(L
"...BUFFER TOO SMALL\n");
1073 *BufferSize
= RequiredSize
;
1074 return EFI_BUFFER_TOO_SMALL
;
1078 ZeroMem(Buffer
, RequiredSize
);
1079 FileInfo
= (EFI_FILE_INFO
*)Buffer
;
1080 FileInfo
->Size
= RequiredSize
;
1081 FileInfo
->FileSize
= dno
->size
;
1082 FileInfo
->Attribute
= 0;
1083 if (dno
->type
== FSW_DNODE_TYPE_DIR
)
1084 FileInfo
->Attribute
|= EFI_FILE_DIRECTORY
;
1085 fsw_efi_strcpy(FileInfo
->FileName
, &dno
->name
);
1087 // get the missing info from the fs driver
1088 ZeroMem(&sb
, sizeof(struct fsw_dnode_stat
));
1089 sb
.store_time_posix
= fsw_efi_store_time_posix
;
1090 sb
.store_attr_posix
= fsw_efi_store_attr_posix
;
1091 sb
.host_data
= FileInfo
;
1092 Status
= fsw_efi_map_status(fsw_dnode_stat(dno
, &sb
), Volume
);
1093 if (EFI_ERROR(Status
))
1095 FileInfo
->PhysicalSize
= sb
.used_bytes
;
1097 // prepare for return
1098 *BufferSize
= RequiredSize
;
1100 Print(L
"...returning '%s'\n", FileInfo
->FileName
);