dmx  2.0.0.0
dmx.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 DMX_H
36 #define DMX_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define DMX_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
66  cfg.abr = MIKROBUS( mikrobus, MIKROBUS_CS ); \
67  cfg.run = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
68  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
69 
75 #define DMX_OK 0
76 #define DMX_ERROR -1
77 #define DMX_ERROR_TIMEOUT -2
78 
84 #define DMX_RSP_OK "OK"
85 #define DMX_RSP_ERROR "ERR"
86 
92 #define DMX_CMD_SADR "@SADR,001\0"
93 #define DMX_CMD_BLEN "@BLEN,006\0"
94 #define DMX_CMD_ITMR "@ITMR,001\0"
95 #define DMX_CMD_FTMR "@FTMR,001\0"
96 #define DMX_CMD_FLEN_MASTER "@FLEN,010\0"
97 #define DMX_CMD_FLEN_SLAVE "@FLEN,006\0"
98 #define DMX_CMD_SCOD "@SCOD,000\0"
99 #define DMX_CMD_PURGEBFR "!PURGEBFR\0"
100 #define DMX_CMD_STORECFG "!STORECFG\0"
101 #define DMX_CMD_CLEARCFG "!CLEARCFG\0"
102 #define DMX_CMD_DISPLCFG "!DISPLCFG\0"
103 
109 #define DMX_SLAVE 0
110 #define DMX_MASTER 1
111 #define DMX_CONFIG_MODE 0
112 #define DMX_RUN_MODE 1
113 #define DMX_INT_INACTIVE 0
114 #define DMX_INT_ACTIVE 1
115 
121 #define DMX_DRV_RX_BUFFER_SIZE 300
122 #define DMX_DRV_TX_BUFFER_SIZE 100
123  // End group macro
126 // --------------------------------------------------------------- PUBLIC TYPES
134 typedef struct
135 {
136  // Output pins
137  digital_out_t rst;
138  digital_out_t abr;
139  digital_out_t run;
140 
141  // Input pins
142  digital_in_t int_pin;
143 
144  // Modules
145  uart_t uart;
146 
147  uint8_t uart_rx_buffer[ DMX_DRV_RX_BUFFER_SIZE ];
148  uint8_t uart_tx_buffer[ DMX_DRV_TX_BUFFER_SIZE ];
149 
150 } dmx_t;
151 
155 typedef struct
156 {
157  // Communication gpio pins
158  pin_name_t rx_pin;
159  pin_name_t tx_pin;
160 
161  // Additional gpio pins
162  pin_name_t rst;
163  pin_name_t abr;
164  pin_name_t run;
165  pin_name_t int_pin;
166 
167  // static variable
168  uint32_t baud_rate; // Clock speed.
170  uart_data_bits_t data_bit; // Data bits.
171  uart_parity_t parity_bit; // Parity bit.
172  uart_stop_bits_t stop_bit; // Stop bits.
173 
174 } dmx_cfg_t;
175  // End types group
177 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
178 
184 #ifdef __cplusplus
185 extern "C"{
186 #endif
187 
196 void dmx_cfg_setup ( dmx_cfg_t *cfg );
197 
206 err_t dmx_init ( dmx_t *ctx, dmx_cfg_t *cfg );
207 
212 void dmx_reset ( dmx_t *ctx, uint8_t dev_mode );
213 
220 void dmx_generic_write ( dmx_t *ctx, uint8_t *data_buf, uint16_t len );
221 
229 err_t dmx_generic_read ( dmx_t *ctx, uint8_t *data_buf, uint16_t max_len );
230 
236 void dmx_send_cmd ( dmx_t* ctx, uint8_t *cmd );
237 
246 void dmx_run ( dmx_t *ctx, uint8_t run_mode );
247 
255 uint8_t dmx_check_int ( dmx_t *ctx );
256 
264 void dmx_set_reset ( dmx_t *ctx, uint8_t state );
265 
274 void dmx_set_auto_baud_rate ( dmx_t *ctx, uint8_t state );
275 
276 #ifdef __cplusplus
277 }
278 #endif
279 #endif // _DMX_H_
280  // End public_function group
283 
284 // ------------------------------------------------------------------------- END
dmx_cfg_setup
void dmx_cfg_setup(dmx_cfg_t *cfg)
Config Object Initialization function.
dmx_check_int
uint8_t dmx_check_int(dmx_t *ctx)
Interrupt Check function.
dmx_cfg_t::uart_blocking
bool uart_blocking
Definition: dmx.h:169
dmx_cfg_t::tx_pin
pin_name_t tx_pin
Definition: dmx.h:159
dmx_t::run
digital_out_t run
Definition: dmx.h:139
dmx_t::int_pin
digital_in_t int_pin
Definition: dmx.h:142
dmx_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: dmx.h:172
dmx_t::rst
digital_out_t rst
Definition: dmx.h:137
dmx_t::uart
uart_t uart
Definition: dmx.h:145
dmx_cfg_t::abr
pin_name_t abr
Definition: dmx.h:163
dmx_send_cmd
void dmx_send_cmd(dmx_t *ctx, uint8_t *cmd)
Send command function.
dmx_cfg_t::baud_rate
uint32_t baud_rate
Definition: dmx.h:168
dmx_set_auto_baud_rate
void dmx_set_auto_baud_rate(dmx_t *ctx, uint8_t state)
Auto Baud Rate Setting function.
dmx_init
err_t dmx_init(dmx_t *ctx, dmx_cfg_t *cfg)
Initialization function.
dmx_t
Click ctx object definition.
Definition: dmx.h:135
dmx_cfg_t::rst
pin_name_t rst
Definition: dmx.h:162
DMX_DRV_TX_BUFFER_SIZE
#define DMX_DRV_TX_BUFFER_SIZE
Definition: dmx.h:122
dmx_generic_read
err_t dmx_generic_read(dmx_t *ctx, uint8_t *data_buf, uint16_t max_len)
Generic read function.
DMX_DRV_RX_BUFFER_SIZE
#define DMX_DRV_RX_BUFFER_SIZE
Definition: dmx.h:121
dmx_t::abr
digital_out_t abr
Definition: dmx.h:138
dmx_reset
void dmx_reset(dmx_t *ctx, uint8_t dev_mode)
Reset function.
dmx_cfg_t::int_pin
pin_name_t int_pin
Definition: dmx.h:165
dmx_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: dmx.h:170
dmx_cfg_t::rx_pin
pin_name_t rx_pin
Definition: dmx.h:158
dmx_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: dmx.h:171
dmx_run
void dmx_run(dmx_t *ctx, uint8_t run_mode)
Mode Setting function.
dmx_generic_write
void dmx_generic_write(dmx_t *ctx, uint8_t *data_buf, uint16_t len)
Generic write function.
dmx_set_reset
void dmx_set_reset(dmx_t *ctx, uint8_t state)
Reset Setting function.
dmx_cfg_t::run
pin_name_t run
Definition: dmx.h:164
dmx_cfg_t
Click configuration structure definition.
Definition: dmx.h:156