i2c.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2012 David Michael Betz
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */
 
#ifndef __I2C_H__
#define __I2C_H__
 
#if defined(__cplusplus)
extern "C" {
#endif
 
#include <stdint.h>
#include "i2c_driver.h"
 
typedef struct I2C I2C;
 
/* i2c operations */
typedef struct {
    int (*close)(I2C *dev);
    int (*read)(I2C *dev, int address, uint8_t *buffer, int count, int stop);
    int (*readMore)(I2C *dev, uint8_t *buffer, int count, int stop);
    int (*write)(I2C *dev, int address, uint8_t *buffer, int count, int stop);
    int (*writeMore)(I2C *dev, uint8_t *buffer, int count, int stop);
} I2C_OPS;
 
/* i2c state information */
struct I2C {
    I2C_OPS *ops;
};
 
typedef struct {
    I2C i2c;
    int cog;
    volatile I2C_MAILBOX mailbox;
} I2C_COGDRIVER;
 
typedef struct {
    I2C i2c;
    uint32_t scl_mask;
    uint32_t sda_mask;
} I2C_SIMPLE;
 
I2C *i2cOpen(I2C_COGDRIVER *dev, int scl, int sda, int freq);
 
void *i2cGetCogBuffer(void);
 
I2C *simple_i2cOpen(I2C_SIMPLE *dev, int scl, int sda);
 
I2C *i2cBootOpen(void);
 
void *i2cBootBuffer(void);
 
static inline int i2cClose(I2C *dev)
{
    return (*dev->ops->close)(dev);
}
 
static inline int i2cWrite(I2C *dev, int address, uint8_t *buffer, int count, int stop)
{
    return (*dev->ops->write)(dev, address, buffer, count, stop);
}
 
static inline int i2cWriteMore(I2C *dev, uint8_t *buffer, int count, int stop)
{
    return (*dev->ops->writeMore)(dev, buffer, count, stop);
}
 
static inline int i2cRead(I2C *dev, int address, uint8_t *buffer, int count, int stop)
{
    return (*dev->ops->read)(dev, address, buffer, count, stop);
}
 
static inline int i2cReadMore(I2C *dev, uint8_t *buffer, int count, int stop)
{
    return (*dev->ops->readMore)(dev, buffer, count, stop);
}
 
/* internal functions */
int cog_i2cRead(I2C *dev, int address, uint8_t *buffer, int count, int stop);
int cog_i2cReadMore(I2C *dev, uint8_t *buffer, int count, int stop);
int cog_i2cWrite(I2C *dev, int address, uint8_t *buffer, int count, int stop);
int cog_i2cWriteMore(I2C *dev, uint8_t *buffer, int count, int stop);
 
#if defined(__cplusplus)
}
#endif
 
#endif