Committing changes to the comments, to improve code documentation.

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

/** @file\r
  EFI ISA ACPI Protocol is used to enumerate and manage all the ISA controllers on\r
  the platform's ISA Bus.\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
///\r
/// Global ID for the EFI ISA ACPI Protocol\r
///\r
#define EFI_ISA_ACPI_PROTOCOL_GUID \\r
  { \\r
    0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 } \\r
  }\r
\r
///\r
/// Forward declaration fo the EFI ISA ACPI Protocol\r
///\r
typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL;\r
\r
///\r
/// ISA ACPI Protocol interrupt resource attributes\r
///\r
#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_EDGE_SENSITIVE   0x01   ///< Edge triggered interrupt on a rising edge\r
#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_EDGE_SENSITIVE    0x02   ///< Edge triggered interrupt on a falling edge\r
#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_LEVEL_SENSITIVE  0x04   ///< Level sensitive interrupt active high\r
#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_LEVEL_SENSITIVE   0x08   ///< Level sensitive interrupt active low\r
\r
///\r
/// ISA ACPI Protocol DMA resource attributes\r
///\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_MASK                 0x03   ///< Bit mask of supported DMA speed attributes\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_COMPATIBILITY        0x00   ///< ISA controller supports compatibility mode DMA transfers\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_A                    0x01   ///< ISA controller supports type A DMA transfers \r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_B                    0x02   ///< ISA controller supports type B DMA transfers\r
#define EFI_ISA_ACPI_DMA_SPEED_TYPE_F                    0x03   ///< ISA controller supports type F DMA transfers\r
#define EFI_ISA_ACPI_DMA_COUNT_BY_BYTE                   0x04   ///< ISA controller increments DMA address by bytes (8-bit)\r
#define EFI_ISA_ACPI_DMA_COUNT_BY_WORD                   0x08   ///< ISA controller increments DMA address by words (16-bit)\r
#define EFI_ISA_ACPI_DMA_BUS_MASTER                      0x10   ///< ISA controller is a DMA bus master\r
#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT             0x20   ///< ISA controller only supports 8-bit DMA transfers\r
#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT_AND_16_BIT  0x40   ///< ISA controller both 8-bit and 16-bit DMA transfers\r
#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_16_BIT            0x80   ///< ISA controller only supports 16-bit DMA transfers\r
\r
///\r
/// ISA ACPI Protocol MMIO resource attributes\r
///\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_MASK                   0x03   ///< Bit mask of supported ISA memory width attributes\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT                  0x00   ///< ISA MMIO region only supports 8-bit access\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_16_BIT                 0x01   ///< ISA MMIO region only supports 16-bit access\r
#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT_AND_16_BIT       0x02   ///< ISA MMIO region supports both 8-bit and 16-bit access \r
#define EFI_ISA_ACPI_MEMORY_WRITEABLE                    0x04   ///< ISA MMIO region supports write transactions\r
#define EFI_ISA_ACPI_MEMORY_CACHEABLE                    0x08   ///< ISA MMIO region supports being cached\r
#define EFI_ISA_ACPI_MEMORY_SHADOWABLE                   0x10   ///< ISA MMIO region may be shadowed\r
#define EFI_ISA_ACPI_MEMORY_EXPANSION_ROM                0x20   ///< ISA MMIO region is an expansion ROM\r
\r
///\r
/// ISA ACPI Protocol I/O resource attributes\r
///\r
#define EFI_ISA_ACPI_IO_DECODE_10_BITS                   0x01    ///< ISA controllers uses a 10-bit address decoder for I/O cycles\r
#define EFI_ISA_ACPI_IO_DECODE_16_BITS                   0x02    ///< ISA controllers uses a 16-bit address decoder for I/O cycles\r
\r
///\r
/// EFI ISA ACPI resource type \r
///\r
typedef enum {\r
  EfiIsaAcpiResourceEndOfList,    ///< Marks the end if a resource list\r
  EfiIsaAcpiResourceIo,           ///< ISA I/O port resource range\r
  EfiIsaAcpiResourceMemory,       ///< ISA MMIO resource range \r
  EfiIsaAcpiResourceDma,          ///< ISA DMA resource \r
  EfiIsaAcpiResourceInterrupt     ///< ISA interrupt resource\r
} EFI_ISA_ACPI_RESOURCE_TYPE;\r
\r
///\r
/// EFI ISA ACPI generic resource structure\r
///\r
typedef struct {\r
  EFI_ISA_ACPI_RESOURCE_TYPE  Type;         ///< The type of resource (I/O, MMIO, DMA, Interrupt)\r
  UINT32                      Attribute;    ///< Bit mask of attributes associated with this resource.  See EFI_ISA_ACPI_xxx macros for valid combinations.\r
  UINT32                      StartRange;   ///< The start of the resource range\r
  UINT32                      EndRange;     ///< The end of the resource range\r
} EFI_ISA_ACPI_RESOURCE;\r
\r
///\r
/// EFI ISA ACPI resource device identifier\r
///\r
typedef struct {\r
  UINT32  HID;   ///< The ACPI Hardware Identifier value associated with an ISA controller.  Matchs ACPI DSDT contents.\r
  UINT32  UID;   ///< The ACPI Unique Identifier value associated with an ISA controller.  Matches ACPI DSDT contents.\r
} EFI_ISA_ACPI_DEVICE_ID;\r
\r
///\r
/// EFI ISA ACPI resource list\r
///\r
typedef struct {\r
  EFI_ISA_ACPI_DEVICE_ID  Device;          ///< The ACPI HID/UID associated with an ISA controller\r
  EFI_ISA_ACPI_RESOURCE   *ResourceItem;   ///< Pointer to the list of resources associated with an ISA controller\r
} EFI_ISA_ACPI_RESOURCE_LIST;\r
\r
/**\r
  Enumerates the ISA controllers on an ISA bus.\r
\r
  This service allows all the ISA controllers on an ISA bus to be enumerated.  If\r
  Device is a pointer to a NULL value, then the first ISA controller on the ISA\r
  bus is returned in Device and EFI_SUCESS is returned.  If Device is a pointer \r
  to value that was returned on a prior call to DeviceEnumerate(), then the next \r
  ISA controller on the ISA bus is returned in Device and EFI_SUCCESS is returned.\r
  If Device is a pointer to the last ISA controller on the ISA bus, then \r
  EFI_NOT_FOUND is returned.\r
\r
  @param[in]  This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
  @param[out] Device   Pointer to an ISA controller named by ACPI HID/UID.\r
\r
  @retval EFI_SUCCESS    The next ISA controller on the ISA bus was returned.\r
  @retval EFI_NOT_FOUND  No device found.\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
  Sets the power state of an ISA controller.\r
\r
  This services sets the power state of the ISA controller specified by Device to \r
  the power state specified by OnOff.  If OnOff is TRUE, then power is applied to \r
  the ISA controller.  If OnOff is FALSE, then power is remobed from the ISA \r
  controller.  If the power state is sucessfully set on the ISA Controller, then\r
  EFI_SUCCESS is returned.\r
\r
  @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
  @param[in] Device   Pointer to an ISA controller named by ACPI HID/UID.\r
  @param[in] OnOff    TRUE to apply power to the ISA controller.  FALSE to remove\r
                      power from the ISA controller.\r
\r
  @retval EFI_SUCCESS   Successfully set the power state of the ISA controller.\r
  @retval Other         The ISA controller cound not be placed in the requested power state.\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
  Retrieves the current set of resource associated with an ISA controller.\r
\r
  Retrieves the set of I/O, MMIO, DMA, and interrupt resources currently \r
  assigned to the ISA controller specified by Device.  These resources\r
  are returned in ResourceList.\r
\r
  @param[in]  This          Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
  @param[in]  Device        Pointer to an ISA controller named by ACPI HID/UID.\r
  @param[out] ResourceList  Pointer to the current resource list for Device.\r
\r
  @retval EFI_SUCCESS    Successfully retrieved the current resource list.\r
  @retval EFI_NOT_FOUND  The resource list could not be retrieved.\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
  Retrieves the set of possible resources that may be assigned to an ISA controller\r
  with SetResource().\r
\r
  Retrieves the possible sets of I/O, MMIO, DMA, and interrupt resources for the\r
  ISA controller specified by Device.  The sets are returned in ResourceList.\r
\r
  @param[in]  This           Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
  @param[in]  Device         Pointer to an ISA controller named by ACPI HID/UID.\r
  @param[out] ResourceList   Pointer to the returned list of resource lists.\r
\r
  @retval EFI_UNSUPPORTED  This services is not supported.\r
\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
  Assigns resources to an ISA controller.\r
\r
  Assigns the I/O, MMIO, DMA, and interrupt resources specified by ResourceList\r
  to the ISA controller specified by Device.  ResourceList must match on of the\r
  possible resource lists returned by GetPosResource() for the same ISA controller.\r
\r
  @param[in] This           Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
  @param[in] Device         Pointer to an ISA controller named by ACPI HID/UID.\r
  @param[in] ResourceList   Pointer to a resources list that must be one of the \r
                            resource lists returned by GetPosResource() for the\r
                            ISA controller specified by Device.\r
\r
  @retval EFI_SUCCESS  Successfully set resources on the ISA controller.\r
  @retval Other        The resources could not be set for the ISA controller.\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
  Enables or disables an ISA controller.\r
\r
  @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
  @param[in] Device   Pointer to the ISA controller to enable/disable.\r
  @param[in] Enable   TRUE to enable the ISA controller.  FALSE to disable the\r
                      ISA controller.\r
\r
  @retval EFI_SUCCESS   Successfully enabled/disabled the ISA controller.\r
  @retval Other         The ISA controller cound not be placed in the requested state.\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
  Places an ISA controller into a usable state.  This service must be called\r
  before SetResource(), EnableDevice(), or SetPower() will behave as expected.\r
\r
  @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
  @param[in] Device   Pointer to an ISA controller named by ACPI HID/UID.\r
\r
  @retval EFI_SUCCESS   Successfully initialized an ISA controller.\r
  @retval Other         The ISA controller could not be initialized.\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
  Initializes all the HW state required for the ISA controlers on the ISA bus \r
  to be enumerated and managed by this rest of the services in this prorotol.\r
  This service must be called before any of the other services in this\r
  protocol will function as expected.\r
 \r
  @param[in] This  Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS   Successfully initialized the ISA interface.\r
  @retval Other         The ISA interface could not be initialized.\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
/// The EFI_ISA_ACPI_PROTOCOL provides the services to enumberate and manage\r
/// ISA controllers on an ISA bus.  This include the ability to initialize, \r
/// enable, disable, and manag the power state of ISA controllers.  It also \r
/// includes services to query current ressources, query possible resources, \r
/// and assign resources to an ISA controller.\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