I2C Interrupt driven driver Total rewrite Reference AVR315 for technical details. More...

#include "user_config.h"

Typedefs
typedef int8_t(*	i2c_callback_t) (void)
	I2C task list @ brief I2C callback function Used when automattically sending several transactions. More...

Functions
uint8_t	i2c_check_op (int8_t index)
	Check if I2C structure pointer is valid. More...

void	i2c_task_init ()
	Initialize I2C task op list NOTE: We ASSUME all i2c_task_op[].buf are statically allocated. More...

void	i2c_task_free_ops ()
	Free all allocated memory for i2c_[] pointers NOTE: We ASSUME all i2c_task_op[].buf are statically allocated. More...

i2c_op_t *	i2c_task_op_add (uint8_t address, uint8_t mode, uint8_t *buf, uint8_t len)
	I2C setup new OP but do not run it yet. More...

int8_t	i2c_task_next_op ()
	I2C task ISR callback function. More...

void	i2c_task_run ()
	Run all valid i2c_task_op[] tasks. More...

void	i2c_init (uint32_t speed)
	I2C initialize Clear all i2c_task_op[] pointers and disables I2C tasks. More...

int8_t	i2c_ok ()
	check if I2C trasnaction detected an error More...

int8_t	i2c_done ()
	Is i2c structure done sending/receiving ? More...

int8_t	i2c_task_done ()
	Are all i2c_task_op[] pointers done sending/receiving ? More...

uint8_t	i2c_fn (uint8_t address, uint8_t mode, uint8_t *buf, uint8_t len)
	I2C setup new OP but do not run it yet. More...

void	i2c_send_start ()
	Send I2C START and enable interrupts. More...

void	i2c_send_stop ()
	Send I2C STOP and disable interrupts. More...

static void	i2c_next ()
	Is there anything else to send ? Called after I2C transaction finishes. More...

void	i2c_timer ()
	I2C timer task - check for I2C operation timeouts. More...

	ISR (TWI_vect)
	I2C ISR for send/receive. More...

void	i2c_print_error (i2c_op_t *o)
	Display Errors for i2c_task_op[index]. More...

void	i2c_display_task_errors ()
	Display any task errors. More...

Variables
i2c_op_t	i2c
	I2C interrupt state registers. More...

i2c_callback_t	i2c_callback = (i2c_callback_t) NULL

i2c_task_t	i2c_task = { 0,0,0,0 }
	I2C task state. More...

i2c_op_t *	i2c_task_op [I2C_OPS] = { NULL }
	I2C task list. More...

static int8_t	i2c_init_status = 0

Detailed Description

I2C Interrupt driven driver Total rewrite Reference AVR315 for technical details.

I2C Interrupt driven driver.

Edit History

[1.0] [Mike Gore] Initial revision of file.

Copyright: Copyright © 2014-2020 Mike Gore, Inc. All rights reserved.; GNU Public License.

Author: Mike Gore

Definition in file i2c.c.

Typedef Documentation

◆ i2c_callback_t

typedef int8_t(* i2c_callback_t) (void)

I2C task list @ brief I2C callback function Used when automattically sending several transactions.

Definition at line 27 of file i2c.c.

Function Documentation

◆ i2c_check_op()

uint8_t i2c_check_op ( int8_t index )

Check if I2C structure pointer is valid.

Parameters

[in] index index of i2c_task_op[] array

Returns: 1 if OK, 0 if NOT

Definition at line 40 of file i2c.c.

Referenced by i2c_task_free_ops(), i2c_task_next_op(), and i2c_task_run().

◆ i2c_display_task_errors()

void i2c_display_task_errors ( )

Display any task errors.

Definition at line 684 of file i2c.c.

Referenced by main().

◆ i2c_done()

int8_t i2c_done ( )

Is i2c structure done sending/receiving ?

Returns: 1 DONE, 0 NOT DONE

Definition at line 379 of file i2c.c.

Referenced by i2c_fn().

◆ i2c_fn()

uint8_t i2c_fn	(	uint8_t	address,
		uint8_t	mode,
		uint8_t *	buf,
		uint8_t	len
	)

I2C setup new OP but do not run it yet.

Parameters

[in]	address	I2C address
[in]	mode	TW_READ or TW_WRITE
[in]	*buf	pointer to buffer for send or receive
[in]	len	size of buffer to read or write

Returns: 1 = OK, 0 = ERROR

Definition at line 407 of file i2c.c.

Referenced by i2c_rtc_read(), and i2c_rtc_write().

◆ i2c_init()

void i2c_init ( uint32_t speed )

I2C initialize Clear all i2c_task_op[] pointers and disables I2C tasks.

=========================================================================

Returns: void

Definition at line 316 of file i2c.c.

Referenced by i2c_rtc_init(), and main().

◆ i2c_next()

static void i2c_next ( )

static

Is there anything else to send ? Called after I2C transaction finishes.

Returns: void

Definition at line 489 of file i2c.c.

Referenced by ISR().

◆ i2c_ok()

int8_t i2c_ok ( )

check if I2C trasnaction detected an error

Did we get an error durring any i2c_task_op[] seand/receive operations

Returns: 1 OK, 0 NOT OK

Definition at line 369 of file i2c.c.

◆ i2c_print_error()

void i2c_print_error ( i2c_op_t * o )

Display Errors for i2c_task_op[index].

Parameters

[in] index index of i2c_task_op[] array

Returns: void

Definition at line 660 of file i2c.c.

Referenced by i2c_display_task_errors().

◆ i2c_send_start()

void i2c_send_start ( )

Send I2C START and enable interrupts.

Returns: void

Definition at line 451 of file i2c.c.

Referenced by i2c_fn(), i2c_task_next_op(), and i2c_task_run().

◆ i2c_send_stop()

void i2c_send_stop ( )

Send I2C STOP and disable interrupts.

Returns: void

Definition at line 468 of file i2c.c.

Referenced by i2c_next(), i2c_task_next_op(), and ISR().

◆ i2c_task_done()

int8_t i2c_task_done ( )

Are all i2c_task_op[] pointers done sending/receiving ?

Returns: 1 DONE, 0 NOT DONE

Definition at line 390 of file i2c.c.

◆ i2c_task_free_ops()

void i2c_task_free_ops ( )

Free all allocated memory for i2c_[] pointers NOTE: We ASSUME all i2c_task_op[].buf are statically allocated.

Returns: void

Definition at line 92 of file i2c.c.

◆ i2c_task_init()

void i2c_task_init ( )

Initialize I2C task op list NOTE: We ASSUME all i2c_task_op[].buf are statically allocated.

Returns: void

Definition at line 69 of file i2c.c.

◆ i2c_task_next_op()

int8_t i2c_task_next_op ( )

I2C task ISR callback function.

Returns: void

Definition at line 163 of file i2c.c.

Referenced by i2c_task_run().

◆ i2c_task_op_add()

i2c_op_t* i2c_task_op_add	(	uint8_t	address,
		uint8_t	mode,
		uint8_t *	buf,
		uint8_t	len
	)

I2C setup new OP but do not run it yet.

Parameters

[in]	address	I2C address
[in]	mode	TW_READ or TW_WRITE
[in]	*buf	pointer to buffer for send or receive
[in]	len	size of buffer to read or write

Returns: i2c_op_t * pointer

Definition at line 135 of file i2c.c.

◆ i2c_task_run()

void i2c_task_run ( )

Run all valid i2c_task_op[] tasks.

Returns: void

Definition at line 225 of file i2c.c.

Referenced by main().

◆ i2c_timer()

void i2c_timer ( )

I2C timer task - check for I2C operation timeouts.

Returns: void

Definition at line 503 of file i2c.c.

Referenced by i2c_init().

◆ ISR()

ISR ( TWI_vect )

I2C ISR for send/receive.

Returns: void

Definition at line 519 of file i2c.c.

Variable Documentation

◆ i2c

i2c_op_t i2c

I2C interrupt state registers.

Definition at line 22 of file i2c.c.

Referenced by i2c_done(), i2c_fn(), i2c_init(), i2c_ok(), i2c_print_error(), i2c_send_start(), i2c_send_stop(), i2c_task_next_op(), i2c_task_run(), i2c_timer(), and ISR().

◆ i2c_callback

i2c_callback_t i2c_callback = (i2c_callback_t) NULL

Definition at line 28 of file i2c.c.

Referenced by i2c_fn(), i2c_next(), and i2c_task_run().

◆ i2c_init_status

int8_t i2c_init_status = 0

static

Definition at line 309 of file i2c.c.

Referenced by i2c_init().

◆ i2c_task

i2c_task_t i2c_task = { 0,0,0,0 }

I2C task state.

Definition at line 31 of file i2c.c.

Referenced by i2c_display_task_errors(), i2c_init(), i2c_task_done(), i2c_task_init(), i2c_task_next_op(), i2c_task_run(), ISR(), and main().

◆ i2c_task_op

i2c_op_t* i2c_task_op[I2C_OPS] = { NULL }

I2C task list.

Definition at line 33 of file i2c.c.

Referenced by i2c_check_op(), i2c_display_task_errors(), i2c_init(), i2c_task_free_ops(), i2c_task_init(), i2c_task_next_op(), and i2c_task_run().

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ i2c_callback_t

Function Documentation

◆ i2c_check_op()

◆ i2c_display_task_errors()

◆ i2c_done()

◆ i2c_fn()

◆ i2c_init()

◆ i2c_next()

◆ i2c_ok()

◆ i2c_print_error()

◆ i2c_send_start()

◆ i2c_send_stop()

◆ i2c_task_done()

◆ i2c_task_free_ops()

◆ i2c_task_init()

◆ i2c_task_next_op()

◆ i2c_task_op_add()

◆ i2c_task_run()

◆ i2c_timer()

◆ ISR()

Variable Documentation

◆ i2c

◆ i2c_callback

◆ i2c_init_status

◆ i2c_task

◆ i2c_task_op