uts7segb2  2.1.0.0
uts7segb2.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 
28 #ifndef UTS7SEGB2_H
29 #define UTS7SEGB2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
48 #include "spi_specifics.h"
49 
70 #define UTS7SEGB2_SEG_DIS14_SEG0 0x00000001l
71 #define UTS7SEGB2_SEG_DIS14_SEG1 0x00000002l
72 #define UTS7SEGB2_SEG_DIS14_SEG2 0x00000004l
73 #define UTS7SEGB2_SEG_DIS14_SEG3 0x00000008l
74 #define UTS7SEGB2_SEG_DIS14_SEG4 0x00000010l
75 #define UTS7SEGB2_SEG_DIS14_SEG5 0x00000020l
76 #define UTS7SEGB2_SEG_DIS14_SEG6 0x00000040l
77 #define UTS7SEGB2_SEG_DIS14_SEG7 0x00000080l
78 #define UTS7SEGB2_SEG_DIS25_SEG0 0x00000100l
79 #define UTS7SEGB2_SEG_DIS25_SEG1 0x00000200l
80 #define UTS7SEGB2_SEG_DIS25_SEG2 0x00000400l
81 #define UTS7SEGB2_SEG_DIS25_SEG3 0x00000800l
82 #define UTS7SEGB2_SEG_DIS25_SEG4 0x00001000l
83 #define UTS7SEGB2_SEG_DIS25_SEG5 0x00002000l
84 #define UTS7SEGB2_SEG_DIS25_SEG6 0x00004000l
85 #define UTS7SEGB2_SEG_DIS25_SEG7 0x00008000l
86 #define UTS7SEGB2_SEG_DIS36_SEG0 0x00010000l
87 #define UTS7SEGB2_SEG_DIS36_SEG1 0x00020000l
88 #define UTS7SEGB2_SEG_DIS36_SEG2 0x00040000l
89 #define UTS7SEGB2_SEG_DIS36_SEG3 0x00080000l
90 #define UTS7SEGB2_SEG_DIS36_SEG4 0x00100000l
91 #define UTS7SEGB2_SEG_DIS36_SEG5 0x00200000l
92 #define UTS7SEGB2_SEG_DIS36_SEG6 0x00400000l
93 #define UTS7SEGB2_SEG_DIS36_SEG7 0x00800000l
94 #define UTS7SEGB2_SEG_ALL 0x01FFFFFFl
95 #define UTS7SEGB2_SEG_BIT_MASK 0x01FFFFFFl
96 
101 #define UTS7SEGB2_NIBBLE_LOW 0x000Fu
102 #define UTS7SEGB2_NIBBLE_HIGH 0x00F0u
103 #define UTS7SEGB2_BYTE_LOW 0x00FFu
104 #define UTS7SEGB2_WORD_BIT_POS_0 0x0001u
105 #define UTS7SEGB2_WORD_BIT_POS_14 0x4000u
106 #define UTS7SEGB2_WORD_BIT_POS_15 0x8000u
107 
112 #define UTS7SEGB2_SEG_NUM_START 0
113 #define UTS7SEGB2_SEG_NUM_END 23
114 #define UTS7SEGB2_SEG_NUM_POS 24
115 
120 #define UTS7SEGB2_BRIGHTNESS_MIN 0x0000u
121 #define UTS7SEGB2_BRIGHTNESS_DEFAULT 0x07FFu
122 #define UTS7SEGB2_BRIGHTNESS_MAX 0x0FFFu
123 
129 #define UTS7SEGB2_BASE_NUM_SYS_BINARY 2
130 #define UTS7SEGB2_BINARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_BINARY * \
131  UTS7SEGB2_BASE_NUM_SYS_BINARY * \
132  UTS7SEGB2_BASE_NUM_SYS_BINARY - 1
133 #define UTS7SEGB2_BASE_NUM_SYS_TERNARY 3
134 #define UTS7SEGB2_TERNARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_TERNARY * \
135  UTS7SEGB2_BASE_NUM_SYS_TERNARY * \
136  UTS7SEGB2_BASE_NUM_SYS_TERNARY - 1
137 #define UTS7SEGB2_BASE_NUM_SYS_QUATERNARY 4
138 #define UTS7SEGB2_QUATERNARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_QUATERNARY * \
139  UTS7SEGB2_BASE_NUM_SYS_QUATERNARY * \
140  UTS7SEGB2_BASE_NUM_SYS_QUATERNARY - 1
141 #define UTS7SEGB2_BASE_NUM_SYS_QUINARY 5
142 #define UTS7SEGB2_QUINARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_QUINARY * \
143  UTS7SEGB2_BASE_NUM_SYS_QUINARY * \
144  UTS7SEGB2_BASE_NUM_SYS_QUINARY - 1
145 #define UTS7SEGB2_BASE_NUM_SYS_SENARY 6
146 #define UTS7SEGB2_SENARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_SENARY * \
147  UTS7SEGB2_BASE_NUM_SYS_SENARY * \
148  UTS7SEGB2_BASE_NUM_SYS_SENARY - 1
149 #define UTS7SEGB2_BASE_NUM_SYS_SEPTENARY 7
150 #define UTS7SEGB2_SEPTENARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_SEPTENARY * \
151  UTS7SEGB2_BASE_NUM_SYS_SEPTENARY * \
152  UTS7SEGB2_BASE_NUM_SYS_SEPTENARY - 1
153 #define UTS7SEGB2_BASE_NUM_SYS_OCTAL 8
154 #define UTS7SEGB2_OCTAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_OCTAL * \
155  UTS7SEGB2_BASE_NUM_SYS_OCTAL * \
156  UTS7SEGB2_BASE_NUM_SYS_OCTAL - 1
157 #define UTS7SEGB2_BASE_NUM_SYS_NONARY 9
158 #define UTS7SEGB2_NONARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_NONARY * \
159  UTS7SEGB2_BASE_NUM_SYS_NONARY * \
160  UTS7SEGB2_BASE_NUM_SYS_NONARY - 1
161 #define UTS7SEGB2_BASE_NUM_SYS_DECIMAL 10
162 #define UTS7SEGB2_DECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_DECIMAL * \
163  UTS7SEGB2_BASE_NUM_SYS_DECIMAL * \
164  UTS7SEGB2_BASE_NUM_SYS_DECIMAL - 1
165 #define UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL 11
166 #define UTS7SEGB2_UNDECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL * \
167  UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL * \
168  UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL - 1
169 #define UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL 12
170 #define UTS7SEGB2_DUODECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL * \
171  UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL * \
172  UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL - 1
173 #define UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL 16
174 #define UTS7SEGB2_HEXADECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL * \
175  UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL * \
176  UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL - 1
177 
182 #define UTS7SEGB2_TOP_SEG_NO_DOT 0x00
183 #define UTS7SEGB2_TOP_SEG_DOT_RIGHT 0x01
184 #define UTS7SEGB2_TOP_SEG_DOT_MIDDLE 0x02
185 #define UTS7SEGB2_TOP_SEG_DOT_LEFT 0x04
186 #define UTS7SEGB2_BOTTOM_SEG_NO_DOT 0x00
187 #define UTS7SEGB2_BOTTOM_SEG_DOT_RIGHT 0x20
188 #define UTS7SEGB2_BOTTOM_SEG_DOT_LEFT 0x08
189 #define UTS7SEGB2_BOTTOM_SEG_DOT_MIDDLE 0x10
190 
199 #define UTS7SEGB2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
200 #define UTS7SEGB2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
201  // uts7segb2_set
203 
218 #define UTS7SEGB2_MAP_MIKROBUS( cfg, mikrobus ) \
219  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
220  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
221  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
222  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
223  cfg.cs2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
224  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
225  // uts7segb2_map // uts7segb2
228 
233 typedef struct
234 {
235  // Output pins
236  digital_out_t cs2;
237  digital_out_t pwm;
239  // Modules
240  spi_master_t spi;
242  pin_name_t chip_select;
244 } uts7segb2_t;
245 
250 typedef struct
251 {
252  // Communication gpio pins
253  pin_name_t miso;
254  pin_name_t mosi;
255  pin_name_t sck;
256  pin_name_t cs;
258  // Additional gpio pins
259  pin_name_t cs2;
260  pin_name_t pwm;
262  // static variable
263  uint32_t spi_speed;
264  spi_master_mode_t spi_mode;
265  spi_master_chip_select_polarity_t cs_polarity;
268 
273 typedef struct
274 {
275  uint8_t char_top_left;
276  uint8_t char_top_mid;
277  uint8_t char_top_right;
279  uint8_t char_bottom_mid;
281  uint16_t brightness;
284 
289 typedef struct
290 {
291  uint16_t num_top;
292  uint16_t brightness_top;
293  uint16_t num_bottom;
294  uint16_t brightness_bottom;
295  uint8_t base;
296  uint8_t dot_bit_mask;
299 
304 typedef enum
305 {
307  UTS7SEGB2_ERROR = -1
308 
310 
315 typedef enum
316 {
319 
321 
338 
353 
367 
382 err_t uts7segb2_top_seg_write ( uts7segb2_t *ctx, uint8_t *data_in, uint8_t len );
383 
398 err_t uts7segb2_top_seg_read ( uts7segb2_t *ctx, uint8_t *data_out, uint8_t len );
399 
414 err_t uts7segb2_bottom_seg_write ( uts7segb2_t *ctx, uint8_t *data_in, uint8_t len );
415 
430 err_t uts7segb2_bottom_seg_read ( uts7segb2_t *ctx, uint8_t *data_out, uint8_t len );
431 
444 
456 
473  uint8_t seg_num, uint16_t brightness );
474 
491  uint32_t seg_bit_mask, uint16_t brightness );
492 
509 
526 
527 #ifdef __cplusplus
528 }
529 #endif
530 #endif // UTS7SEGB2_H
531  // uts7segb2
533 
534 // ------------------------------------------------------------------------ END
uts7segb2_cfg_t::pwm
pin_name_t pwm
Definition: uts7segb2.h:260
uts7segb2_set_outputs_off
void uts7segb2_set_outputs_off(uts7segb2_t *ctx)
UT-S 7-SEG B 2 set outputs OFF function.
uts7segb2_t::cs2
digital_out_t cs2
Definition: uts7segb2.h:236
uts7segb2_init
err_t uts7segb2_init(uts7segb2_t *ctx, uts7segb2_cfg_t *cfg)
UT-S 7-SEG B 2 initialization function.
uts7segb2_character_cfg_t::char_bottom_right
uint8_t char_bottom_right
Definition: uts7segb2.h:280
uts7segb2_seg_sel_t
uts7segb2_seg_sel_t
UT-S 7-SEG B 2 segment group selection value data.
Definition: uts7segb2.h:316
uts7segb2_bottom_seg_read
err_t uts7segb2_bottom_seg_read(uts7segb2_t *ctx, uint8_t *data_out, uint8_t len)
UT-S 7-SEG B 2 bottom segment data reading function.
uts7segb2_character_cfg_t::char_bottom_left
uint8_t char_bottom_left
Definition: uts7segb2.h:278
uts7segb2_t
UT-S 7-SEG B 2 Click context object.
Definition: uts7segb2.h:234
uts7segb2_cfg_t::cs2
pin_name_t cs2
Definition: uts7segb2.h:259
uts7segb2_character_cfg_t::char_bottom_mid
uint8_t char_bottom_mid
Definition: uts7segb2.h:279
uts7segb2_number_cfg_t
UT-S 7-SEG B 2 number configuration object.
Definition: uts7segb2.h:290
uts7segb2_number_cfg_t::dot_bit_mask
uint8_t dot_bit_mask
Definition: uts7segb2.h:296
spi_specifics.h
This file contains SPI specific macros, functions, etc.
uts7segb2_cfg_setup
void uts7segb2_cfg_setup(uts7segb2_cfg_t *cfg)
UT-S 7-SEG B 2 configuration object setup function.
UTS7SEGB2_SEG_TOP
@ UTS7SEGB2_SEG_TOP
Definition: uts7segb2.h:317
uts7segb2_set_led_output
err_t uts7segb2_set_led_output(uts7segb2_t *ctx, uts7segb2_seg_sel_t seg_sel, uint32_t seg_bit_mask, uint16_t brightness)
UT-S 7-SEG B 2 set LED output function.
uts7segb2_character_cfg_t::char_top_mid
uint8_t char_top_mid
Definition: uts7segb2.h:276
uts7segb2_default_cfg
err_t uts7segb2_default_cfg(uts7segb2_t *ctx)
UT-S 7-SEG B 2 default configuration function.
uts7segb2_top_seg_read
err_t uts7segb2_top_seg_read(uts7segb2_t *ctx, uint8_t *data_out, uint8_t len)
UT-S 7-SEG B 2 top segment data reading function.
uts7segb2_character_cfg_t::char_top_right
uint8_t char_top_right
Definition: uts7segb2.h:277
UTS7SEGB2_ERROR
@ UTS7SEGB2_ERROR
Definition: uts7segb2.h:307
uts7segb2_t::chip_select
pin_name_t chip_select
Definition: uts7segb2.h:242
uts7segb2_set_seg_pos
err_t uts7segb2_set_seg_pos(uts7segb2_t *ctx, uts7segb2_seg_sel_t seg_sel, uint8_t seg_num, uint16_t brightness)
UT-S 7-SEG B 2 set segment position function.
uts7segb2_character_cfg_t::char_top_left
uint8_t char_top_left
Definition: uts7segb2.h:275
uts7segb2_top_seg_write
err_t uts7segb2_top_seg_write(uts7segb2_t *ctx, uint8_t *data_in, uint8_t len)
UT-S 7-SEG B 2 top segment data writing function.
uts7segb2_bottom_seg_write
err_t uts7segb2_bottom_seg_write(uts7segb2_t *ctx, uint8_t *data_in, uint8_t len)
UT-S 7-SEG B 2 bottom segment data writing function.
UTS7SEGB2_SEG_BOTTOM
@ UTS7SEGB2_SEG_BOTTOM
Definition: uts7segb2.h:318
uts7segb2_cfg_t::spi_speed
uint32_t spi_speed
Definition: uts7segb2.h:263
uts7segb2_display_character
err_t uts7segb2_display_character(uts7segb2_t *ctx, uts7segb2_character_cfg_t ascii_char)
UT-S 7-SEG B 2 display character function.
uts7segb2_set_outputs_on
void uts7segb2_set_outputs_on(uts7segb2_t *ctx)
UT-S 7-SEG B 2 set outputs ON function.
uts7segb2_cfg_t
UT-S 7-SEG B 2 Click configuration object.
Definition: uts7segb2.h:251
uts7segb2_number_cfg_t::num_top
uint16_t num_top
Definition: uts7segb2.h:291
uts7segb2_number_cfg_t::num_bottom
uint16_t num_bottom
Definition: uts7segb2.h:293
uts7segb2_cfg_t::cs
pin_name_t cs
Definition: uts7segb2.h:256
uts7segb2_t::spi
spi_master_t spi
Definition: uts7segb2.h:240
uts7segb2_return_value_t
uts7segb2_return_value_t
UT-S 7-SEG B 2 Click return value data.
Definition: uts7segb2.h:305
uts7segb2_number_cfg_t::brightness_top
uint16_t brightness_top
Definition: uts7segb2.h:292
uts7segb2_number_cfg_t::base
uint8_t base
Definition: uts7segb2.h:295
uts7segb2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: uts7segb2.h:265
uts7segb2_character_cfg_t
UT-S 7-SEG B 2 character configuration object.
Definition: uts7segb2.h:274
uts7segb2_cfg_t::mosi
pin_name_t mosi
Definition: uts7segb2.h:254
uts7segb2_character_cfg_t::brightness
uint16_t brightness
Definition: uts7segb2.h:281
uts7segb2_display_number
err_t uts7segb2_display_number(uts7segb2_t *ctx, uts7segb2_number_cfg_t number)
UT-S 7-SEG B 2 display number function.
uts7segb2_t::pwm
digital_out_t pwm
Definition: uts7segb2.h:237
uts7segb2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: uts7segb2.h:264
UTS7SEGB2_OK
@ UTS7SEGB2_OK
Definition: uts7segb2.h:306
uts7segb2_cfg_t::miso
pin_name_t miso
Definition: uts7segb2.h:253
uts7segb2_cfg_t::sck
pin_name_t sck
Definition: uts7segb2.h:255
uts7segb2_number_cfg_t::brightness_bottom
uint16_t brightness_bottom
Definition: uts7segb2.h:294