[mirror_edk2.git] / MdeModulePkg / Universal / Network / Udp4Dxe / Udp4Driver.c

/** @file\r
\r
Copyright (c) 2006, 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
  Udp4Driver.c\r
\r
Abstract:\r
\r
\r
**/\r
\r
\r
#include "Udp4Impl.h"\r
\r
EFI_DRIVER_BINDING_PROTOCOL gUdp4DriverBinding = {\r
  Udp4DriverBindingSupported,\r
  Udp4DriverBindingStart,\r
  Udp4DriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding = {\r
  Udp4ServiceBindingCreateChild,\r
  Udp4ServiceBindingDestroyChild\r
};\r
\r
\r
/**\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param  This                   Protocol instance pointer.\r
  @param  ControllerHandle       Handle of device to test.\r
  @param  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                 device to start.\r
\r
  @retval EFI_SUCCES             This driver supports this device.\r
  @retval EFI_ALREADY_STARTED    This driver is already running on this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Udp4DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath  OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Test for the Udp4ServiceBinding Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiUdp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Test for the Ip4 Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiIp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Start this driver on ControllerHandle.\r
\r
  @param  This                   Protocol instance pointer.\r
  @param  ControllerHandle       Handle of device to bind driver to\r
  @param  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                 device to start.\r
\r
  @retval EFI_SUCCES             This driver is added to ControllerHandle\r
  @retval EFI_ALREADY_STARTED    This driver is already running on ControllerHandle\r
  @retval other                  This driver does not support this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Udp4DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath  OPTIONAL\r
  )\r
{\r
  EFI_STATUS         Status;\r
  UDP4_SERVICE_DATA  *Udp4Service;\r
\r
  //\r
  // Allocate Private Context Data Structure.\r
  //\r
  Udp4Service = NetAllocatePool (sizeof (UDP4_SERVICE_DATA));\r
  if (Udp4Service == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = Udp4CreateService (Udp4Service, This->DriverBindingHandle, ControllerHandle);\r
  if (EFI_ERROR (Status)) {\r
    goto FREE_SERVICE;\r
  }\r
\r
  //\r
  // Install the Udp4ServiceBindingProtocol on the ControllerHandle.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &ControllerHandle,\r
                  &gEfiUdp4ServiceBindingProtocolGuid,\r
                  &Udp4Service->ServiceBinding,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto CLEAN_SERVICE;\r
  }\r
\r
  Udp4SetVariableData (Udp4Service);\r
\r
  return Status;\r
\r
CLEAN_SERVICE:\r
\r
  Udp4CleanService (Udp4Service);\r
\r
FREE_SERVICE:\r
\r
  NetFreePool (Udp4Service);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param  This                   Protocol instance pointer.\r
  @param  ControllerHandle       Handle of device to stop driver on\r
  @param  NumberOfChildren       Number of Handles in ChildHandleBuffer. If number\r
                                 of  children is zero stop the entire bus driver.\r
  @param  ChildHandleBuffer      List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCES             This driver is removed ControllerHandle.\r
  @retval other                  This driver was not removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Udp4DriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_HANDLE                    NicHandle;\r
  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
  UDP4_SERVICE_DATA             *Udp4Service;\r
  UDP4_INSTANCE_DATA            *Instance;\r
\r
  //\r
  // Find the NicHandle where UDP4 ServiceBinding Protocol is installed.\r
  //\r
  NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp4ProtocolGuid);\r
  if (NicHandle == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Retrieve the UDP4 ServiceBinding Protocol.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  NicHandle,\r
                  &gEfiUdp4ServiceBindingProtocolGuid,\r
                  (VOID **) &ServiceBinding,\r
                  This->DriverBindingHandle,\r
                  NicHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (ServiceBinding);\r
\r
  //\r
  // Uninstall the UDP4 ServiceBinding Protocol.\r
  //\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  NicHandle,\r
                  &gEfiUdp4ServiceBindingProtocolGuid,\r
                  &Udp4Service->ServiceBinding,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  while (!NetListIsEmpty (&Udp4Service->ChildrenList)) {\r
    //\r
    // Destroy all instances.\r
    //\r
    Instance = NET_LIST_HEAD (&Udp4Service->ChildrenList, UDP4_INSTANCE_DATA, Link);\r
\r
    ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);\r
  }\r
\r
  Udp4ClearVariableData (Udp4Service);\r
\r
  Udp4CleanService (Udp4Service);\r
\r
  NetFreePool (Udp4Service);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Creates a child handle with a set of I/O services.\r
\r
  @param  This                   Protocol instance pointer.\r
  @param  ChildHandle            Pointer to the handle of the child to create.   If\r
                                 it is NULL, then a new handle is created.   If it\r
                                 is not NULL, then the I/O services are  added to\r
                                 the existing child handle.\r
\r
  @retval EFI_SUCCES             The child handle was created with the I/O services\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources availabe to create\r
                                 the child\r
  @retval other                  The child handle was not created\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Udp4ServiceBindingCreateChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    *ChildHandle\r
  )\r
{\r
  EFI_STATUS          Status;\r
  UDP4_SERVICE_DATA   *Udp4Service;\r
  UDP4_INSTANCE_DATA  *Instance;\r
  EFI_TPL             OldTpl;\r
  VOID                *Ip4;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This);\r
\r
  //\r
  // Allocate the instance private data structure.\r
  //\r
  Instance = NetAllocatePool (sizeof (UDP4_INSTANCE_DATA));\r
  if (Instance == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Udp4InitInstance (Udp4Service, Instance);\r
\r
  //\r
  // Add an IpInfo for this instance.\r
  //\r
  Instance->IpInfo = IpIoAddIp (Udp4Service->IpIo);\r
  if (Instance->IpInfo == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto FREE_INSTANCE;\r
  }\r
\r
  //\r
  // Install the Udp4Protocol for this instance.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiUdp4ProtocolGuid,\r
                  &Instance->Udp4Proto,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto REMOVE_IPINFO;\r
  }\r
\r
  Instance->ChildHandle = *ChildHandle;\r
\r
  //\r
  // Open the default Ip4 protocol in the IP_IO BY_CHILD.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Udp4Service->IpIo->ChildHandle,\r
                  &gEfiIp4ProtocolGuid,\r
                  (VOID **) &Ip4,\r
                  gUdp4DriverBinding.DriverBindingHandle,\r
                  Instance->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto UNINSTALL_PROTOCOL;\r
  }\r
\r
  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
\r
  //\r
  // Link this instance into the service context data and increase the ChildrenNumber.\r
  //\r
  NetListInsertTail (&Udp4Service->ChildrenList, &Instance->Link);\r
  Udp4Service->ChildrenNumber++;\r
\r
  NET_RESTORE_TPL (OldTpl);\r
\r
  return Status;\r
\r
UNINSTALL_PROTOCOL:\r
\r
  gBS->UninstallMultipleProtocolInterfaces (\r
         Instance->ChildHandle,\r
         &gEfiUdp4ProtocolGuid,\r
         &Instance->Udp4Proto,\r
         NULL\r
         );\r
\r
REMOVE_IPINFO:\r
\r
  IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo);\r
\r
FREE_INSTANCE:\r
\r
  Udp4CleanInstance (Instance);\r
\r
  NetFreePool (Instance);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Destroys a child handle with a set of I/O services.\r
\r
  @param  This                   Protocol instance pointer.\r
  @param  ChildHandle            Handle of the child to destroy\r
\r
  @retval EFI_SUCCES             The I/O services were removed from the child\r
                                 handle\r
  @retval EFI_UNSUPPORTED        The child handle does not support the I/O services\r
                                  that are being removed\r
  @retval EFI_INVALID_PARAMETER  Child handle is not a valid EFI Handle.\r
  @retval EFI_ACCESS_DENIED      The child handle could not be destroyed because\r
                                 its  I/O services are being used.\r
  @retval other                  The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Udp4ServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    ChildHandle\r
  )\r
{\r
  EFI_STATUS          Status;\r
  UDP4_SERVICE_DATA   *Udp4Service;\r
  EFI_UDP4_PROTOCOL   *Udp4Proto;\r
  UDP4_INSTANCE_DATA  *Instance;\r
  EFI_TPL             OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This);\r
\r
  //\r
  // Try to get the Udp4 protocol from the ChildHandle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ChildHandle,\r
                  &gEfiUdp4ProtocolGuid,\r
                  (VOID **) &Udp4Proto,\r
                  gUdp4DriverBinding.DriverBindingHandle,\r
                  ChildHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Instance = UDP4_INSTANCE_DATA_FROM_THIS (Udp4Proto);\r
\r
  if (Instance->Destroyed) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Use the Destroyed flag to avoid the re-entering of the following code.\r
  //\r
  Instance->Destroyed = TRUE;\r
\r
  //\r
  // Close the Ip4 protocol.\r
  //\r
  gBS->CloseProtocol (\r
         Udp4Service->IpIo->ChildHandle,\r
         &gEfiIp4ProtocolGuid,\r
         gUdp4DriverBinding.DriverBindingHandle,\r
         Instance->ChildHandle\r
         );\r
\r
  //\r
  // Uninstall the Udp4Protocol previously installed on the ChildHandle.\r
  //\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiUdp4ProtocolGuid,\r
                  (VOID *) &Instance->Udp4Proto,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Instance->Destroyed = FALSE;\r
    return Status;\r
  }\r
\r
  //\r
  // Reset the configuration in case the instance's consumer forgets to do this.\r
  //\r
  Udp4Proto->Configure (Udp4Proto, NULL);\r
\r
  //\r
  // Remove the IpInfo this instance consumes.\r
  //\r
  IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo);\r
\r
  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
\r
  //\r
  // Remove this instance from the service context data's ChildrenList.\r
  //\r
  NetListRemoveEntry (&Instance->Link);\r
  Udp4Service->ChildrenNumber--;\r
\r
  //\r
  // Clean the instance.\r
  //\r
  Udp4CleanInstance (Instance);\r
\r
  NET_RESTORE_TPL (OldTpl);\r
\r
  NetFreePool (Instance);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
Udp4DriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The entry point for Udp4 driver which installs the driver binding\r
  and component name protocol on its ImageHandle.\r
\r
Arguments:\r
\r
  ImageHandle - The image handle of the driver.\r
  SystemTable - The system table.\r
\r
Returns:\r
\r
  EFI_SUCCESS - if the driver binding and component name protocols are\r
                successfully installed, otherwise if failed.\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Install the Udp4DriverBinding and Udp4ComponentName protocols.\r
  //\r
  Status = NetLibInstallAllDriverProtocols (\r
             ImageHandle,\r
             SystemTable,\r
             &gUdp4DriverBinding,\r
             ImageHandle,\r
             &gUdp4ComponentName,\r
             NULL,\r
             NULL\r
             );\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Initialize the UDP random port.\r
    //\r
    mUdp4RandomPort = (UINT16) (((UINT16) NetRandomInitSeed ()) % UDP4_PORT_KNOWN + UDP4_PORT_KNOWN);\r
  }\r
\r
  return Status;\r
}\r
\r
Commit	Line	Data
8a67d61d	1	/** @file\r
	2	\r
	3	Copyright (c) 2006, 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	Udp4Driver.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	\r
	19	**/\r
	20	\r
	21	\r
	22	#include "Udp4Impl.h"\r
	23	\r
	24	EFI_DRIVER_BINDING_PROTOCOL gUdp4DriverBinding = {\r
	25	Udp4DriverBindingSupported,\r
	26	Udp4DriverBindingStart,\r
	27	Udp4DriverBindingStop,\r
	28	0xa,\r
	29	NULL,\r
	30	NULL\r
	31	};\r
	32	\r
	33	EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding = {\r
	34	Udp4ServiceBindingCreateChild,\r
	35	Udp4ServiceBindingDestroyChild\r
	36	};\r
	37	\r
	38	\r
	39	/**\r
	40	Test to see if this driver supports ControllerHandle.\r
	41	\r
	42	@param This Protocol instance pointer.\r
	43	@param ControllerHandle Handle of device to test.\r
	44	@param RemainingDevicePath Optional parameter use to pick a specific child\r
	45	device to start.\r
	46	\r
	47	@retval EFI_SUCCES This driver supports this device.\r
	48	@retval EFI_ALREADY_STARTED This driver is already running on this device.\r
	49	\r
	50	**/\r
	51	EFI_STATUS\r
	52	EFIAPI\r
	53	Udp4DriverBindingSupported (\r
	54	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	55	IN EFI_HANDLE ControllerHandle,\r
	56	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
	57	)\r
	58	{\r
	59	EFI_STATUS Status;\r
	60	\r
	61	//\r
	62	// Test for the Udp4ServiceBinding Protocol\r
	63	//\r
	64	Status = gBS->OpenProtocol (\r
65	ControllerHandle,\r
66	&gEfiUdp4ServiceBindingProtocolGuid,\r
67	NULL,\r
68	This->DriverBindingHandle,\r
69	ControllerHandle,\r
70	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
71	);\r
72	if (!EFI_ERROR (Status)) {\r
73	return EFI_ALREADY_STARTED;\r
74	}\r
75	\r
76	//\r
77	// Test for the Ip4 Protocol\r
78	//\r
79	Status = gBS->OpenProtocol (\r
80	ControllerHandle,\r
81	&gEfiIp4ServiceBindingProtocolGuid,\r
82	NULL,\r
83	This->DriverBindingHandle,\r
84	ControllerHandle,\r
85	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
86	);\r
87	\r
88	return Status;\r
89	}\r
90	\r
91	\r
92	/**\r
93	Start this driver on ControllerHandle.\r
94	\r
95	@param This Protocol instance pointer.\r
96	@param ControllerHandle Handle of device to bind driver to\r
97	@param RemainingDevicePath Optional parameter use to pick a specific child\r
98	device to start.\r
99	\r
100	@retval EFI_SUCCES This driver is added to ControllerHandle\r
101	@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
102	@retval other This driver does not support this device\r
103	\r
104	**/\r
105	EFI_STATUS\r
106	EFIAPI\r
107	Udp4DriverBindingStart (\r
108	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
109	IN EFI_HANDLE ControllerHandle,\r
110	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
111	)\r
112	{\r
113	EFI_STATUS Status;\r
114	UDP4_SERVICE_DATA *Udp4Service;\r
115	\r
116	//\r
117	// Allocate Private Context Data Structure.\r
118	//\r
119	Udp4Service = NetAllocatePool (sizeof (UDP4_SERVICE_DATA));\r
120	if (Udp4Service == NULL) {\r
121	return EFI_OUT_OF_RESOURCES;\r
122	}\r
123	\r
124	Status = Udp4CreateService (Udp4Service, This->DriverBindingHandle, ControllerHandle);\r
125	if (EFI_ERROR (Status)) {\r
126	goto FREE_SERVICE;\r
127	}\r
128	\r
129	//\r
130	// Install the Udp4ServiceBindingProtocol on the ControllerHandle.\r
131	//\r
132	Status = gBS->InstallMultipleProtocolInterfaces (\r
133	&ControllerHandle,\r
134	&gEfiUdp4ServiceBindingProtocolGuid,\r
135	&Udp4Service->ServiceBinding,\r
136	NULL\r
137	);\r
138	if (EFI_ERROR (Status)) {\r
139	goto CLEAN_SERVICE;\r
140	}\r
141	\r
142	Udp4SetVariableData (Udp4Service);\r
143	\r
144	return Status;\r
145	\r
146	CLEAN_SERVICE:\r
147	\r
148	Udp4CleanService (Udp4Service);\r
149	\r
150	FREE_SERVICE:\r
151	\r
152	NetFreePool (Udp4Service);\r
153	\r
154	return Status;\r
155	}\r
156	\r
157	\r
158	/**\r
159	Stop this driver on ControllerHandle.\r
160	\r
161	@param This Protocol instance pointer.\r
162	@param ControllerHandle Handle of device to stop driver on\r
163	@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r
164	of children is zero stop the entire bus driver.\r
165	@param ChildHandleBuffer List of Child Handles to Stop.\r
166	\r
167	@retval EFI_SUCCES This driver is removed ControllerHandle.\r
168	@retval other This driver was not removed from this device.\r
169	\r
170	**/\r
171	EFI_STATUS\r
172	EFIAPI\r
173	Udp4DriverBindingStop (\r
174	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
175	IN EFI_HANDLE ControllerHandle,\r
176	IN UINTN NumberOfChildren,\r
177	IN EFI_HANDLE *ChildHandleBuffer\r
178	)\r
179	{\r
180	EFI_STATUS Status;\r
181	EFI_HANDLE NicHandle;\r
182	EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r
183	UDP4_SERVICE_DATA *Udp4Service;\r
184	UDP4_INSTANCE_DATA *Instance;\r
185	\r
186	//\r
187	// Find the NicHandle where UDP4 ServiceBinding Protocol is installed.\r
188	//\r
189	NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp4ProtocolGuid);\r
190	if (NicHandle == NULL) {\r
191	return EFI_SUCCESS;\r
192	}\r
193	\r
194	//\r
195	// Retrieve the UDP4 ServiceBinding Protocol.\r
196	//\r
197	Status = gBS->OpenProtocol (\r
198	NicHandle,\r
199	&gEfiUdp4ServiceBindingProtocolGuid,\r
200	(VOID **) &ServiceBinding,\r
201	This->DriverBindingHandle,\r
202	NicHandle,\r
203	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
204	);\r
205	if (EFI_ERROR (Status)) {\r
206	return EFI_DEVICE_ERROR;\r
207	}\r
208	\r
209	Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (ServiceBinding);\r
210	\r
211	//\r
212	// Uninstall the UDP4 ServiceBinding Protocol.\r
213	//\r
214	Status = gBS->UninstallMultipleProtocolInterfaces (\r
215	NicHandle,\r
216	&gEfiUdp4ServiceBindingProtocolGuid,\r
217	&Udp4Service->ServiceBinding,\r
218	NULL\r
219	);\r
220	if (EFI_ERROR (Status)) {\r
221	return EFI_DEVICE_ERROR;\r
222	}\r
223	\r
224	while (!NetListIsEmpty (&Udp4Service->ChildrenList)) {\r
225	//\r
226	// Destroy all instances.\r
227	//\r
228	Instance = NET_LIST_HEAD (&Udp4Service->ChildrenList, UDP4_INSTANCE_DATA, Link);\r
229	\r
230	ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);\r
231	}\r
232	\r
233	Udp4ClearVariableData (Udp4Service);\r
234	\r
235	Udp4CleanService (Udp4Service);\r
236	\r
237	NetFreePool (Udp4Service);\r
238	\r
239	return EFI_SUCCESS;\r
240	}\r
241	\r
242	\r
243	/**\r
244	Creates a child handle with a set of I/O services.\r
245	\r
246	@param This Protocol instance pointer.\r
247	@param ChildHandle Pointer to the handle of the child to create. If\r
248	it is NULL, then a new handle is created. If it\r
249	is not NULL, then the I/O services are added to\r
250	the existing child handle.\r
251	\r
252	@retval EFI_SUCCES The child handle was created with the I/O services\r
253	@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
254	the child\r
255	@retval other The child handle was not created\r
256	\r
257	**/\r
258	EFI_STATUS\r
259	EFIAPI\r
260	Udp4ServiceBindingCreateChild (\r
261	IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
262	IN EFI_HANDLE *ChildHandle\r
263	)\r
264	{\r
265	EFI_STATUS Status;\r
266	UDP4_SERVICE_DATA *Udp4Service;\r
267	UDP4_INSTANCE_DATA *Instance;\r
268	EFI_TPL OldTpl;\r
269	VOID *Ip4;\r
270	\r
271	if ((This == NULL) \|\| (ChildHandle == NULL)) {\r
272	return EFI_INVALID_PARAMETER;\r
273	}\r
274	\r
275	Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This);\r
276	\r
277	//\r
278	// Allocate the instance private data structure.\r
279	//\r
280	Instance = NetAllocatePool (sizeof (UDP4_INSTANCE_DATA));\r
281	if (Instance == NULL) {\r
282	return EFI_OUT_OF_RESOURCES;\r
283	}\r
284	\r
285	Udp4InitInstance (Udp4Service, Instance);\r
286	\r
287	//\r
288	// Add an IpInfo for this instance.\r
289	//\r
290	Instance->IpInfo = IpIoAddIp (Udp4Service->IpIo);\r
291	if (Instance->IpInfo == NULL) {\r
292	Status = EFI_OUT_OF_RESOURCES;\r
293	goto FREE_INSTANCE;\r
294	}\r
295	\r
296	//\r
297	// Install the Udp4Protocol for this instance.\r
298	//\r
299	Status = gBS->InstallMultipleProtocolInterfaces (\r
300	ChildHandle,\r
301	&gEfiUdp4ProtocolGuid,\r
302	&Instance->Udp4Proto,\r
303	NULL\r
304	);\r
305	if (EFI_ERROR (Status)) {\r
306	goto REMOVE_IPINFO;\r
307	}\r
308	\r
309	Instance->ChildHandle = *ChildHandle;\r
310	\r
311	//\r
312	// Open the default Ip4 protocol in the IP_IO BY_CHILD.\r
313	//\r
314	Status = gBS->OpenProtocol (\r
315	Udp4Service->IpIo->ChildHandle,\r
316	&gEfiIp4ProtocolGuid,\r
317	(VOID **) &Ip4,\r
318	gUdp4DriverBinding.DriverBindingHandle,\r
319	Instance->ChildHandle,\r
320	EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
321	);\r
322	if (EFI_ERROR (Status)) {\r
323	goto UNINSTALL_PROTOCOL;\r
324	}\r
325	\r
326	OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
327	\r
328	//\r
329	// Link this instance into the service context data and increase the ChildrenNumber.\r
330	//\r
331	NetListInsertTail (&Udp4Service->ChildrenList, &Instance->Link);\r
332	Udp4Service->ChildrenNumber++;\r
333	\r
334	NET_RESTORE_TPL (OldTpl);\r
335	\r
336	return Status;\r
337	\r
338	UNINSTALL_PROTOCOL:\r
339	\r
340	gBS->UninstallMultipleProtocolInterfaces (\r
341	Instance->ChildHandle,\r
342	&gEfiUdp4ProtocolGuid,\r
343	&Instance->Udp4Proto,\r
344	NULL\r
345	);\r
346	\r
347	REMOVE_IPINFO:\r
348	\r
349	IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo);\r
350	\r
351	FREE_INSTANCE:\r
352	\r
353	Udp4CleanInstance (Instance);\r
354	\r
355	NetFreePool (Instance);\r
356	\r
357	return Status;\r
358	}\r
359	\r
360	\r
361	/**\r
362	Destroys a child handle with a set of I/O services.\r
363	\r
364	@param This Protocol instance pointer.\r
365	@param ChildHandle Handle of the child to destroy\r
366	\r
367	@retval EFI_SUCCES The I/O services were removed from the child\r
368	handle\r
369	@retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
370	that are being removed\r
371	@retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
372	@retval EFI_ACCESS_DENIED The child handle could not be destroyed because\r
373	its I/O services are being used.\r
374	@retval other The child handle was not destroyed\r
375	\r
376	**/\r
377	EFI_STATUS\r
378	EFIAPI\r
379	Udp4ServiceBindingDestroyChild (\r
380	IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
381	IN EFI_HANDLE ChildHandle\r
382	)\r
383	{\r
384	EFI_STATUS Status;\r
385	UDP4_SERVICE_DATA *Udp4Service;\r
386	EFI_UDP4_PROTOCOL *Udp4Proto;\r
387	UDP4_INSTANCE_DATA *Instance;\r
388	EFI_TPL OldTpl;\r
389	\r
390	if ((This == NULL) \|\| (ChildHandle == NULL)) {\r
391	return EFI_INVALID_PARAMETER;\r
392	}\r
393	\r
394	Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This);\r
395	\r
396	//\r
397	// Try to get the Udp4 protocol from the ChildHandle.\r
398	//\r
399	Status = gBS->OpenProtocol (\r
400	ChildHandle,\r
401	&gEfiUdp4ProtocolGuid,\r
402	(VOID **) &Udp4Proto,\r
403	gUdp4DriverBinding.DriverBindingHandle,\r
404	ChildHandle,\r
405	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
406	);\r
407	if (EFI_ERROR (Status)) {\r
408	return EFI_UNSUPPORTED;\r
409	}\r
410	\r
411	Instance = UDP4_INSTANCE_DATA_FROM_THIS (Udp4Proto);\r
412	\r
413	if (Instance->Destroyed) {\r
414	return EFI_SUCCESS;\r
415	}\r
416	\r
417	//\r
418	// Use the Destroyed flag to avoid the re-entering of the following code.\r
419	//\r
420	Instance->Destroyed = TRUE;\r
421	\r
422	//\r
423	// Close the Ip4 protocol.\r
424	//\r
425	gBS->CloseProtocol (\r
426	Udp4Service->IpIo->ChildHandle,\r
427	&gEfiIp4ProtocolGuid,\r
428	gUdp4DriverBinding.DriverBindingHandle,\r
429	Instance->ChildHandle\r
430	);\r
431	\r
432	//\r
433	// Uninstall the Udp4Protocol previously installed on the ChildHandle.\r
434	//\r
435	Status = gBS->UninstallMultipleProtocolInterfaces (\r
436	ChildHandle,\r
437	&gEfiUdp4ProtocolGuid,\r
438	(VOID *) &Instance->Udp4Proto,\r
439	NULL\r
440	);\r
441	if (EFI_ERROR (Status)) {\r
442	Instance->Destroyed = FALSE;\r
443	return Status;\r
444	}\r
445	\r
446	//\r
447	// Reset the configuration in case the instance's consumer forgets to do this.\r
448	//\r
449	Udp4Proto->Configure (Udp4Proto, NULL);\r
450	\r
451	//\r
452	// Remove the IpInfo this instance consumes.\r
453	//\r
454	IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo);\r
455	\r
456	OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
457	\r
458	//\r
459	// Remove this instance from the service context data's ChildrenList.\r
460	//\r
461	NetListRemoveEntry (&Instance->Link);\r
462	Udp4Service->ChildrenNumber--;\r
463	\r
464	//\r
465	// Clean the instance.\r
466	//\r
467	Udp4CleanInstance (Instance);\r
468	\r
469	NET_RESTORE_TPL (OldTpl);\r
470	\r
471	NetFreePool (Instance);\r
472	\r
473	return EFI_SUCCESS;\r
474	}\r
475	\r
8a67d61d	476	\r
	477	EFI_STATUS\r
	478	EFIAPI\r
	479	Udp4DriverEntryPoint (\r
	480	IN EFI_HANDLE ImageHandle,\r
	481	IN EFI_SYSTEM_TABLE *SystemTable\r
	482	)\r
	483	/*++\r
	484	\r
	485	Routine Description:\r
	486	\r
	487	The entry point for Udp4 driver which installs the driver binding\r
	488	and component name protocol on its ImageHandle.\r
	489	\r
	490	Arguments:\r
	491	\r
	492	ImageHandle - The image handle of the driver.\r
	493	SystemTable - The system table.\r
	494	\r
	495	Returns:\r
	496	\r
	497	EFI_SUCCESS - if the driver binding and component name protocols are\r
	498	successfully installed, otherwise if failed.\r
	499	\r
	500	--*/\r
	501	{\r
	502	EFI_STATUS Status;\r
	503	\r
	504	//\r
	505	// Install the Udp4DriverBinding and Udp4ComponentName protocols.\r
	506	//\r
	507	Status = NetLibInstallAllDriverProtocols (\r
	508	ImageHandle,\r
	509	SystemTable,\r
	510	&gUdp4DriverBinding,\r
	511	ImageHandle,\r
	512	&gUdp4ComponentName,\r
	513	NULL,\r
	514	NULL\r
	515	);\r
	516	if (!EFI_ERROR (Status)) {\r
	517	//\r
	518	// Initialize the UDP random port.\r
	519	//\r
687a2e5f	520	mUdp4RandomPort = (UINT16) (((UINT16) NetRandomInitSeed ()) % UDP4_PORT_KNOWN + UDP4_PORT_KNOWN);\r
8a67d61d	521	}\r
	522	\r
	523	return Status;\r
	524	}\r
	525	\r