-
Notifications
You must be signed in to change notification settings - Fork 46
/
bmi088_mm.h
995 lines (873 loc) · 36.3 KB
/
bmi088_mm.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
/**
* Copyright (c) 2024 Bosch Sensortec GmbH. All rights reserved.
*
* BSD-3-Clause
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @file bmi088_mm.h
* @date 2024-07-29
* @version v1.9.0
*
*/
/*! \file bmi088_mm.h
* \brief Sensor Driver for BMI088_MM family of sensors */
/*!
* @defgroup bmi088_mm BMI088_MM
*/
#ifndef BMI088_MM_H_
#define BMI088_MM_H_
#ifdef __cplusplus
extern "C" {
#endif
/*********************************************************************/
/* Header files */
/*********************************************************************/
#include "bmi08.h"
/*********************************************************************/
/* Macro Definitions */
/*********************************************************************/
/**\name Accel unique chip identifier */
#define BMI088_MM_ACCEL_CHIP_ID_PRIM UINT8_C(0x1A)
#define BMI088_MM_ACCEL_CHIP_ID_SEC UINT8_C(0x1E)
/**\name Orientation result register*/
#define BMI088_MM_REG_ORIENT_HIGHG_OUT UINT8_C(0x29)
#define BMI088_MM_REG_ORIENT_HIGHG_OUT_LENGTH UINT8_C(1)
#define BMI088_MM_ACCEL_DATA_SYNC_INT UINT8_C(0x01)
#define BMI088_MM_ACCEL_ANY_MOT_INT UINT8_C(0x02)
#define BMI088_MM_ACCEL_HIGH_G_INT UINT8_C(0x04)
#define BMI088_MM_ACCEL_LOW_G_INT UINT8_C(0x08)
#define BMI088_MM_ACCEL_ORIENT_INT UINT8_C(0x10)
#define BMI088_MM_ACCEL_NO_MOT_INT UINT8_C(0x20)
#define BMI088_MM_ACCEL_ERR_INT UINT8_C(0x80)
/**\name BMI08 Accel Range */
#define BMI088_MM_ACCEL_RANGE_3G UINT8_C(0x00)
#define BMI088_MM_ACCEL_RANGE_6G UINT8_C(0x01)
#define BMI088_MM_ACCEL_RANGE_12G UINT8_C(0x02)
#define BMI088_MM_ACCEL_RANGE_24G UINT8_C(0x03)
#define BMI088_MM_ACCEL_ANY_MOT_INT_DISABLE UINT8_C(0x00)
#define BMI088_MM_ACCEL_ANY_MOT_INT_ENABLE UINT8_C(0x02)
#define BMI088_MM_ACCEL_HIGH_G_INT_DISABLE UINT8_C(0x00)
#define BMI088_MM_ACCEL_HIGH_G_INT_ENABLE UINT8_C(0x04)
#define BMI088_MM_ACCEL_LOW_G_INT_DISABLE UINT8_C(0x00)
#define BMI088_MM_ACCEL_LOW_G_INT_ENABLE UINT8_C(0x08)
#define BMI088_MM_ACCEL_ORIENT_INT_DISABLE UINT8_C(0x00)
#define BMI088_MM_ACCEL_ORIENT_INT_ENABLE UINT8_C(0x10)
#define BMI088_MM_ACCEL_NO_MOT_INT_DISABLE UINT8_C(0x00)
#define BMI088_MM_ACCEL_NO_MOT_INT_ENABLE UINT8_C(0x20)
#define BMI088_MM_ACCEL_ERR_INT_DISABLE UINT8_C(0x00)
#define BMI088_MM_ACCEL_ERR_INT_ENABLE UINT8_C(0x80)
/**\name BMI08 Anymotion ODR */
#define BMI088_MM_ACCEL_ANY_MOT_ODR_25HZ UINT8_C(0x00)
#define BMI088_MM_ACCEL_ANY_MOT_ODR_50HZ UINT8_C(0x01)
#define BMI088_MM_ACCEL_ANY_MOT_ODR_100HZ UINT8_C(0x02)
#define BMI088_MM_ACCEL_ANY_MOT_ODR_200HZ UINT8_C(0x03)
/**\name Axis Remap Feature size */
#define BMI088_MM_FEATURE_SIZE UINT8_C(0x1E)
/**\name Accel remap start address */
#define BMI088_MM_ADDR_AXES_REMAP_START UINT8_C(0x1C)
/**\name Mask definition for config version */
#define BMI088_MM_CONFIG_MAJOR_MASK UINT16_C(0x3C0)
#define BMI088_MM_CONFIG_MINOR_MASK UINT8_C(0x3F)
/**\name Bit position for major version from config */
#define BMI088_MM_CONFIG_MAJOR_POS UINT8_C(0x06)
/**\name Config ID start address */
#define BMI088_MM_ADDR_CONFIG_ID_START UINT8_C(0x1A)
#define BMI088_MM_E_REMAP_ERROR INT8_C(-11)
#define BMI088_MM_STATUS_SET UINT8_C(1)
#define BMI088_MM_STATUS_CLEAR UINT8_C(0)
/* Power mode switching delay 30ms - refer data sheet table 3 */
#define BMI088_MM_GYRO_POWER_MODE_SWITCHING_DELAY_MS UINT8_C(30)
/* Accel device init delay - refer data sheet section 3 */
#define BMI088_MM_ACCEL_DEVICE_INIT_DELAY_MS UINT8_C(50)
/* Accel power mode switching delay - data sheet section 4.1.1 */
#define BMI088_MM_ACCEL_POWER_MODE_SWITCHING_DELAY_MS UINT8_C(5)
/* Delay required to get temperature data 1.28s - refer data sheet section 5.3.7 */
#define BMI088_MM_TEMPERATURE_DATA_READ_DELAY_MS UINT8_C(1300)
/* Self-test: Resulting minimum difference signal in mg for BMI088_MM */
#define BMI088_MM_ST_ACC_X_AXIS_SIGNAL_DIFF UINT16_C(1000)
#define BMI088_MM_ST_ACC_Y_AXIS_SIGNAL_DIFF UINT16_C(1000)
#define BMI088_MM_ST_ACC_Z_AXIS_SIGNAL_DIFF UINT16_C(500)
/**\name Feature start Addresses */
#define BMI088_MM_ACCEL_ANYMOTION_ADR UINT8_C(0x00)
#define BMI088_MM_ACCEL_DATA_SYNC_ADR UINT8_C(0x02)
#define BMI088_MM_HIGH_G_START_ADR UINT8_C(0x03)
#define BMI088_MM_LOW_G_START_ADR UINT8_C(0x06)
#define BMI088_MM_ORIENT_START_ADR UINT8_C(0x09)
#define BMI088_MM_NO_MOTION_START_ADR UINT8_C(0x0B)
/**\name Accel Any-motion Macros */
#define BMI088_MM_ACCEL_ANYMOTION_LEN UINT8_C(0x02)
#define BMI088_MM_ACCEL_ANYMOTION_THRESHOLD_MASK UINT16_C(0x07FF)
#define BMI088_MM_ACCEL_ANYMOTION_THRESHOLD_SHIFT UINT8_C(0x00)
#define BMI088_MM_ACCEL_ANYMOTION_NOMOTION_SEL_MASK UINT16_C(0x0800)
#define BMI088_MM_ACCEL_ANYMOTION_NOMOTION_SEL_SHIFT UINT8_C(0x0B)
#define BMI088_MM_ACCEL_ANYMOTION_ODR_MASK UINT8_C(0x3000)
#define BMI088_MM_ACCEL_ANYMOTION_ODR_SHIFT UINT8_C(0x0C)
#define BMI088_MM_ACCEL_ANYMOTION_DURATION_MASK UINT16_C(0x1FFF)
#define BMI088_MM_ACCEL_ANYMOTION_DURATION_SHIFT UINT8_C(0x00)
#define BMI088_MM_ACCEL_ANYMOTION_X_EN_MASK UINT16_C(0x2000)
#define BMI088_MM_ACCEL_ANYMOTION_X_EN_SHIFT UINT8_C(0x0D)
#define BMI088_MM_ACCEL_ANYMOTION_Y_EN_MASK UINT16_C(0x4000)
#define BMI088_MM_ACCEL_ANYMOTION_Y_EN_SHIFT UINT8_C(0x0E)
#define BMI088_MM_ACCEL_ANYMOTION_Z_EN_MASK UINT16_C(0x8000)
#define BMI088_MM_ACCEL_ANYMOTION_Z_EN_SHIFT UINT8_C(0x0F)
/**\name Accel Data Sync Macros */
#define BMI088_MM_ACCEL_DATA_SYNC_LEN UINT8_C(0x01)
#define BMI088_MM_ACCEL_DATA_SYNC_MODE_MASK UINT16_C(0x0003)
#define BMI088_MM_ACCEL_DATA_SYNC_MODE_SHIFT UINT16_C(0x0000)
#define BMI088_MM_ACCEL_DATA_SYNC_MODE_OFF UINT8_C(0x00)
#define BMI088_MM_ACCEL_DATA_SYNC_MODE_400HZ UINT8_C(0x01)
#define BMI088_MM_ACCEL_DATA_SYNC_MODE_1000HZ UINT8_C(0x02)
#define BMI088_MM_ACCEL_DATA_SYNC_MODE_2000HZ UINT8_C(0x03)
/**\name Mask definitions for high-g feature configuration */
#define BMI088_MM_HIGH_G_THRES_MASK UINT16_C(0x7FFF)
#define BMI088_MM_HIGH_G_HYST_MASK UINT16_C(0x0FFF)
#define BMI088_MM_HIGH_G_X_SEL_MASK UINT16_C(0x1000)
#define BMI088_MM_HIGH_G_Y_SEL_MASK UINT16_C(0x2000)
#define BMI088_MM_HIGH_G_Z_SEL_MASK UINT16_C(0x4000)
#define BMI088_MM_HIGH_G_ENABLE_MASK UINT16_C(0x8000)
#define BMI088_MM_HIGH_G_DUR_MASK UINT16_C(0x0FFF)
#define BMI088_MM_HIGH_G_OUT_CONF_MASK UINT16_C(0xF000)
/**\name Bit position definitions for high-g feature configuration */
#define BMI088_MM_HIGH_G_THRES_POS UINT8_C(0x00)
#define BMI088_MM_HIGH_G_HYST_POS UINT8_C(0x00)
#define BMI088_MM_HIGH_G_OUT_CONF_POS UINT8_C(0x0C)
#define BMI088_MM_HIGH_G_X_SEL_POS UINT8_C(0x0C)
#define BMI088_MM_HIGH_G_Y_SEL_POS UINT8_C(0x0D)
#define BMI088_MM_HIGH_G_Z_SEL_POS UINT8_C(0x0E)
#define BMI088_MM_HIGH_G_ENABLE_POS UINT8_C(0x0F)
#define BMI088_MM_HIGH_G_DUR_POS UINT8_C(0x00)
#define BMI088_MM_HIGH_G_AXIS_X_POS UINT8_C(0x03)
#define BMI088_MM_HIGH_G_AXIS_Y_POS UINT8_C(0x04)
#define BMI088_MM_HIGH_G_AXIS_Z_POS UINT8_C(0x05)
#define BMI088_MM_HIGH_G_AXIS_DIRECTION_POS UINT8_C(0x06)
#define BMI088_MM_HIGH_G_AXIS_X_MASK UINT8_C(0x08)
#define BMI088_MM_HIGH_G_AXIS_Y_MASK UINT8_C(0x10)
#define BMI088_MM_HIGH_G_AXIS_Z_MASK UINT8_C(0x20)
#define BMI088_MM_HIGH_G_AXIS_DIRECTION_MASK UINT8_C(0x40)
/**\name Mask definitions for low-g feature configuration */
#define BMI088_MM_LOW_G_THRES_MASK UINT16_C(0x7FFF)
#define BMI088_MM_LOW_G_HYST_MASK UINT16_C(0x0FFF)
#define BMI088_MM_LOW_G_DUR_MASK UINT16_C(0x0FFF)
#define BMI088_MM_LOW_G_ENABLE_MASK UINT16_C(0x1000)
/**\name Bit position definitions for low-g feature configuration */
#define BMI088_MM_LOW_G_THRES_POS UINT16_C(0x00)
#define BMI088_MM_LOW_G_HYST_POS UINT16_C(0x00)
#define BMI088_MM_LOW_G_DUR_POS UINT16_C(0x00)
#define BMI088_MM_LOW_G_ENABLE_POS UINT16_C(0x0C)
/**\name Mask definitions for orientation feature configuration */
#define BMI088_MM_ORIENT_ENABLE_MASK UINT16_C(0x0001)
#define BMI088_MM_ORIENT_UP_DOWN_MASK UINT16_C(0x0002)
#define BMI088_MM_ORIENT_SYMM_MODE_MASK UINT16_C(0x000C)
#define BMI088_MM_ORIENT_BLOCK_MODE_MASK UINT16_C(0x0030)
#define BMI088_MM_ORIENT_THETA_MASK UINT16_C(0x0FC0)
#define BMI088_MM_ORIENT_HYST_MASK UINT16_C(0x07FF)
#define BMI088_MM_ORIENT_PORTRAIT_LANDSCAPE_MASK UINT8_C(0x03)
#define BMI088_MM_ORIENT_FACEUP_DOWN_MASK UINT8_C(0x04)
/**\name Bit position definitions for orientation feature configuration */
#define BMI088_MM_ORIENT_ENABLE_POS UINT8_C(0x00)
#define BMI088_MM_ORIENT_UP_DOWN_POS UINT8_C(0x01)
#define BMI088_MM_ORIENT_SYMM_MODE_POS UINT8_C(0x02)
#define BMI088_MM_ORIENT_BLOCK_MODE_POS UINT8_C(0x04)
#define BMI088_MM_ORIENT_THETA_POS UINT8_C(0x06)
#define BMI088_MM_ORIENT_HYST_POS UINT8_C(0x00)
#define BMI088_MM_ORIENT_PORTRAIT_LANDSCAPE_POS UINT8_C(0x00)
#define BMI088_MM_ORIENT_FACEUP_DOWN_POS UINT8_C(0x02)
/**\name Macros for orientation feature output */
#define BMI088_MM_ORIENT_PORTRAIT_UPRIGHT UINT8_C(0x00)
#define BMI088_MM_ORIENT_LANDSCAPE_LEFT UINT8_C(0x01)
#define BMI088_MM_ORIENT_PORTRAIT_UPSIDE_DOWN UINT8_C(0x02)
#define BMI088_MM_ORIENT_LANDSCAPE_RIGHT UINT8_C(0x03)
#define BMI088_MM_ORIENT_FACE_UP UINT8_C(0x00)
#define BMI088_MM_ORIENT_FACE_DOWN UINT8_C(0x01)
/**\name Mask definitions for no-motion feature configuration */
#define BMI088_MM_NO_MOTION_THRESHOLD_MASK UINT16_C(0x07FF)
#define BMI088_MM_NO_MOTION_SEL_MASK UINT16_C(0x0800)
#define BMI088_MM_NO_MOTION_DURATION_MASK UINT16_C(0x1FFF)
#define BMI088_MM_NO_MOTION_X_EN_MASK UINT16_C(0x2000)
#define BMI088_MM_NO_MOTION_Y_EN_MASK UINT16_C(0x4000)
#define BMI088_MM_NO_MOTION_Z_EN_MASK UINT16_C(0x8000)
/**\name Bit position definitions for no-motion feature configuration */
#define BMI088_MM_NO_MOTION_THRESHOLD_POS UINT8_C(0)
#define BMI088_MM_NO_MOTION_SEL_POS UINT8_C(11)
#define BMI088_MM_NO_MOTION_DURATION_POS UINT8_C(0)
#define BMI088_MM_NO_MOTION_X_EN_POS UINT8_C(13)
#define BMI088_MM_NO_MOTION_Y_EN_POS UINT8_C(14)
#define BMI088_MM_NO_MOTION_Z_EN_POS UINT8_C(15)
/*********************************************************************/
/*! @name Macro Definitions for Axes re-mapping */
/*********************************************************************/
/**\name Enable/Disable Selections */
#define BMI088_MM_X_AXIS UINT8_C(0)
#define BMI088_MM_Y_AXIS UINT8_C(1)
#define BMI088_MM_Z_AXIS UINT8_C(2)
/**\name Define values of axis and its sign for re-map settings */
#define BMI088_MM_MAP_X_AXIS UINT8_C(0x00)
#define BMI088_MM_MAP_Y_AXIS UINT8_C(0x01)
#define BMI088_MM_MAP_Z_AXIS UINT8_C(0x02)
#define BMI088_MM_MAP_POSITIVE UINT8_C(0x00)
#define BMI088_MM_MAP_NEGATIVE UINT8_C(0x01)
/*! @name Macros for the user-defined values of axes and their polarities */
#define BMI088_MM_X UINT8_C(0x01)
#define BMI088_MM_NEG_X UINT8_C(0x09)
#define BMI088_MM_Y UINT8_C(0x02)
#define BMI088_MM_NEG_Y UINT8_C(0x0A)
#define BMI088_MM_Z UINT8_C(0x04)
#define BMI088_MM_NEG_Z UINT8_C(0x0C)
#define BMI088_MM_AXIS_MASK UINT8_C(0x07)
#define BMI088_MM_AXIS_SIGN UINT8_C(0x08)
/**\name Mask definitions for axes re-mapping */
#define BMI088_MM_X_AXIS_MASK UINT8_C(0x03)
#define BMI088_MM_X_AXIS_SIGN_MASK UINT8_C(0x04)
#define BMI088_MM_Y_AXIS_MASK UINT8_C(0x18)
#define BMI088_MM_Y_AXIS_SIGN_MASK UINT8_C(0x20)
#define BMI088_MM_Z_AXIS_MASK UINT8_C(0xC0)
#define BMI088_MM_Z_AXIS_SIGN_MASK UINT8_C(0x01)
/**\name Bit position for axes re-mapping */
#define BMI088_MM_X_AXIS_SIGN_POS UINT8_C(0x02)
#define BMI088_MM_Y_AXIS_POS UINT8_C(0x03)
#define BMI088_MM_Y_AXIS_SIGN_POS UINT8_C(0x05)
#define BMI088_MM_Z_AXIS_POS UINT8_C(0x06)
/*********************************************************************/
/* Enumerators */
/*********************************************************************/
/*!
* @brief Enum to select accelerometer interrupts
*/
enum bmi088_mm_accel_int_types {
BMI088_MM_ACCEL_DATA_RDY_INT,
/* Accel data ready interrupt */
BMI088_MM_ACCEL_SYNC_DATA_RDY_INT,
/* Accel synchronized data ready interrupt */
BMI088_MM_ACCEL_SYNC_INPUT,
/* Accel FIFO watermark interrupt */
BMI088_MM_ACCEL_INT_FIFO_WM,
/* Accel FIFO full interrupt */
BMI088_MM_ACCEL_INT_FIFO_FULL,
/* Accel anymotion interrupt*/
BMI088_MM_ANYMOTION_INT,
/* Accel high-g interrupt */
BMI088_MM_HIGH_G_INT,
/* Accel low-g interrupt */
BMI088_MM_LOW_G_INT,
/* Accel orient interrupt */
BMI088_MM_ORIENT_INT,
/* Accel no-motion interrupt */
BMI088_MM_NO_MOTION_INT,
/* Accel Error interrupt */
BMI088_MM_ERROR_INT
};
/*********************************************************************/
/* Structures */
/*********************************************************************/
/*!
* @brief Anymotion config structure
*/
struct bmi088_mm_anymotion_cfg
{
/* 11 bit threshold of anymotion detection (threshold = X mg * 2,048 (5.11 format)) */
uint16_t threshold;
/*! Enable any-motion feature */
uint16_t enable;
/*Select ODR for anymotion feature */
uint16_t odr;
/* 13 bit set the duration for any- and nomotion (time = duration * 20ms (@50Hz)) */
uint16_t duration;
/* Enable anymotion detection for x axis */
uint16_t x_en;
/* Enable anymotion detection for y axis */
uint16_t y_en;
/* Enable anymotion detection for z axis */
uint16_t z_en;
};
/*! @name Structure to define high-g configuration */
struct bmi088_mm_high_g_cfg
{
/*! Acceleration threshold */
uint16_t threshold;
/*! Hysteresis */
uint16_t hysteresis;
/*! To select per x-axis */
uint16_t select_x;
/*! To select per y-axis */
uint16_t select_y;
/*! To select per z-axis */
uint16_t select_z;
/*! high-g enable */
uint16_t enable;
/*! Duration interval */
uint16_t duration;
};
/*! @name Structure to define low-g configuration */
struct bmi088_mm_low_g_cfg
{
/*! Acceleration threshold */
uint16_t threshold;
/*! Hysteresis */
uint16_t hysteresis;
/*! Duration interval */
uint16_t duration;
/*! low-g enable */
uint16_t enable;
};
struct bmi088_mm_high_g_out
{
/*! High G detected on x-axis */
uint8_t x;
/*! High G detected on y-axis */
uint8_t y;
/*! High G detected on z-axis */
uint8_t z;
/*! Axis direction on which High G detected */
uint8_t direction;
};
struct bmi088_mm_orient_cfg
{
/*! Upside/down detection */
uint16_t ud_en;
/*! Symmetrical, high or low Symmetrical */
uint16_t mode;
/*! Blocking mode */
uint16_t blocking;
/*! Threshold angle */
uint16_t theta;
/*! Acceleration hysteresis for orientation detection */
uint16_t hysteresis;
/*! Orientation feature enable */
uint16_t enable;
};
struct bmi088_mm_orient_out
{
/*! Orientation portrait landscape */
uint8_t portrait_landscape;
/*! Orientation face-up down */
uint8_t faceup_down;
};
struct bmi088_mm_no_motion_cfg
{
/*! Duration in 50Hz samples(20msec) */
uint16_t duration;
/*! Acceleration slope threshold */
uint16_t threshold;
/*! To select per x-axis */
uint16_t select_x;
/*! To select per y-axis */
uint16_t select_y;
/*! To select per z-axis */
uint16_t select_z;
/*! Enable no-motion feature */
uint16_t enable;
};
/*! @name Structure to store the re-mapped axis */
struct bmi088_mm_remap
{
/*! Re-mapped x-axis */
uint8_t x;
/*! Re-mapped y-axis */
uint8_t y;
/*! Re-mapped z-axis */
uint8_t z;
};
/*********************************************************************/
/* Function prototype declarations */
/*********************** BMI088_MM Accelerometer function prototypes ************************/
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiInit Accel Initialization
* @brief Initialize the accel sensor and device structure
*/
/*!
* \ingroup bmi088_mmaApiInit
* \page bmi088_mma_api_bmi088_mma_init bmi088_mma_init
* \code
* int8_t bmi088_mma_init(struct bmi08_dev *dev);
* \endcode
* @details This API is the entry point for accel sensor.
* It performs the selection of I2C/SPI read mechanism according to the
* selected interface and reads the chip-id of accel sensor.
*
* @param[in,out] dev : Structure instance of bmi08_dev.
* @note : Refer user guide for detailed info.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_init(struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiConfig Configurations
* @brief Setting up configurations
*/
/*!
* \ingroup bmi088_mmaApiConfig
* \page bmi088_mma_api_bmi088_mma_set_meas_conf bmi088_mma_set_meas_conf
* \code
* int8_t bmi088_mma_set_meas_conf(struct bmi08_dev *dev);
* \endcode
* @details This API sets the Output data rate, range and bandwidth
* of accel sensor.
* @param[in] dev : Structure instance of bmi08_dev.
*
* @note : The user must select one among the following macros to
* select range value for BMI09 accel
*
*@verbatim
* config | value
* -------------------------------|---------------------------
* BMI088_MM_ACCEL_RANGE_3G | 0x00
* BMI088_MM_ACCEL_RANGE_6G | 0x01
* BMI088_MM_ACCEL_RANGE_12G | 0x02
* BMI088_MM_ACCEL_RANGE_24G | 0x03
*@endverbatim
*
* @note : Refer user guide for detailed info.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_set_meas_conf(struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiData Accel Data
* @brief Read accel data from the sensor
*/
/*!
* \ingroup bmi088_mmaApiData
* \page bmi088_mma_api_bmi088_mma_get_data bmi088_mma_get_data
* \code
* int8_t bmi088_mma_get_data(struct bmi08_sensor_data *accel, struct bmi08_dev *dev);
* \endcode
* @details This API reads the accel data from the sensor,
* store it in the bmi08_sensor_data structure instance
* passed by the user.
*
* @param[out] accel : Structure pointer to store accel data
* @param[in] dev : Structure instance of bmi08_dev.
*
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_data(struct bmi08_sensor_data *accel, struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiIntConfig Accel Interrupt configurations
* @brief Set accel sensor interrupt configurations
*/
/*!
* \ingroup bmi088_mmaApiIntConfig
* \page bmi088_mma_api_bmi088_mma_set_int_config bmi088_mma_set_int_config
* \code
* int8_t bmi088_mma_set_int_config(const struct bmi08_accel_int_channel_cfg *int_config, enum bmi088_mm_accel_int_types int_type, struct bmi08_dev *dev);
* \endcode
* @details This API configures the necessary accel interrupt
* based on the user settings in the bmi088_mm_accel_int_channel_cfg
* structure instance.
*
* @param[in] int_config : Structure instance of bmi08_accel_int_channel_cfg.
* @param[in] int_type : Enumerator instance of bmi088_mm_accel_int_types.
* @param[in] dev : Structure instance of bmi08_dev.
* @note : Refer user guide for detailed info.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_set_int_config(const struct bmi08_accel_int_channel_cfg *int_config,
enum bmi088_mm_accel_int_types int_type,
struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiSelftest Accel Self test
* @brief Perform self test of accel sensor
*/
/*!
* \ingroup bmi088_mmaApiSelftest
* \page bmi088_mma_api_bmi088_mma_perform_selftest bmi088_mma_perform_selftest
* \code
* int8_t bmi088_mma_perform_selftest(struct bmi08_dev *dev);
* \endcode
* @details This API checks whether the self test functionality of the sensor
* is working or not
*
* @param[in] dev : Structure instance of bmi08_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_perform_selftest(struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiAnymotion Accel Anymotion
* @brief Configure anymotion of sensor
*/
/*!
* \ingroup bmi088_mmaApiAnymotion
* \page bmi088_mma_api_bmi088_mma_configure_anymotion bmi088_mma_configure_anymotion
* \code
* int8_t bmi088_mma_configure_anymotion(struct bmi088_mm_anymotion_cfg anymotion_cfg, struct bmi08_dev *dev);
* \endcode
* @details This API is used to enable/disable and configure the anymotion
* feature.
*
* @param[in] anymotion_cfg : configure anymotion feature
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_configure_anymotion(struct bmi088_mm_anymotion_cfg anymotion_cfg, struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiInt Features
* @brief Set/Get features
*/
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_set_high_g_config bmi088_mma_set_high_g_config
* \code
* int8_t bmi088_mma_set_high_g_config(const struct bmi088_mm_high_g_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API sets high-g configurations like threshold,
* hysteresis and duration.
*
* @param[in] config : Structure to hold low-g settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_set_high_g_config(const struct bmi088_mm_high_g_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_get_high_g_config bmi088_mma_get_high_g_config
* \code
* int8_t bmi088_mma_get_high_g_config(struct bmi088_mm_high_g_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API gets high-g configurations like threshold,
* hysteresis and duration.
*
* @param[in] config : Structure to hold high-g settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_high_g_config(struct bmi088_mm_high_g_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_set_low_g_config bmi088_mma_set_low_g_config
* \code
* int8_t bmi088_mma_set_low_g_config(const struct bmi088_mm_low_g_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API sets low-g configurations like threshold,
* hysteresis and duration.
*
* @param[in] config : Structure to hold low-g settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_set_low_g_config(const struct bmi088_mm_low_g_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_get_low_g_config bmi088_mma_get_low_g_config
* \code
* int8_t bmi088_mma_get_low_g_config(struct bmi088_mm_low_g_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API gets low-g configurations like threshold,
* hysteresis and duration.
*
* @param[in] config : Structure to hold low-g settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_low_g_config(struct bmi088_mm_low_g_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_set_no_motion_config bmi088_mma_set_no_motion_config
* \code
* int8_t bmi088_mma_set_no_motion_config(const struct bmi088_mm_no_motion_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API sets and enables no-motion parameters like threshold,
* duration,etc .,
*
* @param[in] config : Structure to hold no-motion settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_set_no_motion_config(const struct bmi088_mm_no_motion_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_get_no_motion_config bmi088_mma_get_no_motion_config
* \code
* int8_t bmi088_mma_get_no_motion_config(struct bmi088_mm_no_motion_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API gets no-motion parameters like threshold,
* duration,etc .,
*
* @param[in] config : Structure to hold no-motion settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_no_motion_config(struct bmi088_mm_no_motion_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_set_orient_config bmi088_mma_set_orient_config
* \code
* int8_t bmi088_mma_set_orient_config(const struct bmi088_mm_orient_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API sets orientation parameters like mode, hysteresis, theta, etc.,
*
* @param[in] config : Structure to hold orientation feature settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_set_orient_config(const struct bmi088_mm_orient_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_get_orient_config bmi088_mma_get_orient_config
* \code
* int8_t bmi088_mma_get_orient_config(struct bmi088_mm_orient_cfg *config, struct bmi08_dev *dev);
* \endcode
* @details This API gets orientation parameters like mode, hysteresis, theta, etc.,
*
* @param[in] config : Structure to hold orientation feature settings
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_orient_config(struct bmi088_mm_orient_cfg *config, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_get_orient_output bmi088_mma_get_orient_output
* \code
* int8_t bmi088_mma_get_orient_output(struct bmi088_mm_orient_out *orient_out, struct bmi08_dev *dev);
* \endcode
* @details This API gets the output values of orientation: portrait-
* landscape and face up-down.
*
* @param[out] orient_out : Structure instance of bmi088_mm_orient_out
* @param[in] dev : Structure instance of bmi08_dev.
*
*
* portrait |
* landscape | Output
* -----------|------------
* 0x00 | PORTRAIT_UPRIGHT
* 0x01 | LANDSCAPE_LEFT
* 0x02 | PORTRAIT_UPSIDE_DOWN
* 0x03 | LANDSCAPE_RIGHT
*
* Face |
* up-down | Output
* -----------|------------
* 0x00 | FACE_UP
* 0x01 | FACE_DOWN
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_orient_output(struct bmi088_mm_orient_out *orient_out, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_get_high_g_output bmi088_mma_get_high_g_output
* \code
* int8_t bmi088_mma_get_high_g_output(struct bmi088_mm_high_g_out *high_g_out, struct bmi08_dev *dev);
* \endcode
* @details This API gets the output values of high_g: Axis and Direction
*
* @param[out] high_g_out : Structure instance of bmi088_mm_high_g_out
* @param[in] dev : Structure instance of bmi08_dev.
*
* Direction | Output
* -----------|-----------------
* 0x00 | Positive axis
* 0x01 | Negative axis
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_high_g_output(struct bmi088_mm_high_g_out *high_g_out, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiInt
* \page bmi088_mma_api_bmi088_mma_get_feat_int_status bmi088_mma_get_feat_int_status
* \code
* int8_t bmi088_mma_get_feat_int_status(uint8_t *int_status, struct bmi08_dev *dev);
* \endcode
* @details This API is to get accel feature interrupt status
*
* @param[out] int_status : Variable to store interrupt status
* @param[in] dev : Structure instance of bmi08_dev
*
*@verbatim
*-----------------------------------------
* int_status | Interrupt
*-----------------------------------------
* 0x01 | Data sync
* 0x02 | Any-Motion
* 0x04 | High-g
* 0x08 | Low-g
* 0x16 | Orient
* 0x32 | No-motion
*------------------------------------------
*@endverbatim
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bmi088_mma_get_feat_int_status(uint8_t *int_status, struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiRemap Axis Remap
* @brief Functions of axis remapping of bmi09 sensor
*/
/*!
* \ingroup bmi088_mmaApiRemap
* @brief Set / Get x, y and z axis re-mapping in the sensor
* \page bmi088_mma_api_bmi088_mma_set_remap_axes bmi088_mma_set_remap_axes
* \code
* int8_t bmi088_mma_set_remap_axes(const struct bmi088_mm_remap *remapped_axis, struct bmi08_dev *dev);
* \endcode
* @details This API sets the re-mapped x, y and z axes to the sensor and
* updates them in the device structure.
*
* @param[in] remapped_axis : Pointer to store axes re-mapping data.
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status.
*
* @return 0 -> Success
* @return < 0 -> Fail
*
*/
int8_t bmi088_mma_set_remap_axes(const struct bmi088_mm_remap *remapped_axis, struct bmi08_dev *dev);
/*!
* \ingroup bmi088_mmaApiRemap
* \page bmi088_mm_api_bmi088_mma_get_remap_axes bmi088_mma_get_remap_axes
* \code
* int8_t bmi088_mma_get_remap_axes(struct bmi088_mm_remap *remapped_axis, struct bmi08_dev *dev);
* \endcode
* @details This API gets the re-mapped x, y and z axes from the sensor and
* updates the values in the device structure.
*
* @param[out] remapped_axis : Structure instance of bmi088_mm_remap
* @param[in] dev : Structure instance of bmi08_dev
*
* @return Result of API execution status.
*
* @return 0 -> Success
* @return < 0 -> Fail
*
*/
int8_t bmi088_mma_get_remap_axes(struct bmi088_mm_remap *remapped_axis, struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiVersion Major and Minor Revision
* @brief Reads major and minor revision of sensor
*/
/*!
* \ingroup bmi088_mmaApiVersion
* \page bmi088_mm_api_bmi088_mma_get_version_config bmi088_mma_get_version_config
* \code
*int8_t bmi088_mma_get_version_config(uint16_t *config_major, uint16_t *config_minor, struct bmi08_dev *dev);
* \endcode
* @details This API is used to get the config file major and minor information.
*
* @param[in] dev : Structure instance of bmi08_dev.
* @param[out] config_major : Pointer to data buffer to store the config major.
* @param[out] config_minor : Pointer to data buffer to store the config minor.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval >0 -> Warning
* @retval <0 -> Fail
*/
int8_t bmi088_mma_get_version_config(uint16_t *config_major, uint16_t *config_minor, struct bmi08_dev *dev);
/**
* \ingroup bmi088_mm
* \defgroup bmi088_mmaApiSync Data Synchronization
* @brief Enable / Disable data synchronization
*/
/*!
* \ingroup bmi088_mmaApiSync
* \page bmi088_mma_api_bmi088_mma_configure_data_synchronization bmi088_mma_configure_data_synchronization
* \code
* int8_t bmi088_mma_configure_data_synchronization(struct bmi08_data_sync_cfg sync_cfg, struct bmi08_dev *dev);
* \endcode
* @details This API is used to enable/disable the data synchronization
* feature.
*
* @param[in] sync_cfg : Configure sync feature
* @param[in] dev : Structure instance of bmi08_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*
*/
int8_t bmi088_mma_configure_data_synchronization(struct bmi08_data_sync_cfg sync_cfg, struct bmi08_dev *dev);
#ifdef __cplusplus
}
#endif
#endif /* BMI088_MM_H_ */
/** @}*/