2 Implementation of Mtftp drivers.
4 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php<BR>
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "Mtftp4Impl.h"
17 EFI_DRIVER_BINDING_PROTOCOL gMtftp4DriverBinding
= {
18 Mtftp4DriverBindingSupported
,
19 Mtftp4DriverBindingStart
,
20 Mtftp4DriverBindingStop
,
26 EFI_SERVICE_BINDING_PROTOCOL gMtftp4ServiceBindingTemplete
= {
27 Mtftp4ServiceBindingCreateChild
,
28 Mtftp4ServiceBindingDestroyChild
33 The driver entry point which installs multiple protocols to the ImageHandle.
35 @param ImageHandle The MTFTP's image handle.
36 @param SystemTable The system table.
38 @retval EFI_SUCCESS The handles are successfully installed on the image.
39 @retval others some EFI_ERROR occured.
44 Mtftp4DriverEntryPoint (
45 IN EFI_HANDLE ImageHandle
,
46 IN EFI_SYSTEM_TABLE
*SystemTable
49 return EfiLibInstallDriverBindingComponentName2 (
52 &gMtftp4DriverBinding
,
54 &gMtftp4ComponentName
,
55 &gMtftp4ComponentName2
61 Test whether MTFTP driver support this controller.
63 @param This The MTFTP driver binding instance
64 @param Controller The controller to test
65 @param RemainingDevicePath The remaining device path
67 @retval EFI_SUCCESS The controller has UDP service binding protocol
68 installed, MTFTP can support it.
69 @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
70 RemainingDevicePath is already being managed by
71 the driver specified by This.
72 @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
73 RemainingDevicePath is already being managed by a
74 different driver or an application that requires
76 @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
77 RemainingDevicePath is not supported by the driver
83 Mtftp4DriverBindingSupported (
84 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
85 IN EFI_HANDLE Controller
,
86 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
91 Status
= gBS
->OpenProtocol (
93 &gEfiUdp4ServiceBindingProtocolGuid
,
95 This
->DriverBindingHandle
,
97 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
105 Config a NULL UDP that is used to keep the connection between UDP and MTFTP.
107 Just leave the Udp child unconfigured. When UDP is unloaded,
108 MTFTP will be informed with DriverBinding Stop.
110 @param UdpIo The UDP_IO to configure
111 @param Context The opaque parameter to the callback
113 @retval EFI_SUCCESS It always return EFI_SUCCESS directly.
118 Mtftp4ConfigNullUdp (
128 Create then initialize a MTFTP service binding instance.
130 @param Controller The controller to install the MTFTP service
132 @param Image The driver binding image of the MTFTP driver
133 @param Service The variable to receive the created service
136 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to create the instance
137 @retval EFI_DEVICE_ERROR Failed to create a NULL UDP port to keep
139 @retval EFI_SUCCESS The service instance is created for the
144 Mtftp4CreateService (
145 IN EFI_HANDLE Controller
,
147 OUT MTFTP4_SERVICE
**Service
150 MTFTP4_SERVICE
*MtftpSb
;
154 MtftpSb
= AllocatePool (sizeof (MTFTP4_SERVICE
));
156 if (MtftpSb
== NULL
) {
157 return EFI_OUT_OF_RESOURCES
;
160 MtftpSb
->Signature
= MTFTP4_SERVICE_SIGNATURE
;
161 MtftpSb
->ServiceBinding
= gMtftp4ServiceBindingTemplete
;
162 MtftpSb
->ChildrenNum
= 0;
163 InitializeListHead (&MtftpSb
->Children
);
165 MtftpSb
->Timer
= NULL
;
166 MtftpSb
->TimerToGetMap
= NULL
;
167 MtftpSb
->Controller
= Controller
;
168 MtftpSb
->Image
= Image
;
169 MtftpSb
->ConnectUdp
= NULL
;
172 // Create the timer and a udp to be notified when UDP is uninstalled
174 Status
= gBS
->CreateEvent (
175 EVT_NOTIFY_SIGNAL
| EVT_TIMER
,
182 if (EFI_ERROR (Status
)) {
188 // Create the timer used to time out the procedure which is used to
189 // get the default IP address.
191 Status
= gBS
->CreateEvent (
196 &MtftpSb
->TimerToGetMap
198 if (EFI_ERROR (Status
)) {
199 gBS
->CloseEvent (MtftpSb
->Timer
);
204 MtftpSb
->ConnectUdp
= UdpIoCreateIo (
212 if (MtftpSb
->ConnectUdp
== NULL
) {
213 gBS
->CloseEvent (MtftpSb
->TimerToGetMap
);
214 gBS
->CloseEvent (MtftpSb
->Timer
);
216 return EFI_DEVICE_ERROR
;
225 Release all the resource used the MTFTP service binding instance.
227 @param MtftpSb The MTFTP service binding instance.
232 IN MTFTP4_SERVICE
*MtftpSb
235 UdpIoFreeIo (MtftpSb
->ConnectUdp
);
236 gBS
->CloseEvent (MtftpSb
->TimerToGetMap
);
237 gBS
->CloseEvent (MtftpSb
->Timer
);
242 Start the MTFTP driver on this controller.
244 MTFTP driver will install a MTFTP SERVICE BINDING protocol on the supported
245 controller, which can be used to create/destroy MTFTP children.
247 @param This The MTFTP driver binding protocol.
248 @param Controller The controller to manage.
249 @param RemainingDevicePath Remaining device path.
251 @retval EFI_ALREADY_STARTED The MTFTP service binding protocol has been
252 started on the controller.
253 @retval EFI_SUCCESS The MTFTP service binding is installed on the
259 Mtftp4DriverBindingStart (
260 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
261 IN EFI_HANDLE Controller
,
262 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
265 MTFTP4_SERVICE
*MtftpSb
;
269 // Directly return if driver is already running.
271 Status
= gBS
->OpenProtocol (
273 &gEfiMtftp4ServiceBindingProtocolGuid
,
275 This
->DriverBindingHandle
,
277 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
280 if (Status
== EFI_SUCCESS
) {
281 return EFI_ALREADY_STARTED
;
284 Status
= Mtftp4CreateService (Controller
, This
->DriverBindingHandle
, &MtftpSb
);
286 if (EFI_ERROR (Status
)) {
289 ASSERT (MtftpSb
!= NULL
);
291 Status
= gBS
->SetTimer (MtftpSb
->Timer
, TimerPeriodic
, TICKS_PER_SECOND
);
293 if (EFI_ERROR (Status
)) {
298 // Install the Mtftp4ServiceBinding Protocol onto Controller
300 Status
= gBS
->InstallMultipleProtocolInterfaces (
302 &gEfiMtftp4ServiceBindingProtocolGuid
,
303 &MtftpSb
->ServiceBinding
,
307 if (EFI_ERROR (Status
)) {
314 Mtftp4CleanService (MtftpSb
);
321 Callback function which provided by user to remove one node in NetDestroyLinkList process.
323 @param[in] Entry The entry to be removed.
324 @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
326 @retval EFI_SUCCESS The entry has been removed successfully.
327 @retval Others Fail to remove the entry.
332 Mtftp4DestroyChildEntryInHandleBuffer (
333 IN LIST_ENTRY
*Entry
,
337 MTFTP4_PROTOCOL
*Instance
;
338 EFI_SERVICE_BINDING_PROTOCOL
*ServiceBinding
;
339 UINTN NumberOfChildren
;
340 EFI_HANDLE
*ChildHandleBuffer
;
342 if (Entry
== NULL
|| Context
== NULL
) {
343 return EFI_INVALID_PARAMETER
;
346 Instance
= NET_LIST_USER_STRUCT_S (Entry
, MTFTP4_PROTOCOL
, Link
, MTFTP4_PROTOCOL_SIGNATURE
);
347 ServiceBinding
= ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT
*) Context
)->ServiceBinding
;
348 NumberOfChildren
= ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT
*) Context
)->NumberOfChildren
;
349 ChildHandleBuffer
= ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT
*) Context
)->ChildHandleBuffer
;
351 if (!NetIsInHandleBuffer (Instance
->Handle
, NumberOfChildren
, ChildHandleBuffer
)) {
355 return ServiceBinding
->DestroyChild (ServiceBinding
, Instance
->Handle
);
359 Stop the MTFTP driver on controller. The controller is a UDP
362 @param This The MTFTP driver binding protocol
363 @param Controller The controller to stop
364 @param NumberOfChildren The number of children
365 @param ChildHandleBuffer The array of the child handle.
367 @retval EFI_SUCCESS The driver is stopped on the controller.
368 @retval EFI_DEVICE_ERROR Failed to stop the driver on the controller.
373 Mtftp4DriverBindingStop (
374 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
375 IN EFI_HANDLE Controller
,
376 IN UINTN NumberOfChildren
,
377 IN EFI_HANDLE
*ChildHandleBuffer
380 EFI_SERVICE_BINDING_PROTOCOL
*ServiceBinding
;
381 MTFTP4_SERVICE
*MtftpSb
;
382 EFI_HANDLE NicHandle
;
385 MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context
;
388 // MTFTP driver opens UDP child, So, Controller is a UDP
389 // child handle. Locate the Nic handle first. Then get the
390 // MTFTP private data back.
392 NicHandle
= NetLibGetNicHandle (Controller
, &gEfiUdp4ProtocolGuid
);
394 if (NicHandle
== NULL
) {
398 Status
= gBS
->OpenProtocol (
400 &gEfiMtftp4ServiceBindingProtocolGuid
,
401 (VOID
**) &ServiceBinding
,
402 This
->DriverBindingHandle
,
404 EFI_OPEN_PROTOCOL_GET_PROTOCOL
407 if (EFI_ERROR (Status
)) {
408 return EFI_DEVICE_ERROR
;
411 MtftpSb
= MTFTP4_SERVICE_FROM_THIS (ServiceBinding
);
413 if (!IsListEmpty (&MtftpSb
->Children
)) {
415 // Destroy the Mtftp4 child instance in ChildHandleBuffer.
417 List
= &MtftpSb
->Children
;
418 Context
.ServiceBinding
= ServiceBinding
;
419 Context
.NumberOfChildren
= NumberOfChildren
;
420 Context
.ChildHandleBuffer
= ChildHandleBuffer
;
421 Status
= NetDestroyLinkList (
423 Mtftp4DestroyChildEntryInHandleBuffer
,
429 if (NumberOfChildren
== 0 && IsListEmpty (&MtftpSb
->Children
)) {
430 gBS
->UninstallProtocolInterface (
432 &gEfiMtftp4ServiceBindingProtocolGuid
,
436 Mtftp4CleanService (MtftpSb
);
437 if (gMtftp4ControllerNameTable
!= NULL
) {
438 FreeUnicodeStringTable (gMtftp4ControllerNameTable
);
439 gMtftp4ControllerNameTable
= NULL
;
443 Status
= EFI_SUCCESS
;
451 Initialize a MTFTP protocol instance which is the child of MtftpSb.
453 @param MtftpSb The MTFTP service binding protocol.
454 @param Instance The MTFTP instance to initialize.
459 IN MTFTP4_SERVICE
*MtftpSb
,
460 OUT MTFTP4_PROTOCOL
*Instance
463 ZeroMem (Instance
, sizeof (MTFTP4_PROTOCOL
));
465 Instance
->Signature
= MTFTP4_PROTOCOL_SIGNATURE
;
466 InitializeListHead (&Instance
->Link
);
467 CopyMem (&Instance
->Mtftp4
, &gMtftp4ProtocolTemplate
, sizeof (Instance
->Mtftp4
));
468 Instance
->State
= MTFTP4_STATE_UNCONFIGED
;
469 Instance
->Service
= MtftpSb
;
471 InitializeListHead (&Instance
->Blocks
);
476 Create a MTFTP child for the service binding instance, then
477 install the MTFTP protocol to the ChildHandle.
479 @param This The MTFTP service binding instance.
480 @param ChildHandle The Child handle to install the MTFTP protocol.
482 @retval EFI_INVALID_PARAMETER The parameter is invalid.
483 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the new child.
484 @retval EFI_SUCCESS The child is successfully create.
489 Mtftp4ServiceBindingCreateChild (
490 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
491 IN EFI_HANDLE
*ChildHandle
494 MTFTP4_SERVICE
*MtftpSb
;
495 MTFTP4_PROTOCOL
*Instance
;
500 if ((This
== NULL
) || (ChildHandle
== NULL
)) {
501 return EFI_INVALID_PARAMETER
;
504 Instance
= AllocatePool (sizeof (*Instance
));
506 if (Instance
== NULL
) {
507 return EFI_OUT_OF_RESOURCES
;
510 MtftpSb
= MTFTP4_SERVICE_FROM_THIS (This
);
512 Mtftp4InitProtocol (MtftpSb
, Instance
);
514 Instance
->UnicastPort
= UdpIoCreateIo (
522 if (Instance
->UnicastPort
== NULL
) {
524 return EFI_OUT_OF_RESOURCES
;
528 // Install the MTFTP protocol onto ChildHandle
530 Status
= gBS
->InstallMultipleProtocolInterfaces (
532 &gEfiMtftp4ProtocolGuid
,
537 if (EFI_ERROR (Status
)) {
538 UdpIoFreeIo (Instance
->UnicastPort
);
543 Instance
->Handle
= *ChildHandle
;
546 // Open the Udp4 protocol BY_CHILD.
548 Status
= gBS
->OpenProtocol (
549 MtftpSb
->ConnectUdp
->UdpHandle
,
550 &gEfiUdp4ProtocolGuid
,
552 gMtftp4DriverBinding
.DriverBindingHandle
,
554 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
556 if (EFI_ERROR (Status
)) {
561 // Open the Udp4 protocol by child.
563 Status
= gBS
->OpenProtocol (
564 Instance
->UnicastPort
->UdpHandle
,
565 &gEfiUdp4ProtocolGuid
,
567 gMtftp4DriverBinding
.DriverBindingHandle
,
569 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
571 if (EFI_ERROR (Status
)) {
573 // Close the Udp4 protocol.
576 MtftpSb
->ConnectUdp
->UdpHandle
,
577 &gEfiUdp4ProtocolGuid
,
578 gMtftp4DriverBinding
.DriverBindingHandle
,
585 // Add it to the parent's child list.
587 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
589 InsertTailList (&MtftpSb
->Children
, &Instance
->Link
);
590 MtftpSb
->ChildrenNum
++;
592 gBS
->RestoreTPL (OldTpl
);
597 if (Instance
->Handle
!= NULL
) {
598 gBS
->UninstallMultipleProtocolInterfaces (
600 &gEfiMtftp4ProtocolGuid
,
606 UdpIoFreeIo (Instance
->UnicastPort
);
614 Destroy one of the service binding's child.
616 @param This The service binding instance
617 @param ChildHandle The child handle to destroy
619 @retval EFI_INVALID_PARAMETER The parameter is invaid.
620 @retval EFI_UNSUPPORTED The child may have already been destroyed.
621 @retval EFI_SUCCESS The child is destroyed and removed from the
627 Mtftp4ServiceBindingDestroyChild (
628 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
629 IN EFI_HANDLE ChildHandle
632 MTFTP4_SERVICE
*MtftpSb
;
633 MTFTP4_PROTOCOL
*Instance
;
634 EFI_MTFTP4_PROTOCOL
*Mtftp4
;
638 if ((This
== NULL
) || (ChildHandle
== NULL
)) {
639 return EFI_INVALID_PARAMETER
;
643 // Retrieve the private context data structures
645 Status
= gBS
->OpenProtocol (
647 &gEfiMtftp4ProtocolGuid
,
649 gMtftp4DriverBinding
.DriverBindingHandle
,
651 EFI_OPEN_PROTOCOL_GET_PROTOCOL
654 if (EFI_ERROR (Status
)) {
655 return EFI_UNSUPPORTED
;
658 Instance
= MTFTP4_PROTOCOL_FROM_THIS (Mtftp4
);
659 MtftpSb
= MTFTP4_SERVICE_FROM_THIS (This
);
661 if (Instance
->Service
!= MtftpSb
) {
662 return EFI_INVALID_PARAMETER
;
665 if (Instance
->InDestroy
) {
669 Instance
->InDestroy
= TRUE
;
672 // Close the Udp4 protocol.
675 MtftpSb
->ConnectUdp
->UdpHandle
,
676 &gEfiUdp4ProtocolGuid
,
677 gMtftp4DriverBinding
.DriverBindingHandle
,
682 Instance
->UnicastPort
->UdpHandle
,
683 &gEfiUdp4ProtocolGuid
,
684 gMtftp4DriverBinding
.DriverBindingHandle
,
688 if (Instance
->McastUdpPort
!= NULL
) {
690 Instance
->McastUdpPort
->UdpHandle
,
691 &gEfiUdp4ProtocolGuid
,
692 gMtftp4DriverBinding
.DriverBindingHandle
,
698 // Uninstall the MTFTP4 protocol first to enable a top down destruction.
700 Status
= gBS
->UninstallProtocolInterface (
702 &gEfiMtftp4ProtocolGuid
,
706 if (EFI_ERROR (Status
)) {
707 Instance
->InDestroy
= FALSE
;
711 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
713 Mtftp4CleanOperation (Instance
, EFI_DEVICE_ERROR
);
714 UdpIoFreeIo (Instance
->UnicastPort
);
716 RemoveEntryList (&Instance
->Link
);
717 MtftpSb
->ChildrenNum
--;
719 gBS
->RestoreTPL (OldTpl
);