Mtftp4Driver.h File Reference

#include <Uefi.h>
#include <Protocol/ServiceBinding.h>
#include <Library/NetLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiDriverEntryPoint.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	Mtftp4DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
EFI_STATUS EFIAPI	Mtftp4DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
EFI_STATUS EFIAPI	Mtftp4DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer)
EFI_STATUS EFIAPI	Mtftp4ServiceBindingCreateChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE *ChildHandle)
EFI_STATUS EFIAPI	Mtftp4ServiceBindingDestroyChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE ChildHandle)

Variables
EFI_COMPONENT_NAME_PROTOCOL	gMtftp4ComponentName
EFI_COMPONENT_NAME2_PROTOCOL	gMtftp4ComponentName2
EFI_DRIVER_BINDING_PROTOCOL	gMtftp4DriverBinding
EFI_UNICODE_STRING_TABLE *	gMtftp4ControllerNameTable

Detailed Description

Mtftp drivers function header.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Mtftp4Driver.h.

Function Documentation

Mtftp4DriverBindingStart()

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

Start the MTFTP driver on this controller.

MTFTP driver will install a MTFTP SERVICE BINDING protocol on the supported controller, which can be used to create/destroy MTFTP children.

Parameters

This	The MTFTP driver binding protocol.
Controller	The controller to manage.
RemainingDevicePath	Remaining device path.

Return values

EFI_ALREADY_STARTED	The MTFTP service binding protocol has been started on the controller.
EFI_SUCCESS	The MTFTP service binding is installed on the controller.

Definition at line 263 of file Mtftp4Driver.c.

Mtftp4DriverBindingStop()

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

Stop the MTFTP driver on controller. The controller is a UDP child handle.

Parameters

This	The MTFTP driver binding protocol
Controller	The controller to stop
NumberOfChildren	The number of children
ChildHandleBuffer	The array of the child handle.

Return values

EFI_SUCCESS	The driver is stopped on the controller.
EFI_DEVICE_ERROR	Failed to stop the driver on the controller.

Definition at line 384 of file Mtftp4Driver.c.

Mtftp4DriverBindingSupported()

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

Test whether MTFTP driver support this controller.

Parameters

This	The MTFTP driver binding instance
Controller	The controller to test
RemainingDevicePath	The remaining device path

Return values

EFI_SUCCESS	The controller has UDP service binding protocol installed, MTFTP can support it.
Others	MTFTP can't support the controller.

Test whether MTFTP driver support this controller.

Parameters

This	The MTFTP driver binding instance
Controller	The controller to test
RemainingDevicePath	The remaining device path

Return values

EFI_SUCCESS	The controller has UDP service binding protocol installed, MTFTP can support it.
EFI_ALREADY_STARTED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
EFI_ACCESS_DENIED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 75 of file Mtftp4Driver.c.

Mtftp4ServiceBindingCreateChild()

EFI_STATUS EFIAPI Mtftp4ServiceBindingCreateChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE *	ChildHandle
	)

Create a MTFTP child for the service binding instance, then install the MTFTP protocol to the ChildHandle.

Parameters

This	The MTFTP service binding instance.
ChildHandle	The Child handle to install the MTFTP protocol.

Return values

EFI_INVALID_PARAMETER	The parameter is invalid.
EFI_OUT_OF_RESOURCES	Failed to allocate resource for the new child.
EFI_SUCCESS	The child is successfully create.

Definition at line 499 of file Mtftp4Driver.c.

Mtftp4ServiceBindingDestroyChild()

EFI_STATUS EFIAPI Mtftp4ServiceBindingDestroyChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ChildHandle
	)

Destroy one of the service binding's child.

Parameters

This	The service binding instance
ChildHandle	The child handle to destroy

Return values

EFI_INVALID_PARAMETER	The parameter is invalid.
EFI_UNSUPPORTED	The child may have already been destroyed.
EFI_SUCCESS	The child is destroyed and removed from the parent's child list.

Definition at line 636 of file Mtftp4Driver.c.

Variable Documentation

gMtftp4ComponentName

EFI_COMPONENT_NAME_PROTOCOL gMtftp4ComponentName

extern

EFI Component Name Protocol

Definition at line 143 of file ComponentName.c.

gMtftp4ComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gMtftp4ComponentName2

extern

EFI Component Name 2 Protocol

Definition at line 152 of file ComponentName.c.

gMtftp4ControllerNameTable

EFI_UNICODE_STRING_TABLE* gMtftp4ControllerNameTable

extern

Definition at line 169 of file ComponentName.c.

gMtftp4DriverBinding

EFI_DRIVER_BINDING_PROTOCOL gMtftp4DriverBinding

extern

Definition at line 11 of file Mtftp4Driver.c.