cdc  2.1.0.0
cdc.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 CDC_H
29 #define CDC_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 #include "drv_spi_master.h"
39 #include "spi_specifics.h"
40 
61 #define CDC_OPCODE_WR_MEM 0xA0
62 #define CDC_OPCODE_RD_MEM 0x20
63 #define CDC_OPCODE_RD_RES 0x40
64 #define CDC_OPCODE_POR 0x88
65 #define CDC_OPCODE_INITIALIZE 0x8A
66 #define CDC_OPCODE_CDC_START 0x8C
67 #define CDC_OPCODE_RDC_START 0x8E
68 #define CDC_OPCODE_DSP_TRIG 0x8D
69 #define CDC_OPCODE_NV_STORE 0x96
70 #define CDC_OPCODE_NV_RECALL 0x99
71 #define CDC_OPCODE_NV_ERASE 0x9C
72 #define CDC_OPCODE_TEST_READ 0x7E
73 
77 #define CDC_REG_CFG0 0x00
78 #define CDC_REG_CFG1 0x01
79 #define CDC_REG_CFG2 0x02
80 #define CDC_REG_CFG3 0x03
81 #define CDC_REG_CFG4 0x04
82 #define CDC_REG_CFG5 0x05
83 #define CDC_REG_CFG6 0x06
84 #define CDC_REG_CFG7 0x07
85 #define CDC_REG_CFG8 0x08
86 #define CDC_REG_CFG9 0x09
87 #define CDC_REG_CFG10 0x0A
88 #define CDC_REG_CFG11 0x0B
89 #define CDC_REG_CFG12 0x0C
90 #define CDC_REG_CFG13 0x0D
91 #define CDC_REG_CFG14 0x0E
92 #define CDC_REG_CFG15 0x0F
93 #define CDC_REG_CFG16 0x10
94 #define CDC_REG_CFG17 0x11
95 #define CDC_REG_CFG18 0x12
96 #define CDC_REG_CFG19 0x13
97 #define CDC_REG_CFG20 0x14
98 #define CDC_REG_CFG21 0x15
99 #define CDC_REG_CFG22 0x16
100 #define CDC_REG_CFG23 0x17
101 #define CDC_REG_CFG24 0x18
102 #define CDC_REG_CFG25 0x19
103 #define CDC_REG_CFG26 0x1A
104 #define CDC_REG_CFG27 0x1B
105 #define CDC_REG_CFG28 0x1C
106 #define CDC_REG_CFG29 0x1D
107 #define CDC_REG_CFG30 0x1E
108 #define CDC_REG_CFG31 0x1F
109 #define CDC_REG_CFG32 0x20
110 #define CDC_REG_CFG33 0x21
111 #define CDC_REG_CFG34 0x22
112 #define CDC_REG_CFG35 0x23
113 #define CDC_REG_CFG38 0x26
114 #define CDC_REG_CFG39 0x27
115 #define CDC_REG_CFG40 0x28
116 #define CDC_REG_CFG41 0x29
117 #define CDC_REG_CFG42 0x2A
118 #define CDC_REG_CFG47 0x2F
119 #define CDC_REG_CFG48 0x30
120 #define CDC_REG_CFG49 0x31
121 #define CDC_REG_CFG50 0x32
122 #define CDC_REG_CFG54 0x36
123 #define CDC_REG_CFG62 0x3E
124 #define CDC_REG_CFG63 0x3F
125 
130 #define CDC_REG_RES0 0x00
131 #define CDC_REG_RES1 0x04
132 #define CDC_REG_RES2 0x08
133 #define CDC_REG_RES3 0x0C
134 #define CDC_REG_RES4 0x10
135 #define CDC_REG_RES5 0x14
136 #define CDC_REG_RES6 0x18
137 #define CDC_REG_RES7 0x1C
138 #define CDC_REG_STATUS_0 0x20
139 #define CDC_REG_STATUS_1 0x21
140 #define CDC_REG_STATUS_2 0x22
141  // cdc_reg
143 
158 #define CDC_MEM_ADDRESS_START 0x0000u
159 #define CDC_MEM_ADDRESS_END 0x03FFu
160 #define CDC_MEM_ADDRESS_CFG_OFFSET 0x03C0u
161 #define CDC_MEM_ADDRESS_WR_BLOCK_SIZE 64
162 
167 #define CDC_FIXED_POINT_NUM_FRACTIONAL 27
168 
173 #define CDC_TEST_READ_RES 0x11
174 
180 #define CDC_DEVICE_ADDRESS 0x28
181 
190 #define CDC_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
191 #define CDC_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
192  // cdc_set
194 
209 #define CDC_MAP_MIKROBUS( cfg, mikrobus ) \
210  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
211  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
212  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
213  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
214  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
215  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
216  cfg.sis = MIKROBUS( mikrobus, MIKROBUS_AN );
217  // cdc_map // cdc
220 
225 typedef enum
226 {
231 
236 typedef struct cdc_s
237 {
238  digital_out_t sis;
240  i2c_master_t i2c;
241  spi_master_t spi;
243  uint8_t slave_address;
244  pin_name_t chip_select;
248 
253 typedef struct
254 {
255  pin_name_t scl;
256  pin_name_t sda;
257  pin_name_t miso;
258  pin_name_t mosi;
259  pin_name_t sck;
260  pin_name_t cs;
261  pin_name_t sis;
263  uint32_t i2c_speed;
264  uint8_t i2c_address;
266  uint32_t spi_speed;
267  spi_master_mode_t spi_mode;
268  spi_master_chip_select_polarity_t cs_polarity;
272 } cdc_cfg_t;
273 
278 typedef struct
279 {
280  float res_0;
281  float res_1;
282  float res_2;
283  float res_3;
284  float res_4;
285  float res_5;
286  float res_6;
287  float res_7;
288  uint8_t status_0;
289  uint8_t status_1;
290  uint8_t status_2;
292 } cdc_results_t;
293 
298 typedef enum
299 {
300  CDC_OK = 0,
301  CDC_ERROR = -1
302 
304 
320 void cdc_cfg_setup ( cdc_cfg_t *cfg );
321 
337 
351 err_t cdc_init ( cdc_t *ctx, cdc_cfg_t *cfg );
352 
365 err_t cdc_default_cfg ( cdc_t *ctx );
366 
380 err_t cdc_write_memory ( cdc_t *ctx, uint16_t address, const uint8_t *data_in, uint16_t len );
381 
396 err_t cdc_read_memory ( cdc_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
397 
411 err_t cdc_write_config ( cdc_t *ctx, uint8_t address, const uint8_t *data_in, uint8_t len );
412 
427 err_t cdc_read_config ( cdc_t *ctx, uint8_t address, uint8_t *data_out, uint8_t len );
428 
443 err_t cdc_read_result ( cdc_t *ctx, uint8_t address, uint8_t *data_out, uint8_t len );
444 
456 err_t cdc_send_opcode ( cdc_t *ctx, uint8_t opcode );
457 
469 
482 err_t cdc_read_results ( cdc_t *ctx, cdc_results_t *results );
483 
484 #ifdef __cplusplus
485 }
486 #endif
487 #endif // CDC_H
488  // cdc
490 
491 // ------------------------------------------------------------------------ END
cdc_t
struct cdc_s cdc_t
CDC Click context object.
cdc_results_t::status_0
uint8_t status_0
Definition: cdc.h:288
cdc_s::sis
digital_out_t sis
Definition: cdc.h:238
cdc_read_config
err_t cdc_read_config(cdc_t *ctx, uint8_t address, uint8_t *data_out, uint8_t len)
CDC read config function.
cdc_cfg_t::scl
pin_name_t scl
Definition: cdc.h:255
cdc_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: cdc.h:263
cdc_cfg_t::sda
pin_name_t sda
Definition: cdc.h:256
cdc_send_opcode
err_t cdc_send_opcode(cdc_t *ctx, uint8_t opcode)
CDC send opcode function.
CDC_DRV_SEL_I2C
@ CDC_DRV_SEL_I2C
Definition: cdc.h:228
spi_specifics.h
This file contains SPI specific macros, functions, etc.
cdc_results_t::res_7
float res_7
Definition: cdc.h:287
cdc_results_t::res_4
float res_4
Definition: cdc.h:284
CDC_DRV_SEL_SPI
@ CDC_DRV_SEL_SPI
Definition: cdc.h:227
cdc_return_value_t
cdc_return_value_t
CDC Click return value data.
Definition: cdc.h:299
cdc_results_t
CDC Click results object.
Definition: cdc.h:279
cdc_write_memory
err_t cdc_write_memory(cdc_t *ctx, uint16_t address, const uint8_t *data_in, uint16_t len)
CDC write memory function.
cdc_cfg_t::cs
pin_name_t cs
Definition: cdc.h:260
cdc_cfg_t::sck
pin_name_t sck
Definition: cdc.h:259
cdc_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: cdc.h:268
cdc_cfg_t::sis
pin_name_t sis
Definition: cdc.h:261
cdc_s
CDC Click context object.
Definition: cdc.h:237
cdc_default_cfg
err_t cdc_default_cfg(cdc_t *ctx)
CDC default configuration function.
cdc_read_results
err_t cdc_read_results(cdc_t *ctx, cdc_results_t *results)
CDC read results function.
cdc_results_t::res_3
float res_3
Definition: cdc.h:283
cdc_cfg_t::mosi
pin_name_t mosi
Definition: cdc.h:258
CDC_ERROR
@ CDC_ERROR
Definition: cdc.h:301
cdc_s::chip_select
pin_name_t chip_select
Definition: cdc.h:244
cdc_s::drv_sel
cdc_drv_t drv_sel
Definition: cdc.h:245
cdc_s::i2c
i2c_master_t i2c
Definition: cdc.h:240
CDC_OK
@ CDC_OK
Definition: cdc.h:300
cdc_cfg_t::i2c_address
uint8_t i2c_address
Definition: cdc.h:264
cdc_drv_interface_sel
void cdc_drv_interface_sel(cdc_cfg_t *cfg, cdc_drv_t drv_sel)
CDC driver interface setup function.
cdc_results_t::res_1
float res_1
Definition: cdc.h:281
cdc_results_t::res_5
float res_5
Definition: cdc.h:285
cdc_cfg_t::miso
pin_name_t miso
Definition: cdc.h:257
cdc_s::spi
spi_master_t spi
Definition: cdc.h:241
cdc_results_t::status_2
uint8_t status_2
Definition: cdc.h:290
cdc_init
err_t cdc_init(cdc_t *ctx, cdc_cfg_t *cfg)
CDC initialization function.
cdc_results_t::status_1
uint8_t status_1
Definition: cdc.h:289
cdc_check_communication
err_t cdc_check_communication(cdc_t *ctx)
CDC check communication function.
cdc_drv_t
cdc_drv_t
CDC Click driver selector.
Definition: cdc.h:226
cdc_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: cdc.h:267
cdc_read_result
err_t cdc_read_result(cdc_t *ctx, uint8_t address, uint8_t *data_out, uint8_t len)
CDC read result function.
cdc_s::slave_address
uint8_t slave_address
Definition: cdc.h:243
cdc_cfg_t::drv_sel
cdc_drv_t drv_sel
Definition: cdc.h:270
cdc_results_t::res_6
float res_6
Definition: cdc.h:286
cdc_results_t::res_2
float res_2
Definition: cdc.h:282
cdc_read_memory
err_t cdc_read_memory(cdc_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len)
CDC read memory function.
cdc_results_t::res_0
float res_0
Definition: cdc.h:280
cdc_cfg_t
CDC Click configuration object.
Definition: cdc.h:254
cdc_write_config
err_t cdc_write_config(cdc_t *ctx, uint8_t address, const uint8_t *data_in, uint8_t len)
CDC write config function.
cdc_cfg_t::spi_speed
uint32_t spi_speed
Definition: cdc.h:266
cdc_cfg_setup
void cdc_cfg_setup(cdc_cfg_t *cfg)
CDC configuration object setup function.