Add VLAN support.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9649 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xdu2
551
MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.c
Normal file
551
MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.c
Normal file
@@ -0,0 +1,551 @@
|
||||
/** @file
|
||||
HII Config Access protocol implementation of VLAN configuration module.
|
||||
|
||||
Copyright (c) 2009, Intel Corporation.<BR>
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions
|
||||
of the BSD License which accompanies this distribution. The full
|
||||
text of the license may be found at<BR>
|
||||
http://opensource.org/licenses/bsd-license.php
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
#include "VlanConfigImpl.h"
|
||||
|
||||
EFI_GUID mVlanFormSetGuid = VLAN_CONFIG_PRIVATE_GUID;
|
||||
CHAR16 mVlanStorageName[] = L"VlanNvData";
|
||||
EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting = NULL;
|
||||
|
||||
VLAN_CONFIG_PRIVATE_DATA mVlanConfigPrivateDateTemplate = {
|
||||
VLAN_CONFIG_PRIVATE_DATA_SIGNATURE,
|
||||
{
|
||||
VlanExtractConfig,
|
||||
VlanRouteConfig,
|
||||
VlanCallback
|
||||
}
|
||||
};
|
||||
|
||||
VENDOR_DEVICE_PATH mHiiVendorDevicePathNode = {
|
||||
{
|
||||
HARDWARE_DEVICE_PATH,
|
||||
HW_VENDOR_DP,
|
||||
{
|
||||
(UINT8) (sizeof (VENDOR_DEVICE_PATH)),
|
||||
(UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
|
||||
}
|
||||
},
|
||||
VLAN_CONFIG_PRIVATE_GUID
|
||||
};
|
||||
|
||||
/**
|
||||
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
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UINTN BufferSize;
|
||||
VLAN_CONFIGURATION Configuration;
|
||||
|
||||
if (Request == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
//
|
||||
// Retrieve the pointer to the UEFI HII Config Routing Protocol
|
||||
//
|
||||
if (mHiiConfigRouting == NULL) {
|
||||
gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &mHiiConfigRouting);
|
||||
}
|
||||
ASSERT (mHiiConfigRouting != NULL);
|
||||
|
||||
//
|
||||
// Convert buffer data to <ConfigResp> by helper function BlockToConfig()
|
||||
//
|
||||
ZeroMem (&Configuration, sizeof (VLAN_CONFIGURATION));
|
||||
BufferSize = sizeof (VLAN_CONFIG_PRIVATE_DATA);
|
||||
Status = mHiiConfigRouting->BlockToConfig (
|
||||
mHiiConfigRouting,
|
||||
Request,
|
||||
(UINT8 *) &Configuration,
|
||||
BufferSize,
|
||||
Results,
|
||||
Progress
|
||||
);
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
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
|
||||
)
|
||||
{
|
||||
if (Configuration == NULL || Progress == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
*Progress = Configuration;
|
||||
if (!HiiIsConfigHdrMatch (Configuration, &mVlanFormSetGuid, mVlanStorageName)) {
|
||||
return EFI_NOT_FOUND;
|
||||
}
|
||||
|
||||
*Progress = Configuration + StrLen (Configuration);
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
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
|
||||
)
|
||||
{
|
||||
VLAN_CONFIG_PRIVATE_DATA *PrivateData;
|
||||
VLAN_CONFIGURATION *Configuration;
|
||||
EFI_VLAN_CONFIG_PROTOCOL *VlanConfig;
|
||||
UINTN Index;
|
||||
EFI_HANDLE VlanHandle;
|
||||
|
||||
PrivateData = VLAN_CONFIG_PRIVATE_DATA_FROM_THIS (This);
|
||||
|
||||
if (Action == EFI_BROWSER_ACTION_FORM_OPEN) {
|
||||
//
|
||||
// On FORM_OPEN event, update current VLAN list
|
||||
//
|
||||
VlanUpdateForm (PrivateData);
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
//
|
||||
// Get Browser data
|
||||
//
|
||||
Configuration = AllocateZeroPool (sizeof (VLAN_CONFIGURATION));
|
||||
ASSERT (Configuration != NULL);
|
||||
HiiGetBrowserData (&mVlanFormSetGuid, mVlanStorageName, sizeof (VLAN_CONFIGURATION), (UINT8 *) Configuration);
|
||||
|
||||
VlanConfig = PrivateData->VlanConfig;
|
||||
|
||||
switch (QuestionId) {
|
||||
case VLAN_ADD_QUESTION_ID:
|
||||
//
|
||||
// Add a VLAN
|
||||
//
|
||||
VlanConfig->Set (VlanConfig, Configuration->VlanId, Configuration->Priority);
|
||||
VlanUpdateForm (PrivateData);
|
||||
|
||||
//
|
||||
// Connect the newly created VLAN device
|
||||
//
|
||||
VlanHandle = NetLibGetVlanHandle (PrivateData->ControllerHandle, Configuration->VlanId);
|
||||
if (VlanHandle == NULL) {
|
||||
//
|
||||
// There may be no child handle created for VLAN ID 0, connect the parent handle
|
||||
//
|
||||
VlanHandle = PrivateData->ControllerHandle;
|
||||
}
|
||||
gBS->ConnectController (VlanHandle, NULL, NULL, TRUE);
|
||||
|
||||
//
|
||||
// Clear UI data
|
||||
//
|
||||
*ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;
|
||||
Configuration->VlanId = 0;
|
||||
Configuration->Priority = 0;
|
||||
break;
|
||||
|
||||
case VLAN_REMOVE_QUESTION_ID:
|
||||
//
|
||||
// Remove VLAN
|
||||
//
|
||||
for (Index = 0; Index < PrivateData->NumberOfVlan; Index++) {
|
||||
if (Configuration->VlanList[Index] != 0) {
|
||||
//
|
||||
// Checkbox is selected, need remove this VLAN
|
||||
//
|
||||
VlanConfig->Remove (VlanConfig, PrivateData->VlanId[Index]);
|
||||
}
|
||||
}
|
||||
|
||||
VlanUpdateForm (PrivateData);
|
||||
if (PrivateData->NumberOfVlan == 0) {
|
||||
//
|
||||
// No VLAN device now, connect the physical NIC handle.
|
||||
// Note: PrivateData->NumberOfVlan has been updated by VlanUpdateForm()
|
||||
//
|
||||
gBS->ConnectController (PrivateData->ControllerHandle, NULL, NULL, TRUE);
|
||||
}
|
||||
|
||||
*ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;
|
||||
ZeroMem (Configuration->VlanList, MAX_VLAN_NUMBER);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
HiiSetBrowserData (&mVlanFormSetGuid, mVlanStorageName, sizeof (VLAN_CONFIGURATION), (UINT8 *) Configuration, NULL);
|
||||
FreePool (Configuration);
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
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
|
||||
)
|
||||
{
|
||||
EFI_VLAN_CONFIG_PROTOCOL *VlanConfig;
|
||||
UINT16 NumberOfVlan;
|
||||
UINTN Index;
|
||||
EFI_VLAN_FIND_DATA *VlanData;
|
||||
VOID *StartOpCodeHandle;
|
||||
EFI_IFR_GUID_LABEL *StartLabel;
|
||||
VOID *EndOpCodeHandle;
|
||||
EFI_IFR_GUID_LABEL *EndLabel;
|
||||
CHAR16 *String;
|
||||
CHAR16 VlanStr[30];
|
||||
CHAR16 VlanIdStr[6];
|
||||
UINTN DigitalCount;
|
||||
EFI_STRING_ID StringId;
|
||||
|
||||
//
|
||||
// Find current VLAN configuration
|
||||
//
|
||||
VlanData = NULL;
|
||||
NumberOfVlan = 0;
|
||||
VlanConfig = PrivateData->VlanConfig;
|
||||
VlanConfig->Find (VlanConfig, NULL, &NumberOfVlan, &VlanData);
|
||||
|
||||
//
|
||||
// Update VLAN configuration in PrivateData
|
||||
//
|
||||
if (NumberOfVlan > MAX_VLAN_NUMBER) {
|
||||
NumberOfVlan = MAX_VLAN_NUMBER;
|
||||
}
|
||||
PrivateData->NumberOfVlan = NumberOfVlan;
|
||||
|
||||
//
|
||||
// Init OpCode Handle
|
||||
//
|
||||
StartOpCodeHandle = HiiAllocateOpCodeHandle ();
|
||||
ASSERT (StartOpCodeHandle != NULL);
|
||||
|
||||
EndOpCodeHandle = HiiAllocateOpCodeHandle ();
|
||||
ASSERT (EndOpCodeHandle != NULL);
|
||||
|
||||
//
|
||||
// Create Hii Extend Label OpCode as the start opcode
|
||||
//
|
||||
StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
|
||||
StartOpCodeHandle,
|
||||
&gEfiIfrTianoGuid,
|
||||
NULL,
|
||||
sizeof (EFI_IFR_GUID_LABEL)
|
||||
);
|
||||
StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
|
||||
StartLabel->Number = LABEL_VLAN_LIST;
|
||||
|
||||
//
|
||||
// Create Hii Extend Label OpCode as the end opcode
|
||||
//
|
||||
EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
|
||||
EndOpCodeHandle,
|
||||
&gEfiIfrTianoGuid,
|
||||
NULL,
|
||||
sizeof (EFI_IFR_GUID_LABEL)
|
||||
);
|
||||
EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
|
||||
EndLabel->Number = LABEL_END;
|
||||
|
||||
ZeroMem (PrivateData->VlanId, MAX_VLAN_NUMBER);
|
||||
for (Index = 0; Index < NumberOfVlan; Index++) {
|
||||
String = VlanStr;
|
||||
|
||||
StrCpy (String, L" VLAN ID:");
|
||||
String += 10;
|
||||
//
|
||||
// Pad VlanId string up to 4 characters with space
|
||||
//
|
||||
DigitalCount = UnicodeValueToString (VlanIdStr, 0, VlanData[Index].VlanId, 5);
|
||||
SetMem16 (String, (4 - DigitalCount) * sizeof (CHAR16), L' ');
|
||||
StrCpy (String + 4 - DigitalCount, VlanIdStr);
|
||||
String += 4;
|
||||
|
||||
StrCpy (String, L", Priority:");
|
||||
String += 11;
|
||||
String += UnicodeValueToString (String, 0, VlanData[Index].Priority, 4);
|
||||
*String = 0;
|
||||
|
||||
StringId = HiiSetString (PrivateData->HiiHandle, 0, VlanStr, NULL);
|
||||
ASSERT (StringId != 0);
|
||||
|
||||
HiiCreateCheckBoxOpCode (
|
||||
StartOpCodeHandle,
|
||||
(EFI_QUESTION_ID) (VLAN_LIST_VAR_OFFSET + Index),
|
||||
VLAN_CONFIGURATION_VARSTORE_ID,
|
||||
(UINT16) (VLAN_LIST_VAR_OFFSET + Index),
|
||||
StringId,
|
||||
STRING_TOKEN (STR_VLAN_VLAN_LIST_HELP),
|
||||
0,
|
||||
0,
|
||||
NULL
|
||||
);
|
||||
|
||||
//
|
||||
// Save VLAN id to private data
|
||||
//
|
||||
PrivateData->VlanId[Index] = VlanData[Index].VlanId;
|
||||
}
|
||||
|
||||
HiiUpdateForm (
|
||||
PrivateData->HiiHandle, // HII handle
|
||||
&mVlanFormSetGuid, // Formset GUID
|
||||
VLAN_CONFIGURATION_FORM_ID, // Form ID
|
||||
StartOpCodeHandle, // Label for where to insert opcodes
|
||||
EndOpCodeHandle // Replace data
|
||||
);
|
||||
|
||||
HiiFreeOpCodeHandle (StartOpCodeHandle);
|
||||
HiiFreeOpCodeHandle (EndOpCodeHandle);
|
||||
|
||||
if (VlanData != NULL) {
|
||||
FreePool (VlanData);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
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
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
EFI_HII_HANDLE HiiHandle;
|
||||
EFI_HANDLE DriverHandle;
|
||||
CHAR16 Str[40];
|
||||
CHAR16 *MacString;
|
||||
EFI_DEVICE_PATH_PROTOCOL *ChildDevicePath;
|
||||
EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
|
||||
|
||||
//
|
||||
// Create child handle and install HII Config Access Protocol
|
||||
//
|
||||
ChildDevicePath = AppendDevicePathNode (
|
||||
PrivateData->ParentDevicePath,
|
||||
(CONST EFI_DEVICE_PATH_PROTOCOL *) &mHiiVendorDevicePathNode
|
||||
);
|
||||
if (ChildDevicePath == NULL) {
|
||||
return EFI_OUT_OF_RESOURCES;
|
||||
}
|
||||
PrivateData->ChildDevicePath = ChildDevicePath;
|
||||
|
||||
DriverHandle = NULL;
|
||||
ConfigAccess = &PrivateData->ConfigAccess;
|
||||
Status = gBS->InstallMultipleProtocolInterfaces (
|
||||
&DriverHandle,
|
||||
&gEfiDevicePathProtocolGuid,
|
||||
ChildDevicePath,
|
||||
&gEfiHiiConfigAccessProtocolGuid,
|
||||
ConfigAccess,
|
||||
NULL
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
return Status;
|
||||
}
|
||||
PrivateData->DriverHandle = DriverHandle;
|
||||
|
||||
//
|
||||
// Publish the HII package list
|
||||
//
|
||||
HiiHandle = HiiAddPackages (
|
||||
&mVlanFormSetGuid,
|
||||
DriverHandle,
|
||||
VlanConfigDxeStrings,
|
||||
VlanConfigBin,
|
||||
NULL
|
||||
);
|
||||
if (HiiHandle == NULL) {
|
||||
return EFI_OUT_OF_RESOURCES;
|
||||
}
|
||||
PrivateData->HiiHandle = HiiHandle;
|
||||
|
||||
//
|
||||
// Update formset title
|
||||
//
|
||||
MacString = NULL;
|
||||
Status = NetLibGetMacString (PrivateData->ControllerHandle, PrivateData->ImageHandle, &MacString);
|
||||
if (EFI_ERROR (Status)) {
|
||||
return Status;
|
||||
}
|
||||
PrivateData->MacString = MacString;
|
||||
|
||||
StrCpy (Str, L"VLAN Configuration (MAC:");
|
||||
StrCat (Str, MacString);
|
||||
StrCat (Str, L")");
|
||||
HiiSetString (
|
||||
HiiHandle,
|
||||
STRING_TOKEN (STR_VLAN_FORM_SET_TITLE),
|
||||
Str,
|
||||
NULL
|
||||
);
|
||||
|
||||
//
|
||||
// Update form title
|
||||
//
|
||||
HiiSetString (
|
||||
HiiHandle,
|
||||
STRING_TOKEN (STR_VLAN_FORM_TITLE),
|
||||
Str,
|
||||
NULL
|
||||
);
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
**/
|
||||
VOID
|
||||
UninstallVlanConfigForm (
|
||||
IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData
|
||||
)
|
||||
{
|
||||
//
|
||||
// Free MAC string
|
||||
//
|
||||
if (PrivateData->MacString != NULL) {
|
||||
FreePool (PrivateData->MacString);
|
||||
PrivateData->MacString = NULL;
|
||||
}
|
||||
|
||||
//
|
||||
// Uninstall HII package list
|
||||
//
|
||||
if (PrivateData->HiiHandle != NULL) {
|
||||
HiiRemovePackages (PrivateData->HiiHandle);
|
||||
PrivateData->HiiHandle = NULL;
|
||||
}
|
||||
|
||||
//
|
||||
// Uninstall HII Config Access Protocol
|
||||
//
|
||||
if (PrivateData->DriverHandle != NULL) {
|
||||
gBS->UninstallMultipleProtocolInterfaces (
|
||||
PrivateData->DriverHandle,
|
||||
&gEfiDevicePathProtocolGuid,
|
||||
PrivateData->ChildDevicePath,
|
||||
&gEfiHiiConfigAccessProtocolGuid,
|
||||
&PrivateData->ConfigAccess,
|
||||
NULL
|
||||
);
|
||||
PrivateData->DriverHandle = NULL;
|
||||
|
||||
if (PrivateData->ChildDevicePath != NULL) {
|
||||
FreePool (PrivateData->ChildDevicePath);
|
||||
PrivateData->ChildDevicePath = NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user