EmbeddedGpio.h File Reference

Data Structures
struct	_EMBEDDED_GPIO
struct	_GPIO_CONTROLLER
struct	_PLATFORM_GPIO_CONTROLLER

Macros
#define	GPIO(Port, Pin)   ((EMBEDDED_GPIO_PIN)(((Port) << (16)) | (Pin)))
#define	GPIO_PIN(x)   ((EMBEDDED_GPIO_PIN)(x) & (0xFFFF))
#define	GPIO_PORT(x)   ((EMBEDDED_GPIO_PIN)(x) >> (16))

Typedefs
typedef struct _EMBEDDED_GPIO	EMBEDDED_GPIO
typedef UINTN	EMBEDDED_GPIO_PIN
typedef IN EMBEDDED_GPIO_PIN	Gpio
typedef IN EMBEDDED_GPIO_PIN OUT UINTN *	Value
typedef IN EMBEDDED_GPIO_PIN IN EMBEDDED_GPIO_MODE	Mode
typedef IN EMBEDDED_GPIO_PIN IN EMBEDDED_GPIO_PULL	Direction
typedef struct _GPIO_CONTROLLER	GPIO_CONTROLLER
typedef struct _PLATFORM_GPIO_CONTROLLER	PLATFORM_GPIO_CONTROLLER

Enumerations
enum	EMBEDDED_GPIO_MODE {   GPIO_MODE_INPUT = 0x00, GPIO_MODE_OUTPUT_0 = 0x0E, GPIO_MODE_OUTPUT_1 = 0x0F, GPIO_MODE_SPECIAL_FUNCTION_2 = 0x02,   GPIO_MODE_SPECIAL_FUNCTION_3 = 0x03, GPIO_MODE_SPECIAL_FUNCTION_4 = 0x04, GPIO_MODE_SPECIAL_FUNCTION_5 = 0x05, GPIO_MODE_SPECIAL_FUNCTION_6 = 0x06,   GPIO_MODE_SPECIAL_FUNCTION_7 = 0x07, GPIO_MODE_INPUT = 0x00, GPIO_MODE_OUTPUT_0 = 0x0E, GPIO_MODE_OUTPUT_1 = 0x0F,   GPIO_MODE_SPECIAL_FUNCTION_2 = 0x02, GPIO_MODE_SPECIAL_FUNCTION_3 = 0x03, GPIO_MODE_SPECIAL_FUNCTION_4 = 0x04, GPIO_MODE_SPECIAL_FUNCTION_5 = 0x05,   GPIO_MODE_SPECIAL_FUNCTION_6 = 0x06, GPIO_MODE_SPECIAL_FUNCTION_7 = 0x07 }
enum	EMBEDDED_GPIO_PULL {   GPIO_PULL_NONE, GPIO_PULL_UP, GPIO_PULL_DOWN, GPIO_PULL_NONE,   GPIO_PULL_UP, GPIO_PULL_DOWN }

Functions
typedef	EFI_STATUS (EFIAPI *EMBEDDED_GPIO_GET)(IN EMBEDDED_GPIO *This

Variables
EFI_GUID	gEmbeddedGpioProtocolGuid
EFI_GUID	gPlatformGpioProtocolGuid

Detailed Description

Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.

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

Macro Definition Documentation

#define GPIO	(		Port,
			Pin
	)		((EMBEDDED_GPIO_PIN)(((Port) << (16)) | (Pin)))

#define GPIO_PIN

(

x

)

((EMBEDDED_GPIO_PIN)(x) & (0xFFFF))

#define GPIO_PORT

(

x

)

((EMBEDDED_GPIO_PIN)(x) >> (16))

Typedef Documentation

typedef IN EMBEDDED_GPIO_PIN IN EMBEDDED_GPIO_PULL Direction

typedef struct _EMBEDDED_GPIO EMBEDDED_GPIO

typedef UINTN EMBEDDED_GPIO_PIN

typedef IN EMBEDDED_GPIO_PIN Gpio

typedef struct _GPIO_CONTROLLER GPIO_CONTROLLER

typedef IN EMBEDDED_GPIO_PIN OUT EMBEDDED_GPIO_MODE* Mode

typedef struct _PLATFORM_GPIO_CONTROLLER PLATFORM_GPIO_CONTROLLER

typedef IN EMBEDDED_GPIO_PIN OUT UINTN* Value

Enumeration Type Documentation

enum EMBEDDED_GPIO_MODE

Enumerator
GPIO_MODE_INPUT
GPIO_MODE_OUTPUT_0
GPIO_MODE_OUTPUT_1
GPIO_MODE_SPECIAL_FUNCTION_2
GPIO_MODE_SPECIAL_FUNCTION_3
GPIO_MODE_SPECIAL_FUNCTION_4
GPIO_MODE_SPECIAL_FUNCTION_5
GPIO_MODE_SPECIAL_FUNCTION_6
GPIO_MODE_SPECIAL_FUNCTION_7
GPIO_MODE_INPUT
GPIO_MODE_OUTPUT_0
GPIO_MODE_OUTPUT_1
GPIO_MODE_SPECIAL_FUNCTION_2
GPIO_MODE_SPECIAL_FUNCTION_3
GPIO_MODE_SPECIAL_FUNCTION_4
GPIO_MODE_SPECIAL_FUNCTION_5
GPIO_MODE_SPECIAL_FUNCTION_6
GPIO_MODE_SPECIAL_FUNCTION_7

enum EMBEDDED_GPIO_PULL

Enumerator
GPIO_PULL_NONE
GPIO_PULL_UP
GPIO_PULL_DOWN
GPIO_PULL_NONE
GPIO_PULL_UP
GPIO_PULL_DOWN

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EMBEDDED_GPIO_GET

)

Gets the state of a GPIO pin

Parameters

This	Pointer to protocol
Gpio	Which pin to read
Value	State of the pin

Return values

EFI_SUCCESS	GPIO state returned in Value
EFI_INVALID_PARAMETER	Value is NULL
EFI_NOT_FOUND	Pin does not exit

Sets the state of a GPIO pin

Parameters

This	Pointer to protocol
Gpio	Which pin to modify
Mode	Mode to set

Return values

EFI_SUCCESS	GPIO set as requested
EFI_INVALID_PARAMETER	Invalid mode
EFI_NOT_FOUND	Pin does not exit

Gets the mode (function) of a GPIO pin

Parameters

This	Pointer to protocol
Gpio	Which pin
Mode	Pointer to output mode value

Return values

EFI_SUCCESS	Mode value retrieved
EFI_INVALID_PARAMETER	Mode is NULL
EFI_NOT_FOUND	Pin does not exit

Sets the pull-up / pull-down resistor of a GPIO pin

Parameters

This	Pointer to PPI
Gpio	Port/pin index
Pull	The pullup/pulldown mode to set

Return values

EFI_SUCCESS	Mode was set
EFI_NOT_FOUND	Pin does not exist
EFI_UNSUPPORTED	Action not supported

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.

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 gEmbeddedGpioProtocolGuid

EFI_GUID gPlatformGpioProtocolGuid