Merge branch 'master' of ssh://git.gag.com/scm/git/fw/altos
[fw/altos] / src / drivers / ao_adxl375.c
1 /*
2  * Copyright © 2018 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  */
14
15 #include <ao.h>
16 #include "ao_adxl375.h"
17
18 #define DEBUG_LOW       1
19 #define DEBUG_HIGH      2
20
21 #define DEBUG           0
22
23 #if DEBUG
24 #define PRINTD(l, ...) do { if (DEBUG & (l)) { printf ("\r%5u %s: ", ao_tick_count, __func__); printf(__VA_ARGS__); flush(); } } while(0)
25 #else
26 #define PRINTD(l,...)
27 #endif
28
29 struct ao_adxl375_sample        ao_adxl375_current;
30
31 static void
32 ao_adxl375_start(void) {
33         ao_spi_get_bit(AO_ADXL375_CS_PORT,
34                        AO_ADXL375_CS_PIN,
35                        AO_ADXL375_SPI_INDEX,
36                        AO_ADXL375_SPI_SPEED);
37 }
38
39 static void
40 ao_adxl375_stop(void) {
41         ao_spi_put_bit(AO_ADXL375_CS_PORT,
42                        AO_ADXL375_CS_PIN,
43                        AO_ADXL375_SPI_INDEX);
44 }
45
46 static uint8_t
47 ao_adxl375_reg_read(uint8_t addr)
48 {
49         uint8_t d[2];
50
51         d[0] = addr | AO_ADXL375_READ;
52         ao_adxl375_start();
53         ao_spi_duplex(d, d, 2, AO_ADXL375_SPI_INDEX);
54         ao_adxl375_stop();
55
56         PRINTD(DEBUG_LOW, "read %x = %x\n", addr, d);
57
58         return d[1];
59 }
60
61 static void
62 ao_adxl375_reg_write(uint8_t addr, uint8_t value)
63 {
64         uint8_t d[2];
65
66         PRINTD(DEBUG_LOW, "write %x %x\n", addr, value);
67         d[0] = addr;
68         d[1] = value;
69         ao_adxl375_start();
70         ao_spi_send(d, 2, AO_ADXL375_SPI_INDEX);
71         ao_adxl375_stop();
72
73 #if DEBUG & DEBUG_LOW
74         d[0] = addr | AO_ADXL375_READ
75         d[1] = 0;
76         ao_adxl375_start();
77         ao_spi_duplex(d, d, 2, AO_ADXL375_SPI_INDEX);
78         ao_adxl375_stop();
79         PRINTD(DEBUG_LOW, "readback %x %x\n", d[0], d[1]);
80 #endif
81 }
82
83 static void
84 ao_adxl375_value(struct ao_adxl375_sample *value)
85 {
86         uint8_t d[7];
87
88         d[0] = AO_ADXL375_DATAX0 | AO_ADXL375_READ | AO_ADXL375_MULTI_BYTE;
89         ao_adxl375_start();
90         ao_spi_duplex(d, d, 7, AO_ADXL375_SPI_INDEX);
91         ao_adxl375_stop();
92         memcpy(value, &d[1], 6);
93 }
94
95 struct ao_adxl375_total {
96         int32_t x;
97         int32_t y;
98         int32_t z;
99 };
100
101 #define AO_ADXL375_SELF_TEST_SAMPLES    16
102 #define AO_ADXL375_SELF_TEST_SETTLE     6
103
104 #define MIN_LSB_G       18.4
105 #define MAX_LSB_G       22.6
106 #define SELF_TEST_MIN_G 6.0
107 #define SELF_TEST_MAX_G 6.8
108
109 #define MIN_SELF_TEST   ((int32_t) (MIN_LSB_G * SELF_TEST_MIN_G * AO_ADXL375_SELF_TEST_SAMPLES + 0.5))
110 #define MAX_SELF_TEST   ((int32_t) (MAX_LSB_G * SELF_TEST_MAX_G * AO_ADXL375_SELF_TEST_SAMPLES + 0.5))
111
112 static const int32_t    min_self_test = MIN_SELF_TEST;
113 static const int32_t    max_self_test = MAX_SELF_TEST;
114
115 static void
116 ao_adxl375_total_value(struct ao_adxl375_total *total, int samples)
117 {
118         struct ao_adxl375_sample        value;
119
120         *total = (struct ao_adxl375_total) { 0, 0, 0 };
121         for (int i = 0; i < samples; i++) {
122                 ao_adxl375_value(&value);
123                 total->x += value.x;
124                 total->y += value.y;
125                 total->z += value.z;
126                 ao_delay(AO_MS_TO_TICKS(10));
127         }
128 }
129
130 #define AO_ADXL375_DATA_FORMAT_SETTINGS(self_test) (                    \
131                 AO_ADXL375_DATA_FORMAT_FIXED |                          \
132                 (self_test << AO_ADXL375_DATA_FORMAT_SELF_TEST) |       \
133                 (AO_ADXL375_DATA_FORMAT_SPI_4_WIRE << AO_ADXL375_DATA_FORMAT_SPI_4_WIRE) | \
134                 (0 << AO_ADXL375_DATA_FORMAT_INT_INVERT) |              \
135                 (0 << AO_ADXL375_DATA_FORMAT_JUSTIFY))
136
137 static int32_t  self_test_value;
138
139 static void
140 ao_adxl375_setup(void)
141 {
142         /* Get the device into 4-wire SPI mode before proceeding */
143         ao_adxl375_reg_write(AO_ADXL375_DATA_FORMAT,
144                              AO_ADXL375_DATA_FORMAT_SETTINGS(0));
145
146
147         uint8_t devid = ao_adxl375_reg_read(AO_ADXL375_DEVID);
148         if (devid != AO_ADXL375_DEVID_ID)
149                 ao_sensor_errors = 1;
150
151         /* Set the data rate */
152         ao_adxl375_reg_write(AO_ADXL375_BW_RATE,
153                              (0 << AO_ADXL375_BW_RATE_LOW_POWER) |
154                              (AO_ADXL375_BW_RATE_RATE_200 << AO_ADXL375_BW_RATE_RATE));
155
156         /* Set the offsets all to zero */
157         ao_adxl375_reg_write(AO_ADXL375_OFSX, 0);
158         ao_adxl375_reg_write(AO_ADXL375_OFSY, 0);
159         ao_adxl375_reg_write(AO_ADXL375_OFSZ, 0);
160
161         /* Clear interrupts */
162         ao_adxl375_reg_write(AO_ADXL375_INT_ENABLE, 0);
163
164         /* Configure FIFO (disable) */
165         ao_adxl375_reg_write(AO_ADXL375_FIFO_CTL,
166                              (AO_ADXL375_FIFO_CTL_FIFO_MODE_BYPASS << AO_ADXL375_FIFO_CTL_FIFO_MODE) |
167                              (0 << AO_ADXL375_FIFO_CTL_TRIGGER) |
168                              (0 << AO_ADXL375_FIFO_CTL_SAMPLES));
169
170         /* Place part in measurement mode */
171         ao_adxl375_reg_write(AO_ADXL375_POWER_CTL,
172                              (0 << AO_ADXL375_POWER_CTL_LINK) |
173                              (0 << AO_ADXL375_POWER_CTL_AUTO_SLEEP) |
174                              (1 << AO_ADXL375_POWER_CTL_MEASURE) |
175                              (0 << AO_ADXL375_POWER_CTL_SLEEP) |
176                              (AO_ADXL375_POWER_CTL_WAKEUP_8 << AO_ADXL375_POWER_CTL_WAKEUP));
177
178         (void) ao_adxl375_total_value;
179         /* Perform self-test */
180
181 #define AO_ADXL375_SELF_TEST_SAMPLES    16
182 #define AO_ADXL375_SELF_TEST_SETTLE     6
183
184         struct ao_adxl375_total self_test_off, self_test_on;
185
186         /* Discard some samples to let it settle down */
187         ao_adxl375_total_value(&self_test_off, AO_ADXL375_SELF_TEST_SETTLE);
188
189         /* Get regular values */
190         ao_adxl375_total_value(&self_test_off, AO_ADXL375_SELF_TEST_SAMPLES);
191
192         /* Turn on self test */
193         ao_adxl375_reg_write(AO_ADXL375_DATA_FORMAT,
194                              AO_ADXL375_DATA_FORMAT_SETTINGS(1));
195
196         /* Discard at least 4 samples to let the device settle */
197         ao_adxl375_total_value(&self_test_on, AO_ADXL375_SELF_TEST_SETTLE);
198
199         /* Read self test samples */
200         ao_adxl375_total_value(&self_test_on, AO_ADXL375_SELF_TEST_SAMPLES);
201
202         /* Reset back to normal mode */
203
204         ao_adxl375_reg_write(AO_ADXL375_DATA_FORMAT,
205                              AO_ADXL375_DATA_FORMAT_SETTINGS(0));
206
207         /* Verify Z axis value is in range */
208
209         int32_t z_change = self_test_on.z - self_test_off.z;
210
211         self_test_value = z_change;
212
213         if (z_change < min_self_test || max_self_test < z_change)
214                 ao_sensor_errors = 1;
215
216         /* Discard some samples to let it settle down */
217         ao_adxl375_total_value(&self_test_off, AO_ADXL375_SELF_TEST_SETTLE);
218 }
219
220 static int      adxl375_count;
221
222 static void
223 ao_adxl375(void)
224 {
225         ao_adxl375_setup();
226         for (;;) {
227                 ao_adxl375_value(&ao_adxl375_current);
228                 ++adxl375_count;
229                 ao_arch_critical(
230                         AO_DATA_PRESENT(AO_DATA_ADXL375);
231                         AO_DATA_WAIT();
232                         );
233         }
234 }
235
236 static struct ao_task ao_adxl375_task;
237
238 static void
239 ao_adxl375_dump(void)
240 {
241         printf ("ADXL375 value %d %d %d count %d self test %d min %d max %d\n",
242                 ao_adxl375_current.x,
243                 ao_adxl375_current.y,
244                 ao_adxl375_current.z,
245                 adxl375_count,
246                 self_test_value,
247                 MIN_SELF_TEST,
248                 MAX_SELF_TEST);
249 }
250
251 const struct ao_cmds ao_adxl375_cmds[] = {
252         { ao_adxl375_dump,      "A\0Display ADXL375 data" },
253         { 0, NULL },
254 };
255
256 void
257 ao_adxl375_init(void)
258 {
259         ao_cmd_register(ao_adxl375_cmds);
260         ao_spi_init_cs(AO_ADXL375_CS_PORT, (1 << AO_ADXL375_CS_PIN));
261
262         ao_add_task(&ao_adxl375_task, ao_adxl375, "adxl375");
263 }