lcdmono  2.0.0.0
lcdmono.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 LCDMONO_H
36 #define LCDMONO_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define LCDMONO_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.com = MIKROBUS( mikrobus, MIKROBUS_PWM )
60 
66 #define LCDMONO_RETVAL uint8_t
67 
68 #define LCDMONO_OK 0x00
69 #define LCDMONO_INIT_ERROR 0xFF
70 
76 #define LCDMONO_DISPLAY_WIDTH 128
77 #define LCDMONO_DISPLAY_HEIGHT 128
78 #define LCDMONO_DISPLAY_RESOLUTIONS 2307
79 
85 #define LCDMONO_COLOR_WHITE 0x00
86 #define LCDMONO_COLOR_BLACK 0x01
87 
93 #define LCDMONO_REFRESH_DISPLAY_END 0x01
94 #define LCDMONO_CHECK_NEW_TEXT 0x00
95 #define LCDMONO_REFRESH_TEXT_BUFFER 0x10
96 
102 #define LCDMONO_CMD_DISPLAY_FLAG 0x80
103 #define LCDMONO_CMD_CLEAR_FLAG 0x20
104 #define LCDMONO_DUMMY_BYTE 0x00
105 
111 #define LCDMONO_POWER_ON 1
112 #define LCDMONO_POWER_OFF 0
113  // End group macro
116 // --------------------------------------------------------------- PUBLIC TYPES
122 typedef struct
123 {
124  uint8_t *this_font;
125  uint16_t first_char;
126  uint16_t last_char;
127  uint16_t height;
128 
130 
131 typedef struct
132 {
133  uint16_t x;
134  uint16_t y;
135 
137 
138 typedef struct
139 {
140  // Draw Text
141  uint8_t len; // Number of characters in the text
142  uint16_t start_cord_x; // X position of the text
143  uint16_t start_cord_y; // Y position of the text
144  uint8_t text_color; // Text font color
145  uint8_t bg_color; // Background color
146 
148 
152 typedef struct
153 {
154  // Output pins
155 
156  digital_out_t com;
157  digital_out_t cs;
158 
159  // Modules
160 
161  spi_master_t spi;
162  pin_name_t chip_select;
163 
164  uint8_t lcd_frame[ 2307 ];
166 
170 
171 } lcdmono_t;
172 
176 typedef struct
177 {
178  // Communication gpio pins
179 
180  pin_name_t miso;
181  pin_name_t mosi;
182  pin_name_t sck;
183  pin_name_t cs;
184 
185  // Additional gpio pins
186 
187  pin_name_t com;
188 
189  // static variable
190 
191  uint32_t spi_speed;
192  spi_master_mode_t spi_mode;
193  spi_master_chip_select_polarity_t cs_polarity;
194 
196 
197 } lcdmono_cfg_t;
198  // End types group
200 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
201 
206 #ifdef __cplusplus
207 extern "C"{
208 #endif
209 
218 void lcdmono_cfg_setup ( lcdmono_cfg_t *cfg );
219 
228 
238  lcdmono_t *ctx,
239  uint8_t *wr_buf,
240  uint16_t wr_len,
241  uint8_t *rd_buf,
242  uint16_t rd_len
243 );
244 
254 void lcdmono_send_line_package ( lcdmono_t *ctx, uint8_t addr, uint8_t *tx_data );
255 
261 void lcdmono_clear ( lcdmono_t *ctx );
262 
273 void lcdmono_draw_frame ( lcdmono_t *ctx, uint8_t *frame_data );
274 
285 void lcdmono_draw_const_frame ( lcdmono_t *ctx, const uint8_t *frame_data );
286 
300 void lcdmono_draw_text ( lcdmono_t *ctx, char *text_buf, lcdmono_text_settings_t *tx_set , uint8_t end_mode);
301 
308 void lcdmono_set_font ( lcdmono_t *ctx, lcdmono_font_t *dev_lcd_font );
309 
316 void lcdmono_display_power ( lcdmono_t *ctx, uint8_t ctrl );
317 
323 void lcdmono_display_reset ( lcdmono_t *ctx );
324 
325 #ifdef __cplusplus
326 }
327 #endif
328 #endif // _LCDMONO_H_
329  // End public_function group
332 
333 // ------------------------------------------------------------------------- END
uint16_t first_char
Definition: lcdmono.h:125
void lcdmono_draw_text(lcdmono_t *ctx, char *text_buf, lcdmono_text_settings_t *tx_set, uint8_t end_mode)
Draw text on the screen.
uint16_t start_cord_x
Definition: lcdmono.h:142
Definition: lcdmono.h:122
pin_name_t cs
Definition: lcdmono.h:183
spi_master_t spi
Definition: lcdmono.h:161
spi_master_chip_select_polarity_t cs_polarity
Definition: lcdmono.h:193
uint16_t x
Definition: lcdmono.h:133
uint8_t len
Definition: lcdmono.h:141
lcdmono_coordinate_t lcd_cord
Definition: lcdmono.h:168
void lcdmono_cfg_setup(lcdmono_cfg_t *cfg)
Config Object Initialization function.
uint8_t * this_font
Definition: lcdmono.h:124
Click configuration structure definition.
Definition: lcdmono.h:176
spi_master_mode_t spi_mode
Definition: lcdmono.h:192
lcdmono_text_settings_t tx_set
Definition: lcdmono.h:169
void lcdmono_display_reset(lcdmono_t *ctx)
Reset procedure.
uint32_t spi_speed
Definition: lcdmono.h:191
pin_name_t mosi
Definition: lcdmono.h:181
uint8_t lcd_frame_color
Definition: lcdmono.h:165
pin_name_t miso
Definition: lcdmono.h:180
void lcdmono_draw_frame(lcdmono_t *ctx, uint8_t *frame_data)
Displays draw frame.
uint16_t last_char
Definition: lcdmono.h:126
void lcdmono_set_font(lcdmono_t *ctx, lcdmono_font_t *dev_lcd_font)
Set font.
uint8_t text_color
Definition: lcdmono.h:144
digital_out_t com
Definition: lcdmono.h:156
digital_out_t cs
Definition: lcdmono.h:157
uint8_t bg_color
Definition: lcdmono.h:145
LCDMONO_RETVAL lcdmono_init(lcdmono_t *ctx, lcdmono_cfg_t *cfg)
Initialization function.
void lcdmono_draw_const_frame(lcdmono_t *ctx, const uint8_t *frame_data)
Displays draw const frame.
lcdmono_font_t lcd_font
Definition: lcdmono.h:167
uint16_t height
Definition: lcdmono.h:127
void lcdmono_display_power(lcdmono_t *ctx, uint8_t ctrl)
Display Power State.
uint16_t y
Definition: lcdmono.h:134
void lcdmono_clear(lcdmono_t *ctx)
Clear display.
pin_name_t sck
Definition: lcdmono.h:182
void lcdmono_send_line_package(lcdmono_t *ctx, uint8_t addr, uint8_t *tx_data)
Send line data package.
pin_name_t chip_select
Definition: lcdmono.h:162
Definition: lcdmono.h:138
Click ctx object definition.
Definition: lcdmono.h:152
pin_name_t com
Definition: lcdmono.h:187
uint8_t dev_lcd_frame_color
Definition: lcdmono.h:195
uint16_t start_cord_y
Definition: lcdmono.h:143
void lcdmono_generic_transfer(lcdmono_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
Definition: lcdmono.h:131
#define LCDMONO_RETVAL
Definition: lcdmono.h:66