Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Framework / Ppi / Smbus2 / Smbus2.h

/*++\r
\r
Copyright (c) 2007, 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
  Smbus2.h\r
    \r
Abstract:\r
\r
  Smbus2 PPI as defined in PI 1.0\r
\r
--*/\r
\r
#ifndef _PEI_SMBUS2_PPI_H\r
#define _PEI_SMBUS2_PPI_H\r
\r
#include "EfiSmbus.h"\r
\r
#define PEI_SMBUS2_PPI_GUID \\r
  { \\r
    0x9ca93627, 0xb65b, 0x4324, {0xa2, 0x2, 0xc0, 0xb4, 0x61, 0x76, 0x45, 0x43} \\r
  }\r
\r
EFI_FORWARD_DECLARATION (EFI_PEI_SMBUS2_PPI);\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS2_PPI_EXECUTE_OPERATION) (\r
  IN CONST EFI_PEI_SMBUS2_PPI       * This,\r
  IN      EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,\r
  IN      EFI_SMBUS_DEVICE_COMMAND  Command,\r
  IN      EFI_SMBUS_OPERATION       Operation,\r
  IN      BOOLEAN                   PecCheck,\r
  IN OUT  UINTN                     *Length,\r
  IN OUT  VOID                      *Buffer\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS_NOTIFY2_FUNCTION) (\r
  IN  CONST EFI_PEI_SMBUS2_PPI          * SmbusPpi,\r
  IN      EFI_SMBUS_DEVICE_ADDRESS      SlaveAddress,\r
  IN      UINTN                         Data\r
  );\r
\r
//\r
// If ArpAll is TRUE, SmbusUdid/SlaveAddress is Optional.\r
// If FALSE, ArpDevice will enum SmbusUdid and the address will be at SlaveAddress\r
//\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS2_PPI_ARP_DEVICE) (\r
  IN CONST EFI_PEI_SMBUS2_PPI       * This,\r
  IN      BOOLEAN                   ArpAll,\r
  IN      EFI_SMBUS_UDID            * SmbusUdid, OPTIONAL\r
  IN OUT  EFI_SMBUS_DEVICE_ADDRESS  * SlaveAddress OPTIONAL\r
  );\r
\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS2_PPI_GET_ARP_MAP) (\r
  IN CONST EFI_PEI_SMBUS2_PPI       * This,\r
  IN OUT  UINTN                     *Length,\r
  IN OUT  EFI_SMBUS_DEVICE_MAP      **SmbusDeviceMap\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS2_PPI_NOTIFY) (\r
  IN CONST EFI_PEI_SMBUS2_PPI       * This,\r
  IN      EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,\r
  IN      UINTN                     Data,\r
  IN      EFI_PEI_SMBUS_NOTIFY2_FUNCTION NotifyFunction\r
  );\r
\r
struct _EFI_PEI_SMBUS2_PPI {\r
  EFI_PEI_SMBUS2_PPI_EXECUTE_OPERATION Execute;\r
  EFI_PEI_SMBUS2_PPI_ARP_DEVICE        ArpDevice;\r
  EFI_PEI_SMBUS2_PPI_GET_ARP_MAP       GetArpMap;\r
  EFI_PEI_SMBUS2_PPI_NOTIFY            Notify;\r
  EFI_GUID                             Identifier;\r
};\r
\r
extern EFI_GUID gPeiSmbus2PpiGuid;\r
\r
#endif\r