mirror of https://github.com/acidanthera/audk.git
382 lines
17 KiB
C
382 lines
17 KiB
C
|
/** @file
|
||
|
|
Header file for driver binding protocol and HII config access protocol.
|
||
|
|
|
||
|
Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
|
||
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#ifndef __VLAN_CONFIG_IMPL_H__
|
||
|
|
#define __VLAN_CONFIG_IMPL_H__
|
||
|
|
|
||
|
|
#include <Uefi.h>
|
||
|
|
|
||
|
|
#include <Protocol/ComponentName.h>
|
||
|
|
#include <Protocol/ComponentName2.h>
|
||
|
|
#include <Protocol/HiiConfigAccess.h>
|
||
|
|
#include <Protocol/HiiConfigRouting.h>
|
||
|
|
#include <Protocol/VlanConfig.h>
|
||
|
|
|
||
|
|
#include <Library/BaseLib.h>
|
||
|
|
#include <Library/BaseMemoryLib.h>
|
||
|
|
#include <Library/DebugLib.h>
|
||
|
|
#include <Library/MemoryAllocationLib.h>
|
||
|
|
#include <Library/UefiBootServicesTableLib.h>
|
||
|
|
#include <Library/UefiLib.h>
|
||
|
|
#include <Library/NetLib.h>
|
||
|
|
#include <Library/HiiLib.h>
|
||
|
|
#include <Library/DevicePathLib.h>
|
||
|
|
#include <Library/PrintLib.h>
|
||
|
|
|
||
|
|
#include <Guid/MdeModuleHii.h>
|
||
|
|
|
||
|
|
#include "VlanConfigNvData.h"
|
||
|
|
|
||
|
|
extern EFI_COMPONENT_NAME2_PROTOCOL gVlanConfigComponentName2;
|
||
|
|
extern EFI_COMPONENT_NAME_PROTOCOL gVlanConfigComponentName;
|
||
|
|
|
||
|
|
//
|
||
|
|
// Tool generated IFR binary data and String package data
|
||
|
|
//
|
||
|
|
extern UINT8 VlanConfigBin[];
|
||
|
|
extern UINT8 VlanConfigDxeStrings[];
|
||
|
|
|
||
|
|
#define VLAN_LIST_VAR_OFFSET ((UINT16) OFFSET_OF (VLAN_CONFIGURATION, VlanList))
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
UINTN Signature;
|
||
|
|
|
||
|
|
EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;
|
||
|
|
EFI_HII_HANDLE HiiHandle;
|
||
|
|
EFI_HANDLE DriverHandle;
|
||
|
|
EFI_DEVICE_PATH_PROTOCOL *ChildDevicePath;
|
||
|
|
|
||
|
|
EFI_HANDLE ControllerHandle;
|
||
|
|
EFI_HANDLE ImageHandle;
|
||
|
|
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;
|
||
|
|
EFI_VLAN_CONFIG_PROTOCOL *VlanConfig;
|
||
|
|
CHAR16 *MacString;
|
||
|
|
|
||
|
|
UINT16 NumberOfVlan;
|
||
|
|
UINT16 VlanId[MAX_VLAN_NUMBER];
|
||
|
|
} VLAN_CONFIG_PRIVATE_DATA;
|
||
|
|
|
||
|
|
#define VLAN_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('V', 'C', 'P', 'D')
|
||
|
|
#define VLAN_CONFIG_PRIVATE_DATA_FROM_THIS(a) CR (a, VLAN_CONFIG_PRIVATE_DATA, ConfigAccess, VLAN_CONFIG_PRIVATE_DATA_SIGNATURE)
|
||
|
|
|
||
|
|
extern VLAN_CONFIG_PRIVATE_DATA mVlanConfigPrivateDateTemplate;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
Retrieves a Unicode string that is the user readable name of the driver.
|
||
|
|
|
||
|
|
This function retrieves the user readable name of a driver in the form of a
|
||
|
|
Unicode string. If the driver specified by This has a user readable name in
|
||
|
|
the language specified by Language, then a pointer to the driver name is
|
||
|
|
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
|
||
|
|
by This does not support the language specified by Language,
|
||
|
|
then EFI_UNSUPPORTED is returned.
|
||
|
|
|
||
|
|
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||
|
|
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||
|
|
@param Language[in] A pointer to a Null-terminated ASCII string
|
||
|
|
array indicating the language. This is the
|
||
|
|
language of the driver name that the caller is
|
||
|
|
requesting, and it must match one of the
|
||
|
|
languages specified in SupportedLanguages. The
|
||
|
|
number of languages supported by a driver is up
|
||
|
|
to the driver writer. Language is specified
|
||
|
|
in RFC 4646 or ISO 639-2 language code format.
|
||
|
|
@param DriverName[out] A pointer to the Unicode string to return.
|
||
|
|
This Unicode string is the name of the
|
||
|
|
driver specified by This in the language
|
||
|
|
specified by Language.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The Unicode string for the Driver specified by
|
||
|
|
This and the language specified by Language was
|
||
|
|
returned in DriverName.
|
||
|
|
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||
|
|
@retval EFI_INVALID_PARAMETER DriverName is NULL.
|
||
|
|
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||
|
|
the language specified by Language.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
VlanConfigComponentNameGetDriverName (
|
||
|
|
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||
|
|
IN CHAR8 *Language,
|
||
|
|
OUT CHAR16 **DriverName
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Retrieves a Unicode string that is the user readable name of the controller
|
||
|
|
that is being managed by a driver.
|
||
|
|
|
||
|
|
This function retrieves the user readable name of the controller specified by
|
||
|
|
ControllerHandle and ChildHandle in the form of a Unicode string. If the
|
||
|
|
driver specified by This has a user readable name in the language specified by
|
||
|
|
Language, then a pointer to the controller name is returned in ControllerName,
|
||
|
|
and EFI_SUCCESS is returned. If the driver specified by This is not currently
|
||
|
|
managing the controller specified by ControllerHandle and ChildHandle,
|
||
|
|
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
|
||
|
|
support the language specified by Language, then EFI_UNSUPPORTED is returned.
|
||
|
|
|
||
|
|
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||
|
|
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||
|
|
@param ControllerHandle[in] The handle of a controller that the driver
|
||
|
|
specified by This is managing. This handle
|
||
|
|
specifies the controller whose name is to be
|
||
|
|
returned.
|
||
|
|
@param ChildHandle[in] The handle of the child controller to retrieve
|
||
|
|
the name of. This is an optional parameter that
|
||
|
|
may be NULL. It will be NULL for device
|
||
|
|
drivers. It will also be NULL for a bus drivers
|
||
|
|
that wish to retrieve the name of the bus
|
||
|
|
controller. It will not be NULL for a bus
|
||
|
|
driver that wishes to retrieve the name of a
|
||
|
|
child controller.
|
||
|
|
@param Language[in] A pointer to a Null-terminated ASCII string
|
||
|
|
array indicating the language. This is the
|
||
|
|
language of the driver name that the caller is
|
||
|
|
requesting, and it must match one of the
|
||
|
|
languages specified in SupportedLanguages. The
|
||
|
|
number of languages supported by a driver is up
|
||
|
|
to the driver writer. Language is specified in
|
||
|
|
RFC 4646 or ISO 639-2 language code format.
|
||
|
|
@param ControllerName[out] A pointer to the Unicode string to return.
|
||
|
|
This Unicode string is the name of the
|
||
|
|
controller specified by ControllerHandle and
|
||
|
|
ChildHandle in the language specified by
|
||
|
|
Language from the point of view of the driver
|
||
|
|
specified by This.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The Unicode string for the user readable name in
|
||
|
|
the language specified by Language for the
|
||
|
|
driver specified by This was returned in
|
||
|
|
DriverName.
|
||
|
@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
|
||
|
|
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
|
||
|
|
EFI_HANDLE.
|
||
|
|
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||
|
|
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
|
||
|
|
@retval EFI_UNSUPPORTED The driver specified by This is not currently
|
||
|
|
managing the controller specified by
|
||
|
|
ControllerHandle and ChildHandle.
|
||
|
|
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||
|
|
the language specified by Language.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
VlanConfigComponentNameGetControllerName (
|
||
|
|
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN EFI_HANDLE ChildHandle OPTIONAL,
|
||
|
|
IN CHAR8 *Language,
|
||
|
|
OUT CHAR16 **ControllerName
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Test to see if this driver supports ControllerHandle.
|
||
|
|
|
||
|
|
@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_SUCCES 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
|
||
|
|
VlanConfigDriverBindingSupported (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Start this driver on ControllerHandle.
|
||
|
|
|
||
|
|
@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_SUCCES 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
|
||
|
|
VlanConfigDriverBindingStart (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Stop this driver on ControllerHandle.
|
||
|
|
|
||
|
|
@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_SUCCES This driver is removed ControllerHandle
|
||
|
|
@retval other This driver was not removed from this device
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
VlanConfigDriverBindingStop (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN UINTN NumberOfChildren,
|
||
|
|
IN EFI_HANDLE *ChildHandleBuffer
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
This function update VLAN list in the VLAN configuration Form.
|
||
|
|
|
||
|
|
@param[in, out] PrivateData Points to VLAN configuration private data.
|
||
|
|
|
||
|
|
**/
|
||
|
|
VOID
|
||
|
|
VlanUpdateForm (
|
||
|
|
IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
This function publish the VLAN configuration Form for a network device. The
|
||
|
|
HII Config Access protocol will be installed on a child handle of the network
|
||
|
|
device.
|
||
|
|
|
||
|
|
@param[in, out] PrivateData Points to VLAN configuration private data.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS HII Form is installed for this network device.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
|
||
|
|
@retval Others Other errors as indicated.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
InstallVlanConfigForm (
|
||
|
|
IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
This function remove the VLAN configuration Form for a network device. The
|
||
|
|
child handle for HII Config Access protocol will be destroyed.
|
||
|
|
|
||
|
|
@param[in, out] PrivateData Points to VLAN configuration private data.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS HII Form has been uninstalled successfully.
|
||
|
|
@retval Others Other errors as indicated.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
UninstallVlanConfigForm (
|
||
|
|
IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
This function allows a caller to extract the current configuration for one
|
||
|
|
or more named elements from the target driver.
|
||
|
|
|
||
|
|
@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
|
||
|
|
@param[in] Request A null-terminated Unicode string in
|
||
|
|
<ConfigRequest> format.
|
||
|
|
@param[out] Progress On return, points to a character in the Request
|
||
|
|
string. Points to the string's null terminator if
|
||
|
|
request was successful. Points to the most recent
|
||
|
|
'&' before the first failing name/value pair (or
|
||
|
|
the beginning of the string if the failure is in
|
||
|
|
the first name/value pair) if the request was not
|
||
|
|
successful.
|
||
|
|
@param[out] Results A null-terminated Unicode string in
|
||
|
|
<ConfigAltResp> format which has all values filled
|
||
|
|
in for the names in the Request string. String to
|
||
|
|
be allocated by the called function.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The Results is filled with the requested values.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
|
||
|
|
@retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
|
||
|
|
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this
|
||
|
|
driver.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
VlanExtractConfig (
|
||
|
|
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
|
||
|
|
IN CONST EFI_STRING Request,
|
||
|
|
OUT EFI_STRING *Progress,
|
||
|
|
OUT EFI_STRING *Results
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
This function processes the results of changes in configuration.
|
||
|
|
|
||
|
|
@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
|
||
|
|
@param[in] Configuration A null-terminated Unicode string in <ConfigResp>
|
||
|
|
format.
|
||
|
|
@param[out] Progress A pointer to a string filled in with the offset of
|
||
|
|
the most recent '&' before the first failing
|
||
|
|
name/value pair (or the beginning of the string if
|
||
|
|
the failure is in the first name/value pair) or
|
||
|
|
the terminating NULL if all was successful.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The Results is processed successfully.
|
||
|
|
@retval EFI_INVALID_PARAMETER Configuration is NULL.
|
||
|
|
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this
|
||
|
|
driver.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
VlanRouteConfig (
|
||
|
|
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
|
||
|
|
IN CONST EFI_STRING Configuration,
|
||
|
|
OUT EFI_STRING *Progress
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
This function processes the results of changes in configuration.
|
||
|
|
|
||
|
|
@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
|
||
|
|
@param[in] Action Specifies the type of action taken by the browser.
|
||
|
|
@param[in] QuestionId A unique value which is sent to the original
|
||
|
|
exporting driver so that it can identify the type
|
||
|
|
of data to expect.
|
||
|
|
@param[in] Type The type of value for the question.
|
||
|
|
@param[in] Value A pointer to the data being sent to the original
|
||
|
|
exporting driver.
|
||
|
|
@param[out] ActionRequest On return, points to the action requested by the
|
||
|
|
callback function.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The callback successfully handled the action.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
|
||
|
|
variable and its data.
|
||
|
|
@retval EFI_DEVICE_ERROR The variable could not be saved.
|
||
|
|
@retval EFI_UNSUPPORTED The specified Action is not supported by the
|
||
|
|
callback.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
VlanCallback (
|
||
|
|
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
|
||
|
|
IN EFI_BROWSER_ACTION Action,
|
||
|
|
IN EFI_QUESTION_ID QuestionId,
|
||
|
|
IN UINT8 Type,
|
||
|
|
IN EFI_IFR_TYPE_VALUE *Value,
|
||
|
|
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
|
||
|
|
);
|
||
|
|
|
||
|
|
#endif
|