FdtClient.h File Reference

Data Structures
struct	_FDT_CLIENT_PROTOCOL

Macros
#define	FDT_CLIENT_PROTOCOL_GUID

Typedefs
typedef struct _FDT_CLIENT_PROTOCOL	FDT_CLIENT_PROTOCOL
typedef IN INT32	Node
typedef IN INT32 IN CONST CHAR8 *	PropertyName
typedef IN INT32 IN CONST CHAR8 OUT CONST VOID **	Prop
typedef IN INT32 IN CONST CHAR8 OUT CONST VOID OUT UINT32 *	PropSize
typedef IN CONST CHAR8 *	CompatibleString
typedef IN CONST CHAR8 IN INT32	PrevNode
typedef IN CONST CHAR8 OUT CONST VOID **	Reg
typedef IN CONST CHAR8 OUT CONST VOID OUT UINTN *	AddressCells
typedef IN CONST CHAR8 OUT CONST VOID OUT UINTN OUT UINTN *	SizeCells
typedef IN CONST CHAR8 OUT CONST VOID OUT UINTN OUT UINTN OUT UINT32 *	RegSize

Functions
typedef	EFI_STATUS (EFIAPI *FDT_CLIENT_GET_NODE_PROPERTY)(IN FDT_CLIENT_PROTOCOL *This

Variables
EFI_GUID	gFdtClientProtocolGuid

Detailed Description

DISCLAIMER: the FDT_CLIENT_PROTOCOL introduced here is a work in progress, and should not be used outside of the EDK II tree.

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

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

Macro Definition Documentation

#define FDT_CLIENT_PROTOCOL_GUID

Value:

{ \
  0xE11FACA0, 0x4710, 0x4C8E, {0xA7, 0xA2, 0x01, 0xBA, 0xA2, 0x59, 0x1B, 0x4C} \
  }

Typedef Documentation

typedef OUT INT32 OUT CONST VOID OUT UINTN * AddressCells

typedef IN CONST CHAR8 * CompatibleString

typedef struct _FDT_CLIENT_PROTOCOL FDT_CLIENT_PROTOCOL

typedef OUT INT32 * Node

typedef IN INT32 PrevNode

typedef IN CONST CHAR8 IN CONST CHAR8 OUT CONST VOID ** Prop

typedef IN CONST CHAR8 IN CONST CHAR8 * PropertyName

typedef IN CONST CHAR8 IN CONST CHAR8 OUT CONST VOID OUT UINT32 * PropSize

typedef OUT INT32 OUT CONST VOID ** Reg

typedef OUT INT32 OUT CONST VOID OUT UINTN OUT UINTN OUT UINT32 * RegSize

typedef OUT INT32 OUT CONST VOID OUT UINTN OUT UINTN * SizeCells

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

FDT_CLIENT_GET_NODE_PROPERTY

)

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 gFdtClientProtocolGuid