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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 #include "drv_spi_master.h"
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define PRESSURE11_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
56  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
57  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
58  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
59  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
60  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
61  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
62 
68 #define PRESSURE11_MASTER_I2C 0
69 #define PRESSURE11_MASTER_SPI 1
70 
76 #define PRESSURE11_RETVAL uint8_t
77 
78 #define PRESSURE11_OK 0x00
79 #define PRESSURE11_INIT_ERROR 0xFF
80 
81 #define DEVICE_ERROR 0x02
82 #define DEVICE_OK 0x00
83 
89 #define PRESSURE11_I_AM 0xB1
90 
96 #define PRESSURE11_REG_INTERRUPT 0x0B
97 #define PRESSURE11_REG_THS_P_L 0x0C
98 #define PRESSURE11_REG_THS_P_H 0x0D
99 #define PRESSURE11_REG_WHO_AM_I 0x0F
100 #define PRESSURE11_REG_CTRL_REG1 0x10
101 #define PRESSURE11_REG_CTRL_REG2 0x11
102 #define PRESSURE11_REG_CTRL_REG3 0x12
103 #define PRESSURE11_REG_FIFO_CTRL 0x14
104 #define PRESSURE11_REG_REF_P_XL 0x15
105 #define PRESSURE11_REG_REF_P_L 0x16
106 #define PRESSURE11_REG_REF_P_H 0x17
107 #define PRESSURE11_REG_RPDS_L 0x18
108 #define PRESSURE11_REG_RPDS_H 0x19
109 #define PRESSURE11_REG_RES_CONF 0x1A
110 #define PRESSURE11_REG_INT_SOURCE 0x25
111 #define PRESSURE11_REG_FIFO_STATUS 0x26
112 #define PRESSURE11_REG_STATUS 0x27
113 #define PRESSURE11_REG_PRESS_OUT_XL 0x28
114 #define PRESSURE11_REG_PRESS_OUT_L 0x29
115 #define PRESSURE11_REG_PRESS_OUT_H 0x2A
116 #define PRESSURE11_REG_TEMP_OUT_L 0x2B
117 #define PRESSURE11_REG_TEMP_OUT_H 0x2C
118 #define PRESSURE11_REG_LPFP_RES 0x33
119 
125 #define PRESSURE11_CFG_INTERRUPT_AUTORIFP 0x80
126 #define PRESSURE11_CFG_INTERRUPT_RESET_ARP 0x40
127 #define PRESSURE11_CFG_INTERRUPT_AUTOZERO 0x20
128 #define PRESSURE11_CFG_INTERRUPT_RESET_AZ 0x10
129 #define PRESSURE11_CFG_INTERRUPT_DIFF_EN 0x08
130 #define PRESSURE11_CFG_INTERRUPT_LIR 0x04
131 #define PRESSURE11_CFG_INTERRUPT_PLE 0x02
132 #define PRESSURE11_CFG_INTERRUPT_PHE 0x01
133 #define PRESSURE11_CFG_INTERRUPT_DISABLE_ALL 0x00
134 
140 #define PRESSURE11_CTRL_1_ODR_1_HZ 0x10
141 #define PRESSURE11_CTRL_1_ODR_10_HZ 0x20
142 #define PRESSURE11_CTRL_1_ODR_25_HZ 0x30
143 #define PRESSURE11_CTRL_1_ODR_50_HZ 0x40
144 #define PRESSURE11_CTRL_1_ODR_75_HZ 0x50
145 #define PRESSURE11_CTRL_1_EN_LPFP 0x08
146 #define PRESSURE11_CTRL_1_LPFP_CFG 0x04
147 #define PRESSURE11_CTRL_1_BDU 0x02
148 #define PRESSURE11_CTRL_1_SIM 0x01
149 #define PRESSURE11_CTRL_1_DISABLE_ALL 0x00
150 
156 #define PRESSURE11_CTRL_2_BOOT 0x80
157 #define PRESSURE11_CTRL_2_FIFO_EN 0x40
158 #define PRESSURE11_CTRL_2_STOP_ON_FTH 0x20
159 #define PRESSURE11_CTRL_2_IF_ADD_INC 0x10
160 #define PRESSURE11_CTRL_2_I2C_DIS 0x08
161 #define PRESSURE11_CTRL_2_SWRESET 0x04
162 #define PRESSURE11_CTRL_2_ONE_SHOT 0x01
163 #define PRESSURE11_CTRL_2_DISABLE_ALL 0x00
164 
170 #define PRESSURE11_CTRL_3_INT_H_L 0x80
171 #define PRESSURE11_CTRL_3_PP_OD 0x40
172 #define PRESSURE11_CTRL_3_F_FSS5 0x20
173 #define PRESSURE11_CTRL_3_F_FTH 0x10
174 #define PRESSURE11_CTRL_3_F_OVR 0x08
175 #define PRESSURE11_CTRL_3_DRDY 0x04
176 #define PRESSURE11_CTRL_3_INT_PRESS_LOW_OR_HIGH 0x03
177 #define PRESSURE11_CTRL_3_INT_PRESS_LOW 0x02
178 #define PRESSURE11_CTRL_3_INT_PRESS_HIGH 0x01
179 #define PRESSURE11_CTRL_3_DISABLE_ALL 0x00
180 
186 #define PRESSURE11_CTRL_FIFO_BYPASS_TO_FIFO_MODE 0xE0
187 #define PRESSURE11_CTRL_FIFO_DYNAMIC_STREAM_MODE 0xC0
188 #define PRESSURE11_CTRL_FIFO_BYPASS_TO_STREAM_MODE 0x80
189 #define PRESSURE11_CTRL_FIFO_STREAM_TO_FIFO_MODE 0x60
190 #define PRESSURE11_CTRL_FIFO_STREAM_MODE 0x40
191 #define PRESSURE11_CTRL_FIFO_FIFO_MODE 0x20
192 #define PRESSURE11_CTRL_FIFO_BYPASS_MODE 0x00
193 
199 #define PRESSURE11_INT_SOURCE_BOOT_STATUS 0x80
200 #define PRESSURE11_INT_SOURCE_IA 0x04
201 #define PRESSURE11_INT_SOURCE_PL 0x02
202 #define PRESSURE11_INT_SOURCE_PH 0x01
203 
209 #define PRESSURE11_STATUS_FTH_FIFO 0x80
210 #define PRESSURE11_STATUS_OVR 0x40
211 #define PRESSURE11_STATUS_FIFO_32_UNREAD_SAMPLES 0x20
212 #define PRESSURE11_STATUS_FIFO_31_UNREAD_SAMPLES 0x1F
213 #define PRESSURE11_STATUS_FIFO_30_UNREAD_SAMPLES 0x1E
214 #define PRESSURE11_STATUS_FIFO_29_UNREAD_SAMPLES 0x1D
215 #define PRESSURE11_STATUS_FIFO_28_UNREAD_SAMPLES 0x1C
216 #define PRESSURE11_STATUS_FIFO_27_UNREAD_SAMPLES 0x1B
217 #define PRESSURE11_STATUS_FIFO_26_UNREAD_SAMPLES 0x1A
218 #define PRESSURE11_STATUS_FIFO_25_UNREAD_SAMPLES 0x19
219 #define PRESSURE11_STATUS_FIFO_24_UNREAD_SAMPLES 0x18
220 #define PRESSURE11_STATUS_FIFO_23_UNREAD_SAMPLES 0x17
221 #define PRESSURE11_STATUS_FIFO_22_UNREAD_SAMPLES 0x16
222 #define PRESSURE11_STATUS_FIFO_21_UNREAD_SAMPLES 0x15
223 #define PRESSURE11_STATUS_FIFO_20_UNREAD_SAMPLES 0x14
224 #define PRESSURE11_STATUS_FIFO_19_UNREAD_SAMPLES 0x13
225 #define PRESSURE11_STATUS_FIFO_18_UNREAD_SAMPLES 0x12
226 #define PRESSURE11_STATUS_FIFO_17_UNREAD_SAMPLES 0x11
227 #define PRESSURE11_STATUS_FIFO_16_UNREAD_SAMPLES 0x10
228 #define PRESSURE11_STATUS_FIFO_15_UNREAD_SAMPLES 0x0F
229 #define PRESSURE11_STATUS_FIFO_14_UNREAD_SAMPLES 0x0E
230 #define PRESSURE11_STATUS_FIFO_13_UNREAD_SAMPLES 0x0D
231 #define PRESSURE11_STATUS_FIFO_12_UNREAD_SAMPLES 0x0C
232 #define PRESSURE11_STATUS_FIFO_11_UNREAD_SAMPLES 0x0B
233 #define PRESSURE11_STATUS_FIFO_10_UNREAD_SAMPLES 0x0A
234 #define PRESSURE11_STATUS_FIFO_9_UNREAD_SAMPLES 0x09
235 #define PRESSURE11_STATUS_FIFO_8_UNREAD_SAMPLES 0x08
236 #define PRESSURE11_STATUS_FIFO_7_UNREAD_SAMPLES 0x07
237 #define PRESSURE11_STATUS_FIFO_6_UNREAD_SAMPLES 0x06
238 #define PRESSURE11_STATUS_FIFO_5_UNREAD_SAMPLES 0x05
239 #define PRESSURE11_STATUS_FIFO_4_UNREAD_SAMPLES 0x04
240 #define PRESSURE11_STATUS_FIFO_3_UNREAD_SAMPLES 0x03
241 #define PRESSURE11_STATUS_FIFO_2_UNREAD_SAMPLES 0x02
242 #define PRESSURE11_STATUS_FIFO_1_UNREAD_SAMPLES 0x01
243 #define PRESSURE11_STATUS_FIFO_EMPTY 0x00
244 
250 #define PRESSURE11_STATUS_T_OR 0x20
251 #define PRESSURE11_STATUS_P_OR 0x10
252 #define PRESSURE11_STATUS_T_DA 0x02
253 #define PRESSURE11_STATUS_P_DA 0x01
254 
260 #define PRESSURE11_DEVICE_SLAVE_ADDR_GND 0x5C
261 #define PRESSURE11_DEVICE_SLAVE_ADDR_VDD 0x5D
262 
264 // End group macro
265 // --------------------------------------------------------------- PUBLIC TYPES
274 typedef uint8_t pressure11_select_t;
275 
279 typedef void ( *pressure11_master_io_t )( struct pressure11_s*, uint8_t, uint8_t*, uint8_t );
280 
284 typedef struct pressure11_s
285 {
286  // Output pins
287 
288  digital_out_t cs;
289 
290  // Input pins
291 
292  digital_in_t int_pin;
293 
294  // Modules
295 
296  i2c_master_t i2c;
297  spi_master_t spi;
298 
299  // ctx variable
300 
301  uint8_t slave_address;
302  pin_name_t chip_select;
303 
307 
309 
313 typedef struct
314 {
315  // Communication gpio pins
316 
317  pin_name_t scl;
318  pin_name_t sda;
319  pin_name_t miso;
320  pin_name_t mosi;
321  pin_name_t sck;
322  pin_name_t cs;
323 
324  // Additional gpio pins
325 
326  pin_name_t int_pin;
327 
328  // static variable
329 
330  uint32_t i2c_speed;
331  uint8_t i2c_address;
332 
333  uint32_t spi_speed;
334  spi_master_mode_t spi_mode;
335  spi_master_chip_select_polarity_t cs_polarity;
336 
338 
340  // End types group
342 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
348 #ifdef __cplusplus
349 extern "C"{
350 #endif
351 
361 
371 
382 void pressure11_generic_write ( pressure11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
383 
394 void pressure11_generic_read ( pressure11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
395 
404 
413 
422 
431 
432 #ifdef __cplusplus
433 }
434 #endif
435 #endif // _PRESSURE11_H_
436  // End public_function group
439 
440 // ------------------------------------------------------------------------- END
pressure11_s::i2c
i2c_master_t i2c
Definition: pressure11.h:296
pressure11_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: pressure11.h:334
pressure11_cfg_t::miso
pin_name_t miso
Definition: pressure11.h:319
pressure11_cfg_t::spi_speed
uint32_t spi_speed
Definition: pressure11.h:333
pressure11_select_t
uint8_t pressure11_select_t
Communication type.
Definition: pressure11.h:274
pressure11_s::write_f
pressure11_master_io_t write_f
Definition: pressure11.h:304
pressure11_s::spi
spi_master_t spi
Definition: pressure11.h:297
pressure11_cfg_t::sda
pin_name_t sda
Definition: pressure11.h:318
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:314
pressure11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pressure11.h:330
pressure11_cfg_t::i2c_address
uint8_t i2c_address
Definition: pressure11.h:331
pressure11_cfg_t::sck
pin_name_t sck
Definition: pressure11.h:321
pressure11_s::chip_select
pin_name_t chip_select
Definition: pressure11.h:302
pressure11_s::read_f
pressure11_master_io_t read_f
Definition: pressure11.h:305
pressure11_s::master_sel
pressure11_select_t master_sel
Definition: pressure11.h:306
pressure11_s
Click ctx object definition.
Definition: pressure11.h:285
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:279
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:292
pressure11_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure11.h:335
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:301
pressure11_cfg_t::int_pin
pin_name_t int_pin
Definition: pressure11.h:326
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:288
pressure11_cfg_t::mosi
pin_name_t mosi
Definition: pressure11.h:320
PRESSURE11_RETVAL
#define PRESSURE11_RETVAL
Definition: pressure11.h:76
pressure11_cfg_t::cs
pin_name_t cs
Definition: pressure11.h:322
pressure11_cfg_t::scl
pin_name_t scl
Definition: pressure11.h:317
pressure11_cfg_t::sel
pressure11_select_t sel
Definition: pressure11.h:337
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.