123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990 |
- /** @file
- The driver binding and service binding protocol for the TCP driver.
- Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include "TcpMain.h"
- UINT16 mTcp4RandomPort;
- UINT16 mTcp6RandomPort;
- TCP_HEARTBEAT_TIMER mTcpTimer = {
- NULL,
- 0
- };
- EFI_TCP4_PROTOCOL gTcp4ProtocolTemplate = {
- Tcp4GetModeData,
- Tcp4Configure,
- Tcp4Routes,
- Tcp4Connect,
- Tcp4Accept,
- Tcp4Transmit,
- Tcp4Receive,
- Tcp4Close,
- Tcp4Cancel,
- Tcp4Poll
- };
- EFI_TCP6_PROTOCOL gTcp6ProtocolTemplate = {
- Tcp6GetModeData,
- Tcp6Configure,
- Tcp6Connect,
- Tcp6Accept,
- Tcp6Transmit,
- Tcp6Receive,
- Tcp6Close,
- Tcp6Cancel,
- Tcp6Poll
- };
- SOCK_INIT_DATA mTcpDefaultSockData = {
- SockStream,
- SO_CLOSED,
- NULL,
- TCP_BACKLOG,
- TCP_SND_BUF_SIZE,
- TCP_RCV_BUF_SIZE,
- IP_VERSION_4,
- NULL,
- TcpCreateSocketCallback,
- TcpDestroySocketCallback,
- NULL,
- NULL,
- 0,
- TcpDispatcher,
- NULL,
- };
- EFI_DRIVER_BINDING_PROTOCOL gTcp4DriverBinding = {
- Tcp4DriverBindingSupported,
- Tcp4DriverBindingStart,
- Tcp4DriverBindingStop,
- 0xa,
- NULL,
- NULL
- };
- EFI_DRIVER_BINDING_PROTOCOL gTcp6DriverBinding = {
- Tcp6DriverBindingSupported,
- Tcp6DriverBindingStart,
- Tcp6DriverBindingStop,
- 0xa,
- NULL,
- NULL
- };
- EFI_SERVICE_BINDING_PROTOCOL gTcpServiceBinding = {
- TcpServiceBindingCreateChild,
- TcpServiceBindingDestroyChild
- };
- /**
- Create and start the heartbeat timer for the TCP driver.
- @retval EFI_SUCCESS The timer was successfully created and started.
- @retval other The timer was not created.
- **/
- EFI_STATUS
- TcpCreateTimer (
- VOID
- )
- {
- EFI_STATUS Status;
- Status = EFI_SUCCESS;
- if (mTcpTimer.RefCnt == 0) {
- Status = gBS->CreateEvent (
- EVT_TIMER | EVT_NOTIFY_SIGNAL,
- TPL_NOTIFY,
- TcpTicking,
- NULL,
- &mTcpTimer.TimerEvent
- );
- if (!EFI_ERROR (Status)) {
- Status = gBS->SetTimer (
- mTcpTimer.TimerEvent,
- TimerPeriodic,
- (UINT64)(TICKS_PER_SECOND / TCP_TICK_HZ)
- );
- }
- }
- if (!EFI_ERROR (Status)) {
- mTcpTimer.RefCnt++;
- }
- return Status;
- }
- /**
- Stop and destroy the heartbeat timer for TCP driver.
- **/
- VOID
- TcpDestroyTimer (
- VOID
- )
- {
- ASSERT (mTcpTimer.RefCnt > 0);
- mTcpTimer.RefCnt--;
- if (mTcpTimer.RefCnt > 0) {
- return;
- }
- gBS->SetTimer (mTcpTimer.TimerEvent, TimerCancel, 0);
- gBS->CloseEvent (mTcpTimer.TimerEvent);
- mTcpTimer.TimerEvent = NULL;
- }
- /**
- The entry point for Tcp driver, which is used to install Tcp driver on the ImageHandle.
- @param[in] ImageHandle The firmware allocated handle for this driver image.
- @param[in] SystemTable Pointer to the EFI system table.
- @retval EFI_SUCCESS The driver loaded.
- @retval other The driver did not load.
- **/
- EFI_STATUS
- EFIAPI
- TcpDriverEntryPoint (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
- {
- EFI_STATUS Status;
- UINT32 Seed;
- //
- // Install the TCP Driver Binding Protocol
- //
- Status = EfiLibInstallDriverBindingComponentName2 (
- ImageHandle,
- SystemTable,
- &gTcp4DriverBinding,
- ImageHandle,
- &gTcpComponentName,
- &gTcpComponentName2
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- //
- // Install the TCP Driver Binding Protocol
- //
- Status = EfiLibInstallDriverBindingComponentName2 (
- ImageHandle,
- SystemTable,
- &gTcp6DriverBinding,
- NULL,
- &gTcpComponentName,
- &gTcpComponentName2
- );
- if (EFI_ERROR (Status)) {
- EfiLibUninstallDriverBindingComponentName2 (
- &gTcp4DriverBinding,
- &gTcpComponentName,
- &gTcpComponentName2
- );
- return Status;
- }
- //
- // Initialize ISS and random port.
- //
- Seed = NetRandomInitSeed ();
- mTcpGlobalIss = NET_RANDOM (Seed) % mTcpGlobalIss;
- mTcp4RandomPort = (UINT16)(TCP_PORT_KNOWN + (NET_RANDOM (Seed) % TCP_PORT_KNOWN));
- mTcp6RandomPort = mTcp4RandomPort;
- return EFI_SUCCESS;
- }
- /**
- Create a new TCP4 or TCP6 driver service binding protocol
- @param[in] Controller Controller handle of device to bind driver to.
- @param[in] Image The TCP driver's image handle.
- @param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.
- @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
- @retval EFI_SUCCESS A new IP6 service binding private was created.
- **/
- EFI_STATUS
- TcpCreateService (
- IN EFI_HANDLE Controller,
- IN EFI_HANDLE Image,
- IN UINT8 IpVersion
- )
- {
- EFI_STATUS Status;
- EFI_GUID *IpServiceBindingGuid;
- EFI_GUID *TcpServiceBindingGuid;
- TCP_SERVICE_DATA *TcpServiceData;
- IP_IO_OPEN_DATA OpenData;
- if (IpVersion == IP_VERSION_4) {
- IpServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid;
- TcpServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid;
- } else {
- IpServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid;
- TcpServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid;
- }
- Status = gBS->OpenProtocol (
- Controller,
- TcpServiceBindingGuid,
- NULL,
- Image,
- Controller,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (!EFI_ERROR (Status)) {
- return EFI_ALREADY_STARTED;
- }
- Status = gBS->OpenProtocol (
- Controller,
- IpServiceBindingGuid,
- NULL,
- Image,
- Controller,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_UNSUPPORTED;
- }
- //
- // Create the TCP service data.
- //
- TcpServiceData = AllocateZeroPool (sizeof (TCP_SERVICE_DATA));
- if (TcpServiceData == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- TcpServiceData->Signature = TCP_DRIVER_SIGNATURE;
- TcpServiceData->ControllerHandle = Controller;
- TcpServiceData->DriverBindingHandle = Image;
- TcpServiceData->IpVersion = IpVersion;
- CopyMem (
- &TcpServiceData->ServiceBinding,
- &gTcpServiceBinding,
- sizeof (EFI_SERVICE_BINDING_PROTOCOL)
- );
- TcpServiceData->IpIo = IpIoCreate (Image, Controller, IpVersion);
- if (TcpServiceData->IpIo == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- InitializeListHead (&TcpServiceData->SocketList);
- ZeroMem (&OpenData, sizeof (IP_IO_OPEN_DATA));
- if (IpVersion == IP_VERSION_4) {
- CopyMem (
- &OpenData.IpConfigData.Ip4CfgData,
- &mIp4IoDefaultIpConfigData,
- sizeof (EFI_IP4_CONFIG_DATA)
- );
- OpenData.IpConfigData.Ip4CfgData.DefaultProtocol = EFI_IP_PROTO_TCP;
- } else {
- CopyMem (
- &OpenData.IpConfigData.Ip6CfgData,
- &mIp6IoDefaultIpConfigData,
- sizeof (EFI_IP6_CONFIG_DATA)
- );
- OpenData.IpConfigData.Ip6CfgData.DefaultProtocol = EFI_IP_PROTO_TCP;
- }
- OpenData.PktRcvdNotify = TcpRxCallback;
- Status = IpIoOpen (TcpServiceData->IpIo, &OpenData);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = TcpCreateTimer ();
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = gBS->InstallMultipleProtocolInterfaces (
- &Controller,
- TcpServiceBindingGuid,
- &TcpServiceData->ServiceBinding,
- NULL
- );
- if (EFI_ERROR (Status)) {
- TcpDestroyTimer ();
- goto ON_ERROR;
- }
- return EFI_SUCCESS;
- ON_ERROR:
- if (TcpServiceData->IpIo != NULL) {
- IpIoDestroy (TcpServiceData->IpIo);
- TcpServiceData->IpIo = NULL;
- }
- FreePool (TcpServiceData);
- return Status;
- }
- /**
- 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
- TcpDestroyChildEntryInHandleBuffer (
- IN LIST_ENTRY *Entry,
- IN VOID *Context
- )
- {
- SOCKET *Sock;
- EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
- UINTN NumberOfChildren;
- EFI_HANDLE *ChildHandleBuffer;
- if ((Entry == NULL) || (Context == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- Sock = NET_LIST_USER_STRUCT_S (Entry, SOCKET, Link, SOCK_SIGNATURE);
- ServiceBinding = ((TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ServiceBinding;
- NumberOfChildren = ((TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->NumberOfChildren;
- ChildHandleBuffer = ((TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ChildHandleBuffer;
- if (!NetIsInHandleBuffer (Sock->SockHandle, NumberOfChildren, ChildHandleBuffer)) {
- return EFI_SUCCESS;
- }
- return ServiceBinding->DestroyChild (ServiceBinding, Sock->SockHandle);
- }
- /**
- Destroy a TCP6 or TCP4 service binding instance. It will release all
- the resources allocated by the instance.
- @param[in] Controller Controller handle of device to bind driver to.
- @param[in] ImageHandle The TCP driver's image handle.
- @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number
- of children is zero stop the entire bus driver.
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
- if NumberOfChildren is 0.
- @param[in] IpVersion IP_VERSION_4 or IP_VERSION_6
- @retval EFI_SUCCESS The resources used by the instance were cleaned up.
- @retval Others Failed to clean up some of the resources.
- **/
- EFI_STATUS
- TcpDestroyService (
- IN EFI_HANDLE Controller,
- IN EFI_HANDLE ImageHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer OPTIONAL,
- IN UINT8 IpVersion
- )
- {
- EFI_HANDLE NicHandle;
- EFI_GUID *IpProtocolGuid;
- EFI_GUID *ServiceBindingGuid;
- EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
- TCP_SERVICE_DATA *TcpServiceData;
- EFI_STATUS Status;
- LIST_ENTRY *List;
- TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context;
- ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));
- if (IpVersion == IP_VERSION_4) {
- IpProtocolGuid = &gEfiIp4ProtocolGuid;
- ServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid;
- } else {
- IpProtocolGuid = &gEfiIp6ProtocolGuid;
- ServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid;
- }
- NicHandle = NetLibGetNicHandle (Controller, IpProtocolGuid);
- if (NicHandle == NULL) {
- return EFI_SUCCESS;
- }
- Status = gBS->OpenProtocol (
- NicHandle,
- ServiceBindingGuid,
- (VOID **)&ServiceBinding,
- ImageHandle,
- Controller,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_DEVICE_ERROR;
- }
- TcpServiceData = TCP_SERVICE_FROM_THIS (ServiceBinding);
- if (NumberOfChildren != 0) {
- List = &TcpServiceData->SocketList;
- Context.ServiceBinding = ServiceBinding;
- Context.NumberOfChildren = NumberOfChildren;
- Context.ChildHandleBuffer = ChildHandleBuffer;
- Status = NetDestroyLinkList (
- List,
- TcpDestroyChildEntryInHandleBuffer,
- &Context,
- NULL
- );
- } else if (IsListEmpty (&TcpServiceData->SocketList)) {
- //
- // Uninstall TCP servicebinding protocol
- //
- gBS->UninstallMultipleProtocolInterfaces (
- NicHandle,
- ServiceBindingGuid,
- ServiceBinding,
- NULL
- );
- //
- // Destroy the IpIO consumed by TCP driver
- //
- IpIoDestroy (TcpServiceData->IpIo);
- TcpServiceData->IpIo = NULL;
- //
- // Destroy the heartbeat timer.
- //
- TcpDestroyTimer ();
- //
- // Release the TCP service data
- //
- FreePool (TcpServiceData);
- Status = EFI_SUCCESS;
- }
- return Status;
- }
- /**
- Test to see if this driver supports ControllerHandle.
- @param[in] This Protocol instance pointer.
- @param[in] ControllerHandle Handle of device to test.
- @param[in] RemainingDevicePath Optional parameter use to pick a specific
- child device to start.
- @retval EFI_SUCCESS This driver supports this device.
- @retval EFI_ALREADY_STARTED This driver is already running on this device.
- @retval other This driver does not support this device.
- **/
- EFI_STATUS
- EFIAPI
- Tcp4DriverBindingSupported (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- //
- // Test for the Tcp4ServiceBinding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiTcp4ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (!EFI_ERROR (Status)) {
- return EFI_ALREADY_STARTED;
- }
- //
- // Test for the Ip4ServiceBinding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiIp4ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- return Status;
- }
- /**
- Start this driver on ControllerHandle.
- @param[in] This Protocol instance pointer.
- @param[in] ControllerHandle Handle of device to bind driver to.
- @param[in] RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
- @retval EFI_SUCCESS The driver is added to ControllerHandle.
- @retval EFI_OUT_OF_RESOURCES There are not enough resources to start the
- driver.
- @retval other The driver cannot be added to ControllerHandle.
- **/
- EFI_STATUS
- EFIAPI
- Tcp4DriverBindingStart (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- Status = TcpCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_4);
- if ((Status == EFI_ALREADY_STARTED) || (Status == EFI_UNSUPPORTED)) {
- Status = EFI_SUCCESS;
- }
- return Status;
- }
- /**
- Stop this driver on ControllerHandle.
- @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
- Tcp4DriverBindingStop (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
- )
- {
- return TcpDestroyService (
- ControllerHandle,
- This->DriverBindingHandle,
- NumberOfChildren,
- ChildHandleBuffer,
- IP_VERSION_4
- );
- }
- /**
- Test to see if this driver supports ControllerHandle.
- @param[in] This Protocol instance pointer.
- @param[in] ControllerHandle Handle of device to test.
- @param[in] RemainingDevicePath Optional parameter use to pick a specific
- child device to start.
- @retval EFI_SUCCESS This driver supports this device.
- @retval EFI_ALREADY_STARTED This driver is already running on this device.
- @retval other This driver does not support this device.
- **/
- EFI_STATUS
- EFIAPI
- Tcp6DriverBindingSupported (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- //
- // Test for the Tcp6ServiceBinding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiTcp6ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (!EFI_ERROR (Status)) {
- return EFI_ALREADY_STARTED;
- }
- //
- // Test for the Ip6ServiceBinding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiIp6ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- return Status;
- }
- /**
- Start this driver on ControllerHandle.
- @param[in] This Protocol instance pointer.
- @param[in] ControllerHandle Handle of device to bind driver to.
- @param[in] RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
- @retval EFI_SUCCESS The driver is added to ControllerHandle.
- @retval EFI_OUT_OF_RESOURCES There are not enough resources to start the
- driver.
- @retval other The driver cannot be added to ControllerHandle.
- **/
- EFI_STATUS
- EFIAPI
- Tcp6DriverBindingStart (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- Status = TcpCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_6);
- if ((Status == EFI_ALREADY_STARTED) || (Status == EFI_UNSUPPORTED)) {
- Status = EFI_SUCCESS;
- }
- return Status;
- }
- /**
- Stop this driver on ControllerHandle.
- @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
- Tcp6DriverBindingStop (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
- )
- {
- return TcpDestroyService (
- ControllerHandle,
- This->DriverBindingHandle,
- NumberOfChildren,
- ChildHandleBuffer,
- IP_VERSION_6
- );
- }
- /**
- The Callback function called after the TCP socket was created.
- @param[in] This Pointer to the socket just created
- @param[in] Context Context of the socket
- @retval EFI_SUCCESS This protocol installed successfully.
- @retval other An error occurred.
- **/
- EFI_STATUS
- TcpCreateSocketCallback (
- IN SOCKET *This,
- IN VOID *Context
- )
- {
- EFI_STATUS Status;
- TCP_SERVICE_DATA *TcpServiceData;
- EFI_GUID *IpProtocolGuid;
- VOID *Ip;
- if (This->IpVersion == IP_VERSION_4) {
- IpProtocolGuid = &gEfiIp4ProtocolGuid;
- } else {
- IpProtocolGuid = &gEfiIp6ProtocolGuid;
- }
- TcpServiceData = ((TCP_PROTO_DATA *)This->ProtoReserved)->TcpService;
- //
- // Open the default IP protocol of IP_IO BY_DRIVER.
- //
- Status = gBS->OpenProtocol (
- TcpServiceData->IpIo->ChildHandle,
- IpProtocolGuid,
- &Ip,
- TcpServiceData->DriverBindingHandle,
- This->SockHandle,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- //
- // Open the device path on the handle where service binding resides on.
- //
- Status = gBS->OpenProtocol (
- TcpServiceData->ControllerHandle,
- &gEfiDevicePathProtocolGuid,
- (VOID **)&This->ParentDevicePath,
- TcpServiceData->DriverBindingHandle,
- This->SockHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- gBS->CloseProtocol (
- TcpServiceData->IpIo->ChildHandle,
- IpProtocolGuid,
- TcpServiceData->DriverBindingHandle,
- This->SockHandle
- );
- } else {
- //
- // Insert this socket into the SocketList.
- //
- InsertTailList (&TcpServiceData->SocketList, &This->Link);
- }
- return Status;
- }
- /**
- The callback function called before the TCP socket was to be destroyed.
- @param[in] This The TCP socket to be destroyed.
- @param[in] Context The context of the socket.
- **/
- VOID
- TcpDestroySocketCallback (
- IN SOCKET *This,
- IN VOID *Context
- )
- {
- TCP_SERVICE_DATA *TcpServiceData;
- EFI_GUID *IpProtocolGuid;
- if (This->IpVersion == IP_VERSION_4) {
- IpProtocolGuid = &gEfiIp4ProtocolGuid;
- } else {
- IpProtocolGuid = &gEfiIp6ProtocolGuid;
- }
- TcpServiceData = ((TCP_PROTO_DATA *)This->ProtoReserved)->TcpService;
- //
- // Remove this node from the list.
- //
- RemoveEntryList (&This->Link);
- //
- // Close the IP protocol.
- //
- gBS->CloseProtocol (
- TcpServiceData->IpIo->ChildHandle,
- IpProtocolGuid,
- TcpServiceData->DriverBindingHandle,
- This->SockHandle
- );
- }
- /**
- Creates a child handle with a set of TCP services.
- 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, out] 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
- TcpServiceBindingCreateChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN OUT EFI_HANDLE *ChildHandle
- )
- {
- SOCKET *Sock;
- TCP_SERVICE_DATA *TcpServiceData;
- TCP_PROTO_DATA TcpProto;
- EFI_STATUS Status;
- EFI_TPL OldTpl;
- if ((NULL == This) || (NULL == ChildHandle)) {
- return EFI_INVALID_PARAMETER;
- }
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- Status = EFI_SUCCESS;
- TcpServiceData = TCP_SERVICE_FROM_THIS (This);
- TcpProto.TcpService = TcpServiceData;
- TcpProto.TcpPcb = NULL;
- //
- // Create a tcp instance with default Tcp default
- // sock init data and TcpProto
- //
- mTcpDefaultSockData.ProtoData = &TcpProto;
- mTcpDefaultSockData.DataSize = sizeof (TCP_PROTO_DATA);
- mTcpDefaultSockData.DriverBinding = TcpServiceData->DriverBindingHandle;
- mTcpDefaultSockData.IpVersion = TcpServiceData->IpVersion;
- if (TcpServiceData->IpVersion == IP_VERSION_4) {
- mTcpDefaultSockData.Protocol = &gTcp4ProtocolTemplate;
- } else {
- mTcpDefaultSockData.Protocol = &gTcp6ProtocolTemplate;
- }
- Sock = SockCreateChild (&mTcpDefaultSockData);
- if (NULL == Sock) {
- DEBUG (
- (DEBUG_ERROR,
- "TcpDriverBindingCreateChild: No resource to create a Tcp Child\n")
- );
- Status = EFI_OUT_OF_RESOURCES;
- } else {
- *ChildHandle = Sock->SockHandle;
- }
- mTcpDefaultSockData.ProtoData = NULL;
- gBS->RestoreTPL (OldTpl);
- return Status;
- }
- /**
- Destroys a child handle with a set of TCP services.
- 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 This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
- @param ChildHandle Handle of the child to be destroyed.
- @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
- TcpServiceBindingDestroyChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ChildHandle
- )
- {
- EFI_STATUS Status;
- VOID *Tcp;
- SOCKET *Sock;
- if ((NULL == This) || (NULL == ChildHandle)) {
- return EFI_INVALID_PARAMETER;
- }
- //
- // retrieve the Tcp4 protocol from ChildHandle
- //
- Status = gBS->OpenProtocol (
- ChildHandle,
- &gEfiTcp4ProtocolGuid,
- &Tcp,
- gTcp4DriverBinding.DriverBindingHandle,
- ChildHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- //
- // No Tcp4, try the Tcp6 protocol
- //
- Status = gBS->OpenProtocol (
- ChildHandle,
- &gEfiTcp6ProtocolGuid,
- &Tcp,
- gTcp6DriverBinding.DriverBindingHandle,
- ChildHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- Status = EFI_UNSUPPORTED;
- }
- }
- if (!EFI_ERROR (Status)) {
- //
- // destroy this sock and related Tcp protocol control
- // block
- //
- Sock = SOCK_FROM_THIS (Tcp);
- SockDestroyChild (Sock);
- }
- return Status;
- }
|