TianoCore EDK2 master
Loading...
Searching...
No Matches
Mtftp6Driver.h File Reference

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI Mtftp6DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
 
EFI_STATUS EFIAPI Mtftp6DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
 
EFI_STATUS EFIAPI Mtftp6DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer)
 
EFI_STATUS EFIAPI Mtftp6ServiceBindingCreateChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN OUT EFI_HANDLE *ChildHandle)
 
EFI_STATUS EFIAPI Mtftp6ServiceBindingDestroyChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE ChildHandle)
 

Variables

EFI_COMPONENT_NAME_PROTOCOL gMtftp6ComponentName
 
EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2
 
EFI_UNICODE_STRING_TABLEgMtftp6ControllerNameTable
 

Detailed Description

Driver Binding functions and Service Binding functions declaration for Mtftp6 Driver.

Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Mtftp6Driver.h.

Function Documentation

◆ Mtftp6DriverBindingStart()

EFI_STATUS EFIAPI Mtftp6DriverBindingStart ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  Controller,
IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath 
)

Start this driver on Controller. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Start() it must also follow these calling restrictions.

Parameters
[in]ThisProtocol instance pointer.
[in]ControllerHandle of device to bind driver to.
[in]RemainingDevicePathOptional parameter use to pick a specific child device to start.
Return values
EFI_SUCCESSThis driver is added to Controller.
EFI_ALREADY_STARTEDThis driver is already running on Controller.
OthersThis driver does not support this device.

Definition at line 351 of file Mtftp6Driver.c.

◆ Mtftp6DriverBindingStop()

EFI_STATUS EFIAPI Mtftp6DriverBindingStop ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  Controller,
IN UINTN  NumberOfChildren,
IN EFI_HANDLE ChildHandleBuffer 
)

Stop this driver on Controller. This service is called by the EFI boot service DisconnectController(). In order to make drivers as small as possible, there are calling restrictions for this service. DisconnectController() must follow these calling restrictions. If any other agent wishes to call Stop(), it must also follow these calling restrictions.

Parameters
[in]ThisProtocol instance pointer.
[in]ControllerHandle of device to stop driver on
[in]NumberOfChildrenNumber of Handles in ChildHandleBuffer. If number of children is zero, stop the entire bus driver.
[in]ChildHandleBufferList of Child Handles to Stop.
Return values
EFI_SUCCESSThis driver is removed Controller.
EFI_DEVICE_ERRORAn unexpected error.
OthersThis driver was not removed from this device.

Definition at line 447 of file Mtftp6Driver.c.

◆ Mtftp6DriverBindingSupported()

EFI_STATUS EFIAPI Mtftp6DriverBindingSupported ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  Controller,
IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath 
)

Test to see if this driver supports Controller. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Supported(), it must also follow these calling restrictions.

Parameters
[in]ThisProtocol instance pointer.
[in]ControllerHandle of device to test.
[in]RemainingDevicePathOptional parameter use to pick a specific child device to start.
Return values
EFI_SUCCESSThis driver supports this device.
OthersThis driver does not support this device.

Test to see if this driver supports Controller. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Supported(), it must also follow these calling restrictions.

Parameters
[in]ThisProtocol instance pointer.
[in]ControllerHandle of device to test
[in]RemainingDevicePathOptional parameter use to pick a specific child. device to start.
Return values
EFI_SUCCESSThis driver supports this device.
OthersThis driver does not support this device.

Definition at line 315 of file Mtftp6Driver.c.

◆ Mtftp6ServiceBindingCreateChild()

EFI_STATUS EFIAPI Mtftp6ServiceBindingCreateChild ( IN EFI_SERVICE_BINDING_PROTOCOL This,
IN OUT EFI_HANDLE ChildHandle 
)

Creates a child handle and installs a protocol.

The CreateChild() function installs a protocol on ChildHandle. If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.

Parameters
[in]ThisPointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
[in,out]ChildHandlePointer 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.
Return values
EFI_SUCCESSThe protocol was added to ChildHandle.
EFI_INVALID_PARAMETERChildHandle is NULL.
OthersThe child handle was not created.

Definition at line 537 of file Mtftp6Driver.c.

◆ Mtftp6ServiceBindingDestroyChild()

EFI_STATUS EFIAPI Mtftp6ServiceBindingDestroyChild ( IN EFI_SERVICE_BINDING_PROTOCOL This,
IN EFI_HANDLE  ChildHandle 
)

Destroys a child handle with a protocol installed on it.

The DestroyChild() function does the opposite of CreateChild(). It removes a protocol that was installed by CreateChild() from ChildHandle. If the removed protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.

Parameters
[in]ThisPointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
[in]ChildHandleHandle of the child to destroy.
Return values
EFI_SUCCESSThe protocol was removed from ChildHandle.
EFI_UNSUPPORTEDChildHandle does not support the protocol that is being removed.
EFI_INVALID_PARAMETERChild handle is NULL.
OthersThe child handle was not destroyed

Definition at line 636 of file Mtftp6Driver.c.

Variable Documentation

◆ gMtftp6ComponentName

EFI_COMPONENT_NAME_PROTOCOL gMtftp6ComponentName
extern

Definition at line 140 of file ComponentName.c.

◆ gMtftp6ComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2
extern

Definition at line 149 of file ComponentName.c.

◆ gMtftp6ControllerNameTable

EFI_UNICODE_STRING_TABLE* gMtftp6ControllerNameTable
extern

Definition at line 166 of file ComponentName.c.