HardwareInterrupt2.h File Reference

Data Structures
struct	_EFI_HARDWARE_INTERRUPT2_PROTOCOL

Macros
#define	EFI_HARDWARE_INTERRUPT2_PROTOCOL_GUID

Typedefs
typedef struct _EFI_HARDWARE_INTERRUPT2_PROTOCOL	EFI_HARDWARE_INTERRUPT2_PROTOCOL
typedef IN HARDWARE_INTERRUPT_SOURCE	Source
typedef IN HARDWARE_INTERRUPT_SOURCE IN HARDWARE_INTERRUPT_HANDLER	Handler
typedef IN HARDWARE_INTERRUPT_SOURCE IN BOOLEAN *	InterruptState
typedef IN HARDWARE_INTERRUPT_SOURCE OUT EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE *	TriggerType

Enumerations
enum	EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE { EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_LOW, EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_HIGH, EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_FALLING, EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_RISING }

Functions
typedef	EFI_STATUS (EFIAPI *HARDWARE_INTERRUPT2_REGISTER)(IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This

Variables
EFI_GUID	gHardwareInterrupt2ProtocolGuid

Detailed Description

Copyright (c) 2016-2017, Linaro Ltd. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_HARDWARE_INTERRUPT2_PROTOCOL_GUID

Value:

{ 0x32898322, 0x2d1a, 0x474a, \
    { 0xba, 0xaa, 0xf3, 0xf7, 0xcf, 0x56, 0x94, 0x70 } }

Typedef Documentation

typedef struct _EFI_HARDWARE_INTERRUPT2_PROTOCOL EFI_HARDWARE_INTERRUPT2_PROTOCOL

typedef IN HARDWARE_INTERRUPT_SOURCE IN HARDWARE_INTERRUPT_HANDLER Handler

typedef IN HARDWARE_INTERRUPT_SOURCE IN BOOLEAN* InterruptState

typedef IN HARDWARE_INTERRUPT_SOURCE Source

typedef IN HARDWARE_INTERRUPT_SOURCE IN EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE TriggerType

Enumeration Type Documentation

enum EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE

Enumerator
EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_LOW
EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_HIGH
EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_FALLING
EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_RISING

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE

)

Register Handler for the specified interrupt source.

Parameters

This	Instance pointer for this protocol
Source	Hardware source of the interrupt
Handler	Callback for interrupt. NULL to unregister

Return values

EFI_SUCCESS	Source was updated to support Handler.
EFI_DEVICE_ERROR	Hardware could not be programmed.

Enable interrupt source Source.

Parameters

This	Instance pointer for this protocol
Source	Hardware source of the interrupt

Return values

EFI_SUCCESS	Source interrupt enabled.
EFI_DEVICE_ERROR	Hardware could not be programmed.

Disable interrupt source Source.

Parameters

This	Instance pointer for this protocol
Source	Hardware source of the interrupt

Return values

EFI_SUCCESS	Source interrupt disabled.
EFI_DEVICE_ERROR	Hardware could not be programmed.

Return current state of interrupt source Source.

Parameters

This	Instance pointer for this protocol
Source	Hardware source of the interrupt
InterruptState	TRUE: source enabled, FALSE: source disabled.

Return values

EFI_SUCCESS	InterruptState is valid
EFI_DEVICE_ERROR	InterruptState is not valid

Signal to the hardware that the End Of Interrupt state has been reached.

Parameters

This	Instance pointer for this protocol
Source	Hardware source of the interrupt

Return values

EFI_SUCCESS	Source interrupt EOI'ed.
EFI_DEVICE_ERROR	Hardware could not be programmed.

Return the configured trigger type for an interrupt source

Parameters

This	Instance pointer for this protocol
Source	Hardware source of the interrupt
TriggerType	The configured trigger type

Return values

EFI_SUCCESS	Operation successful
EFI_DEVICE_ERROR	Information could not be returned

Configure the trigger type for an interrupt source

Parameters

This	Instance pointer for this protocol
Source	Hardware source of the interrupt
TriggerType	The trigger type to configure

Return values

EFI_SUCCESS	Operation successful
EFI_DEVICE_ERROR	Hardware could not be programmed.

Variable Documentation

EFI_GUID gHardwareInterrupt2ProtocolGuid