/** @file\r
This protocol abstracts the PIRQ programming from the generic EFI Compatibility Support Modules (CSMs).\r
\r
- Copyright (c) 2007, Intel Corporation\r
+ Copyright (c) 2007 - 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
#ifndef _EFI_LEGACY_INTERRUPT_H_\r
#define _EFI_LEGACY_INTERRUPT_H_\r
\r
-#include <PiDxe.h>\r
\r
#define EFI_LEGACY_INTERRUPT_PROTOCOL_GUID \\r
{ \\r
Get the number of PIRQs this hardware supports.\r
\r
@param This Protocol instance pointer.\r
- @param NumberPirsq Number of PIRQs.\r
+ @param NumberPirsq Number of PIRQs that are supported.\r
\r
- @retval EFI_SUCCESS Number of PIRQs returned.\r
+ @retval EFI_SUCCESS The number of PIRQs was returned successfully.\r
\r
**/\r
typedef\r
@param Device PCI Device\r
@param Function PCI Function\r
\r
- @retval EFI_SUCCESS Bus/Device/Function returned\r
+ @retval EFI_SUCCESS The Bus, Device, and Function were returned successfully\r
\r
**/\r
typedef\r
\r
@param This Protocol instance pointer.\r
@param PirqNumber PIRQ register to read.\r
- @param PirqData Data written.\r
+ @param PirqData Data to write.\r
\r
- @retval EFI_SUCCESS Table pointer returned\r
+ @retval EFI_SUCCESS The PIRQ was programmed\r
@retval EFI_INVALID_PARAMETER Invalid PIRQ number\r
\r
**/\r
IN UINT8 PirqData\r
);\r
\r
-/**\r
- @par Protocol Description:\r
- Abstracts the PIRQ programming from the generic EFI Compatibility Support Modules\r
-\r
- @param GetNumberPirqs\r
- Gets the number of PIRQs supported.\r
-\r
- @param GetLocation\r
- Gets the PCI bus, device, and function that associated with this protocol.\r
-\r
- @param ReadPirq\r
- Reads the indicated PIRQ register.\r
-\r
- @param WritePirq\r
- Writes to the indicated PIRQ register.\r
-\r
-**/\r
struct _EFI_LEGACY_INTERRUPT_PROTOCOL {\r
+ ///\r
+ /// Gets the number of PIRQs supported.\r
+ ///\r
EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS GetNumberPirqs;\r
+\r
+ ///\r
+ /// Gets the PCI bus, device, and function that associated with this protocol.\r
+ ///\r
EFI_LEGACY_INTERRUPT_GET_LOCATION GetLocation;\r
+\r
+ ///\r
+ /// Reads the indicated PIRQ register.\r
+ ///\r
EFI_LEGACY_INTERRUPT_READ_PIRQ ReadPirq;\r
+\r
+ ///\r
+ /// Writes to the indicated PIRQ register.\r
+ ///\r
EFI_LEGACY_INTERRUPT_WRITE_PIRQ WritePirq;\r
};\r
\r