[mirror_edk2.git] / MdeModulePkg / Universal / Network / Mtftp4Dxe / Mtftp4Driver.c

/** @file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  Mtftp4Driver.c\r
\r
Abstract:\r
\r
\r
**/\r
\r
#include "Mtftp4Impl.h"\r
\r
EFI_DRIVER_BINDING_PROTOCOL   gMtftp4DriverBinding = {\r
  Mtftp4DriverBindingSupported,\r
  Mtftp4DriverBindingStart,\r
  Mtftp4DriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_SERVICE_BINDING_PROTOCOL  gMtftp4ServiceBindingTemplete = {\r
  Mtftp4ServiceBindingCreateChild,\r
  Mtftp4ServiceBindingDestroyChild\r
};\r
\r
EFI_STATUS\r
EFIAPI\r
Mtftp4DriverEntryPoint (\r
  IN EFI_HANDLE             ImageHandle,\r
  IN EFI_SYSTEM_TABLE       *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The driver entry point which installs multiple protocols to the ImageHandle.\r
\r
Arguments:\r
\r
  ImageHandle - The MTFTP's image handle\r
  SystemTable - The system table\r
\r
Returns:\r
\r
  EFI_SUCCESS - The handles are successfully installed on the image. Otherwise\r
  some EFI_ERROR.\r
\r
--*/\r
{\r
  return NetLibInstallAllDriverProtocols (\r
           ImageHandle,\r
           SystemTable,\r
           &gMtftp4DriverBinding,\r
           ImageHandle,\r
           &gMtftp4ComponentName,\r
           NULL,\r
           NULL\r
           );\r
}\r
\r
\r
/**\r
  Test whether MTFTP driver support this controller.\r
\r
  @param  This                   The MTFTP driver binding instance\r
  @param  Controller             The controller to test\r
  @param  RemainingDevicePath    The remaining device path\r
\r
  @retval EFI_SUCCESS            The controller has UDP service binding protocol\r
                                 installed, MTFTP can support it.\r
  @retval Others                 MTFTP can't support the controller.\r
\r
**/\r
EFI_STATUS\r
Mtftp4DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiUdp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Config a NULL UDP that is used to keep the connection between UDP\r
  and MTFTP. Just leave the Udp child unconfigured. When UDP is\r
  unloaded, MTFTP will be informed with DriverBinding Stop.\r
\r
  @param  UdpIo                  The UDP port to configure\r
  @param  Context                The opaque parameter to the callback\r
\r
  @retval EFI_SUCCESS            It always return EFI_SUCCESS directly.\r
\r
**/\r
EFI_STATUS\r
Mtftp4ConfigNullUdp (\r
  IN UDP_IO_PORT            *UdpIo,\r
  IN VOID                   *Context\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Create then initialize a MTFTP service binding instance.\r
\r
  @param  Controller             The controller to install the MTFTP service\r
                                 binding on\r
  @param  Image                  The driver binding image of the MTFTP driver\r
  @param  Service                The variable to receive the created service\r
                                 binding instance.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resource to create the instance\r
  @retval EFI_DEVICE_ERROR       Failed to create a NULL UDP port to keep\r
                                 connection  with UDP.\r
  @retval EFI_SUCCESS            The service instance is created for the\r
                                 controller.\r
\r
**/\r
EFI_STATUS\r
Mtftp4CreateService (\r
  IN  EFI_HANDLE            Controller,\r
  IN  EFI_HANDLE            Image,\r
  OUT MTFTP4_SERVICE        **Service\r
  )\r
{\r
  MTFTP4_SERVICE            *MtftpSb;\r
  EFI_STATUS                Status;\r
\r
  *Service  = NULL;\r
  MtftpSb   = NetAllocatePool (sizeof (MTFTP4_SERVICE));\r
\r
  if (MtftpSb == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  MtftpSb->Signature      = MTFTP4_SERVICE_SIGNATURE;\r
  MtftpSb->ServiceBinding = gMtftp4ServiceBindingTemplete;\r
  MtftpSb->InDestory      = FALSE;\r
  MtftpSb->ChildrenNum    = 0;\r
  NetListInit (&MtftpSb->Children);\r
\r
  MtftpSb->Timer          = NULL;\r
  MtftpSb->TimerToGetMap  = NULL;\r
  MtftpSb->Controller     = Controller;\r
  MtftpSb->Image          = Image;\r
  MtftpSb->ConnectUdp     = NULL;\r
\r
  //\r
  // Create the timer and a udp to be notified when UDP is uninstalled\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL | EVT_TIMER,\r
                  TPL_CALLBACK,\r
                  Mtftp4OnTimerTick,\r
                  MtftpSb,\r
                  &MtftpSb->Timer\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    NetFreePool (MtftpSb);\r
    return Status;\r
  }\r
\r
  //\r
  // Create the timer used to time out the procedure which is used to\r
  // get the default IP address.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_TIMER,\r
                  TPL_CALLBACK,\r
                  NULL,\r
                  NULL,\r
                  &MtftpSb->TimerToGetMap\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    gBS->CloseEvent (MtftpSb->Timer);\r
    NetFreePool (MtftpSb);\r
    return Status;\r
  }\r
\r
  MtftpSb->ConnectUdp = UdpIoCreatePort (Controller, Image, Mtftp4ConfigNullUdp, NULL);\r
\r
  if (MtftpSb->ConnectUdp == NULL) {\r
    gBS->CloseEvent (MtftpSb->TimerToGetMap);\r
    gBS->CloseEvent (MtftpSb->Timer);\r
    NetFreePool (MtftpSb);\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  *Service = MtftpSb;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Release all the resource used the MTFTP service binding instance.\r
\r
  @param  MtftpSb                The MTFTP service binding instance.\r
\r
  @return None\r
\r
**/\r
VOID\r
Mtftp4CleanService (\r
  IN MTFTP4_SERVICE     *MtftpSb\r
  )\r
{\r
  UdpIoFreePort (MtftpSb->ConnectUdp);\r
  gBS->CloseEvent (MtftpSb->TimerToGetMap);\r
  gBS->CloseEvent (MtftpSb->Timer);\r
}\r
\r
\r
/**\r
  Start the MTFTP driver on this controller. MTFTP driver will\r
  install a MTFTP SERVICE BINDING protocol on the supported\r
  controller, which can be used to create/destroy MTFTP children.\r
\r
  @param  This                   The MTFTP driver binding protocol.\r
  @param  Controller             The controller to manage.\r
  @param  RemainingDevicePath    Remaining device path.\r
\r
  @retval EFI_ALREADY_STARTED    The MTFTP service binding protocol has been\r
                                 started  on the controller.\r
  @retval EFI_SUCCESS            The MTFTP service binding is installed on the\r
                                 controller.\r
\r
**/\r
EFI_STATUS\r
Mtftp4DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  MTFTP4_SERVICE            *MtftpSb;\r
  EFI_STATUS                Status;\r
\r
  //\r
  // Directly return if driver is already running.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiMtftp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
\r
  if (Status == EFI_SUCCESS) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  Status = Mtftp4CreateService (Controller, This->DriverBindingHandle, &MtftpSb);\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->SetTimer (MtftpSb->Timer, TimerPeriodic, TICKS_PER_SECOND);\r
\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Install the Mtftp4ServiceBinding Protocol onto Controller\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Controller,\r
                  &gEfiMtftp4ServiceBindingProtocolGuid,\r
                  &MtftpSb->ServiceBinding,\r
                  NULL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  Mtftp4CleanService (MtftpSb);\r
  NetFreePool (MtftpSb);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Stop the MTFTP driver on controller. The controller is a UDP\r
  child handle.\r
\r
  @param  This                   The MTFTP driver binding protocol\r
  @param  Controller             The controller to stop\r
  @param  NumberOfChildren       The number of children\r
  @param  ChildHandleBuffer      The array of the child handle.\r
\r
  @retval EFI_SUCCESS            The driver is stopped on the controller.\r
  @retval EFI_DEVICE_ERROR       Failed to stop the driver on the controller.\r
\r
**/\r
EFI_STATUS\r
Mtftp4DriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN  EFI_HANDLE                  Controller,\r
  IN  UINTN                       NumberOfChildren,\r
  IN  EFI_HANDLE                  *ChildHandleBuffer\r
  )\r
{\r
  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
  MTFTP4_SERVICE                *MtftpSb;\r
  MTFTP4_PROTOCOL               *Instance;\r
  EFI_HANDLE                    NicHandle;\r
  EFI_STATUS                    Status;\r
  EFI_TPL                       OldTpl;\r
\r
  //\r
  // MTFTP driver opens UDP child, So, Controller is a UDP\r
  // child handle. Locate the Nic handle first. Then get the\r
  // MTFTP private data back.\r
  //\r
  NicHandle = NetLibGetNicHandle (Controller, &gEfiUdp4ProtocolGuid);\r
\r
  if (NicHandle == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  NicHandle,\r
                  &gEfiMtftp4ServiceBindingProtocolGuid,\r
                  (VOID **) &ServiceBinding,\r
                  This->DriverBindingHandle,\r
                  NicHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  MtftpSb = MTFTP4_SERVICE_FROM_THIS (ServiceBinding);\r
\r
  if (MtftpSb->InDestory) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  OldTpl             = NET_RAISE_TPL (NET_TPL_LOCK);\r
  MtftpSb->InDestory = TRUE;\r
\r
  while (!NetListIsEmpty (&MtftpSb->Children)) {\r
    Instance = NET_LIST_HEAD (&MtftpSb->Children, MTFTP4_PROTOCOL, Link);\r
    Mtftp4ServiceBindingDestroyChild (ServiceBinding, Instance->Handle);\r
  }\r
\r
  if (MtftpSb->ChildrenNum != 0) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->UninstallProtocolInterface (\r
                  NicHandle,\r
                  &gEfiMtftp4ServiceBindingProtocolGuid,\r
                  ServiceBinding\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Mtftp4CleanService (MtftpSb);\r
  NetFreePool (MtftpSb);\r
\r
  NET_RESTORE_TPL (OldTpl);\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  MtftpSb->InDestory = FALSE;\r
\r
  NET_RESTORE_TPL (OldTpl);\r
  return Status;\r
}\r
\r
\r
/**\r
  Initialize a MTFTP protocol instance which is the child of MtftpSb.\r
\r
  @param  MtftpSb                The MTFTP service binding protocol.\r
  @param  Instance               The MTFTP instance to initialize.\r
\r
  @return None\r
\r
**/\r
VOID\r
Mtftp4InitProtocol (\r
  IN MTFTP4_SERVICE         *MtftpSb,\r
  IN MTFTP4_PROTOCOL        *Instance\r
  )\r
{\r
  NetZeroMem (Instance, sizeof (MTFTP4_PROTOCOL));\r
\r
  Instance->Signature = MTFTP4_PROTOCOL_SIGNATURE;\r
  NetListInit (&Instance->Link);\r
  CopyMem (&Instance->Mtftp4, &gMtftp4ProtocolTemplate, sizeof (Instance->Mtftp4));\r
  Instance->State     = MTFTP4_STATE_UNCONFIGED;\r
  Instance->Indestory = FALSE;\r
  Instance->Service   = MtftpSb;\r
\r
  NetListInit (&Instance->Blocks);\r
}\r
\r
\r
/**\r
  Create a MTFTP child for the service binding instance, then\r
  install the MTFTP protocol to the ChildHandle.\r
\r
  @param  This                   The MTFTP service binding instance.\r
  @param  ChildHandle            The Child handle to install the MTFTP protocol.\r
\r
  @retval EFI_INVALID_PARAMETER  The parameter is invalid.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resource for the new child.\r
  @retval EFI_SUCCESS            The child is successfully create.\r
\r
**/\r
EFI_STATUS\r
Mtftp4ServiceBindingCreateChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN OUT EFI_HANDLE                *ChildHandle\r
  )\r
{\r
  MTFTP4_SERVICE            *MtftpSb;\r
  MTFTP4_PROTOCOL           *Instance;\r
  EFI_STATUS                Status;\r
  EFI_TPL                   OldTpl;\r
  VOID                      *Udp4;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Instance = NetAllocatePool (sizeof (*Instance));\r
\r
  if (Instance == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  MtftpSb = MTFTP4_SERVICE_FROM_THIS (This);\r
\r
  Mtftp4InitProtocol (MtftpSb, Instance);\r
\r
  Instance->UnicastPort = UdpIoCreatePort (\r
                            MtftpSb->Controller,\r
                            MtftpSb->Image,\r
                            Mtftp4ConfigNullUdp,\r
                            Instance\r
                            );\r
\r
  if (Instance->UnicastPort == NULL) {\r
    NetFreePool (Instance);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Install the MTFTP protocol onto ChildHandle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiMtftp4ProtocolGuid,\r
                  &Instance->Mtftp4,\r
                  NULL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Instance->Handle  = *ChildHandle;\r
\r
  //\r
  // Open the Udp4 protocol BY_CHILD.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  MtftpSb->ConnectUdp->UdpHandle,\r
                  &gEfiUdp4ProtocolGuid,\r
                  (VOID **) &Udp4,\r
                  gMtftp4DriverBinding.DriverBindingHandle,\r
                  Instance->Handle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Instance->Handle,\r
           &gEfiMtftp4ProtocolGuid,\r
           &Instance->Mtftp4,\r
           NULL\r
           );\r
\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Add it to the parent's child list.\r
  //\r
  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
\r
  NetListInsertTail (&MtftpSb->Children, &Instance->Link);\r
  MtftpSb->ChildrenNum++;\r
\r
  NET_RESTORE_TPL (OldTpl);\r
\r
ON_ERROR:\r
\r
  if (EFI_ERROR (Status)) {\r
    UdpIoFreePort (Instance->UnicastPort);\r
    NetFreePool (Instance);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Destory one of the service binding's child.\r
\r
  @param  This                   The service binding instance\r
  @param  ChildHandle            The child handle to destory\r
\r
  @retval EFI_INVALID_PARAMETER  The parameter is invaid.\r
  @retval EFI_UNSUPPORTED        The child may have already been destoried.\r
  @retval EFI_SUCCESS            The child is destoried and removed from the\r
                                 parent's child list.\r
\r
**/\r
EFI_STATUS\r
Mtftp4ServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                   ChildHandle\r
  )\r
{\r
  MTFTP4_SERVICE            *MtftpSb;\r
  MTFTP4_PROTOCOL           *Instance;\r
  EFI_MTFTP4_PROTOCOL       *Mtftp4;\r
  EFI_STATUS                Status;\r
  EFI_TPL                   OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Retrieve the private context data structures\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ChildHandle,\r
                  &gEfiMtftp4ProtocolGuid,\r
                  (VOID **) &Mtftp4,\r
                  gMtftp4DriverBinding.DriverBindingHandle,\r
                  ChildHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Instance  = MTFTP4_PROTOCOL_FROM_THIS (Mtftp4);\r
  MtftpSb   = MTFTP4_SERVICE_FROM_THIS (This);\r
\r
  if (Instance->Service != MtftpSb) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Instance->Indestory) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Instance->Indestory = TRUE;\r
\r
  //\r
  // Close the Udp4 protocol.\r
  //\r
  gBS->CloseProtocol (\r
         MtftpSb->ConnectUdp->UdpHandle,\r
         &gEfiUdp4ProtocolGuid,\r
         gMtftp4DriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  //\r
  // Uninstall the MTFTP4 protocol first to enable a top down destruction.\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  ChildHandle,\r
                  &gEfiMtftp4ProtocolGuid,\r
                  Mtftp4\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    Instance->Indestory = FALSE;\r
    return Status;\r
  }\r
\r
  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
\r
  Mtftp4CleanOperation (Instance, EFI_DEVICE_ERROR);\r
  UdpIoFreePort (Instance->UnicastPort);\r
\r
  NetListRemoveEntry (&Instance->Link);\r
  MtftpSb->ChildrenNum--;\r
\r
  NET_RESTORE_TPL (OldTpl);\r
\r
  NetFreePool (Instance);\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
772db4bb	1	/** @file\r
	2	\r
	3	Copyright (c) 2006 - 2007, Intel Corporation\r
	4	All rights reserved. This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	Module Name:\r
	13	\r
	14	Mtftp4Driver.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	\r
	19	**/\r
	20	\r
	21	#include "Mtftp4Impl.h"\r
	22	\r
	23	EFI_DRIVER_BINDING_PROTOCOL gMtftp4DriverBinding = {\r
	24	Mtftp4DriverBindingSupported,\r
	25	Mtftp4DriverBindingStart,\r
	26	Mtftp4DriverBindingStop,\r
	27	0xa,\r
	28	NULL,\r
	29	NULL\r
	30	};\r
	31	\r
	32	EFI_SERVICE_BINDING_PROTOCOL gMtftp4ServiceBindingTemplete = {\r
	33	Mtftp4ServiceBindingCreateChild,\r
	34	Mtftp4ServiceBindingDestroyChild\r
	35	};\r
	36	\r
772db4bb	37	EFI_STATUS\r
	38	EFIAPI\r
	39	Mtftp4DriverEntryPoint (\r
	40	IN EFI_HANDLE ImageHandle,\r
	41	IN EFI_SYSTEM_TABLE *SystemTable\r
	42	)\r
	43	/*++\r
	44	\r
	45	Routine Description:\r
	46	\r
	47	The driver entry point which installs multiple protocols to the ImageHandle.\r
	48	\r
	49	Arguments:\r
	50	\r
	51	ImageHandle - The MTFTP's image handle\r
	52	SystemTable - The system table\r
	53	\r
	54	Returns:\r
	55	\r
	56	EFI_SUCCESS - The handles are successfully installed on the image. Otherwise\r
	57	some EFI_ERROR.\r
	58	\r
	59	--*/\r
	60	{\r
	61	return NetLibInstallAllDriverProtocols (\r
	62	ImageHandle,\r
	63	SystemTable,\r
	64	&gMtftp4DriverBinding,\r
	65	ImageHandle,\r
	66	&gMtftp4ComponentName,\r
	67	NULL,\r
	68	NULL\r
	69	);\r
	70	}\r
	71	\r
	72	\r
	73	/**\r
	74	Test whether MTFTP driver support this controller.\r
	75	\r
	76	@param This The MTFTP driver binding instance\r
	77	@param Controller The controller to test\r
	78	@param RemainingDevicePath The remaining device path\r
	79	\r
	80	@retval EFI_SUCCESS The controller has UDP service binding protocol\r
	81	installed, MTFTP can support it.\r
	82	@retval Others MTFTP can't support the controller.\r
	83	\r
	84	**/\r
	85	EFI_STATUS\r
	86	Mtftp4DriverBindingSupported (\r
	87	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	88	IN EFI_HANDLE Controller,\r
	89	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	90	)\r
	91	{\r
	92	EFI_STATUS Status;\r
	93	\r
	94	Status = gBS->OpenProtocol (\r
	95	Controller,\r
	96	&gEfiUdp4ServiceBindingProtocolGuid,\r
	97	NULL,\r
	98	This->DriverBindingHandle,\r
	99	Controller,\r
	100	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
101	);\r
102	\r
103	return Status;\r
104	}\r
105	\r
106	\r
107	/**\r
108	Config a NULL UDP that is used to keep the connection between UDP\r
109	and MTFTP. Just leave the Udp child unconfigured. When UDP is\r
110	unloaded, MTFTP will be informed with DriverBinding Stop.\r
111	\r
112	@param UdpIo The UDP port to configure\r
113	@param Context The opaque parameter to the callback\r
114	\r
115	@retval EFI_SUCCESS It always return EFI_SUCCESS directly.\r
116	\r
117	**/\r
118	EFI_STATUS\r
119	Mtftp4ConfigNullUdp (\r
120	IN UDP_IO_PORT *UdpIo,\r
121	IN VOID *Context\r
122	)\r
123	{\r
124	return EFI_SUCCESS;\r
125	}\r
126	\r
127	\r
128	/**\r
129	Create then initialize a MTFTP service binding instance.\r
130	\r
131	@param Controller The controller to install the MTFTP service\r
132	binding on\r
133	@param Image The driver binding image of the MTFTP driver\r
134	@param Service The variable to receive the created service\r
135	binding instance.\r
136	\r
137	@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to create the instance\r
138	@retval EFI_DEVICE_ERROR Failed to create a NULL UDP port to keep\r
139	connection with UDP.\r
140	@retval EFI_SUCCESS The service instance is created for the\r
141	controller.\r
142	\r
143	**/\r
144	EFI_STATUS\r
145	Mtftp4CreateService (\r
146	IN EFI_HANDLE Controller,\r
147	IN EFI_HANDLE Image,\r
148	OUT MTFTP4_SERVICE **Service\r
149	)\r
150	{\r
151	MTFTP4_SERVICE *MtftpSb;\r
152	EFI_STATUS Status;\r
153	\r
154	*Service = NULL;\r
155	MtftpSb = NetAllocatePool (sizeof (MTFTP4_SERVICE));\r
156	\r
157	if (MtftpSb == NULL) {\r
158	return EFI_OUT_OF_RESOURCES;\r
159	}\r
160	\r
161	MtftpSb->Signature = MTFTP4_SERVICE_SIGNATURE;\r
162	MtftpSb->ServiceBinding = gMtftp4ServiceBindingTemplete;\r
163	MtftpSb->InDestory = FALSE;\r
164	MtftpSb->ChildrenNum = 0;\r
165	NetListInit (&MtftpSb->Children);\r
166	\r
167	MtftpSb->Timer = NULL;\r
168	MtftpSb->TimerToGetMap = NULL;\r
169	MtftpSb->Controller = Controller;\r
170	MtftpSb->Image = Image;\r
171	MtftpSb->ConnectUdp = NULL;\r
172	\r
173	//\r
174	// Create the timer and a udp to be notified when UDP is uninstalled\r
175	//\r
176	Status = gBS->CreateEvent (\r
177	EVT_NOTIFY_SIGNAL \| EVT_TIMER,\r
178	TPL_CALLBACK,\r
179	Mtftp4OnTimerTick,\r
180	MtftpSb,\r
181	&MtftpSb->Timer\r
182	);\r
183	\r
184	if (EFI_ERROR (Status)) {\r
185	NetFreePool (MtftpSb);\r
186	return Status;\r
187	}\r
188	\r
189	//\r
190	// Create the timer used to time out the procedure which is used to\r
191	// get the default IP address.\r
192	//\r
193	Status = gBS->CreateEvent (\r
194	EVT_TIMER,\r
195	TPL_CALLBACK,\r
196	NULL,\r
197	NULL,\r
198	&MtftpSb->TimerToGetMap\r
199	);\r
200	if (EFI_ERROR (Status)) {\r
201	gBS->CloseEvent (MtftpSb->Timer);\r
202	NetFreePool (MtftpSb);\r
203	return Status;\r
204	}\r
205	\r
206	MtftpSb->ConnectUdp = UdpIoCreatePort (Controller, Image, Mtftp4ConfigNullUdp, NULL);\r
207	\r
208	if (MtftpSb->ConnectUdp == NULL) {\r
209	gBS->CloseEvent (MtftpSb->TimerToGetMap);\r
210	gBS->CloseEvent (MtftpSb->Timer);\r
211	NetFreePool (MtftpSb);\r
212	return EFI_DEVICE_ERROR;\r
213	}\r
214	\r
215	*Service = MtftpSb;\r
216	return EFI_SUCCESS;\r
217	}\r
218	\r
219	\r
220	/**\r
221	Release all the resource used the MTFTP service binding instance.\r
222	\r
223	@param MtftpSb The MTFTP service binding instance.\r
224	\r
225	@return None\r
226	\r
227	**/\r
228	VOID\r
229	Mtftp4CleanService (\r
230	IN MTFTP4_SERVICE *MtftpSb\r
231	)\r
232	{\r
233	UdpIoFreePort (MtftpSb->ConnectUdp);\r
234	gBS->CloseEvent (MtftpSb->TimerToGetMap);\r
235	gBS->CloseEvent (MtftpSb->Timer);\r
236	}\r
237	\r
238	\r
239	/**\r
240	Start the MTFTP driver on this controller. MTFTP driver will\r
241	install a MTFTP SERVICE BINDING protocol on the supported\r
242	controller, which can be used to create/destroy MTFTP children.\r
243	\r
244	@param This The MTFTP driver binding protocol.\r
245	@param Controller The controller to manage.\r
246	@param RemainingDevicePath Remaining device path.\r
247	\r
248	@retval EFI_ALREADY_STARTED The MTFTP service binding protocol has been\r
249	started on the controller.\r
250	@retval EFI_SUCCESS The MTFTP service binding is installed on the\r
251	controller.\r
252	\r
253	**/\r
254	EFI_STATUS\r
255	Mtftp4DriverBindingStart (\r
256	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
257	IN EFI_HANDLE Controller,\r
258	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
259	)\r
260	{\r
261	MTFTP4_SERVICE *MtftpSb;\r
262	EFI_STATUS Status;\r
263	\r
264	//\r
265	// Directly return if driver is already running.\r
266	//\r
267	Status = gBS->OpenProtocol (\r
268	Controller,\r
269	&gEfiMtftp4ServiceBindingProtocolGuid,\r
270	NULL,\r
271	This->DriverBindingHandle,\r
272	Controller,\r
273	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
274	);\r
275	\r
276	if (Status == EFI_SUCCESS) {\r
277	return EFI_ALREADY_STARTED;\r
278	}\r
279	\r
280	Status = Mtftp4CreateService (Controller, This->DriverBindingHandle, &MtftpSb);\r
281	\r
282	if (EFI_ERROR (Status)) {\r
283	return Status;\r
284	}\r
285	\r
286	Status = gBS->SetTimer (MtftpSb->Timer, TimerPeriodic, TICKS_PER_SECOND);\r
287	\r
288	if (EFI_ERROR (Status)) {\r
289	goto ON_ERROR;\r
290	}\r
291	\r
292	//\r
293	// Install the Mtftp4ServiceBinding Protocol onto Controller\r
294	//\r
295	Status = gBS->InstallMultipleProtocolInterfaces (\r
296	&Controller,\r
297	&gEfiMtftp4ServiceBindingProtocolGuid,\r
298	&MtftpSb->ServiceBinding,\r
299	NULL\r
300	);\r
301	\r
302	if (EFI_ERROR (Status)) {\r
303	goto ON_ERROR;\r
304	}\r
305	\r
306	return EFI_SUCCESS;\r
307	\r
308	ON_ERROR:\r
309	Mtftp4CleanService (MtftpSb);\r
310	NetFreePool (MtftpSb);\r
311	\r
312	return Status;\r
313	}\r
314	\r
315	\r
316	/**\r
317	Stop the MTFTP driver on controller. The controller is a UDP\r
318	child handle.\r
319	\r
320	@param This The MTFTP driver binding protocol\r
321	@param Controller The controller to stop\r
322	@param NumberOfChildren The number of children\r
323	@param ChildHandleBuffer The array of the child handle.\r
324	\r
325	@retval EFI_SUCCESS The driver is stopped on the controller.\r
326	@retval EFI_DEVICE_ERROR Failed to stop the driver on the controller.\r
327	\r
328	**/\r
329	EFI_STATUS\r
330	Mtftp4DriverBindingStop (\r
331	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
332	IN EFI_HANDLE Controller,\r
333	IN UINTN NumberOfChildren,\r
334	IN EFI_HANDLE *ChildHandleBuffer\r
335	)\r
336	{\r
337	EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r
338	MTFTP4_SERVICE *MtftpSb;\r
339	MTFTP4_PROTOCOL *Instance;\r
340	EFI_HANDLE NicHandle;\r
341	EFI_STATUS Status;\r
342	EFI_TPL OldTpl;\r
343	\r
344	//\r
345	// MTFTP driver opens UDP child, So, Controller is a UDP\r
346	// child handle. Locate the Nic handle first. Then get the\r
347	// MTFTP private data back.\r
348	//\r
349	NicHandle = NetLibGetNicHandle (Controller, &gEfiUdp4ProtocolGuid);\r
350	\r
351	if (NicHandle == NULL) {\r
352	return EFI_SUCCESS;\r
353	}\r
354	\r
355	Status = gBS->OpenProtocol (\r
356	NicHandle,\r
357	&gEfiMtftp4ServiceBindingProtocolGuid,\r
358	(VOID **) &ServiceBinding,\r
359	This->DriverBindingHandle,\r
360	NicHandle,\r
361	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
362	);\r
363	\r
364	if (EFI_ERROR (Status)) {\r
365	return EFI_DEVICE_ERROR;\r
366	}\r
367	\r
368	MtftpSb = MTFTP4_SERVICE_FROM_THIS (ServiceBinding);\r
369	\r
370	if (MtftpSb->InDestory) {\r
371	return EFI_SUCCESS;\r
372	}\r
373	\r
374	OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
375	MtftpSb->InDestory = TRUE;\r
376	\r
377	while (!NetListIsEmpty (&MtftpSb->Children)) {\r
378	Instance = NET_LIST_HEAD (&MtftpSb->Children, MTFTP4_PROTOCOL, Link);\r
379	Mtftp4ServiceBindingDestroyChild (ServiceBinding, Instance->Handle);\r
380	}\r
381	\r
382	if (MtftpSb->ChildrenNum != 0) {\r
383	Status = EFI_DEVICE_ERROR;\r
384	goto ON_ERROR;\r
385	}\r
386	\r
387	Status = gBS->UninstallProtocolInterface (\r
388	NicHandle,\r
389	&gEfiMtftp4ServiceBindingProtocolGuid,\r
390	ServiceBinding\r
391	);\r
392	\r
393	if (EFI_ERROR (Status)) {\r
394	goto ON_ERROR;\r
395	}\r
396	\r
397	Mtftp4CleanService (MtftpSb);\r
398	NetFreePool (MtftpSb);\r
399	\r
400	NET_RESTORE_TPL (OldTpl);\r
401	return EFI_SUCCESS;\r
402	\r
403	ON_ERROR:\r
404	MtftpSb->InDestory = FALSE;\r
405	\r
406	NET_RESTORE_TPL (OldTpl);\r
407	return Status;\r
408	}\r
409	\r
410	\r
411	/**\r
412	Initialize a MTFTP protocol instance which is the child of MtftpSb.\r
413	\r
414	@param MtftpSb The MTFTP service binding protocol.\r
415	@param Instance The MTFTP instance to initialize.\r
416	\r
417	@return None\r
418	\r
419	**/\r
420	VOID\r
421	Mtftp4InitProtocol (\r
422	IN MTFTP4_SERVICE *MtftpSb,\r
423	IN MTFTP4_PROTOCOL *Instance\r
424	)\r
425	{\r
426	NetZeroMem (Instance, sizeof (MTFTP4_PROTOCOL));\r
427	\r
428	Instance->Signature = MTFTP4_PROTOCOL_SIGNATURE;\r
429	NetListInit (&Instance->Link);\r
687a2e5f	430	CopyMem (&Instance->Mtftp4, &gMtftp4ProtocolTemplate, sizeof (Instance->Mtftp4));\r
772db4bb	431	Instance->State = MTFTP4_STATE_UNCONFIGED;\r
	432	Instance->Indestory = FALSE;\r
	433	Instance->Service = MtftpSb;\r
	434	\r
	435	NetListInit (&Instance->Blocks);\r
	436	}\r
	437	\r
	438	\r
	439	/**\r
	440	Create a MTFTP child for the service binding instance, then\r
	441	install the MTFTP protocol to the ChildHandle.\r
	442	\r
	443	@param This The MTFTP service binding instance.\r
	444	@param ChildHandle The Child handle to install the MTFTP protocol.\r
	445	\r
	446	@retval EFI_INVALID_PARAMETER The parameter is invalid.\r
	447	@retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the new child.\r
	448	@retval EFI_SUCCESS The child is successfully create.\r
	449	\r
	450	**/\r
	451	EFI_STATUS\r
	452	Mtftp4ServiceBindingCreateChild (\r
	453	IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
	454	IN OUT EFI_HANDLE *ChildHandle\r
	455	)\r
	456	{\r
	457	MTFTP4_SERVICE *MtftpSb;\r
	458	MTFTP4_PROTOCOL *Instance;\r
	459	EFI_STATUS Status;\r
	460	EFI_TPL OldTpl;\r
	461	VOID *Udp4;\r
	462	\r
	463	if ((This == NULL) \|\| (ChildHandle == NULL)) {\r
	464	return EFI_INVALID_PARAMETER;\r
	465	}\r
	466	\r
	467	Instance = NetAllocatePool (sizeof (*Instance));\r
	468	\r
	469	if (Instance == NULL) {\r
	470	return EFI_OUT_OF_RESOURCES;\r
	471	}\r
	472	\r
	473	MtftpSb = MTFTP4_SERVICE_FROM_THIS (This);\r
	474	\r
	475	Mtftp4InitProtocol (MtftpSb, Instance);\r
	476	\r
	477	Instance->UnicastPort = UdpIoCreatePort (\r
	478	MtftpSb->Controller,\r
	479	MtftpSb->Image,\r
	480	Mtftp4ConfigNullUdp,\r
	481	Instance\r
	482	);\r
	483	\r
	484	if (Instance->UnicastPort == NULL) {\r
	485	NetFreePool (Instance);\r
	486	return EFI_OUT_OF_RESOURCES;\r
	487	}\r
	488	\r
	489	//\r
	490	// Install the MTFTP protocol onto ChildHandle\r
	491	//\r
	492	Status = gBS->InstallMultipleProtocolInterfaces (\r
	493	ChildHandle,\r
	494	&gEfiMtftp4ProtocolGuid,\r
495	&Instance->Mtftp4,\r
496	NULL\r
497	);\r
498	\r
499	if (EFI_ERROR (Status)) {\r
500	goto ON_ERROR;\r
501	}\r
502	\r
503	Instance->Handle = *ChildHandle;\r
504	\r
505	//\r
506	// Open the Udp4 protocol BY_CHILD.\r
507	//\r
508	Status = gBS->OpenProtocol (\r
509	MtftpSb->ConnectUdp->UdpHandle,\r
510	&gEfiUdp4ProtocolGuid,\r
511	(VOID **) &Udp4,\r
512	gMtftp4DriverBinding.DriverBindingHandle,\r
513	Instance->Handle,\r
514	EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
515	);\r
516	if (EFI_ERROR (Status)) {\r
517	gBS->UninstallMultipleProtocolInterfaces (\r
518	Instance->Handle,\r
519	&gEfiMtftp4ProtocolGuid,\r
520	&Instance->Mtftp4,\r
521	NULL\r
522	);\r
523	\r
524	goto ON_ERROR;\r
525	}\r
526	\r
527	//\r
528	// Add it to the parent's child list.\r
529	//\r
530	OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
531	\r
532	NetListInsertTail (&MtftpSb->Children, &Instance->Link);\r
533	MtftpSb->ChildrenNum++;\r
534	\r
535	NET_RESTORE_TPL (OldTpl);\r
536	\r
537	ON_ERROR:\r
538	\r
539	if (EFI_ERROR (Status)) {\r
540	UdpIoFreePort (Instance->UnicastPort);\r
541	NetFreePool (Instance);\r
542	}\r
543	\r
544	return Status;\r
545	}\r
546	\r
547	\r
548	/**\r
549	Destory one of the service binding's child.\r
550	\r
551	@param This The service binding instance\r
552	@param ChildHandle The child handle to destory\r
553	\r
554	@retval EFI_INVALID_PARAMETER The parameter is invaid.\r
555	@retval EFI_UNSUPPORTED The child may have already been destoried.\r
556	@retval EFI_SUCCESS The child is destoried and removed from the\r
557	parent's child list.\r
558	\r
559	**/\r
560	EFI_STATUS\r
561	Mtftp4ServiceBindingDestroyChild (\r
562	IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
563	IN EFI_HANDLE ChildHandle\r
564	)\r
565	{\r
566	MTFTP4_SERVICE *MtftpSb;\r
567	MTFTP4_PROTOCOL *Instance;\r
568	EFI_MTFTP4_PROTOCOL *Mtftp4;\r
569	EFI_STATUS Status;\r
570	EFI_TPL OldTpl;\r
571	\r
572	if ((This == NULL) \|\| (ChildHandle == NULL)) {\r
573	return EFI_INVALID_PARAMETER;\r
574	}\r
575	\r
576	//\r
577	// Retrieve the private context data structures\r
578	//\r
579	Status = gBS->OpenProtocol (\r
580	ChildHandle,\r
581	&gEfiMtftp4ProtocolGuid,\r
582	(VOID **) &Mtftp4,\r
583	gMtftp4DriverBinding.DriverBindingHandle,\r
584	ChildHandle,\r
585	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
586	);\r
587	\r
588	if (EFI_ERROR (Status)) {\r
589	return EFI_UNSUPPORTED;\r
590	}\r
591	\r
592	Instance = MTFTP4_PROTOCOL_FROM_THIS (Mtftp4);\r
593	MtftpSb = MTFTP4_SERVICE_FROM_THIS (This);\r
594	\r
595	if (Instance->Service != MtftpSb) {\r
596	return EFI_INVALID_PARAMETER;\r
597	}\r
598	\r
599	if (Instance->Indestory) {\r
600	return EFI_SUCCESS;\r
601	}\r
602	\r
603	Instance->Indestory = TRUE;\r
604	\r
605	//\r
606	// Close the Udp4 protocol.\r
607	//\r
608	gBS->CloseProtocol (\r
609	MtftpSb->ConnectUdp->UdpHandle,\r
610	&gEfiUdp4ProtocolGuid,\r
611	gMtftp4DriverBinding.DriverBindingHandle,\r
612	ChildHandle\r
613	);\r
614	\r
615	//\r
616	// Uninstall the MTFTP4 protocol first to enable a top down destruction.\r
617	//\r
618	Status = gBS->UninstallProtocolInterface (\r
619	ChildHandle,\r
620	&gEfiMtftp4ProtocolGuid,\r
621	Mtftp4\r
622	);\r
623	\r
624	if (EFI_ERROR (Status)) {\r
625	Instance->Indestory = FALSE;\r
626	return Status;\r
627	}\r
628	\r
629	OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
630	\r
631	Mtftp4CleanOperation (Instance, EFI_DEVICE_ERROR);\r
632	UdpIoFreePort (Instance->UnicastPort);\r
633	\r
634	NetListRemoveEntry (&Instance->Link);\r
635	MtftpSb->ChildrenNum--;\r
636	\r
637	NET_RESTORE_TPL (OldTpl);\r
638	\r
639	NetFreePool (Instance);\r
640	return EFI_SUCCESS;\r
641	}\r