DeviceManager.h File Reference

#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>

Go to the source code of this file.

Data Structures
struct	HII_VENDOR_DEVICE_PATH
struct	DEVICE_MANAGER_CALLBACK_DATA
struct	MENU_INFO_ITEM
struct	MAC_ADDRESS_NODE_LIST
struct	DEVICE_MANAGER_MENU_ITEM

Macros
#define	DEVICE_MANAGER_FORMSET_GUID
#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
#define	DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE   SIGNATURE_32 ('D', 'M', 'C', 'B')
#define	DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS(a)

Functions
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)
EFI_STATUS EFIAPI	DeviceManagerRouteConfig (IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, IN CONST EFI_STRING Configuration, OUT EFI_STRING *Progress)
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)

Variables
UINT8	DeviceManagerVfrBin []

Detailed Description

The device manager reference implement

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

Definition in file DeviceManager.h.

Macro Definition Documentation

DEVICE_KEY_OFFSET

#define DEVICE_KEY_OFFSET   0x4000

Definition at line 43 of file DeviceManager.h.

DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS

#define DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS

(

a

)

Value:

  CR (a, \
      DEVICE_MANAGER_CALLBACK_DATA, \
      ConfigAccess, \
      DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE \
      )

Definition at line 96 of file DeviceManager.h.

DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE

#define DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE   SIGNATURE_32 ('D', 'M', 'C', 'B')

Definition at line 54 of file DeviceManager.h.

DEVICE_MANAGER_FORM_ID

#define DEVICE_MANAGER_FORM_ID   0x1000

Definition at line 40 of file DeviceManager.h.

DEVICE_MANAGER_FORMSET_GUID

#define DEVICE_MANAGER_FORMSET_GUID

Value:

  { \
  0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27} \
  }

Definition at line 32 of file DeviceManager.h.

LABEL_END

#define LABEL_END   0xffff

Definition at line 37 of file DeviceManager.h.

LABEL_FORM_ID_OFFSET

#define LABEL_FORM_ID_OFFSET   0x0100

Definition at line 38 of file DeviceManager.h.

MAX_KEY_SECTION_LEN

#define MAX_KEY_SECTION_LEN   0x1000

Definition at line 46 of file DeviceManager.h.

NETWORK_DEVICE_FORM_ID

#define NETWORK_DEVICE_FORM_ID   0x1002

Definition at line 42 of file DeviceManager.h.

NETWORK_DEVICE_LIST_FORM_ID

#define NETWORK_DEVICE_LIST_FORM_ID   0x1001

Definition at line 41 of file DeviceManager.h.

NETWORK_DEVICE_LIST_KEY_OFFSET

#define NETWORK_DEVICE_LIST_KEY_OFFSET   0x2000

Definition at line 44 of file DeviceManager.h.

QUESTION_NETWORK_DEVICE_ID

#define QUESTION_NETWORK_DEVICE_ID   0x3FFF

Definition at line 48 of file DeviceManager.h.

Function Documentation

DeviceManagerCallback()

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
	)

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.

Parameters

This	Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
Action	Specifies the type of action taken by the browser.
QuestionId	A unique value which is sent to the original exporting driver so that it can identify the type of data to expect.
Type	The type of value for the question.
Value	A pointer to the data being sent to the original exporting driver.
ActionRequest	On return, points to the action requested by the callback function.

Return values

EFI_SUCCESS	The callback successfully handled the action.
EFI_INVALID_PARAMETER	The setup browser call this function with invalid parameters.

Definition at line 840 of file DeviceManager.c.

DeviceManagerExtractConfig()

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 allows a caller to extract the current configuration for one or more named elements from the target driver.

Parameters

This	Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
Request	A null-terminated Unicode string in <ConfigRequest> format.
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.
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.

Return values

EFI_SUCCESS	The Results is filled with the requested values.
EFI_OUT_OF_RESOURCES	Not enough memory to store the results.
EFI_INVALID_PARAMETER	Request is illegal syntax, or unknown name.
EFI_NOT_FOUND	Routing data doesn't match any storage in this driver.

Definition at line 775 of file DeviceManager.c.

DeviceManagerRouteConfig()

EFI_STATUS EFIAPI DeviceManagerRouteConfig	(	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.

Parameters

This	Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
Configuration	A null-terminated Unicode string in <ConfigResp> format.
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.

Return values

EFI_SUCCESS	The Results is processed successfully.
EFI_INVALID_PARAMETER	Configuration is NULL.
EFI_NOT_FOUND	Routing data doesn't match any storage in this driver.

Definition at line 807 of file DeviceManager.c.