ata6570  2.0.0.0
ata6570.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  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef ATA6570_H
35 #define ATA6570_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 #include "drv_spi_master.h"
40 #include "drv_uart.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define ATA6570_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.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
59  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
60 
67 #define ATA6570_RETVAL uint8_t
68 
69 #define ATA6570_OK 0x00
70 #define ATA6570_INIT_ERROR 0xFF
71 
77 #define DRV_RX_BUFFER_SIZE 500
78 
84 #define ATA6570_DMCR 0x01
85 #define ATA6570_DMSR 0x03
86 #define ATA6570_SECR 0x04
87 #define ATA6570_GPM0 0x06
88 #define ATA6570_GPM1 0x07
89 #define ATA6570_GPM2 0x08
90 #define ATA6570_GPM3 0x09
91 #define ATA6570_RWPR 0x0A
92 
98 #define ATA6570_TRXCR 0x20
99 #define ATA6570_TRXSR 0x22
100 #define ATA6570_TRXECR 0x23
101 #define ATA6570_DRCR 0x26
102 #define ATA6570_CIDR0 0x27
103 #define ATA6570_CIDR1 0x28
104 #define ATA6570_CIDR2 0x29
105 #define ATA6570_CIDR3 0x2A
106 #define ATA6570_CIDMR0 0x2B
107 #define ATA6570_CIDMR1 0x2C
108 #define ATA6570_CIDMR2 0x2D
109 #define ATA6570_CIDMR3 0x2E
110 #define ATA6570_CFCR 0x2F
111 #define ATA6570_BFECR 0x32
112 #define ATA6570_BFIR 0x33
113 #define ATA6570_TRXECR2 0x34
114 #define ATA6570_TRXESR2 0x35
115 #define ATA6570_WDCR1 0x36
116 #define ATA6570_WDCR2 0x37
117 #define ATA6570_WDSR 0x38
118 #define ATA6570_WDTRIG 0x39
119 #define ATA6570_EFCR 0x3A
120 #define ATA6570_FECR 0x3B
121 #define ATA6570_GLFT 0x67
122 #define ATA6570_CDMR0 0x68
123 #define ATA6570_CDMR1 0x69
124 #define ATA6570_CDMR2 0x6A
125 #define ATA6570_CDMR3 0x6B
126 #define ATA6570_CDMR4 0x6C
127 #define ATA6570_CDMR5 0x6D
128 #define ATA6570_CDMR6 0x6E
129 #define ATA6570_CDMR7 0x6F
130 #define ATA6570_PWKS 0x4B
131 #define ATA6570_WKECR 0x4C
132 #define ATA6570_GESR 0x60
133 #define ATA6570_SESR 0x61
134 #define ATA6570_WKESR 0x64
135 
141 #define ATA6570_DIDR 0x7E
142 
148 #define ATA6570_FUDI 0x70
149 #define ATA6570_FUDO 0x71
150 #define ATA6570_FUSEL 0x72
151 #define ATA6570_BGCAL 0x73
152 #define ATA6570_FRCCAL 0x74
153 #define ATA6570_HRCCALL 0x75
154 #define ATA6570_HRCCALH 0x76
155 
161 #define ATA6570_OPMODE_SLEEP 0x01
162 #define ATA6570_OPMODE_STBY 0x04
163 #define ATA6570_OPMODE_NORMAL 0x07
164  // End group macro
167 // --------------------------------------------------------------- PUBLIC TYPES
168 
172 typedef struct
173 {
174  // Output pins
175 
176  digital_out_t cs;
177 
178  // Modules
179 
180  spi_master_t spi;
181  pin_name_t chip_select;
182  uart_t uart;
183 
184  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
185  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
186 
187 } ata6570_t;
188 
192 typedef struct
193 {
194  // Communication gpio pins
195 
196  pin_name_t miso;
197  pin_name_t mosi;
198  pin_name_t sck;
199  pin_name_t cs;
200 
201  pin_name_t rx_pin;
202  pin_name_t tx_pin;
203 
204  // static variables
205 
206  // spi
207 
208  uint32_t spi_speed;
209  spi_master_mode_t spi_mode;
210  spi_master_chip_select_polarity_t cs_polarity;
211 
212  // uart
213 
214  uint32_t baud_rate; // Clock speed.
216  uart_data_bits_t data_bit; // Data bits.
217  uart_parity_t parity_bit; // Parity bit.
218  uart_stop_bits_t stop_bit; // Stop bits.
219 
220 } ata6570_cfg_t;
221  // End types group
223 
224 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
225 
230 #ifdef __cplusplus
231 extern "C"{
232 #endif
233 
242 void ata6570_cfg_setup ( ata6570_cfg_t *cfg );
243 
253 
265 void ata6570_generic_transfer ( ata6570_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
266 
273 void ata6570_generic_write ( ata6570_t *ctx, char *data_buf, uint16_t len );
274 
282 int32_t ata6570_generic_read ( ata6570_t *ctx, char *data_buf, uint16_t max_len );
283 
296 void ata6570_write_reg ( ata6570_t *ctx, const uint8_t address, uint8_t input );
297 
309 uint8_t ata6570_read_reg ( ata6570_t *ctx, const uint8_t address );
310 
311 #ifdef __cplusplus
312 }
313 #endif
314 #endif // _ATA6570_H_
315  // End public_function group
318 
319 // ------------------------------------------------------------------------- END
ATA6570_RETVAL
#define ATA6570_RETVAL
Definition: ata6570.h:67
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ata6570.h:77
ata6570_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ata6570.h:216
ata6570_cfg_t::spi_speed
uint32_t spi_speed
Definition: ata6570.h:208
ata6570_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ata6570.h:210
ata6570_cfg_t::cs
pin_name_t cs
Definition: ata6570.h:199
ata6570_generic_transfer
void ata6570_generic_transfer(ata6570_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
ata6570_t::spi
spi_master_t spi
Definition: ata6570.h:180
ata6570_generic_read
int32_t ata6570_generic_read(ata6570_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
ata6570_t::cs
digital_out_t cs
Definition: ata6570.h:176
ata6570_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ata6570.h:202
ata6570_generic_write
void ata6570_generic_write(ata6570_t *ctx, char *data_buf, uint16_t len)
Generic write function.
ata6570_cfg_t::miso
pin_name_t miso
Definition: ata6570.h:196
ata6570_t::chip_select
pin_name_t chip_select
Definition: ata6570.h:181
ata6570_cfg_t::uart_blocking
bool uart_blocking
Definition: ata6570.h:215
ata6570_cfg_t
Click configuration structure definition.
Definition: ata6570.h:192
ata6570_cfg_t::baud_rate
uint32_t baud_rate
Definition: ata6570.h:214
ata6570_init
ATA6570_RETVAL ata6570_init(ata6570_t *ctx, ata6570_cfg_t *cfg)
Initialization function.
ata6570_cfg_t::mosi
pin_name_t mosi
Definition: ata6570.h:197
ata6570_read_reg
uint8_t ata6570_read_reg(ata6570_t *ctx, const uint8_t address)
Read Register.
ata6570_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ata6570.h:201
ata6570_write_reg
void ata6570_write_reg(ata6570_t *ctx, const uint8_t address, uint8_t input)
Write Register.
ata6570_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ata6570.h:218
ata6570_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ata6570.h:217
ata6570_t::uart
uart_t uart
Definition: ata6570.h:182
ata6570_cfg_setup
void ata6570_cfg_setup(ata6570_cfg_t *cfg)
Config Object Initialization function.
ata6570_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: ata6570.h:209
ata6570_t
Click ctx object definition.
Definition: ata6570.h:172
ata6570_cfg_t::sck
pin_name_t sck
Definition: ata6570.h:198