c7x10b  2.0.0.0
c7x10b.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 
23 #ifndef C7X10B_H
24 #define C7X10B_H
25 
30 #ifdef PREINIT_SUPPORTED
31 #include "preinit.h"
32 #endif
33 
34 #ifdef MikroCCoreVersion
35  #if MikroCCoreVersion >= 1
36  #include "delays.h"
37  #endif
38 #endif
39 
40 #include "drv_digital_out.h"
41 #include "drv_digital_in.h"
42 #include "drv_spi_master.h"
43 
44 // -------------------------------------------------------------- PUBLIC MACROS
45 
56 #define C7X10B_MAP_MIKROBUS( cfg, mikrobus ) \
57  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
58  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
59  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
60  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
61  cfg.rc = MIKROBUS( mikrobus, MIKROBUS_AN ); \
62  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
63  cfg.rr = MIKROBUS( mikrobus, MIKROBUS_PWM )
64 
70 #define C7X10B_DISPLAY_DELAY_5MS 5
71 #define C7X10B_DISPLAY_DELAY_10MS 10
72 #define C7X10B_DISPLAY_DELAY_20MS 20
73 #define C7X10B_DISPLAY_DELAY_35MS 35
74 #define C7X10B_DISPLAY_DELAY_50MS 50
75 #define C7X10B_DISPLAY_DELAY_100MS 100
76 #define C7X10B_DISPLAY_DELAY_150MS 150
77 
83 #define C7X10B_DISPLAY_LEFT 0x00
84 #define C7X10B_DISPLAY_RIGHT 0x01
85 #define C7X10B_DISPLAY_REFRESH 0x10
86 
92 #define C7X10B_DISPLAY_PIXEL_REFRESH 0x01
93 #define C7X10B_DISPLAY_PIXEL_STORAGE 0x00
94  // End group macro
97 
98 // --------------------------------------------------------------- PUBLIC TYPES
99 
108 typedef struct
109 {
110  digital_out_t cs;
111 
112  // Output pins
113 
114  digital_out_t rc;
115  digital_out_t rst;
116  digital_out_t rr;
117 
118  // Modules
119 
120  spi_master_t spi;
121  pin_name_t chip_select;
122 
123 } c7x10b_t;
124 
128 typedef struct
129 {
130  // Communication gpio pins
131 
132  pin_name_t miso;
133  pin_name_t mosi;
134  pin_name_t sck;
135  pin_name_t cs;
136 
137  // Additional gpio pins
138 
139  pin_name_t rc;
140  pin_name_t rst;
141  pin_name_t rr;
142 
143  // static variable
144 
145  uint32_t spi_speed;
146  spi_master_mode_t spi_mode;
147  spi_master_chip_select_polarity_t cs_polarity;
148 
149 } c7x10b_cfg_t;
150 
154 typedef struct
155 {
156  uint8_t cord_x;
157  uint8_t cord_y;
158 
160 
161 typedef enum
162 {
164  C7X10B_ERROR = -1
166  // End types group
168 
169 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
170 
175 #ifdef __cplusplus
176 extern "C"{
177 #endif
178 
188 
198 
208 void c7x10b_display_process ( c7x10b_t *ctx, uint8_t *frame, uint16_t disp_delay );
209 
219 void c7x10b_draw_pixel ( c7x10b_t *ctx, c7x10b_pixel_t *pixel, uint8_t mode, uint8_t px_delay );
220 
231 void c7x10b_draw_char ( c7x10b_t *ctx, char ch, uint8_t pos, uint8_t ch_delay );
232 
242 void c7x10b_draw_number ( c7x10b_t *ctx, uint8_t num, uint16_t num_delay );
243 
244 #ifdef __cplusplus
245 }
246 #endif
247 #endif // _C7X10B_H_
248  // End public_function group
251 
252 // ------------------------------------------------------------------------- END
c7x10b_cfg_t::cs
pin_name_t cs
Definition: c7x10b.h:135
c7x10b_cfg_t::rr
pin_name_t rr
Definition: c7x10b.h:141
c7x10b_cfg_t
Click configuration structure definition.
Definition: c7x10b.h:129
c7x10b_t::rr
digital_out_t rr
Definition: c7x10b.h:116
c7x10b_cfg_t::mosi
pin_name_t mosi
Definition: c7x10b.h:133
c7x10b_t::rst
digital_out_t rst
Definition: c7x10b.h:115
c7x10b_t::cs
digital_out_t cs
Definition: c7x10b.h:110
c7x10b_cfg_setup
void c7x10b_cfg_setup(c7x10b_cfg_t *cfg)
Config Object Initialization function.
c7x10b_pixel_t
pixel structure definition.
Definition: c7x10b.h:155
c7x10b_pixel_t::cord_x
uint8_t cord_x
Definition: c7x10b.h:156
c7x10b_draw_pixel
void c7x10b_draw_pixel(c7x10b_t *ctx, c7x10b_pixel_t *pixel, uint8_t mode, uint8_t px_delay)
Draw pixel (function).
c7x10b_cfg_t::sck
pin_name_t sck
Definition: c7x10b.h:134
c7x10b_cfg_t::rst
pin_name_t rst
Definition: c7x10b.h:140
c7x10b_cfg_t::rc
pin_name_t rc
Definition: c7x10b.h:139
C7X10B_ERROR
@ C7X10B_ERROR
Definition: c7x10b.h:164
c7x10b_draw_char
void c7x10b_draw_char(c7x10b_t *ctx, char ch, uint8_t pos, uint8_t ch_delay)
Draw char (function).
c7x10b_cfg_t::spi_speed
uint32_t spi_speed
Definition: c7x10b.h:145
c7x10b_pixel_t::cord_y
uint8_t cord_y
Definition: c7x10b.h:157
c7x10b_draw_number
void c7x10b_draw_number(c7x10b_t *ctx, uint8_t num, uint16_t num_delay)
Draw number (function).
c7x10b_t::rc
digital_out_t rc
Definition: c7x10b.h:114
c7x10b_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: c7x10b.h:147
c7x10b_display_process
void c7x10b_display_process(c7x10b_t *ctx, uint8_t *frame, uint16_t disp_delay)
Display process (function).
C7X10B_OK
@ C7X10B_OK
Definition: c7x10b.h:163
c7x10b_return_value_t
c7x10b_return_value_t
Definition: c7x10b.h:162
c7x10b_cfg_t::miso
pin_name_t miso
Definition: c7x10b.h:132
c7x10b_t::chip_select
pin_name_t chip_select
Definition: c7x10b.h:121
c7x10b_init
c7x10b_return_value_t c7x10b_init(c7x10b_t *ctx, c7x10b_cfg_t *cfg)
Initialization function.
c7x10b_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: c7x10b.h:146
c7x10b_t
Click ctx object definition.
Definition: c7x10b.h:109
c7x10b_t::spi
spi_master_t spi
Definition: c7x10b.h:120