+++ /dev/null
-/*++\r
-\r
-Copyright (c) 1999 - 2006, Intel Corporation. All rights reserved.<BR>\r
-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
-Module Name:\r
-\r
- Legacy8259.h\r
- \r
-Abstract:\r
-\r
- This protocol abstracts the 8259 interrupt controller. This includes\r
- PCI IRQ routing need to program the PCI Interrupt Line register.\r
-\r
-Revision History\r
-\r
- The EFI Legacy 8259 Protocol is compliant with CSM spec 0.96.\r
-\r
---*/\r
-\r
-#ifndef _EFI_LEGACY_8259_H\r
-#define _EFI_LEGACY_8259_H\r
-\r
-#define EFI_LEGACY_8259_PROTOCOL_GUID \\r
- { \\r
- 0x38321dba, 0x4fe0, 0x4e17, {0x8a, 0xec, 0x41, 0x30, 0x55, 0xea, 0xed, 0xc1} \\r
- }\r
-\r
-EFI_FORWARD_DECLARATION (EFI_LEGACY_8259_PROTOCOL);\r
-\r
-typedef enum {\r
- Efi8259Irq0,\r
- Efi8259Irq1,\r
- Efi8259Irq2,\r
- Efi8259Irq3,\r
- Efi8259Irq4,\r
- Efi8259Irq5,\r
- Efi8259Irq6,\r
- Efi8259Irq7,\r
- Efi8259Irq8,\r
- Efi8259Irq9,\r
- Efi8259Irq10,\r
- Efi8259Irq11,\r
- Efi8259Irq12,\r
- Efi8259Irq13,\r
- Efi8259Irq14,\r
- Efi8259Irq15,\r
- Efi8259IrqMax\r
-} EFI_8259_IRQ;\r
-\r
-typedef enum {\r
- Efi8259LegacyMode,\r
- Efi8259ProtectedMode,\r
- Efi8259MaxMode\r
-} EFI_8259_MODE;\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_SET_VECTOR_BASE) (\r
- IN EFI_LEGACY_8259_PROTOCOL * This,\r
- IN UINT8 MasterBase,\r
- IN UINT8 SlaveBase\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Get the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for\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
- Arguments:\r
- This - Protocol instance pointer.\r
- MasterBase - The base vector for the Master PIC in the 8259 controller\r
- Slavebase - The base vector for the Master PIC in the 8259 controller\r
-\r
- Returns:\r
- EFI_SUCCESS - The new bases were programmed\r
- EFI_DEVICE_ERROR - A device erro occured programming the vector bases\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\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
- OUT UINT16 *ProtectedMask, OPTIONAL\r
- OUT UINT16 *ProtectedEdgeLevel OPTIONAL\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Get the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for\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
- Arguments:\r
- This - Protocol instance pointer.\r
- LegacyMask - Bit 0 is Irq0 - Bit 15 is Irq15\r
- LegacyEdgeLevel - Bit 0 is Irq0 - Bit 15 is Irq15\r
- ProtectedMask - Bit 0 is Irq0 - Bit 15 is Irq15\r
- ProtectedEdgeLevel - Bit 0 is Irq0 - Bit 15 is Irq15\r
-\r
- Returns:\r
- EFI_SUCCESS - 8259 status returned\r
- EFI_DEVICE_ERROR - Error reading 8259\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\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
- IN UINT16 *ProtectedMask, OPTIONAL\r
- IN UINT16 *ProtectedEdgeLevel OPTIONAL\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Set the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for\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
- Also set the edge/level masks.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- LegacyMask - Bit 0 is Irq0 - Bit 15 is Irq15\r
- LegacyEdgeLevel - Bit 0 is Irq0 - Bit 15 is Irq15\r
- ProtectedMask - Bit 0 is Irq0 - Bit 15 is Irq15\r
- ProtectedEdgeLevel - Bit 0 is Irq0 - Bit 15 is Irq15\r
-\r
- Returns:\r
- EFI_SUCCESS - 8259 status returned\r
- EFI_DEVICE_ERROR - Error reading 8259\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\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
- IN UINT16 *EdgeLevel OPTIONAL\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Set the 8259 mode of operation. The base address for the 8259 is different for\r
- legacy and protected mode. The legacy mode requires the master 8259 to have a\r
- master base of 0x08 and the slave base of 0x70. The protected mode base locations\r
- are not defined. Interrupts must be masked by the caller before this function\r
- is called. The interrupt mask from the current mode is saved. The interrupt \r
- mask for the new mode is Mask, or if Mask does not exist the previously saved\r
- mask is used.\r
-\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Mode - Mode of operation. i.e. real mode or protected mode\r
- Mask - Optional interupt mask for the new mode.\r
- EdgeLevel - Optional trigger mask for the new mode.\r
-\r
- Returns:\r
- EFI_SUCCESS - 8259 programmed\r
- EFI_DEVICE_ERROR - Error writting to 8259\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\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
-/*++\r
-\r
- Routine Description:\r
- Convert from IRQ to processor interrupt vector number.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Irq - 8259 IRQ0 - IRQ15\r
- Vector - Processor vector number that matches Irq\r
-\r
- Returns:\r
- EFI_SUCCESS - The Vector matching Irq is returned\r
- EFI_INVALID_PARAMETER - Irq not valid\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\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
-/*++\r
-\r
- Routine Description:\r
- Enable Irq by unmasking interrupt in 8259\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Irq - 8259 IRQ0 - IRQ15\r
- LevelTriggered - TRUE if level triggered. FALSE if edge triggered.\r
-\r
- Returns:\r
- EFI_SUCCESS - Irq enabled on 8259\r
- EFI_INVALID_PARAMETER - Irq not valid\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_DISABLE_IRQ) (\r
- IN EFI_LEGACY_8259_PROTOCOL * This,\r
- IN EFI_8259_IRQ Irq\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Disable Irq by masking interrupt in 8259\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Irq - 8259 IRQ0 - IRQ15\r
-\r
- Returns:\r
- EFI_SUCCESS - Irq disabled on 8259\r
- EFI_INVALID_PARAMETER - Irq not valid\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\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
-/*++\r
-\r
- Routine Description:\r
- PciHandle represents a PCI config space of a PCI function. Vector \r
- represents Interrupt Pin (from PCI config space) and it is the data\r
- that is programmed into the Interrupt Line (from the PCI config space)\r
- register.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- PciHandle - PCI function to return vector for \r
- Vector - Vector for fucntion that matches \r
-\r
- Returns:\r
- EFI_SUCCESS - A valid Vector is returned\r
- EFI_INVALID_PARAMETER - PciHandle not valid\r
-\r
---*/\r
-;\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_LEGACY_8259_END_OF_INTERRUPT) (\r
- IN EFI_LEGACY_8259_PROTOCOL * This,\r
- IN EFI_8259_IRQ Irq\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Send an EOI to 8259\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Irq - 8259 IRQ0 - IRQ15\r
-\r
- Returns:\r
- EFI_SUCCESS - EOI successfully sent to 8259\r
- EFI_INVALID_PARAMETER - Irq not valid\r
-\r
---*/\r
-;\r
-\r
-struct _EFI_LEGACY_8259_PROTOCOL {\r
- EFI_LEGACY_8259_SET_VECTOR_BASE SetVectorBase;\r
- EFI_LEGACY_8259_GET_MASK GetMask;\r
- EFI_LEGACY_8259_SET_MASK SetMask;\r
- EFI_LEGACY_8259_SET_MODE SetMode;\r
- EFI_LEGACY_8259_GET_VECTOR GetVector;\r
- EFI_LEGACY_8259_ENABLE_IRQ EnableIrq;\r
- EFI_LEGACY_8259_DISABLE_IRQ DisableIrq;\r
- EFI_LEGACY_8259_GET_INTERRUPT_LINE GetInterruptLine;\r
- EFI_LEGACY_8259_END_OF_INTERRUPT EndOfInterrupt;\r
-};\r
-\r
-extern EFI_GUID gEfiLegacy8259ProtocolGuid;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff