c8800retro 2.0.0.0
c8800retro.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 C8800RETRO_H
29#define C8800RETRO_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define C8800RETRO_REG_DIGIT_0 0x01
60#define C8800RETRO_REG_DIGIT_1 0x02
61#define C8800RETRO_REG_DIGIT_2 0x03
62#define C8800RETRO_REG_DIGIT_3 0x04
63#define C8800RETRO_REG_DIGIT_4 0x05
64#define C8800RETRO_REG_DIGIT_5 0x06
65#define C8800RETRO_REG_DIGIT_6 0x07
66#define C8800RETRO_REG_DIGIT_7 0x08
67#define C8800RETRO_REG_DECODE_MODE 0x09
68#define C8800RETRO_REG_GLOBAL_INTENSITY 0x0A
69#define C8800RETRO_REG_SCAN_LIMIT 0x0B
70#define C8800RETRO_REG_SHUTDOWN 0x0C
71#define C8800RETRO_REG_SELF_ADDRESSING 0x2D
72#define C8800RETRO_REG_FEATURE 0x0E
73#define C8800RETRO_REG_DISPLAY_TEST_MODE 0x0F
74#define C8800RETRO_REG_DIG0_DIG1_INTENSITY 0x10
75#define C8800RETRO_REG_DIG2_DIG3_INTENSITY 0x11
76#define C8800RETRO_REG_DIG4_DIG5_INTENSITY 0x12
77#define C8800RETRO_REG_DIG6_DIG7_INTENSITY 0x13
78#define C8800RETRO_REG_DIAG_DIGIT_0 0x14
79#define C8800RETRO_REG_DIAG_DIGIT_1 0x15
80#define C8800RETRO_REG_DIAG_DIGIT_2 0x16
81#define C8800RETRO_REG_DIAG_DIGIT_3 0x17
82#define C8800RETRO_REG_DIAG_DIGIT_4 0x18
83#define C8800RETRO_REG_DIAG_DIGIT_5 0x19
84#define C8800RETRO_REG_DIAG_DIGIT_6 0x1A
85#define C8800RETRO_REG_DIAG_DIGIT_7 0x1B
86#define C8800RETRO_REG_KEYA 0x1C
87#define C8800RETRO_REG_KEYB 0x1D
88 // c8800retro_reg
90
105#define C8800RETRO_SHUTDOWN_RESET 0x00
106#define C8800RETRO_SHUTDOWN 0x80
107#define C8800RETRO_NORMAL_OPERATION_RESET 0x01
108#define C8800RETRO_NORMAL_OPERATION 0x81
109
114#define C8800RETRO_NO_DECODE 0x00
115#define C8800RETRO_DECODE_0 0x01
116#define C8800RETRO_DECODE_0_2 0x07
117#define C8800RETRO_DECODE_0_5 0x3F
118#define C8800RETRO_DECODE_0_2_5 0x25
119
124#define C8800RETRO_FACTORY_SET_ADDRESS 0x00
125#define C8800RETRO_USER_SET_ADDRESS 0x01
126
131#define C8800RETRO_INTENSITY_1 0x00
132#define C8800RETRO_INTENSITY_2 0x01
133#define C8800RETRO_INTENSITY_3 0x02
134#define C8800RETRO_INTENSITY_4 0x03
135#define C8800RETRO_INTENSITY_5 0x04
136#define C8800RETRO_INTENSITY_6 0x05
137#define C8800RETRO_INTENSITY_7 0x06
138#define C8800RETRO_INTENSITY_8 0x07
139#define C8800RETRO_INTENSITY_9 0x08
140#define C8800RETRO_INTENSITY_10 0x09
141#define C8800RETRO_INTENSITY_11 0x0A
142#define C8800RETRO_INTENSITY_12 0x0B
143#define C8800RETRO_INTENSITY_13 0x0C
144#define C8800RETRO_INTENSITY_14 0x0D
145#define C8800RETRO_INTENSITY_15 0x0E
146#define C8800RETRO_INTENSITY_16 0x0F
147
152#define C8800RETRO_SCAN_LIMIT_0 0x00
153#define C8800RETRO_SCAN_LIMIT_0_1 0x01
154#define C8800RETRO_SCAN_LIMIT_0_2 0x02
155#define C8800RETRO_SCAN_LIMIT_0_3 0x03
156#define C8800RETRO_SCAN_LIMIT_0_4 0x04
157#define C8800RETRO_SCAN_LIMIT_0_5 0x05
158#define C8800RETRO_SCAN_LIMIT_0_6 0x06
159#define C8800RETRO_SCAN_LIMIT_0_7 0x07
160
165#define C8800RETRO_KEY_NONE 0x0000
166#define C8800RETRO_KEY_A1 0x8000
167#define C8800RETRO_KEY_A2 0x4000
168#define C8800RETRO_KEY_A3 0x2000
169#define C8800RETRO_KEY_A4 0x1000
170#define C8800RETRO_KEY_B1 0x0800
171#define C8800RETRO_KEY_B2 0x0400
172#define C8800RETRO_KEY_B3 0x0200
173#define C8800RETRO_KEY_B4 0x0100
174#define C8800RETRO_KEY_C1 0x0080
175#define C8800RETRO_KEY_C2 0x0040
176#define C8800RETRO_KEY_C3 0x0020
177#define C8800RETRO_KEY_C4 0x0010
178#define C8800RETRO_KEY_D1 0x0008
179#define C8800RETRO_KEY_D2 0x0004
180#define C8800RETRO_KEY_D3 0x0002
181#define C8800RETRO_KEY_D4 0x0001
182
187#define C8800RETRO_SCROLL_SPEED_SLOW 300
188#define C8800RETRO_SCROLL_SPEED_MEDIUM 150
189#define C8800RETRO_SCROLL_SPEED_FAST 50
190#define C8800RETRO_SCROLL_HORIZONTAL_LEFT 0
191#define C8800RETRO_SCROLL_HORIZONTAL_RIGHT 1
192#define C8800RETRO_SCROLL_VERTICAL_UP 2
193#define C8800RETRO_SCROLL_VERTICAL_DOWN 3
194
200#define C8800RETRO_SET_DEV_ADDR 0x00
201 // c8800retro_set
203
218#define C8800RETRO_MAP_MIKROBUS( cfg, mikrobus ) \
219 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
220 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
221 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
222 // c8800retro_map // c8800retro
225
230typedef struct
231{
232 // Input pins
233 digital_in_t int_pin;
235 // Modules
236 i2c_master_t i2c;
238 // I2C slave address
242
247typedef struct
248{
249 pin_name_t scl;
250 pin_name_t sda;
252 pin_name_t int_pin;
254 uint32_t i2c_speed;
255 uint8_t i2c_address;
258
263typedef enum
264{
267
269
286
302
317
331err_t c8800retro_write_reg ( c8800retro_t *ctx, uint8_t reg, uint8_t data_in );
332
348err_t c8800retro_read_reg ( c8800retro_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
349
362
377err_t c8800retro_display_char ( c8800retro_t *ctx, uint8_t char_index );
378
391err_t c8800retro_display_image ( c8800retro_t *ctx, uint8_t *p_image );
392
410err_t c8800retro_display_string ( c8800retro_t *ctx, uint8_t scroll_mode, uint16_t scroll_speed_ms, uint8_t *text );
411
421
434
448err_t c8800retro_get_keypad ( c8800retro_t *ctx, uint16_t *keypad );
449
450#ifdef __cplusplus
451}
452#endif
453#endif // C8800RETRO_H
454 // c8800retro
456
457// ------------------------------------------------------------------------ END
c8800retro_return_value_t
8800 Retro Click return value data.
Definition: c8800retro.h:264
@ C8800RETRO_OK
Definition: c8800retro.h:265
@ C8800RETRO_ERROR
Definition: c8800retro.h:266
err_t c8800retro_display_image(c8800retro_t *ctx, uint8_t *p_image)
8800 Retro display image function.
err_t c8800retro_clear_display(c8800retro_t *ctx)
8800 Retro clear display function.
err_t c8800retro_read_reg(c8800retro_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
8800 Retro read register function.
err_t c8800retro_write_reg(c8800retro_t *ctx, uint8_t reg, uint8_t data_in)
8800 Retro write register function.
err_t c8800retro_clear_interrupt(c8800retro_t *ctx)
8800 Retro clear interrupt function.
err_t c8800retro_get_keypad(c8800retro_t *ctx, uint16_t *keypad)
8800 Retro get keypad function.
err_t c8800retro_init(c8800retro_t *ctx, c8800retro_cfg_t *cfg)
8800 Retro initialization function.
err_t c8800retro_display_char(c8800retro_t *ctx, uint8_t char_index)
8800 Retro display char function.
uint8_t c8800retro_get_int_pin(c8800retro_t *ctx)
8800 Retro get int pin function.
void c8800retro_cfg_setup(c8800retro_cfg_t *cfg)
8800 Retro configuration object setup function.
err_t c8800retro_display_string(c8800retro_t *ctx, uint8_t scroll_mode, uint16_t scroll_speed_ms, uint8_t *text)
8800 Retro display string function.
err_t c8800retro_default_cfg(c8800retro_t *ctx)
8800 Retro default configuration function.
8800 Retro Click configuration object.
Definition: c8800retro.h:248
uint32_t i2c_speed
Definition: c8800retro.h:254
pin_name_t scl
Definition: c8800retro.h:249
pin_name_t int_pin
Definition: c8800retro.h:252
pin_name_t sda
Definition: c8800retro.h:250
uint8_t i2c_address
Definition: c8800retro.h:255
8800 Retro Click context object.
Definition: c8800retro.h:231
digital_in_t int_pin
Definition: c8800retro.h:233
i2c_master_t i2c
Definition: c8800retro.h:236
uint8_t slave_address
Definition: c8800retro.h:239