leddriver10.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef LEDDRIVER10_H
#define LEDDRIVER10_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "drv_pwm.h"
 
#define LEDDRIVER10_ENABLE_ALL_CH     0xFFFF
#define LEDDRIVER10_DISABLE_ALL_CH    0x0000
#define LEDDRIVER10_ENABLE_CH_0       0x0001
#define LEDDRIVER10_ENABLE_CH_1       0x0002
#define LEDDRIVER10_ENABLE_CH_2       0x0004
#define LEDDRIVER10_ENABLE_CH_3       0x0008
#define LEDDRIVER10_ENABLE_CH_4       0x0010
#define LEDDRIVER10_ENABLE_CH_5       0x0020
#define LEDDRIVER10_ENABLE_CH_6       0x0040
#define LEDDRIVER10_ENABLE_CH_7       0x0080
#define LEDDRIVER10_ENABLE_CH_8       0x0100
#define LEDDRIVER10_ENABLE_CH_9       0x0200
#define LEDDRIVER10_ENABLE_CH_10      0x0400
#define LEDDRIVER10_ENABLE_CH_11      0x0800
#define LEDDRIVER10_ENABLE_CH_12      0x1000
#define LEDDRIVER10_ENABLE_CH_13      0x2000
#define LEDDRIVER10_ENABLE_CH_14      0x4000
#define LEDDRIVER10_ENABLE_CH_15      0x8000
 
#define LEDDRIVER10_DEF_FREQ          10000
 
 // leddriver10_set
 
#define LEDDRIVER10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.pwm  = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // leddriver10_map
 // leddriver10
 
typedef struct
{
    // Modules
    spi_master_t  spi;          
    pwm_t         pwm;          
    pin_name_t    chip_select;  
    uint32_t      pwm_freq;     
} leddriver10_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    pin_name_t  pwm;                                     
    // Static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
    uint32_t                           dev_pwm_freq;     
} leddriver10_cfg_t;
 
typedef enum
{
    LEDDRIVER10_OK = 0,
    LEDDRIVER10_ERROR = -1
 
} leddriver10_return_value_t;
 
void leddriver10_cfg_setup ( leddriver10_cfg_t *cfg );
 
err_t leddriver10_init ( leddriver10_t *ctx, leddriver10_cfg_t *cfg );
 
err_t leddriver10_set_channels ( leddriver10_t *ctx, uint16_t ch_mask );
 
err_t leddriver10_read_channels ( leddriver10_t *ctx, uint16_t *ch_mask );
 
err_t leddriver10_set_duty_cycle ( leddriver10_t *ctx, float duty_cycle );
 
err_t leddriver10_pwm_stop ( leddriver10_t *ctx );
 
err_t leddriver10_pwm_start ( leddriver10_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER10_H
 
 // leddriver10
 
// ------------------------------------------------------------------------ END