Add comments for Include header files

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / IsaAcpi.h

/** @file\r
  ISA Acpi Protocol is used to operate and communicate with ISA device.\r
\r
Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
All rights reserved. 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
\r
#ifndef __ISA_ACPI_H_\r
#define __ISA_ACPI_H_\r
\r
#define EFI_ISA_ACPI_PROTOCOL_GUID \\r
		{ 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 } }\r
\r
typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL;\r
\r
//\r
// Resource Attribute definition\r
//\r
#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_EDGE_SENSITIVE   0x01\r
#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_EDGE_SENSITIVE    0x02\r
#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_LEVEL_SENSITIVE  0x04\r
#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_LEVEL_SENSITIVE   0x08\r
\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_MASK                 0x03\r
\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_COMPATIBILITY        0x00\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_A                    0x01\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_B                    0x02\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_F                    0x03\r
#define EFI_ISA_ACPI_DMA_COUNT_BY_BYTE                   0x04\r
#define EFI_ISA_ACPI_DMA_COUNT_BY_WORD                   0x08\r
#define EFI_ISA_ACPI_DMA_BUS_MASTER                      0x10\r
#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT             0x20\r
#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT_AND_16_BIT  0x40\r
#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_16_BIT            0x80\r
\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_MASK                   0x03\r
\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT                  0x00\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_16_BIT                 0x01\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT_AND_16_BIT       0x02\r
#define EFI_ISA_ACPI_MEMORY_WRITEABLE                    0x04\r
#define EFI_ISA_ACPI_MEMORY_CACHEABLE                    0x08\r
#define EFI_ISA_ACPI_MEMORY_SHADOWABLE                   0x10\r
#define EFI_ISA_ACPI_MEMORY_EXPANSION_ROM                0x20\r
\r
#define EFI_ISA_ACPI_IO_DECODE_10_BITS                   0x01\r
#define EFI_ISA_ACPI_IO_DECODE_16_BITS                   0x02\r
\r
//\r
// Resource List definition: \r
//\r
typedef enum {\r
  EfiIsaAcpiResourceEndOfList,\r
  EfiIsaAcpiResourceIo,\r
  EfiIsaAcpiResourceMemory,\r
  EfiIsaAcpiResourceDma,\r
  EfiIsaAcpiResourceInterrupt\r
} EFI_ISA_ACPI_RESOURCE_TYPE;\r
\r
typedef struct {\r
  EFI_ISA_ACPI_RESOURCE_TYPE  Type;\r
  UINT32                      Attribute;\r
  UINT32                      StartRange;\r
  UINT32                      EndRange;\r
} EFI_ISA_ACPI_RESOURCE;\r
\r
typedef struct {\r
  UINT32                      HID;\r
  UINT32                      UID;\r
} EFI_ISA_ACPI_DEVICE_ID;\r
\r
typedef struct {\r
  EFI_ISA_ACPI_DEVICE_ID      Device;\r
  EFI_ISA_ACPI_RESOURCE       *ResourceItem;\r
} EFI_ISA_ACPI_RESOURCE_LIST;\r
\r
/**\r
  Enumerate the ISA devices on the ISA bus.\r
\r
  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
  @param  Device             Found next ISA device.\r
\r
  @retval EFI_NOT_FOUND      No device found.\r
  @retval EFI_SUCCESS        Success get the next ISA device.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_DEVICE_ENUMERATE) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This,\r
  OUT EFI_ISA_ACPI_DEVICE_ID         **Device\r
  );\r
\r
/**\r
  Set ISA device power.\r
\r
  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
  @param  Device             ISA device.\r
  @param  OnOff              Whether to set power on or off.\r
\r
  @retval EFI_SUCCESS        Successfully set ISA device.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_SET_DEVICE_POWER) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This,\r
  IN EFI_ISA_ACPI_DEVICE_ID          *Device,\r
  IN BOOLEAN                         OnOff\r
  );\r
  \r
/**\r
  Get current Resource of the specific ISA device.\r
\r
  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
  @param  Device             ISA device.\r
  @param  ResourceList       Returned resource list.\r
\r
  @retval EFI_SUCCESS        Successfully get current resource.\r
  @retval EFI_NOT_FOUND      No resource found.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_GET_CUR_RESOURCE) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This,\r
  IN EFI_ISA_ACPI_DEVICE_ID          *Device,\r
  OUT EFI_ISA_ACPI_RESOURCE_LIST     **ResourceList\r
  );\r
\r
/**\r
  Get possible resource for the specific ISA device.\r
\r
  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
  @param  Device             ISA device.\r
  @param  ResourceList       Returned resource list.\r
\r
  @retval EFI_SUCCESS        Successfully get possible resource.\r
  @retval EFI_NOT_FOUND      No resource found.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_GET_POS_RESOURCE) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This,\r
  IN EFI_ISA_ACPI_DEVICE_ID          *Device,\r
  OUT EFI_ISA_ACPI_RESOURCE_LIST     **ResourceList\r
  );\r
\r
/**\r
  Set resources for the specific ISA device.\r
\r
  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
  @param  Device             ISA device.\r
  @param  ResourceList       Resource list will be set.\r
\r
  @retval EFI_SUCCESS        Successfully set resource.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_SET_RESOURCE) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This,\r
  IN EFI_ISA_ACPI_DEVICE_ID          *Device,\r
  IN EFI_ISA_ACPI_RESOURCE_LIST      *ResourceList\r
  );    \r
\r
/**\r
  Enable or disable ISA device.\r
\r
  @param  This               Pointer of EFI_ISA_ACPI_PROTOCOL.\r
  @param  Device             ISA device.\r
  @param  Enable             Enable/Disable.\r
\r
  @retval EFI_SUCCESS        Successfully perform this action.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_ENABLE_DEVICE) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This,\r
  IN EFI_ISA_ACPI_DEVICE_ID          *Device,\r
  IN BOOLEAN                         Enable\r
  );    \r
\r
/**\r
  Init ISA device.\r
\r
  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
  @param  Device             ISA device.\r
\r
  @retval EFI_SUCCESS        Successfully initialize ISA device.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_INIT_DEVICE) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This,\r
  IN EFI_ISA_ACPI_DEVICE_ID          *Device\r
  );  \r
\r
/**\r
  ISA Interface Init.\r
\r
  @param  This               Pointer of EFI_ISA_ACPI_PROTOCOL.\r
\r
  @retval EFI_SUCCESS        Successfully initialize ISA interface.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_ISA_ACPI_INTERFACE_INIT) (\r
  IN EFI_ISA_ACPI_PROTOCOL           *This\r
  );\r
\r
//\r
// Interface structure for the ISA ACPI Protocol\r
//\r
struct _EFI_ISA_ACPI_PROTOCOL {\r
  EFI_ISA_ACPI_DEVICE_ENUMERATE     DeviceEnumerate;\r
  EFI_ISA_ACPI_SET_DEVICE_POWER     SetPower;\r
  EFI_ISA_ACPI_GET_CUR_RESOURCE     GetCurResource;\r
  EFI_ISA_ACPI_GET_POS_RESOURCE     GetPosResource;\r
  EFI_ISA_ACPI_SET_RESOURCE         SetResource;\r
  EFI_ISA_ACPI_ENABLE_DEVICE        EnableDevice;\r
  EFI_ISA_ACPI_INIT_DEVICE          InitDevice;\r
  EFI_ISA_ACPI_INTERFACE_INIT       InterfaceInit;\r
};\r
\r
extern EFI_GUID gEfiIsaAcpiProtocolGuid;\r
  \r
#endif\r