X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FLegacy8259.h;h=c843de1018a85b0f874694591ab0d86add728bea;hb=c5b900bed8bab2f16149c48f11c525690611b33d;hp=e9f91733ef49d1ec6a0470421c8fab662a015d84;hpb=79964ac84ea0ca6c68d0dea38245fa83ff1945d1;p=mirror_edk2.git diff --git a/IntelFrameworkPkg/Include/Protocol/Legacy8259.h b/IntelFrameworkPkg/Include/Protocol/Legacy8259.h index e9f91733ef..c843de1018 100644 --- a/IntelFrameworkPkg/Include/Protocol/Legacy8259.h +++ b/IntelFrameworkPkg/Include/Protocol/Legacy8259.h @@ -1,27 +1,26 @@ /** @file This protocol abstracts the 8259 interrupt controller. This includes - PCI IRQ routing need to program the PCI Interrupt Line register. + PCI IRQ routing needed to program the PCI Interrupt Line register. - Copyright (c) 2007, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - - Module Name: Legacy8259.h +Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. +The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is defined in Framework for EFI Compatibility Support Module spec - Version 0.96 + Version 0.97. **/ #ifndef _EFI_LEGACY_8259_H_ #define _EFI_LEGACY_8259_H_ + #define EFI_LEGACY_8259_PROTOCOL_GUID \ { \ 0x38321dba, 0x4fe0, 0x4e17, {0x8a, 0xec, 0x41, 0x30, 0x55, 0xea, 0xed, 0xc1 } \ @@ -60,17 +59,17 @@ typedef enum { the legacy mode mask and the protected mode mask. The base address for the 8259 is different for legacy and protected mode, so two masks are required. - @param This Protocol instance pointer. - @param MasterBase The base vector for the Master PIC in the 8259 controller - @param Slavebase The base vector for the Master PIC in the 8259 controller + @param This The protocol instance pointer. + @param MasterBase The base vector for the Master PIC in the 8259 controller. + @param SlaveBase The base vector for the Slave PIC in the 8259 controller. - @retval EFI_SUCCESS The new bases were programmed - @retval EFI_DEVICE_ERROR A device erro occured programming the vector bases + @retval EFI_SUCCESS The new bases were programmed. + @retval EFI_DEVICE_ERROR A device error occured programming the vector bases. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_SET_VECTOR_BASE) ( +(EFIAPI *EFI_LEGACY_8259_SET_VECTOR_BASE)( IN EFI_LEGACY_8259_PROTOCOL *This, IN UINT8 MasterBase, IN UINT8 SlaveBase @@ -81,19 +80,19 @@ EFI_STATUS the legacy mode mask and the protected mode mask. The base address for the 8259 is different for legacy and protected mode, so two masks are required. - @param This Protocol instance pointer. - @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15 - @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15 - @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15 - @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15 + @param This The protocol instance pointer. + @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15. + @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15. + @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15. + @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15. - @retval EFI_SUCCESS 8259 status returned - @retval EFI_DEVICE_ERROR Error reading 8259 + @retval EFI_SUCCESS 8259 status returned. + @retval EFI_DEVICE_ERROR Error reading 8259. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_GET_MASK) ( +(EFIAPI *EFI_LEGACY_8259_GET_MASK)( IN EFI_LEGACY_8259_PROTOCOL *This, OUT UINT16 *LegacyMask, OPTIONAL OUT UINT16 *LegacyEdgeLevel, OPTIONAL @@ -107,19 +106,19 @@ EFI_STATUS is different for legacy and protected mode, so two masks are required. Also set the edge/level masks. - @param This Protocol instance pointer. - @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15 - @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15 - @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15 - @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15 + @param This The protocol instance pointer. + @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15. + @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15. + @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15. + @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15. - @retval EFI_SUCCESS 8259 status returned - @retval EFI_DEVICE_ERROR Error reading 8259 + @retval EFI_SUCCESS 8259 status returned. + @retval EFI_DEVICE_ERROR Error writing 8259. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_SET_MASK) ( +(EFIAPI *EFI_LEGACY_8259_SET_MASK)( IN EFI_LEGACY_8259_PROTOCOL *This, IN UINT16 *LegacyMask, OPTIONAL IN UINT16 *LegacyEdgeLevel, OPTIONAL @@ -136,18 +135,18 @@ EFI_STATUS mask for the new mode is Mask, or if Mask does not exist the previously saved mask is used. - @param This Protocol instance pointer. - @param Mode Mode of operation. i.e. real mode or protected mode + @param This The protocol instance pointer. + @param Mode The mode of operation. i.e. the real mode or protected mode. @param Mask Optional interupt mask for the new mode. @param EdgeLevel Optional trigger mask for the new mode. - @retval EFI_SUCCESS 8259 programmed - @retval EFI_DEVICE_ERROR Error writting to 8259 + @retval EFI_SUCCESS 8259 programmed. + @retval EFI_DEVICE_ERROR Error writing to 8259. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_SET_MODE) ( +(EFIAPI *EFI_LEGACY_8259_SET_MODE)( IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_MODE Mode, IN UINT16 *Mask, OPTIONAL @@ -157,17 +156,17 @@ EFI_STATUS /** Convert from IRQ to processor interrupt vector number. - @param This Protocol instance pointer. - @param Irq 8259 IRQ0 - IRQ15 - @param Vector Processor vector number that matches Irq + @param This The protocol instance pointer. + @param Irq 8259 IRQ0 - IRQ15. + @param Vector The processor vector number that matches an Irq. - @retval EFI_SUCCESS The Vector matching Irq is returned - @retval EFI_INVALID_PARAMETER Irq not valid + @retval EFI_SUCCESS The Vector matching Irq is returned. + @retval EFI_INVALID_PARAMETER The Irq not valid. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_GET_VECTOR) ( +(EFIAPI *EFI_LEGACY_8259_GET_VECTOR)( IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_IRQ Irq, OUT UINT8 *Vector @@ -176,17 +175,17 @@ EFI_STATUS /** Enable Irq by unmasking interrupt in 8259 - @param This Protocol instance pointer. - @param Irq 8259 IRQ0 - IRQ15 + @param This The protocol instance pointer. + @param Irq 8259 IRQ0 - IRQ15. @param LevelTriggered TRUE if level triggered. FALSE if edge triggered. - @retval EFI_SUCCESS Irq enabled on 8259 - @retval EFI_INVALID_PARAMETER Irq not valid + @retval EFI_SUCCESS The Irq was enabled on 8259. + @retval EFI_INVALID_PARAMETER The Irq is not valid. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_ENABLE_IRQ) ( +(EFIAPI *EFI_LEGACY_8259_ENABLE_IRQ)( IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_IRQ Irq, IN BOOLEAN LevelTriggered @@ -195,16 +194,16 @@ EFI_STATUS /** Disable Irq by masking interrupt in 8259 - @param This Protocol instance pointer. - @param Irq 8259 IRQ0 - IRQ15 + @param This The protocol instance pointer. + @param Irq 8259 IRQ0 - IRQ15. - @retval EFI_SUCCESS Irq disabled on 8259 - @retval EFI_INVALID_PARAMETER Irq not valid + @retval EFI_SUCCESS The Irq was disabled on 8259. + @retval EFI_INVALID_PARAMETER The Irq is not valid. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_DISABLE_IRQ) ( +(EFIAPI *EFI_LEGACY_8259_DISABLE_IRQ)( IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_IRQ Irq ); @@ -215,17 +214,17 @@ EFI_STATUS that is programmed into the Interrupt Line (from the PCI config space) register. - @param This Protocol instance pointer. - @param PciHandle PCI function to return vector for - @param Vector Vector for fucntion that matches + @param This The protocol instance pointer. + @param PciHandle The PCI function to return the vector for. + @param Vector The vector for the function it matches. - @retval EFI_SUCCESS A valid Vector is returned - @retval EFI_INVALID_PARAMETER PciHandle not valid + @retval EFI_SUCCESS A valid Vector was returned. + @retval EFI_INVALID_PARAMETER PciHandle not valid. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_GET_INTERRUPT_LINE) ( +(EFIAPI *EFI_LEGACY_8259_GET_INTERRUPT_LINE)( IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_HANDLE PciHandle, OUT UINT8 *Vector @@ -234,16 +233,16 @@ EFI_STATUS /** Send an EOI to 8259 - @param This Protocol instance pointer. - @param Irq 8259 IRQ0 - IRQ15 + @param This The protocol instance pointer. + @param Irq 8259 IRQ0 - IRQ15. - @retval EFI_SUCCESS EOI successfully sent to 8259 - @retval EFI_INVALID_PARAMETER Irq not valid + @retval EFI_SUCCESS EOI was successfully sent to 8259. + @retval EFI_INVALID_PARAMETER The Irq isnot valid. **/ typedef EFI_STATUS -(EFIAPI *EFI_LEGACY_8259_END_OF_INTERRUPT) ( +(EFIAPI *EFI_LEGACY_8259_END_OF_INTERRUPT)( IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_IRQ Irq );