/** @file\r
This protocol abstracts the 8259 interrupt controller. This includes\r
- PCI IRQ routing need to program the PCI Interrupt Line register.\r
+ PCI IRQ routing needed to program the PCI Interrupt Line register.\r
\r
- Copyright (c) 2007, 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
- Module Name: Legacy8259.h\r
+Copyright (c) 2007 - 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
@par Revision Reference:\r
This protocol is defined in Framework for EFI Compatibility Support Module spec\r
- Version 0.96\r
+ Version 0.97.\r
\r
**/\r
\r
#ifndef _EFI_LEGACY_8259_H_\r
#define _EFI_LEGACY_8259_H_\r
\r
-#include <PiDxe.h>\r
\r
#define EFI_LEGACY_8259_PROTOCOL_GUID \\r
{ \\r
the legacy mode mask and the protected mode mask. The base address for the 8259\r
is different for legacy and protected mode, so two masks are required.\r
\r
- @param This Protocol instance pointer.\r
- @param MasterBase The base vector for the Master PIC in the 8259 controller\r
- @param Slavebase The base vector for the Master PIC in the 8259 controller\r
+ @param This The protocol instance pointer.\r
+ @param MasterBase The base vector for the Master PIC in the 8259 controller.\r
+ @param SlaveBase The base vector for the Slave PIC in the 8259 controller.\r
\r
- @retval EFI_SUCCESS The new bases were programmed\r
- @retval EFI_DEVICE_ERROR A device erro occured programming the vector bases\r
+ @retval EFI_SUCCESS The new bases were programmed.\r
+ @retval EFI_DEVICE_ERROR A device error occured programming the vector bases.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_SET_VECTOR_BASE) (\r
+(EFIAPI *EFI_LEGACY_8259_SET_VECTOR_BASE)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN UINT8 MasterBase,\r
IN UINT8 SlaveBase\r
the legacy mode mask and the protected mode mask. The base address for the 8259\r
is different for legacy and protected mode, so two masks are required.\r
\r
- @param This Protocol instance pointer.\r
- @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15\r
- @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
- @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15\r
- @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
+ @param This The protocol instance pointer.\r
+ @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15.\r
+ @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15.\r
+ @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15.\r
+ @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15.\r
\r
- @retval EFI_SUCCESS 8259 status returned\r
- @retval EFI_DEVICE_ERROR Error reading 8259\r
+ @retval EFI_SUCCESS 8259 status returned.\r
+ @retval EFI_DEVICE_ERROR Error reading 8259.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_GET_MASK) (\r
+(EFIAPI *EFI_LEGACY_8259_GET_MASK)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
OUT UINT16 *LegacyMask, OPTIONAL\r
OUT UINT16 *LegacyEdgeLevel, OPTIONAL\r
is different for legacy and protected mode, so two masks are required.\r
Also set the edge/level masks.\r
\r
- @param This Protocol instance pointer.\r
- @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15\r
- @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
- @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15\r
- @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
+ @param This The protocol instance pointer.\r
+ @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15.\r
+ @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15.\r
+ @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15.\r
+ @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15.\r
\r
- @retval EFI_SUCCESS 8259 status returned\r
- @retval EFI_DEVICE_ERROR Error reading 8259\r
+ @retval EFI_SUCCESS 8259 status returned.\r
+ @retval EFI_DEVICE_ERROR Error writing 8259.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_SET_MASK) (\r
+(EFIAPI *EFI_LEGACY_8259_SET_MASK)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN UINT16 *LegacyMask, OPTIONAL\r
IN UINT16 *LegacyEdgeLevel, OPTIONAL\r
mask for the new mode is Mask, or if Mask does not exist the previously saved\r
mask is used.\r
\r
- @param This Protocol instance pointer.\r
- @param Mode Mode of operation. i.e. real mode or protected mode\r
+ @param This The protocol instance pointer.\r
+ @param Mode The mode of operation. i.e. the real mode or protected mode.\r
@param Mask Optional interupt mask for the new mode.\r
@param EdgeLevel Optional trigger mask for the new mode.\r
\r
- @retval EFI_SUCCESS 8259 programmed\r
- @retval EFI_DEVICE_ERROR Error writting to 8259\r
+ @retval EFI_SUCCESS 8259 programmed.\r
+ @retval EFI_DEVICE_ERROR Error writing to 8259.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_SET_MODE) (\r
+(EFIAPI *EFI_LEGACY_8259_SET_MODE)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN EFI_8259_MODE Mode,\r
IN UINT16 *Mask, OPTIONAL\r
/**\r
Convert from IRQ to processor interrupt vector number.\r
\r
- @param This Protocol instance pointer.\r
- @param Irq 8259 IRQ0 - IRQ15\r
- @param Vector Processor vector number that matches Irq\r
+ @param This The protocol instance pointer.\r
+ @param Irq 8259 IRQ0 - IRQ15.\r
+ @param Vector The processor vector number that matches an Irq.\r
\r
- @retval EFI_SUCCESS The Vector matching Irq is returned\r
- @retval EFI_INVALID_PARAMETER Irq not valid\r
+ @retval EFI_SUCCESS The Vector matching Irq is returned.\r
+ @retval EFI_INVALID_PARAMETER The Irq not valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_GET_VECTOR) (\r
+(EFIAPI *EFI_LEGACY_8259_GET_VECTOR)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN EFI_8259_IRQ Irq,\r
OUT UINT8 *Vector\r
/**\r
Enable Irq by unmasking interrupt in 8259\r
\r
- @param This Protocol instance pointer.\r
- @param Irq 8259 IRQ0 - IRQ15\r
+ @param This The protocol instance pointer.\r
+ @param Irq 8259 IRQ0 - IRQ15.\r
@param LevelTriggered TRUE if level triggered. FALSE if edge triggered.\r
\r
- @retval EFI_SUCCESS Irq enabled on 8259\r
- @retval EFI_INVALID_PARAMETER Irq not valid\r
+ @retval EFI_SUCCESS The Irq was enabled on 8259.\r
+ @retval EFI_INVALID_PARAMETER The Irq is not valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_ENABLE_IRQ) (\r
+(EFIAPI *EFI_LEGACY_8259_ENABLE_IRQ)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN EFI_8259_IRQ Irq,\r
IN BOOLEAN LevelTriggered\r
/**\r
Disable Irq by masking interrupt in 8259\r
\r
- @param This Protocol instance pointer.\r
- @param Irq 8259 IRQ0 - IRQ15\r
+ @param This The protocol instance pointer.\r
+ @param Irq 8259 IRQ0 - IRQ15.\r
\r
- @retval EFI_SUCCESS Irq disabled on 8259\r
- @retval EFI_INVALID_PARAMETER Irq not valid\r
+ @retval EFI_SUCCESS The Irq was disabled on 8259.\r
+ @retval EFI_INVALID_PARAMETER The Irq is not valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_DISABLE_IRQ) (\r
+(EFIAPI *EFI_LEGACY_8259_DISABLE_IRQ)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN EFI_8259_IRQ Irq\r
);\r
that is programmed into the Interrupt Line (from the PCI config space)\r
register.\r
\r
- @param This Protocol instance pointer.\r
- @param PciHandle PCI function to return vector for\r
- @param Vector Vector for fucntion that matches\r
+ @param This The protocol instance pointer.\r
+ @param PciHandle The PCI function to return the vector for.\r
+ @param Vector The vector for the function it matches.\r
\r
- @retval EFI_SUCCESS A valid Vector is returned\r
- @retval EFI_INVALID_PARAMETER PciHandle not valid\r
+ @retval EFI_SUCCESS A valid Vector was returned.\r
+ @retval EFI_INVALID_PARAMETER PciHandle not valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_GET_INTERRUPT_LINE) (\r
+(EFIAPI *EFI_LEGACY_8259_GET_INTERRUPT_LINE)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN EFI_HANDLE PciHandle,\r
OUT UINT8 *Vector\r
/**\r
Send an EOI to 8259\r
\r
- @param This Protocol instance pointer.\r
- @param Irq 8259 IRQ0 - IRQ15\r
+ @param This The protocol instance pointer.\r
+ @param Irq 8259 IRQ0 - IRQ15.\r
\r
- @retval EFI_SUCCESS EOI successfully sent to 8259\r
- @retval EFI_INVALID_PARAMETER Irq not valid\r
+ @retval EFI_SUCCESS EOI was successfully sent to 8259.\r
+ @retval EFI_INVALID_PARAMETER The Irq isnot valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_END_OF_INTERRUPT) (\r
+(EFIAPI *EFI_LEGACY_8259_END_OF_INTERRUPT)(\r
IN EFI_LEGACY_8259_PROTOCOL *This,\r
IN EFI_8259_IRQ Irq\r
);\r
projects / mirror_edk2.git / blobdiff