IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h File Reference


Data Structures

struct  _EFI_LEGACY_INTERRUPT_PROTOCOL

Defines

#define EFI_LEGACY_INTERRUPT_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_LEGACY_INTERRUPT_PROTOCOL 
EFI_LEGACY_INTERRUPT_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS )(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, OUT UINT8 *NumberPirqs)
typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_GET_LOCATION )(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, OUT UINT8 *Bus, OUT UINT8 *Device, OUT UINT8 *Function)
typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_READ_PIRQ )(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, IN UINT8 PirqNumber, OUT UINT8 *PirqData)
typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_WRITE_PIRQ )(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, IN UINT8 PirqNumber, IN UINT8 PirqData)

Variables

EFI_GUID gEfiLegacyInterruptProtocolGuid

Detailed Description

This protocol abstracts the PIRQ programming from the generic EFI Compatibility Support Modules (CSMs).

Copyright (c) 2007 - 2010, 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 that 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.

Revision Reference:
This protocol is defined in Framework for the EFI Compatibility Support Module specification. Version 0.97.

Define Documentation

#define EFI_LEGACY_INTERRUPT_PROTOCOL_GUID

Value:

{ \
    0x31ce593d, 0x108a, 0x485d, {0xad, 0xb2, 0x78, 0xf2, 0x1f, 0x29, 0x66, 0xbe } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_GET_LOCATION)(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, OUT UINT8 *Bus, OUT UINT8 *Device, OUT UINT8 *Function)

Gets the PCI location associated with this protocol.

Parameters:
This The Protocol instance pointer.
Bus The PCI Bus.
Device The PCI Device.
Function The PCI Function.
Return values:
EFI_SUCCESS The Bus, Device, and Function were returned successfully.

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS)(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, OUT UINT8 *NumberPirqs)

Get the number of PIRQs this hardware supports.

Parameters:
This The protocol instance pointer.
NumberPirsq The number of PIRQs that are supported.
Return values:
EFI_SUCCESS The number of PIRQs was returned successfully.

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_READ_PIRQ)(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, IN UINT8 PirqNumber, OUT UINT8 *PirqData)

Read the PIRQ register and return the data

Parameters:
This The protocol instance pointer.
PirqNumber The PIRQ register to read.
PirqData The data read.
Return values:
EFI_SUCCESS The data was read.
EFI_INVALID_PARAMETER Invalid PIRQ number.

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_INTERRUPT_WRITE_PIRQ)(IN EFI_LEGACY_INTERRUPT_PROTOCOL *This, IN UINT8 PirqNumber, IN UINT8 PirqData)

Write the specified PIRQ register with the given data.

Parameters:
This The protocol instance pointer.
PirqNumber A PIRQ register to read.
PirqData The data to write.
Return values:
EFI_SUCCESS The PIRQ was programmed.
EFI_INVALID_PARAMETER Invalid PIRQ number.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1