2 This protocol abstracts the 8259 interrupt controller. This includes
3 PCI IRQ routing need to program the PCI Interrupt Line register.
5 Copyright (c) 2007, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 Module Name: Legacy8259.h
16 @par Revision Reference:
17 This protocol is defined in Framework for EFI Compatibility Support Module spec
22 #ifndef _EFI_LEGACY_8259_H_
23 #define _EFI_LEGACY_8259_H_
25 #define EFI_LEGACY_8259_PROTOCOL_GUID \
27 0x38321dba, 0x4fe0, 0x4e17, {0x8a, 0xec, 0x41, 0x30, 0x55, 0xea, 0xed, 0xc1 } \
30 typedef struct _EFI_LEGACY_8259_PROTOCOL EFI_LEGACY_8259_PROTOCOL
;
59 Get the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for
60 the legacy mode mask and the protected mode mask. The base address for the 8259
61 is different for legacy and protected mode, so two masks are required.
63 @param This Protocol instance pointer.
64 @param MasterBase The base vector for the Master PIC in the 8259 controller
65 @param Slavebase The base vector for the Master PIC in the 8259 controller
67 @retval EFI_SUCCESS The new bases were programmed
68 @retval EFI_DEVICE_ERROR A device erro occured programming the vector bases
73 (EFIAPI
*EFI_LEGACY_8259_SET_VECTOR_BASE
) (
74 IN EFI_LEGACY_8259_PROTOCOL
*This
,
80 Get the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for
81 the legacy mode mask and the protected mode mask. The base address for the 8259
82 is different for legacy and protected mode, so two masks are required.
84 @param This Protocol instance pointer.
85 @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
86 @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
87 @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
88 @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
90 @retval EFI_SUCCESS 8259 status returned
91 @retval EFI_DEVICE_ERROR Error reading 8259
96 (EFIAPI
*EFI_LEGACY_8259_GET_MASK
) (
97 IN EFI_LEGACY_8259_PROTOCOL
*This
,
98 OUT UINT16
*LegacyMask
, OPTIONAL
99 OUT UINT16
*LegacyEdgeLevel
, OPTIONAL
100 OUT UINT16
*ProtectedMask
, OPTIONAL
101 OUT UINT16
*ProtectedEdgeLevel OPTIONAL
105 Set the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for
106 the legacy mode mask and the protected mode mask. The base address for the 8259
107 is different for legacy and protected mode, so two masks are required.
108 Also set the edge/level masks.
110 @param This Protocol instance pointer.
111 @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
112 @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
113 @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
114 @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
116 @retval EFI_SUCCESS 8259 status returned
117 @retval EFI_DEVICE_ERROR Error reading 8259
122 (EFIAPI
*EFI_LEGACY_8259_SET_MASK
) (
123 IN EFI_LEGACY_8259_PROTOCOL
*This
,
124 IN UINT16
*LegacyMask
, OPTIONAL
125 IN UINT16
*LegacyEdgeLevel
, OPTIONAL
126 IN UINT16
*ProtectedMask
, OPTIONAL
127 IN UINT16
*ProtectedEdgeLevel OPTIONAL
131 Set the 8259 mode of operation. The base address for the 8259 is different for
132 legacy and protected mode. The legacy mode requires the master 8259 to have a
133 master base of 0x08 and the slave base of 0x70. The protected mode base locations
134 are not defined. Interrupts must be masked by the caller before this function
135 is called. The interrupt mask from the current mode is saved. The interrupt
136 mask for the new mode is Mask, or if Mask does not exist the previously saved
139 @param This Protocol instance pointer.
140 @param Mode Mode of operation. i.e. real mode or protected mode
141 @param Mask Optional interupt mask for the new mode.
142 @param EdgeLevel Optional trigger mask for the new mode.
144 @retval EFI_SUCCESS 8259 programmed
145 @retval EFI_DEVICE_ERROR Error writting to 8259
150 (EFIAPI
*EFI_LEGACY_8259_SET_MODE
) (
151 IN EFI_LEGACY_8259_PROTOCOL
*This
,
152 IN EFI_8259_MODE Mode
,
153 IN UINT16
*Mask
, OPTIONAL
154 IN UINT16
*EdgeLevel OPTIONAL
158 Convert from IRQ to processor interrupt vector number.
160 @param This Protocol instance pointer.
161 @param Irq 8259 IRQ0 - IRQ15
162 @param Vector Processor vector number that matches Irq
164 @retval EFI_SUCCESS The Vector matching Irq is returned
165 @retval EFI_INVALID_PARAMETER Irq not valid
170 (EFIAPI
*EFI_LEGACY_8259_GET_VECTOR
) (
171 IN EFI_LEGACY_8259_PROTOCOL
*This
,
177 Enable Irq by unmasking interrupt in 8259
179 @param This Protocol instance pointer.
180 @param Irq 8259 IRQ0 - IRQ15
181 @param LevelTriggered TRUE if level triggered. FALSE if edge triggered.
183 @retval EFI_SUCCESS Irq enabled on 8259
184 @retval EFI_INVALID_PARAMETER Irq not valid
189 (EFIAPI
*EFI_LEGACY_8259_ENABLE_IRQ
) (
190 IN EFI_LEGACY_8259_PROTOCOL
*This
,
192 IN BOOLEAN LevelTriggered
196 Disable Irq by masking interrupt in 8259
198 @param This Protocol instance pointer.
199 @param Irq 8259 IRQ0 - IRQ15
201 @retval EFI_SUCCESS Irq disabled on 8259
202 @retval EFI_INVALID_PARAMETER Irq not valid
207 (EFIAPI
*EFI_LEGACY_8259_DISABLE_IRQ
) (
208 IN EFI_LEGACY_8259_PROTOCOL
*This
,
213 PciHandle represents a PCI config space of a PCI function. Vector
214 represents Interrupt Pin (from PCI config space) and it is the data
215 that is programmed into the Interrupt Line (from the PCI config space)
218 @param This Protocol instance pointer.
219 @param PciHandle PCI function to return vector for
220 @param Vector Vector for fucntion that matches
222 @retval EFI_SUCCESS A valid Vector is returned
223 @retval EFI_INVALID_PARAMETER PciHandle not valid
228 (EFIAPI
*EFI_LEGACY_8259_GET_INTERRUPT_LINE
) (
229 IN EFI_LEGACY_8259_PROTOCOL
*This
,
230 IN EFI_HANDLE PciHandle
,
237 @param This Protocol instance pointer.
238 @param Irq 8259 IRQ0 - IRQ15
240 @retval EFI_SUCCESS EOI successfully sent to 8259
241 @retval EFI_INVALID_PARAMETER Irq not valid
246 (EFIAPI
*EFI_LEGACY_8259_END_OF_INTERRUPT
) (
247 IN EFI_LEGACY_8259_PROTOCOL
*This
,
252 @par Protocol Description:
253 Abstracts the 8259 and APIC hardware control between EFI usage and
254 Compatibility16 usage.
257 Sets the vector bases for master and slave PICs.
260 Gets IRQ and edge/level masks for 16-bit real mode and 32-bit protected mode.
263 Sets the IRQ and edge\level masks for 16-bit real mode and 32-bit protected mode.
266 Sets PIC mode to 16-bit real mode or 32-bit protected mode.
269 Gets the base vector assigned to an IRQ.
277 @param GetInterruptLine
278 Gets an IRQ that is assigned to a PCI device.
280 @param EndOfInterrupt
281 Issues the end of interrupt command.
284 struct _EFI_LEGACY_8259_PROTOCOL
{
285 EFI_LEGACY_8259_SET_VECTOR_BASE SetVectorBase
;
286 EFI_LEGACY_8259_GET_MASK GetMask
;
287 EFI_LEGACY_8259_SET_MASK SetMask
;
288 EFI_LEGACY_8259_SET_MODE SetMode
;
289 EFI_LEGACY_8259_GET_VECTOR GetVector
;
290 EFI_LEGACY_8259_ENABLE_IRQ EnableIrq
;
291 EFI_LEGACY_8259_DISABLE_IRQ DisableIrq
;
292 EFI_LEGACY_8259_GET_INTERRUPT_LINE GetInterruptLine
;
293 EFI_LEGACY_8259_END_OF_INTERRUPT EndOfInterrupt
;
296 extern EFI_GUID gEfiLegacy8259ProtocolGuid
;