I2cFunctions.h File Reference

Header file for USB-I2C interfacing module. More...

#include "main.h"

Go to the source code of this file.

Functions
CyU3PReturnStatus_t	AdiI2CReadHandler (uint16_t RequestLength)
	Handler for I2C read command from control endpoint. More...
CyU3PReturnStatus_t	AdiI2CWriteHandler (uint16_t RequestLength)
	Handler for I2C write command from control endpoint. More...
CyU3PReturnStatus_t	AdiI2CInit (uint32_t BitRate, CyBool_t isDMA)
	Init I2C peripheral. More...
uint32_t	I2CParseUSBBuffer (uint32_t *timeout, uint32_t *numBytes, CyU3PI2cPreamble_t *preamble)
	Parses I2C command data from the USB Buffer. Used for read/write/stream. More...

Detailed Description

Header file for USB-I2C interfacing module.

Copyright (c) 2018-2020 Analog Devices, Inc. All Rights Reserved. This software is proprietary to Analog Devices, Inc. and its licensors.

THIS SOFTWARE UTILIZES LIBRARIES DEVELOPED AND MAINTAINED BY CYPRESS INC. THE LICENSE INCLUDED IN THIS REPOSITORY DOES NOT EXTEND TO CYPRESS PROPERTY.

Use of this file is governed by the license agreement included in this repository.

Date

5/13/2020

Author

A. Nolan (alex..nosp@m.nola.nosp@m.n@ana.nosp@m.log..nosp@m.com)

Function Documentation

AdiI2CInit()

CyU3PReturnStatus_t AdiI2CInit	(	uint32_t	BitRate,
		CyBool_t	isDMA
	)

Init I2C peripheral.

Parameters

BitRate	Bit rate to configure I2C peripheral for (100KHz - 1MHz)
isDMA	If the I2C peripheral should be configured for DMA

Returns

A status code indicating the success of I2C init operation.

AdiI2CReadHandler()

CyU3PReturnStatus_t AdiI2CReadHandler

(

uint16_t

RequestLength

)

Handler for I2C read command from control endpoint.

Parameters

RequestLength

Number of bytes received over control endpoint

Returns

A status code indicating the success of the I2C read command

This function uses the I2C peripheral in register mode to perform a single transfer. The number of bytes read in a single transfer can be 0 bytes - 12KB.

AdiI2CWriteHandler()

CyU3PReturnStatus_t AdiI2CWriteHandler

(

uint16_t

RequestLength

)

Handler for I2C write command from control endpoint.

Parameters

RequestLength

Number of bytes received over control endpoint

Returns

A status code indicating the success of the I2C write command

This function uses the I2C peripheral in register mode to perform a single transfer. The number of bytes written in a single transfer is limited to ~4070.

I2CParseUSBBuffer()

uint32_t I2CParseUSBBuffer	(	uint32_t *	timeout,
		uint32_t *	numBytes,
		CyU3PI2cPreamble_t *	preamble
	)

Parses I2C command data from the USB Buffer. Used for read/write/stream.

Parameters

timeout	Timeout value for I2C transaction. Return by reference.
numBytes	Number of bytes field in USBBuffer. Return by reference
preamble	I2C preamble struct stored in USBBuffer. Return by reference

Returns

Index for the start of the I2C transmit data (if it exists)