gyro2  2.0.0.0
gyro2.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 GYRO2_H
36 #define GYRO2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define GYRO2_ADDR0 0x20
53 #define GYRO2_ADDR1 0x21
54 
59 #define GYRO2_STATUS 0x00
60 #define GYRO2_OUT_X_MSB 0x01
61 #define GYRO2_OUT_X_LSB 0x02
62 #define GYRO2_OUT_Y_MSB 0x03
63 #define GYRO2_OUT_Y_LSB 0x04
64 #define GYRO2_OUT_Z_MSB 0x05
65 #define GYRO2_OUT_Z_LSB 0x06
66 #define GYRO2_DR_STATUS 0x07
67 #define GYRO2_F_STATUS 0x08
68 #define GYRO2_F_SETUP 0x09
69 #define GYRO2_F_EVENT 0x0A
70 #define GYRO2_INT_SRC_FLAG 0x0B
71 #define GYRO2_WHO_AM_I 0x0C
72 #define GYRO2_CTRL_REG0 0x0D
73 #define GYRO2_CTRL_REG1 0x13
74 
79 #define GYRO2_SCALE_0 0
80 #define GYRO2_SCALE_1 1
81 #define GYRO2_SCALE_2 2
82 #define GYRO2_SCALE_3 3
83 
84 #define GYRO2_HI_PASS_OFF 0x00
85 #define GYRO2_HI_PASS_MOD0 0x04
86 #define GYRO2_HI_PASS_MOD1 0x0C
87 #define GYRO2_HI_PASS_MOD2 0x14
88 #define GYRO2_HI_PASS_MOD3 0x1C
89 
90 #define GYRO2_LO_PASS_OFF 0x00
91 #define GYRO2_LO_PASS_MOD0 0x20
92 #define GYRO2_LO_PASS_MOD1 0x60
93 #define GYRO2_LO_PASS_MOD2 0xE0
94 
99 #define GYRO2_RT_CFG 0x0E
100 
105 #define GYRO2_RT_CFG_ELE 0x08
106 #define GYRO2_RT_CFG_ZTEFE 0x04
107 #define GYRO2_RT_CFG_YTEFE 0x02
108 #define GYRO2_RT_CFG_XTEFE 0x01
109 
114 #define GYRO2_RT_SRC 0x0F
115 #define GYRO2_RT_THS 0x10
116 #define GYRO2_RT_COUNT 0x11
117 #define GYRO2_TEMP 0x12
118 
123 #define GYRO2_DR_800Hz 0
124 #define GYRO2_DR_400Hz 1
125 #define GYRO2_DR_200Hz 2
126 #define GYRO2_DR_100Hz 3
127 #define GYRO2_DR_50Hz 4
128 #define GYRO2_DR_25Hz 5
129 #define GYRO2_DR_12_5Hz 6
130 #define GYRO2_STANDBY 0
131 #define GYRO2_READY 1
132 #define GYRO2_ACTIVE 3
133 
138 #define GYRO2_CTRL_REG2 0x14
139 
144 #define GYRO2_INT_CFG_FIFO_INT1 0x80
145 #define GYRO2_INT_CFG_FIFO_INT2 0x00
146 #define GYRO2_INT_EN_FIFO 0x40
147 #define GYRO2_INT_DIS_FIFO 0x00
148 #define GYRO2_INT_CFG_RT_INT1 0x20
149 #define GYRO2_INT_CFG_RT_INT2 0x00
150 #define GYRO2_INT_EN_RT 0x10
151 #define GYRO2_DIS_EN_RT 0x00
152 #define GYRO2_INT_CFG_DRDY_INT1 0x08
153 #define GYRO2_INT_CFG_DRDY_INT2 0x00
154 #define GYRO2_INT_EN_DRDY 0x04
155 #define GYRO2_INT_DIS_DRDY 0x00
156 #define GYRO2_IPOL_ACTIVE_HI 0x02
157 #define GYRO2_IPOL_ACTIVE_LO 0x00
158 #define GYRO2_PP_OD_OS 0x01
159 #define GYRO2_PP_OD_PUSH_PULL 0x00
160 
165 #define GYRO2_CTRL_REG3 0x15
166 
172 #define GYRO2_MAP_MIKROBUS( cfg, mikrobus ) \
173  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
174  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
175  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
176  cfg.scs = MIKROBUS( mikrobus, MIKROBUS_AN ); \
177  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
178  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
179  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
180 
186 #define GYRO2_RETVAL uint8_t
187 
188 #define GYRO2_OK 0x00
189 #define GYRO2_INIT_ERROR 0xFF
190  // End group macro
193 // --------------------------------------------------------------- PUBLIC TYPES
202 typedef void ( *gyro2_master_io_t )( struct gyro2_s*, uint8_t, uint8_t*, uint8_t );
203 
204 typedef struct
205 {
206  uint8_t tmp_ctrl_reg0;
207  uint8_t tmp_ctrl_reg1;
208  uint8_t tmp_ctrl_reg2;
209  uint8_t tmp_ctrl_reg3;
210 
211 } ctrl_reg_t;
212 
213 
217 typedef struct gyro2_s
218 {
219  // Output pins
220 
221  digital_out_t scs;
222  digital_out_t rst;
223  digital_out_t rdy_pin;
224  digital_out_t cs;
225 
226  // Input pins
227 
228  digital_in_t rdy;
229  digital_in_t int_pin;
230 
231  // Modules
232 
233  i2c_master_t i2c;
234 
235  // ctx variable
236 
237  uint8_t slave_address;
238 
239  //ctrl register variables
240 
242 
244 
248 typedef struct
249 {
250  // Communication gpio pins
251 
252  pin_name_t scl;
253  pin_name_t sda;
254  pin_name_t cs;
255 
256  // Additional gpio pins
257 
258  pin_name_t scs;
259  pin_name_t rst;
260  pin_name_t rdy;
261  pin_name_t int_pin;
262  pin_name_t rdy_pin;
263 
264  // static variable
265 
266  uint32_t i2c_speed;
267  uint8_t i2c_address;
268 
269 } gyro2_cfg_t;
270  // End types group
272 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
278 #ifdef __cplusplus
279 extern "C"{
280 #endif
281 
291 
300 
308 uint8_t gyro2_default_cfg ( gyro2_t *ctx );
309 
320 void gyro2_generic_write ( gyro2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
321 
332 void gyro2_generic_read ( gyro2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
333 
342 void gyro2_scs_set ( gyro2_t *ctx, uint8_t val );
343 
352 void gyro2_rst_set ( gyro2_t *ctx, uint8_t val );
353 
366 void gyro2_cs_set ( gyro2_t *ctx, uint8_t val );
367 
376 void gyro2_rdy_set ( gyro2_t *ctx, uint8_t val );
377 
385 uint8_t gyro2_rdy_get ( gyro2_t *ctx );
386 
394 uint8_t gyro2_int_get ( gyro2_t *ctx );
395 
403 void gyro2_hw_reset ( gyro2_t *ctx );
404 
412 uint8_t gyro2_get_id ( gyro2_t *ctx );
413 
423 void gyro2_get_axisraw ( gyro2_t *ctx, int16_t *axis_data );
424 
432 void gyro2_calc_axis ( int16_t *axis_data );
433 
442 
450 void gyro2_sw_reset ( gyro2_t *ctx );
451 
460 void gyro2_set_dr ( gyro2_t *ctx, uint8_t rate );
461 
462 void gyro2_set_opmode ( gyro2_t *ctx, uint8_t opmode );
463 
474 void gyro2_interrupt_cfg ( gyro2_t *ctx, uint8_t int_route, uint8_t int_en, uint8_t polarity_outdrvsetting );
475 
484 void gyro2_interrupt_event_generation ( gyro2_t *ctx, uint8_t cfg );
485 
494 void gyro2_sensitivity ( gyro2_t *ctx, uint8_t s_setting );
495 
506 void gyro2_fr_setup ( gyro2_t *ctx, uint8_t low_pass, uint8_t hi_pass, uint8_t scale_set );
507 
508 #ifdef __cplusplu
509 
510 #endif
511 #endif // GYRO2_H
512  // End public_function group
515 
516 // ------------------------------------------------------------------------ END
gyro2_fr_setup
void gyro2_fr_setup(gyro2_t *ctx, uint8_t low_pass, uint8_t hi_pass, uint8_t scale_set)
Filter and scale of measurement functio.
gyro2_rdy_set
void gyro2_rdy_set(gyro2_t *ctx, uint8_t val)
Set ready pin function.
gyro2_rdy_get
uint8_t gyro2_rdy_get(gyro2_t *ctx)
Get ready pin function.
gyro2_scs_set
void gyro2_scs_set(gyro2_t *ctx, uint8_t val)
Set cs pin function.
gyro2_cfg_t::rdy
pin_name_t rdy
Definition: gyro2.h:260
gyro2_get_id
uint8_t gyro2_get_id(gyro2_t *ctx)
ID return function.
gyro2_master_io_t
void(* gyro2_master_io_t)(struct gyro2_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: gyro2.h:202
gyro2_hw_reset
void gyro2_hw_reset(gyro2_t *ctx)
Hardware reset function.
gyro2_cfg_t::i2c_address
uint8_t i2c_address
Definition: gyro2.h:267
gyro2_s::slave_address
uint8_t slave_address
Definition: gyro2.h:237
gyro2_t
struct gyro2_s gyro2_t
Click ctx object definition.
gyro2_s
Click ctx object definition.
Definition: gyro2.h:218
gyro2_cs_set
void gyro2_cs_set(gyro2_t *ctx, uint8_t val)
Comm interface function.
ctrl_reg_t::tmp_ctrl_reg0
uint8_t tmp_ctrl_reg0
Definition: gyro2.h:206
gyro2_cfg_t::rdy_pin
pin_name_t rdy_pin
Definition: gyro2.h:262
gyro2_cfg_t::int_pin
pin_name_t int_pin
Definition: gyro2.h:261
gyro2_sw_reset
void gyro2_sw_reset(gyro2_t *ctx)
Soft reset function.
gyro2_interrupt_cfg
void gyro2_interrupt_cfg(gyro2_t *ctx, uint8_t int_route, uint8_t int_en, uint8_t polarity_outdrvsetting)
Interrupt cfg function.
gyro2_generic_read
void gyro2_generic_read(gyro2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
ctrl_reg_t::tmp_ctrl_reg1
uint8_t tmp_ctrl_reg1
Definition: gyro2.h:207
gyro2_cfg_setup
void gyro2_cfg_setup(gyro2_cfg_t *cfg)
Config Object Initialization function.
gyro2_calc_axis
void gyro2_calc_axis(int16_t *axis_data)
Calc axis funtion.
gyro2_read_temperature
uint8_t gyro2_read_temperature(gyro2_t *ctx)
Temperature read function.
gyro2_s::rdy
digital_in_t rdy
Definition: gyro2.h:228
gyro2_init
GYRO2_RETVAL gyro2_init(gyro2_t *ctx, gyro2_cfg_t *cfg)
Initialization function.
gyro2_cfg_t::rst
pin_name_t rst
Definition: gyro2.h:259
gyro2_s::i2c
i2c_master_t i2c
Definition: gyro2.h:233
gyro2_s::rst
digital_out_t rst
Definition: gyro2.h:222
gyro2_set_opmode
void gyro2_set_opmode(gyro2_t *ctx, uint8_t opmode)
gyro2_int_get
uint8_t gyro2_int_get(gyro2_t *ctx)
Get int pin function.
gyro2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gyro2.h:266
gyro2_interrupt_event_generation
void gyro2_interrupt_event_generation(gyro2_t *ctx, uint8_t cfg)
Int event generation function.
gyro2_s::int_pin
digital_in_t int_pin
Definition: gyro2.h:229
gyro2_default_cfg
uint8_t gyro2_default_cfg(gyro2_t *ctx)
Click Default Configuration function.
gyro2_s::rdy_pin
digital_out_t rdy_pin
Definition: gyro2.h:223
gyro2_generic_write
void gyro2_generic_write(gyro2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
gyro2_cfg_t::cs
pin_name_t cs
Definition: gyro2.h:254
gyro2_cfg_t::scs
pin_name_t scs
Definition: gyro2.h:258
ctrl_reg_t::tmp_ctrl_reg3
uint8_t tmp_ctrl_reg3
Definition: gyro2.h:209
gyro2_set_dr
void gyro2_set_dr(gyro2_t *ctx, uint8_t rate)
Data rate function.
ctrl_reg_t::tmp_ctrl_reg2
uint8_t tmp_ctrl_reg2
Definition: gyro2.h:208
GYRO2_RETVAL
#define GYRO2_RETVAL
Definition: gyro2.h:186
ctrl_reg_t
Definition: gyro2.h:205
gyro2_sensitivity
void gyro2_sensitivity(gyro2_t *ctx, uint8_t s_setting)
Sensitivity function.
gyro2_s::cs
digital_out_t cs
Definition: gyro2.h:224
gyro2_get_axisraw
void gyro2_get_axisraw(gyro2_t *ctx, int16_t *axis_data)
Axis read function.
gyro2_rst_set
void gyro2_rst_set(gyro2_t *ctx, uint8_t val)
Set rst pin function.
gyro2_s::scs
digital_out_t scs
Definition: gyro2.h:221
gyro2_cfg_t::scl
pin_name_t scl
Definition: gyro2.h:252
gyro2_cfg_t::sda
pin_name_t sda
Definition: gyro2.h:253
gyro2_cfg_t
Click configuration structure definition.
Definition: gyro2.h:249
gyro2_s::tmp_ctrl_reg
ctrl_reg_t tmp_ctrl_reg
Definition: gyro2.h:241