3 Copyright (c) 2006 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this 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.
18 This following section documents the envirnoment variables for the Win NT
19 build. These variables are used to define the (virtual) hardware
20 configuration of the NT environment
22 A ! can be used to seperate multiple instances in a variable. Each
23 instance represents a seperate hardware device.
25 EFI_WIN_NT_PHYSICAL_DISKS - maps to drives on your system
26 EFI_WIN_NT_VIRTUAL_DISKS - maps to a device emulated by a file
27 EFI_WIN_NT_FILE_SYSTEM - mouts a directory as a file system
28 EFI_WIN_NT_CONSOLE - make a logical comand line window (only one!)
29 EFI_WIN_NT_UGA - Builds UGA Windows of Width and Height
30 EFI_WIN_NT_SERIAL_PORT - maps physical serial ports
32 <F>ixed - Fixed disk like a hard drive.
33 <R>emovable - Removable media like a floppy or CD-ROM.
34 Read <O>nly - Write protected device.
35 Read <W>rite - Read write device.
36 <block count> - Decimal number of blocks a device supports.
37 <block size> - Decimal number of bytes per block.
39 NT envirnonment variable contents. '<' and '>' are not part of the variable,
40 they are just used to make this help more readable. There should be no
41 spaces between the ';'. Extra spaces will break the variable. A '!' is
42 used to seperate multiple devices in a variable.
44 EFI_WIN_NT_VIRTUAL_DISKS =
45 <F | R><O | W>;<block count>;<block size>[!...]
47 EFI_WIN_NT_PHYSICAL_DISKS =
48 <drive letter>:<F | R><O | W>;<block count>;<block size>[!...]
50 Virtual Disks: These devices use a file to emulate a hard disk or removable
53 Thus a 20 MB emulated hard drive would look like:
54 EFI_WIN_NT_VIRTUAL_DISKS=FW;40960;512
56 A 1.44MB emulated floppy with a block size of 1024 would look like:
57 EFI_WIN_NT_VIRTUAL_DISKS=RW;1440;1024
59 Physical Disks: These devices use NT to open a real device in your system
61 Thus a 120 MB floppy would look like:
62 EFI_WIN_NT_PHYSICAL_DISKS=B:RW;245760;512
64 Thus a standard CD-ROM floppy would look like:
65 EFI_WIN_NT_PHYSICAL_DISKS=Z:RO;307200;2048
67 EFI_WIN_NT_FILE_SYSTEM =
68 <directory path>[!...]
70 Mounting the two directories C:\FOO and C:\BAR would look like:
71 EFI_WIN_NT_FILE_SYSTEM=c:\foo!c:\bar
76 Declaring a text console window with the title "My EFI Console" woild look like:
77 EFI_WIN_NT_CONSOLE=My EFI Console
80 <width> <height>[!...]
82 Declaring a two UGA windows with resolutions of 800x600 and 1024x768 would look like:
83 Example : EFI_WIN_NT_UGA=800 600!1024 768
85 EFI_WIN_NT_SERIAL_PORT =
88 Declaring two serial ports on COM1 and COM2 would look like:
89 Example : EFI_WIN_NT_SERIAL_PORT=COM1!COM2
91 EFI_WIN_NT_PASS_THROUGH =
92 <BaseAddress>;<Bus#>;<Device#>;<Function#>
94 Declaring a base address of 0xE0000000 (used for PCI Express devices)
95 and having NT32 talk to a device located at bus 0, device 1, function 0:
96 Example : EFI_WIN_NT_PASS_THROUGH=E000000;0;1;0
101 // The package level header files this module uses
104 #include <WinNtDxe.h>
106 // The protocols, PPI and GUID defintions for this module
108 #include <Protocol/WinNtThunk.h>
109 #include <Protocol/WinNtIo.h>
110 #include <Protocol/ComponentName.h>
111 #include <Protocol/DriverBinding.h>
112 #include <Protocol/DevicePath.h>
114 // The Library classes this module consumes
116 #include <Library/DebugLib.h>
117 #include <Library/BaseLib.h>
118 #include <Library/UefiDriverEntryPoint.h>
119 #include <Library/UefiLib.h>
120 #include <Library/PcdLib.h>
121 #include <Library/BaseMemoryLib.h>
122 #include <Library/UefiBootServicesTableLib.h>
123 #include <Library/DevicePathLib.h>
124 #include <Library/MemoryAllocationLib.h>
126 #include "WinNtBusDriver.h"
128 extern EFI_GUID gWinNtBusDriverGuid
;
130 // DriverBinding protocol global
132 EFI_DRIVER_BINDING_PROTOCOL gWinNtBusDriverBinding
= {
133 WinNtBusDriverBindingSupported
,
134 WinNtBusDriverBindingStart
,
135 WinNtBusDriverBindingStop
,
141 #define NT_PCD_ARRAY_SIZE (sizeof(mPcdEnvironment)/sizeof(NT_PCD_ENTRY))
144 // Table to map NT Environment variable to the GUID that should be in
147 static NT_PCD_ENTRY mPcdEnvironment
[] = {
148 PcdToken(PcdWinNtConsole
), &gEfiWinNtConsoleGuid
,
149 PcdToken(PcdWinNtGop
), &gEfiWinNtGopGuid
,
150 PcdToken(PcdWinNtSerialPort
), &gEfiWinNtSerialPortGuid
,
151 PcdToken(PcdWinNtFileSystem
), &gEfiWinNtFileSystemGuid
,
152 PcdToken(PcdWinNtVirtualDisk
), &gEfiWinNtVirtualDisksGuid
,
153 PcdToken(PcdWinNtPhysicalDisk
), &gEfiWinNtPhysicalDisksGuid
157 The user Entry Point for module WinNtBusDriver. The user code starts with this function.
159 @param[in] ImageHandle The firmware allocated handle for the EFI image.
160 @param[in] SystemTable A pointer to the EFI System Table.
162 @retval EFI_SUCCESS The entry point is executed successfully.
163 @retval other Some error occurs when executing this entry point.
168 InitializeWinNtBusDriver(
169 IN EFI_HANDLE ImageHandle
,
170 IN EFI_SYSTEM_TABLE
*SystemTable
176 // Install driver model protocol(s).
178 Status
= EfiLibInstallDriverBindingComponentName2 (
181 &gWinNtBusDriverBinding
,
183 &gWinNtBusDriverComponentName
,
184 &gWinNtBusDriverComponentName2
186 ASSERT_EFI_ERROR (Status
);
199 Buffer
= AllocatePool (Size
);
200 ASSERT (Buffer
!= NULL
);
208 WinNtBusDriverBindingSupported (
209 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
210 IN EFI_HANDLE ControllerHandle
,
211 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
224 // TODO: This - add argument and description to function comment
225 // TODO: ControllerHandle - add argument and description to function comment
226 // TODO: RemainingDevicePath - add argument and description to function comment
227 // TODO: EFI_UNSUPPORTED - add return value to function comment
228 // TODO: EFI_UNSUPPORTED - add return value to function comment
229 // TODO: EFI_SUCCESS - add return value to function comment
230 // TODO: EFI_SUCCESS - add return value to function comment
233 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
234 EFI_WIN_NT_THUNK_PROTOCOL
*WinNtThunk
;
238 // Check the contents of the first Device Path Node of RemainingDevicePath to make sure
239 // it is a legal Device Path Node for this bus driver's children.
241 if (RemainingDevicePath
!= NULL
) {
242 if (RemainingDevicePath
->Type
!= HARDWARE_DEVICE_PATH
||
243 RemainingDevicePath
->SubType
!= HW_VENDOR_DP
||
244 DevicePathNodeLength(RemainingDevicePath
) != sizeof(WIN_NT_VENDOR_DEVICE_PATH_NODE
)) {
245 return EFI_UNSUPPORTED
;
248 for (Index
= 0; Index
< NT_PCD_ARRAY_SIZE
; Index
++) {
249 if (CompareGuid (&((VENDOR_DEVICE_PATH
*) RemainingDevicePath
)->Guid
, mPcdEnvironment
[Index
].DevicePathGuid
)) {
254 if (Index
>= NT_PCD_ARRAY_SIZE
) {
255 return EFI_UNSUPPORTED
;
260 // Open the IO Abstraction(s) needed to perform the supported test
262 Status
= gBS
->OpenProtocol (
264 &gEfiDevicePathProtocolGuid
,
266 This
->DriverBindingHandle
,
268 EFI_OPEN_PROTOCOL_BY_DRIVER
270 if (Status
== EFI_ALREADY_STARTED
) {
274 if (EFI_ERROR (Status
)) {
280 &gEfiDevicePathProtocolGuid
,
281 This
->DriverBindingHandle
,
285 Status
= gBS
->OpenProtocol (
287 &gEfiWinNtThunkProtocolGuid
,
289 This
->DriverBindingHandle
,
291 EFI_OPEN_PROTOCOL_BY_DRIVER
293 if (Status
== EFI_ALREADY_STARTED
) {
297 if (EFI_ERROR (Status
)) {
302 // Since we call through WinNtThunk we need to make sure it's valid
304 Status
= EFI_SUCCESS
;
305 if (WinNtThunk
->Signature
!= EFI_WIN_NT_THUNK_PROTOCOL_SIGNATURE
) {
306 Status
= EFI_UNSUPPORTED
;
310 // Close the I/O Abstraction(s) used to perform the supported test
314 &gEfiWinNtThunkProtocolGuid
,
315 This
->DriverBindingHandle
,
324 WinNtBusDriverBindingStart (
325 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
326 IN EFI_HANDLE ControllerHandle
,
327 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
340 // TODO: This - add argument and description to function comment
341 // TODO: ControllerHandle - add argument and description to function comment
342 // TODO: RemainingDevicePath - add argument and description to function comment
343 // TODO: EFI_OUT_OF_RESOURCES - add return value to function comment
344 // TODO: EFI_OUT_OF_RESOURCES - add return value to function comment
345 // TODO: EFI_SUCCESS - add return value to function comment
348 EFI_STATUS InstallStatus
;
349 EFI_WIN_NT_THUNK_PROTOCOL
*WinNtThunk
;
350 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
351 WIN_NT_BUS_DEVICE
*WinNtBusDevice
;
352 WIN_NT_IO_DEVICE
*WinNtDevice
;
358 UINT16 ComponentName
[MAX_NT_ENVIRNMENT_VARIABLE_LENGTH
];
359 WIN_NT_VENDOR_DEVICE_PATH_NODE
*Node
;
360 BOOLEAN CreateDevice
;
365 Status
= EFI_UNSUPPORTED
;
368 // Grab the protocols we need
370 Status
= gBS
->OpenProtocol (
372 &gEfiDevicePathProtocolGuid
,
374 This
->DriverBindingHandle
,
376 EFI_OPEN_PROTOCOL_BY_DRIVER
378 if (EFI_ERROR (Status
) && Status
!= EFI_ALREADY_STARTED
) {
382 Status
= gBS
->OpenProtocol (
384 &gEfiWinNtThunkProtocolGuid
,
386 This
->DriverBindingHandle
,
388 EFI_OPEN_PROTOCOL_BY_DRIVER
390 if (EFI_ERROR (Status
) && Status
!= EFI_ALREADY_STARTED
) {
394 if (Status
!= EFI_ALREADY_STARTED
) {
395 WinNtBusDevice
= AllocatePool (sizeof (WIN_NT_BUS_DEVICE
));
396 if (WinNtBusDevice
== NULL
) {
397 return EFI_OUT_OF_RESOURCES
;
400 WinNtBusDevice
->Signature
= WIN_NT_BUS_DEVICE_SIGNATURE
;
401 WinNtBusDevice
->ControllerNameTable
= NULL
;
405 gWinNtBusDriverComponentName
.SupportedLanguages
,
406 &WinNtBusDevice
->ControllerNameTable
,
407 L
"Windows Bus Controller",
412 gWinNtBusDriverComponentName2
.SupportedLanguages
,
413 &WinNtBusDevice
->ControllerNameTable
,
414 L
"Windows Bus Controller",
419 Status
= gBS
->InstallMultipleProtocolInterfaces (
421 &gWinNtBusDriverGuid
,
425 if (EFI_ERROR (Status
)) {
426 FreeUnicodeStringTable (WinNtBusDevice
->ControllerNameTable
);
427 FreePool (WinNtBusDevice
);
433 // Loop on the Variable list. Parse each variable to produce a set of handles that
434 // represent virtual hardware devices.
436 InstallStatus
= EFI_NOT_FOUND
;
437 for (Index
= 0; Index
< NT_PCD_ARRAY_SIZE
; Index
++) {
438 PcdTempStr
= (VOID
*)LibPcdGetPtr (mPcdEnvironment
[Index
].Token
);
439 ASSERT (PcdTempStr
!= NULL
);
441 TempStrSize
= StrLen (PcdTempStr
);
442 TempStr
= AllocateMemory ((TempStrSize
* sizeof (CHAR16
)) + 1);
443 StrCpy (TempStr
, PcdTempStr
);
445 StartString
= TempStr
;
448 // Parse the envirnment variable into sub strings using '!' as a delimator.
449 // Each substring needs it's own handle to be added to the system. This code
450 // does not understand the sub string. Thats the device drivers job.
453 while (*StartString
!= '\0') {
456 // Find the end of the sub string
458 SubString
= StartString
;
459 while (*SubString
!= '\0' && *SubString
!= '!') {
463 if (*SubString
== '!') {
465 // Replace token with '\0' to make sub strings. If this is the end
466 // of the string SubString will already point to NULL.
473 if (RemainingDevicePath
!= NULL
) {
474 CreateDevice
= FALSE
;
475 Node
= (WIN_NT_VENDOR_DEVICE_PATH_NODE
*) RemainingDevicePath
;
476 if (Node
->VendorDevicePath
.Header
.Type
== HARDWARE_DEVICE_PATH
&&
477 Node
->VendorDevicePath
.Header
.SubType
== HW_VENDOR_DP
&&
478 DevicePathNodeLength (&Node
->VendorDevicePath
.Header
) == sizeof (WIN_NT_VENDOR_DEVICE_PATH_NODE
)
480 if (CompareGuid (&Node
->VendorDevicePath
.Guid
, mPcdEnvironment
[Index
].DevicePathGuid
) &&
481 Node
->Instance
== Count
491 // Allocate instance structure, and fill in parent information.
493 WinNtDevice
= AllocateMemory (sizeof (WIN_NT_IO_DEVICE
));
494 if (WinNtDevice
== NULL
) {
495 return EFI_OUT_OF_RESOURCES
;
498 WinNtDevice
->Handle
= NULL
;
499 WinNtDevice
->ControllerHandle
= ControllerHandle
;
500 WinNtDevice
->ParentDevicePath
= ParentDevicePath
;
502 WinNtDevice
->WinNtIo
.WinNtThunk
= WinNtThunk
;
505 // Plus 2 to account for the NULL at the end of the Unicode string
507 StringSize
= (UINTN
) ((UINT8
*) SubString
- (UINT8
*) StartString
) + sizeof (CHAR16
);
508 WinNtDevice
->WinNtIo
.EnvString
= AllocateMemory (StringSize
);
509 if (WinNtDevice
->WinNtIo
.EnvString
!= NULL
) {
510 CopyMem (WinNtDevice
->WinNtIo
.EnvString
, StartString
, StringSize
);
513 WinNtDevice
->ControllerNameTable
= NULL
;
515 WinNtThunk
->SPrintf (ComponentName
, sizeof (ComponentName
), L
"%s", WinNtDevice
->WinNtIo
.EnvString
);
517 WinNtDevice
->DevicePath
= WinNtBusCreateDevicePath (
519 mPcdEnvironment
[Index
].DevicePathGuid
,
522 if (WinNtDevice
->DevicePath
== NULL
) {
523 FreePool (WinNtDevice
);
524 return EFI_OUT_OF_RESOURCES
;
529 gWinNtBusDriverComponentName
.SupportedLanguages
,
530 &WinNtDevice
->ControllerNameTable
,
536 gWinNtBusDriverComponentName2
.SupportedLanguages
,
537 &WinNtDevice
->ControllerNameTable
,
543 WinNtDevice
->WinNtIo
.TypeGuid
= mPcdEnvironment
[Index
].DevicePathGuid
;
544 WinNtDevice
->WinNtIo
.InstanceNumber
= Count
;
546 WinNtDevice
->Signature
= WIN_NT_IO_DEVICE_SIGNATURE
;
548 Status
= gBS
->InstallMultipleProtocolInterfaces (
549 &WinNtDevice
->Handle
,
550 &gEfiDevicePathProtocolGuid
,
551 WinNtDevice
->DevicePath
,
552 &gEfiWinNtIoProtocolGuid
,
553 &WinNtDevice
->WinNtIo
,
556 if (EFI_ERROR (Status
)) {
557 FreeUnicodeStringTable (WinNtDevice
->ControllerNameTable
);
558 FreePool (WinNtDevice
);
561 // Open For Child Device
563 Status
= gBS
->OpenProtocol (
565 &gEfiWinNtThunkProtocolGuid
,
567 This
->DriverBindingHandle
,
569 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
571 if (!EFI_ERROR (Status
)) {
572 InstallStatus
= EFI_SUCCESS
;
578 // Parse Next sub string. This will point to '\0' if we are at the end.
581 StartString
= SubString
;
593 WinNtBusDriverBindingStop (
594 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
595 IN EFI_HANDLE ControllerHandle
,
596 IN UINTN NumberOfChildren
,
597 IN EFI_HANDLE
*ChildHandleBuffer
610 // TODO: This - add argument and description to function comment
611 // TODO: ControllerHandle - add argument and description to function comment
612 // TODO: NumberOfChildren - add argument and description to function comment
613 // TODO: ChildHandleBuffer - add argument and description to function comment
614 // TODO: EFI_SUCCESS - add return value to function comment
615 // TODO: EFI_DEVICE_ERROR - add return value to function comment
616 // TODO: EFI_SUCCESS - add return value to function comment
620 BOOLEAN AllChildrenStopped
;
621 EFI_WIN_NT_IO_PROTOCOL
*WinNtIo
;
622 WIN_NT_BUS_DEVICE
*WinNtBusDevice
;
623 WIN_NT_IO_DEVICE
*WinNtDevice
;
624 EFI_WIN_NT_THUNK_PROTOCOL
*WinNtThunk
;
627 // Complete all outstanding transactions to Controller.
628 // Don't allow any new transaction to Controller to be started.
631 if (NumberOfChildren
== 0) {
633 // Close the bus driver
635 Status
= gBS
->OpenProtocol (
637 &gWinNtBusDriverGuid
,
639 This
->DriverBindingHandle
,
641 EFI_OPEN_PROTOCOL_GET_PROTOCOL
643 if (EFI_ERROR (Status
)) {
647 gBS
->UninstallMultipleProtocolInterfaces (
649 &gWinNtBusDriverGuid
,
654 FreeUnicodeStringTable (WinNtBusDevice
->ControllerNameTable
);
656 FreePool (WinNtBusDevice
);
660 &gEfiWinNtThunkProtocolGuid
,
661 This
->DriverBindingHandle
,
667 &gEfiDevicePathProtocolGuid
,
668 This
->DriverBindingHandle
,
674 AllChildrenStopped
= TRUE
;
676 for (Index
= 0; Index
< NumberOfChildren
; Index
++) {
678 Status
= gBS
->OpenProtocol (
679 ChildHandleBuffer
[Index
],
680 &gEfiWinNtIoProtocolGuid
,
682 This
->DriverBindingHandle
,
684 EFI_OPEN_PROTOCOL_GET_PROTOCOL
686 if (!EFI_ERROR (Status
)) {
688 WinNtDevice
= WIN_NT_IO_DEVICE_FROM_THIS (WinNtIo
);
690 Status
= gBS
->CloseProtocol (
692 &gEfiWinNtThunkProtocolGuid
,
693 This
->DriverBindingHandle
,
697 Status
= gBS
->UninstallMultipleProtocolInterfaces (
699 &gEfiDevicePathProtocolGuid
,
700 WinNtDevice
->DevicePath
,
701 &gEfiWinNtIoProtocolGuid
,
702 &WinNtDevice
->WinNtIo
,
706 if (EFI_ERROR (Status
)) {
709 &gEfiWinNtThunkProtocolGuid
,
710 (VOID
**) &WinNtThunk
,
711 This
->DriverBindingHandle
,
713 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
717 // Close the child handle
719 FreeUnicodeStringTable (WinNtDevice
->ControllerNameTable
);
720 FreePool (WinNtDevice
);
724 if (EFI_ERROR (Status
)) {
725 AllChildrenStopped
= FALSE
;
729 if (!AllChildrenStopped
) {
730 return EFI_DEVICE_ERROR
;
736 EFI_DEVICE_PATH_PROTOCOL
*
737 WinNtBusCreateDevicePath (
738 IN EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
,
740 IN UINT16 InstanceNumber
745 Create a device path node using Guid and InstanceNumber and append it to
746 the passed in RootDevicePath
749 RootDevicePath - Root of the device path to return.
751 Guid - GUID to use in vendor device path node.
753 InstanceNumber - Instance number to use in the vendor device path. This
754 argument is needed to make sure each device path is unique.
758 EFI_DEVICE_PATH_PROTOCOL
762 WIN_NT_VENDOR_DEVICE_PATH_NODE DevicePath
;
764 DevicePath
.VendorDevicePath
.Header
.Type
= HARDWARE_DEVICE_PATH
;
765 DevicePath
.VendorDevicePath
.Header
.SubType
= HW_VENDOR_DP
;
766 SetDevicePathNodeLength (&DevicePath
.VendorDevicePath
.Header
, sizeof (WIN_NT_VENDOR_DEVICE_PATH_NODE
));
769 // The GUID defines the Class
771 CopyMem (&DevicePath
.VendorDevicePath
.Guid
, Guid
, sizeof (EFI_GUID
));
774 // Add an instance number so we can make sure there are no Device Path
777 DevicePath
.Instance
= InstanceNumber
;
779 return AppendDevicePathNode (
781 (EFI_DEVICE_PATH_PROTOCOL
*) &DevicePath