I2CSlave.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_I2CSLAVE__include
#define ti_drivers_I2CSLAVE__include

#ifdef __cplusplus
extern "C" {
#endif

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

#define I2CSLAVE_CMD_RESERVED             32

#define I2CSLAVE_STATUS_RESERVED         -32

#define I2CSLAVE_STATUS_SUCCESS          0

#define I2CSLAVE_STATUS_ERROR           -1

#define I2CSLAVE_STATUS_UNDEFINEDCMD   -2

typedef struct I2CSlave_Config      *I2CSlave_Handle;

typedef enum I2CSlave_Mode {
    I2CSLAVE_IDLE_MODE = 0,  /* I2CSlave is not performing a transaction */
    I2CSLAVE_WRITE_MODE,     /* I2CSlave is currently performing write */
    I2CSLAVE_READ_MODE,      /* I2CSlave is currently performing read */
    I2CSLAVE_START_MODE,     /* I2CSlave received a START from a master */
    I2CSLAVE_ERROR = 0xFF    /* I2CSlave error has occurred, exit gracefully */
} I2CSlave_Mode;

typedef enum I2CSlave_TransferMode {
    I2CSLAVE_MODE_BLOCKING,  
    I2CSLAVE_MODE_CALLBACK   
} I2CSlave_TransferMode;

typedef void (*I2CSlave_CallbackFxn)(I2CSlave_Handle, bool);

typedef struct I2CSlave_Params {
    I2CSlave_TransferMode   transferMode;
    I2CSlave_CallbackFxn    transferCallbackFxn;
    uint_fast16_t           slaveAddress;
    uintptr_t               custom;
} I2CSlave_Params;

typedef void        (*I2CSlave_CloseFxn)    (I2CSlave_Handle handle);

typedef int         (*I2CSlave_ControlFxn)  (I2CSlave_Handle handle,
                                        unsigned int cmd,
                                        void *arg);

typedef void        (*I2CSlave_InitFxn)     (I2CSlave_Handle handle);

typedef I2CSlave_Handle  (*I2CSlave_OpenFxn)     (I2CSlave_Handle handle,
                                        I2CSlave_Params *params);

typedef bool        (*I2CSlave_WriteFxn) (I2CSlave_Handle handle,
        const void *buffer, size_t size);


typedef bool        (*I2CSlave_ReadFxn) (I2CSlave_Handle handle, void *buffer,
        size_t size);


typedef struct I2CSlave_FxnTable {
    I2CSlave_CloseFxn        closeFxn;

    I2CSlave_ControlFxn      controlFxn;

    I2CSlave_InitFxn         initFxn;

    I2CSlave_OpenFxn         openFxn;

    I2CSlave_ReadFxn     readFxn;

    I2CSlave_WriteFxn  writeFxn;
} I2CSlave_FxnTable;

typedef struct I2CSlave_Config {
    I2CSlave_FxnTable const *fxnTablePtr;

    void               *object;

    void         const *hwAttrs;
} I2CSlave_Config;


extern void I2CSlave_close(I2CSlave_Handle handle);

extern int I2CSlave_control(I2CSlave_Handle handle, unsigned int cmd,
    void *arg);

extern void I2CSlave_init(void);

extern I2CSlave_Handle I2CSlave_open(unsigned int index,
    I2CSlave_Params *params);

extern void I2CSlave_Params_init(I2CSlave_Params *params);

extern bool I2CSlave_read(I2CSlave_Handle handle, void *buffer,
        size_t size);
extern bool I2CSlave_write(I2CSlave_Handle handle, const void *buffer,
        size_t size);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_I2CSLAVE__include */