mirror of https://github.com/acidanthera/audk.git
185 lines
7.1 KiB
C
185 lines
7.1 KiB
C
|
/** @file
|
||
|
|
|
||
|
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
|
||
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#ifndef __EFI_IP4_DRIVER_H__
|
||
|
|
#define __EFI_IP4_DRIVER_H__
|
||
|
|
|
||
|
|
#include <Protocol/ServiceBinding.h>
|
||
|
|
|
||
|
|
extern EFI_DRIVER_BINDING_PROTOCOL gIp4DriverBinding;
|
||
|
|
extern EFI_COMPONENT_NAME_PROTOCOL gIp4ComponentName;
|
||
|
|
extern EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2;
|
||
|
extern EFI_UNICODE_STRING_TABLE *gIp4ControllerNameTable;
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
|
||
|
|
UINTN NumberOfChildren;
|
||
|
|
EFI_HANDLE *ChildHandleBuffer;
|
||
|
|
} IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;
|
||
|
|
|
||
|
|
//
|
||
|
|
// Function prototype for the driver's entry point
|
||
|
|
//
|
||
|
/**
|
||
|
|
This is the declaration of an EFI image entry point. This entry point is
|
||
|
|
the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
|
||
|
|
both device drivers and bus drivers.
|
||
|
|
|
||
|
|
The entry point for IP4 driver which install the driver
|
||
|
|
binding and component name protocol on its image.
|
||
|
|
|
||
|
|
@param[in] ImageHandle The firmware allocated handle for the UEFI image.
|
||
|
|
@param[in] SystemTable A pointer to the EFI System Table.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The operation completed successfully.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
Ip4DriverEntryPoint (
|
||
|
|
IN EFI_HANDLE ImageHandle,
|
||
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
||
|
|
);
|
||
|
|
|
||
|
|
//
|
||
|
|
// Function prototypes for the Drivr Binding Protocol
|
||
|
|
//
|
||
|
|
/**
|
||
|
|
Test to see if this driver supports ControllerHandle. 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.
|
||
|
|
|
||
|
|
@param[in] This Protocol instance pointer.
|
||
|
|
@param[in] ControllerHandle Handle of device to test
|
||
|
|
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
|
||
|
|
device to start.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS This driver supports this device
|
||
|
|
@retval EFI_ALREADY_STARTED This driver is already running on this device
|
||
|
|
@retval other This driver does not support this device
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
Ip4DriverBindingSupported (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL * This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Start this driver on ControllerHandle. 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 Start() it
|
||
|
|
must also follow these calling restrictions.
|
||
|
|
|
||
|
|
@param[in] This Protocol instance pointer.
|
||
|
|
@param[in] ControllerHandle Handle of device to bind driver to
|
||
|
|
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
|
||
|
|
device to start.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS This driver is added to ControllerHandle
|
||
|
|
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
|
||
|
|
@retval other This driver does not support this device
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
Ip4DriverBindingStart (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL * This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Stop this driver on ControllerHandle. This service is called by the
|
||
|
|
EFI boot service DisconnectController(). In order to
|
||
|
|
make drivers as small as possible, there are a few 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.
|
||
|
|
|
||
|
|
@param[in] This Protocol instance pointer.
|
||
|
|
@param[in] ControllerHandle Handle of device to stop driver on
|
||
|
|
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number
|
||
|
|
of children is zero stop the entire bus driver.
|
||
|
|
@param[in] ChildHandleBuffer List of Child Handles to Stop.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS This driver is removed ControllerHandle
|
||
|
|
@retval other This driver was not removed from this device
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
Ip4DriverBindingStop (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN UINTN NumberOfChildren,
|
||
|
|
IN EFI_HANDLE *ChildHandleBuffer
|
||
|
|
);
|
||
|
|
|
||
|
|
//
|
||
|
// Function prototypes for the ServiceBinding Protocol
|
||
|
|
//
|
||
|
|
/**
|
||
|
|
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.
|
||
|
|
|
||
|
|
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
|
||
|
|
@param ChildHandle Pointer 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.
|
||
|
|
|
||
|
|
@retval EFI_SUCCES The protocol was added to ChildHandle.
|
||
|
|
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
|
||
|
|
the child
|
||
|
|
@retval other The child handle was not created
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
Ip4ServiceBindingCreateChild (
|
||
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||
|
|
IN OUT 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.
|
||
|
|
|
||
|
|
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
|
||
|
|
@param ChildHandle Handle of the child to destroy
|
||
|
|
|
||
|
|
@retval EFI_SUCCES The protocol was removed from ChildHandle.
|
||
|
|
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
|
||
|
@retval EFI_INVALID_PARAMETER Child handle is NULL.
|
||
|
|
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
|
||
|
|
because its services are being used.
|
||
|
|
@retval other The child handle was not destroyed
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
Ip4ServiceBindingDestroyChild (
|
||
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ChildHandle
|
||
|
|
);
|
||
|
|
#endif
|