rs232spi  2.0.0.0
rs232spi.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 RS232SPI_H
36 #define RS232SPI_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_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define RS232SPI_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.sdn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.irq = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define RS232SPI_RETVAL uint8_t
77 
78 #define RS232SPI_OK 0x00
79 #define RS232SPI_INIT_ERROR 0xFF
80 
86 #define RS232SPI_CMD_WRITE_CONF 0xC000
87 #define RS232SPI_CMD_READ_CONF 0x4000
88 #define RS232SPI_CMD_WRITE_DATA 0x8000
89 #define RS232SPI_CMD_READ_DATA 0x0000
90 
96 #define RS232SPI_CONF_R 0x8000
97 #define RS232SPI_CONF_T 0x4000
98 #define RS232SPI_CONF_RM 0x0400
99 
100 #define RS232SPI_CONF_FEN 0x2000
101 #define RS232SPI_CONF_SHDN 0x1000
102 #define RS232SPI_CONF_TM 0x0800
103 #define RS232SPI_CONF_PM 0x0200
104 #define RS232SPI_CONF_RAM 0x0100
105 #define RS232SPI_CONF_IR 0x0080
106 #define RS232SPI_CONF_ST 0x0040
107 #define RS232SPI_CONF_PE 0x0020
108 #define RS232SPI_CONF_L 0x0010
109 #define RS232SPI_BAUD 0x000F
110 
111 #define RS232SPI_CONF_TE 0x400
112 #define RS232SPI_CONF_RA_FE 0x400
113 #define RS232SPI_CONF_RTS 0x0200
114 #define RS232SPI_CONF_CTS 0x0200
115 #define RS232SPI_CONF_PT 0x0100
116 #define RS232SPI_CONF_DATA 0x00FF
117 
123 #define RS232SPI_CONF_BAUD_X1_115200 0x0000
124 #define RS232SPI_CONF_BAUD_X1_57600 0x0001
125 #define RS232SPI_CONF_BAUD_X1_38400 0x0008
126 #define RS232SPI_CONF_BAUD_X1_19200 0x0009
127 #define RS232SPI_CONF_BAUD_X1_9600 0x000A
128 #define RS232SPI_CONF_BAUD_X1_4800 0x000B
129 #define RS232SPI_CONF_BAUD_X1_2400 0x000C
130 #define RS232SPI_CONF_BAUD_X1_1200 0x000D
131 #define RS232SPI_CONF_BAUD_X1_600 0x000E
132 #define RS232SPI_CONF_BAUD_X1_300 0x000F
133 
139 #define RS232SPI_CONF_BAUD_X2_230400 0x0000
140 #define RS232SPI_CONF_BAUD_X2_115200 0x0001
141 #define RS232SPI_CONF_BAUD_X2_57600 0x0002
142 #define RS232SPI_CONF_BAUD_X2_38400 0x0009
143 #define RS232SPI_CONF_BAUD_X2_19200 0x000A
144 #define RS232SPI_CONF_BAUD_X2_9600 0x000B
145 #define RS232SPI_CONF_BAUD_X2_4800 0x000C
146 #define RS232SPI_CONF_BAUD_X2_2400 0x000D
147 #define RS232SPI_CONF_BAUD_X2_1200 0x000E
148 #define RS232SPI_CONF_BAUD_X2_600 0x000F
149  // End group macro
152 // --------------------------------------------------------------- PUBLIC TYPES
161 typedef struct
162 {
163  // Output pins
164 
165  digital_out_t sdn;
166  digital_out_t cs;
167 
168  // Input pins
169 
170  digital_in_t irq;
171 
172  // Modules
173 
174  spi_master_t spi;
175  pin_name_t chip_select;
176 
177 } rs232spi_t;
178 
182 typedef struct
183 {
184  // Communication gpio pins
185 
186  pin_name_t miso;
187  pin_name_t mosi;
188  pin_name_t sck;
189  pin_name_t cs;
190 
191  // Additional gpio pins
192 
193  pin_name_t sdn;
194  pin_name_t irq;
195 
196  // static variable
197 
198  uint32_t spi_speed;
199  spi_master_mode_t spi_mode;
200  spi_master_chip_select_polarity_t cs_polarity;
201 
203  // End types group
205 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
206 
211 #ifdef __cplusplus
212 extern "C"{
213 #endif
214 
224 
233 
242 void rs232spi_default_cfg ( rs232spi_t *ctx, uint32_t speed );
243 
252 void rs232spi_reg_write ( rs232spi_t *ctx, uint16_t write_data );
253 
261 uint8_t rs232spi_reg_read ( rs232spi_t *ctx );
262 
271 uint16_t rs232spi_transfer ( rs232spi_t *ctx, uint16_t write_data );
272 
280 uint16_t rs232spi_read_cfg ( rs232spi_t *ctx );
281 
290 
298 uint16_t rs232spi_data_ready ( rs232spi_t *ctx );
299 
307 uint16_t rs232spi_check_busy ( rs232spi_t *ctx );
308 
316 void rs232spi_data_write ( rs232spi_t *ctx, uint8_t write_data );
317 
326 void rs232spi_digital_write_rst ( rs232spi_t *ctx, uint8_t signal );
327 
336 
337 #ifdef __cplusplus
338 }
339 #endif
340 #endif // _RS232SPI_H_
341  // End public_function group
344 
345 // ------------------------------------------------------------------------- END
RS232SPI_RETVAL
#define RS232SPI_RETVAL
Definition: rs232spi.h:76
rs232spi_t::sdn
digital_out_t sdn
Definition: rs232spi.h:165
rs232spi_cfg_t::miso
pin_name_t miso
Definition: rs232spi.h:186
rs232spi_cfg_setup
void rs232spi_cfg_setup(rs232spi_cfg_t *cfg)
Config Object Initialization function.
rs232spi_t::spi
spi_master_t spi
Definition: rs232spi.h:174
rs232spi_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rs232spi.h:200
rs232spi_read_cfg
uint16_t rs232spi_read_cfg(rs232spi_t *ctx)
Read configuration function.
rs232spi_transfer
uint16_t rs232spi_transfer(rs232spi_t *ctx, uint16_t write_data)
SPI transfer function.
rs232spi_t
Click ctx object definition.
Definition: rs232spi.h:162
rs232spi_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rs232spi.h:199
rs232spi_t::cs
digital_out_t cs
Definition: rs232spi.h:166
rs232spi_cfg_t::spi_speed
uint32_t spi_speed
Definition: rs232spi.h:198
rs232spi_digital_write_rst
void rs232spi_digital_write_rst(rs232spi_t *ctx, uint8_t signal)
Digital write reset function.
rs232spi_cfg_t::irq
pin_name_t irq
Definition: rs232spi.h:194
rs232spi_reg_read
uint8_t rs232spi_reg_read(rs232spi_t *ctx)
Register read function.
rs232spi_reg_write
void rs232spi_reg_write(rs232spi_t *ctx, uint16_t write_data)
Register write function.
rs232spi_flush
void rs232spi_flush(rs232spi_t *ctx)
Flush function.
rs232spi_check_busy
uint16_t rs232spi_check_busy(rs232spi_t *ctx)
Check if busy function.
rs232spi_cfg_t::sdn
pin_name_t sdn
Definition: rs232spi.h:193
rs232spi_t::irq
digital_in_t irq
Definition: rs232spi.h:170
rs232spi_t::chip_select
pin_name_t chip_select
Definition: rs232spi.h:175
rs232spi_digital_read_int
uint8_t rs232spi_digital_read_int(rs232spi_t *ctx)
Digital read interrupt function.
rs232spi_data_ready
uint16_t rs232spi_data_ready(rs232spi_t *ctx)
Data ready function.
rs232spi_init
RS232SPI_RETVAL rs232spi_init(rs232spi_t *ctx, rs232spi_cfg_t *cfg)
Initialization function.
rs232spi_cfg_t
Click configuration structure definition.
Definition: rs232spi.h:183
rs232spi_cfg_t::cs
pin_name_t cs
Definition: rs232spi.h:189
rs232spi_data_write
void rs232spi_data_write(rs232spi_t *ctx, uint8_t write_data)
Data write function.
rs232spi_cfg_t::mosi
pin_name_t mosi
Definition: rs232spi.h:187
rs232spi_default_cfg
void rs232spi_default_cfg(rs232spi_t *ctx, uint32_t speed)
Click Default Configuration function.
rs232spi_cfg_t::sck
pin_name_t sck
Definition: rs232spi.h:188