twi.h

Go to the documentation of this file.

/*This file has been prepared for Doxygen automatic documentation generation.*/
/* ************************************************************************

Copyright (c) 2006, Atmel Corporation All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the
following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. The name of ATMEL may not be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ATMEL ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE EXPRESSLY AND SPECIFICALLY
DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

************************************************************************ */


#ifndef _TWI_H_
#define _TWI_H_

#ifdef __GNUC__
        #include <avr32/io.h>
#elif __ICCAVR32__
        #include <avr32/ioap7000.h>
#else
        #error No known compiler used
#endif


#define TWI_SUCCESS                          0
#define TWI_INVALID_ARGUMENT    -1
#define TWI_ARBITRATION_LOST    -2

#define TWI_NO_CHIP_FOUND               -3
#define TWI_RECEIVE_OVERRUN             -4
#define TWI_RECEIVE_NACK            -5

#define TWI_SEND_OVERRUN                -6
#define TWI_SEND_NACK                   -7

#define TWI_TIMEOUT 5000

struct twi_options_t
{
        unsigned long cpu_hz;

        unsigned long speed;

        unsigned char twi_addr;

};

struct twi_package_t
{

        char chip;

        unsigned int addr;

        int addr_length;

        char *buffer;

        unsigned int length;
};

int twi_init(struct twi_options_t * opt);


int twi_probe(char chip_addr);


int twi_read(struct twi_package_t * package);


/*
 * twi_write: -  Write multiple bytes to an twi compatable device
 *
 * \param *package      Package information and data
 *                                      (see \ref twi_package_t)
 * \return 0 in case of success
 */
int twi_write(struct twi_package_t * package);

#endif

---