-
Notifications
You must be signed in to change notification settings - Fork 0
/
bma5.h
1079 lines (1019 loc) · 36.5 KB
/
bma5.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
996
997
998
999
1000
/**
* 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 bma5.h
* @date 2024-07-29
* @version v4.2.0
*
*/
#ifndef _BMA5_H
#define _BMA5_H
/*! CPP guard */
#ifdef __cplusplus
extern "C" {
#endif
/******************************************************************************/
/****************************** Header files **********************************/
/******************************************************************************/
#include "bma5_defs.h"
/******************************************************************************/
/********************** Function prototype declarations ***********************/
/******************************************************************************/
/**
* \ingroup bma5
* \defgroup bma5ApiRegs BMA5 Registers
* @brief Set / Get data from the given register address of the sensor
*/
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_set_regs bma5_set_regs
* \code
* int8_t bma5_set_regs(uint8_t addr, const uint8_t *data, uint32_t len, struct bma5_dev *dev);
* \endcode
* @details This API writes data to the given register address of bma5
* sensor.
*
* @param[in] addr : Register address to which the data is written.
* @param[in] data : Pointer to data buffer in which data to be written is stored.
* @param[in] len : No. of bytes of data to be written.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_regs(uint8_t addr, const uint8_t *data, uint32_t len, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_regs bma5_get_regs
* \code
* int8_t bma5_get_regs(uint8_t addr, uint8_t *data, uint32_t len, struct bma5_dev *dev);
* \endcode
* @details This API reads the data from the given register address of bma5
* sensor.
*
* @param[in] addr : Register address from which data is read.
* @param[out] data : Pointer to data buffer where read data is stored.
* @param[in] len : No. of bytes of data to be read.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_regs(uint8_t addr, uint8_t *data, uint32_t len, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_health_status bma5_get_health_status
* \code
* int8_t bma5_get_health_status(uint8_t *sensor_health_status, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the This register contains internal health status information
*
* @param[out] sensor_health_status : The value 0xF indicate a good internal health state.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_health_status(uint8_t *sensor_health_status, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_cmd_suspend bma5_get_cmd_suspend
* \code
* int8_t bma5_get_cmd_suspend(uint8_t *suspend, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Command register to activate suspend mode.
*
* @param[out] suspend : Write '1' to activate suspend mode. The register content prior to entering this power mode will NOT be lost.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_cmd_suspend(uint8_t *suspend, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_cmd_suspend bma5_get_cmd_suspend
* \code
* int8_t bma5_set_cmd_suspend(const uint8_t suspend, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Command register to activate suspend mode.
*
* @param[in] suspend : Write '1' to activate suspend mode. The register content prior to entering this power mode will NOT be lost.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_cmd_suspend(const uint8_t suspend, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_config_status bma5_get_config_status
* \code
* int8_t bma5_get_config_status(struct bma5_config_status *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Global error flags
*
* @param[out] config : Structure instance of bma5_config_status
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_config_status(struct bma5_config_status *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_config_status bma5_get_config_status
* \code
* int8_t bma5_set_config_status(const struct bma5_config_status *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Global error flags
*
* @param[in] config : Structure instance of bma5_config_status
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_config_status(const struct bma5_config_status *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_sensor_status bma5_get_sensor_status
* \code
* int8_t bma5_get_sensor_status(struct bma5_sensor_status *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Global status flags
*
* @param[out] config : Structure instance of bma5_sensor_status
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_sensor_status(struct bma5_sensor_status *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_sensor_status bma5_get_sensor_status
* \code
* int8_t bma5_set_sensor_status(const struct bma5_sensor_status *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Global status flags
*
* @param[in] config : Structure instance of bma5_sensor_status
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_sensor_status(const struct bma5_sensor_status *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_temp_data bma5_get_temp_data
* \code
* int8_t bma5_get_temp_data(uint8_t *temp_data, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Temperature data register
*
* @param[out] temp_data : Calculated temperature. Resolution: 1 K/LSB. The value 0 represents 23°C.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_temp_data(uint8_t *temp_data, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_fifo_data_out bma5_get_fifo_data_out
* \code
* int8_t bma5_get_fifo_data_out(uint8_t *fifo_data_out, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the FIFO data register
*
* @param[out] fifo_data_out : Output of the FIFO. During burst reads on this address
* the address increment stops and the FIFO can be read out with help of the burst read.
* The type of data stored in the FIFO depends on configuration stored in FIFO_CONF_* registers.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_fifo_data_out(uint8_t *fifo_data_out, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_acc_conf_0 bma5_get_acc_conf_0
* \code
* int8_t bma5_get_acc_conf_0(uint8_t *sensor_ctrl, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Accelerometer configuration register 0
*
* @param[out] sensor_ctrl : This bit enables/disables the accelerometer and the temperature sensor.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_acc_conf_0(uint8_t *sensor_ctrl, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_acc_conf_0 bma5_get_acc_conf_0
* \code
* int8_t bma5_set_acc_conf_0(const uint8_t sensor_ctrl, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Accelerometer configuration register 0
*
* @param[in] sensor_ctrl : This bit enables/disables the accelerometer and the temperature sensor.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_acc_conf_0(const uint8_t sensor_ctrl, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_acc_conf bma5_get_acc_conf
* \code
* int8_t bma5_get_acc_conf(struct bma5_acc_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Accelerometer configuration register
*
* @param[out] config : Structure instance of bma5_acc_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_acc_conf(struct bma5_acc_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_set_acc_conf bma5_get_acc_conf
* \code
* int8_t bma5_set_acc_conf(const struct bma5_acc_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Accelerometer configuration register
*
* @param[in] config : Structure instance of bma5_acc_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_acc_conf(const struct bma5_acc_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_temp_conf bma5_get_temp_conf
* \code
* int8_t bma5_get_temp_conf(struct bma5_temp_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Temperature Sensor configuration register
*
* @param[out] config : Structure instance of bma5_temp_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_temp_conf(struct bma5_temp_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_temp_conf bma5_get_temp_conf
* \code
* int8_t bma5_set_temp_conf(const struct bma5_temp_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Temperature Sensor configuration register
*
* @param[in] config : Structure instance of bma5_temp_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_temp_conf(const struct bma5_temp_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_int_conf bma5_get_int_conf
* \code
* int8_t bma5_get_int_conf(struct bma5_int_conf_types *config, uint8_t int_configs, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Configuration register for INT2
*
* @param[out] config : Structure instance of bma5_int_conf
* @param[in] int_configs : Number of interrupts configurations to get.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_int_conf(struct bma5_int_conf_types *config, uint8_t int_configs, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_int_conf bma5_get_int_conf
* \code
* int8_t bma5_set_int_conf(const struct bma5_int_conf_types *config, uint8_t int_configs, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Configuration register for INT2
*
* @param[in] config : Structure instance of bma5_int_conf
* @param[in] int_configs : Number of interrupts configurations to set.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_int_conf(const struct bma5_int_conf_types *config, uint8_t int_configs, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_if_conf_0 bma5_get_if_conf_0
* \code
* int8_t bma5_get_if_conf_0(uint8_t *if_i2c_slv_addr, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Serial interface settings
*
* @param[out] if_i2c_slv_addr : I2C slave address of this device.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_if_conf_0(uint8_t *if_i2c_slv_addr, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_if_conf bma5_get_if_conf
* \code
* int8_t bma5_get_if_conf(struct bma5_if_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Serial interface settings
*
* @param[out] config : Structure instance of bma5_if_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_if_conf(struct bma5_if_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_if_conf bma5_get_if_conf
* \code
* int8_t bma5_set_if_conf(const struct bma5_if_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Serial interface settings
*
* @param[in] config : Structure instance of bma5_if_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_if_conf(const struct bma5_if_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_fifo_ctrl bma5_get_fifo_ctrl
* \code
* int8_t bma5_set_fifo_ctrl(const struct bma5_fifo_ctrl *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the FIFO control register
*
* @param[in] config : Structure instance of bma5_fifo_ctrl
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_fifo_ctrl(const struct bma5_fifo_ctrl *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_fifo_conf bma5_get_fifo_conf
* \code
* int8_t bma5_get_fifo_conf(struct bma5_fifo_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the FIFO configuration register
*
* @param[out] config : Structure instance of bma5_fifo_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_fifo_conf(struct bma5_fifo_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_fifo_conf bma5_get_fifo_conf
* \code
* int8_t bma5_set_fifo_conf(const struct bma5_fifo_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the FIFO configuration register
*
* @param[in] config : Structure instance of bma5_fifo_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_fifo_conf(const struct bma5_fifo_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feat_eng_conf bma5_get_feat_eng_conf
* \code
* int8_t bma5_get_feat_eng_conf(uint8_t *feat_eng_ctrl, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the feature engine ('feat_eng') configuration register
*
* @param[out] feat_eng_ctrl : An enable/disable switch for the feature engine. The feature engine is internally reseted, once the engine is disabled and the enabled again.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_feat_eng_conf(uint8_t *feat_eng_ctrl, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feat_eng_conf bma5_get_feat_eng_conf
* \code
* int8_t bma5_set_feat_eng_conf(const uint8_t feat_eng_ctrl, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the feature engine ('feat_eng') configuration register
*
* @param[in] feat_eng_ctrl : An enable/disable switch for the feature engine. The feature engine is internally reseted, once the engine is disabled and the enabled again.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_feat_eng_conf(const uint8_t feat_eng_ctrl, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feat_eng_status bma5_get_feat_eng_status
* \code
* int8_t bma5_get_feat_eng_status(struct bma5_feat_eng_status *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the feature engine ('feat_eng') status register
*
* @param[out] config : Structure instance of bma5_feat_eng_status
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_feat_eng_status(struct bma5_feat_eng_status *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feat_eng_gpr_conf bma5_get_feat_eng_gpr_conf
* \code
* int8_t bma5_get_feat_eng_gpr_conf(struct bma5_feat_eng_gpr_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the feature engine ('feat_eng') general purpose register configuration register
*
* @param[out] config : Structure instance of bma5_feat_eng_gpr_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_feat_eng_gpr_conf(struct bma5_feat_eng_gpr_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feat_eng_gpr_conf bma5_get_feat_eng_gpr_conf
* \code
* int8_t bma5_set_feat_eng_gpr_conf(const struct bma5_feat_eng_gpr_conf *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the feature engine ('feat_eng') general purpose register configuration register
*
* @param[in] config : Structure instance of bma5_feat_eng_gpr_conf
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_feat_eng_gpr_conf(const struct bma5_feat_eng_gpr_conf *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feat_eng_gpr_ctrl bma5_get_feat_eng_gpr_ctrl
* \code
* int8_t bma5_set_feat_eng_gpr_ctrl(const struct bma5_feat_eng_gpr_ctrl *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the feature engine ('feat_eng') general purpose register control register
*
* @param[in] config : Structure instance of bma5_feat_eng_gpr_ctrl
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_feat_eng_gpr_ctrl(const struct bma5_feat_eng_gpr_ctrl *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feature_data_addr bma5_get_feature_data_addr
* \code
* int8_t bma5_get_feature_data_addr(uint8_t *feature_data_addr, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the feature engine ('feat_eng') feature data start address
*
* @param[out] feature_data_addr : Feature data address. For the address values see the extended memory map.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_feature_data_addr(uint8_t *feature_data_addr, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feature_data_addr bma5_get_feature_data_addr
* \code
* int8_t bma5_set_feature_data_addr(const uint8_t feature_data_addr, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the feature engine ('feat_eng') feature data start address
*
* @param[in] feature_data_addr : Feature data address. For the address values see the extended memory map.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_feature_data_addr(const uint8_t feature_data_addr, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feature_data_tx bma5_get_feature_data_tx
* \code
* int8_t bma5_get_feature_data_tx(uint8_t *feature_data, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the feature engine ('feat_eng') feature data
*
* @param[out] feature_data : The data port associated with feature_data_addr.
* During burst read/write operations on this address
* the address increment stops and the burst operation can be used to
* read/write multiple feature_data words. See the extendend memory map for details.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_feature_data_tx(uint8_t *feature_data, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_feature_data_tx bma5_get_feature_data_tx
* \code
* int8_t bma5_set_feature_data_tx(const uint8_t feature_data, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the feature engine ('feat_eng') feature data
*
* @param[in] feature_data : The data port associated with feature_data_addr.
* During burst read/write operations on this address
* the address increment stops and the burst operation can be used to
* read/write multiple feature_data words. See the extendend memory map for details.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_feature_data_tx(const uint8_t feature_data, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_acc_self_test bma5_get_acc_self_test
* \code
* int8_t bma5_get_acc_self_test(struct bma5_acc_self_test *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the Select NORMAL/SELF_TEST mode and test data. If you write to this register, the ACC data path is reset.
*
* @param[out] config : Structure instance of bma5_acc_self_test
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_acc_self_test(struct bma5_acc_self_test *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_acc_self_test bma5_get_acc_self_test
* \code
* int8_t bma5_set_acc_self_test(const struct bma5_acc_self_test *config, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Select NORMAL/SELF_TEST mode and test data. If you write to this register, the ACC data path is reset.
*
* @param[in] config : Structure instance of bma5_acc_self_test
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_acc_self_test(const struct bma5_acc_self_test *config, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_cmd bma5_get_cmd
* \code
* int8_t bma5_set_cmd(const uint8_t cmd, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the Command Register
*
* @param[in] cmd : Available commands (Note: Register will always read as 0x00):
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_cmd(const uint8_t cmd, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_acc bma5_get_acc
* \code
* int8_t bma5_get_acc(struct bma5_accel *accel, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the acceleration data
*
* @param[out] acc : acceleration data.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_acc(struct bma5_accel *accel, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_sensor_time bma5_get_sensor_time
* \code
* int8_t bma5_get_sensor_time(uint32_t *sensor_time, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the the sensor time
*
* @param[out] sensor_time : the sensor time
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_sensor_time(uint32_t *sensor_time, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_fifo_fill_level bma5_get_fifo_fill_level
* \code
* int8_t bma5_get_fifo_fill_level(uint16_t *fifo_fill_level, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the FIFO fill level
*
* @param[out] fifo_fill_level : FIFO fill level
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_fifo_fill_level(uint16_t *fifo_fill_level, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_fifo_wm bma5_get_fifo_wm
* \code
* int8_t bma5_get_fifo_wm(uint16_t *fifo_wm, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the FIFO watermark level
*
* @param[out] fifo_wm : FIFO watermark level
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_fifo_wm(uint16_t *fifo_wm, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_set_fifo_wm bma5_set_fifo_wm
* \code
* int8_t bma5_set_fifo_wm(uint16_t fifo_wm, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to set the FIFO watermark level
*
* @param[in] fifo_wm : FIFO watermark level
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_fifo_wm(uint16_t fifo_wm, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_set_acc_doff bma5_set_acc_doff
* \code
* int8_t bma5_set_acc_doff(struct bma5_accel_doff *accel_doff, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the acceleration doff data
*
* @param[out] accel_doff : acceleration doff data.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_set_acc_doff(const struct bma5_accel_doff *accel_doff, struct bma5_dev *dev);
/*!
* \ingroup bma5ApiRegs
* \page bma5_api_bma5_get_acc_doff bma5_get_acc_doff
* \code
* int8_t bma5_get_acc_doff(struct bma5_accel_doff *accel_doff, struct bma5_dev *dev);
* \endcode
* @details This API carries the provision to get the acceleration doff data
*
* @param[out] accel_doff : acceleration doff data.
* @param[in] dev : Structure instance of bma5_dev.
*
* @return Result of API execution status
*
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_get_acc_doff(struct bma5_accel_doff *accel_doff, struct bma5_dev *dev);
/**
* \ingroup bma5
* \defgroup bma5Apist BMA5 Self-Test
* @brief Self-Test APIs
*/
/*!
* \ingroup bma5Apist
* \page bma5_api_bma5_activate_self_test bma5_activate_self_test
* \code
* int8_t bma5_activate_self_test(struct bma5_dev *dev);
* \endcode
* @details This API is to activate self-test procedure
*
* @param[in,out] dev : Structure instance of bma5_dev
*
* @return Result of API execution status.
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_activate_self_test(struct bma5_dev *dev);
/*!
* \ingroup bma5Apist
* \page bma5_api_bma5_self_test_pos_excitation bma5_self_test_pos_excitation
* \code
* int8_t bma5_self_test_pos_excitation(struct bma5_dev *dev);
* \endcode
* @details This API is to perform self-test procedure with positive excitation
*
* @param[in,out] dev : Structure instance of bma5_dev
*
* @return Result of API execution status.
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_self_test_pos_excitation(struct bma5_dev *dev);
/*!
* \ingroup bma5Apist
* \page bma5_api_bma5_self_test_neg_excitation bma5_self_test_neg_excitation
* \code
* int8_t bma5_self_test_neg_excitation(struct bma5_dev *dev);
* \endcode
* @details This API is to perform self-test procedure with negative excitation
*
* @param[in,out] dev : Structure instance of bma5_dev
*
* @return Result of API execution status.
* @retval = 0 -> Success
* @retval > 0 -> Warning
* @retval < 0 -> Error
*/
int8_t bma5_self_test_neg_excitation(struct bma5_dev *dev);
/**
* \ingroup bma5
* \defgroup bma5FIFOApiRegs BMA5 FIFO
* @brief APIs for FIFO
*/
/*!
* \ingroup bma5FIFOApiRegs
* \page bma5_api_bma5_read_fifo_data bma5_read_fifo_data
* \code
* int8_t bma5_read_fifo_data(struct bma5_fifo_frame *fifo, const struct bma5_fifo_conf *fifo_conf,