lcdmini  2.0.0.0
lcdmini.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 LCDMINI_H
29 #define LCDMINI_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 #include "drv_pwm.h"
50 
71 #define LCDMINI_IODIRB_BANK0 0x01
72 #define LCDMINI_OLATB_BANK0 0x15
73 #define LCDMINI_IOCON_BANK0 0x0A
74 #define LCDMINI_ADDRESS_CODE 0x40
75 #define LCDMINI_GPIO_REGISTER 0x09
76  // lcdmini_reg
78 
93 #define LCDMINI_ENABLE 0x08
94 #define LCDMINI_RESET 0x04
95 
96 #define LCDMINI_OP_CODE_READ 0x01
97 #define LCDMINI_OP_CODE_WRITE 0xFE
98 
103 #define LCDMINI_CLEAR 0x01
104 #define LCDMINI_RETURN_HOME 0x02
105 #define LCDMINI_DISPLAY_OFF_CURSOR_OFF 0x08
106 #define LCDMINI_CURSOR_OFF 0x0C
107 #define LCDMINI_UNDERLINE_ON 0x0E
108 #define LCDMINI_BLINK_CURSOR_ON 0x0F
109 #define LCDMINI_MOVE_CURSOR_LEFT 0x10
110 #define LCDMINI_MOVE_CURSOR_RIGHT 0x14
111 #define LCDMINI_TURN_ON 0x0A
112 #define LCDMINI_TURN_OFF 0x0C
113 #define LCDMINI_SHIFT_LEFT 0x18
114 #define LCDMINI_SHIFT_RIGHT 0x1C
115 #define LCDMINI_2_LINE_5X7 0x28
116 
117 #define LCDMINI_FIRST_ROW 0x80
118 #define LCDMINI_SECOND_ROW 0xC0
119 #define LCDMINI_THIRD_ROW 0x94
120 #define LCDMINI_FOURTH_ROW 0xD4
121 
122 
127 #define LCDMINI_DEF_FREQ 500
128 
137 #define LCDMINI_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
138 #define LCDMINI_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
139  // lcdmini_set
141 
156 #define LCDMINI_MAP_MIKROBUS( cfg, mikrobus ) \
157  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
158  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
159  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
160  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
161  cfg.cs2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
162  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
163  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
164  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
165  // lcdmini_map // lcdmini
168 
173 typedef struct
174 {
175  // Output pins
176  digital_out_t cs2;
177  digital_out_t rst;
179  // Input pins
180  digital_in_t int_pin;
182  // Modules
183  pwm_t pwm;
185  spi_master_t spi;
187  pin_name_t chip_select;
188  uint32_t pwm_freq;
190 } lcdmini_t;
191 
196 typedef struct
197 {
198  // Communication gpio pins
199  pin_name_t miso;
200  pin_name_t mosi;
201  pin_name_t sck;
202  pin_name_t cs;
204  // Additional gpio pins
205  pin_name_t cs2;
206  pin_name_t rst;
207  pin_name_t pwm;
208  pin_name_t int_pin;
210  // Static variables
211  uint32_t dev_pwm_freq;
213  uint32_t spi_speed;
214  spi_master_mode_t spi_mode;
215  spi_master_chip_select_polarity_t cs_polarity;
217 } lcdmini_cfg_t;
218 
223 typedef enum
224 {
226  LCDMINI_ERROR = -1
227 
229 
246 
260 err_t lcdmini_init ( lcdmini_t *ctx, lcdmini_cfg_t *cfg );
261 
276 
291 err_t lcdmini_generic_write ( lcdmini_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
292 
307 err_t lcdmini_generic_read ( lcdmini_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
308 
320 err_t lcdmini_set_duty_cycle ( lcdmini_t *ctx, float duty_cycle );
321 
333 
345 
355 void lcdmini_set_backlight ( lcdmini_t *ctx, float backlight_value );
356 
366 void lcdmini_set_contrast( lcdmini_t *ctx, uint8_t contrast_value );
367 
376 
385 
399 err_t lcdmini_read_register ( lcdmini_t *ctx, uint8_t reg , uint8_t *data_out );
400 
414 err_t lcdmini_write_register ( lcdmini_t *ctx, uint8_t reg , uint8_t data_in );
415 
424 void lcdmini_send_cmd ( lcdmini_t *ctx, uint8_t command );
425 
434 void lcdmini_send_char ( lcdmini_t *ctx, uint8_t character );
435 
446 void lcdmini_display_char ( lcdmini_t *ctx, uint8_t row, uint8_t column, char character );
447 
460 void lcdmini_display_text ( lcdmini_t *ctx, uint8_t row, uint8_t column, char *data_in );
461 
462 #ifdef __cplusplus
463 }
464 #endif
465 #endif // LCDMINI_H
466  // lcdmini
468 
469 // ------------------------------------------------------------------------ END
lcdmini_display_char
void lcdmini_display_char(lcdmini_t *ctx, uint8_t row, uint8_t column, char character)
LCD mini display character.
lcdmini_t::pwm
pwm_t pwm
Definition: lcdmini.h:183
lcdmini_t::rst
digital_out_t rst
Definition: lcdmini.h:177
lcdmini_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: lcdmini.h:211
lcdmini_pwm_stop
err_t lcdmini_pwm_stop(lcdmini_t *ctx)
LCD mini stop PWM module.
lcdmini_set_contrast
void lcdmini_set_contrast(lcdmini_t *ctx, uint8_t contrast_value)
Set contrast function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
lcdmini_generic_write
err_t lcdmini_generic_write(lcdmini_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
LCD mini data writing function.
lcdmini_default_cfg
err_t lcdmini_default_cfg(lcdmini_t *ctx)
LCD mini default configuration function.
lcdmini_t::spi
spi_master_t spi
Definition: lcdmini.h:185
lcdmini_t::chip_select
pin_name_t chip_select
Definition: lcdmini.h:187
lcdmini_cfg_t::cs2
pin_name_t cs2
Definition: lcdmini.h:205
lcdmini_cfg_setup
void lcdmini_cfg_setup(lcdmini_cfg_t *cfg)
LCD mini configuration object setup function.
lcdmini_send_cmd
void lcdmini_send_cmd(lcdmini_t *ctx, uint8_t command)
LCD mini send command.
lcdmini_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: lcdmini.h:215
lcdmini_cfg_t::sck
pin_name_t sck
Definition: lcdmini.h:201
lcdmini_hw_reset
void lcdmini_hw_reset(lcdmini_t *ctx)
Hardware reset function.
lcdmini_t::int_pin
digital_in_t int_pin
Definition: lcdmini.h:180
lcdmini_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: lcdmini.h:214
lcdmini_cfg_t::mosi
pin_name_t mosi
Definition: lcdmini.h:200
LCDMINI_OK
@ LCDMINI_OK
Definition: lcdmini.h:225
lcdmini_t::cs2
digital_out_t cs2
Definition: lcdmini.h:176
lcdmini_init
err_t lcdmini_init(lcdmini_t *ctx, lcdmini_cfg_t *cfg)
LCD mini initialization function.
lcdmini_set_duty_cycle
err_t lcdmini_set_duty_cycle(lcdmini_t *ctx, float duty_cycle)
LCD mini sets PWM duty cycle.
lcdmini_pwm_start
err_t lcdmini_pwm_start(lcdmini_t *ctx)
LCD mini start PWM module.
lcdmini_read_register
err_t lcdmini_read_register(lcdmini_t *ctx, uint8_t reg, uint8_t *data_out)
LCD mini register data reading function.
lcdmini_send_char
void lcdmini_send_char(lcdmini_t *ctx, uint8_t character)
LCD mini send character.
lcdmini_write_register
err_t lcdmini_write_register(lcdmini_t *ctx, uint8_t reg, uint8_t data_in)
LCD mini register data writing function.
lcdmini_cfg_t::rst
pin_name_t rst
Definition: lcdmini.h:206
lcdmini_generic_read
err_t lcdmini_generic_read(lcdmini_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
LCD mini data reading function.
lcdmini_cfg_t::pwm
pin_name_t pwm
Definition: lcdmini.h:207
lcdmini_cfg_t::cs
pin_name_t cs
Definition: lcdmini.h:202
lcdmini_cfg_t::miso
pin_name_t miso
Definition: lcdmini.h:199
lcdmini_cfg_t::int_pin
pin_name_t int_pin
Definition: lcdmini.h:208
lcdmini_get_interrupt
uint8_t lcdmini_get_interrupt(lcdmini_t *ctx)
Get interrupt.
lcdmini_return_value_t
lcdmini_return_value_t
LCD mini Click return value data.
Definition: lcdmini.h:224
lcdmini_set_backlight
void lcdmini_set_backlight(lcdmini_t *ctx, float backlight_value)
Set backlight function.
lcdmini_t::pwm_freq
uint32_t pwm_freq
Definition: lcdmini.h:188
lcdmini_t
LCD mini Click context object.
Definition: lcdmini.h:174
lcdmini_cfg_t
LCD mini Click configuration object.
Definition: lcdmini.h:197
LCDMINI_ERROR
@ LCDMINI_ERROR
Definition: lcdmini.h:226
lcdmini_cfg_t::spi_speed
uint32_t spi_speed
Definition: lcdmini.h:213
lcdmini_display_text
void lcdmini_display_text(lcdmini_t *ctx, uint8_t row, uint8_t column, char *data_in)
LCD mini display text.