cxpi  2.0.0.0
cxpi.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2021 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 CXPI_H
29 #define CXPI_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define CXPI_PIN_STATE_DISABLE 0x00
74 #define CXPI_PIN_STATE_ENABLE 0x01
75 
81 #define DRV_BUFFER_SIZE 200
82  // cxpi_cmd
84 
99 #define CXPI_MAP_MIKROBUS( cfg, mikrobus ) \
100  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
101  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
102  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
103  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
104  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
105  // cxpi_map // cxpi
108 
113 typedef struct
114 {
115  // Output pins
116  digital_out_t en;
117  digital_out_t pwm;
119  // Input pins
120  digital_in_t int_pin;
122  // Modules
123  uart_t uart;
125  // Buffers
126  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
127  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
129 } cxpi_t;
130 
135 typedef struct
136 {
137  // Communication gpio pins
138  pin_name_t rx_pin;
139  pin_name_t tx_pin;
141  // Additional gpio pins
142  pin_name_t en;
143  pin_name_t pwm;
144  pin_name_t int_pin;
146  // Static variable
147  uint32_t baud_rate;
149  uart_data_bits_t data_bit;
150  uart_parity_t parity_bit;
151  uart_stop_bits_t stop_bit;
153 } cxpi_cfg_t;
154 
159 typedef enum
160 {
161  CXPI_OK = 0,
162  CXPI_ERROR = -1
163 
165 
182 
196 err_t cxpi_init ( cxpi_t *ctx, cxpi_cfg_t *cfg );
197 
211 err_t cxpi_default_cfg ( cxpi_t *ctx );
212 
225 err_t cxpi_generic_write ( cxpi_t *ctx, char *data_buf, uint16_t len );
226 
239 err_t cxpi_generic_read ( cxpi_t *ctx, char *data_buf, uint16_t max_len );
240 
249 void cxpi_write_byte ( cxpi_t *ctx, uint8_t input );
250 
258 uint8_t cxpi_read_byte ( cxpi_t *ctx );
259 
267 uint8_t cxpi_byte_ready ( cxpi_t *ctx );
268 
277 void cxpi_send_command ( cxpi_t *ctx, char *command );
278 
288 void cxpi_set_nslp_pin_state ( cxpi_t *ctx, uint8_t pin_state );
289 
300 void cxpi_set_pwm_pin_state ( cxpi_t *ctx, uint8_t pin_state );
301 
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 #endif // CXPI_H
317  // cxpi
319 
320 // ------------------------------------------------------------------------ END
cxpi_generic_write
err_t cxpi_generic_write(cxpi_t *ctx, char *data_buf, uint16_t len)
CXPI data writing function.
CXPI_OK
@ CXPI_OK
Definition: cxpi.h:161
cxpi_set_nslp_pin_state
void cxpi_set_nslp_pin_state(cxpi_t *ctx, uint8_t pin_state)
Set NSLP pin state function.
cxpi_t::uart
uart_t uart
Definition: cxpi.h:123
cxpi_byte_ready
uint8_t cxpi_byte_ready(cxpi_t *ctx)
Check for new byte received.
cxpi_set_through_mode
void cxpi_set_through_mode(cxpi_t *ctx)
Set through mode function.
cxpi_cfg_setup
void cxpi_cfg_setup(cxpi_cfg_t *cfg)
CXPI configuration object setup function.
cxpi_cfg_t::rx_pin
pin_name_t rx_pin
Definition: cxpi.h:138
cxpi_cfg_t::uart_blocking
bool uart_blocking
Definition: cxpi.h:148
cxpi_generic_read
err_t cxpi_generic_read(cxpi_t *ctx, char *data_buf, uint16_t max_len)
CXPI data reading function.
cxpi_set_pwm_pin_state
void cxpi_set_pwm_pin_state(cxpi_t *ctx, uint8_t pin_state)
Set PWM pin state function.
cxpi_cfg_t::pwm
pin_name_t pwm
Definition: cxpi.h:143
cxpi_t::en
digital_out_t en
Definition: cxpi.h:116
cxpi_cfg_t::int_pin
pin_name_t int_pin
Definition: cxpi.h:144
cxpi_read_byte
uint8_t cxpi_read_byte(cxpi_t *ctx)
Read Single Byte.
cxpi_t::int_pin
digital_in_t int_pin
Definition: cxpi.h:120
cxpi_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: cxpi.h:151
cxpi_send_command
void cxpi_send_command(cxpi_t *ctx, char *command)
Send command.
cxpi_cfg_t::en
pin_name_t en
Definition: cxpi.h:142
cxpi_write_byte
void cxpi_write_byte(cxpi_t *ctx, uint8_t input)
Write Single Byte.
cxpi_default_cfg
err_t cxpi_default_cfg(cxpi_t *ctx)
CXPI default configuration function.
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
CXPI driver buffer size.
Definition: cxpi.h:81
cxpi_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: cxpi.h:149
cxpi_t::pwm
digital_out_t pwm
Definition: cxpi.h:117
cxpi_init
err_t cxpi_init(cxpi_t *ctx, cxpi_cfg_t *cfg)
CXPI initialization function.
cxpi_return_value_t
cxpi_return_value_t
CXPI Click return value data.
Definition: cxpi.h:160
cxpi_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: cxpi.h:150
cxpi_cfg_t::baud_rate
uint32_t baud_rate
Definition: cxpi.h:147
cxpi_cfg_t
CXPI Click configuration object.
Definition: cxpi.h:136
CXPI_ERROR
@ CXPI_ERROR
Definition: cxpi.h:162
cxpi_t
CXPI Click context object.
Definition: cxpi.h:114
cxpi_cfg_t::tx_pin
pin_name_t tx_pin
Definition: cxpi.h:139