matrixr.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 MATRIXR_H
#define MATRIXR_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
 
#define MATRIXR_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.csn   = MIKROBUS( mikrobus, MIKROBUS_AN ); 
#define MATRIXR_RETVAL  uint8_t
 
#define MATRIXR_OK           0x00
#define MATRIXR_INIT_ERROR   0xFF
#define MATRIXR_DECODE_MODE_REG    0x09
#define MATRIXR_INTENSITY_REG      0x0A
#define MATRIXR_SCAN_LIMIT_REG     0x0B
#define MATRIXR_SHUTDOWN_REG       0x0C
#define MATRIXR_DISPLAY_TEST_REG   0x0F
#define MATRIXR_NO_DECODE          0x00
#define MATRIXR_DECODE_DIGIT_0     0x01
#define MATRIXR_DECODE_DIGIT_3_0   0x0F
#define MATRIXR_DECODE_DIGIT_7     0xFF
#define MATRIXR_INTEN_LVL_0   0x00
#define MATRIXR_INTEN_LVL_1   0x03
#define MATRIXR_INTEN_LVL_2   0x06
#define MATRIXR_INTEN_LVL_3   0x09
#define MATRIXR_INTEN_LVL_4   0x0C
#define MATRIXR_INTEN_LVL_5   0x0F
#define MATRIXR_DISPLAY_DIGIT_0     0x00
#define MATRIXR_DISPLAY_DIGIT_0_1   0x01
#define MATRIXR_DISPLAY_DIGIT_0_2   0x02
#define MATRIXR_DISPLAY_DIGIT_0_3   0x03
#define MATRIXR_DISPLAY_DIGIT_0_4   0x04
#define MATRIXR_DISPLAY_DIGIT_0_5   0x05
#define MATRIXR_DISPLAY_DIGIT_0_6   0x06
#define MATRIXR_DISPLAY_DIGIT_0_7   0x07
#define MATRIXR_SHUTDOWN_MODE      0x00
#define MATRIXR_NORMAL_OPERATION   0x01
 
#define MATRIXR_DISPLAY_NORMAL_OPERATION   0x00
#define MATRIXR_DISPLAY_TEST_MODE          0X01
 // End group macro 
 
// --------------------------------------------------------------- PUBLIC TYPES
 
typedef struct 
{
    // Output pins 
 
    digital_out_t csn;
    digital_out_t cs;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} matrixr_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 csn;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
 
} matrixr_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void matrixr_cfg_setup ( matrixr_cfg_t *cfg );
 
MATRIXR_RETVAL matrixr_init ( matrixr_t *ctx, matrixr_cfg_t *cfg );
 
void matrixr_default_cfg ( matrixr_t *ctx );
 
void matrixr_display_characters ( matrixr_t *ctx, uint8_t left_char, uint8_t right_char );
 
void matrixr_write_reg ( matrixr_t *ctx, uint8_t address, uint8_t input_data );
 
void matrixr_set_csn_high ( matrixr_t *ctx );
 
void matrixr_set_csn_low ( matrixr_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _MATRIXR_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END