/** @file | |
The device manager reference implement | |
Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR> | |
SPDX-License-Identifier: BSD-2-Clause-Patent | |
**/ | |
#ifndef _DEVICE_MANAGER_H_ | |
#define _DEVICE_MANAGER_H_ | |
#include <Guid/MdeModuleHii.h> | |
#include <Guid/HiiPlatformSetupFormset.h> | |
#include <Protocol/HiiConfigAccess.h> | |
#include <Protocol/PciIo.h> | |
#include <Library/PrintLib.h> | |
#include <Library/DebugLib.h> | |
#include <Library/BaseMemoryLib.h> | |
#include <Library/UefiBootServicesTableLib.h> | |
#include <Library/MemoryAllocationLib.h> | |
#include <Library/BaseLib.h> | |
#include <Library/HiiLib.h> | |
#include <Library/DevicePathLib.h> | |
#include <Library/UefiBootManagerLib.h> | |
#include <Library/UefiHiiServicesLib.h> | |
// | |
// These are defined as the same with vfr file | |
// | |
#define DEVICE_MANAGER_FORMSET_GUID \ | |
{ \ | |
0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27} \ | |
} | |
#define LABEL_END 0xffff | |
#define LABEL_FORM_ID_OFFSET 0x0100 | |
#define DEVICE_MANAGER_FORM_ID 0x1000 | |
#define NETWORK_DEVICE_LIST_FORM_ID 0x1001 | |
#define NETWORK_DEVICE_FORM_ID 0x1002 | |
#define DEVICE_KEY_OFFSET 0x4000 | |
#define NETWORK_DEVICE_LIST_KEY_OFFSET 0x2000 | |
#define MAX_KEY_SECTION_LEN 0x1000 | |
#define QUESTION_NETWORK_DEVICE_ID 0x3FFF | |
// | |
// These are the VFR compiler generated data representing our VFR data. | |
// | |
extern UINT8 DeviceManagerVfrBin[]; | |
#define DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('D', 'M', 'C', 'B') | |
/// | |
/// HII specific Vendor Device Path definition. | |
/// | |
typedef struct { | |
VENDOR_DEVICE_PATH VendorDevicePath; | |
EFI_DEVICE_PATH_PROTOCOL End; | |
} HII_VENDOR_DEVICE_PATH; | |
typedef struct { | |
UINTN Signature; | |
/// | |
/// Device Manager HII relative handles | |
/// | |
EFI_HII_HANDLE HiiHandle; | |
EFI_HANDLE DriverHandle; | |
/// | |
/// Device Manager Produced protocols | |
/// | |
EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess; | |
/// | |
/// Configuration data | |
/// | |
UINT8 VideoBios; | |
} DEVICE_MANAGER_CALLBACK_DATA; | |
typedef struct { | |
EFI_STRING_ID PromptId; | |
EFI_QUESTION_ID QuestionId; | |
} MENU_INFO_ITEM; | |
typedef struct { | |
UINTN CurListLen; | |
UINTN MaxListLen; | |
MENU_INFO_ITEM *NodeList; | |
} MAC_ADDRESS_NODE_LIST; | |
#define DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS(a) \ | |
CR (a, \ | |
DEVICE_MANAGER_CALLBACK_DATA, \ | |
ConfigAccess, \ | |
DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE \ | |
) | |
typedef struct { | |
EFI_STRING_ID StringId; | |
UINT16 Class; | |
} DEVICE_MANAGER_MENU_ITEM; | |
/** | |
This function allows a caller to extract the current configuration for one | |
or more named elements from the target driver. | |
@param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. | |
@param Request A null-terminated Unicode string in <ConfigRequest> format. | |
@param 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 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 illegal syntax, or unknown name. | |
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
DeviceManagerExtractConfig ( | |
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 This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. | |
@param Configuration A null-terminated Unicode string in <ConfigResp> format. | |
@param 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 | |
DeviceManagerRouteConfig ( | |
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, | |
IN CONST EFI_STRING Configuration, | |
OUT EFI_STRING *Progress | |
); | |
/** | |
This function is invoked if user selected a interactive opcode from Device Manager's | |
Formset. If user set VBIOS, the new value is saved to EFI variable. | |
@param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. | |
@param Action Specifies the type of action taken by the browser. | |
@param QuestionId A unique value which is sent to the original exporting driver | |
so that it can identify the type of data to expect. | |
@param Type The type of value for the question. | |
@param Value A pointer to the data being sent to the original exporting driver. | |
@param ActionRequest On return, points to the action requested by the callback function. | |
@retval EFI_SUCCESS The callback successfully handled the action. | |
@retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
DeviceManagerCallback ( | |
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 |