i2c_driver.h

/*******************************************************************************
 * Copyright (c) 2009-2014, MAV'RIC Development Team
 * 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. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
 ******************************************************************************/

/*******************************************************************************
 * \file i2c_driver.h
 * 
 * \author MAV'RIC Team
 * \author Felix Schill
 *   
 * \brief The i2c driver
 *
 ******************************************************************************/
 
 
#ifndef I2C_DRIVER_H_
#define I2C_DRIVER_H_


#include "twim.h"
#include <stdint.h>
#include "dma_channel_config.h"

#define I2C_DEVICES 2               
#define I2C_SCHEDULE_SLOTS 10       

#define I2C_READ 0                  
#define I2C_WRITE 1                 
#define I2C_WRITE1_THEN_READ 2      


typedef struct 
{
    uint8_t     slave_address;              
    uint16_t    i2c_speed;                  
    int8_t      direction;                  
    int8_t      write_then_read_preamble;   
    uint8_t*    write_data;                 
    uint32_t    write_count;                
    uint8_t*    read_data;                  
    uint32_t    read_count;                 
} i2c_packet_conf_t;

typedef void (i2c_callback_t)(i2c_packet_conf_t* data);

typedef struct  
{
    i2c_packet_conf_t config;
    uint8_t         schedule_slot;          
    int32_t         repetition_rate_ms;     
    uint8_t         trigger_next_event;     
    int8_t          active;                 
    int8_t          transfer_in_progress;   
    i2c_callback_t* callback;               
} i2c_schedule_event_t ;

int32_t i2c_driver_init(uint8_t i2c_device);

int8_t i2c_driver_reset(uint8_t i2c_device);

int8_t i2c_driver_add_request(uint8_t i2c_device, i2c_schedule_event_t* new_event);

int8_t i2c_driver_change_request(uint8_t i2c_device, i2c_schedule_event_t* new_event);

int8_t i2c_driver_enable_request(uint8_t i2c_device, uint8_t schedule_slot);

int8_t i2c_driver_pause_request(uint8_t i2c_device, uint8_t schedule_slot);

int8_t i2c_driver_remove_request(uint8_t i2c_device, uint8_t schedule_slot);  // if the slot is currently processing, this blocks until it's finished

int8_t i2c_driver_trigger_request(uint8_t i2c_device, uint8_t schedule_slot);
#endif /* I2C_DRIVER_H_ */