Symbols ![]()
loading...
Files ![]()
loading...
i2c_read_timeout_us() function
Attempt to read specified number of bytes from address, with timeout
Syntax
static inline int i2c_read_timeout_us(i2c_inst_t *i2c,
uint8_t addr,
uint8_t *dst,
size_t len,
bool nostop,
uint timeout_us);
Arguments
Argument
Description
addr
7-bit address of device to read from
dst
Pointer to buffer to receive data
len
Length of data in bytes to receive
nostop
If true, master retains control of the bus at the end of the transfer (no Stop is issued), and the next transfer will begin with a Restart rather than a Start.
timeout_us
The time that the function will wait for the entire transaction to complete
Return value
Number of bytes read, or PICO_ERROR_GENERIC if address not acknowledged, no device present, or PICO_ERROR_TIMEOUT if a timeout occurred.
Related Functions
Found 26 other functions taking a ![]()
i2c_inst
argument:
Function
Description
Attempt to write specified number of bytes to address, blocking
Attempt to read specified number of bytes from address, blocking
Initialise the I2C HW block Put the I2C hardware into a known state, and enable it. Must be called before other functions. By default, the I2C is configured to operate as a master. The I2C bus frequency is set as close as possible to requested, and the actual rate set is returned
Return pointer to structure containing i2c hardware registers
Convert I2C instance to hardware instance number
Set I2C port to slave mode
Pop a byte from I2C Rx FIFO. This function is non-blocking and assumes the Rx FIFO isn't empty.
Determine non-blocking write space available
Determine number of bytes received
Set I2C baudrate Set I2C bus frequency as close as possible to requested, and return actual rate set. Baudrate may not be as exactly requested due to clocking limitations.
Attempt to read specified number of bytes from address, blocking until the specified absolute time is reached.
Attempt to write specified number of bytes to address, blocking until the specified absolute time is reached.
Configure an I2C instance for slave mode.
Push a byte into I2C Tx FIFO. This function is non-blocking and assumes the Tx FIFO isn't full.
Disable the I2C HW block Disable the I2C again if it is no longer used. Must be reinitialised before being used again.
Restore an I2C instance to master mode.
Return the DREQ to use for pacing transfers to/from a particular I2C instance
Attempt to write specified number of bytes to address, with timeout
Read direct from RX FIFO Reads directly from the I2C RX FIFO which is mainly useful for slave-mode operation.
Write direct to TX FIFO Writes directly to the I2C TX FIFO which is mainly useful for slave-mode operation.