ioexp_tca6424.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  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 IO_EXP_TCA6424_H_
#define IO_EXP_TCA6424_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <drivers/i2c.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define TCA6424_MODE_INPUT              (0U)
 
#define TCA6424_MODE_OUTPUT             (1U)
 
#define TCA6424_OUT_STATE_LOW           (0U)
 
#define TCA6424_OUT_STATE_HIGH          (1U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct TCA6424_Params_s
{
    uint32_t        i2cInstance;
    uint32_t        i2cAddress;
} TCA6424_Params;
 
typedef struct TCA6424_Attrs_s
{
    uint32_t        numIo;
} TCA6424_Attrs;
 
typedef struct TCA6424_Config_s
{
    TCA6424_Params      params;
    TCA6424_Attrs       attrs;
    I2C_Handle          i2cHandle;
    void               *lock;
    SemaphoreP_Object   lockObj;
} TCA6424_Config;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t TCA6424_open(TCA6424_Config *config, const TCA6424_Params *params);
 
void TCA6424_close(TCA6424_Config *config);
 
int32_t TCA6424_config(TCA6424_Config *config, uint32_t ioIndex, uint32_t mode);
 
int32_t TCA6424_setOutput(TCA6424_Config *config, uint32_t ioIndex, uint32_t state);
 
void TCA6424_getAttrs(TCA6424_Config *config, TCA6424_Attrs *attrs);
 
void TCA6424_Params_init(TCA6424_Params *params);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef TCA6424_H_ */