c7seg  2.0.0.0
c7seg.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef C7SEG_H
36 #define C7SEG_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define C7SEG_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.mr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
70 
76 #define C7SEG_RETVAL uint8_t
77 
78 #define C7SEG_OK 0x00
79 #define C7SEG_INIT_ERROR 0xFF
80 
86 #define C7SEG_DISPLAY_OFF 0
87 #define C7SEG_DISPLAY_ON 1
88  // End group macro
91 
92 // --------------------------------------------------------------- PUBLIC TYPES
101 typedef struct
102 {
103  digital_out_t cs;
104  // Output pins
105 
106  digital_out_t mr;
107  digital_out_t pwm;
108 
109  // Modules
110 
111  spi_master_t spi;
112  pin_name_t chip_select;
113 
114 } c7seg_t;
115 
119 typedef struct
120 {
121  // Communication gpio pins
122 
123  pin_name_t miso;
124  pin_name_t mosi;
125  pin_name_t sck;
126  pin_name_t cs;
127 
128  // Additional gpio pins
129 
130  pin_name_t mr;
131  pin_name_t pwm;
132 
133  // static variable
134 
135  uint32_t spi_speed;
136  spi_master_mode_t spi_mode;
137  spi_master_chip_select_polarity_t cs_polarity;
138 
139 } c7seg_cfg_t;
140  // End types group
142 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
143 
148 #ifdef __cplusplus
149 extern "C"{
150 #endif
151 
161 
171 
190 
202 void c7seg_generic_transfer ( c7seg_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
203 
213 void c7seg_write_data ( c7seg_t *ctx, uint8_t write_left, uint8_t write_right );
214 
222 void c7seg_reset ( c7seg_t *ctx );
223 
232 void c7seg_display_mode ( c7seg_t *ctx, uint8_t display_mode );
233 
243 void c7seg_write_data_number ( c7seg_t *ctx, uint8_t left_number, uint8_t right_number );
244 
254 void c7seg_write_data_character ( c7seg_t *ctx, char left_char, char right_char );
255 
256 #ifdef __cplusplus
257 }
258 #endif
259 #endif // _C7SEG_H_
260  // End public_function group
263 
265 // ------------------------------------------------------------------------- END
c7seg_cfg_t::mosi
pin_name_t mosi
Definition: c7seg.h:124
c7seg_display_mode
void c7seg_display_mode(c7seg_t *ctx, uint8_t display_mode)
Display mode function.
c7seg_t::chip_select
pin_name_t chip_select
Definition: c7seg.h:112
c7seg_cfg_setup
void c7seg_cfg_setup(c7seg_cfg_t *cfg)
Config Object Initialization function.
c7seg_write_data
void c7seg_write_data(c7seg_t *ctx, uint8_t write_left, uint8_t write_right)
Generic write data function.
c7seg_t::spi
spi_master_t spi
Definition: c7seg.h:111
c7seg_write_data_character
void c7seg_write_data_character(c7seg_t *ctx, char left_char, char right_char)
c7seg_cfg_t::pwm
pin_name_t pwm
Definition: c7seg.h:131
c7seg_t::mr
digital_out_t mr
Definition: c7seg.h:106
c7seg_t::cs
digital_out_t cs
Definition: c7seg.h:103
c7seg_cfg_t::miso
pin_name_t miso
Definition: c7seg.h:123
c7seg_init
C7SEG_RETVAL c7seg_init(c7seg_t *ctx, c7seg_cfg_t *cfg)
Initialization function.
C7SEG_RETVAL
#define C7SEG_RETVAL
Definition: c7seg.h:76
c7seg_t::pwm
digital_out_t pwm
Definition: c7seg.h:107
c7seg_cfg_t::mr
pin_name_t mr
Definition: c7seg.h:130
c7seg_write_data_number
void c7seg_write_data_number(c7seg_t *ctx, uint8_t left_number, uint8_t right_number)
c7seg_cfg_t::cs
pin_name_t cs
Definition: c7seg.h:126
c7seg_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: c7seg.h:136
c7seg_cfg_t::spi_speed
uint32_t spi_speed
Definition: c7seg.h:135
c7seg_cfg_t
Click configuration structure definition.
Definition: c7seg.h:120
c7seg_cfg_t::sck
pin_name_t sck
Definition: c7seg.h:125
c7seg_generic_transfer
void c7seg_generic_transfer(c7seg_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
c7seg_default_cfg
void c7seg_default_cfg(c7seg_t *ctx)
Click Default Configuration function.
c7seg_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: c7seg.h:137
c7seg_reset
void c7seg_reset(c7seg_t *ctx)
Click Reset function.
c7seg_t
Click ctx object definition.
Definition: c7seg.h:102