Blame view

RIOT/drivers/include/lis3dh.h 25.7 KB
a752c7ab   elopes   add first test an...
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
  /*
   * Copyright (C) 2015 Eistec AB
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    drivers_lis3dh LIS3DH accelerometer
   * @ingroup     drivers_sensors
   * @brief       Device driver for the LIS3DH accelerometer
   * @{
   *
   * @file
   * @brief       Device driver interface for the LIS3DH accelerometer
   *
   *
   * @author      Joakim Nohlgård <joakim.nohlgard@eistec.se>
   */
  
  #ifndef LIS3DH_H
  #define LIS3DH_H
  
  #include <stdint.h>
  
  #include "periph/spi.h"
  #include "periph/gpio.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Identifier register value
   *
   * The WHO_AM_I register should contain this value in order to correctly
   * identify the chip.
   */
  #define LIS3DH_WHO_AM_I_RESPONSE                 (0x33)
  
  /**
   * @name    LIS3DH hardware register addresses
   * @{
   */
  #define LIS3DH_REG_STATUS_AUX                    (0x07)
  #define LIS3DH_REG_OUT_AUX_ADC1_L                (0x08)
  #define LIS3DH_REG_OUT_AUX_ADC1_H                (0x09)
  #define LIS3DH_REG_OUT_AUX_ADC2_L                (0x0A)
  #define LIS3DH_REG_OUT_AUX_ADC2_H                (0x0B)
  #define LIS3DH_REG_OUT_AUX_ADC3_L                (0x0C)
  #define LIS3DH_REG_OUT_AUX_ADC3_H                (0x0D)
  #define LIS3DH_REG_INT_COUNTER_REG               (0x0E)
  #define LIS3DH_REG_WHO_AM_I                      (0x0F)
  #define LIS3DH_REG_TEMP_CFG_REG                  (0x1F)
  #define LIS3DH_REG_CTRL_REG1                     (0x20)
  #define LIS3DH_REG_CTRL_REG2                     (0x21)
  #define LIS3DH_REG_CTRL_REG3                     (0x22)
  #define LIS3DH_REG_CTRL_REG4                     (0x23)
  #define LIS3DH_REG_CTRL_REG5                     (0x24)
  #define LIS3DH_REG_CTRL_REG6                     (0x25)
  #define LIS3DH_REG_REFERENCE                     (0x26)
  #define LIS3DH_REG_STATUS_REG                    (0x27)
  #define LIS3DH_REG_OUT_X_L                       (0x28)
  #define LIS3DH_REG_OUT_X_H                       (0x29)
  #define LIS3DH_REG_OUT_Y_L                       (0x2A)
  #define LIS3DH_REG_OUT_Y_H                       (0x2B)
  #define LIS3DH_REG_OUT_Z_L                       (0x2C)
  #define LIS3DH_REG_OUT_Z_H                       (0x2D)
  #define LIS3DH_REG_FIFO_CTRL_REG                 (0x2E)
  #define LIS3DH_REG_FIFO_SRC_REG                  (0x2F)
  #define LIS3DH_REG_INT1_CFG                      (0x30)
  #define LIS3DH_REG_INT1_SOURCE                   (0x31)
  #define LIS3DH_REG_INT1_THS                      (0x32)
  #define LIS3DH_REG_INT1_DURATION                 (0x33)
  #define LIS3DH_REG_CLICK_CFG                     (0x38)
  #define LIS3DH_REG_CLICK_SRC                     (0x39)
  #define LIS3DH_REG_CLICK_THS                     (0x3A)
  #define LIS3DH_REG_TIME_LIMIT                    (0x3B)
  #define LIS3DH_REG_TIME_LATENCY                  (0x3C)
  #define LIS3DH_REG_TIME_WINDOW                   (0x3D)
  /** @} */
  
  /*
   * Bit offsets within the individual registers
   * source: LIS3DH datasheet
   */
  
  /**
   * @name    TEMP_CFG_REG bitfield macros
   * @{
   */
  /**
   * @brief   ADC enable
   *
   * Default value: 0
   *
   * 0: ADC disabled; 1: ADC enabled
   */
  #define LIS3DH_TEMP_CFG_REG_ADC_PD_MASK          (1 << 7)
  /**
   * @brief   Temperature sensor (T) enable.
   *
   * Default value: 0
   *
   * 0: T disabled; 1: T enabled
   */
  #define LIS3DH_TEMP_CFG_REG_TEMP_EN_MASK         (1 << 6)
  /** @} */ /* TEMP_CFG_REG bitfield macros */
  
  /**
   * @name    CTRL_REG1 bitfield macros
   * @{
   */
  /**
   * @brief    ODR global shift
   */
  #define LIS3DH_CTRL_REG1_ODR_SHIFT               (4)
  /**
   * @brief    ODR fourth bit mask
   */
  #define LIS3DH_CTRL_REG1_ODR3_MASK               (1 << (LIS3DH_CTRL_REG1_ODR_SHIFT + 3))
  /**
   * @brief    ODR third bit mask
   */
  #define LIS3DH_CTRL_REG1_ODR2_MASK               (1 << (LIS3DH_CTRL_REG1_ODR_SHIFT + 2))
  /**
   * @brief    ODR second bit mask
   */
  #define LIS3DH_CTRL_REG1_ODR1_MASK               (1 << (LIS3DH_CTRL_REG1_ODR_SHIFT + 1))
  /**
   * @brief   ODR first bit mask
   */
  #define LIS3DH_CTRL_REG1_ODR0_MASK               (1 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   Output data rate (ODR) selection bitfield
   *
   * Default value: 0000
   *
   * 0000: Power down; Others: Refer to data sheet
   *
   * @see LIS3DH data sheet Table 25, Data rate configuration
   */
  #define LIS3DH_CTRL_REG1_ODR_MASK                (LIS3DH_CTRL_REG1_ODR3_MASK | \
                                                    LIS3DH_CTRL_REG1_ODR2_MASK | \
                                                    LIS3DH_CTRL_REG1_ODR1_MASK | \
                                                    LIS3DH_CTRL_REG1_ODR0_MASK)
  /**
   * @brief   Low power mode enable.
   *
   * Default value: 0
   *
   *  0. normal mode
   *  1. low power mode
   */
  #define LIS3DH_CTRL_REG1_LPEN_MASK               (1 << 3)
  /**
   * @brief   Z enable bit offset
   */
  #define LIS3DH_CTRL_REG1_ZEN_SHIFT               (2)
  /**
   * @brief   Z axis enable.
   *
   * Default value: 1
   *
   *  0. Z axis disabled
   *  1. Z axis enabled
   */
  #define LIS3DH_CTRL_REG1_ZEN_MASK                (1 << LIS3DH_CTRL_REG1_ZEN_SHIFT)
  /**
   * @brief   Y enable bit offset
   */
  #define LIS3DH_CTRL_REG1_YEN_SHIFT               (1)
  /**
   * @brief   Y axis enable.
   *
   * Default value: 1
   *
   *  0. Y axis disabled
   *  1. Y axis enabled
   */
  #define LIS3DH_CTRL_REG1_YEN_MASK                (1 << LIS3DH_CTRL_REG1_YEN_SHIFT)
  /**
   * @brief   X enable bit offset
   */
  #define LIS3DH_CTRL_REG1_XEN_SHIFT               (0)
  /**
   * @brief   X axis enable.
   *
   * Default value: 1
   *
   *  0. X axis disabled
   *  1. X axis enabled
   */
  #define LIS3DH_CTRL_REG1_XEN_MASK                (1 << LIS3DH_CTRL_REG1_XEN_SHIFT)
  /**
   * @brief   XYZ enable bitfield offset
   */
  #define LIS3DH_CTRL_REG1_XYZEN_SHIFT             (0)
  /**
   * @brief   X, Y, Z enable bitfield mask
   */
  #define LIS3DH_CTRL_REG1_XYZEN_MASK              (LIS3DH_CTRL_REG1_XEN_MASK | \
                                                    LIS3DH_CTRL_REG1_YEN_MASK | LIS3DH_CTRL_REG1_ZEN_MASK)
  
  /**
   * @brief    enable X axis (Use when calling lis3dh_set_axes())
   */
  #define LIS3DH_AXES_X                            (LIS3DH_CTRL_REG1_XEN_MASK)
  /**
   * @brief   enable Y axis (Use when calling lis3dh_set_axes())
   */
  #define LIS3DH_AXES_Y                            (LIS3DH_CTRL_REG1_YEN_MASK)
  /**
   * @brief   enable Z axis (Use when calling lis3dh_set_axes())
   */
  #define LIS3DH_AXES_Z                            (LIS3DH_CTRL_REG1_ZEN_MASK)
  /** @} */  /* CTRL_REG1 bitfield macros */
  
  /**
   * @brief   Convenience macro for enabling all axes.
   */
  #define LIS3DH_AXES_XYZ (LIS3DH_CTRL_REG1_XYZEN_MASK)
  
  /**
   * @name    CTRL_REG2 bitfield macros
   * @{
   */
  /**
   * @brief   High pass filter mode selection second bit
   *
   * Default value: 0
   *
   * @see Refer to Table 29, "High pass filter mode configuration"
   */
  #define LIS3DH_CTRL_REG2_HPM1_MASK               (1 << 7)
  /**
   * @brief   High pass filter mode selection first bit
   *
   * Default value: 0
   *
   * @see Refer to Table 29, "High pass filter mode configuration"
   */
  #define LIS3DH_CTRL_REG2_HPM0_MASK               (1 << 6)
  /**
   * @brief   High pass filter cut off frequency selection second bit
   */
  #define LIS3DH_CTRL_REG2_HPCF2_MASK              (1 << 5)
  /**
   * @brief   High pass filter cut off frequency selection second bit
   */
  #define LIS3DH_CTRL_REG2_HPCF1_MASK              (1 << 4)
  /**
   * @brief   Filtered data selection
   *
   * Default value: 0
   *
   *  0. internal filter bypassed
   *  1. data from internal filter sent to output register and FIFO
   */
  #define LIS3DH_CTRL_REG2_FDS_MASK                (1 << 3)
  /**
   * @brief   High pass filter enabled for CLICK function.
   *
   *  0. filter bypassed
   *  1. filter enabled
   */
  #define LIS3DH_CTRL_REG2_HPCLICK_MASK            (1 << 2)
  /**
   * @brief   High pass filter enabled for AOI function on interrupt 2, second bit
   *
   *  0. filter bypassed
   *  1. filter enabled
   */
  #define LIS3DH_CTRL_REG2_HPIS2_MASK              (1 << 1)
  /**
   * @brief   High pass filter enabled for AOI function on interrupt 2, first bit
   *
   *  0. filter bypassed
   *  1. filter enabled
   */
  #define LIS3DH_CTRL_REG2_HPIS1_MASK              (1 << 0)
  /** @} */ /* CTRL_REG2 bitfield macros */
  
  /**
   * @name    CTRL_REG3 bitfield macros
   * @{
   */
  /**
   * @brief   CLICK interrupt on INT1
   *
   * Default value 0.
   *
   *  0. Disable
   *  1. Enable
   */
  #define LIS3DH_CTRL_REG3_I1_CLICK_MASK           (1 << 7)
  /**
   * @brief   AOI1 interrupt on INT1
   *
   * Default value 0.
   *
   *  0. Disable
   *  1. Enable
   */
  #define LIS3DH_CTRL_REG3_I1_AOI1_MASK            (1 << 6)
  /**
   * @brief   AOI2 interrupt on INT1.
   *
   * Default value 0.
   *
   *  0. Disable
   *  1. Enable
   */
  #define LIS3DH_CTRL_REG3_I1_AOI2_MASK            (1 << 5)
  /**
   * @brief   DRDY1 interrupt on INT1
   *
   * Default value 0.
   *
   *  0. Disable
   *  1. Enable
   */
  #define LIS3DH_CTRL_REG3_I1_DRDY1_MASK           (1 << 4)
  /**
   * @brief   DRDY2 interrupt on INT1
   *
   * Default value 0.
   *
   *  0. Disable
   *  1. Enable
   */
  #define LIS3DH_CTRL_REG3_I1_DRDY2_MASK           (1 << 3)
  /**
   * @brief   FIFO Watermark interrupt on INT1
   *
   * Default value 0.
   *
   *  0. Disable
   *  1. Enable
   */
  #define LIS3DH_CTRL_REG3_I1_WTM_MASK             (1 << 2)
  /**
   * @brief   FIFO Overrun interrupt on INT1
   *
   * Default value 0.
   *
   *  0. Disable
   *  1. Enable
   */
  #define LIS3DH_CTRL_REG3_I1_OVERRUN_MASK         (1 << 1)
  /** @} */ /* CTRL_REG3 bitfield macros */
  
  /**
   * @name CTRL_REG4 bitfield macros
   * @{
   */
  /**
   * @brief   Block data update (BDU) bit mask
   *
   * Default value of BDU: 0
   *
   *  0. continuous update
   *  1. output registers not updated until MSB and LSB reading
   */
  #define LIS3DH_CTRL_REG4_BDU_MASK                (1 << 7)
  /**
   * @brief   Block data update (BDU) enable
   */
  #define LIS3DH_CTRL_REG4_BDU_ENABLE              (LIS3DH_CTRL_REG4_BDU_MASK)
  /**
   * @brief    Block data update (BDU) disable
   */
  #define LIS3DH_CTRL_REG4_BDU_DISABLE             (0)
  /**
   * @brief   Big/little endian bit mask
   *
   * Default value of BLE: 0.
   *
   *  0. Data LSB @ lower address
   *  1. Data MSB @ lower address
   */
  #define LIS3DH_CTRL_REG4_BLE_MASK                (1 << 6)
  /**
   * @brief   Big/little endian little endian mode
   */
  #define LIS3DH_CTRL_REG4_BLE_LITTLE_ENDIAN       (0)
  /**
   * @brief   Big/little endian big endian mode
   */
  #define LIS3DH_CTRL_REG4_BLE_BIG_ENDIAN          (LIS3DH_CTRL_REG4_BLE_MASK)
  /**
   * @brief   Full scale selection mask second bit
   */
  #define LIS3DH_CTRL_REG4_FS1_MASK                (1 << 5)
  /**
   * @brief   Full scale selection mask first bit
   */
  #define LIS3DH_CTRL_REG4_FS0_MASK                (1 << 4)
  /**
   * @brief   Full scale selection mask
   */
  #define LIS3DH_CTRL_REG4_FS_MASK                 (LIS3DH_CTRL_REG4_FS1_MASK | \
                                                    LIS3DH_CTRL_REG4_FS0_MASK)
  /**
   * @brief   Scale register value: +/- 2G
   */
  #define LIS3DH_CTRL_REG4_SCALE_2G                (0)
  /**
   * @brief   Scale register value: +/- 4G
   */
  #define LIS3DH_CTRL_REG4_SCALE_4G                (LIS3DH_CTRL_REG4_FS0_MASK)
  /**
   * @brief   Scale register value: +/- 8G
   */
  #define LIS3DH_CTRL_REG4_SCALE_8G                (LIS3DH_CTRL_REG4_FS1_MASK)
  /**
   * @brief   Scale: +/- 16G
   */
  #define LIS3DH_CTRL_REG4_SCALE_16G               (LIS3DH_CTRL_REG4_FS1_MASK | LIS3DH_CTRL_REG4_FS0_MASK)
  /**
   * @brief   High resolution output mode
   *
   * Default value: 0
   *
   *  0. High resolution disable
   *  1. High resolution enable
   */
  #define LIS3DH_CTRL_REG4_HR_MASK                 (1 << 3)
  /**
   * @brief   Self test enable second bit mask
   *
   * Default value of self test: 00
   *
   *  - 00: Self test disabled
   *  - Other: See Table 34
   *
   * @see Table 34
   */
  #define LIS3DH_CTRL_REG4_ST1_MASK                (1 << 2)
  /**
   * @brief   Self test enable first bit mask
   */
  #define LIS3DH_CTRL_REG4_ST0_MASK                (1 << 1)
  /**
   * @brief   SPI serial interface mode selection
   *
   * Default value: 0
   *
   *  0. 4-wire interface
   *  1. 3-wire interface
   */
  #define LIS3DH_CTRL_REG4_SIM_MASK                (1 << 0)
  /**
   * @brief   Reboot memory content
   *
   * Default value: 0
   *
   *  0. normal mode
   *  1. reboot memory content
   */
  #define LIS3DH_CTRL_REG5_REBOOT_MASK             (1 << 7)
  /**
   * @brief   FIFO enable
   *
   * Default value: 0
   *
   *  0. FIFO disable
   *  1. FIFO enable
   */
  #define LIS3DH_CTRL_REG5_FIFO_EN_MASK            (1 << 6)
  /**
   * @brief   Latch interrupt request on INT1
   *
   * Latch interrupt request on INT1_SRC register, with INT1_SRC register
   * cleared by reading INT1_SRC itself.
   *
   * Default value: 0
   *
   *  0. interrupt request not latched
   *  1. interrupt request latched
   */
  #define LIS3DH_CTRL_REG5_LIR_I1_MASK             (1 << 3)
  /**
   * @brief   4D enable
   *
   * 4D detection is enabled on INT1 when 6D bit on INT1_CFG is set to 1.
   */
  #define LIS3DH_CTRL_REG5_D4D_I1_MASK             (1 << 2)
  /** @} */ /* CTRL_REG4 bitfield macros */
  
  /**
   * @name    STATUS_REG bitfield macros
   * @{
   */
  /**
   * @brief   X, Y or Z axis data overrun
   *
   * Default value: 0
   *
   *  0. no overrun has occurred
   *  1. a new set of data has overwritten the previous ones
   */
  #define LIS3DH_STATUS_REG_ZYXOR_MASK             (1 << 7)
  /**
   * @brief   Z axis data overrun
   *
   * Default value: 0
   *
   *  0. no overrun has occurred
   *  1. a new data for the Z-axis has overwritten the previous one
   */
  #define LIS3DH_STATUS_REG_ZOR_MASK               (1 << 6)
  /**
   * @brief   Y axis data overrun
   *
   * Default value: 0
   *
   *  0. no overrun has occurred
   *  1. a new data for the Y-axis has overwritten the previous one
   */
  #define LIS3DH_STATUS_REG_YOR_MASK               (1 << 5)
  /**
   * @brief   X axis data overrun
   *
   * Default value: 0
   *
   *  0. no overrun has occurred
   *  1. a new data for the X-axis has overwritten the previous one
   */
  #define LIS3DH_STATUS_REG_XOR_MASK               (1 << 4)
  /**
   * @brief   X, Y or Z axis new data available
   *
   * Default value: 0
   *
   *  0. a new set of data is not yet available
   *  1. a new set of data is available
   */
  #define LIS3DH_STATUS_REG_ZYXDA_MASK             (1 << 3)
  /**
   * @brief   Z axis new data available
   *
   * Default value: 0
   *
   *  0. a new data for the Z-axis is not yet available
   *  1. a new data for the Z-axis is available
   */
  #define LIS3DH_STATUS_REG_ZDA_MASK               (1 << 2)
  /**
   * @brief   Y axis new data available
   *
   * Default value: 0
   *
   *  0. a new data for the Y-axis is not yet available
   *  1. a new data for the Y-axis is available
   */
  #define LIS3DH_STATUS_REG_YDA_MASK               (1 << 1)
  /**
   * @brief   X axis new data available
   *
   * Default value: 0
   *
   *  0. a new data for the X-axis is not yet available
   *  1. a new data for the X-axis is available
   */
  #define LIS3DH_STATUS_REG_XDA_MASK               (1 << 0)
  /** @} */ /* STATUS_REG bitfield macros */
  
  /**
   * @name    FIFO_CTRL_REG bitfield macros
   * @{
   */
  #define LIS3DH_FIFO_CTRL_REG_FM_SHIFT            (6)
  #define LIS3DH_FIFO_CTRL_REG_FM1_MASK            (1 << 7)
  #define LIS3DH_FIFO_CTRL_REG_FM0_MASK            (1 << 6)
  #define LIS3DH_FIFO_CTRL_REG_FM_MASK             (LIS3DH_FIFO_CTRL_REG_FM1_MASK | \
                                                    LIS3DH_FIFO_CTRL_REG_FM0_MASK)
  #define LIS3DH_FIFO_CTRL_REG_TR_MASK             (1 << 5)
  #define LIS3DH_FIFO_CTRL_REG_FTH4_MASK           (1 << 4)
  #define LIS3DH_FIFO_CTRL_REG_FTH3_MASK           (1 << 3)
  #define LIS3DH_FIFO_CTRL_REG_FTH2_MASK           (1 << 2)
  #define LIS3DH_FIFO_CTRL_REG_FTH1_MASK           (1 << 1)
  #define LIS3DH_FIFO_CTRL_REG_FTH0_MASK           (1 << 0)
  #define LIS3DH_FIFO_CTRL_REG_FTH_SHIFT           (0)
  #define LIS3DH_FIFO_CTRL_REG_FTH_MASK            (LIS3DH_FIFO_CTRL_REG_FTH0_MASK | \
                                                    LIS3DH_FIFO_CTRL_REG_FTH1_MASK | \
                                                    LIS3DH_FIFO_CTRL_REG_FTH2_MASK | \
                                                    LIS3DH_FIFO_CTRL_REG_FTH3_MASK | \
                                                    LIS3DH_FIFO_CTRL_REG_FTH4_MASK)
  /** @} */ /* FIFO_CTRL_REG bitfield macros */
  
  /**
   * @name    FIFO_SRC_REG bitfield macros
   * @{
   */
  #define LIS3DH_FIFO_SRC_REG_WTM_MASK             (1 << 7)
  #define LIS3DH_FIFO_SRC_REG_OVRN_FIFO_MASK       (1 << 6)
  #define LIS3DH_FIFO_SRC_REG_EMPTY_MASK           (1 << 5)
  #define LIS3DH_FIFO_SRC_REG_FSS4_MASK            (1 << 4)
  #define LIS3DH_FIFO_SRC_REG_FSS3_MASK            (1 << 3)
  #define LIS3DH_FIFO_SRC_REG_FSS2_MASK            (1 << 2)
  #define LIS3DH_FIFO_SRC_REG_FSS1_MASK            (1 << 1)
  #define LIS3DH_FIFO_SRC_REG_FSS0_MASK            (1 << 0)
  #define LIS3DH_FIFO_SRC_REG_FSS_SHIFT            (0)
  #define LIS3DH_FIFO_SRC_REG_FSS_MASK             (LIS3DH_FIFO_SRC_REG_FSS0_MASK | \
                                                    LIS3DH_FIFO_SRC_REG_FSS1_MASK | \
                                                    LIS3DH_FIFO_SRC_REG_FSS2_MASK | \
                                                    LIS3DH_FIFO_SRC_REG_FSS3_MASK | \
                                                    LIS3DH_FIFO_SRC_REG_FSS4_MASK)
  /** @} */ /* FIFO_CTRL_REG bitfield macros */
  
  /**
   * @name    Register address bitfield macros
   * @{
   */
  /**
   * @brief   Write to register
   */
  #define LIS3DH_SPI_WRITE_MASK                    (0 << 7)
  /**
   * @brief   The READ bit must be set when reading
   */
  #define LIS3DH_SPI_READ_MASK                     (1 << 7)
  /**
   * @brief   Multi byte transfers must assert this bit when writing the address.
   */
  #define LIS3DH_SPI_MULTI_MASK                    (1 << 6)
  /**
   * @brief   Opposite of LIS3DH_SPI_MULTI_MASK.
   */
  #define LIS3DH_SPI_SINGLE_MASK                   (0 << 6)
  /**
   * @brief   Mask of the address bits in the address byte during transfers.
   */
  #define LIS3DH_SPI_ADDRESS_MASK                  (0x3F)
  /** @} */ /* Register address bitfield macros */
  
  /**
   * @brief   Length of scalar measurement data in bytes.
   */
  #define LIS3DH_ADC_DATA_SIZE                     (2U)
  
  /**
   * @name    FIFO modes.
   *
   * Used when calling lis3dh_set_fifo()
   * @{
   */
  /**
   * @brief   FIFO mode: Bypass
   */
  #define LIS3DH_FIFO_MODE_BYPASS                  (0x00 << LIS3DH_FIFO_CTRL_REG_FM_SHIFT)
  /**
   * @brief   FIFO mode: FIFO
   */
  #define LIS3DH_FIFO_MODE_FIFO                    (0x01 << LIS3DH_FIFO_CTRL_REG_FM_SHIFT)
  /**
   * @brief   FIFO mode: Stream
   */
  #define LIS3DH_FIFO_MODE_STREAM                  (0x02 << LIS3DH_FIFO_CTRL_REG_FM_SHIFT)
  /**
   * @brief   FIFO mode: Stream to FIFO
   */
  #define LIS3DH_FIFO_MODE_STREAM_TO_FIFO          (0x03 << LIS3DH_FIFO_CTRL_REG_FM_SHIFT)
  /** @} */
  
  /**
   * @name    Output Data Rates (ODR) macros
   *
   * Use these when calling lis3dh_set_odr(odr).
   * @{
   */
  /**
   * @brief    Powerdown mode
   */
  #define LIS3DH_ODR_POWERDOWN                     (0x00 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   1Hz mode
   */
  #define LIS3DH_ODR_1Hz                           (0x01 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   10Hz mode
   */
  #define LIS3DH_ODR_10Hz                          (0x02 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   25Hz mode
   */
  #define LIS3DH_ODR_25Hz                          (0x03 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   50Hz mode
   */
  #define LIS3DH_ODR_50Hz                          (0x04 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   100Hz mode
   */
  #define LIS3DH_ODR_100Hz                         (0x05 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   200Hz mode
   */
  #define LIS3DH_ODR_200Hz                         (0x06 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   400Hz mode
   */
  #define LIS3DH_ODR_400Hz                         (0x07 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   Low power 1600Hz mode
   */
  #define LIS3DH_ODR_LP1600Hz                      (0x08 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   Normal mode 1250 Hz
   * @note    Normal mode 1250 Hz and Low power mode 5000 Hz share the same setting
   */
  #define LIS3DH_ODR_NP1250Hz                      (0x09 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /**
   * @brief   Low power mode 5000 Hz
   * @note    Normal mode 1250 Hz and Low power mode 5000 Hz share the same setting
   */
  #define LIS3DH_ODR_LP5000HZ                      (0x09 << LIS3DH_CTRL_REG1_ODR_SHIFT)
  /** @} */
  
  /**
   * @brief   Configuration parameters for LIS3DH devices
   */
  typedef struct {
      spi_t spi;              /**< SPI device the sensor is connected to */
      spi_clk_t clk;          /**< designated clock speed of the SPI bus */
      gpio_t cs;              /**< Chip select pin */
      gpio_t int1;            /**< INT1 pin */
      gpio_t int2;            /**< INT2 (DRDY) pin */
      uint8_t scale;          /**< Default sensor scale: 2, 4, 8, or 16 (G) */
      uint8_t odr;            /**< Default sensor ODR setting: LIS3DH_ODR_xxxHz */
  } lis3dh_params_t;
  
  /**
   * @brief   Device descriptor for LIS3DH sensors
   */
  typedef struct {
      spi_t spi;              /**< SPI device the sensor is connected to */
      spi_clk_t clk;          /**< clock speed of the SPI bus */
      gpio_t cs;              /**< Chip select pin */
      int16_t scale;          /**< Current scale setting of the sensor */
  } lis3dh_t;
  
  /**
   * @brief   Result vector for accelerometer measurement
   */
  typedef struct __attribute__((packed))
  {
      int16_t acc_x;          /**< Acceleration in the X direction in milli-G */
      int16_t acc_y;          /**< Acceleration in the Y direction in milli-G */
      int16_t acc_z;          /**< Acceleration in the Z direction in milli-G */
  } lis3dh_data_t;
  
  /**
   * @brief   Initialize a LIS3DH sensor instance
   *
   * @param[in]  dev          Device descriptor of sensor to initialize
   * @param[in]  params       Configuration parameters
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_init(lis3dh_t *dev, const lis3dh_params_t *params);
  
  /**
   * @brief   Read 3D acceleration data from the accelerometer
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[out] acc_data     Accelerometer data output buffer
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_read_xyz(const lis3dh_t *dev, lis3dh_data_t *acc_data);
  
  /**
   * @brief   Read auxiliary ADC channel 1 data from the accelerometer
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[out] out          The value of ADC1 (OUT_1_{L,H}) will be written to this buffer
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_read_aux_adc1(const lis3dh_t *dev, int16_t *out);
  
  /**
   * @brief   Read auxiliary ADC channel 2 data from the accelerometer
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[out] out          The value of ADC2 (OUT_2_{L,H}) will be written to this buffer
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_read_aux_adc2(const lis3dh_t *dev, int16_t *out);
  
  /**
   * @brief   Read auxiliary ADC channel 3 data from the accelerometer
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[out] out          The value of ADC3 (OUT_3_{L,H}) will be written to this buffer
   *
   * @note The internal temperature sensor is connected to the third channel on
   *       the auxiliary ADC when the TEMP_EN bit of TEMP_CFG_REG is set.
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_read_aux_adc3(const lis3dh_t *dev, int16_t *out);
  
  /**
   * @brief   Turn on/off power to the auxiliary ADC in LIS3DH.
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[in]  enable       Power state of the auxiliary ADC
   * @param[in]  temperature  If not zero, switch the ADC mux so that a
   *                          temperature reading is available on OUT_3_L, OUT_3_H.
   *
   * @note This ADC is only used for the temperature reading and the external ADC
   *       pins. The accelerometer ADC is turned on by lis3dh_set_odr().
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_set_aux_adc(const lis3dh_t *dev, const uint8_t enable, const uint8_t temperature);
  
  /**
   * @brief   Enable/disable accelerometer axes.
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[in]  axes         An OR-ed combination of LIS3DH_AXES_X,
   *                          LIS3DH_AXES_Y, LIS3DH_AXES_Z.
   *
   * @note The macro LIS3DH_AXES_XYZ is a convenience shortcut to enable all axes.
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_set_axes(const lis3dh_t *dev, const uint8_t axes);
  
  /**
   * @brief   Enable/disable the FIFO.
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[in]  mode         FIFO mode, see data sheet for details.
   * @param[in]  watermark    Watermark level for FIFO level interrupts
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_set_fifo(const lis3dh_t *dev, const uint8_t mode, const uint8_t watermark);
  
  /**
   * @brief   Set the output data rate of the sensor.
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[in]  odr          Chosen output data rate.
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_set_odr(const lis3dh_t *dev, const uint8_t odr);
  
  /**
   * @brief   Set the full scale range of the sensor.
   *
   * Valid values for scale are 2, 4, 8, 16 and represents the full range of the
   * sensor.
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[in]  scale        The chosen sensitivity scale.
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_set_scale(lis3dh_t *dev, const uint8_t scale);
  
  /**
   * @brief   Set INT1 pin function
   *
   * Set the bits of CTRL_REG3 for choosing sources for the INT1 pin.
   *
   * @param[in]  dev          Device descriptor of sensor
   * @param[in]  mode         CTRL_REG3 value, see data sheet for details.
   *
   * @return                  0 on success
   * @return                  -1 on error
   */
  int lis3dh_set_int1(const lis3dh_t *dev, const uint8_t mode);
  
  /**
   * @brief   Get the current number of elements in the FIFO
   *
   * @param[in]  dev          Device descriptor of sensor
   *
   * @return                  number of elements in device FIFO on success
   * @return                  -1 on error
   */
  int lis3dh_get_fifo_level(const lis3dh_t *dev);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* LIS3DH_H */
  /** @} */