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) 2006, 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
,
81 Get the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for
82 the legacy mode mask and the protected mode mask. The base address for the 8259
83 is different for legacy and protected mode, so two masks are required.
85 @param This Protocol instance pointer.
86 @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
87 @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
88 @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
89 @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
91 @retval EFI_SUCCESS 8259 status returned
92 @retval EFI_DEVICE_ERROR Error reading 8259
97 (EFIAPI
*EFI_LEGACY_8259_GET_MASK
) (
98 IN EFI_LEGACY_8259_PROTOCOL
*This
,
99 OUT UINT16
*LegacyMask
, OPTIONAL
100 OUT UINT16
*LegacyEdgeLevel
, OPTIONAL
101 OUT UINT16
*ProtectedMask
, OPTIONAL
102 OUT UINT16
*ProtectedEdgeLevel OPTIONAL
107 Set the 8259 interrupt masks for Irq0 - Irq15. A different mask exists for
108 the legacy mode mask and the protected mode mask. The base address for the 8259
109 is different for legacy and protected mode, so two masks are required.
110 Also set the edge/level masks.
112 @param This Protocol instance pointer.
113 @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
114 @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
115 @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
116 @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
118 @retval EFI_SUCCESS 8259 status returned
119 @retval EFI_DEVICE_ERROR Error reading 8259
124 (EFIAPI
*EFI_LEGACY_8259_SET_MASK
) (
125 IN EFI_LEGACY_8259_PROTOCOL
*This
,
126 IN UINT16
*LegacyMask
, OPTIONAL
127 IN UINT16
*LegacyEdgeLevel
, OPTIONAL
128 IN UINT16
*ProtectedMask
, OPTIONAL
129 IN UINT16
*ProtectedEdgeLevel OPTIONAL
134 Set the 8259 mode of operation. The base address for the 8259 is different for
135 legacy and protected mode. The legacy mode requires the master 8259 to have a
136 master base of 0x08 and the slave base of 0x70. The protected mode base locations
137 are not defined. Interrupts must be masked by the caller before this function
138 is called. The interrupt mask from the current mode is saved. The interrupt
139 mask for the new mode is Mask, or if Mask does not exist the previously saved
142 @param This Protocol instance pointer.
143 @param Mode Mode of operation. i.e. real mode or protected mode
144 @param Mask Optional interupt mask for the new mode.
145 @param EdgeLevel Optional trigger mask for the new mode.
147 @retval EFI_SUCCESS 8259 programmed
148 @retval EFI_DEVICE_ERROR Error writting to 8259
153 (EFIAPI
*EFI_LEGACY_8259_SET_MODE
) (
154 IN EFI_LEGACY_8259_PROTOCOL
*This
,
155 IN EFI_8259_MODE Mode
,
156 IN UINT16
*Mask
, OPTIONAL
157 IN UINT16
*EdgeLevel OPTIONAL
162 Convert from IRQ to processor interrupt vector number.
164 @param This Protocol instance pointer.
165 @param Irq 8259 IRQ0 - IRQ15
166 @param Vector Processor vector number that matches Irq
168 @retval EFI_SUCCESS The Vector matching Irq is returned
169 @retval EFI_INVALID_PARAMETER Irq not valid
174 (EFIAPI
*EFI_LEGACY_8259_GET_VECTOR
) (
175 IN EFI_LEGACY_8259_PROTOCOL
*This
,
182 Enable Irq by unmasking interrupt in 8259
184 @param This Protocol instance pointer.
185 @param Irq 8259 IRQ0 - IRQ15
186 @param LevelTriggered TRUE if level triggered. FALSE if edge triggered.
188 @retval EFI_SUCCESS Irq enabled on 8259
189 @retval EFI_INVALID_PARAMETER Irq not valid
194 (EFIAPI
*EFI_LEGACY_8259_ENABLE_IRQ
) (
195 IN EFI_LEGACY_8259_PROTOCOL
*This
,
197 IN BOOLEAN LevelTriggered
202 Disable Irq by masking interrupt in 8259
204 @param This Protocol instance pointer.
205 @param Irq 8259 IRQ0 - IRQ15
207 @retval EFI_SUCCESS Irq disabled on 8259
208 @retval EFI_INVALID_PARAMETER Irq not valid
213 (EFIAPI
*EFI_LEGACY_8259_DISABLE_IRQ
) (
214 IN EFI_LEGACY_8259_PROTOCOL
*This
,
220 PciHandle represents a PCI config space of a PCI function. Vector
221 represents Interrupt Pin (from PCI config space) and it is the data
222 that is programmed into the Interrupt Line (from the PCI config space)
225 @param This Protocol instance pointer.
226 @param PciHandle PCI function to return vector for
227 @param Vector Vector for fucntion that matches
229 @retval EFI_SUCCESS A valid Vector is returned
230 @retval EFI_INVALID_PARAMETER PciHandle not valid
235 (EFIAPI
*EFI_LEGACY_8259_GET_INTERRUPT_LINE
) (
236 IN EFI_LEGACY_8259_PROTOCOL
*This
,
237 IN EFI_HANDLE PciHandle
,
245 @param This Protocol instance pointer.
246 @param Irq 8259 IRQ0 - IRQ15
248 @retval EFI_SUCCESS EOI successfully sent to 8259
249 @retval EFI_INVALID_PARAMETER Irq not valid
254 (EFIAPI
*EFI_LEGACY_8259_END_OF_INTERRUPT
) (
255 IN EFI_LEGACY_8259_PROTOCOL
*This
,
261 @par Protocol Description:
262 Abstracts the 8259 and APIC hardware control between EFI usage and
263 Compatibility16 usage.
266 Sets the vector bases for master and slave PICs.
269 Gets IRQ and edge/level masks for 16-bit real mode and 32-bit protected mode.
272 Sets the IRQ and edge\level masks for 16-bit real mode and 32-bit protected mode.
275 Sets PIC mode to 16-bit real mode or 32-bit protected mode.
278 Gets the base vector assigned to an IRQ.
286 @param GetInterruptLine
287 Gets an IRQ that is assigned to a PCI device.
289 @param EndOfInterrupt
290 Issues the end of interrupt command.
293 struct _EFI_LEGACY_8259_PROTOCOL
{
294 EFI_LEGACY_8259_SET_VECTOR_BASE SetVectorBase
;
295 EFI_LEGACY_8259_GET_MASK GetMask
;
296 EFI_LEGACY_8259_SET_MASK SetMask
;
297 EFI_LEGACY_8259_SET_MODE SetMode
;
298 EFI_LEGACY_8259_GET_VECTOR GetVector
;
299 EFI_LEGACY_8259_ENABLE_IRQ EnableIrq
;
300 EFI_LEGACY_8259_DISABLE_IRQ DisableIrq
;
301 EFI_LEGACY_8259_GET_INTERRUPT_LINE GetInterruptLine
;
302 EFI_LEGACY_8259_END_OF_INTERRUPT EndOfInterrupt
;
305 extern EFI_GUID gEfiLegacy8259ProtocolGuid
;