I2C.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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.
 */
#ifndef ti_drivers_I2C__include
#define ti_drivers_I2C__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#define I2C_CMD_RESERVED             32

#define I2C_STATUS_RESERVED         -32

#define I2C_STATUS_SUCCESS          0

#define I2C_STATUS_ERROR           -1

#define I2C_STATUS_UNDEFINEDCMD   -2

/* Add I2C_CMD_<commands> here */

typedef struct I2C_Config      *I2C_Handle;

typedef struct I2C_Transaction {
    void    *writeBuf;    
    size_t  writeCount;   
    void    *readBuf;     
    size_t  readCount;    
    unsigned char slaveAddress; 
    void    *arg;         
    void    *nextPtr;     
} I2C_Transaction;

typedef enum I2C_TransferMode {
    I2C_MODE_BLOCKING,  
    I2C_MODE_CALLBACK   
} I2C_TransferMode;

typedef void (*I2C_CallbackFxn)(I2C_Handle, I2C_Transaction *, bool);

typedef enum I2C_BitRate {
    I2C_100kHz = 0,
    I2C_400kHz = 1
} I2C_BitRate;

typedef struct I2C_Params {
    I2C_TransferMode    transferMode; 
    I2C_CallbackFxn     transferCallbackFxn; 
    I2C_BitRate         bitRate; 
    uintptr_t           custom;  
} I2C_Params;

typedef void        (*I2C_CancelFxn)    (I2C_Handle handle);

typedef void        (*I2C_CloseFxn)    (I2C_Handle handle);

typedef int         (*I2C_ControlFxn)  (I2C_Handle handle,
                                        unsigned int cmd,
                                        void *arg);

typedef void        (*I2C_InitFxn)     (I2C_Handle handle);

typedef I2C_Handle  (*I2C_OpenFxn)     (I2C_Handle handle,
                                        I2C_Params *params);

typedef bool        (*I2C_TransferFxn) (I2C_Handle handle,
                                        I2C_Transaction *transaction);

typedef struct I2C_FxnTable {
    I2C_CancelFxn        cancelFxn;

    I2C_CloseFxn        closeFxn;

    I2C_ControlFxn      controlFxn;

    I2C_InitFxn         initFxn;

    I2C_OpenFxn         openFxn;

    I2C_TransferFxn     transferFxn;
} I2C_FxnTable;

typedef struct I2C_Config {
    I2C_FxnTable const *fxnTablePtr;

    void               *object;

    void         const *hwAttrs;
} I2C_Config;


extern void I2C_cancel(I2C_Handle handle);

extern void I2C_close(I2C_Handle handle);

extern int I2C_control(I2C_Handle handle, unsigned int cmd, void *arg);

extern void I2C_init(void);

extern I2C_Handle I2C_open(unsigned int index, I2C_Params *params);

extern void I2C_Params_init(I2C_Params *params);

extern bool I2C_transfer(I2C_Handle handle, I2C_Transaction *transaction);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_I2C__include */