iso9141  2.0.0.0
iso9141.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 ISO9141_H
29 #define ISO9141_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
70 #define ISO9141_TX_DRV_BUFFER_SIZE 100
71 #define ISO9141_RX_DRV_BUFFER_SIZE 300
72  // iso9141_set
74 
89 #define ISO9141_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
91  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
92 
93  // iso9141_map // iso9141
95 
100 typedef struct
101 {
102  // Modules
103  uart_t uart;
105  // Buffers
106  uint8_t uart_rx_buffer[ ISO9141_RX_DRV_BUFFER_SIZE ];
107  uint8_t uart_tx_buffer[ ISO9141_TX_DRV_BUFFER_SIZE ];
109 } iso9141_t;
110 
115 typedef struct
116 {
117  // Communication gpio pins
118  pin_name_t rx_pin;
119  pin_name_t tx_pin;
121  // Static variable
122  uint32_t baud_rate;
124  uart_data_bits_t data_bit;
125  uart_parity_t parity_bit;
126  uart_stop_bits_t stop_bit;
128 } iso9141_cfg_t;
129 
134 typedef enum
135 {
137  ISO9141_ERROR = -1
138 
140 
157 
171 err_t iso9141_init ( iso9141_t *ctx, iso9141_cfg_t *cfg );
172 
185 err_t iso9141_generic_write ( iso9141_t *ctx, uint8_t *data_buf, uint16_t len );
186 
199 err_t iso9141_generic_read ( iso9141_t *ctx, uint8_t *data_buf, uint16_t max_len );
200 
201 #ifdef __cplusplus
202 }
203 #endif
204 #endif // ISO9141_H
205  // iso9141
207 
208 // ------------------------------------------------------------------------ END
ISO9141_ERROR
@ ISO9141_ERROR
Definition: iso9141.h:137
iso9141_return_value_t
iso9141_return_value_t
ISO 9141 Click return value data.
Definition: iso9141.h:135
iso9141_cfg_t::uart_blocking
bool uart_blocking
Definition: iso9141.h:123
iso9141_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: iso9141.h:124
iso9141_cfg_t::rx_pin
pin_name_t rx_pin
Definition: iso9141.h:118
ISO9141_OK
@ ISO9141_OK
Definition: iso9141.h:136
iso9141_cfg_t::baud_rate
uint32_t baud_rate
Definition: iso9141.h:122
ISO9141_TX_DRV_BUFFER_SIZE
#define ISO9141_TX_DRV_BUFFER_SIZE
ISO 9141 driver buffer size.
Definition: iso9141.h:70
iso9141_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: iso9141.h:126
iso9141_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: iso9141.h:125
iso9141_t::uart
uart_t uart
Definition: iso9141.h:103
iso9141_cfg_t
ISO 9141 Click configuration object.
Definition: iso9141.h:116
ISO9141_RX_DRV_BUFFER_SIZE
#define ISO9141_RX_DRV_BUFFER_SIZE
Definition: iso9141.h:71
iso9141_t
ISO 9141 Click context object.
Definition: iso9141.h:101
iso9141_cfg_t::tx_pin
pin_name_t tx_pin
Definition: iso9141.h:119
iso9141_cfg_setup
void iso9141_cfg_setup(iso9141_cfg_t *cfg)
ISO 9141 configuration object setup function.
iso9141_generic_read
err_t iso9141_generic_read(iso9141_t *ctx, uint8_t *data_buf, uint16_t max_len)
ISO 9141 data reading function.
iso9141_generic_write
err_t iso9141_generic_write(iso9141_t *ctx, uint8_t *data_buf, uint16_t len)
ISO 9141 data writing function.
iso9141_init
err_t iso9141_init(iso9141_t *ctx, iso9141_cfg_t *cfg)
ISO 9141 initialization function.