uts7segb2.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 UTS7SEGB2_H
#define UTS7SEGB2_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 UTS7SEGB2_SEG_DIS14_SEG0              0x00000001l
#define UTS7SEGB2_SEG_DIS14_SEG1              0x00000002l
#define UTS7SEGB2_SEG_DIS14_SEG2              0x00000004l
#define UTS7SEGB2_SEG_DIS14_SEG3              0x00000008l
#define UTS7SEGB2_SEG_DIS14_SEG4              0x00000010l
#define UTS7SEGB2_SEG_DIS14_SEG5              0x00000020l
#define UTS7SEGB2_SEG_DIS14_SEG6              0x00000040l
#define UTS7SEGB2_SEG_DIS14_SEG7              0x00000080l
#define UTS7SEGB2_SEG_DIS25_SEG0              0x00000100l
#define UTS7SEGB2_SEG_DIS25_SEG1              0x00000200l
#define UTS7SEGB2_SEG_DIS25_SEG2              0x00000400l
#define UTS7SEGB2_SEG_DIS25_SEG3              0x00000800l
#define UTS7SEGB2_SEG_DIS25_SEG4              0x00001000l
#define UTS7SEGB2_SEG_DIS25_SEG5              0x00002000l
#define UTS7SEGB2_SEG_DIS25_SEG6              0x00004000l
#define UTS7SEGB2_SEG_DIS25_SEG7              0x00008000l
#define UTS7SEGB2_SEG_DIS36_SEG0              0x00010000l
#define UTS7SEGB2_SEG_DIS36_SEG1              0x00020000l
#define UTS7SEGB2_SEG_DIS36_SEG2              0x00040000l
#define UTS7SEGB2_SEG_DIS36_SEG3              0x00080000l
#define UTS7SEGB2_SEG_DIS36_SEG4              0x00100000l
#define UTS7SEGB2_SEG_DIS36_SEG5              0x00200000l
#define UTS7SEGB2_SEG_DIS36_SEG6              0x00400000l
#define UTS7SEGB2_SEG_DIS36_SEG7              0x00800000l
#define UTS7SEGB2_SEG_ALL                     0x01FFFFFFl
#define UTS7SEGB2_SEG_BIT_MASK                0x01FFFFFFl
 
#define UTS7SEGB2_NIBBLE_LOW                  0x000Fu
#define UTS7SEGB2_NIBBLE_HIGH                 0x00F0u
#define UTS7SEGB2_BYTE_LOW                    0x00FFu
#define UTS7SEGB2_WORD_BIT_POS_0              0x0001u
#define UTS7SEGB2_WORD_BIT_POS_14             0x4000u
#define UTS7SEGB2_WORD_BIT_POS_15             0x8000u
 
#define UTS7SEGB2_SEG_NUM_START               0
#define UTS7SEGB2_SEG_NUM_END                 23
#define UTS7SEGB2_SEG_NUM_POS                 24
 
#define UTS7SEGB2_BRIGHTNESS_MIN              0x0000u
#define UTS7SEGB2_BRIGHTNESS_DEFAULT          0x07FFu
#define UTS7SEGB2_BRIGHTNESS_MAX              0x0FFFu
 
#define UTS7SEGB2_BASE_NUM_SYS_BINARY         2
#define UTS7SEGB2_BINARY_NUM_MAX              UTS7SEGB2_BASE_NUM_SYS_BINARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_BINARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_BINARY - 1
#define UTS7SEGB2_BASE_NUM_SYS_TERNARY        3
#define UTS7SEGB2_TERNARY_NUM_MAX             UTS7SEGB2_BASE_NUM_SYS_TERNARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_TERNARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_TERNARY - 1
#define UTS7SEGB2_BASE_NUM_SYS_QUATERNARY     4
#define UTS7SEGB2_QUATERNARY_NUM_MAX          UTS7SEGB2_BASE_NUM_SYS_QUATERNARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_QUATERNARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_QUATERNARY - 1
#define UTS7SEGB2_BASE_NUM_SYS_QUINARY        5
#define UTS7SEGB2_QUINARY_NUM_MAX             UTS7SEGB2_BASE_NUM_SYS_QUINARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_QUINARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_QUINARY - 1
#define UTS7SEGB2_BASE_NUM_SYS_SENARY         6
#define UTS7SEGB2_SENARY_NUM_MAX              UTS7SEGB2_BASE_NUM_SYS_SENARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_SENARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_SENARY - 1
#define UTS7SEGB2_BASE_NUM_SYS_SEPTENARY      7
#define UTS7SEGB2_SEPTENARY_NUM_MAX           UTS7SEGB2_BASE_NUM_SYS_SEPTENARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_SEPTENARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_SEPTENARY - 1
#define UTS7SEGB2_BASE_NUM_SYS_OCTAL          8
#define UTS7SEGB2_OCTAL_NUM_MAX               UTS7SEGB2_BASE_NUM_SYS_OCTAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_OCTAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_OCTAL - 1
#define UTS7SEGB2_BASE_NUM_SYS_NONARY         9
#define UTS7SEGB2_NONARY_NUM_MAX              UTS7SEGB2_BASE_NUM_SYS_NONARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_NONARY * \
                                              UTS7SEGB2_BASE_NUM_SYS_NONARY - 1
#define UTS7SEGB2_BASE_NUM_SYS_DECIMAL        10
#define UTS7SEGB2_DECIMAL_NUM_MAX             UTS7SEGB2_BASE_NUM_SYS_DECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_DECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_DECIMAL - 1
#define UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL      11
#define UTS7SEGB2_UNDECIMAL_NUM_MAX           UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL - 1
#define UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL     12
#define UTS7SEGB2_DUODECIMAL_NUM_MAX          UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL - 1
#define UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL    16
#define UTS7SEGB2_HEXADECIMAL_NUM_MAX         UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL * \
                                              UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL - 1
 
#define UTS7SEGB2_TOP_SEG_NO_DOT              0x00
#define UTS7SEGB2_TOP_SEG_DOT_RIGHT           0x01
#define UTS7SEGB2_TOP_SEG_DOT_MIDDLE          0x02
#define UTS7SEGB2_TOP_SEG_DOT_LEFT            0x04
#define UTS7SEGB2_BOTTOM_SEG_NO_DOT           0x00
#define UTS7SEGB2_BOTTOM_SEG_DOT_RIGHT        0x20
#define UTS7SEGB2_BOTTOM_SEG_DOT_LEFT         0x08
#define UTS7SEGB2_BOTTOM_SEG_DOT_MIDDLE       0x10
 
#define UTS7SEGB2_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define UTS7SEGB2_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // uts7segb2_set
 
#define UTS7SEGB2_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.cs2  = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.pwm  = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // uts7segb2_map
 // uts7segb2
 
typedef struct
{
    // Output pins
    digital_out_t cs2;    
    digital_out_t pwm;    
    // Modules
    spi_master_t spi;     
    pin_name_t   chip_select;    
} uts7segb2_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 cs2;    
    pin_name_t pwm;    
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} uts7segb2_cfg_t;
 
typedef struct
{
    uint8_t  char_top_left;        
    uint8_t  char_top_mid;         
    uint8_t  char_top_right;       
    uint8_t  char_bottom_left;     
    uint8_t  char_bottom_mid;      
    uint8_t  char_bottom_right;    
    uint16_t brightness;           
} uts7segb2_character_cfg_t;
 
typedef struct
{
    uint16_t num_top;              
    uint16_t brightness_top;       
    uint16_t num_bottom;           
    uint16_t brightness_bottom;    
    uint8_t  base;                 
    uint8_t  dot_bit_mask;         
} uts7segb2_number_cfg_t;
 
typedef enum
{
    UTS7SEGB2_OK = 0,
    UTS7SEGB2_ERROR = -1
 
} uts7segb2_return_value_t;
 
typedef enum
{
    UTS7SEGB2_SEG_TOP = 0,
    UTS7SEGB2_SEG_BOTTOM
 
} uts7segb2_seg_sel_t;
 
void uts7segb2_cfg_setup ( uts7segb2_cfg_t *cfg );
 
err_t uts7segb2_init ( uts7segb2_t *ctx, uts7segb2_cfg_t *cfg );
 
err_t uts7segb2_default_cfg ( uts7segb2_t *ctx );
 
err_t uts7segb2_top_seg_write ( uts7segb2_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t uts7segb2_top_seg_read ( uts7segb2_t *ctx, uint8_t *data_out, uint8_t len );
 
err_t uts7segb2_bottom_seg_write ( uts7segb2_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t uts7segb2_bottom_seg_read ( uts7segb2_t *ctx, uint8_t *data_out, uint8_t len );
 
void uts7segb2_set_outputs_on ( uts7segb2_t *ctx );
 
void uts7segb2_set_outputs_off ( uts7segb2_t *ctx );
 
err_t uts7segb2_set_seg_pos ( uts7segb2_t *ctx, uts7segb2_seg_sel_t seg_sel, 
                              uint8_t seg_num, uint16_t brightness );
 
err_t uts7segb2_set_led_output ( uts7segb2_t *ctx, uts7segb2_seg_sel_t seg_sel, 
                                 uint32_t seg_bit_mask, uint16_t brightness );
 
err_t uts7segb2_display_character ( uts7segb2_t *ctx, uts7segb2_character_cfg_t ascii_char );
 
err_t uts7segb2_display_number ( uts7segb2_t *ctx, uts7segb2_number_cfg_t number );
 
#ifdef __cplusplus
}
#endif
#endif // UTS7SEGB2_H
 
 // uts7segb2
 
// ------------------------------------------------------------------------ END