pressure11  2.0.0.0
pressure11.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 PRESSURE11_H
36 #define PRESSURE11_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_i2c_master.h"
51 #include "drv_spi_master.h"
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define PRESSURE11_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
66  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
78 #define PRESSURE11_MASTER_I2C 0
79 #define PRESSURE11_MASTER_SPI 1
80 
86 #define PRESSURE11_RETVAL uint8_t
87 
88 #define PRESSURE11_OK 0x00
89 #define PRESSURE11_INIT_ERROR 0xFF
90 
91 #define DEVICE_ERROR 0x02
92 #define DEVICE_OK 0x00
93 
99 #define PRESSURE11_I_AM 0xB1
100 
106 #define PRESSURE11_REG_INTERRUPT 0x0B
107 #define PRESSURE11_REG_THS_P_L 0x0C
108 #define PRESSURE11_REG_THS_P_H 0x0D
109 #define PRESSURE11_REG_WHO_AM_I 0x0F
110 #define PRESSURE11_REG_CTRL_REG1 0x10
111 #define PRESSURE11_REG_CTRL_REG2 0x11
112 #define PRESSURE11_REG_CTRL_REG3 0x12
113 #define PRESSURE11_REG_FIFO_CTRL 0x14
114 #define PRESSURE11_REG_REF_P_XL 0x15
115 #define PRESSURE11_REG_REF_P_L 0x16
116 #define PRESSURE11_REG_REF_P_H 0x17
117 #define PRESSURE11_REG_RPDS_L 0x18
118 #define PRESSURE11_REG_RPDS_H 0x19
119 #define PRESSURE11_REG_RES_CONF 0x1A
120 #define PRESSURE11_REG_INT_SOURCE 0x25
121 #define PRESSURE11_REG_FIFO_STATUS 0x26
122 #define PRESSURE11_REG_STATUS 0x27
123 #define PRESSURE11_REG_PRESS_OUT_XL 0x28
124 #define PRESSURE11_REG_PRESS_OUT_L 0x29
125 #define PRESSURE11_REG_PRESS_OUT_H 0x2A
126 #define PRESSURE11_REG_TEMP_OUT_L 0x2B
127 #define PRESSURE11_REG_TEMP_OUT_H 0x2C
128 #define PRESSURE11_REG_LPFP_RES 0x33
129 
135 #define PRESSURE11_CFG_INTERRUPT_AUTORIFP 0x80
136 #define PRESSURE11_CFG_INTERRUPT_RESET_ARP 0x40
137 #define PRESSURE11_CFG_INTERRUPT_AUTOZERO 0x20
138 #define PRESSURE11_CFG_INTERRUPT_RESET_AZ 0x10
139 #define PRESSURE11_CFG_INTERRUPT_DIFF_EN 0x08
140 #define PRESSURE11_CFG_INTERRUPT_LIR 0x04
141 #define PRESSURE11_CFG_INTERRUPT_PLE 0x02
142 #define PRESSURE11_CFG_INTERRUPT_PHE 0x01
143 #define PRESSURE11_CFG_INTERRUPT_DISABLE_ALL 0x00
144 
150 #define PRESSURE11_CTRL_1_ODR_1_HZ 0x10
151 #define PRESSURE11_CTRL_1_ODR_10_HZ 0x20
152 #define PRESSURE11_CTRL_1_ODR_25_HZ 0x30
153 #define PRESSURE11_CTRL_1_ODR_50_HZ 0x40
154 #define PRESSURE11_CTRL_1_ODR_75_HZ 0x50
155 #define PRESSURE11_CTRL_1_EN_LPFP 0x08
156 #define PRESSURE11_CTRL_1_LPFP_CFG 0x04
157 #define PRESSURE11_CTRL_1_BDU 0x02
158 #define PRESSURE11_CTRL_1_SIM 0x01
159 #define PRESSURE11_CTRL_1_DISABLE_ALL 0x00
160 
166 #define PRESSURE11_CTRL_2_BOOT 0x80
167 #define PRESSURE11_CTRL_2_FIFO_EN 0x40
168 #define PRESSURE11_CTRL_2_STOP_ON_FTH 0x20
169 #define PRESSURE11_CTRL_2_IF_ADD_INC 0x10
170 #define PRESSURE11_CTRL_2_I2C_DIS 0x08
171 #define PRESSURE11_CTRL_2_SWRESET 0x04
172 #define PRESSURE11_CTRL_2_ONE_SHOT 0x01
173 #define PRESSURE11_CTRL_2_DISABLE_ALL 0x00
174 
180 #define PRESSURE11_CTRL_3_INT_H_L 0x80
181 #define PRESSURE11_CTRL_3_PP_OD 0x40
182 #define PRESSURE11_CTRL_3_F_FSS5 0x20
183 #define PRESSURE11_CTRL_3_F_FTH 0x10
184 #define PRESSURE11_CTRL_3_F_OVR 0x08
185 #define PRESSURE11_CTRL_3_DRDY 0x04
186 #define PRESSURE11_CTRL_3_INT_PRESS_LOW_OR_HIGH 0x03
187 #define PRESSURE11_CTRL_3_INT_PRESS_LOW 0x02
188 #define PRESSURE11_CTRL_3_INT_PRESS_HIGH 0x01
189 #define PRESSURE11_CTRL_3_DISABLE_ALL 0x00
190 
196 #define PRESSURE11_CTRL_FIFO_BYPASS_TO_FIFO_MODE 0xE0
197 #define PRESSURE11_CTRL_FIFO_DYNAMIC_STREAM_MODE 0xC0
198 #define PRESSURE11_CTRL_FIFO_BYPASS_TO_STREAM_MODE 0x80
199 #define PRESSURE11_CTRL_FIFO_STREAM_TO_FIFO_MODE 0x60
200 #define PRESSURE11_CTRL_FIFO_STREAM_MODE 0x40
201 #define PRESSURE11_CTRL_FIFO_FIFO_MODE 0x20
202 #define PRESSURE11_CTRL_FIFO_BYPASS_MODE 0x00
203 
209 #define PRESSURE11_INT_SOURCE_BOOT_STATUS 0x80
210 #define PRESSURE11_INT_SOURCE_IA 0x04
211 #define PRESSURE11_INT_SOURCE_PL 0x02
212 #define PRESSURE11_INT_SOURCE_PH 0x01
213 
219 #define PRESSURE11_STATUS_FTH_FIFO 0x80
220 #define PRESSURE11_STATUS_OVR 0x40
221 #define PRESSURE11_STATUS_FIFO_32_UNREAD_SAMPLES 0x20
222 #define PRESSURE11_STATUS_FIFO_31_UNREAD_SAMPLES 0x1F
223 #define PRESSURE11_STATUS_FIFO_30_UNREAD_SAMPLES 0x1E
224 #define PRESSURE11_STATUS_FIFO_29_UNREAD_SAMPLES 0x1D
225 #define PRESSURE11_STATUS_FIFO_28_UNREAD_SAMPLES 0x1C
226 #define PRESSURE11_STATUS_FIFO_27_UNREAD_SAMPLES 0x1B
227 #define PRESSURE11_STATUS_FIFO_26_UNREAD_SAMPLES 0x1A
228 #define PRESSURE11_STATUS_FIFO_25_UNREAD_SAMPLES 0x19
229 #define PRESSURE11_STATUS_FIFO_24_UNREAD_SAMPLES 0x18
230 #define PRESSURE11_STATUS_FIFO_23_UNREAD_SAMPLES 0x17
231 #define PRESSURE11_STATUS_FIFO_22_UNREAD_SAMPLES 0x16
232 #define PRESSURE11_STATUS_FIFO_21_UNREAD_SAMPLES 0x15
233 #define PRESSURE11_STATUS_FIFO_20_UNREAD_SAMPLES 0x14
234 #define PRESSURE11_STATUS_FIFO_19_UNREAD_SAMPLES 0x13
235 #define PRESSURE11_STATUS_FIFO_18_UNREAD_SAMPLES 0x12
236 #define PRESSURE11_STATUS_FIFO_17_UNREAD_SAMPLES 0x11
237 #define PRESSURE11_STATUS_FIFO_16_UNREAD_SAMPLES 0x10
238 #define PRESSURE11_STATUS_FIFO_15_UNREAD_SAMPLES 0x0F
239 #define PRESSURE11_STATUS_FIFO_14_UNREAD_SAMPLES 0x0E
240 #define PRESSURE11_STATUS_FIFO_13_UNREAD_SAMPLES 0x0D
241 #define PRESSURE11_STATUS_FIFO_12_UNREAD_SAMPLES 0x0C
242 #define PRESSURE11_STATUS_FIFO_11_UNREAD_SAMPLES 0x0B
243 #define PRESSURE11_STATUS_FIFO_10_UNREAD_SAMPLES 0x0A
244 #define PRESSURE11_STATUS_FIFO_9_UNREAD_SAMPLES 0x09
245 #define PRESSURE11_STATUS_FIFO_8_UNREAD_SAMPLES 0x08
246 #define PRESSURE11_STATUS_FIFO_7_UNREAD_SAMPLES 0x07
247 #define PRESSURE11_STATUS_FIFO_6_UNREAD_SAMPLES 0x06
248 #define PRESSURE11_STATUS_FIFO_5_UNREAD_SAMPLES 0x05
249 #define PRESSURE11_STATUS_FIFO_4_UNREAD_SAMPLES 0x04
250 #define PRESSURE11_STATUS_FIFO_3_UNREAD_SAMPLES 0x03
251 #define PRESSURE11_STATUS_FIFO_2_UNREAD_SAMPLES 0x02
252 #define PRESSURE11_STATUS_FIFO_1_UNREAD_SAMPLES 0x01
253 #define PRESSURE11_STATUS_FIFO_EMPTY 0x00
254 
260 #define PRESSURE11_STATUS_T_OR 0x20
261 #define PRESSURE11_STATUS_P_OR 0x10
262 #define PRESSURE11_STATUS_T_DA 0x02
263 #define PRESSURE11_STATUS_P_DA 0x01
264 
270 #define PRESSURE11_DEVICE_SLAVE_ADDR_GND 0x5C
271 #define PRESSURE11_DEVICE_SLAVE_ADDR_VDD 0x5D
272 
274 // End group macro
275 // --------------------------------------------------------------- PUBLIC TYPES
284 typedef uint8_t pressure11_select_t;
285 
289 typedef void ( *pressure11_master_io_t )( struct pressure11_s*, uint8_t, uint8_t*, uint8_t );
290 
294 typedef struct pressure11_s
295 {
296  // Output pins
297 
298  digital_out_t cs;
299 
300  // Input pins
301 
302  digital_in_t int_pin;
303 
304  // Modules
305 
306  i2c_master_t i2c;
307  spi_master_t spi;
308 
309  // ctx variable
310 
311  uint8_t slave_address;
312  pin_name_t chip_select;
313 
317 
319 
323 typedef struct
324 {
325  // Communication gpio pins
326 
327  pin_name_t scl;
328  pin_name_t sda;
329  pin_name_t miso;
330  pin_name_t mosi;
331  pin_name_t sck;
332  pin_name_t cs;
333 
334  // Additional gpio pins
335 
336  pin_name_t int_pin;
337 
338  // static variable
339 
340  uint32_t i2c_speed;
341  uint8_t i2c_address;
342 
343  uint32_t spi_speed;
344  spi_master_mode_t spi_mode;
345  spi_master_chip_select_polarity_t cs_polarity;
346 
348 
350  // End types group
352 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
358 #ifdef __cplusplus
359 extern "C"{
360 #endif
361 
371 
381 
392 void pressure11_generic_write ( pressure11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
393 
404 void pressure11_generic_read ( pressure11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
405 
414 
423 
432 
441 
442 #ifdef __cplusplus
443 }
444 #endif
445 #endif // _PRESSURE11_H_
446  // End public_function group
449 
450 // ------------------------------------------------------------------------- END
pressure11_s::i2c
i2c_master_t i2c
Definition: pressure11.h:306
pressure11_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: pressure11.h:344
pressure11_cfg_t::miso
pin_name_t miso
Definition: pressure11.h:329
pressure11_cfg_t::spi_speed
uint32_t spi_speed
Definition: pressure11.h:343
pressure11_select_t
uint8_t pressure11_select_t
Communication type.
Definition: pressure11.h:284
pressure11_s::write_f
pressure11_master_io_t write_f
Definition: pressure11.h:314
pressure11_s::spi
spi_master_t spi
Definition: pressure11.h:307
pressure11_cfg_t::sda
pin_name_t sda
Definition: pressure11.h:328
pressure11_get_interrupt
uint8_t pressure11_get_interrupt(pressure11_t *ctx)
Functions for read int pin.
pressure11_cfg_t
Click configuration structure definition.
Definition: pressure11.h:324
pressure11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pressure11.h:340
pressure11_cfg_t::i2c_address
uint8_t i2c_address
Definition: pressure11.h:341
pressure11_cfg_t::sck
pin_name_t sck
Definition: pressure11.h:331
pressure11_s::chip_select
pin_name_t chip_select
Definition: pressure11.h:312
pressure11_s::read_f
pressure11_master_io_t read_f
Definition: pressure11.h:315
pressure11_s::master_sel
pressure11_select_t master_sel
Definition: pressure11.h:316
pressure11_s
Click ctx object definition.
Definition: pressure11.h:295
pressure11_t
struct pressure11_s pressure11_t
Click ctx object definition.
pressure11_master_io_t
void(* pressure11_master_io_t)(struct pressure11_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: pressure11.h:289
pressure11_check_id
uint8_t pressure11_check_id(pressure11_t *ctx)
Functions for cheking commuincation with the chip and checking its ID.
pressure11_get_pressure
float pressure11_get_pressure(pressure11_t *ctx)
Functions for pressure reading.
pressure11_s::int_pin
digital_in_t int_pin
Definition: pressure11.h:302
pressure11_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure11.h:345
pressure11_get_temperature
float pressure11_get_temperature(pressure11_t *ctx)
Functions for temperature reading.
pressure11_generic_write
void pressure11_generic_write(pressure11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pressure11_s::slave_address
uint8_t slave_address
Definition: pressure11.h:311
pressure11_cfg_t::int_pin
pin_name_t int_pin
Definition: pressure11.h:336
pressure11_init
PRESSURE11_RETVAL pressure11_init(pressure11_t *ctx, pressure11_cfg_t *cfg)
Initialization function.
pressure11_s::cs
digital_out_t cs
Definition: pressure11.h:298
pressure11_cfg_t::mosi
pin_name_t mosi
Definition: pressure11.h:330
PRESSURE11_RETVAL
#define PRESSURE11_RETVAL
Definition: pressure11.h:86
pressure11_cfg_t::cs
pin_name_t cs
Definition: pressure11.h:332
pressure11_cfg_t::scl
pin_name_t scl
Definition: pressure11.h:327
pressure11_cfg_t::sel
pressure11_select_t sel
Definition: pressure11.h:347
pressure11_generic_read
void pressure11_generic_read(pressure11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pressure11_cfg_setup
void pressure11_cfg_setup(pressure11_cfg_t *cfg)
Config Object Initialization function.