led.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 LED_H_
#define LED_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/i2c.h>
#include <drivers/gpio.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef void *LED_Handle;
typedef struct LED_Config_s LED_Config;
typedef struct LED_Params_s LED_Params;
 
typedef int32_t (*LED_OpenFxn)(LED_Config *config, const LED_Params *params);
 
typedef void (*LED_CloseFxn)(LED_Config *config);
 
typedef int32_t (*LED_OnFxn)(LED_Config *config, uint32_t index);
 
typedef int32_t (*LED_OffFxn)(LED_Config *config, uint32_t index);
 
typedef int32_t (*LED_SetMaskFxn)(LED_Config *config, uint32_t mask);
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
struct LED_Params_s
{
    uint32_t        gpioBaseAddr;
    uint32_t        gpioPinNum;
    uint32_t        i2cInstance;
    uint32_t        i2cAddress;
    uint32_t        ioIndex;
};
 
typedef struct LED_Fxns_s
{
    LED_OpenFxn     openFxn;
    LED_CloseFxn    closeFxn;
    LED_OnFxn       onFxn;
    LED_OffFxn      offFxn;
    LED_SetMaskFxn  setMaskFxn;
} LED_Fxns;
 
typedef struct 
{
    uint32_t        numLedPerGroup;
} LED_Attrs;
 
struct LED_Config_s
{
    LED_Attrs      *attrs;
    LED_Fxns       *fxns;
    void           *object;
};
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void LED_Params_init(LED_Params *params);
 
LED_Handle LED_open(uint32_t instanceId, const LED_Params *params);
 
void LED_close(LED_Handle handle);
 
int32_t LED_on(LED_Handle handle, uint32_t index);
 
int32_t LED_off(LED_Handle handle, uint32_t index);
 
int32_t LED_setMask(LED_Handle handle, uint32_t mask);
 
const LED_Attrs *LED_getAttrs(uint32_t instanceId);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
typedef struct
{
    I2C_Handle      i2cHandle;
    uint32_t        gpioBaseAddr;
    uint32_t        gpioPinNum;
    uint32_t        i2cInstance;
    uint32_t        i2cAddress;
    uint32_t        ioIndex;
} LED_Object;
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef LED_H_ */