I2cEnumerate.h File Reference

Data Structures
struct	_EFI_I2C_ENUMERATE_PROTOCOL

Macros
#define	EFI_I2C_ENUMERATE_PROTOCOL_GUID   { 0xda8cd7c4, 0x1c00, 0x49e2, { 0x80, 0x3e, 0x52, 0x14, 0xe7, 0x01, 0x89, 0x4c }}

Typedefs
typedef struct _EFI_I2C_ENUMERATE_PROTOCOL	EFI_I2C_ENUMERATE_PROTOCOL
typedef IN OUT CONST EFI_I2C_DEVICE **	Device
typedef IN UINTN	I2cBusConfiguration
typedef IN UINTN OUT UINTN *	BusClockHertz

Functions
typedef	EFI_STATUS (EFIAPI *EFI_I2C_ENUMERATE_PROTOCOL_ENUMERATE)(IN CONST EFI_I2C_ENUMERATE_PROTOCOL *This

Variables
EFI_GUID	gEfiI2cEnumerateProtocolGuid

Detailed Description

I2C Device Enumerate Protocol as defined in the PI 1.3 specification.

This protocol supports the enumerations of device on the I2C bus.

Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

This protocol is from PI Version 1.3.

Macro Definition Documentation

#define EFI_I2C_ENUMERATE_PROTOCOL_GUID   { 0xda8cd7c4, 0x1c00, 0x49e2, { 0x80, 0x3e, 0x52, 0x14, 0xe7, 0x01, 0x89, 0x4c }}

Typedef Documentation

typedef IN UINTN OUT UINTN* BusClockHertz

typedef IN OUT CONST EFI_I2C_DEVICE** Device

typedef struct _EFI_I2C_ENUMERATE_PROTOCOL EFI_I2C_ENUMERATE_PROTOCOL

typedef IN UINTN I2cBusConfiguration

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EFI_I2C_ENUMERATE_PROTOCOL_GET_BUS_FREQUENCY

)

Enumerate the I2C devices

This function enables the caller to traverse the set of I2C devices on an I2C bus.

Parameters

[in]	This	The platform data for the next device on the I2C bus was returned successfully.
[in,out]	Device	Pointer to a buffer containing an EFI_I2C_DEVICE structure. Enumeration is started by setting the initial EFI_I2C_DEVICE structure pointer to NULL. The buffer receives an EFI_I2C_DEVICE structure pointer to the next I2C device.

Return values

EFI_SUCCESS	The platform data for the next device on the I2C bus was returned successfully.
EFI_INVALID_PARAMETER	Device is NULL
EFI_NO_MAPPING	*Device does not point to a valid EFI_I2C_DEVICE structure returned in a previous call Enumerate().

Get the requested I2C bus frequency for a specified bus configuration.

This function returns the requested I2C bus clock frequency for the I2cBusConfiguration. This routine is provided for diagnostic purposes and is meant to be called after calling Enumerate to get the I2cBusConfiguration value.

Parameters

[in]	This	Pointer to an EFI_I2C_ENUMERATE_PROTOCOL structure.
[in]	I2cBusConfiguration	I2C bus configuration to access the I2C device
[out]	*BusClockHertz	Pointer to a buffer to receive the I2C bus clock frequency in Hertz

Return values

EFI_SUCCESS	The I2C bus frequency was returned successfully.
EFI_INVALID_PARAMETER	BusClockHertz was NULL
EFI_NO_MAPPING	Invalid I2cBusConfiguration value

Variable Documentation

EFI_GUID gEfiI2cEnumerateProtocolGuid

Reference to variable defined in the .DEC file