rtd2  2.0.0.0
rtd2.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 RTD2_H
36 #define RTD2_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 #include "spi_specifics.h"
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define RTD2_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
66  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
67  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
68  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.str = MIKROBUS( mikrobus, MIKROBUS_AN ); \
70  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
82 #define RTD2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
83 #define RTD2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
84 
89 #define RTD2_REG_MUX0 0x00
90 #define RTD2_REG_VBIAS 0x01
91 #define RTD2_REG_MUX1 0x02
92 #define RTD2_REG_SYS0 0x03
93 #define RTD2_REG_OFC0 0x04
94 #define RTD2_REG_OFC1 0x05
95 #define RTD2_REG_OFC2 0x06
96 #define RTD2_REG_FSC0 0x07
97 #define RTD2_REG_FSC1 0x08
98 #define RTD2_REG_FSC2 0x09
99 #define RTD2_REG_IDAC0 0x0A
100 #define RTD2_REG_IDAC1 0x0B
101 #define RTD2_REG_GPIOCFG 0x0C
102 #define RTD2_REG_GPIODIR 0x0D
103 #define RTD2_REG_GPIODAT 0x0E
104 
115 #define RTD2_CMD_WAKEUP 0x01
116 #define RTD2_CMD_SLEEP 0x03
117 #define RTD2_CMD_SYNC 0x05
118 #define RTD2_CMD_RESET 0x07
119 #define RTD2_CMD_NOP 0xFF
120 
126 #define RTD2_CMD_RDATA 0x12
127 #define RTD2_CMD_RDATAC 0x14
128 #define RTD2_CMD_SDATAC 0x16
129 
135 #define RTD2_CMD_RREG 0x20
136 
142 #define RTD2_CMD_WREG 0x40
143 
149 #define RTD2_CMD_SYSOCAL 0x60
150 #define RTD2_CMD_SYSGCAL 0x61
151 #define RTD2_CMD_SELFOCAL 0x62
152 
158 #define RTD2_RW_DUMMY 0xFF
159 
171 #define RTD2_BCS_OFF 0x00
172 #define RTD2_BCS_500 0x40
173 #define RTD2_BCS_2 0x80
174 #define RTD2_BCS_10 0xC0
175 
181 #define RTD2_AINP0 0x00
182 #define RTD2_AINP1 0x08
183 #define RTD2_AINP2 0x10
184 #define RTD2_AINP3 0x18
185 #define RTD2_AIN_POS 0x38
186 
192 #define RTD2_AINN0 0x00
193 #define RTD2_AINN1 0x01
194 #define RTD2_AINN2 0x02
195 #define RTD2_AINN3 0x03
196 #define RTD2_AIN_NEG 0x07
197 
203 #define RTD2_VBIAS_OFF 0x00
204 #define RTD2_VBIAS0 0x01
205 #define RTD2_VBIAS1 0x02
206 #define RTD2_VBIAS2 0x04
207 #define RTD2_VBIAS3 0x08
208 
220 #define RTD2_INT_VREF_OFF 0x00
221 #define RTD2_INT_VREF_ON 0x20
222 #define RTD2_INT_VREF_CONV 0x40
223 
229 #define RTD2_REF0 0x00
230 #define RTD2_INT 0x10
231 #define RTD2_INT_REF0 0x18
232 
238 #define RTD2_MEAS_NORM 0x00
239 #define RTD2_MEAS_OFFSET 0x01
240 #define RTD2_MEAS_GAIN 0x02
241 #define RTD2_MEAS_TEMP 0x03
242 #define RTD2_MEAS_REF0 0x05
243 #define RTD2_MEAS_AVDD 0x06
244 #define RTD2_MEAS_DVDD 0x07
245 
257 #define RTD2_GAIN_1 0x00
258 #define RTD2_GAIN_2 0x10
259 #define RTD2_GAIN_4 0x20
260 #define RTD2_GAIN_8 0x30
261 #define RTD2_GAIN_16 0x40
262 #define RTD2_GAIN_32 0x50
263 #define RTD2_GAIN_64 0x60
264 #define RTD2_GAIN_128 0x70
265 
271 #define RTD2_DR_5 0x00
272 #define RTD2_DR_10 0x01
273 #define RTD2_DR_20 0x02
274 #define RTD2_DR_40 0x03
275 #define RTD2_DR_80 0x04
276 #define RTD2_DR_160 0x05
277 #define RTD2_DR_320 0x06
278 #define RTD2_DR_640 0x07
279 #define RTD2_DR_1000 0x08
280 #define RTD2_DR_2000 0x0F
281 
293 #define RTD2_IDAC_ID 0x90
294 
300 #define RTD2_DRDY_OFF 0x00
301 #define RTD2_DRDY_ON 0x08
302 
308 #define RTD2_IDAC_OFF 0x00
309 #define RTD2_IDAC_50 0x01
310 #define RTD2_IDAC_100 0x02
311 #define RTD2_IDAC_250 0x03
312 #define RTD2_IDAC_500 0x04
313 #define RTD2_IDAC_750 0x05
314 #define RTD2_IDAC_1000 0x06
315 #define RTD2_IDAC_1500 0x07
316 
328 #define RTD2_IDAC1_A0 0xCC
329 #define RTD2_IDAC1_A1 0xDC
330 #define RTD2_IDAC1_A2 0xEC
331 #define RTD2_IDAC1_A3 0xFC
332 
338 #define RTD2_IDAC2_A0 0xCC
339 #define RTD2_IDAC2_A1 0xCD
340 #define RTD2_IDAC2_A2 0xCE
341 #define RTD2_IDAC2_A3 0xCF
342 
354 #define RTD2_GPIO_0 0x01
355 #define RTD2_GPIO_1 0x02
356 #define RTD2_GPIO_2 0x04
357 #define RTD2_GPIO_3 0x08
358 
370 #define RTD2_IO_0 0x01
371 #define RTD2_IO_1 0x02
372 #define RTD2_IO_2 0x04
373 #define RTD2_IO_3 0x08
374 
381 #define RTD2_OUT_0 0x01
382 #define RTD2_OUT_1 0x02
383 #define RTD2_OUT_2 0x04
384 #define RTD2_OUT_3 0x08
385 
391 #define RTD2_PIN_LOW 0x00
392 #define RTD2_PIN_HIGH 0x01
393 
399 #define RTD2_ERROR 0x00
400 #define RTD2_SUCCESS 0x01
401 
407 #define RTD2_START_CONVERSION_DISABLE 0x00
408 #define RTD2_START_CONVERSION_ENABLE 0x01
409 
415 #define RTD2_NEW_DATA_IS_NOT_READY 0x00
416 #define RTD2_NEW_DATA_IS_READY 0x01
417 
423 #define COEFF_PT100_RESISTANCE_OHMS_0_C 100.00000000
424 #define COEFF_ALPHA 0.3920000000
425 #define COEFF_ADC_RES_RT_P 0.0000753846
426 #define COEFF_ADC_COR_FACT 50.980300000
427  // End group macro
429 // --------------------------------------------------------------- PUBLIC TYPES
438 typedef struct
439 {
440  digital_out_t cs;
441  // Output pins
442 
443  digital_out_t str;
444  digital_out_t rst;
445 
446  // Input pins
447  digital_in_t rdy;
448 
449  // Modules
450  spi_master_t spi;
451  pin_name_t chip_select;
452 
453 } rtd2_t;
454 
458 typedef struct
459 {
460  // Communication gpio pins
461  pin_name_t miso;
462  pin_name_t mosi;
463  pin_name_t sck;
464  pin_name_t cs;
465 
466  // Additional gpio pins
467  pin_name_t str;
468  pin_name_t rst;
469  pin_name_t rdy;
470 
471  // static variable
472  uint32_t spi_speed;
473  spi_master_mode_t spi_mode;
474  spi_master_chip_select_polarity_t cs_polarity;
475 
476 } rtd2_cfg_t;
477  // End types group
479 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
480 
485 #ifdef __cplusplus
486 extern "C"{
487 #endif
488 
498 
508 err_t rtd2_init ( rtd2_t *ctx, rtd2_cfg_t *cfg );
509 
529 void rtd2_default_cfg ( rtd2_t *ctx );
530 
543 void rtd2_hw_reset ( rtd2_t *ctx );
544 
558 void rtd2_toggle_cs ( rtd2_t *ctx, uint8_t cs_state );
559 
573 void rtd2_enable_start ( rtd2_t *ctx, uint8_t en_start );
574 
591 uint8_t rtd2_check_interupt ( rtd2_t *ctx );
592 
604 void rtd2_send_cmd ( rtd2_t *ctx, uint8_t cmd );
605 
616 void rtd2_set_wakeup ( rtd2_t *ctx );
617 
628 void rtd2_set_sleep ( rtd2_t *ctx );
629 
641 void rtd2_set_sync ( rtd2_t *ctx );
642 
654 void rtd2_set_reset ( rtd2_t *ctx );
655 
668 
681 
694 
712 void rtd2_write_continuous ( rtd2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
713 
731 void rtd2_read_continuous ( rtd2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
732 
748 void rtd2_write_reg ( rtd2_t *ctx, uint8_t reg, uint8_t tx_data );
749 
766 uint8_t rtd2_read_reg ( rtd2_t *ctx, uint8_t reg );
767 
788 uint8_t rtd2_set_burn_out_source ( rtd2_t *ctx, uint8_t burn_out );
789 
813 void rtd2_set_mux_sel ( rtd2_t *ctx, uint8_t adc_pos, uint8_t adc_neg );
814 
836 uint8_t rtd2_set_bias ( rtd2_t *ctx, uint8_t bias );
837 
857 uint8_t rtd2_set_int_ref ( rtd2_t *ctx, uint8_t s_ref );
858 
878 void rtd2_set_system_monitor ( rtd2_t *ctx, uint8_t sys_mon );
879 
912 void rtd2_set_system_control ( rtd2_t *ctx, uint8_t gain, uint8_t output_rate );
913 
934 void rtd2_set_idac_current_mag ( rtd2_t *ctx, uint8_t c_idac );
935 
958 void rtd2_set_idac_current_out ( rtd2_t *ctx, uint8_t c_out_1, uint8_t c_out_2 );
959 
975 
988 int32_t rtd2_read_output_data ( rtd2_t *ctx );
989 
1004 float rtd2_calc_temperature ( int32_t adc_val );
1005 
1020 
1021 #ifdef __cplusplus
1022 }
1023 #endif
1024 #endif // _RTD2_H_
1025  // End public_function group
1028 
1029 // ------------------------------------------------------------------------- END
rtd2_set_system_control
void rtd2_set_system_control(rtd2_t *ctx, uint8_t gain, uint8_t output_rate)
Set system control function.
rtd2_cfg_t::sck
pin_name_t sck
Definition: rtd2.h:463
rtd2_t::chip_select
pin_name_t chip_select
Definition: rtd2.h:451
rtd2_set_mux_sel
void rtd2_set_mux_sel(rtd2_t *ctx, uint8_t adc_pos, uint8_t adc_neg)
Set multiplexer selection function.
rtd2_set_idac_current_out
void rtd2_set_idac_current_out(rtd2_t *ctx, uint8_t c_out_1, uint8_t c_out_2)
Set IDAC current out function.
rtd2_t::cs
digital_out_t cs
Definition: rtd2.h:440
rtd2_set_int_ref
uint8_t rtd2_set_int_ref(rtd2_t *ctx, uint8_t s_ref)
Set int ref function.
rtd2_set_bias
uint8_t rtd2_set_bias(rtd2_t *ctx, uint8_t bias)
Set bias function.
rtd2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rtd2.h:473
rtd2_get_temperature
float rtd2_get_temperature(rtd2_t *ctx)
Get temperature function.
rtd2_calc_temperature
float rtd2_calc_temperature(int32_t adc_val)
Calculate temperature function.
rtd2_set_system_monitor
void rtd2_set_system_monitor(rtd2_t *ctx, uint8_t sys_mon)
Set system monitor function.
rtd2_send_cmd
void rtd2_send_cmd(rtd2_t *ctx, uint8_t cmd)
Send command function.
rtd2_toggle_cs
void rtd2_toggle_cs(rtd2_t *ctx, uint8_t cs_state)
Toggle CS pin function.
rtd2_set_sleep
void rtd2_set_sleep(rtd2_t *ctx)
Set to sleep function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
rtd2_t::rst
digital_out_t rst
Definition: rtd2.h:444
rtd2_cfg_t::rdy
pin_name_t rdy
Definition: rtd2.h:469
rtd2_t
Click ctx object definition.
Definition: rtd2.h:439
rtd2_enable_start
void rtd2_enable_start(rtd2_t *ctx, uint8_t en_start)
Enable conversion start function.
rtd2_cfg_t::spi_speed
uint32_t spi_speed
Definition: rtd2.h:472
rtd2_set_read_data_once
void rtd2_set_read_data_once(rtd2_t *ctx)
Set read data once function.
rtd2_cfg_t::rst
pin_name_t rst
Definition: rtd2.h:468
rtd2_cfg_t
Click configuration structure definition.
Definition: rtd2.h:459
rtd2_set_idac_current_mag
void rtd2_set_idac_current_mag(rtd2_t *ctx, uint8_t c_idac)
Set IDAC current magnitude function.
rtd2_cfg_t::miso
pin_name_t miso
Definition: rtd2.h:461
rtd2_cfg_t::mosi
pin_name_t mosi
Definition: rtd2.h:462
rtd2_check_new_data_ready
uint8_t rtd2_check_new_data_ready(rtd2_t *ctx)
Check new data ready function.
rtd2_t::str
digital_out_t str
Definition: rtd2.h:443
rtd2_cfg_setup
void rtd2_cfg_setup(rtd2_cfg_t *cfg)
Config Object Initialization function.
rtd2_set_sync
void rtd2_set_sync(rtd2_t *ctx)
Set sync function.
rtd2_set_read_data_continuous
void rtd2_set_read_data_continuous(rtd2_t *ctx)
Set read data continuous function.
rtd2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rtd2.h:474
rtd2_read_output_data
int32_t rtd2_read_output_data(rtd2_t *ctx)
Read output data function.
rtd2_cfg_t::str
pin_name_t str
Definition: rtd2.h:467
rtd2_default_cfg
void rtd2_default_cfg(rtd2_t *ctx)
Set default configuration function.
rtd2_set_burn_out_source
uint8_t rtd2_set_burn_out_source(rtd2_t *ctx, uint8_t burn_out)
Set burn out source function.
rtd2_hw_reset
void rtd2_hw_reset(rtd2_t *ctx)
Hardware reset function.
rtd2_t::rdy
digital_in_t rdy
Definition: rtd2.h:447
rtd2_set_wakeup
void rtd2_set_wakeup(rtd2_t *ctx)
Set wakeup function.
rtd2_t::spi
spi_master_t spi
Definition: rtd2.h:450
rtd2_read_reg
uint8_t rtd2_read_reg(rtd2_t *ctx, uint8_t reg)
Read the register function.
rtd2_init
err_t rtd2_init(rtd2_t *ctx, rtd2_cfg_t *cfg)
Initialization function.
rtd2_set_stop_data
void rtd2_set_stop_data(rtd2_t *ctx)
Set stop data function.
rtd2_set_reset
void rtd2_set_reset(rtd2_t *ctx)
Set reset function.
rtd2_read_continuous
void rtd2_read_continuous(rtd2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes)
Continuous read the data function.
rtd2_write_continuous
void rtd2_write_continuous(rtd2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes)
Continuous write the data function.
rtd2_write_reg
void rtd2_write_reg(rtd2_t *ctx, uint8_t reg, uint8_t tx_data)
Write the register function.
rtd2_cfg_t::cs
pin_name_t cs
Definition: rtd2.h:464
rtd2_check_interupt
uint8_t rtd2_check_interupt(rtd2_t *ctx)
Check interrupt status function.