utl7segb.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 UTL7SEGB_H
#define UTL7SEGB_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 "spi_specifics.h"
 
#define UTL7SEGB_BASE_NUM_SYS_BINARY                2
#define UTL7SEGB_BASE_NUM_SYS_TERNARY               3
#define UTL7SEGB_BASE_NUM_SYS_QUATERNARY            4
#define UTL7SEGB_BASE_NUM_SYS_QUINARY               5
#define UTL7SEGB_BASE_NUM_SYS_SENARY                6
#define UTL7SEGB_BASE_NUM_SYS_SEPTENARY             7
#define UTL7SEGB_BASE_NUM_SYS_OCTAL                 8
#define UTL7SEGB_BASE_NUM_SYS_NONARY                9
#define UTL7SEGB_BASE_NUM_SYS_DECIMAL               10
#define UTL7SEGB_BASE_NUM_SYS_UNDECIMAL             11
#define UTL7SEGB_BASE_NUM_SYS_DUODECIMAL            12
#define UTL7SEGB_BASE_NUM_SYS_HEXADECIMAL           16
 
 // utl7segb_base
 
#define UTL7SEGB_NO_DOT                             0
#define UTL7SEGB_DOT_RIGHT                          1
#define UTL7SEGB_DOT_LEFT                           2
#define UTL7SEGB_DOT_LEFT_RIGHT                     3
 
#define UTL7SEGB_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define UTL7SEGB_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // utl7segb_set
 
#define UTL7SEGB_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.oe = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // utl7segb_map
 // utl7segb
 
typedef struct
{
    // Output pins
    digital_out_t oe;    
    // Modules
    spi_master_t spi;    
    pin_name_t   chip_select;    
} utl7segb_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;    
    pin_name_t mosi;    
    pin_name_t sck;     
    pin_name_t cs;      
    // Additional gpio pins
    pin_name_t oe;      
    // static variable
    uint32_t                          spi_speed;      
    spi_master_mode_t                 spi_mode;       
    spi_master_chip_select_polarity_t cs_polarity;    
} utl7segb_cfg_t;
 
typedef enum
{
    UTL7SEGB_OK = 0,
    UTL7SEGB_ERROR = -1
 
} utl7segb_return_value_t;
 
void utl7segb_cfg_setup ( utl7segb_cfg_t *cfg );
 
err_t utl7segb_init ( utl7segb_t *ctx, utl7segb_cfg_t *cfg );
 
err_t utl7segb_default_cfg ( utl7segb_t *ctx );
 
err_t utl7segb_generic_write ( utl7segb_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t utl7segb_generic_read ( utl7segb_t *ctx, uint8_t *data_out, uint8_t len );
 
void utl7segb_enable ( utl7segb_t *ctx );
 
void utl7segb_disable ( utl7segb_t *ctx );
 
err_t utl7segb_display_number ( utl7segb_t *ctx, uint8_t base, uint8_t num, uint8_t dot_pos );
 
err_t utl7segb_get_number ( utl7segb_t *ctx, uint8_t base, uint8_t *num, uint8_t *dot_pos );
 
#ifdef __cplusplus
}
#endif
#endif // UTL7SEGB_H
 
 // utl7segb
 
// ------------------------------------------------------------------------ END