123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332 |
- /** @file
- Driver Binding functions implementation for UEFI HTTP boot.
- Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include "HttpBootDxe.h"
- ///
- /// Driver Binding Protocol instance
- ///
- EFI_DRIVER_BINDING_PROTOCOL gHttpBootIp4DxeDriverBinding = {
- HttpBootIp4DxeDriverBindingSupported,
- HttpBootIp4DxeDriverBindingStart,
- HttpBootIp4DxeDriverBindingStop,
- HTTP_BOOT_DXE_VERSION,
- NULL,
- NULL
- };
- EFI_DRIVER_BINDING_PROTOCOL gHttpBootIp6DxeDriverBinding = {
- HttpBootIp6DxeDriverBindingSupported,
- HttpBootIp6DxeDriverBindingStart,
- HttpBootIp6DxeDriverBindingStop,
- HTTP_BOOT_DXE_VERSION,
- NULL,
- NULL
- };
- /**
- Check whether UNDI protocol supports IPv6.
- @param[in] Private Pointer to HTTP_BOOT_PRIVATE_DATA.
- @param[out] Ipv6Support TRUE if UNDI supports IPv6.
- @retval EFI_SUCCESS Get the result whether UNDI supports IPv6 by NII or AIP protocol successfully.
- @retval EFI_NOT_FOUND Don't know whether UNDI supports IPv6 since NII or AIP is not available.
- **/
- EFI_STATUS
- HttpBootCheckIpv6Support (
- IN HTTP_BOOT_PRIVATE_DATA *Private,
- OUT BOOLEAN *Ipv6Support
- )
- {
- EFI_HANDLE Handle;
- EFI_ADAPTER_INFORMATION_PROTOCOL *Aip;
- EFI_STATUS Status;
- EFI_GUID *InfoTypesBuffer;
- UINTN InfoTypeBufferCount;
- UINTN TypeIndex;
- BOOLEAN Supported;
- VOID *InfoBlock;
- UINTN InfoBlockSize;
- ASSERT (Private != NULL && Ipv6Support != NULL);
- //
- // Check whether the UNDI supports IPv6 by NII protocol.
- //
- if (Private->Nii != NULL) {
- *Ipv6Support = Private->Nii->Ipv6Supported;
- return EFI_SUCCESS;
- }
- //
- // Get the NIC handle by SNP protocol.
- //
- Handle = NetLibGetSnpHandle (Private->Controller, NULL);
- if (Handle == NULL) {
- return EFI_NOT_FOUND;
- }
- Aip = NULL;
- Status = gBS->HandleProtocol (
- Handle,
- &gEfiAdapterInformationProtocolGuid,
- (VOID *) &Aip
- );
- if (EFI_ERROR (Status) || Aip == NULL) {
- return EFI_NOT_FOUND;
- }
- InfoTypesBuffer = NULL;
- InfoTypeBufferCount = 0;
- Status = Aip->GetSupportedTypes (Aip, &InfoTypesBuffer, &InfoTypeBufferCount);
- if (EFI_ERROR (Status) || InfoTypesBuffer == NULL) {
- FreePool (InfoTypesBuffer);
- return EFI_NOT_FOUND;
- }
- Supported = FALSE;
- for (TypeIndex = 0; TypeIndex < InfoTypeBufferCount; TypeIndex++) {
- if (CompareGuid (&InfoTypesBuffer[TypeIndex], &gEfiAdapterInfoUndiIpv6SupportGuid)) {
- Supported = TRUE;
- break;
- }
- }
- FreePool (InfoTypesBuffer);
- if (!Supported) {
- return EFI_NOT_FOUND;
- }
- //
- // We now have adapter information block.
- //
- InfoBlock = NULL;
- InfoBlockSize = 0;
- Status = Aip->GetInformation (Aip, &gEfiAdapterInfoUndiIpv6SupportGuid, &InfoBlock, &InfoBlockSize);
- if (EFI_ERROR (Status) || InfoBlock == NULL) {
- FreePool (InfoBlock);
- return EFI_NOT_FOUND;
- }
- *Ipv6Support = ((EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT *) InfoBlock)->Ipv6Support;
- FreePool (InfoBlock);
- return EFI_SUCCESS;
- }
- /**
- Destroy the HTTP child based on IPv4 stack.
- @param[in] This Pointer to the EFI_DRIVER_BINDING_PROTOCOL.
- @param[in] Private Pointer to HTTP_BOOT_PRIVATE_DATA.
- **/
- VOID
- HttpBootDestroyIp4Children (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN HTTP_BOOT_PRIVATE_DATA *Private
- )
- {
- ASSERT (This != NULL);
- ASSERT (Private != NULL);
- if (Private->Dhcp4Child != NULL) {
- gBS->CloseProtocol (
- Private->Dhcp4Child,
- &gEfiDhcp4ProtocolGuid,
- This->DriverBindingHandle,
- Private->Controller
- );
- NetLibDestroyServiceChild (
- Private->Controller,
- This->DriverBindingHandle,
- &gEfiDhcp4ServiceBindingProtocolGuid,
- Private->Dhcp4Child
- );
- }
- if (Private->Ip6Nic == NULL && Private->HttpCreated) {
- HttpIoDestroyIo (&Private->HttpIo);
- Private->HttpCreated = FALSE;
- }
- if (Private->Ip4Nic != NULL) {
- gBS->CloseProtocol (
- Private->Controller,
- &gEfiCallerIdGuid,
- This->DriverBindingHandle,
- Private->Ip4Nic->Controller
- );
- gBS->UninstallMultipleProtocolInterfaces (
- Private->Ip4Nic->Controller,
- &gEfiLoadFileProtocolGuid,
- &Private->Ip4Nic->LoadFile,
- &gEfiDevicePathProtocolGuid,
- Private->Ip4Nic->DevicePath,
- NULL
- );
- FreePool (Private->Ip4Nic);
- Private->Ip4Nic = NULL;
- }
- }
- /**
- Destroy the HTTP child based on IPv6 stack.
- @param[in] This Pointer to the EFI_DRIVER_BINDING_PROTOCOL.
- @param[in] Private Pointer to HTTP_BOOT_PRIVATE_DATA.
- **/
- VOID
- HttpBootDestroyIp6Children (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN HTTP_BOOT_PRIVATE_DATA *Private
- )
- {
- ASSERT (This != NULL);
- ASSERT (Private != NULL);
- if (Private->Ip6Child != NULL) {
- gBS->CloseProtocol (
- Private->Ip6Child,
- &gEfiIp6ProtocolGuid,
- This->DriverBindingHandle,
- Private->Controller
- );
- NetLibDestroyServiceChild (
- Private->Controller,
- This->DriverBindingHandle,
- &gEfiIp6ServiceBindingProtocolGuid,
- Private->Ip6Child
- );
- }
- if (Private->Dhcp6Child != NULL) {
- gBS->CloseProtocol (
- Private->Dhcp6Child,
- &gEfiDhcp6ProtocolGuid,
- This->DriverBindingHandle,
- Private->Controller
- );
- NetLibDestroyServiceChild (
- Private->Controller,
- This->DriverBindingHandle,
- &gEfiDhcp6ServiceBindingProtocolGuid,
- Private->Dhcp6Child
- );
- }
- if (Private->Ip4Nic == NULL && Private->HttpCreated) {
- HttpIoDestroyIo(&Private->HttpIo);
- Private->HttpCreated = FALSE;
- }
- if (Private->Ip6Nic != NULL) {
- gBS->CloseProtocol (
- Private->Controller,
- &gEfiCallerIdGuid,
- This->DriverBindingHandle,
- Private->Ip6Nic->Controller
- );
- gBS->UninstallMultipleProtocolInterfaces (
- Private->Ip6Nic->Controller,
- &gEfiLoadFileProtocolGuid,
- &Private->Ip6Nic->LoadFile,
- &gEfiDevicePathProtocolGuid,
- Private->Ip6Nic->DevicePath,
- NULL
- );
- FreePool (Private->Ip6Nic);
- Private->Ip6Nic = NULL;
- }
- }
- /**
- Tests to see if this driver supports a given controller. If a child device is provided,
- it further tests to see if this driver supports creating a handle for the specified child device.
- This function checks to see if the driver specified by This supports the device specified by
- ControllerHandle. Drivers will typically use the device path attached to
- ControllerHandle and/or the services from the bus I/O abstraction attached to
- ControllerHandle to determine if the driver supports ControllerHandle. This function
- may be called many times during platform initialization. In order to reduce boot times, the tests
- performed by this function must be very small, and take as little time as possible to execute. This
- function must not change the state of any hardware devices, and this function must be aware that the
- device specified by ControllerHandle may already be managed by the same driver or a
- different driver. This function must match its calls to AllocatePages() with FreePages(),
- AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
- Because ControllerHandle may have been previously started by the same driver, if a protocol is
- already in the opened state, then it must not be closed with CloseProtocol(). This is required
- to guarantee the state of ControllerHandle is not modified by this function.
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
- @param[in] ControllerHandle The handle of the controller to test. This handle
- must support a protocol interface that supplies
- an I/O abstraction to the driver.
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
- parameter is ignored by device drivers, and is optional for bus
- drivers. For bus drivers, if this parameter is not NULL, then
- the bus driver must determine if the bus controller specified
- by ControllerHandle and the child controller specified
- by RemainingDevicePath are both supported by this
- bus driver.
- @retval EFI_SUCCESS The device specified by ControllerHandle and
- RemainingDevicePath is supported by the driver specified by This.
- @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
- RemainingDevicePath is already being managed by the driver
- specified by This.
- @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
- RemainingDevicePath is already being managed by a different
- driver or an application that requires exclusive access.
- Currently not implemented.
- @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
- RemainingDevicePath is not supported by the driver specified by This.
- **/
- EFI_STATUS
- EFIAPI
- HttpBootIp4DxeDriverBindingSupported (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- //
- // Try to open the DHCP4, HTTP4 and Device Path protocol.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDhcp4ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiHttpServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDevicePathProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- return Status;
- }
- /**
- Starts a device controller or a bus controller.
- The Start() function is designed to be invoked from the EFI boot service ConnectController().
- As a result, much of the error checking on the parameters to Start() has been moved into this
- common boot service. It is legal to call Start() from other locations,
- but the following calling restrictions must be followed, or the system behavior will not be deterministic.
- 1. ControllerHandle must be a valid EFI_HANDLE.
- 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
- EFI_DEVICE_PATH_PROTOCOL.
- 3. Prior to calling Start(), the Supported() function for the driver specified by This must
- have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
- @param[in] ControllerHandle The handle of the controller to start. This handle
- must support a protocol interface that supplies
- an I/O abstraction to the driver.
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
- parameter is ignored by device drivers, and is optional for bus
- drivers. For a bus driver, if this parameter is NULL, then handles
- for all the children of Controller are created by this driver.
- If this parameter is not NULL and the first Device Path Node is
- not the End of Device Path Node, then only the handle for the
- child device specified by the first Device Path Node of
- RemainingDevicePath is created by this driver.
- If the first Device Path Node of RemainingDevicePath is
- the End of Device Path Node, no child handle is created by this
- driver.
- @retval EFI_SUCCESS The device was started.
- @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
- @retval Others The driver failded to start the device.
- **/
- EFI_STATUS
- EFIAPI
- HttpBootIp4DxeDriverBindingStart (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- HTTP_BOOT_PRIVATE_DATA *Private;
- EFI_DEV_PATH *Node;
- EFI_DEVICE_PATH_PROTOCOL *DevicePath;
- UINT32 *Id;
- BOOLEAN FirstStart;
- FirstStart = FALSE;
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiCallerIdGuid,
- (VOID **) &Id,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (!EFI_ERROR (Status)) {
- Private = HTTP_BOOT_PRIVATE_DATA_FROM_ID(Id);
- } else {
- FirstStart = TRUE;
- //
- // Initialize the private data structure.
- //
- Private = AllocateZeroPool (sizeof (HTTP_BOOT_PRIVATE_DATA));
- if (Private == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- Private->Signature = HTTP_BOOT_PRIVATE_DATA_SIGNATURE;
- Private->Controller = ControllerHandle;
- InitializeListHead (&Private->CacheList);
- //
- // Get the NII interface if it exists, it's not required.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiNetworkInterfaceIdentifierProtocolGuid_31,
- (VOID **) &Private->Nii,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- Private->Nii = NULL;
- }
- //
- // Open Device Path Protocol to prepare for appending IP and URI node.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDevicePathProtocolGuid,
- (VOID **) &Private->ParentDevicePath,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Initialize the HII configuration form.
- //
- Status = HttpBootConfigFormInit (Private);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Install a protocol with Caller Id Guid to the NIC, this is just to build the relationship between
- // NIC handle and the private data.
- //
- Status = gBS->InstallProtocolInterface (
- &ControllerHandle,
- &gEfiCallerIdGuid,
- EFI_NATIVE_INTERFACE,
- &Private->Id
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- }
- if (Private->Ip4Nic != NULL) {
- //
- // Already created before
- //
- return EFI_SUCCESS;
- }
- Private->Ip4Nic = AllocateZeroPool (sizeof (HTTP_BOOT_VIRTUAL_NIC));
- if (Private->Ip4Nic == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- Private->Ip4Nic->Private = Private;
- Private->Ip4Nic->ImageHandle = This->DriverBindingHandle;
- Private->Ip4Nic->Signature = HTTP_BOOT_VIRTUAL_NIC_SIGNATURE;
- //
- // Create DHCP4 child instance.
- //
- Status = NetLibCreateServiceChild (
- ControllerHandle,
- This->DriverBindingHandle,
- &gEfiDhcp4ServiceBindingProtocolGuid,
- &Private->Dhcp4Child
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = gBS->OpenProtocol (
- Private->Dhcp4Child,
- &gEfiDhcp4ProtocolGuid,
- (VOID **) &Private->Dhcp4,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_BY_DRIVER
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Get the Ip4Config2 protocol, it's required to configure the default gateway address.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiIp4Config2ProtocolGuid,
- (VOID **) &Private->Ip4Config2,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Append IPv4 device path node.
- //
- Node = AllocateZeroPool (sizeof (IPv4_DEVICE_PATH));
- if (Node == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- Node->Ipv4.Header.Type = MESSAGING_DEVICE_PATH;
- Node->Ipv4.Header.SubType = MSG_IPv4_DP;
- SetDevicePathNodeLength (Node, sizeof (IPv4_DEVICE_PATH));
- Node->Ipv4.StaticIpAddress = FALSE;
- DevicePath = AppendDevicePathNode (Private->ParentDevicePath, (EFI_DEVICE_PATH_PROTOCOL*) Node);
- FreePool (Node);
- if (DevicePath == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- //
- // Append URI device path node.
- //
- Node = AllocateZeroPool (sizeof (EFI_DEVICE_PATH_PROTOCOL));
- if (Node == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- Node->DevPath.Type = MESSAGING_DEVICE_PATH;
- Node->DevPath.SubType = MSG_URI_DP;
- SetDevicePathNodeLength (Node, sizeof (EFI_DEVICE_PATH_PROTOCOL));
- Private->Ip4Nic->DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL*) Node);
- FreePool (Node);
- FreePool (DevicePath);
- if (Private->Ip4Nic->DevicePath == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- //
- // Create a child handle for the HTTP boot and install DevPath and Load file protocol on it.
- //
- CopyMem (&Private->Ip4Nic->LoadFile, &gHttpBootDxeLoadFile, sizeof (EFI_LOAD_FILE_PROTOCOL));
- Status = gBS->InstallMultipleProtocolInterfaces (
- &Private->Ip4Nic->Controller,
- &gEfiLoadFileProtocolGuid,
- &Private->Ip4Nic->LoadFile,
- &gEfiDevicePathProtocolGuid,
- Private->Ip4Nic->DevicePath,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Open the Caller Id child to setup a parent-child relationship between
- // real NIC handle and the HTTP boot Ipv4 NIC handle.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiCallerIdGuid,
- (VOID **) &Id,
- This->DriverBindingHandle,
- Private->Ip4Nic->Controller,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- return EFI_SUCCESS;
- ON_ERROR:
- if (Private != NULL) {
- if (FirstStart) {
- gBS->UninstallProtocolInterface (
- ControllerHandle,
- &gEfiCallerIdGuid,
- &Private->Id
- );
- }
- HttpBootDestroyIp4Children (This, Private);
- HttpBootConfigFormUnload (Private);
- if (FirstStart) {
- FreePool (Private);
- }
- }
- return Status;
- }
- /**
- Stops a device controller or a bus controller.
- The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
- As a result, much of the error checking on the parameters to Stop() has been moved
- into this common boot service. It is legal to call Stop() from other locations,
- but the following calling restrictions must be followed, or the system behavior will not be deterministic.
- 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
- same driver's Start() function.
- 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
- EFI_HANDLE. In addition, all of these handles must have been created in this driver's
- Start() function, and the Start() function must have called OpenProtocol() on
- ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
- @param[in] ControllerHandle A handle to the device being stopped. The handle must
- support a bus specific I/O protocol for the driver
- to use to stop the device.
- @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
- if NumberOfChildren is 0.
- @retval EFI_SUCCESS The device was stopped.
- @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
- **/
- EFI_STATUS
- EFIAPI
- HttpBootIp4DxeDriverBindingStop (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
- )
- {
- EFI_STATUS Status;
- EFI_LOAD_FILE_PROTOCOL *LoadFile;
- HTTP_BOOT_PRIVATE_DATA *Private;
- EFI_HANDLE NicHandle;
- UINT32 *Id;
- //
- // Try to get the Load File Protocol from the controller handle.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiLoadFileProtocolGuid,
- (VOID **) &LoadFile,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- //
- // If failed, try to find the NIC handle for this controller.
- //
- NicHandle = HttpBootGetNicByIp4Children (ControllerHandle);
- if (NicHandle == NULL) {
- return EFI_SUCCESS;
- }
- //
- // Try to retrieve the private data by the Caller Id Guid.
- //
- Status = gBS->OpenProtocol (
- NicHandle,
- &gEfiCallerIdGuid,
- (VOID **) &Id,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- Private = HTTP_BOOT_PRIVATE_DATA_FROM_ID (Id);
- } else {
- Private = HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE (LoadFile);
- NicHandle = Private->Controller;
- }
- //
- // Disable the HTTP boot function.
- //
- Status = HttpBootStop (Private);
- if (Status != EFI_SUCCESS && Status != EFI_NOT_STARTED) {
- return Status;
- }
- //
- // Destory all child instance and uninstall protocol interface.
- //
- HttpBootDestroyIp4Children (This, Private);
- if (Private->Ip4Nic == NULL && Private->Ip6Nic == NULL) {
- //
- // Release the cached data.
- //
- HttpBootFreeCacheList (Private);
- //
- // Unload the config form.
- //
- HttpBootConfigFormUnload (Private);
- gBS->UninstallProtocolInterface (
- NicHandle,
- &gEfiCallerIdGuid,
- &Private->Id
- );
- FreePool (Private);
- }
- return EFI_SUCCESS;
- }
- /**
- Tests to see if this driver supports a given controller. If a child device is provided,
- it further tests to see if this driver supports creating a handle for the specified child device.
- This function checks to see if the driver specified by This supports the device specified by
- ControllerHandle. Drivers will typically use the device path attached to
- ControllerHandle and/or the services from the bus I/O abstraction attached to
- ControllerHandle to determine if the driver supports ControllerHandle. This function
- may be called many times during platform initialization. In order to reduce boot times, the tests
- performed by this function must be very small, and take as little time as possible to execute. This
- function must not change the state of any hardware devices, and this function must be aware that the
- device specified by ControllerHandle may already be managed by the same driver or a
- different driver. This function must match its calls to AllocatePages() with FreePages(),
- AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
- Because ControllerHandle may have been previously started by the same driver, if a protocol is
- already in the opened state, then it must not be closed with CloseProtocol(). This is required
- to guarantee the state of ControllerHandle is not modified by this function.
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
- @param[in] ControllerHandle The handle of the controller to test. This handle
- must support a protocol interface that supplies
- an I/O abstraction to the driver.
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
- parameter is ignored by device drivers, and is optional for bus
- drivers. For bus drivers, if this parameter is not NULL, then
- the bus driver must determine if the bus controller specified
- by ControllerHandle and the child controller specified
- by RemainingDevicePath are both supported by this
- bus driver.
- @retval EFI_SUCCESS The device specified by ControllerHandle and
- RemainingDevicePath is supported by the driver specified by This.
- @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
- RemainingDevicePath is already being managed by the driver
- specified by This.
- @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
- RemainingDevicePath is already being managed by a different
- driver or an application that requires exclusive access.
- Currently not implemented.
- @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
- RemainingDevicePath is not supported by the driver specified by This.
- **/
- EFI_STATUS
- EFIAPI
- HttpBootIp6DxeDriverBindingSupported (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- //
- // Try to open the DHCP6, HTTP and Device Path protocol.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDhcp6ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiHttpServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDevicePathProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- return Status;
- }
- /**
- Starts a device controller or a bus controller.
- The Start() function is designed to be invoked from the EFI boot service ConnectController().
- As a result, much of the error checking on the parameters to Start() has been moved into this
- common boot service. It is legal to call Start() from other locations,
- but the following calling restrictions must be followed, or the system behavior will not be deterministic.
- 1. ControllerHandle must be a valid EFI_HANDLE.
- 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
- EFI_DEVICE_PATH_PROTOCOL.
- 3. Prior to calling Start(), the Supported() function for the driver specified by This must
- have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
- @param[in] ControllerHandle The handle of the controller to start. This handle
- must support a protocol interface that supplies
- an I/O abstraction to the driver.
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
- parameter is ignored by device drivers, and is optional for bus
- drivers. For a bus driver, if this parameter is NULL, then handles
- for all the children of Controller are created by this driver.
- If this parameter is not NULL and the first Device Path Node is
- not the End of Device Path Node, then only the handle for the
- child device specified by the first Device Path Node of
- RemainingDevicePath is created by this driver.
- If the first Device Path Node of RemainingDevicePath is
- the End of Device Path Node, no child handle is created by this
- driver.
- @retval EFI_SUCCESS The device was started.
- @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
- @retval Others The driver failded to start the device.
- **/
- EFI_STATUS
- EFIAPI
- HttpBootIp6DxeDriverBindingStart (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- HTTP_BOOT_PRIVATE_DATA *Private;
- EFI_DEV_PATH *Node;
- EFI_DEVICE_PATH_PROTOCOL *DevicePath;
- UINT32 *Id;
- BOOLEAN Ipv6Available;
- BOOLEAN FirstStart;
- FirstStart = FALSE;
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiCallerIdGuid,
- (VOID **) &Id,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (!EFI_ERROR (Status)) {
- Private = HTTP_BOOT_PRIVATE_DATA_FROM_ID(Id);
- } else {
- FirstStart = TRUE;
- //
- // Initialize the private data structure.
- //
- Private = AllocateZeroPool (sizeof (HTTP_BOOT_PRIVATE_DATA));
- if (Private == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- Private->Signature = HTTP_BOOT_PRIVATE_DATA_SIGNATURE;
- Private->Controller = ControllerHandle;
- InitializeListHead (&Private->CacheList);
- //
- // Get the NII interface if it exists, it's not required.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiNetworkInterfaceIdentifierProtocolGuid_31,
- (VOID **) &Private->Nii,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- Private->Nii = NULL;
- }
- //
- // Open Device Path Protocol to prepare for appending IP and URI node.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDevicePathProtocolGuid,
- (VOID **) &Private->ParentDevicePath,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Initialize the HII configuration form.
- //
- Status = HttpBootConfigFormInit (Private);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Install a protocol with Caller Id Guid to the NIC, this is just to build the relationship between
- // NIC handle and the private data.
- //
- Status = gBS->InstallProtocolInterface (
- &ControllerHandle,
- &gEfiCallerIdGuid,
- EFI_NATIVE_INTERFACE,
- &Private->Id
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- }
- //
- // Set IPv6 available flag.
- //
- Status = HttpBootCheckIpv6Support (Private, &Ipv6Available);
- if (EFI_ERROR (Status)) {
- //
- // Fail to get the data whether UNDI supports IPv6.
- // Set default value to TRUE.
- //
- Ipv6Available = TRUE;
- }
- if (!Ipv6Available) {
- Status = EFI_UNSUPPORTED;
- goto ON_ERROR;
- }
- if (Private->Ip6Nic != NULL) {
- //
- // Already created before
- //
- return EFI_SUCCESS;
- }
- Private->Ip6Nic = AllocateZeroPool (sizeof (HTTP_BOOT_VIRTUAL_NIC));
- if (Private->Ip6Nic == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- Private->Ip6Nic->Private = Private;
- Private->Ip6Nic->ImageHandle = This->DriverBindingHandle;
- Private->Ip6Nic->Signature = HTTP_BOOT_VIRTUAL_NIC_SIGNATURE;
- //
- // Create Dhcp6 child and open Dhcp6 protocol
- Status = NetLibCreateServiceChild (
- ControllerHandle,
- This->DriverBindingHandle,
- &gEfiDhcp6ServiceBindingProtocolGuid,
- &Private->Dhcp6Child
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = gBS->OpenProtocol (
- Private->Dhcp6Child,
- &gEfiDhcp6ProtocolGuid,
- (VOID **) &Private->Dhcp6,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_BY_DRIVER
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Create Ip6 child and open Ip6 protocol for background ICMP packets.
- //
- Status = NetLibCreateServiceChild (
- ControllerHandle,
- This->DriverBindingHandle,
- &gEfiIp6ServiceBindingProtocolGuid,
- &Private->Ip6Child
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = gBS->OpenProtocol (
- Private->Ip6Child,
- &gEfiIp6ProtocolGuid,
- (VOID **) &Private->Ip6,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_BY_DRIVER
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Locate Ip6Config protocol, it's required to configure the default gateway address.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiIp6ConfigProtocolGuid,
- (VOID **) &Private->Ip6Config,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Append IPv6 device path node.
- //
- Node = AllocateZeroPool (sizeof (IPv6_DEVICE_PATH));
- if (Node == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- Node->Ipv6.Header.Type = MESSAGING_DEVICE_PATH;
- Node->Ipv6.Header.SubType = MSG_IPv6_DP;
- Node->Ipv6.PrefixLength = IP6_PREFIX_LENGTH;
- SetDevicePathNodeLength (Node, sizeof (IPv6_DEVICE_PATH));
- DevicePath = AppendDevicePathNode(Private->ParentDevicePath, (EFI_DEVICE_PATH*) Node);
- FreePool(Node);
- if (DevicePath == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- //
- // Append URI device path node.
- //
- Node = AllocateZeroPool (sizeof (EFI_DEVICE_PATH_PROTOCOL));
- if (Node == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- Node->DevPath.Type = MESSAGING_DEVICE_PATH;
- Node->DevPath.SubType = MSG_URI_DP;
- SetDevicePathNodeLength (Node, sizeof (EFI_DEVICE_PATH_PROTOCOL));
- Private->Ip6Nic->DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL*) Node);
- FreePool (Node);
- FreePool (DevicePath);
- if (Private->Ip6Nic->DevicePath == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- //
- // Create a child handle for the HTTP boot and install DevPath and Load file protocol on it.
- //
- CopyMem (&Private->Ip6Nic->LoadFile, &gHttpBootDxeLoadFile, sizeof (Private->LoadFile));
- Status = gBS->InstallMultipleProtocolInterfaces (
- &Private->Ip6Nic->Controller,
- &gEfiLoadFileProtocolGuid,
- &Private->Ip6Nic->LoadFile,
- &gEfiDevicePathProtocolGuid,
- Private->Ip6Nic->DevicePath,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Open the Caller Id child to setup a parent-child relationship between
- // real NIC handle and the HTTP boot child handle.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiCallerIdGuid,
- (VOID **) &Id,
- This->DriverBindingHandle,
- Private->Ip6Nic->Controller,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- return EFI_SUCCESS;
- ON_ERROR:
- if (Private != NULL) {
- if (FirstStart) {
- gBS->UninstallProtocolInterface (
- ControllerHandle,
- &gEfiCallerIdGuid,
- &Private->Id
- );
- }
- HttpBootDestroyIp6Children(This, Private);
- HttpBootConfigFormUnload (Private);
- if (FirstStart) {
- FreePool (Private);
- }
- }
- return Status;
- }
- /**
- Stops a device controller or a bus controller.
- The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
- As a result, much of the error checking on the parameters to Stop() has been moved
- into this common boot service. It is legal to call Stop() from other locations,
- but the following calling restrictions must be followed, or the system behavior will not be deterministic.
- 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
- same driver's Start() function.
- 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
- EFI_HANDLE. In addition, all of these handles must have been created in this driver's
- Start() function, and the Start() function must have called OpenProtocol() on
- ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
- @param[in] ControllerHandle A handle to the device being stopped. The handle must
- support a bus specific I/O protocol for the driver
- to use to stop the device.
- @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
- if NumberOfChildren is 0.
- @retval EFI_SUCCESS The device was stopped.
- @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
- **/
- EFI_STATUS
- EFIAPI
- HttpBootIp6DxeDriverBindingStop (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
- )
- {
- EFI_STATUS Status;
- EFI_LOAD_FILE_PROTOCOL *LoadFile;
- HTTP_BOOT_PRIVATE_DATA *Private;
- EFI_HANDLE NicHandle;
- UINT32 *Id;
- //
- // Try to get the Load File Protocol from the controller handle.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiLoadFileProtocolGuid,
- (VOID **) &LoadFile,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- //
- // If failed, try to find the NIC handle for this controller.
- //
- NicHandle = HttpBootGetNicByIp6Children (ControllerHandle);
- if (NicHandle == NULL) {
- return EFI_SUCCESS;
- }
- //
- // Try to retrieve the private data by the Caller Id Guid.
- //
- Status = gBS->OpenProtocol (
- NicHandle,
- &gEfiCallerIdGuid,
- (VOID **) &Id,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- Private = HTTP_BOOT_PRIVATE_DATA_FROM_ID (Id);
- } else {
- Private = HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE (LoadFile);
- NicHandle = Private->Controller;
- }
- //
- // Disable the HTTP boot function.
- //
- Status = HttpBootStop (Private);
- if (Status != EFI_SUCCESS && Status != EFI_NOT_STARTED) {
- return Status;
- }
- //
- // Destory all child instance and uninstall protocol interface.
- //
- HttpBootDestroyIp6Children (This, Private);
- if (Private->Ip4Nic == NULL && Private->Ip6Nic == NULL) {
- //
- // Release the cached data.
- //
- HttpBootFreeCacheList (Private);
- //
- // Unload the config form.
- //
- HttpBootConfigFormUnload (Private);
- gBS->UninstallProtocolInterface (
- NicHandle,
- &gEfiCallerIdGuid,
- &Private->Id
- );
- FreePool (Private);
- }
- return EFI_SUCCESS;
- }
- /**
- This is the declaration of an EFI image entry point. This entry point is
- the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
- both device drivers and bus drivers.
- @param[in] ImageHandle The firmware allocated handle for the UEFI image.
- @param[in] SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS The operation completed successfully.
- @retval Others An unexpected error occurred.
- **/
- EFI_STATUS
- EFIAPI
- HttpBootDxeDriverEntryPoint (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
- {
- EFI_STATUS Status;
- //
- // Install UEFI Driver Model protocol(s).
- //
- Status = EfiLibInstallDriverBindingComponentName2 (
- ImageHandle,
- SystemTable,
- &gHttpBootIp4DxeDriverBinding,
- ImageHandle,
- &gHttpBootDxeComponentName,
- &gHttpBootDxeComponentName2
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- Status = EfiLibInstallDriverBindingComponentName2 (
- ImageHandle,
- SystemTable,
- &gHttpBootIp6DxeDriverBinding,
- NULL,
- &gHttpBootDxeComponentName,
- &gHttpBootDxeComponentName2
- );
- if (EFI_ERROR (Status)) {
- EfiLibUninstallDriverBindingComponentName2(
- &gHttpBootIp4DxeDriverBinding,
- &gHttpBootDxeComponentName,
- &gHttpBootDxeComponentName2
- );
- }
- return Status;
- }
|