aversive_10-03-12/modules/comm/i2c/i2c.h

Go to the documentation of this file.

/*  
 *  Copyright Droids Corporation, Microb Technology, Eirbot (2007)
 * 
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Revision : $Id: i2c.h,v 1.6 2009-03-15 21:51:17 zer0 Exp $
 *
 */

/* Author Zer0, based on Tof old i2c module */

#ifndef _I2C_H_
#define _I2C_H_

#include <aversive.h>
#include <i2c_config.h>

#define I2C_DEBUG 1

#define I2C_ADD_GENCALL 0x00

/* this is not a valid address regarding the I2C protocol, but is used
 * as a magic for addressing the master from the slave */
#define I2C_ADD_MASTER  0x80




/* I2C modes */
typedef enum { I2C_MODE_UNINIT,      
               I2C_MODE_SLAVE,       
#ifdef CONFIG_MODULE_I2C_MASTER
               I2C_MODE_MASTER,      
#endif
#ifdef CONFIG_MODULE_I2C_MULTIMASTER
               I2C_MODE_MULTIMASTER, 
#endif
} i2c_mode_t ;

/* control flags */
#define I2C_CTRL_GENERIC            0x00

#define I2C_CTRL_SYNC               0x01

#define I2C_CTRL_DONT_RELEASE_BUS   0x02


/* status flags */
#define I2C_STATUS_READY            0x00
#define I2C_STATUS_MASTER_XMIT      0x01
#define I2C_STATUS_MASTER_RECV      0x02
#define I2C_STATUS_SLAVE_XMIT_WAIT  0x04
#define I2C_STATUS_SLAVE_XMIT       0x08
#define I2C_STATUS_SLAVE_RECV       0x10
#define I2C_STATUS_OP_FINISHED      0x20
#define I2C_STATUS_NEED_XMIT_EVT    0x40
#define I2C_STATUS_NEED_RECV_EVT    0x80


void i2c_init(i2c_mode_t mode, uint8_t add);


void i2c_register_recv_event(void (*event)(uint8_t *, int8_t));

void i2c_register_recv_byte_event(void (*event)(uint8_t, uint8_t, uint8_t));


void i2c_register_send_event(void (*event)(int8_t));


int8_t i2c_send(uint8_t dest_add, uint8_t *buf, uint8_t size, uint8_t ctrl);

int8_t i2c_resend(void);

int8_t i2c_rerecv(void);

void i2c_release_bus(void);

int8_t i2c_recv(uint8_t dest_add, uint8_t size, uint8_t ctrl);


int8_t i2c_flush(void);

uint8_t i2c_set_recv_size(uint8_t size);

i2c_mode_t i2c_mode(void);

uint8_t i2c_status(void);

uint8_t i2c_get_recv_buffer(uint8_t *buf, uint8_t size);

void i2c_reset(void);

#if I2C_DEBUG == 1

void i2c_debug(void);
#endif


#endif

---