#include <Protocol/Legacy8259.h>
#include <Protocol/PciIo.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/IoLib.h>
#include <Library/BaseLib.h>
#include <Library/PcdLib.h>
#include <IndustryStandard/Pci.h>

Macros
#define	LEGACY_MODE_BASE_VECTOR_MASTER 0x08

#define	LEGACY_MODE_BASE_VECTOR_SLAVE 0x70

#define	PROTECTED_MODE_BASE_VECTOR_MASTER 0x68

#define	PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70

#define	LEGACY_8259_CONTROL_REGISTER_MASTER 0x20

#define	LEGACY_8259_MASK_REGISTER_MASTER 0x21

#define	LEGACY_8259_CONTROL_REGISTER_SLAVE 0xA0

#define	LEGACY_8259_MASK_REGISTER_SLAVE 0xA1

#define	LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_MASTER 0x4D0

#define	LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_SLAVE 0x4D1

#define	LEGACY_8259_EOI 0x20

Functions
EFI_STATUS EFIAPI	Interrupt8259SetVectorBase (IN EFI_LEGACY_8259_PROTOCOL *This, IN UINT8 MasterBase, IN UINT8 SlaveBase)

EFI_STATUS EFIAPI	Interrupt8259GetMask (IN EFI_LEGACY_8259_PROTOCOL This, OUT UINT16 LegacyMask OPTIONAL, OUT UINT16 LegacyEdgeLevel OPTIONAL, OUT UINT16 ProtectedMask OPTIONAL, OUT UINT16 *ProtectedEdgeLevel OPTIONAL)

EFI_STATUS EFIAPI	Interrupt8259SetMask (IN EFI_LEGACY_8259_PROTOCOL This, IN UINT16 LegacyMask OPTIONAL, IN UINT16 LegacyEdgeLevel OPTIONAL, IN UINT16 ProtectedMask OPTIONAL, IN UINT16 *ProtectedEdgeLevel OPTIONAL)

EFI_STATUS EFIAPI	Interrupt8259SetMode (IN EFI_LEGACY_8259_PROTOCOL This, IN EFI_8259_MODE Mode, IN UINT16 Mask OPTIONAL, IN UINT16 *EdgeLevel OPTIONAL)

EFI_STATUS EFIAPI	Interrupt8259GetVector (IN EFI_LEGACY_8259_PROTOCOL This, IN EFI_8259_IRQ Irq, OUT UINT8 Vector)

EFI_STATUS EFIAPI	Interrupt8259EnableIrq (IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_IRQ Irq, IN BOOLEAN LevelTriggered)

EFI_STATUS EFIAPI	Interrupt8259DisableIrq (IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_IRQ Irq)

EFI_STATUS EFIAPI	Interrupt8259GetInterruptLine (IN EFI_LEGACY_8259_PROTOCOL This, IN EFI_HANDLE PciHandle, OUT UINT8 Vector)

EFI_STATUS EFIAPI	Interrupt8259EndOfInterrupt (IN EFI_LEGACY_8259_PROTOCOL *This, IN EFI_8259_IRQ Irq)

Detailed Description

Driver implementing the Tiano Legacy 8259 Protocol

Copyright (c) 2005 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file 8259.h.

Macro Definition Documentation

◆ LEGACY_8259_CONTROL_REGISTER_MASTER

#define LEGACY_8259_CONTROL_REGISTER_MASTER 0x20

Definition at line 31 of file 8259.h.

◆ LEGACY_8259_CONTROL_REGISTER_SLAVE

#define LEGACY_8259_CONTROL_REGISTER_SLAVE 0xA0

Definition at line 33 of file 8259.h.

◆ LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_MASTER

#define LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_MASTER 0x4D0

Definition at line 35 of file 8259.h.

◆ LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_SLAVE

#define LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_SLAVE 0x4D1

Definition at line 36 of file 8259.h.

◆ LEGACY_8259_EOI

#define LEGACY_8259_EOI 0x20

Definition at line 38 of file 8259.h.

◆ LEGACY_8259_MASK_REGISTER_MASTER

#define LEGACY_8259_MASK_REGISTER_MASTER 0x21

Definition at line 32 of file 8259.h.

◆ LEGACY_8259_MASK_REGISTER_SLAVE

#define LEGACY_8259_MASK_REGISTER_SLAVE 0xA1

Definition at line 34 of file 8259.h.

◆ LEGACY_MODE_BASE_VECTOR_MASTER

#define LEGACY_MODE_BASE_VECTOR_MASTER 0x08

Definition at line 25 of file 8259.h.

◆ LEGACY_MODE_BASE_VECTOR_SLAVE

#define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70

Definition at line 26 of file 8259.h.

◆ PROTECTED_MODE_BASE_VECTOR_MASTER

#define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68

Definition at line 28 of file 8259.h.

◆ PROTECTED_MODE_BASE_VECTOR_SLAVE

#define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70

Definition at line 29 of file 8259.h.

Function Documentation

◆ Interrupt8259DisableIrq()

EFI_STATUS EFIAPI Interrupt8259DisableIrq	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN EFI_8259_IRQ	Irq
	)

Disables the specified IRQ.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	Irq	IRQ0-IRQ15.

Return values

EFI_SUCCESS	The Irq was disabled on the 8259 PIC.
EFI_INVALID_PARAMETER	The Irq is not valid.

Definition at line 474 of file 8259.c.

◆ Interrupt8259EnableIrq()

EFI_STATUS EFIAPI Interrupt8259EnableIrq	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN EFI_8259_IRQ	Irq,
		IN BOOLEAN	LevelTriggered
	)

Enables the specified IRQ.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	Irq	IRQ0-IRQ15.
[in]	LevelTriggered	0 = Edge triggered; 1 = Level triggered.

Return values

EFI_SUCCESS	The Irq was enabled on the 8259 PIC.
EFI_INVALID_PARAMETER	The Irq is not valid.

Definition at line 440 of file 8259.c.

◆ Interrupt8259EndOfInterrupt()

EFI_STATUS EFIAPI Interrupt8259EndOfInterrupt	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN EFI_8259_IRQ	Irq
	)

Issues the End of Interrupt (EOI) commands to PICs.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	Irq	The interrupt for which to issue the EOI command.

Return values

EFI_SUCCESS	The EOI command was issued.
EFI_INVALID_PARAMETER	The Irq is not valid.

Definition at line 551 of file 8259.c.

◆ Interrupt8259GetInterruptLine()

EFI_STATUS EFIAPI Interrupt8259GetInterruptLine	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN EFI_HANDLE	PciHandle,
		OUT UINT8 *	Vector
	)

Reads the PCI configuration space to get the interrupt number that is assigned to the card.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	PciHandle	PCI function for which to return the vector.
[out]	Vector	IRQ number that corresponds to the interrupt line.

Return values

EFI_SUCCESS The interrupt line value was read successfully.

Definition at line 504 of file 8259.c.

◆ Interrupt8259GetMask()

EFI_STATUS EFIAPI Interrupt8259GetMask	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		OUT UINT16 *LegacyMask	OPTIONAL,
		OUT UINT16 *LegacyEdgeLevel	OPTIONAL,
		OUT UINT16 *ProtectedMask	OPTIONAL,
		OUT UINT16 *ProtectedEdgeLevel	OPTIONAL
	)

Gets the current 16-bit real mode and 32-bit protected-mode IRQ masks.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[out]	LegacyMask	16-bit mode interrupt mask for IRQ0-IRQ15.
[out]	LegacyEdgeLevel	16-bit mode edge/level mask for IRQ-IRQ15.
[out]	ProtectedMask	32-bit mode interrupt mask for IRQ0-IRQ15.
[out]	ProtectedEdgeLevel	32-bit mode edge/level mask for IRQ0-IRQ15.

Return values

EFI_SUCCESS	The 8259 PIC was programmed successfully.
EFI_DEVICE_ERROR	There was an error while reading the 8259 PIC.

Definition at line 231 of file 8259.c.

◆ Interrupt8259GetVector()

EFI_STATUS EFIAPI Interrupt8259GetVector	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN EFI_8259_IRQ	Irq,
		OUT UINT8 *	Vector
	)

Translates the IRQ into a vector.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	Irq	IRQ0-IRQ15.
[out]	Vector	The vector that is assigned to the IRQ.

Return values

EFI_SUCCESS	The Vector that matches Irq was returned.
EFI_INVALID_PARAMETER	Irq is not valid.

Definition at line 408 of file 8259.c.

◆ Interrupt8259SetMask()

EFI_STATUS EFIAPI Interrupt8259SetMask	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN UINT16 *LegacyMask	OPTIONAL,
		IN UINT16 *LegacyEdgeLevel	OPTIONAL,
		IN UINT16 *ProtectedMask	OPTIONAL,
		IN UINT16 *ProtectedEdgeLevel	OPTIONAL
	)

Sets the current 16-bit real mode and 32-bit protected-mode IRQ masks.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	LegacyMask	16-bit mode interrupt mask for IRQ0-IRQ15.
[in]	LegacyEdgeLevel	16-bit mode edge/level mask for IRQ-IRQ15.
[in]	ProtectedMask	32-bit mode interrupt mask for IRQ0-IRQ15.
[in]	ProtectedEdgeLevel	32-bit mode edge/level mask for IRQ0-IRQ15.

Return values

EFI_SUCCESS	The 8259 PIC was programmed successfully.
EFI_DEVICE_ERROR	There was an error while writing the 8259 PIC.

Definition at line 273 of file 8259.c.

◆ Interrupt8259SetMode()

EFI_STATUS EFIAPI Interrupt8259SetMode	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN EFI_8259_MODE	Mode,
		IN UINT16 *Mask	OPTIONAL,
		IN UINT16 *EdgeLevel	OPTIONAL
	)

Sets the mode of the PICs.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	Mode	16-bit real or 32-bit protected mode.
[in]	Mask	The value with which to set the interrupt mask.
[in]	EdgeLevel	The value with which to set the edge/level mask.

Return values

EFI_SUCCESS	The mode was set successfully.
EFI_INVALID_PARAMETER	The mode was not set.

Definition at line 314 of file 8259.c.

◆ Interrupt8259SetVectorBase()

EFI_STATUS EFIAPI Interrupt8259SetVectorBase	(	IN EFI_LEGACY_8259_PROTOCOL *	This,
		IN UINT8	MasterBase,
		IN UINT8	SlaveBase
	)

Sets the base address for the 8259 master and slave PICs.

Parameters

[in]	This	Indicates the EFI_LEGACY_8259_PROTOCOL instance.
[in]	MasterBase	Interrupt vectors for IRQ0-IRQ7.
[in]	SlaveBase	Interrupt vectors for IRQ8-IRQ15.

Return values

EFI_SUCCESS	The 8259 PIC was programmed successfully.
EFI_DEVICE_ERROR	There was an error while writing to the 8259 PIC.

Definition at line 114 of file 8259.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ LEGACY_8259_CONTROL_REGISTER_MASTER

◆ LEGACY_8259_CONTROL_REGISTER_SLAVE

◆ LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_MASTER

◆ LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_SLAVE

◆ LEGACY_8259_EOI

◆ LEGACY_8259_MASK_REGISTER_MASTER

◆ LEGACY_8259_MASK_REGISTER_SLAVE

◆ LEGACY_MODE_BASE_VECTOR_MASTER

◆ LEGACY_MODE_BASE_VECTOR_SLAVE

◆ PROTECTED_MODE_BASE_VECTOR_MASTER

◆ PROTECTED_MODE_BASE_VECTOR_SLAVE

Function Documentation

◆ Interrupt8259DisableIrq()

◆ Interrupt8259EnableIrq()

◆ Interrupt8259EndOfInterrupt()

◆ Interrupt8259GetInterruptLine()

◆ Interrupt8259GetMask()

◆ Interrupt8259GetVector()

◆ Interrupt8259SetMask()

◆ Interrupt8259SetMode()

◆ Interrupt8259SetVectorBase()