audk/IntelFrameworkModulePkg/Universal/Legacy8259Dxe/8259.h

294 lines
6.3 KiB
C

/**
Copyright (c) 2005, 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:
8259.h
Abstract:
Driver implementing the Tiano Legacy 8259 Protocol
**/
#ifndef _8259_H__
#define _8259_H__
#include <FrameworkDxe.h>
#include <Protocol/Legacy8259.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/IoLib.h>
//
// 8259 Hardware definitions
//
#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
//
// Protocol Function Prototypes
//
EFI_STATUS
EFIAPI
Interrupt8259SetVectorBase (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN UINT8 MasterBase,
IN UINT8 SlaveBase
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
MasterBase - TODO: add argument description
SlaveBase - TODO: add argument description
Returns:
TODO: add return values
**/
;
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
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
LegacyMask - TODO: add argument description
LegacyEdgeLevel - TODO: add argument description
ProtectedMask - TODO: add argument description
ProtectedEdgeLevel - TODO: add argument description
Returns:
TODO: add return values
**/
;
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
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
LegacyMask - TODO: add argument description
LegacyEdgeLevel - TODO: add argument description
ProtectedMask - TODO: add argument description
ProtectedEdgeLevel - TODO: add argument description
Returns:
TODO: add return values
**/
;
EFI_STATUS
EFIAPI
Interrupt8259SetMode (
IN EFI_LEGACY_8259_PROTOCOL * This,
IN EFI_8259_MODE Mode,
IN UINT16 *Mask, OPTIONAL
IN UINT16 *EdgeLevel OPTIONAL
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Mode - TODO: add argument description
Mask - TODO: add argument description
EdgeLevel - TODO: add argument description
Returns:
TODO: add return values
**/
;
EFI_STATUS
EFIAPI
Interrupt8259GetVector (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_8259_IRQ Irq,
OUT UINT8 *Vector
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Irq - TODO: add argument description
Vector - TODO: add argument description
Returns:
TODO: add return values
**/
;
EFI_STATUS
EFIAPI
Interrupt8259EnableIrq (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_8259_IRQ Irq,
IN BOOLEAN LevelTriggered
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Irq - TODO: add argument description
LevelTriggered - TODO: add argument description
Returns:
TODO: add return values
**/
;
EFI_STATUS
EFIAPI
Interrupt8259DisableIrq (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_8259_IRQ Irq
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Irq - TODO: add argument description
Returns:
TODO: add return values
**/
;
EFI_STATUS
EFIAPI
Interrupt8259GetInterruptLine (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_HANDLE PciHandle,
OUT UINT8 *Vector
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
PciHandle - TODO: add argument description
Vector - TODO: add argument description
Returns:
TODO: add return values
**/
;
EFI_STATUS
EFIAPI
Interrupt8259EndOfInterrupt (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_8259_IRQ Irq
)
/**
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Irq - TODO: add argument description
Returns:
TODO: add return values
**/
;
#endif