e4397fc4a42f55351b2f05451c0a9249165121ea
[fw/altos] / src / drivers / ao_bmx160.c
1 /*
2  * Copyright © 2019 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  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17  */
18
19 #include <ao.h>
20 #include <ao_bmx160.h>
21 #include <ao_exti.h>
22
23 static uint8_t  ao_bmx160_configured;
24
25 #define ao_bmx160_spi_get()     ao_spi_get(AO_BMX160_SPI_BUS, AO_SPI_SPEED_8MHz)
26 #define ao_bmx160_spi_put()     ao_spi_put(AO_BMX160_SPI_BUS)
27
28 #define ao_bmx160_spi_start()   ao_spi_set_cs(AO_BMX160_SPI_CS_PORT,    \
29                                               (1 << AO_BMX160_SPI_CS_PIN))
30
31 #define ao_bmx160_spi_end()     ao_spi_clr_cs(AO_BMX160_SPI_CS_PORT,    \
32                                               (1 << AO_BMX160_SPI_CS_PIN))
33
34 static void
35 _ao_bmx160_reg_write(uint8_t addr, uint8_t value)
36 {
37         uint8_t d[2] = { addr, value };
38         ao_bmx160_spi_start();
39         ao_spi_send(d, 2, AO_BMX160_SPI_BUS);
40         ao_bmx160_spi_end();
41 }
42
43 static void
44 _ao_bmx160_read(uint8_t addr, void *data, uint8_t len)
45 {
46         addr |= 0x80;
47         ao_bmx160_spi_start();
48         ao_spi_send(&addr, 1, AO_BMX160_SPI_BUS);
49         ao_spi_recv(data, len, AO_BMX160_SPI_BUS);
50         ao_bmx160_spi_end();
51 }
52
53 static uint8_t
54 _ao_bmx160_reg_read(uint8_t addr)
55 {
56         uint8_t value;
57         addr |= 0x80;
58         ao_bmx160_spi_start();
59         ao_spi_send(&addr, 1, AO_BMX160_SPI_BUS);
60         ao_spi_recv(&value, 1, AO_BMX160_SPI_BUS);
61         ao_bmx160_spi_end();
62         return value;
63 }
64
65 static void
66 _ao_bmx160_cmd(uint8_t cmd)
67 {
68         _ao_bmx160_reg_write(BMX160_CMD, cmd);
69         ao_delay(AO_MS_TO_TICKS(100));
70 }
71
72 static void
73 _ao_bmx160_mag_setup(void)
74 {
75         _ao_bmx160_reg_write(BMX160_MAG_IF_0, 0x80);
76 }
77
78 static void
79 _ao_bmm150_wait_manual(void)
80 {
81         while (_ao_bmx160_reg_read(BMX160_STATUS) & (1 << BMX160_STATUS_MAG_MAN_OP))
82                 ;
83 }
84
85 static void
86 _ao_bmm150_reg_write(uint8_t addr, uint8_t data)
87 {
88         _ao_bmx160_reg_write(BMX160_MAG_IF_3, data);
89         _ao_bmx160_reg_write(BMX160_MAG_IF_2, addr);
90         _ao_bmm150_wait_manual();
91 }
92
93 #if BMX160_TEST
94 static uint8_t
95 _ao_bmm150_reg_read(uint8_t addr)
96 {
97         _ao_bmx160_reg_write(BMX160_MAG_IF_1, addr);
98         _ao_bmm150_wait_manual();
99         return _ao_bmx160_reg_read(BMX160_DATA_0);
100 }
101 #endif
102
103 static void
104 _ao_bmx160_sample(struct ao_bmx160_sample *sample)
105 {
106         _ao_bmx160_read(BMX160_MAG_X_0_7, sample, sizeof (*sample));
107 #if __BYTE_ORDER != __LITTLE_ENDIAN
108         int             i = sizeof (*sample) / 2;
109         uint16_t        *d = (uint16_t *) sample;
110
111         /* byte swap */
112         while (i--) {
113                 uint16_t        t = *d;
114                 *d++ = (t >> 8) | (t << 8);
115         }
116 #endif
117 }
118
119 #define G       981     /* in cm/s² */
120
121 #if 0
122 static int16_t /* cm/s² */
123 ao_bmx160_accel(int16_t v)
124 {
125         return (int16_t) ((v * (int32_t) (16.0 * 980.665 + 0.5)) / 32767);
126 }
127
128 static int16_t  /* deg*10/s */
129 ao_bmx160_gyro(int16_t v)
130 {
131         return (int16_t) ((v * (int32_t) 20000) / 32767);
132 }
133
134 static uint8_t
135 ao_bmx160_accel_check(int16_t normal, int16_t test)
136 {
137         int16_t diff = test - normal;
138
139         if (diff < BMX160_ST_ACCEL(16) / 4) {
140                 return 1;
141         }
142         if (diff > BMX160_ST_ACCEL(16) * 4) {
143                 return 1;
144         }
145         return 0;
146 }
147
148 static uint8_t
149 ao_bmx160_gyro_check(int16_t normal, int16_t test)
150 {
151         int16_t diff = test - normal;
152
153         if (diff < 0)
154                 diff = -diff;
155         if (diff < BMX160_ST_GYRO(2000) / 4) {
156                 return 1;
157         }
158         if (diff > BMX160_ST_GYRO(2000) * 4) {
159                 return 1;
160         }
161         return 0;
162 }
163 #endif
164
165 static void
166 _ao_bmx160_wait_alive(void)
167 {
168         uint8_t i;
169
170         /* Wait for the chip to wake up */
171         for (i = 0; i < 30; i++) {
172                 ao_delay(AO_MS_TO_TICKS(100));
173                 if (_ao_bmx160_reg_read(BMX160_CHIPID) == BMX160_CHIPID_BMX160)
174                         break;
175         }
176         if (i == 30)
177                 ao_panic(AO_PANIC_SELF_TEST_BMX160);
178 }
179
180 #define ST_TRIES        10
181 #define MAG_TRIES       10
182
183 static void
184 _ao_bmx160_setup(void)
185 {
186         int r;
187
188         if (ao_bmx160_configured)
189                 return;
190
191         /* Make sure the chip is responding */
192         _ao_bmx160_wait_alive();
193
194         /* Force SPI mode */
195         _ao_bmx160_reg_write(BMX160_NV_CONF, 1 << BMX160_NV_CONF_SPI_EN);
196
197         /* Enable acc and gyr
198          */
199
200         _ao_bmx160_cmd(BMX160_CMD_ACC_SET_PMU_MODE(BMX160_PMU_STATUS_ACC_PMU_STATUS_NORMAL));
201         _ao_bmx160_cmd(BMX160_CMD_GYR_SET_PMU_MODE(BMX160_PMU_STATUS_GYR_PMU_STATUS_NORMAL));
202
203         /* Configure accelerometer:
204          *
205          *      undersampling disabled
206          *      normal filter
207          *      200Hz sampling rate
208          *      16g range
209          *
210          * This yields a 3dB cutoff frequency of 80Hz
211          */
212         _ao_bmx160_reg_write(BMX160_ACC_CONF,
213                              (0 << BMX160_ACC_CONF_ACC_US) |
214                              (BMX160_ACC_CONF_ACC_BWP_NORMAL << BMX160_ACC_CONF_ACC_BWP) |
215                              (BMX160_ACC_CONF_ACC_ODR_200 << BMX160_ACC_CONF_ACC_ODR));
216         _ao_bmx160_reg_write(BMX160_ACC_RANGE,
217                              BMX160_ACC_RANGE_16G);
218         for (r = 0x4; r <= 0x17; r++)
219                 (void) _ao_bmx160_reg_read(r);
220
221         /* Configure gyro:
222          *
223          *      200Hz sampling rate
224          *      Normal filter mode
225          *      ±2000°/s
226          */
227         _ao_bmx160_reg_write(BMX160_GYR_CONF,
228                              (BMX160_GYR_CONF_GYR_BWP_NORMAL << BMX160_GYR_CONF_GYR_BWP) |
229                              (BMX160_GYR_CONF_GYR_ODR_200 << BMX160_GYR_CONF_GYR_ODR));
230         _ao_bmx160_reg_write(BMX160_GYR_RANGE,
231                              BMX160_GYR_RANGE_2000);
232
233
234         /* Configure magnetometer:
235          *
236          *      30Hz sampling rate
237          *      power on
238          *      axes enabled
239          */
240         _ao_bmx160_cmd(BMX160_CMD_MAG_IF_SET_PMU_MODE(BMX160_PMU_STATUS_MAG_IF_PMU_STATUS_NORMAL));
241
242         /* Enter setup mode */
243         _ao_bmx160_mag_setup();
244
245         /* Place in suspend mode to reboot the chip */
246         _ao_bmm150_reg_write(BMM150_POWER_MODE,
247                              (0 << BMM150_POWER_MODE_POWER_CONTROL));
248
249         /* Power on */
250         _ao_bmm150_reg_write(BMM150_POWER_MODE,
251                              (1 << BMM150_POWER_MODE_POWER_CONTROL));
252
253         /* Set data rate and place in sleep mode */
254         _ao_bmm150_reg_write(BMM150_CONTROL,
255                              (BMM150_CONTROL_DATA_RATE_30 << BMM150_CONTROL_DATA_RATE) |
256                              (BMM150_CONTROL_OP_MODE_SLEEP << BMM150_CONTROL_OP_MODE));
257
258         /* enable all axes (should already be enabled) */
259         _ao_bmm150_reg_write(BMM150_INT_CONF,
260                              (0 << BMM150_INT_CONF_X_DISABLE) |
261                              (0 << BMM150_INT_CONF_Y_DISABLE) |
262                              (0 << BMM150_INT_CONF_Z_DISABLE));
263
264         /* Set repetition values (?) */
265         _ao_bmm150_reg_write(BMM150_REPXY, BMM150_REPXY_VALUE(9));
266         _ao_bmm150_reg_write(BMM150_REPZ, BMM150_REPZ_VALUE(15));
267
268         /* To get data out of the magnetometer, set the control op mode to 'forced', then read
269          * from the data registers
270          */
271         _ao_bmx160_reg_write(BMX160_MAG_IF_3, (BMM150_CONTROL_OP_MODE_FORCED << BMM150_CONTROL_OP_MODE));
272         _ao_bmx160_reg_write(BMX160_MAG_IF_2, BMM150_CONTROL);
273         _ao_bmx160_reg_write(BMX160_MAG_IF_1, BMM150_DATA_X_0_4);
274
275         /* Set data rate to 200Hz */
276         _ao_bmx160_reg_write(BMX160_MAG_CONF,
277                              (BMX160_MAG_CONF_MAG_ODR_200 << BMX160_MAG_CONF_MAG_ODR));
278
279         /* Put magnetometer interface back into 'normal mode'
280          */
281         _ao_bmx160_reg_write(BMX160_MAG_IF_0,
282                              (0 << BMX160_MAG_IF_0_MAG_MANUAL_EN) |
283                              (0 << BMX160_MAG_IF_0_MAG_OFFSET) |
284                              (0 << BMX160_MAG_IF_0_MAG_RD_BURST));
285
286         ao_bmx160_configured = 1;
287 }
288
289 struct ao_bmx160_sample ao_bmx160_current;
290
291 static void
292 ao_bmx160(void)
293 {
294         struct ao_bmx160_sample sample;
295
296         /* ao_bmx160_init already grabbed the SPI bus and mutex */
297         _ao_bmx160_setup();
298         ao_bmx160_spi_put();
299         for (;;)
300         {
301                 ao_bmx160_spi_get();
302                 _ao_bmx160_sample(&sample);
303                 ao_bmx160_spi_put();
304                 ao_arch_block_interrupts();
305                 ao_bmx160_current = sample;
306                 AO_DATA_PRESENT(AO_DATA_BMX160);
307                 AO_DATA_WAIT();
308                 ao_arch_release_interrupts();
309         }
310 }
311
312 static struct ao_task ao_bmx160_task;
313
314 static void
315 ao_bmx160_show(void)
316 {
317         printf ("Accel: %7d %7d %7d Gyro: %7d %7d %7d Mag: %7d %7d %7d\n",
318                 ao_bmx160_current.acc_x,
319                 ao_bmx160_current.acc_y,
320                 ao_bmx160_current.acc_z,
321                 ao_bmx160_current.gyr_x,
322                 ao_bmx160_current.gyr_y,
323                 ao_bmx160_current.gyr_z,
324                 ao_bmx160_current.mag_x,
325                 ao_bmx160_current.mag_y,
326                 ao_bmx160_current.mag_z);
327 }
328
329 #if BMX160_TEST
330
331 static void
332 ao_bmx160_read(void)
333 {
334         uint8_t addr;
335         uint8_t val;
336
337         addr = ao_cmd_hex();
338         if (ao_cmd_status != ao_cmd_success)
339                 return;
340         ao_bmx160_spi_get();
341         val = _ao_bmx160_reg_read(addr);
342         ao_bmx160_spi_put();
343         printf("Addr %02x val %02x\n", addr, val);
344 }
345
346 static void
347 ao_bmx160_write(void)
348 {
349         uint8_t addr;
350         uint8_t val;
351
352         addr = ao_cmd_hex();
353         if (ao_cmd_status != ao_cmd_success)
354                 return;
355         val = ao_cmd_hex();
356         if (ao_cmd_status != ao_cmd_success)
357                 return;
358         printf("Addr %02x val %02x\n", addr, val);
359         ao_bmx160_spi_get();
360         _ao_bmx160_reg_write(addr, val);
361         ao_bmx160_spi_put();
362 }
363
364 static void
365 ao_bmm150_read(void)
366 {
367         uint8_t addr;
368         uint8_t val;
369
370         addr = ao_cmd_hex();
371         if (ao_cmd_status != ao_cmd_success)
372                 return;
373         ao_bmx160_spi_get();
374         val = _ao_bmm150_reg_read(addr);
375         ao_bmx160_spi_put();
376         printf("Addr %02x val %02x\n", addr, val);
377 }
378
379 static void
380 ao_bmm150_write(void)
381 {
382         uint8_t addr;
383         uint8_t val;
384
385         addr = ao_cmd_hex();
386         if (ao_cmd_status != ao_cmd_success)
387                 return;
388         val = ao_cmd_hex();
389         if (ao_cmd_status != ao_cmd_success)
390                 return;
391         printf("Addr %02x val %02x\n", addr, val);
392         ao_bmx160_spi_get();
393         _ao_bmm150_reg_write(addr, val);
394         ao_bmx160_spi_put();
395 }
396
397 #endif /* BMX160_TEST */
398
399 static const struct ao_cmds ao_bmx160_cmds[] = {
400         { ao_bmx160_show,       "I\0Show BMX160 status" },
401 #if BMX160_TEST
402         { ao_bmx160_read,       "R <addr>\0Read BMX160 register" },
403         { ao_bmx160_write,      "W <addr> <val>\0Write BMX160 register" },
404         { ao_bmm150_read,       "M <addr>\0Read BMM150 register" },
405         { ao_bmm150_write,      "N <addr> <val>\0Write BMM150 register" },
406 #endif
407         { 0, NULL }
408 };
409
410 void
411 ao_bmx160_init(void)
412 {
413         ao_add_task(&ao_bmx160_task, ao_bmx160, "bmx160");
414
415         ao_spi_init_cs(AO_BMX160_SPI_CS_PORT, (1 << AO_BMX160_SPI_CS_PIN));
416
417         /* Pretend to be the bmx160 task. Grab the SPI bus right away and
418          * hold it for the task so that nothing else uses the SPI bus before
419          * we get the I2C mode disabled in the chip
420          */
421
422         ao_cur_task = &ao_bmx160_task;
423         ao_bmx160_spi_get();
424         ao_cur_task = NULL;
425         ao_cmd_register(&ao_bmx160_cmds[0]);
426 }