Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Framework / Protocol / SmmGpiDispatch / SmmGpiDispatch.h

/*++\r
\r
Copyright (c) 1999 - 2002, 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
\r
Module Name:\r
\r
    SmmGpiDispatch.h\r
\r
Abstract:\r
\r
    EFI Smm Gpi Smi Child Protocol\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _EFI_SMM_GPI_DISPATCH_H_\r
#define _EFI_SMM_GPI_DISPATCH_H_\r
\r
//\r
// Global ID for the GPI SMI Protocol\r
//\r
#define EFI_SMM_GPI_DISPATCH_PROTOCOL_GUID \\r
  { \\r
    0xe0744b81, 0x9513, 0x49cd, {0x8c, 0xea, 0xe9, 0x24, 0x5e, 0x70, 0x39, 0xda} \\r
  }\r
\r
EFI_FORWARD_DECLARATION (EFI_SMM_GPI_DISPATCH_PROTOCOL);\r
\r
//\r
// Related Definitions\r
//\r
//\r
// GpiMask is a bit mask of 32 possible general purpose inputs that can generate a\r
// a SMI.  Bit 0 corresponds to logical GPI[0], 1 corresponds to logical GPI[1], etc.\r
//\r
// The logical GPI index to physical pin on device is described by the GPI device name\r
// found on the same handle as the GpiSmi child dispatch protocol.  The GPI device name\r
// is defined as protocol with a GUID name and NULL protocol pointer.\r
//\r
typedef struct {\r
  UINTN GpiNum;\r
} EFI_SMM_GPI_DISPATCH_CONTEXT;\r
\r
//\r
// Member functions\r
//\r
typedef\r
VOID\r
(EFIAPI *EFI_SMM_GPI_DISPATCH) (\r
  IN  EFI_HANDLE                    DispatchHandle,\r
  IN  EFI_SMM_GPI_DISPATCH_CONTEXT  * DispatchContext\r
  );\r
\r
/*++\r
\r
  Routine Description:\r
    Dispatch function for a GPI SMI handler.\r
\r
  Arguments:\r
    DispatchHandle      - Handle of this dispatch function.\r
    DispatchContext     - Pointer to the dispatch function's context.\r
                          The DispatchContext fields are filled in\r
                          by the dispatching driver prior to\r
                          invoking this dispatch function.\r
\r
  Returns:\r
    Nothing\r
\r
--*/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_GPI_REGISTER) (\r
  IN EFI_SMM_GPI_DISPATCH_PROTOCOL            * This,\r
  IN  EFI_SMM_GPI_DISPATCH                    DispatchFunction,\r
  IN  EFI_SMM_GPI_DISPATCH_CONTEXT            * DispatchContext,\r
  OUT EFI_HANDLE                              * DispatchHandle\r
  );\r
\r
/*++\r
\r
  Routine Description:\r
    Register a child SMI source dispatch function with a parent SMM driver\r
\r
  Arguments:\r
    This                  - Protocol instance pointer.\r
    DispatchFunction      - Pointer to dispatch function to be invoked for\r
                            this SMI source\r
    DispatchContext       - Pointer to the dispatch function's context.\r
                            The caller fills this context in before calling\r
                            the register function to indicate to the register\r
                            function the GPI(s) for which the dispatch function\r
                            should be invoked.\r
    DispatchHandle        - Handle of dispatch function, for when interfacing\r
                            with the parent Sx state SMM driver.\r
\r
  Returns:\r
    EFI_SUCCESS           - The dispatch function has been successfully\r
                            registered and the SMI source has been enabled.\r
    EFI_DEVICE_ERROR      - The driver was unable to enable the SMI source.\r
    EFI_OUT_OF_RESOURCES  - Not enough memory (system or SMM) to manage this\r
                            child.\r
    EFI_INVALID_PARAMETER - DispatchContext is invalid. The GPI input value\r
                            is not within valid range.\r
\r
--*/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_GPI_UNREGISTER) (\r
  IN EFI_SMM_GPI_DISPATCH_PROTOCOL            * This,\r
  IN  EFI_HANDLE                              DispatchHandle\r
  );\r
\r
/*++\r
\r
  Routine Description:\r
    Unregister a child SMI source dispatch function with a parent SMM driver\r
\r
  Arguments:\r
    This                  - Protocol instance pointer.\r
    DispatchHandle        - Handle of dispatch function to deregister.\r
\r
  Returns:\r
    EFI_SUCCESS           - The dispatch function has been successfully \r
                            unregistered and the SMI source has been disabled\r
                            if there are no other registered child dispatch\r
                            functions for this SMI source.\r
    EFI_INVALID_PARAMETER - Handle is invalid.\r
    other                 - TBD\r
\r
--*/\r
\r
//\r
// Interface structure for the SMM GPI SMI Dispatch Protocol\r
//\r
struct _EFI_SMM_GPI_DISPATCH_PROTOCOL {\r
  EFI_SMM_GPI_REGISTER    Register;\r
  EFI_SMM_GPI_UNREGISTER  UnRegister;\r
  UINTN                   NumSupportedGpis;\r
};\r
\r
extern EFI_GUID gEfiSmmGpiDispatchProtocolGuid;\r
\r
#endif\r