matrixr  2.0.0.0
matrixr.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
34 // ----------------------------------------------------------------------------
35 
36 #ifndef MATRIXR_H
37 #define MATRIXR_H
38 
39 #include "mikrosdk_version.h"
40 
41 #ifdef __GNUC__
42 #if mikroSDK_GET_VERSION < 20800ul
43 #include "rcu_delays.h"
44 #else
45 #include "delays.h"
46 #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_spi_master.h"
52 
53 
54 // -------------------------------------------------------------- PUBLIC MACROS
55 
66 #define MATRIXR_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.csn = MIKROBUS( mikrobus, MIKROBUS_AN );
72 
78 #define MATRIXR_RETVAL uint8_t
79 
80 #define MATRIXR_OK 0x00
81 #define MATRIXR_INIT_ERROR 0xFF
82 
88 #define MATRIXR_DECODE_MODE_REG 0x09
89 #define MATRIXR_INTENSITY_REG 0x0A
90 #define MATRIXR_SCAN_LIMIT_REG 0x0B
91 #define MATRIXR_SHUTDOWN_REG 0x0C
92 #define MATRIXR_DISPLAY_TEST_REG 0x0F
93 
99 #define MATRIXR_NO_DECODE 0x00
100 #define MATRIXR_DECODE_DIGIT_0 0x01
101 #define MATRIXR_DECODE_DIGIT_3_0 0x0F
102 #define MATRIXR_DECODE_DIGIT_7 0xFF
103 
109 #define MATRIXR_INTEN_LVL_0 0x00
110 #define MATRIXR_INTEN_LVL_1 0x03
111 #define MATRIXR_INTEN_LVL_2 0x06
112 #define MATRIXR_INTEN_LVL_3 0x09
113 #define MATRIXR_INTEN_LVL_4 0x0C
114 #define MATRIXR_INTEN_LVL_5 0x0F
115 
121 #define MATRIXR_DISPLAY_DIGIT_0 0x00
122 #define MATRIXR_DISPLAY_DIGIT_0_1 0x01
123 #define MATRIXR_DISPLAY_DIGIT_0_2 0x02
124 #define MATRIXR_DISPLAY_DIGIT_0_3 0x03
125 #define MATRIXR_DISPLAY_DIGIT_0_4 0x04
126 #define MATRIXR_DISPLAY_DIGIT_0_5 0x05
127 #define MATRIXR_DISPLAY_DIGIT_0_6 0x06
128 #define MATRIXR_DISPLAY_DIGIT_0_7 0x07
129 
135 #define MATRIXR_SHUTDOWN_MODE 0x00
136 #define MATRIXR_NORMAL_OPERATION 0x01
137 
142 #define MATRIXR_DISPLAY_NORMAL_OPERATION 0x00
143 #define MATRIXR_DISPLAY_TEST_MODE 0X01
144  // End group macro
147 
148 // --------------------------------------------------------------- PUBLIC TYPES
149 
158 typedef struct
159 {
160  // Output pins
161 
162  digital_out_t csn;
163  digital_out_t cs;
164 
165  // Modules
166 
167  spi_master_t spi;
168  pin_name_t chip_select;
169 
170 } matrixr_t;
171 
175 typedef struct
176 {
177  // Communication gpio pins
178 
179  pin_name_t miso;
180  pin_name_t mosi;
181  pin_name_t sck;
182  pin_name_t cs;
183 
184  // Additional gpio pins
185 
186  pin_name_t csn;
187 
188  // static variable
189 
190  uint32_t spi_speed;
191  spi_master_mode_t spi_mode;
192  spi_master_chip_select_polarity_t cs_polarity;
193 
194 
195 } matrixr_cfg_t;
196  // End types group
198 
199 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
200 
205 #ifdef __cplusplus
206 extern "C"{
207 #endif
208 
218 
227 
236 
246 void matrixr_display_characters ( matrixr_t *ctx, uint8_t left_char, uint8_t right_char );
247 
257 void matrixr_write_reg ( matrixr_t *ctx, uint8_t address, uint8_t input_data );
258 
267 
276 
277 #ifdef __cplusplus
278 }
279 #endif
280 #endif // _MATRIXR_H_
281  // End public_function group
284 
285 // ------------------------------------------------------------------------- END
matrixr_cfg_t::mosi
pin_name_t mosi
Definition: matrixr.h:180
MATRIXR_RETVAL
#define MATRIXR_RETVAL
Definition: matrixr.h:78
matrixr_cfg_t::cs
pin_name_t cs
Definition: matrixr.h:182
matrixr_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: matrixr.h:192
matrixr_cfg_t
Click configuration structure definition.
Definition: matrixr.h:176
matrixr_cfg_setup
void matrixr_cfg_setup(matrixr_cfg_t *cfg)
Config Object Initialization function.
matrixr_default_cfg
void matrixr_default_cfg(matrixr_t *ctx)
Click Default Configuration function.
matrixr_cfg_t::miso
pin_name_t miso
Definition: matrixr.h:179
matrixr_t::chip_select
pin_name_t chip_select
Definition: matrixr.h:168
matrixr_cfg_t::csn
pin_name_t csn
Definition: matrixr.h:186
matrixr_init
MATRIXR_RETVAL matrixr_init(matrixr_t *ctx, matrixr_cfg_t *cfg)
Initialization function.
matrixr_t::csn
digital_out_t csn
Definition: matrixr.h:162
matrixr_write_reg
void matrixr_write_reg(matrixr_t *ctx, uint8_t address, uint8_t input_data)
Register write function.
matrixr_t
Click ctx object definition.
Definition: matrixr.h:159
matrixr_set_csn_high
void matrixr_set_csn_high(matrixr_t *ctx)
Set CSN pin to high function.
matrixr_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: matrixr.h:191
matrixr_t::cs
digital_out_t cs
Definition: matrixr.h:163
matrixr_display_characters
void matrixr_display_characters(matrixr_t *ctx, uint8_t left_char, uint8_t right_char)
Display characters function.
matrixr_t::spi
spi_master_t spi
Definition: matrixr.h:167
matrixr_cfg_t::spi_speed
uint32_t spi_speed
Definition: matrixr.h:190
matrixr_set_csn_low
void matrixr_set_csn_low(matrixr_t *ctx)
Set CSN pin to low function.
matrixr_cfg_t::sck
pin_name_t sck
Definition: matrixr.h:181