mcp2003b  2.1.0.0
mcp2003b.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 MCP2003B_H
29 #define MCP2003B_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 
74 #define MCP2003B_TX_DRV_BUFFER_SIZE 100
75 #define MCP2003B_RX_DRV_BUFFER_SIZE 300
76  // mcp2003b_cmd
78 
93 #define MCP2003B_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
95  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
96  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
97  // mcp2003b_map // mcp2003b
100 
105 typedef struct
106 {
107  // Output pins
108  digital_out_t cs;
110  // Modules
111  uart_t uart;
113  // Buffers
114  uint8_t uart_rx_buffer[ MCP2003B_RX_DRV_BUFFER_SIZE ];
115  uint8_t uart_tx_buffer[ MCP2003B_TX_DRV_BUFFER_SIZE ];
117 } mcp2003b_t;
118 
123 typedef struct
124 {
125  // Communication gpio pins
126  pin_name_t rx_pin;
127  pin_name_t tx_pin;
129  // Additional gpio pins
130  pin_name_t cs;
132  // Static variable
133  uint32_t baud_rate;
135  uart_data_bits_t data_bit;
136  uart_parity_t parity_bit;
137  uart_stop_bits_t stop_bit;
140 
145 typedef enum
146 {
148  MCP2003B_ERROR = -1
149 
151 
168 
183 
196 err_t mcp2003b_generic_write ( mcp2003b_t *ctx, uint8_t *data_in, uint16_t len );
197 
210 err_t mcp2003b_generic_read ( mcp2003b_t *ctx, uint8_t *data_out, uint16_t len );
211 
221 void mcp2003b_set_cs_pin ( mcp2003b_t *ctx, uint8_t state );
222 
223 #ifdef __cplusplus
224 }
225 #endif
226 #endif // MCP2003B_H
227  // mcp2003b
229 
230 // ------------------------------------------------------------------------ END
MCP2003B_OK
@ MCP2003B_OK
Definition: mcp2003b.h:147
mcp2003b_set_cs_pin
void mcp2003b_set_cs_pin(mcp2003b_t *ctx, uint8_t state)
MCP2003B set cs pin function.
mcp2003b_t::uart
uart_t uart
Definition: mcp2003b.h:111
mcp2003b_return_value_t
mcp2003b_return_value_t
MCP2003B Click return value data.
Definition: mcp2003b.h:146
mcp2003b_t
MCP2003B Click context object.
Definition: mcp2003b.h:106
mcp2003b_generic_write
err_t mcp2003b_generic_write(mcp2003b_t *ctx, uint8_t *data_in, uint16_t len)
MCP2003B data writing function.
mcp2003b_cfg_t::rx_pin
pin_name_t rx_pin
Definition: mcp2003b.h:126
mcp2003b_cfg_t::baud_rate
uint32_t baud_rate
Definition: mcp2003b.h:133
mcp2003b_cfg_t
MCP2003B Click configuration object.
Definition: mcp2003b.h:124
mcp2003b_init
err_t mcp2003b_init(mcp2003b_t *ctx, mcp2003b_cfg_t *cfg)
MCP2003B initialization function.
mcp2003b_generic_read
err_t mcp2003b_generic_read(mcp2003b_t *ctx, uint8_t *data_out, uint16_t len)
MCP2003B data reading function.
mcp2003b_cfg_t::cs
pin_name_t cs
Definition: mcp2003b.h:130
mcp2003b_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: mcp2003b.h:136
MCP2003B_ERROR
@ MCP2003B_ERROR
Definition: mcp2003b.h:148
mcp2003b_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: mcp2003b.h:137
mcp2003b_cfg_t::uart_blocking
bool uart_blocking
Definition: mcp2003b.h:134
mcp2003b_cfg_setup
void mcp2003b_cfg_setup(mcp2003b_cfg_t *cfg)
MCP2003B configuration object setup function.
MCP2003B_RX_DRV_BUFFER_SIZE
#define MCP2003B_RX_DRV_BUFFER_SIZE
Definition: mcp2003b.h:75
MCP2003B_TX_DRV_BUFFER_SIZE
#define MCP2003B_TX_DRV_BUFFER_SIZE
MCP2003B driver buffer size.
Definition: mcp2003b.h:74
mcp2003b_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: mcp2003b.h:135
mcp2003b_t::cs
digital_out_t cs
Definition: mcp2003b.h:108
mcp2003b_cfg_t::tx_pin
pin_name_t tx_pin
Definition: mcp2003b.h:127