c16x12  2.0.0.0
c16x12.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 C16X12_H
36 #define C16X12_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define C16X12_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.sdb = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
78 #define C16X12_RETVAL uint8_t
79 
80 #define C16X12_OK 0x00
81 #define C16X12_INIT_ERROR 0xFF
82 
88 #define C16X12G_PSR 0xFD
89 #define C16X12G_PSWL 0xFE
90 #define C16X12G_IMR 0xF0
91 #define C16X12G_ISR 0xF1
92 #define C16X12G_PSWL_DISABLE 0x00
93 #define C16X12G_PSWL_ENABLE 0xC5
94 #define C16X12G_IMR_IAC 0x08
95 #define C16X12G_IMR_IAB 0x04
96 #define C16X12G_IMR_IS 0x02
97 #define C16X12G_IMR_IO 0x01
98 #define C16X12G_ISR_ABM3 0x10
99 #define C16X12G_ISR_ABM2 0x08
100 #define C16X12G_ISR_ABM1 0x04
101 #define C16X12G_ISR_SB 0x02
102 #define C16X12G_ISR_OB 0x01
103 
109 #define C16X12G_CR_SYNC_MASTER 0x40
110 #define C16X12G_CR_SYNC_SLAVE 0x80
111 #define C16X12G_CR_OSD 0x04
112 #define C16X12G_CR_BEN 0x02
113 #define C16X12G_CR_SSD 0x01
114 #define C16X12G_LEDONOFF 0x0000
115 #define C16X12G_LEDOPEN 0x0018
116 #define C16X12G_LEDSHORT 0x0030
117 #define C16X12G_LEDPWM 0x0100
118 #define C16X12G_LEDABM 0x0200
119 #define C16X12G_CR 0x0300
120 #define C16X12G_GCC 0x0301
121 #define C16X12G_ABM1 0x0302
122 #define C16X12G_ABM2 0x0306
123 #define C16X12G_ABM3 0x030A
124 #define C16X12G_TUR 0x030E
125 #define C16X12G_SWPUR 0x030F
126 #define C16X12G_CSPDR 0x0310
127 #define C16X12G_RESET 0x0311
128 
134 #define C16X12G_CS 16
135 #define C16X12G_SW 12
136 #define C16X12G_GND_ADDR 0x00
137 #define C16X12G_SCL_ADDR 0x01
138 #define C16X12G_SDA_ADDR 0x02
139 #define C16X12G_VCC_ADDR 0x03
140 #define C16X12G_ABM_LOOP_TIMES_MAX 0x0FFF
141 #define C16X12G_ABM_LOOP_FOREVER 0x0000
142 
148 #define C16X12G_LED_STATE_OFF 0x00
149 #define C16X12G_LED_STATE_ON 0x01
150 
156 #define C16X12G_CONTINUE_SETTINGS 0x00
157 #define C16X12G_STOP_SETTINGS 0x01
158 
164 #define C16X12G_LED_STATUS_NORMAL 0x00
165 #define C16X12G_LED_STATUS_OPEN 0x01
166 #define C16X12G_LED_STATUS_SHORT 0x02
167 #define C16X12G_LED_STATUS_UNKNOWN 0x03
168 
174 #define C16X12G_RESISTOR_OFF 0x00
175 #define C16X12G_RESISTOR_500 0x01
176 #define C16X12G_RESISTOR_1K 0x02
177 #define C16X12G_RESISTOR_2K 0x03
178 #define C16X12G_RESISTOR_4K 0x04
179 #define C16X12G_RESISTOR_8K 0x05
180 #define C16X12G_RESISTOR_16K 0x06
181 #define C16X12G_RESISTOR_32K 0x07
182 
188 #define C16X12G_LED_MODE_PWM 0x00
189 #define C16X12G_LED_MODE_ABM1 0x01
190 #define C16X12G_LED_MODE_ABM2 0x02
191 #define C16X12G_LED_MODE_ABM3 0x03
192 
198 #define C16X12G_ABM_T1_210MS 0x00
199 #define C16X12G_ABM_T1_420MS 0x20
200 #define C16X12G_ABM_T1_840MS 0x40
201 #define C16X12G_ABM_T1_1680MS 0x60
202 #define C16X12G_ABM_T1_3360MS 0x80
203 #define C16X12G_ABM_T1_6720MS 0xA0
204 #define C16X12G_ABM_T1_13440MS 0xC0
205 #define C16X12G_ABM_T1_26880MS 0xE0
206 
212 #define C16X12G_ABM_T2_0MS 0x00
213 #define C16X12G_ABM_T2_210MS 0x02
214 #define C16X12G_ABM_T2_420MS 0x04
215 #define C16X12G_ABM_T2_840MS 0x06
216 #define C16X12G_ABM_T2_1680MS 0x08
217 #define C16X12G_ABM_T2_3360MS 0x0A
218 #define C16X12G_ABM_T2_6720MS 0x0C
219 #define C16X12G_ABM_T2_13440MS 0x0E
220 #define C16X12G_ABM_T2_26880MS 0x10
221 
227 #define C16X12G_ABM_T3_210MS 0x00
228 #define C16X12G_ABM_T3_420MS 0x20
229 #define C16X12G_ABM_T3_840MS 0x40
230 #define C16X12G_ABM_T3_1680MS 0x60
231 #define C16X12G_ABM_T3_3360MS 0x80
232 #define C16X12G_ABM_T3_6720MS 0xA0
233 #define C16X12G_ABM_T3_13440MS 0xC0
234 #define C16X12G_ABM_T3_26880MS 0xE0
235 
241 #define C16X12G_ABM_T4_0MS 0x00
242 #define C16X12G_ABM_T4_210MS 0x02
243 #define C16X12G_ABM_T4_420MS 0x04
244 #define C16X12G_ABM_T4_840MS 0x06
245 #define C16X12G_ABM_T4_1680MS 0x08
246 #define C16X12G_ABM_T4_3360MS 0x0A
247 #define C16X12G_ABM_T4_6720MS 0x0C
248 #define C16X12G_ABM_T4_13440MS 0x0E
249 #define C16X12G_ABM_T4_26880MS 0x10
250 #define C16X12G_ABM_T4_53760MS 0x12
251 #define C16X12G_ABM_T4_107520MS 0x14
252 
258 #define C16X12G_ABM_LOOP_BEGIN_T1 0x00
259 #define C16X12G_ABM_LOOP_BEGIN_T2 0x10
260 #define C16X12G_ABM_LOOP_BEGIN_T3 0x20
261 #define C16X12G_ABM_LOOP_BEGIN_T4 0x30
262 
268 #define C16X12G_ABM_LOOP_END_T3 0x00
269 #define C16X12G_ABM_LOOP_END_T1 0x40
270 
276 #define C16X12G_ABM_NUM_1 0x0302
277 #define C16X12G_ABM_NUM_2 0x0306
278 #define C16X12G_ABM_NUM_3 0x030A
279  // End group macro
282 
283 // --------------------------------------------------------------- PUBLIC TYPES
292 typedef struct
293 {
294  // Output pins
295 
296  digital_out_t rst;
297  digital_out_t sdb;
298 
299  // Input pins
300 
301  digital_in_t int_pin;
302 
303  // Modules
304 
305  i2c_master_t i2c;
306 
307  // ctx variable
308 
309  uint8_t slave_address;
310 
311 } c16x12_t;
312 
316 typedef struct
317 {
318  // Communication gpio pins
319 
320  pin_name_t scl;
321  pin_name_t sda;
322 
323  // Additional gpio pins
324 
325  pin_name_t rst;
326  pin_name_t sdb;
327  pin_name_t int_pin;
328 
329  // static variable
330 
331  uint32_t i2c_speed;
332  uint8_t i2c_address;
333 
334 } c16x12_cfg_t;
335 
339 typedef struct
340 {
341  uint8_t time_1;
342  uint8_t time_2;
343  uint8_t time_3;
344  uint8_t time_4;
345  uint8_t loop_begin;
346  uint8_t loop_end;
347  uint16_t loop_times;
348 
349 }c16x12_abm_t;
350  // End types group
352 
353 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
354 
360 #ifdef __cplusplus
361 extern "C"{
362 #endif
363 
373 
383 
392 
403 void c16x12_generic_write ( c16x12_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
404 
415 void c16x12_generic_read ( c16x12_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
416 
424 void c16x12g_write_reg ( c16x12_t *ctx, uint8_t reg, uint8_t c_data );
425 
432 void c16x12g_select_page ( c16x12_t *ctx, uint8_t page );
433 
443 void c16x12g_write_page_byte ( c16x12_t *ctx, uint16_t reg_addr, uint8_t reg_value );
444 
455 void c16x12g_write_page_data ( c16x12_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t n_data );
456 
464 uint8_t c16x12g_read_reg ( c16x12_t *ctx, uint8_t reg );
465 
472 void c16x12g_set_stand_by ( c16x12_t *ctx, uint8_t state );
473 
480 
489 
500 
509 void c16x12g_set_all_leds ( c16x12_t *ctx, uint8_t state );
510 
518 void c16x12g_set_global_current_control ( c16x12_t *ctx, uint8_t gcc );
519 
526 
538 void c16x12g_set_column_state ( c16x12_t *ctx, uint8_t col, uint16_t state, uint8_t c_end );
539 
555 void c16x12g_set_leds_mode ( c16x12_t *ctx, uint8_t mode );
556 
563 void c16x12g_set_pmw ( c16x12_t *ctx, uint8_t pwm_value );
564 
579 void c16x12g_set_led ( c16x12_t *ctx, uint8_t x_pos, uint8_t y_pos, uint8_t state, uint8_t c_end );
580 
588 void c16x12g_display_byte ( c16x12_t *ctx, char ch );
589 
597 void c16x12g_display_image ( c16x12_t *ctx, uint16_t *p_image );
598 
608 void c16x12g_display_text ( c16x12_t *ctx, char *p_text, uint8_t n_char, uint8_t speed );
609 
618 void c16x12g_config_abm ( c16x12_t *ctx, uint16_t n_abm, c16x12_abm_t *config );
619 
628 
629 
630 
631 #ifdef __cplusplus
632 }
633 #endif
634 #endif // _C16X12_H_
635  // End public_function group
638 
639 // ------------------------------------------------------------------------- END
c16x12_t::int_pin
digital_in_t int_pin
Definition: c16x12.h:301
c16x12g_set_leds_mode
void c16x12g_set_leds_mode(c16x12_t *ctx, uint8_t mode)
Functions for sets LEDs mode.
c16x12g_config_abm
void c16x12g_config_abm(c16x12_t *ctx, uint16_t n_abm, c16x12_abm_t *config)
Functions for ABM configuration.
c16x12g_clear_display
void c16x12g_clear_display(c16x12_t *ctx)
Functions for clear display.
c16x12_t::rst
digital_out_t rst
Definition: c16x12.h:296
c16x12_abm_t::time_1
uint8_t time_1
Definition: c16x12.h:341
c16x12_cfg_t::scl
pin_name_t scl
Definition: c16x12.h:320
c16x12_abm_t::loop_end
uint8_t loop_end
Definition: c16x12.h:346
c16x12g_write_page_data
void c16x12g_write_page_data(c16x12_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t n_data)
Functions for write n byte in registers with select page.
c16x12_generic_read
void c16x12_generic_read(c16x12_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
c16x12_abm_t
ABM structure definition.
Definition: c16x12.h:340
c16x12_t::sdb
digital_out_t sdb
Definition: c16x12.h:297
c16x12_abm_t::time_3
uint8_t time_3
Definition: c16x12.h:343
c16x12_abm_t::loop_times
uint16_t loop_times
Definition: c16x12.h:347
c16x12g_read_reg
uint8_t c16x12g_read_reg(c16x12_t *ctx, uint8_t reg)
Functions for read byte from register.
c16x12g_write_page_byte
void c16x12g_write_page_byte(c16x12_t *ctx, uint16_t reg_addr, uint8_t reg_value)
Functions for write one byte in register with select page.
c16x12g_device_configuration
void c16x12g_device_configuration(c16x12_t *ctx)
Functions for device configuration.
c16x12g_display_byte
void c16x12g_display_byte(c16x12_t *ctx, char ch)
Functions for display one Byte.
c16x12g_set_led
void c16x12g_set_led(c16x12_t *ctx, uint8_t x_pos, uint8_t y_pos, uint8_t state, uint8_t c_end)
Functions for sets LEDs state.
c16x12_cfg_t::i2c_address
uint8_t i2c_address
Definition: c16x12.h:332
c16x12g_select_page
void c16x12g_select_page(c16x12_t *ctx, uint8_t page)
Functions for select page.
c16x12_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: c16x12.h:331
c16x12_cfg_t
Click configuration structure definition.
Definition: c16x12.h:317
c16x12g_display_text
void c16x12g_display_text(c16x12_t *ctx, char *p_text, uint8_t n_char, uint8_t speed)
Functions for display text with scroll.
c16x12g_set_pmw
void c16x12g_set_pmw(c16x12_t *ctx, uint8_t pwm_value)
Functions for sets PWM for all LEDs.
c16x12_cfg_setup
void c16x12_cfg_setup(c16x12_cfg_t *cfg)
Config Object Initialization function.
c16x12g_set_global_current_control
void c16x12g_set_global_current_control(c16x12_t *ctx, uint8_t gcc)
Functions for sets global current for all leds.
c16x12g_set_stand_by
void c16x12g_set_stand_by(c16x12_t *ctx, uint8_t state)
Functions for sets SDB pin state.
c16x12_t::i2c
i2c_master_t i2c
Definition: c16x12.h:305
c16x12_generic_write
void c16x12_generic_write(c16x12_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
c16x12g_set_all_leds
void c16x12g_set_all_leds(c16x12_t *ctx, uint8_t state)
Functions for sets all LEDs on the state.
c16x12_cfg_t::sdb
pin_name_t sdb
Definition: c16x12.h:326
c16x12g_device_reset
void c16x12g_device_reset(c16x12_t *ctx)
Functions for device reset.
c16x12_init
C16X12_RETVAL c16x12_init(c16x12_t *ctx, c16x12_cfg_t *cfg)
Initialization function.
c16x12_cfg_t::int_pin
pin_name_t int_pin
Definition: c16x12.h:327
c16x12_t::slave_address
uint8_t slave_address
Definition: c16x12.h:309
c16x12g_display_image
void c16x12g_display_image(c16x12_t *ctx, uint16_t *p_image)
Functions for display Image.
c16x12g_write_reg
void c16x12g_write_reg(c16x12_t *ctx, uint8_t reg, uint8_t c_data)
Functions for write one byte in register.
C16X12_RETVAL
#define C16X12_RETVAL
Definition: c16x12.h:78
c16x12_cfg_t::sda
pin_name_t sda
Definition: c16x12.h:321
c16x12_default_cfg
void c16x12_default_cfg(c16x12_t *ctx)
Click Default Configuration function.
c16x12_abm_t::loop_begin
uint8_t loop_begin
Definition: c16x12.h:345
c16x12_abm_t::time_4
uint8_t time_4
Definition: c16x12.h:344
c16x12_t
Click ctx object definition.
Definition: c16x12.h:293
c16x12g_start_abm
void c16x12g_start_abm(c16x12_t *ctx)
Functions for start new ABM configuration.
c16x12_cfg_t::rst
pin_name_t rst
Definition: c16x12.h:325
c16x12g_get_interrupt
uint8_t c16x12g_get_interrupt(c16x12_t *ctx)
Functions for reads interrupt state.
c16x12g_set_column_state
void c16x12g_set_column_state(c16x12_t *ctx, uint8_t col, uint16_t state, uint8_t c_end)
Functions for sets column state.
c16x12_abm_t::time_2
uint8_t time_2
Definition: c16x12.h:342