+++ /dev/null
-/*++\r
-\r
-Copyright (c) 2008-2013, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
- PlatformToDriverConfiguration.h\r
-\r
-Abstract:\r
-\r
- UEFI Platform to Driver Configuration Protocol\r
-\r
-Revision History:\r
-\r
---*/\r
-\r
-#ifndef _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_H_\r
-#define _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_H_\r
-\r
-//\r
-// Global ID for the Platform to Driver Configuration Protocol\r
-//\r
-#define EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL_GUID \\r
- { \\r
- 0x642cd590, 0x8059, 0x4c0a, {0xa9, 0x58, 0xc5, 0xec, 0x07, 0xd2, 0x3c, 0x4b} \\r
- }\r
-\r
-#define EFI_PLATFORM_TO_DRIVER_CONFIGURATION_CLP_GUID \\r
- { \\r
- 0x345ecc0e, 0x0cb6, 0x4b75, {0xbb, 0x57, 0x1b, 0x12, 0x9c, 0x47, 0x33, 0x3e} \\r
- }\r
-\r
-EFI_FORWARD_DECLARATION (EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL);\r
-\r
-typedef enum {\r
- EfiPlatformConfigurationActionNone = 0,\r
- EfiPlatformConfigurationActionStopController = 1,\r
- EfiPlatformConfigurationActionRestartController = 2,\r
- EfiPlatformConfigurationActionRestartPlatform = 3,\r
- EfiPlatformConfigurationActionNvramFailed = 4,\r
- EfiPlatformConfigurationActionMaximum\r
-} EFI_PLATFORM_CONFIGURATION_ACTION;\r
-\r
-typedef struct {\r
- CHAR8 *CLPCommand;\r
- UINT32 CLPCommandLength;\r
- CHAR8 *CLPReturnString;\r
- UINT32 CLPReturnStringLength;\r
- UINT8 CLPCmdStatus;\r
- UINT8 CLPErrorValue;\r
- UINT16 CLPMsgCode;\r
-} EFI_CONFIGURE_CLP_PARAMETER_BLK;\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY) (\r
- IN EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL *This,\r
- IN EFI_HANDLE ControllerHandle,\r
- IN EFI_HANDLE ChildHandle, OPTIONAL\r
- IN UINTN *Instance,\r
- OUT EFI_GUID **ParameterTypeGuid,\r
- OUT VOID **ParameterBlock,\r
- OUT UINTN *ParameterBlockSize\r
- );\r
-/*++\r
-\r
- Routine Description:\r
- Allows the UEFI driver to query the platform for configuration information\r
- needed to complete the drivers Start() operation.\r
-\r
- Arguments:\r
- This - A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
- ControllerHandle - The handle the platform will return configuration\r
- information about.\r
- ChildHandle - The handle of the child controller to set options on.\r
- This is an optional parameter that may be NULL. It will\r
- be NULL for device drivers, and for a bus drivers that\r
- wish to set options for the bus controller. It will not\r
- be NULL for a bus driver that wishes to set options for\r
- one of its child controllers.\r
- Instance - Pointer to the Instance value. Zero means return the first\r
- query data. The caller should increment this value by one\r
- each time to retrieve successive data.\r
- ParameterTypeGuid - An EFI_GUID that defines the contents of ParameterBlock.\r
- UEFI drivers must use the ParameterTypeGuid to determine\r
- how to parse the ParameterBlock. The caller should not\r
- attempt to free ParameterTypeGuid.\r
- ParameterBlock - The platform returns a pointer to the ParameterBlock\r
- structure which contains details about the configuration\r
- parameters specific to the ParameterTypeGuid. This structure\r
- is defined based on the protocol and may be different for\r
- different protocols. UEFI driver decodes this structure\r
- and its contents based on ParameterTypeGuid. ParameterBlock\r
- is allocated by the platform and the platform is responsible\r
- for freeing the ParameterBlock after Response is called.\r
- ParameterBlockSize - The platform returns the size of the ParameterBlock in bytes.\r
-\r
- Returns:\r
- EFI_SUCCESS - The platform return parameter information for ControllerHandle.\r
- EFI_NOT_FOUND - No more unread Instance exists.\r
- EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
- EFI_INVALID_PARAMETER - Instance is NULL.\r
- EFI_DEVICE_ERROR - A device error occurred while attempting to return\r
- parameter block information for the controller specified\r
- by ControllerHandle and ChildHandle.\r
- EFI_OUT_RESOURCES - There are not enough resources available to set the\r
- configuration options for the controller specified\r
- by ControllerHandle and ChildHandle.\r
-\r
---*/\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE) (\r
- IN EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL *This,\r
- IN EFI_HANDLE ControllerHandle,\r
- IN EFI_HANDLE ChildHandle OPTIONAL,\r
- IN UINTN *Instance,\r
- IN EFI_GUID *ParameterTypeGuid,\r
- IN VOID *ParameterBlock,\r
- IN UINTN ParameterBlockSize ,\r
- IN EFI_PLATFORM_CONFIGURATION_ACTION ConfigurationAction\r
- );\r
-/*++\r
-\r
- Routine Description:\r
- Tell the platform what actions where taken by the driver after processing\r
- the data returned from Query.\r
-\r
- Arguments:\r
- This - A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
- ControllerHandle - The handle the platform will return configuration\r
- information about.\r
- ChildHandle - The handle of the child controller to set options on.\r
- This is an optional parameter that may be NULL. It will\r
- be NULL for device drivers, and for a bus drivers that\r
- wish to set options for the bus controller. It will not\r
- be NULL for a bus driver that wishes to set options for\r
- one of its child controllers.\r
- Instance - Instance data returned from Query.\r
- ParameterTypeGuid - ParameterTypeGuid returned from Query.\r
- ParameterBlock - ParameterBlock returned from Query.\r
- ParameterBlockSize - The ParameterBlock size returned from Query.\r
- ConfigurationAction- The driver tells the platform what action is required\r
- for ParameterBlock to take effect.\r
-\r
- Returns:\r
- EFI_SUCCESS - The platform return parameter information for ControllerHandle.\r
- EFI_NOT_FOUND - Instance was not found.\r
- EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
- EFI_INVALID_PARAMETER - Instance is zero.\r
-\r
---*/\r
-\r
-//\r
-// Interface structure for the Platform to Driver Configuration Protocol\r
-//\r
-struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY Query;\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE Response;\r
-};\r
-\r
-extern EFI_GUID gEfiPlatformToDriverConfigurationProtocolGuid;\r
-extern EFI_GUID gEfiPlatformToDriverConfigurationClpGuid;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff