EdkCompatibilityPkg/Foundation/Efi/Protocol/AuthenticationInfo/AuthenticationInfo.h

   1 /*++
   2
   3 Copyright (c) 2008, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14     PlatformToDriverConfiguration.h
  15
  16 Abstract:
  17
  18     UEFI Authentication Info Protocol.
  19
  20 Revision History:
  21
  22 --*/
  23
  24 #ifndef _EFI_AUTHENTICATION_INFO_H_
  25 #define _EFI_AUTHENTICATION_INFO_H_
  26
  27 //
  28 // Global ID for the Authentication Info Protocol
  29 //
  30 #define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID \
  31   { \
  32     0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7} \
  33   }
  34
  35 EFI_FORWARD_DECLARATION (EFI_AUTHENTICATION_INFO_PROTOCOL);
  36
  37 typedef
  38 EFI_STATUS
  39 (EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_GET) (
  40   IN  EFI_AUTHENTICATION_INFO_PROTOCOL    *This,
  41   IN  EFI_HANDLE                          *ControllerHandle,
  42   OUT VOID                                *Buffer
  43   );
  44 /*++
  45
  46   Routine Description:
  47     Retrieves the Authentication information associated with a particular
  48     controller handle.
  49
  50   Arguments:
  51     This               - Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL instance.
  52     ControllerHandle   - Handle to the Controller.
  53     Buffer             - Pointer to the authentication information. This function
  54                          is responsible for allocating the buffer and it is the
  55                          caller's responsibility to free buffer when the caller
  56                          is finished with buffer.
  57
  58   Returns:
  59     EFI_SUCCESS        - Successfully retrieved Authentication information
  60                          for the given ControllerHandle.
  61     EFI_NOT_FOUND      - No matching Authentication information found for the
  62                          given ControllerHandle.
  63     EFI_DEVICE_ERROR   - The Authentication information could not be retrieved
  64                          due to a hardware error.
  65
  66 --*/
  67
  68 typedef
  69 EFI_STATUS
  70 (EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_SET) (
  71   IN  EFI_AUTHENTICATION_INFO_PROTOCOL    *This,
  72   IN  EFI_HANDLE                          *ControllerHandle,
  73   IN  VOID                                *Buffer
  74   );
  75 /*++
  76
  77   Routine Description:
  78     Set the Authentication information for a given controller handle.
  79
  80   Arguments:
  81     This               - Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL instance.
  82     ControllerHandle   - Handle to the Controller.
  83     Buffer             - Pointer to the authentication information.
  84
  85   Returns:
  86     EFI_SUCCESS          - Successfully set the Authentication node information
  87                            for the given ControllerHandle.
  88     EFI_UNSUPPORTED      - If the platform policies do not allow setting of the
  89                            Authentication information.
  90     EFI_DEVICE_ERROR     - The authentication node information could not be configured
  91                            due to a hardware error.
  92     EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the data.
  93
  94 --*/
  95
  96 //
  97 // Interface structure for the Authentication Info Protocol
  98 //
  99 struct _EFI_AUTHENTICATION_INFO_PROTOCOL {
 100   EFI_AUTHENTICATION_INFO_PROTOCOL_GET   Get;
 101   EFI_AUTHENTICATION_INFO_PROTOCOL_SET   Set;
 102 };
 103
 104 extern EFI_GUID gEfiAuthenticationInfoProtocolGuid;
 105
 106 #endif