EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index

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

Go to the documentation of this file.
00001 /*++
00002 
00003 Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>
00004 This program and the accompanying materials
00005 are licensed and made available under the terms and conditions of the BSD License
00006 which accompanies this distribution.  The full text of the license may be found at
00007 http://opensource.org/licenses/bsd-license.php
00008 
00009 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
00010 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
00011 
00012 Module Name:
00013 
00014     PlatformToDriverConfiguration.h
00015 
00016 Abstract:
00017 
00018     UEFI Authentication Info Protocol.
00019 
00020 Revision History:
00021 
00022 --*/
00023 
00024 #ifndef _EFI_AUTHENTICATION_INFO_H_
00025 #define _EFI_AUTHENTICATION_INFO_H_
00026 
00027 //
00028 // Global ID for the Authentication Info Protocol
00029 //
00030 #define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID \
00031   { \
00032     0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7} \
00033   }
00034 
00035 EFI_FORWARD_DECLARATION (EFI_AUTHENTICATION_INFO_PROTOCOL);
00036 
00037 typedef
00038 EFI_STATUS
00039 (EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_GET) (
00040   IN  EFI_AUTHENTICATION_INFO_PROTOCOL    *This,
00041   IN  EFI_HANDLE                          ControllerHandle,
00042   OUT VOID                                **Buffer
00043   );
00044 /*++
00045 
00046   Routine Description:
00047     Retrieves the Authentication information associated with a particular
00048     controller handle.
00049 
00050   Arguments:
00051     This               - Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL instance.
00052     ControllerHandle   - Handle to the Controller.
00053     Buffer             - Pointer to the authentication information. This function
00054                          is responsible for allocating the buffer and it is the
00055                          caller's responsibility to free buffer when the caller
00056                          is finished with buffer.
00057 
00058   Returns:
00059     EFI_SUCCESS        - Successfully retrieved Authentication information
00060                          for the given ControllerHandle.
00061     EFI_NOT_FOUND      - No matching Authentication information found for the
00062                          given ControllerHandle.
00063     EFI_DEVICE_ERROR   - The Authentication information could not be retrieved
00064                          due to a hardware error.
00065 
00066 --*/
00067 
00068 typedef
00069 EFI_STATUS
00070 (EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_SET) (
00071   IN  EFI_AUTHENTICATION_INFO_PROTOCOL    *This,
00072   IN  EFI_HANDLE                          ControllerHandle,
00073   IN  VOID                                *Buffer
00074   );
00075 /*++
00076 
00077   Routine Description:
00078     Set the Authentication information for a given controller handle.
00079 
00080   Arguments:
00081     This               - Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL instance.
00082     ControllerHandle   - Handle to the Controller.
00083     Buffer             - Pointer to the authentication information.
00084 
00085   Returns:
00086     EFI_SUCCESS          - Successfully set the Authentication node information
00087                            for the given ControllerHandle.
00088     EFI_UNSUPPORTED      - If the platform policies do not allow setting of the
00089                            Authentication information.
00090     EFI_DEVICE_ERROR     - The authentication node information could not be configured
00091                            due to a hardware error.
00092     EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the data.
00093 
00094 --*/
00095 
00096 //
00097 // Interface structure for the Authentication Info Protocol
00098 //
00099 struct _EFI_AUTHENTICATION_INFO_PROTOCOL {
00100   EFI_AUTHENTICATION_INFO_PROTOCOL_GET   Get;
00101   EFI_AUTHENTICATION_INFO_PROTOCOL_SET   Set;
00102 };
00103 
00104 extern EFI_GUID gEfiAuthenticationInfoProtocolGuid;
00105 
00106 #endif
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines