123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536 |
- /** @file
- The driver binding and service binding protocol for DnsDxe driver.
- Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include "DnsImpl.h"
- EFI_DRIVER_BINDING_PROTOCOL gDns4DriverBinding = {
- Dns4DriverBindingSupported,
- Dns4DriverBindingStart,
- Dns4DriverBindingStop,
- DNS_VERSION,
- NULL,
- NULL
- };
- EFI_DRIVER_BINDING_PROTOCOL gDns6DriverBinding = {
- Dns6DriverBindingSupported,
- Dns6DriverBindingStart,
- Dns6DriverBindingStop,
- DNS_VERSION,
- NULL,
- NULL
- };
- EFI_SERVICE_BINDING_PROTOCOL mDns4ServiceBinding = {
- Dns4ServiceBindingCreateChild,
- Dns4ServiceBindingDestroyChild
- };
- EFI_SERVICE_BINDING_PROTOCOL mDns6ServiceBinding = {
- Dns6ServiceBindingCreateChild,
- Dns6ServiceBindingDestroyChild
- };
- DNS_DRIVER_DATA *mDriverData = NULL;
- /**
- Destroy the DNS instance and recycle the resources.
- @param[in] Instance The pointer to the DNS instance.
- **/
- VOID
- DnsDestroyInstance (
- IN DNS_INSTANCE *Instance
- )
- {
- ZeroMem (&Instance->Dns4CfgData, sizeof (EFI_DNS4_CONFIG_DATA));
- ZeroMem (&Instance->Dns6CfgData, sizeof (EFI_DNS6_CONFIG_DATA));
- if (!NetMapIsEmpty (&Instance->Dns4TxTokens)) {
- Dns4InstanceCancelToken (Instance, NULL);
- }
- if (!NetMapIsEmpty (&Instance->Dns6TxTokens)) {
- Dns6InstanceCancelToken (Instance, NULL);
- }
- if (Instance->UdpIo != NULL) {
- UdpIoFreeIo (Instance->UdpIo);
- }
- FreePool (Instance);
- }
- /**
- Create the DNS instance and initialize it.
- @param[in] Service The pointer to the DNS service.
- @param[out] Instance The pointer to the DNS instance.
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
- @retval EFI_SUCCESS The DNS instance is created.
- **/
- EFI_STATUS
- DnsCreateInstance (
- IN DNS_SERVICE *Service,
- OUT DNS_INSTANCE **Instance
- )
- {
- DNS_INSTANCE *DnsIns;
- *Instance = NULL;
- DnsIns = AllocateZeroPool (sizeof (DNS_INSTANCE));
- if (DnsIns == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- DnsIns->Signature = DNS_INSTANCE_SIGNATURE;
- InitializeListHead (&DnsIns->Link);
- DnsIns->State = DNS_STATE_UNCONFIGED;
- DnsIns->InDestroy = FALSE;
- DnsIns->Service = Service;
- if (Service->IpVersion == IP_VERSION_4) {
- CopyMem (&DnsIns->Dns4, &mDns4Protocol, sizeof (DnsIns->Dns4));
- NetMapInit (&DnsIns->Dns4TxTokens);
- } else {
- CopyMem (&DnsIns->Dns6, &mDns6Protocol, sizeof (DnsIns->Dns6));
- NetMapInit (&DnsIns->Dns6TxTokens);
- }
- DnsIns->UdpIo = UdpIoCreateIo (
- Service->ControllerHandle, /// NicHandle
- Service->ImageHandle,
- DnsConfigNullUdp,
- Service->IpVersion,
- DnsIns
- );
- if (DnsIns->UdpIo == NULL) {
- FreePool (DnsIns);
- return EFI_OUT_OF_RESOURCES;
- }
- *Instance = DnsIns;
- return EFI_SUCCESS;
- }
- /**
- Callback function which provided by user to remove one node in NetDestroyLinkList process.
- @param[in] Entry The entry to be removed.
- @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
- @retval EFI_SUCCESS The entry has been removed successfully.
- @retval Others Fail to remove the entry.
- **/
- EFI_STATUS
- EFIAPI
- DnsDestroyChildEntryInHandleBuffer (
- IN LIST_ENTRY *Entry,
- IN VOID *Context
- )
- {
- DNS_INSTANCE *Instance;
- EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
- UINTN NumberOfChildren;
- EFI_HANDLE *ChildHandleBuffer;
- if ((Entry == NULL) || (Context == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- Instance = NET_LIST_USER_STRUCT_S (Entry, DNS_INSTANCE, Link, DNS_INSTANCE_SIGNATURE);
- ServiceBinding = ((DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ServiceBinding;
- NumberOfChildren = ((DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->NumberOfChildren;
- ChildHandleBuffer = ((DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ChildHandleBuffer;
- if (!NetIsInHandleBuffer (Instance->ChildHandle, NumberOfChildren, ChildHandleBuffer)) {
- return EFI_SUCCESS;
- }
- return ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);
- }
- /**
- Config a NULL UDP that is used to keep the connection between UDP and DNS.
- Just leave the Udp child unconfigured. When UDP is unloaded,
- DNS will be informed with DriverBinding Stop.
- @param UdpIo The UDP_IO to configure
- @param Context The opaque parameter to the callback
- @retval EFI_SUCCESS It always return EFI_SUCCESS directly.
- **/
- EFI_STATUS
- EFIAPI
- DnsConfigNullUdp (
- IN UDP_IO *UdpIo,
- IN VOID *Context
- )
- {
- return EFI_SUCCESS;
- }
- /**
- Release all the resource used the DNS service binding instance.
- @param DnsSb The Dns service binding instance.
- **/
- VOID
- DnsDestroyService (
- IN DNS_SERVICE *DnsSb
- )
- {
- UdpIoFreeIo (DnsSb->ConnectUdp);
- if (DnsSb->TimerToGetMap != NULL) {
- gBS->CloseEvent (DnsSb->TimerToGetMap);
- }
- if (DnsSb->Timer != NULL) {
- gBS->CloseEvent (DnsSb->Timer);
- }
- FreePool (DnsSb);
- }
- /**
- Create then initialize a Dns service binding instance.
- @param Controller The controller to install the DNS service
- binding on
- @param Image The driver binding image of the DNS driver
- @param IpVersion IpVersion for this service
- @param Service The variable to receive the created service
- binding instance.
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to create the instance.
- @retval EFI_DEVICE_ERROR Failed to create a NULL UDP port to keep
- connection with UDP.
- @retval EFI_SUCCESS The service instance is created for the
- controller.
- **/
- EFI_STATUS
- DnsCreateService (
- IN EFI_HANDLE Controller,
- IN EFI_HANDLE Image,
- IN UINT8 IpVersion,
- OUT DNS_SERVICE **Service
- )
- {
- EFI_STATUS Status;
- DNS_SERVICE *DnsSb;
- Status = EFI_SUCCESS;
- DnsSb = NULL;
- *Service = NULL;
- DnsSb = AllocateZeroPool (sizeof (DNS_SERVICE));
- if (DnsSb == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- DnsSb->Signature = DNS_SERVICE_SIGNATURE;
- if (IpVersion == IP_VERSION_4) {
- DnsSb->ServiceBinding = mDns4ServiceBinding;
- } else {
- DnsSb->ServiceBinding = mDns6ServiceBinding;
- }
- DnsSb->Dns4ChildrenNum = 0;
- InitializeListHead (&DnsSb->Dns4ChildrenList);
- DnsSb->Dns6ChildrenNum = 0;
- InitializeListHead (&DnsSb->Dns6ChildrenList);
- DnsSb->ControllerHandle = Controller;
- DnsSb->ImageHandle = Image;
- DnsSb->TimerToGetMap = NULL;
- DnsSb->Timer = NULL;
- DnsSb->IpVersion = IpVersion;
- //
- // Create the timer used to time out the procedure which is used to
- // get the default IP address.
- //
- Status = gBS->CreateEvent (
- EVT_TIMER,
- TPL_CALLBACK,
- NULL,
- NULL,
- &DnsSb->TimerToGetMap
- );
- if (EFI_ERROR (Status)) {
- FreePool (DnsSb);
- return Status;
- }
- //
- // Create the timer to retransmit packets.
- //
- Status = gBS->CreateEvent (
- EVT_NOTIFY_SIGNAL | EVT_TIMER,
- TPL_CALLBACK,
- DnsOnTimerRetransmit,
- DnsSb,
- &DnsSb->Timer
- );
- if (EFI_ERROR (Status)) {
- if (DnsSb->TimerToGetMap != NULL) {
- gBS->CloseEvent (DnsSb->TimerToGetMap);
- }
- FreePool (DnsSb);
- return Status;
- }
- DnsSb->ConnectUdp = NULL;
- DnsSb->ConnectUdp = UdpIoCreateIo (
- Controller,
- Image,
- DnsConfigNullUdp,
- DnsSb->IpVersion,
- NULL
- );
- if (DnsSb->ConnectUdp == NULL) {
- if (DnsSb->TimerToGetMap != NULL) {
- gBS->CloseEvent (DnsSb->TimerToGetMap);
- }
- gBS->CloseEvent (DnsSb->Timer);
- FreePool (DnsSb);
- return EFI_DEVICE_ERROR;
- }
- *Service = DnsSb;
- return Status;
- }
- /**
- Unloads an image.
- @param ImageHandle Handle that identifies the image to be unloaded.
- @retval EFI_SUCCESS The image has been unloaded.
- @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
- **/
- EFI_STATUS
- EFIAPI
- DnsUnload (
- IN EFI_HANDLE ImageHandle
- )
- {
- EFI_STATUS Status;
- LIST_ENTRY *Entry;
- DNS4_CACHE *ItemCache4;
- DNS4_SERVER_IP *ItemServerIp4;
- DNS6_CACHE *ItemCache6;
- DNS6_SERVER_IP *ItemServerIp6;
- ItemCache4 = NULL;
- ItemServerIp4 = NULL;
- ItemCache6 = NULL;
- ItemServerIp6 = NULL;
- //
- // Disconnect the driver specified by ImageHandle
- //
- Status = NetLibDefaultUnload (ImageHandle);
- if (EFI_ERROR (Status)) {
- return Status;
- }
- //
- // Free mDriverData.
- //
- if (mDriverData != NULL) {
- if (mDriverData->Timer != NULL) {
- gBS->CloseEvent (mDriverData->Timer);
- }
- while (!IsListEmpty (&mDriverData->Dns4CacheList)) {
- Entry = NetListRemoveHead (&mDriverData->Dns4CacheList);
- ASSERT (Entry != NULL);
- ItemCache4 = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);
- FreePool (ItemCache4->DnsCache.HostName);
- FreePool (ItemCache4->DnsCache.IpAddress);
- FreePool (ItemCache4);
- }
- while (!IsListEmpty (&mDriverData->Dns4ServerList)) {
- Entry = NetListRemoveHead (&mDriverData->Dns4ServerList);
- ASSERT (Entry != NULL);
- ItemServerIp4 = NET_LIST_USER_STRUCT (Entry, DNS4_SERVER_IP, AllServerLink);
- FreePool (ItemServerIp4);
- }
- while (!IsListEmpty (&mDriverData->Dns6CacheList)) {
- Entry = NetListRemoveHead (&mDriverData->Dns6CacheList);
- ASSERT (Entry != NULL);
- ItemCache6 = NET_LIST_USER_STRUCT (Entry, DNS6_CACHE, AllCacheLink);
- FreePool (ItemCache6->DnsCache.HostName);
- FreePool (ItemCache6->DnsCache.IpAddress);
- FreePool (ItemCache6);
- }
- while (!IsListEmpty (&mDriverData->Dns6ServerList)) {
- Entry = NetListRemoveHead (&mDriverData->Dns6ServerList);
- ASSERT (Entry != NULL);
- ItemServerIp6 = NET_LIST_USER_STRUCT (Entry, DNS6_SERVER_IP, AllServerLink);
- FreePool (ItemServerIp6);
- }
- FreePool (mDriverData);
- }
- return Status;
- }
- /**
- 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 ImageHandle The firmware allocated handle for the UEFI image.
- @param SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS The operation completed successfully.
- @retval Others An unexpected error occurred.
- **/
- EFI_STATUS
- EFIAPI
- DnsDriverEntryPoint (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
- {
- EFI_STATUS Status;
- Status = EFI_SUCCESS;
- //
- // Install the Dns4 Driver Binding Protocol.
- //
- Status = EfiLibInstallDriverBindingComponentName2 (
- ImageHandle,
- SystemTable,
- &gDns4DriverBinding,
- ImageHandle,
- &gDnsComponentName,
- &gDnsComponentName2
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- //
- // Install the Dns6 Driver Binding Protocol.
- //
- Status = EfiLibInstallDriverBindingComponentName2 (
- ImageHandle,
- SystemTable,
- &gDns6DriverBinding,
- NULL,
- &gDnsComponentName,
- &gDnsComponentName2
- );
- if (EFI_ERROR (Status)) {
- goto Error1;
- }
- //
- // Create the driver data structures.
- //
- mDriverData = AllocateZeroPool (sizeof (DNS_DRIVER_DATA));
- if (mDriverData == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto Error2;
- }
- //
- // Create the timer event to update DNS cache list.
- //
- Status = gBS->CreateEvent (
- EVT_NOTIFY_SIGNAL | EVT_TIMER,
- TPL_CALLBACK,
- DnsOnTimerUpdate,
- NULL,
- &mDriverData->Timer
- );
- if (EFI_ERROR (Status)) {
- goto Error3;
- }
- Status = gBS->SetTimer (mDriverData->Timer, TimerPeriodic, TICKS_PER_SECOND);
- if (EFI_ERROR (Status)) {
- goto Error4;
- }
- InitializeListHead (&mDriverData->Dns4CacheList);
- InitializeListHead (&mDriverData->Dns4ServerList);
- InitializeListHead (&mDriverData->Dns6CacheList);
- InitializeListHead (&mDriverData->Dns6ServerList);
- return Status;
- Error4:
- gBS->CloseEvent (mDriverData->Timer);
- Error3:
- FreePool (mDriverData);
- Error2:
- EfiLibUninstallDriverBindingComponentName2 (
- &gDns6DriverBinding,
- &gDnsComponentName,
- &gDnsComponentName2
- );
- Error1:
- EfiLibUninstallDriverBindingComponentName2 (
- &gDns4DriverBinding,
- &gDnsComponentName,
- &gDnsComponentName2
- );
- return Status;
- }
- /**
- 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
- Dns4DriverBindingSupported (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- //
- // Test for the Dns4ServiceBinding Protocol.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDns4ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (!EFI_ERROR (Status)) {
- return EFI_ALREADY_STARTED;
- }
- //
- // Test for the Udp4ServiceBinding Protocol.
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiUdp4ServiceBindingProtocolGuid,
- 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 failed to start the device.
- **/
- EFI_STATUS
- EFIAPI
- Dns4DriverBindingStart (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- DNS_SERVICE *DnsSb;
- EFI_STATUS Status;
- Status = DnsCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_4, &DnsSb);
- if (EFI_ERROR (Status)) {
- return Status;
- }
- ASSERT (DnsSb != NULL);
- Status = gBS->SetTimer (DnsSb->Timer, TimerPeriodic, TICKS_PER_SECOND);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Install the Dns4ServiceBinding Protocol onto ControllerHandle.
- //
- Status = gBS->InstallMultipleProtocolInterfaces (
- &ControllerHandle,
- &gEfiDns4ServiceBindingProtocolGuid,
- &DnsSb->ServiceBinding,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- return EFI_SUCCESS;
- ON_ERROR:
- DnsDestroyService (DnsSb);
- 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
- Dns4DriverBindingStop (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
- )
- {
- EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
- DNS_SERVICE *DnsSb;
- EFI_HANDLE NicHandle;
- EFI_STATUS Status;
- LIST_ENTRY *List;
- DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context;
- //
- // DNS driver opens UDP child, So, Controller is a UDP
- // child handle. Locate the Nic handle first. Then get the
- // DNS private data back.
- //
- NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp4ProtocolGuid);
- if (NicHandle == NULL) {
- return EFI_SUCCESS;
- }
- Status = gBS->OpenProtocol (
- NicHandle,
- &gEfiDns4ServiceBindingProtocolGuid,
- (VOID **)&ServiceBinding,
- This->DriverBindingHandle,
- NicHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_DEVICE_ERROR;
- }
- DnsSb = DNS_SERVICE_FROM_THIS (ServiceBinding);
- if (!IsListEmpty (&DnsSb->Dns4ChildrenList)) {
- //
- // Destroy the Dns child instance in ChildHandleBuffer.
- //
- List = &DnsSb->Dns4ChildrenList;
- Context.ServiceBinding = ServiceBinding;
- Context.NumberOfChildren = NumberOfChildren;
- Context.ChildHandleBuffer = ChildHandleBuffer;
- Status = NetDestroyLinkList (
- List,
- DnsDestroyChildEntryInHandleBuffer,
- &Context,
- NULL
- );
- }
- if ((NumberOfChildren == 0) && IsListEmpty (&DnsSb->Dns4ChildrenList)) {
- gBS->UninstallProtocolInterface (
- NicHandle,
- &gEfiDns4ServiceBindingProtocolGuid,
- ServiceBinding
- );
- DnsDestroyService (DnsSb);
- if (gDnsControllerNameTable != NULL) {
- FreeUnicodeStringTable (gDnsControllerNameTable);
- gDnsControllerNameTable = NULL;
- }
- Status = EFI_SUCCESS;
- }
- return Status;
- }
- /**
- 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
- Dns6DriverBindingSupported (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- //
- // Test for the Dns6ServiceBinding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiDns6ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (!EFI_ERROR (Status)) {
- return EFI_ALREADY_STARTED;
- }
- //
- // Test for the Udp6ServiceBinding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiUdp6ServiceBindingProtocolGuid,
- 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 failed to start the device.
- **/
- EFI_STATUS
- EFIAPI
- Dns6DriverBindingStart (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- DNS_SERVICE *DnsSb;
- EFI_STATUS Status;
- Status = DnsCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_6, &DnsSb);
- if (EFI_ERROR (Status)) {
- return Status;
- }
- ASSERT (DnsSb != NULL);
- Status = gBS->SetTimer (DnsSb->Timer, TimerPeriodic, TICKS_PER_SECOND);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- //
- // Install the Dns6ServiceBinding Protocol onto ControllerHandle
- //
- Status = gBS->InstallMultipleProtocolInterfaces (
- &ControllerHandle,
- &gEfiDns6ServiceBindingProtocolGuid,
- &DnsSb->ServiceBinding,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- return EFI_SUCCESS;
- ON_ERROR:
- DnsDestroyService (DnsSb);
- 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
- Dns6DriverBindingStop (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
- )
- {
- EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
- DNS_SERVICE *DnsSb;
- EFI_HANDLE NicHandle;
- EFI_STATUS Status;
- LIST_ENTRY *List;
- DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context;
- //
- // DNS driver opens UDP child, So, Controller is a UDP
- // child handle. Locate the Nic handle first. Then get the
- // DNS private data back.
- //
- NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp6ProtocolGuid);
- if (NicHandle == NULL) {
- return EFI_SUCCESS;
- }
- Status = gBS->OpenProtocol (
- NicHandle,
- &gEfiDns6ServiceBindingProtocolGuid,
- (VOID **)&ServiceBinding,
- This->DriverBindingHandle,
- NicHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_DEVICE_ERROR;
- }
- DnsSb = DNS_SERVICE_FROM_THIS (ServiceBinding);
- if (!IsListEmpty (&DnsSb->Dns6ChildrenList)) {
- //
- // Destroy the Dns child instance in ChildHandleBuffer.
- //
- List = &DnsSb->Dns6ChildrenList;
- Context.ServiceBinding = ServiceBinding;
- Context.NumberOfChildren = NumberOfChildren;
- Context.ChildHandleBuffer = ChildHandleBuffer;
- Status = NetDestroyLinkList (
- List,
- DnsDestroyChildEntryInHandleBuffer,
- &Context,
- NULL
- );
- }
- if ((NumberOfChildren == 0) && IsListEmpty (&DnsSb->Dns6ChildrenList)) {
- gBS->UninstallProtocolInterface (
- NicHandle,
- &gEfiDns6ServiceBindingProtocolGuid,
- ServiceBinding
- );
- DnsDestroyService (DnsSb);
- if (gDnsControllerNameTable != NULL) {
- FreeUnicodeStringTable (gDnsControllerNameTable);
- gDnsControllerNameTable = NULL;
- }
- Status = EFI_SUCCESS;
- }
- return Status;
- }
- /**
- Creates a child handle and installs a protocol.
- The CreateChild() function installs a protocol on ChildHandle.
- If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
- If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
- @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
- @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL,
- then a new handle is created. If it is a pointer to an existing UEFI handle,
- then the protocol is added to the existing UEFI handle.
- @retval EFI_SUCCESS The protocol was added to ChildHandle.
- @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
- the child
- @retval other The child handle was not created
- **/
- EFI_STATUS
- EFIAPI
- Dns4ServiceBindingCreateChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN EFI_HANDLE *ChildHandle
- )
- {
- DNS_SERVICE *DnsSb;
- DNS_INSTANCE *Instance;
- EFI_STATUS Status;
- EFI_TPL OldTpl;
- VOID *Udp4;
- if ((This == NULL) || (ChildHandle == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- DnsSb = DNS_SERVICE_FROM_THIS (This);
- Status = DnsCreateInstance (DnsSb, &Instance);
- if (EFI_ERROR (Status)) {
- return Status;
- }
- ASSERT (Instance != NULL);
- //
- // Install the DNS protocol onto ChildHandle
- //
- Status = gBS->InstallMultipleProtocolInterfaces (
- ChildHandle,
- &gEfiDns4ProtocolGuid,
- &Instance->Dns4,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Instance->ChildHandle = *ChildHandle;
- //
- // Open the Udp4 protocol BY_CHILD.
- //
- Status = gBS->OpenProtocol (
- DnsSb->ConnectUdp->UdpHandle,
- &gEfiUdp4ProtocolGuid,
- (VOID **)&Udp4,
- gDns4DriverBinding.DriverBindingHandle,
- Instance->ChildHandle,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- gBS->UninstallMultipleProtocolInterfaces (
- Instance->ChildHandle,
- &gEfiDns4ProtocolGuid,
- &Instance->Dns4,
- NULL
- );
- goto ON_ERROR;
- }
- //
- // Open the Udp4 protocol by child.
- //
- Status = gBS->OpenProtocol (
- Instance->UdpIo->UdpHandle,
- &gEfiUdp4ProtocolGuid,
- (VOID **)&Udp4,
- gDns4DriverBinding.DriverBindingHandle,
- Instance->ChildHandle,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- //
- // Close the Udp4 protocol.
- //
- gBS->CloseProtocol (
- DnsSb->ConnectUdp->UdpHandle,
- &gEfiUdp4ProtocolGuid,
- gDns4DriverBinding.DriverBindingHandle,
- *ChildHandle
- );
- gBS->UninstallMultipleProtocolInterfaces (
- Instance->ChildHandle,
- &gEfiDns4ProtocolGuid,
- &Instance->Dns4,
- NULL
- );
- goto ON_ERROR;
- }
- //
- // Add it to the parent's child list.
- //
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- InsertTailList (&DnsSb->Dns4ChildrenList, &Instance->Link);
- DnsSb->Dns4ChildrenNum++;
- gBS->RestoreTPL (OldTpl);
- return EFI_SUCCESS;
- ON_ERROR:
- DnsDestroyInstance (Instance);
- return Status;
- }
- /**
- Destroys a child handle with a protocol installed on it.
- The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
- that was installed by CreateChild() from ChildHandle. If the removed protocol is the
- last protocol on ChildHandle, then ChildHandle is destroyed.
- @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
- @param[in] ChildHandle Handle of the child to destroy
- @retval EFI_SUCCESS The protocol was removed from ChildHandle.
- @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
- @retval EFI_INVALID_PARAMETER Child handle is NULL.
- @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
- because its services are being used.
- @retval other The child handle was not destroyed
- **/
- EFI_STATUS
- EFIAPI
- Dns4ServiceBindingDestroyChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ChildHandle
- )
- {
- DNS_SERVICE *DnsSb;
- DNS_INSTANCE *Instance;
- EFI_DNS4_PROTOCOL *Dns4;
- EFI_STATUS Status;
- EFI_TPL OldTpl;
- if ((This == NULL) || (ChildHandle == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- //
- // Retrieve the private context data structures
- //
- Status = gBS->OpenProtocol (
- ChildHandle,
- &gEfiDns4ProtocolGuid,
- (VOID **)&Dns4,
- gDns4DriverBinding.DriverBindingHandle,
- ChildHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_UNSUPPORTED;
- }
- Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (Dns4);
- DnsSb = DNS_SERVICE_FROM_THIS (This);
- if (Instance->Service != DnsSb) {
- return EFI_INVALID_PARAMETER;
- }
- if (Instance->InDestroy) {
- return EFI_SUCCESS;
- }
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- Instance->InDestroy = TRUE;
- //
- // Close the Udp4 protocol.
- //
- gBS->CloseProtocol (
- DnsSb->ConnectUdp->UdpHandle,
- &gEfiUdp4ProtocolGuid,
- gDns4DriverBinding.DriverBindingHandle,
- ChildHandle
- );
- gBS->CloseProtocol (
- Instance->UdpIo->UdpHandle,
- &gEfiUdp4ProtocolGuid,
- gDns4DriverBinding.DriverBindingHandle,
- ChildHandle
- );
- gBS->RestoreTPL (OldTpl);
- //
- // Uninstall the DNS protocol first to enable a top down destruction.
- //
- Status = gBS->UninstallProtocolInterface (
- ChildHandle,
- &gEfiDns4ProtocolGuid,
- Dns4
- );
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- if (EFI_ERROR (Status)) {
- Instance->InDestroy = FALSE;
- gBS->RestoreTPL (OldTpl);
- return Status;
- }
- RemoveEntryList (&Instance->Link);
- DnsSb->Dns4ChildrenNum--;
- gBS->RestoreTPL (OldTpl);
- DnsDestroyInstance (Instance);
- return EFI_SUCCESS;
- }
- /**
- Creates a child handle and installs a protocol.
- The CreateChild() function installs a protocol on ChildHandle.
- If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
- If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
- @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
- @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL,
- then a new handle is created. If it is a pointer to an existing UEFI handle,
- then the protocol is added to the existing UEFI handle.
- @retval EFI_SUCCESS The protocol was added to ChildHandle.
- @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
- the child
- @retval other The child handle was not created
- **/
- EFI_STATUS
- EFIAPI
- Dns6ServiceBindingCreateChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN EFI_HANDLE *ChildHandle
- )
- {
- DNS_SERVICE *DnsSb;
- DNS_INSTANCE *Instance;
- EFI_STATUS Status;
- EFI_TPL OldTpl;
- VOID *Udp6;
- if ((This == NULL) || (ChildHandle == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- DnsSb = DNS_SERVICE_FROM_THIS (This);
- Status = DnsCreateInstance (DnsSb, &Instance);
- if (EFI_ERROR (Status)) {
- return Status;
- }
- ASSERT (Instance != NULL);
- //
- // Install the DNS protocol onto ChildHandle
- //
- Status = gBS->InstallMultipleProtocolInterfaces (
- ChildHandle,
- &gEfiDns6ProtocolGuid,
- &Instance->Dns6,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Instance->ChildHandle = *ChildHandle;
- //
- // Open the Udp6 protocol BY_CHILD.
- //
- Status = gBS->OpenProtocol (
- DnsSb->ConnectUdp->UdpHandle,
- &gEfiUdp6ProtocolGuid,
- (VOID **)&Udp6,
- gDns6DriverBinding.DriverBindingHandle,
- Instance->ChildHandle,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- gBS->UninstallMultipleProtocolInterfaces (
- Instance->ChildHandle,
- &gEfiDns6ProtocolGuid,
- &Instance->Dns6,
- NULL
- );
- goto ON_ERROR;
- }
- //
- // Open the Udp6 protocol by child.
- //
- Status = gBS->OpenProtocol (
- Instance->UdpIo->UdpHandle,
- &gEfiUdp6ProtocolGuid,
- (VOID **)&Udp6,
- gDns6DriverBinding.DriverBindingHandle,
- Instance->ChildHandle,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- //
- // Close the Udp6 protocol.
- //
- gBS->CloseProtocol (
- DnsSb->ConnectUdp->UdpHandle,
- &gEfiUdp6ProtocolGuid,
- gDns6DriverBinding.DriverBindingHandle,
- *ChildHandle
- );
- gBS->UninstallMultipleProtocolInterfaces (
- Instance->ChildHandle,
- &gEfiDns6ProtocolGuid,
- &Instance->Dns6,
- NULL
- );
- goto ON_ERROR;
- }
- //
- // Add it to the parent's child list.
- //
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- InsertTailList (&DnsSb->Dns6ChildrenList, &Instance->Link);
- DnsSb->Dns6ChildrenNum++;
- gBS->RestoreTPL (OldTpl);
- return EFI_SUCCESS;
- ON_ERROR:
- DnsDestroyInstance (Instance);
- return Status;
- }
- /**
- Destroys a child handle with a protocol installed on it.
- The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
- that was installed by CreateChild() from ChildHandle. If the removed protocol is the
- last protocol on ChildHandle, then ChildHandle is destroyed.
- @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
- @param[in] ChildHandle Handle of the child to destroy
- @retval EFI_SUCCESS The protocol was removed from ChildHandle.
- @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
- @retval EFI_INVALID_PARAMETER Child handle is NULL.
- @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
- because its services are being used.
- @retval other The child handle was not destroyed
- **/
- EFI_STATUS
- EFIAPI
- Dns6ServiceBindingDestroyChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ChildHandle
- )
- {
- DNS_SERVICE *DnsSb;
- DNS_INSTANCE *Instance;
- EFI_DNS6_PROTOCOL *Dns6;
- EFI_STATUS Status;
- EFI_TPL OldTpl;
- if ((This == NULL) || (ChildHandle == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- //
- // Retrieve the private context data structures
- //
- Status = gBS->OpenProtocol (
- ChildHandle,
- &gEfiDns6ProtocolGuid,
- (VOID **)&Dns6,
- gDns6DriverBinding.DriverBindingHandle,
- ChildHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_UNSUPPORTED;
- }
- Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (Dns6);
- DnsSb = DNS_SERVICE_FROM_THIS (This);
- if (Instance->Service != DnsSb) {
- return EFI_INVALID_PARAMETER;
- }
- if (Instance->InDestroy) {
- return EFI_SUCCESS;
- }
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- Instance->InDestroy = TRUE;
- //
- // Close the Udp6 protocol.
- //
- gBS->CloseProtocol (
- DnsSb->ConnectUdp->UdpHandle,
- &gEfiUdp6ProtocolGuid,
- gDns6DriverBinding.DriverBindingHandle,
- ChildHandle
- );
- gBS->CloseProtocol (
- Instance->UdpIo->UdpHandle,
- &gEfiUdp6ProtocolGuid,
- gDns6DriverBinding.DriverBindingHandle,
- ChildHandle
- );
- gBS->RestoreTPL (OldTpl);
- //
- // Uninstall the DNS protocol first to enable a top down destruction.
- //
- Status = gBS->UninstallProtocolInterface (
- ChildHandle,
- &gEfiDns6ProtocolGuid,
- Dns6
- );
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- if (EFI_ERROR (Status)) {
- Instance->InDestroy = FALSE;
- gBS->RestoreTPL (OldTpl);
- return Status;
- }
- RemoveEntryList (&Instance->Link);
- DnsSb->Dns6ChildrenNum--;
- gBS->RestoreTPL (OldTpl);
- DnsDestroyInstance (Instance);
- return EFI_SUCCESS;
- }
|