drv_ext_light.h

/*
  Copyright (c) 2010 - 2017, Nordic Semiconductor ASA
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.

  2. Redistributions in binary form, except as embedded into a Nordic
     Semiconductor ASA integrated circuit in a product or a software update for
     such product, 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.

  3. Neither the name of Nordic Semiconductor ASA nor the names of its
     contributors may be used to endorse or promote products derived from this
     software without specific prior written permission.

  4. This software, with or without modification, must only be used with a
     Nordic Semiconductor ASA integrated circuit.

  5. Any software provided in binary form under this license must not be reverse
     engineered, decompiled, modified and/or disassembled.

  THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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 __DRV_EXT_LIGHT_H__
#define __DRV_EXT_LIGHT_H__

#include <stdint.h>
#include "app_error.h"
#include "drv_sx1509.h"
#include "sx150x_led_drv_regs.h"
#include "sx150x_led_drv_calc.h"
#include "app_timer.h"

#define DRV_EXT_LIGHT_INTENSITY_MAX ((uint8_t)(0xFF))   
#define DRV_EXT_LIGHT_INTENSITY_OFF (0)                 

#define DRV_EXT_LIGHT_MAX_PIN_ID_ALLOWED        16      
#define DRV_EXT_LIGHT_NUM_LIGHTS_MAX            (((DRV_SX1509_HIGHINPMODE_PIN15_Pos + 1) < (16)) ? \
                                                (DRV_SX1509_HIGHINPMODE_PIN15_Pos + 1) : (16))          
#define DRV_EXT_LIGHT_IOEXT_CLKX_DIV_MAX        (DRV_SX1509_MISC_CLKX_Msk >> DRV_SX1509_MISC_CLKX_Pos)  
#define DRV_EXT_LIGHT_INVALID_RESYNC_PIN        255     

enum
{
    DRV_EXT_LIGHT_STATUS_CODE_SUCCESS,            
    DRV_EXT_LIGHT_STATUS_CODE_INVALID_PARAM,      
    DRV_EXT_LIGHT_STATUS_CODE_NOT_SUPPORTED,      
    DRV_EXT_LIGHT_STATUS_CODE_INVALID_LIGHT_TYPE, 
    DRV_EXT_LIGHT_STATUS_CODE_INVALID_TIMER_VALUE 
};

typedef enum
{
    DRV_EXT_LIGHT_CLKX_DIV_1 = 1,
    DRV_EXT_LIGHT_CLKX_DIV_2 ,
    DRV_EXT_LIGHT_CLKX_DIV_4 ,
    DRV_EXT_LIGHT_CLKX_DIV_8 ,
    DRV_EXT_LIGHT_CLKX_DIV_16,
    DRV_EXT_LIGHT_CLKX_DIV_32,
    DRV_EXT_LIGHT_CLKX_DIV_64,
}drv_ext_light_clkx_div_t;

typedef enum
{
    DRV_EXT_LIGHT_COLOR_NONE,
    DRV_EXT_LIGHT_COLOR_RED,
    DRV_EXT_LIGHT_COLOR_GREEN,
    DRV_EXT_LIGHT_COLOR_YELLOW,
    DRV_EXT_LIGHT_COLOR_BLUE,
    DRV_EXT_LIGHT_COLOR_PURPLE,
    DRV_EXT_LIGHT_COLOR_CYAN,
    DRV_EXT_LIGHT_COLOR_WHITE
}drv_ext_light_color_mix_t;

typedef enum
{
    EXTENDER_OSC_UNUSED,            
    EXTENDER_OSC_USED_RUNNING,      
    EXTENDER_OSC_USED_PAUSED,       
    EXTENDER_OSC_USED_PERM,         
    IOEXT_OSC_STATUS_T_SIZE         
}drv_ext_light_ioext_osc_status_t;

typedef struct
{
    uint32_t active_time_ms;                            
    uint32_t inactive_time_ms;                          
    drv_ext_light_color_mix_t colors;                   
    drv_ext_light_ioext_osc_status_t ioext_osc_status;  
}drv_ext_light_status_t;

#define DRV_EXT_LIGHT_STATUS_INIT                    \
{                                                    \
    .active_time_ms   = 0,                           \
    .inactive_time_ms = 0,                           \
    .colors           = DRV_EXT_LIGHT_COLOR_NONE,    \
    .ioext_osc_status = EXTENDER_OSC_UNUSED          \
}

typedef struct
{
    drv_ext_light_status_t * p_status;      
    app_timer_id_t           timer;         
}drv_ext_light_data_t;

#define DRV_EXT_LIGHT_DEF(light_id)                                                                             \
    static drv_ext_light_status_t light_id##_timings = DRV_EXT_LIGHT_STATUS_INIT;                               \
    static app_timer_t light_id##_timer_data = { {0} };                                                         \
    static drv_ext_light_data_t light_id = {.p_status = &light_id##_timings, .timer = &light_id##_timer_data}  \


typedef enum
{
    DRV_EXT_LIGHT_TYPE_MONO,        
    DRV_EXT_LIGHT_TYPE_RGB          
}drv_ext_light_reg_type_t;

typedef struct
{
    drv_ext_light_reg_type_t type;  
    union
    {
        uint8_t mono;               
        struct
        {
            uint8_t r;              
            uint8_t g;              
            uint8_t b;              
        }rgb;
    }pin;
    drv_ext_light_data_t * p_data;        
}drv_ext_light_conf_t;

typedef struct
{
    drv_ext_light_conf_t const * p_light_conf;          
    uint8_t                      num_lights;            
    drv_ext_light_clkx_div_t     clkx_div;              
    drv_sx1509_cfg_t const     * p_twi_conf;            
    uint8_t                      resync_pin;            
} drv_ext_light_init_t;

typedef struct
{
    uint8_t r;          
    uint8_t g;          
    uint8_t b;          
}drv_ext_light_rgb_intensity_t;

typedef struct
{
    drv_ext_light_color_mix_t color;            
    drv_ext_light_sequence_t  sequence_vals;    
}drv_ext_light_rgb_sequence_t;

#define SEQUENCE_REAL_VAL_INIT(PARAM) drv_ext_light_sequence_t PARAM = SEQUENCE_DEFAULT_VAL

ret_code_t drv_ext_light_reset(void);

ret_code_t drv_ext_light_on(uint32_t id);

ret_code_t drv_ext_light_off(uint32_t id);

ret_code_t drv_ext_light_intensity_set(uint32_t id, uint8_t intensity);

ret_code_t drv_ext_light_rgb_intensity_set(uint32_t id, drv_ext_light_rgb_intensity_t const * const p_intensity);

ret_code_t drv_ext_light_sequence(uint32_t id, drv_ext_light_sequence_t * const p_sequence);

ret_code_t drv_ext_light_rgb_sequence(uint32_t id, drv_ext_light_rgb_sequence_t * const p_sequence);

ret_code_t drv_ext_light_init(drv_ext_light_init_t const * p_init, bool on_init_reset);

#endif