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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define UTS7SEGB2_SEG_DIS14_SEG0 0x00000001l
61 #define UTS7SEGB2_SEG_DIS14_SEG1 0x00000002l
62 #define UTS7SEGB2_SEG_DIS14_SEG2 0x00000004l
63 #define UTS7SEGB2_SEG_DIS14_SEG3 0x00000008l
64 #define UTS7SEGB2_SEG_DIS14_SEG4 0x00000010l
65 #define UTS7SEGB2_SEG_DIS14_SEG5 0x00000020l
66 #define UTS7SEGB2_SEG_DIS14_SEG6 0x00000040l
67 #define UTS7SEGB2_SEG_DIS14_SEG7 0x00000080l
68 #define UTS7SEGB2_SEG_DIS25_SEG0 0x00000100l
69 #define UTS7SEGB2_SEG_DIS25_SEG1 0x00000200l
70 #define UTS7SEGB2_SEG_DIS25_SEG2 0x00000400l
71 #define UTS7SEGB2_SEG_DIS25_SEG3 0x00000800l
72 #define UTS7SEGB2_SEG_DIS25_SEG4 0x00001000l
73 #define UTS7SEGB2_SEG_DIS25_SEG5 0x00002000l
74 #define UTS7SEGB2_SEG_DIS25_SEG6 0x00004000l
75 #define UTS7SEGB2_SEG_DIS25_SEG7 0x00008000l
76 #define UTS7SEGB2_SEG_DIS36_SEG0 0x00010000l
77 #define UTS7SEGB2_SEG_DIS36_SEG1 0x00020000l
78 #define UTS7SEGB2_SEG_DIS36_SEG2 0x00040000l
79 #define UTS7SEGB2_SEG_DIS36_SEG3 0x00080000l
80 #define UTS7SEGB2_SEG_DIS36_SEG4 0x00100000l
81 #define UTS7SEGB2_SEG_DIS36_SEG5 0x00200000l
82 #define UTS7SEGB2_SEG_DIS36_SEG6 0x00400000l
83 #define UTS7SEGB2_SEG_DIS36_SEG7 0x00800000l
84 #define UTS7SEGB2_SEG_ALL 0x01FFFFFFl
85 #define UTS7SEGB2_SEG_BIT_MASK 0x01FFFFFFl
86 
91 #define UTS7SEGB2_NIBBLE_LOW 0x000Fu
92 #define UTS7SEGB2_NIBBLE_HIGH 0x00F0u
93 #define UTS7SEGB2_BYTE_LOW 0x00FFu
94 #define UTS7SEGB2_WORD_BIT_POS_0 0x0001u
95 #define UTS7SEGB2_WORD_BIT_POS_14 0x4000u
96 #define UTS7SEGB2_WORD_BIT_POS_15 0x8000u
97 
102 #define UTS7SEGB2_SEG_NUM_START 0
103 #define UTS7SEGB2_SEG_NUM_END 23
104 #define UTS7SEGB2_SEG_NUM_POS 24
105 
110 #define UTS7SEGB2_BRIGHTNESS_MIN 0x0000u
111 #define UTS7SEGB2_BRIGHTNESS_DEFAULT 0x07FFu
112 #define UTS7SEGB2_BRIGHTNESS_MAX 0x0FFFu
113 
119 #define UTS7SEGB2_BASE_NUM_SYS_BINARY 2
120 #define UTS7SEGB2_BINARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_BINARY * \
121  UTS7SEGB2_BASE_NUM_SYS_BINARY * \
122  UTS7SEGB2_BASE_NUM_SYS_BINARY - 1
123 #define UTS7SEGB2_BASE_NUM_SYS_TERNARY 3
124 #define UTS7SEGB2_TERNARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_TERNARY * \
125  UTS7SEGB2_BASE_NUM_SYS_TERNARY * \
126  UTS7SEGB2_BASE_NUM_SYS_TERNARY - 1
127 #define UTS7SEGB2_BASE_NUM_SYS_QUATERNARY 4
128 #define UTS7SEGB2_QUATERNARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_QUATERNARY * \
129  UTS7SEGB2_BASE_NUM_SYS_QUATERNARY * \
130  UTS7SEGB2_BASE_NUM_SYS_QUATERNARY - 1
131 #define UTS7SEGB2_BASE_NUM_SYS_QUINARY 5
132 #define UTS7SEGB2_QUINARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_QUINARY * \
133  UTS7SEGB2_BASE_NUM_SYS_QUINARY * \
134  UTS7SEGB2_BASE_NUM_SYS_QUINARY - 1
135 #define UTS7SEGB2_BASE_NUM_SYS_SENARY 6
136 #define UTS7SEGB2_SENARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_SENARY * \
137  UTS7SEGB2_BASE_NUM_SYS_SENARY * \
138  UTS7SEGB2_BASE_NUM_SYS_SENARY - 1
139 #define UTS7SEGB2_BASE_NUM_SYS_SEPTENARY 7
140 #define UTS7SEGB2_SEPTENARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_SEPTENARY * \
141  UTS7SEGB2_BASE_NUM_SYS_SEPTENARY * \
142  UTS7SEGB2_BASE_NUM_SYS_SEPTENARY - 1
143 #define UTS7SEGB2_BASE_NUM_SYS_OCTAL 8
144 #define UTS7SEGB2_OCTAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_OCTAL * \
145  UTS7SEGB2_BASE_NUM_SYS_OCTAL * \
146  UTS7SEGB2_BASE_NUM_SYS_OCTAL - 1
147 #define UTS7SEGB2_BASE_NUM_SYS_NONARY 9
148 #define UTS7SEGB2_NONARY_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_NONARY * \
149  UTS7SEGB2_BASE_NUM_SYS_NONARY * \
150  UTS7SEGB2_BASE_NUM_SYS_NONARY - 1
151 #define UTS7SEGB2_BASE_NUM_SYS_DECIMAL 10
152 #define UTS7SEGB2_DECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_DECIMAL * \
153  UTS7SEGB2_BASE_NUM_SYS_DECIMAL * \
154  UTS7SEGB2_BASE_NUM_SYS_DECIMAL - 1
155 #define UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL 11
156 #define UTS7SEGB2_UNDECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL * \
157  UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL * \
158  UTS7SEGB2_BASE_NUM_SYS_UNDECIMAL - 1
159 #define UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL 12
160 #define UTS7SEGB2_DUODECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL * \
161  UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL * \
162  UTS7SEGB2_BASE_NUM_SYS_DUODECIMAL - 1
163 #define UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL 16
164 #define UTS7SEGB2_HEXADECIMAL_NUM_MAX UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL * \
165  UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL * \
166  UTS7SEGB2_BASE_NUM_SYS_HEXADECIMAL - 1
167 
172 #define UTS7SEGB2_TOP_SEG_NO_DOT 0x00
173 #define UTS7SEGB2_TOP_SEG_DOT_RIGHT 0x01
174 #define UTS7SEGB2_TOP_SEG_DOT_MIDDLE 0x02
175 #define UTS7SEGB2_TOP_SEG_DOT_LEFT 0x04
176 #define UTS7SEGB2_BOTTOM_SEG_NO_DOT 0x00
177 #define UTS7SEGB2_BOTTOM_SEG_DOT_RIGHT 0x20
178 #define UTS7SEGB2_BOTTOM_SEG_DOT_LEFT 0x08
179 #define UTS7SEGB2_BOTTOM_SEG_DOT_MIDDLE 0x10
180 
189 #define UTS7SEGB2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
190 #define UTS7SEGB2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
191  // uts7segb2_set
193 
208 #define UTS7SEGB2_MAP_MIKROBUS( cfg, mikrobus ) \
209  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
210  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
211  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
212  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
213  cfg.cs2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
214  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
215  // uts7segb2_map // uts7segb2
218 
223 typedef struct
224 {
225  // Output pins
226  digital_out_t cs2;
227  digital_out_t pwm;
229  // Modules
230  spi_master_t spi;
232  pin_name_t chip_select;
234 } uts7segb2_t;
235 
240 typedef struct
241 {
242  // Communication gpio pins
243  pin_name_t miso;
244  pin_name_t mosi;
245  pin_name_t sck;
246  pin_name_t cs;
248  // Additional gpio pins
249  pin_name_t cs2;
250  pin_name_t pwm;
252  // static variable
253  uint32_t spi_speed;
254  spi_master_mode_t spi_mode;
255  spi_master_chip_select_polarity_t cs_polarity;
258 
263 typedef struct
264 {
265  uint8_t char_top_left;
266  uint8_t char_top_mid;
267  uint8_t char_top_right;
269  uint8_t char_bottom_mid;
271  uint16_t brightness;
274 
279 typedef struct
280 {
281  uint16_t num_top;
282  uint16_t brightness_top;
283  uint16_t num_bottom;
284  uint16_t brightness_bottom;
285  uint8_t base;
286  uint8_t dot_bit_mask;
289 
294 typedef enum
295 {
297  UTS7SEGB2_ERROR = -1
298 
300 
305 typedef enum
306 {
309 
311 
328 
343 
357 
372 err_t uts7segb2_top_seg_write ( uts7segb2_t *ctx, uint8_t *data_in, uint8_t len );
373 
388 err_t uts7segb2_top_seg_read ( uts7segb2_t *ctx, uint8_t *data_out, uint8_t len );
389 
404 err_t uts7segb2_bottom_seg_write ( uts7segb2_t *ctx, uint8_t *data_in, uint8_t len );
405 
420 err_t uts7segb2_bottom_seg_read ( uts7segb2_t *ctx, uint8_t *data_out, uint8_t len );
421 
434 
446 
463  uint8_t seg_num, uint16_t brightness );
464 
481  uint32_t seg_bit_mask, uint16_t brightness );
482 
499 
516 
517 #ifdef __cplusplus
518 }
519 #endif
520 #endif // UTS7SEGB2_H
521  // uts7segb2
523 
524 // ------------------------------------------------------------------------ END
uts7segb2_cfg_t::pwm
pin_name_t pwm
Definition: uts7segb2.h:250
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:226
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:270
uts7segb2_seg_sel_t
uts7segb2_seg_sel_t
UT-S 7-SEG B 2 segment group selection value data.
Definition: uts7segb2.h:306
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:268
uts7segb2_t
UT-S 7-SEG B 2 Click context object.
Definition: uts7segb2.h:224
uts7segb2_cfg_t::cs2
pin_name_t cs2
Definition: uts7segb2.h:249
uts7segb2_character_cfg_t::char_bottom_mid
uint8_t char_bottom_mid
Definition: uts7segb2.h:269
uts7segb2_number_cfg_t
UT-S 7-SEG B 2 number configuration object.
Definition: uts7segb2.h:280
uts7segb2_number_cfg_t::dot_bit_mask
uint8_t dot_bit_mask
Definition: uts7segb2.h:286
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:307
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:266
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:267
UTS7SEGB2_ERROR
@ UTS7SEGB2_ERROR
Definition: uts7segb2.h:297
uts7segb2_t::chip_select
pin_name_t chip_select
Definition: uts7segb2.h:232
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:265
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:308
uts7segb2_cfg_t::spi_speed
uint32_t spi_speed
Definition: uts7segb2.h:253
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:241
uts7segb2_number_cfg_t::num_top
uint16_t num_top
Definition: uts7segb2.h:281
uts7segb2_number_cfg_t::num_bottom
uint16_t num_bottom
Definition: uts7segb2.h:283
uts7segb2_cfg_t::cs
pin_name_t cs
Definition: uts7segb2.h:246
uts7segb2_t::spi
spi_master_t spi
Definition: uts7segb2.h:230
uts7segb2_return_value_t
uts7segb2_return_value_t
UT-S 7-SEG B 2 Click return value data.
Definition: uts7segb2.h:295
uts7segb2_number_cfg_t::brightness_top
uint16_t brightness_top
Definition: uts7segb2.h:282
uts7segb2_number_cfg_t::base
uint8_t base
Definition: uts7segb2.h:285
uts7segb2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: uts7segb2.h:255
uts7segb2_character_cfg_t
UT-S 7-SEG B 2 character configuration object.
Definition: uts7segb2.h:264
uts7segb2_cfg_t::mosi
pin_name_t mosi
Definition: uts7segb2.h:244
uts7segb2_character_cfg_t::brightness
uint16_t brightness
Definition: uts7segb2.h:271
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:227
uts7segb2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: uts7segb2.h:254
UTS7SEGB2_OK
@ UTS7SEGB2_OK
Definition: uts7segb2.h:296
uts7segb2_cfg_t::miso
pin_name_t miso
Definition: uts7segb2.h:243
uts7segb2_cfg_t::sck
pin_name_t sck
Definition: uts7segb2.h:245
uts7segb2_number_cfg_t::brightness_bottom
uint16_t brightness_bottom
Definition: uts7segb2.h:284