Update prototype name of Get()/Set() to EFI_AUTHENTICATION_INFO_PROTOCOL_GET/ EFI_AUT...

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Efi / Protocol / AuthenticationInfo / AuthenticationInfo.h

/*++\r
\r
Copyright (c) 2008 - 2011, 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 Authentication Info Protocol.\r
\r
Revision History:\r
\r
--*/\r
\r
#ifndef _EFI_AUTHENTICATION_INFO_H_\r
#define _EFI_AUTHENTICATION_INFO_H_\r
\r
//\r
// Global ID for the Authentication Info Protocol\r
//\r
#define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID \\r
  { \\r
    0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7} \\r
  }\r
\r
EFI_FORWARD_DECLARATION (EFI_AUTHENTICATION_INFO_PROTOCOL);\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_GET) (\r
  IN  EFI_AUTHENTICATION_INFO_PROTOCOL    *This,\r
  IN  EFI_HANDLE                          ControllerHandle,\r
  OUT VOID                                **Buffer\r
  );\r
/*++\r
\r
  Routine Description:\r
    Retrieves the Authentication information associated with a particular\r
    controller handle.\r
\r
  Arguments:\r
    This               - Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL instance.\r
    ControllerHandle   - Handle to the Controller.\r
    Buffer             - Pointer to the authentication information. This function\r
                         is responsible for allocating the buffer and it is the\r
                         caller's responsibility to free buffer when the caller\r
                         is finished with buffer.\r
\r
  Returns:\r
    EFI_SUCCESS        - Successfully retrieved Authentication information\r
                         for the given ControllerHandle.\r
    EFI_NOT_FOUND      - No matching Authentication information found for the\r
                         given ControllerHandle.\r
    EFI_DEVICE_ERROR   - The Authentication information could not be retrieved\r
                         due to a hardware error.\r
\r
--*/\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_SET) (\r
  IN  EFI_AUTHENTICATION_INFO_PROTOCOL    *This,\r
  IN  EFI_HANDLE                          ControllerHandle,\r
  IN  VOID                                *Buffer\r
  );\r
/*++\r
\r
  Routine Description:\r
    Set the Authentication information for a given controller handle.\r
\r
  Arguments:\r
    This               - Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL instance.\r
    ControllerHandle   - Handle to the Controller.\r
    Buffer             - Pointer to the authentication information.\r
\r
  Returns:\r
    EFI_SUCCESS          - Successfully set the Authentication node information\r
                           for the given ControllerHandle.\r
    EFI_UNSUPPORTED      - If the platform policies do not allow setting of the\r
                           Authentication information.\r
    EFI_DEVICE_ERROR     - The authentication node information could not be configured\r
                           due to a hardware error.\r
    EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the data.\r
\r
--*/\r
\r
//\r
// Interface structure for the Authentication Info Protocol\r
//\r
struct _EFI_AUTHENTICATION_INFO_PROTOCOL {\r
  EFI_AUTHENTICATION_INFO_PROTOCOL_GET   Get;\r
  EFI_AUTHENTICATION_INFO_PROTOCOL_SET   Set;\r
};\r
\r
extern EFI_GUID gEfiAuthenticationInfoProtocolGuid;\r
\r
#endif\r