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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define RS232SPI_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.sdn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
59  cfg.irq = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define RS232SPI_RETVAL uint8_t
67 
68 #define RS232SPI_OK 0x00
69 #define RS232SPI_INIT_ERROR 0xFF
70 
76 #define RS232SPI_CMD_WRITE_CONF 0xC000
77 #define RS232SPI_CMD_READ_CONF 0x4000
78 #define RS232SPI_CMD_WRITE_DATA 0x8000
79 #define RS232SPI_CMD_READ_DATA 0x0000
80 
86 #define RS232SPI_CONF_R 0x8000
87 #define RS232SPI_CONF_T 0x4000
88 #define RS232SPI_CONF_RM 0x0400
89 
90 #define RS232SPI_CONF_FEN 0x2000
91 #define RS232SPI_CONF_SHDN 0x1000
92 #define RS232SPI_CONF_TM 0x0800
93 #define RS232SPI_CONF_PM 0x0200
94 #define RS232SPI_CONF_RAM 0x0100
95 #define RS232SPI_CONF_IR 0x0080
96 #define RS232SPI_CONF_ST 0x0040
97 #define RS232SPI_CONF_PE 0x0020
98 #define RS232SPI_CONF_L 0x0010
99 #define RS232SPI_BAUD 0x000F
100 
101 #define RS232SPI_CONF_TE 0x400
102 #define RS232SPI_CONF_RA_FE 0x400
103 #define RS232SPI_CONF_RTS 0x0200
104 #define RS232SPI_CONF_CTS 0x0200
105 #define RS232SPI_CONF_PT 0x0100
106 #define RS232SPI_CONF_DATA 0x00FF
107 
113 #define RS232SPI_CONF_BAUD_X1_115200 0x0000
114 #define RS232SPI_CONF_BAUD_X1_57600 0x0001
115 #define RS232SPI_CONF_BAUD_X1_38400 0x0008
116 #define RS232SPI_CONF_BAUD_X1_19200 0x0009
117 #define RS232SPI_CONF_BAUD_X1_9600 0x000A
118 #define RS232SPI_CONF_BAUD_X1_4800 0x000B
119 #define RS232SPI_CONF_BAUD_X1_2400 0x000C
120 #define RS232SPI_CONF_BAUD_X1_1200 0x000D
121 #define RS232SPI_CONF_BAUD_X1_600 0x000E
122 #define RS232SPI_CONF_BAUD_X1_300 0x000F
123 
129 #define RS232SPI_CONF_BAUD_X2_230400 0x0000
130 #define RS232SPI_CONF_BAUD_X2_115200 0x0001
131 #define RS232SPI_CONF_BAUD_X2_57600 0x0002
132 #define RS232SPI_CONF_BAUD_X2_38400 0x0009
133 #define RS232SPI_CONF_BAUD_X2_19200 0x000A
134 #define RS232SPI_CONF_BAUD_X2_9600 0x000B
135 #define RS232SPI_CONF_BAUD_X2_4800 0x000C
136 #define RS232SPI_CONF_BAUD_X2_2400 0x000D
137 #define RS232SPI_CONF_BAUD_X2_1200 0x000E
138 #define RS232SPI_CONF_BAUD_X2_600 0x000F
139  // End group macro
142 // --------------------------------------------------------------- PUBLIC TYPES
151 typedef struct
152 {
153  // Output pins
154 
155  digital_out_t sdn;
156  digital_out_t cs;
157 
158  // Input pins
159 
160  digital_in_t irq;
161 
162  // Modules
163 
164  spi_master_t spi;
165  pin_name_t chip_select;
166 
167 } rs232spi_t;
168 
172 typedef struct
173 {
174  // Communication gpio pins
175 
176  pin_name_t miso;
177  pin_name_t mosi;
178  pin_name_t sck;
179  pin_name_t cs;
180 
181  // Additional gpio pins
182 
183  pin_name_t sdn;
184  pin_name_t irq;
185 
186  // static variable
187 
188  uint32_t spi_speed;
189  spi_master_mode_t spi_mode;
190  spi_master_chip_select_polarity_t cs_polarity;
191 
193  // End types group
195 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
196 
201 #ifdef __cplusplus
202 extern "C"{
203 #endif
204 
214 
223 
232 void rs232spi_default_cfg ( rs232spi_t *ctx, uint32_t speed );
233 
242 void rs232spi_reg_write ( rs232spi_t *ctx, uint16_t write_data );
243 
252 uint16_t rs232spi_reg_read ( rs232spi_t *ctx, uint16_t write_data );
253 
262 uint16_t rs232spi_transfer ( rs232spi_t *ctx, uint16_t write_data );
263 
271 uint16_t rs232spi_read_cfg ( rs232spi_t *ctx );
272 
281 
289 uint16_t rs232spi_data_ready ( rs232spi_t *ctx );
290 
298 uint16_t rs232spi_check_busy ( rs232spi_t *ctx );
299 
307 void rs232spi_data_write ( rs232spi_t *ctx, uint8_t write_data );
308 
317 void rs232spi_digital_write_rst ( rs232spi_t *ctx, uint8_t signal );
318 
327 
328 #ifdef __cplusplus
329 }
330 #endif
331 #endif // _RS232SPI_H_
332  // End public_function group
335 
336 // ------------------------------------------------------------------------- END
RS232SPI_RETVAL
#define RS232SPI_RETVAL
Definition: rs232spi.h:66
rs232spi_t::sdn
digital_out_t sdn
Definition: rs232spi.h:155
rs232spi_cfg_t::miso
pin_name_t miso
Definition: rs232spi.h:176
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:164
rs232spi_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rs232spi.h:190
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:152
rs232spi_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rs232spi.h:189
rs232spi_t::cs
digital_out_t cs
Definition: rs232spi.h:156
rs232spi_cfg_t::spi_speed
uint32_t spi_speed
Definition: rs232spi.h:188
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:184
rs232spi_reg_read
uint16_t rs232spi_reg_read(rs232spi_t *ctx, uint16_t write_data)
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:183
rs232spi_t::irq
digital_in_t irq
Definition: rs232spi.h:160
rs232spi_t::chip_select
pin_name_t chip_select
Definition: rs232spi.h:165
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:173
rs232spi_cfg_t::cs
pin_name_t cs
Definition: rs232spi.h:179
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:177
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:178