utl7segb  2.1.0.0
utl7segb.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 UTL7SEGB_H
29 #define UTL7SEGB_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 
71 #define UTL7SEGB_BASE_NUM_SYS_BINARY 2
72 #define UTL7SEGB_BASE_NUM_SYS_TERNARY 3
73 #define UTL7SEGB_BASE_NUM_SYS_QUATERNARY 4
74 #define UTL7SEGB_BASE_NUM_SYS_QUINARY 5
75 #define UTL7SEGB_BASE_NUM_SYS_SENARY 6
76 #define UTL7SEGB_BASE_NUM_SYS_SEPTENARY 7
77 #define UTL7SEGB_BASE_NUM_SYS_OCTAL 8
78 #define UTL7SEGB_BASE_NUM_SYS_NONARY 9
79 #define UTL7SEGB_BASE_NUM_SYS_DECIMAL 10
80 #define UTL7SEGB_BASE_NUM_SYS_UNDECIMAL 11
81 #define UTL7SEGB_BASE_NUM_SYS_DUODECIMAL 12
82 #define UTL7SEGB_BASE_NUM_SYS_HEXADECIMAL 16
83  // utl7segb_base
85 
100 #define UTL7SEGB_NO_DOT 0
101 #define UTL7SEGB_DOT_RIGHT 1
102 #define UTL7SEGB_DOT_LEFT 2
103 #define UTL7SEGB_DOT_LEFT_RIGHT 3
104 
113 #define UTL7SEGB_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
114 #define UTL7SEGB_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
115  // utl7segb_set
117 
132 #define UTL7SEGB_MAP_MIKROBUS( cfg, mikrobus ) \
133  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
134  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
135  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
136  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
137  cfg.oe = MIKROBUS( mikrobus, MIKROBUS_PWM )
138  // utl7segb_map // utl7segb
141 
146 typedef struct
147 {
148  // Output pins
149  digital_out_t oe;
151  // Modules
152  spi_master_t spi;
154  pin_name_t chip_select;
156 } utl7segb_t;
157 
162 typedef struct
163 {
164  // Communication gpio pins
165  pin_name_t miso;
166  pin_name_t mosi;
167  pin_name_t sck;
168  pin_name_t cs;
170  // Additional gpio pins
171  pin_name_t oe;
173  // static variable
174  uint32_t spi_speed;
175  spi_master_mode_t spi_mode;
176  spi_master_chip_select_polarity_t cs_polarity;
179 
184 typedef enum
185 {
187  UTL7SEGB_ERROR = -1
188 
190 
207 
222 
236 
249 err_t utl7segb_generic_write ( utl7segb_t *ctx, uint8_t *data_in, uint8_t len );
250 
263 err_t utl7segb_generic_read ( utl7segb_t *ctx, uint8_t *data_out, uint8_t len );
264 
276 
288 
304 err_t utl7segb_display_number ( utl7segb_t *ctx, uint8_t base, uint8_t num, uint8_t dot_pos );
305 
321 err_t utl7segb_get_number ( utl7segb_t *ctx, uint8_t base, uint8_t *num, uint8_t *dot_pos );
322 
323 #ifdef __cplusplus
324 }
325 #endif
326 #endif // UTL7SEGB_H
327  // utl7segb
329 
330 // ------------------------------------------------------------------------ END
utl7segb_cfg_setup
void utl7segb_cfg_setup(utl7segb_cfg_t *cfg)
UT-L 7-SEG B configuration object setup function.
UTL7SEGB_OK
@ UTL7SEGB_OK
Definition: utl7segb.h:186
utl7segb_generic_read
err_t utl7segb_generic_read(utl7segb_t *ctx, uint8_t *data_out, uint8_t len)
UT-L 7-SEG B data reading function.
utl7segb_cfg_t
UT-L 7-SEG B Click configuration object.
Definition: utl7segb.h:163
utl7segb_t::oe
digital_out_t oe
Definition: utl7segb.h:149
utl7segb_cfg_t::sck
pin_name_t sck
Definition: utl7segb.h:167
UTL7SEGB_ERROR
@ UTL7SEGB_ERROR
Definition: utl7segb.h:187
utl7segb_t::chip_select
pin_name_t chip_select
Definition: utl7segb.h:154
spi_specifics.h
This file contains SPI specific macros, functions, etc.
utl7segb_cfg_t::oe
pin_name_t oe
Definition: utl7segb.h:171
utl7segb_cfg_t::cs
pin_name_t cs
Definition: utl7segb.h:168
utl7segb_cfg_t::mosi
pin_name_t mosi
Definition: utl7segb.h:166
utl7segb_generic_write
err_t utl7segb_generic_write(utl7segb_t *ctx, uint8_t *data_in, uint8_t len)
UT-L 7-SEG B data writing function.
utl7segb_t::spi
spi_master_t spi
Definition: utl7segb.h:152
utl7segb_enable
void utl7segb_enable(utl7segb_t *ctx)
UT-L 7-SEG B enable function.
utl7segb_display_number
err_t utl7segb_display_number(utl7segb_t *ctx, uint8_t base, uint8_t num, uint8_t dot_pos)
UT-L 7-SEG B display number function.
utl7segb_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: utl7segb.h:175
utl7segb_default_cfg
err_t utl7segb_default_cfg(utl7segb_t *ctx)
UT-L 7-SEG B default configuration function.
utl7segb_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: utl7segb.h:176
utl7segb_init
err_t utl7segb_init(utl7segb_t *ctx, utl7segb_cfg_t *cfg)
UT-L 7-SEG B initialization function.
utl7segb_return_value_t
utl7segb_return_value_t
UT-L 7-SEG B Click return value data.
Definition: utl7segb.h:185
utl7segb_cfg_t::spi_speed
uint32_t spi_speed
Definition: utl7segb.h:174
utl7segb_cfg_t::miso
pin_name_t miso
Definition: utl7segb.h:165
utl7segb_get_number
err_t utl7segb_get_number(utl7segb_t *ctx, uint8_t base, uint8_t *num, uint8_t *dot_pos)
UT-L 7-SEG B get number function.
utl7segb_disable
void utl7segb_disable(utl7segb_t *ctx)
UT-L 7-SEG B disable function.
utl7segb_t
UT-L 7-SEG B Click context object.
Definition: utl7segb.h:147