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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define __ISA_ACPI_H_\r
\r
///\r
-/// Global ID for the EFI ISA ACPI Protocol\r
+/// Global ID for the EFI ISA ACPI Protocol.\r
///\r
#define EFI_ISA_ACPI_PROTOCOL_GUID \\r
{ \\r
typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL;\r
\r
///\r
-/// ISA ACPI Protocol interrupt resource attributes\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
+#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
+/// 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
+#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
+#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
+#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
+ 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
+ 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
+ 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 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_DEVICE_ID Device; ///< The ACPI HID/UID associated with an ISA controller.\r
+ EFI_ISA_ACPI_RESOURCE *ResourceItem; ///< A pointer to the list of resources associated with an ISA controller.\r
} EFI_ISA_ACPI_RESOURCE_LIST;\r
\r
/**\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
+ @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+ @param[out] Device The 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
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] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+ @param[in] Device The pointer to an ISA controller named by ACPI HID/UID.\r
@param[in] OnOff TRUE denotes on, FALSE denotes off.\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
+ @retval Other The ISA controller could not be placed in the requested power state.\r
\r
**/\r
typedef\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
+ @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+ @param[in] Device The pointer to an ISA controller named by ACPI HID/UID.\r
+ @param[out] ResourceList The 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
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
+ @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+ @param[in] Device The pointer to an ISA controller named by ACPI HID/UID.\r
+ @param[out] ResourceList The pointer to the returned list of resource lists.\r
\r
@retval EFI_UNSUPPORTED This service is not supported.\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 a resource list 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
+ @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+ @param[in] Device The pointer to an ISA controller named by ACPI HID/UID.\r
+ @param[in] ResourceList The 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
/**\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] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+ @param[in] Device The 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
+ @retval Other The ISA controller could not be placed in the requested state.\r
\r
**/\r
typedef\r
Initializes an ISA controller, so that it can be used. 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
+ @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+ @param[in] Device The 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
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
+ @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Successfully initialized all required hardware states.\r
@retval Other The ISA interface could not be initialized.\r
projects / mirror_edk2.git / blobdiff