HardwareInterrupt2.h File Reference

#include <Protocol/HardwareInterrupt.h>

Go to the source code of this file.

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 EFI_STATUS(EFIAPI *	HARDWARE_INTERRUPT2_REGISTER) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, IN HARDWARE_INTERRUPT_HANDLER Handler)
typedef EFI_STATUS(EFIAPI *	HARDWARE_INTERRUPT2_ENABLE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source)
typedef EFI_STATUS(EFIAPI *	HARDWARE_INTERRUPT2_DISABLE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source)
typedef EFI_STATUS(EFIAPI *	HARDWARE_INTERRUPT2_INTERRUPT_STATE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, IN BOOLEAN *InterruptState)
typedef EFI_STATUS(EFIAPI *	HARDWARE_INTERRUPT2_END_OF_INTERRUPT) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source)
typedef EFI_STATUS(EFIAPI *	HARDWARE_INTERRUPT2_GET_TRIGGER_TYPE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, OUT EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE *TriggerType)
typedef EFI_STATUS(EFIAPI *	HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, IN 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 }

Variables
EFI_GUID	gHardwareInterrupt2ProtocolGuid

Detailed Description

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

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

Definition in file HardwareInterrupt2.h.

Macro Definition Documentation

EFI_HARDWARE_INTERRUPT2_PROTOCOL_GUID

#define EFI_HARDWARE_INTERRUPT2_PROTOCOL_GUID

Value:

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

Definition at line 16 of file HardwareInterrupt2.h.

Typedef Documentation

EFI_HARDWARE_INTERRUPT2_PROTOCOL

typedef struct _EFI_HARDWARE_INTERRUPT2_PROTOCOL EFI_HARDWARE_INTERRUPT2_PROTOCOL

Definition at line 28 of file HardwareInterrupt2.h.

HARDWARE_INTERRUPT2_DISABLE

typedef EFI_STATUS(EFIAPI * HARDWARE_INTERRUPT2_DISABLE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source)

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.

Definition at line 77 of file HardwareInterrupt2.h.

HARDWARE_INTERRUPT2_ENABLE

typedef EFI_STATUS(EFIAPI * HARDWARE_INTERRUPT2_ENABLE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source)

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.

Definition at line 60 of file HardwareInterrupt2.h.

HARDWARE_INTERRUPT2_END_OF_INTERRUPT

typedef EFI_STATUS(EFIAPI * HARDWARE_INTERRUPT2_END_OF_INTERRUPT) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source)

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.

Definition at line 114 of file HardwareInterrupt2.h.

HARDWARE_INTERRUPT2_GET_TRIGGER_TYPE

typedef EFI_STATUS(EFIAPI * HARDWARE_INTERRUPT2_GET_TRIGGER_TYPE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, OUT EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE *TriggerType)

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

Definition at line 132 of file HardwareInterrupt2.h.

HARDWARE_INTERRUPT2_INTERRUPT_STATE

typedef EFI_STATUS(EFIAPI * HARDWARE_INTERRUPT2_INTERRUPT_STATE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, IN BOOLEAN *InterruptState)

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

Definition at line 95 of file HardwareInterrupt2.h.

HARDWARE_INTERRUPT2_REGISTER

typedef EFI_STATUS(EFIAPI * HARDWARE_INTERRUPT2_REGISTER) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, IN HARDWARE_INTERRUPT_HANDLER Handler)

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.

Definition at line 42 of file HardwareInterrupt2.h.

HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE

typedef EFI_STATUS(EFIAPI * HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE) (IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, IN HARDWARE_INTERRUPT_SOURCE Source, IN EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE TriggerType)

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.

Definition at line 151 of file HardwareInterrupt2.h.

Enumeration Type Documentation

EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE

enum EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE

Definition at line 20 of file HardwareInterrupt2.h.