git.gag.com Git - fw/altos/blob - src/drivers/ao_mmc5983.c

   1 /*
   2  * Copyright © 2021 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_mmc5983.h>
  21 #include <ao_exti.h>
  22
  23 #if HAS_MMC5983
  24
  25 #define DEBUG_MMC5983   0
  26
  27 struct ao_mmc5983_sample        ao_mmc5983_current;
  28 static struct ao_mmc5983_sample ao_mmc5983_offset;
  29
  30 static uint8_t  ao_mmc5983_configured;
  31
  32 #ifdef MMC5983_I2C
  33 #ifdef AO_MMC5983_I2C_INDEX
  34
  35 static void
  36 ao_mmc5983_start(void) {
  37         ao_i2c_get(AO_MMC5983_I2C_INDEX);
  38 }
  39
  40 static void
  41 ao_mmc5983_stop(void) {
  42         ao_i2c_put(AO_MMC5983_I2C_INDEX);
  43 }
  44
  45 static void
  46 ao_mmc5983_reg_write(uint8_t addr, uint8_t data)
  47 {
  48         uint8_t d[2];
  49
  50         d[0] = addr;
  51         d[1] = data;
  52
  53         ao_mmc5983_start();
  54         ao_i2c_start(AO_MMC5983_I2C_INDEX, MMC5983_I2C_ADDR);
  55         ao_i2c_send(d, 2, AO_MMC5983_I2C_INDEX, true);
  56         ao_mmc5983_stop();
  57 }
  58
  59 static uint8_t
  60 ao_mmc5983_reg_read(uint8_t addr)
  61 {
  62         uint8_t d[1];
  63
  64         ao_mmc5983_start();
  65         ao_i2c_start(AO_MMC5983_I2C_INDEX, MMC5983_I2C_ADDR);
  66         d[0] = addr;
  67         ao_i2c_send(d, 1, AO_MMC5983_I2C_INDEX, false);
  68         ao_i2c_start(AO_MMC5983_I2C_INDEX, MMC5983_I2C_ADDR | 1);
  69         ao_i2c_recv(d, 1, AO_MMC5983_I2C_INDEX, true);
  70         ao_mmc5983_stop();
  71         return d[0];
  72 }
  73
  74 static void
  75 ao_mmc5983_raw(struct ao_mmc5983_raw *raw)
  76 {
  77         ao_mmc5983_start();
  78         ao_i2c_start(AO_MMC5983_I2C_INDEX, MMC5983_I2C_ADDR);
  79         raw->addr = MMC5983_X_OUT_0;
  80         ao_i2c_send(&(raw->addr), 1, AO_MMC5983_I2C_INDEX, false);
  81         ao_i2c_start(AO_MMC5983_I2C_INDEX, MMC5983_I2C_ADDR | 1);
  82         ao_i2c_recv(&(raw->x0), sizeof(*raw) - 1, AO_MMC5983_I2C_INDEX, true);
  83         ao_mmc5983_stop();
  84 }
  85
  86 #else
  87 #include <ao_i2c_bit.h>
  88
  89 static void
  90 ao_mmc5983_reg_write(uint8_t addr, uint8_t data)
  91 {
  92         uint8_t d[2];
  93
  94         d[0] = addr;
  95         d[1] = data;
  96
  97         ao_i2c_bit_start(MMC5983_I2C_ADDR);
  98         ao_i2c_bit_send(d, 2);
  99         ao_i2c_bit_stop();
 100 }
 101
 102 static uint8_t
 103 ao_mmc5983_reg_read(uint8_t addr)
 104 {
 105         uint8_t d[1];
 106
 107         ao_i2c_bit_start(MMC5983_I2C_ADDR);
 108         d[0] = addr;
 109         ao_i2c_bit_send(d, 1);
 110         ao_i2c_bit_restart(MMC5983_I2C_ADDR | 1);
 111         ao_i2c_bit_recv(d, 1);
 112         ao_i2c_bit_stop();
 113         return d[0];
 114 }
 115
 116 static void
 117 ao_mmc5983_raw(struct ao_mmc5983_raw *raw)
 118 {
 119         ao_i2c_bit_start(MMC5983_I2C_ADDR);
 120         raw->addr = MMC5983_X_OUT_0;
 121         ao_i2c_bit_send(&(raw->addr), 1);
 122         ao_i2c_bit_restart(MMC5983_I2C_ADDR | 1);
 123         ao_i2c_bit_recv(&(raw->x0), sizeof(*raw) - 1);
 124         ao_i2c_bit_stop();
 125 }
 126
 127 #endif
 128
 129 #else
 130 #define AO_MMC5983_SPI_SPEED    ao_spi_speed(AO_MMC5983_SPI_INDEX, 2000000)
 131
 132 static void
 133 ao_mmc5983_start(void) {
 134         ao_spi_get_bit(AO_MMC5983_SPI_CS_PORT,
 135                        AO_MMC5983_SPI_CS_PIN,
 136                        AO_MMC5983_SPI_INDEX,
 137                        AO_MMC5983_SPI_SPEED);
 138 }
 139
 140 static void
 141 ao_mmc5983_stop(void) {
 142         ao_spi_put_bit(AO_MMC5983_SPI_CS_PORT,
 143                        AO_MMC5983_SPI_CS_PIN,
 144                        AO_MMC5983_SPI_INDEX);
 145 }
 146
 147
 148 static void
 149 ao_mmc5983_reg_write(uint8_t addr, uint8_t data)
 150 {
 151         uint8_t d[2];
 152
 153         d[0] = addr;
 154         d[1] = data;
 155         ao_mmc5983_start();
 156         ao_spi_send(d, 2, AO_MMC5983_SPI_INDEX);
 157         ao_mmc5983_stop();
 158 }
 159
 160 static uint8_t
 161 ao_mmc5983_reg_read(uint8_t addr)
 162 {
 163         uint8_t d[2];
 164
 165         d[0] = addr | MMC5983_READ;
 166         ao_mmc5983_start();
 167         ao_spi_duplex(d, d, 2, AO_MMC5983_SPI_INDEX);
 168         ao_mmc5983_stop();
 169
 170         return d[1];
 171 }
 172
 173 static void
 174 ao_mmc5983_duplex(uint8_t *dst, uint8_t len)
 175 {
 176         ao_mmc5983_start();
 177         ao_spi_duplex(dst, dst, len, AO_MMC5983_SPI_INDEX);
 178         ao_mmc5983_stop();
 179 }
 180
 181 static void
 182 ao_mmc5983_raw(struct ao_mmc5983_raw *raw)
 183 {
 184         raw->addr = MMC5983_X_OUT_0 | MMC5983_READ;
 185         ao_mmc5983_duplex((uint8_t *) raw, sizeof (*raw));
 186 }
 187 #endif
 188
 189 /* Saturating subtraction. Keep the result within range
 190  * of an int16_t
 191  */
 192 static int16_t
 193 sat_sub(int16_t a, int16_t b)
 194 {
 195         int32_t v = (int32_t) a - (int32_t) b;
 196         if (v < -32768)
 197                 v = -32768;
 198         if (v > 32767)
 199                 v = 32767;
 200         return (int16_t) v;
 201 }
 202
 203 /* Wait for a synchronous sample to finish */
 204 static void
 205 ao_mmc5983_wait(void)
 206 {
 207         for (;;) {
 208                 uint8_t status = ao_mmc5983_reg_read(MMC5983_STATUS);
 209                 if ((status & (1 << MMC5983_STATUS_MEAS_M_DONE)) != 0)
 210                         break;
 211                 ao_delay(0);
 212         }
 213 }
 214
 215 static void
 216 ao_mmc5983_set(void)
 217 {
 218         ao_mmc5983_reg_write(MMC5983_CONTROL_0,
 219                              (1 << MMC5983_CONTROL_0_SET));
 220 }
 221
 222 static void
 223 ao_mmc5983_reset(void)
 224 {
 225         ao_mmc5983_reg_write(MMC5983_CONTROL_0,
 226                              (1 << MMC5983_CONTROL_0_RESET));
 227 }
 228
 229 static struct ao_mmc5983_raw raw;
 230
 231 /* Read the sensor values and convert to a sample struct */
 232 static void
 233 ao_mmc5983_sample(struct ao_mmc5983_sample *s)
 234 {
 235         ao_mmc5983_raw(&raw);
 236
 237         /* Bias by 32768 to convert from uint16_t to int16_t */
 238         s->x = (int16_t) ((((uint16_t) raw.x0 << 8) | raw.x1) - 32768);
 239         s->y = (int16_t) ((((uint16_t) raw.y0 << 8) | raw.y1) - 32768);
 240         s->z = (int16_t) ((((uint16_t) raw.z0 << 8) | raw.z1) - 32768);
 241 }
 242
 243 /* Synchronously sample the sensors */
 244 static void
 245 ao_mmc5983_sync_sample(struct ao_mmc5983_sample *v)
 246 {
 247         ao_mmc5983_reg_write(MMC5983_CONTROL_0,
 248                              (1 << MMC5983_CONTROL_0_TM_M));
 249         ao_mmc5983_wait();
 250         ao_mmc5983_sample(v);
 251 }
 252
 253 static struct ao_mmc5983_sample set, reset;
 254
 255 /* Calibrate the device by finding the zero point */
 256 static void
 257 ao_mmc5983_cal(void)
 258 {
 259         /* Compute offset */
 260
 261         ao_delay(AO_MS_TO_TICKS(100));
 262
 263         /* Measure in 'SET' mode */
 264         ao_mmc5983_set();
 265         ao_delay(AO_MS_TO_TICKS(100));
 266         ao_mmc5983_sync_sample(&set);
 267
 268         ao_delay(AO_MS_TO_TICKS(100));
 269
 270         /* Measure in 'RESET' mode */
 271         ao_mmc5983_reset();
 272         ao_delay(AO_MS_TO_TICKS(100));
 273         ao_mmc5983_sync_sample(&reset);
 274
 275         /* The zero point is the average of SET and RESET values */
 276         ao_mmc5983_offset.x = (int16_t) (((int32_t) set.x + (int32_t) reset.x) / 2);
 277         ao_mmc5983_offset.y = (int16_t) (((int32_t) set.y + (int32_t) reset.y) / 2);
 278         ao_mmc5983_offset.z = (int16_t) (((int32_t) set.z + (int32_t) reset.z) / 2);
 279 }
 280
 281 /* Configure the device to automatically sample at 200Hz */
 282 static void
 283 ao_mmc5983_run(void)
 284 {
 285         /* Set bandwidth to 200Hz */
 286         ao_mmc5983_reg_write(MMC5983_CONTROL_1,
 287                              MMC5983_CONTROL_1_BW_200 << MMC5983_CONTROL_1_BW);
 288
 289         /* Measure at 200Hz so we get recent samples by just reading
 290          * the registers
 291          */
 292         ao_mmc5983_reg_write(MMC5983_CONTROL_2,
 293                              (1 << MMC5983_CONTROL_2_CMM_EN) |
 294                              (MMC5983_CONTROL_2_CM_FREQ_200HZ << MMC5983_CONTROL_2_CM_FREQ) |
 295                              (0 << MMC5983_CONTROL_2_EN_PRD_SET) |
 296                              (MMC5983_CONTROL_2_PRD_SET_1000));
 297         ao_mmc5983_configured = 1;
 298 }
 299
 300 /* Reboot the device by setting the SW_RST bit and waiting 10ms */
 301 static void
 302 ao_mmc5983_reboot(void)
 303 {
 304         ao_mmc5983_configured = 0;
 305
 306         ao_mmc5983_reg_write(MMC5983_CONTROL_1,
 307                              1 << MMC5983_CONTROL_1_SW_RST);
 308
 309         /* Delay for power up time (10ms) */
 310         ao_delay(AO_MS_TO_TICKS(10));
 311 }
 312
 313 /* Configure the device for operation */
 314 static uint8_t
 315 ao_mmc5983_setup(void)
 316 {
 317         uint8_t product_id;
 318
 319         /* Reboot the device */
 320         ao_mmc5983_reboot();
 321
 322         /* Check product ID */
 323         product_id = ao_mmc5983_reg_read(MMC5983_PRODUCT_ID);
 324         if (product_id != MMC5983_PRODUCT_ID_PRODUCT_I2C &&
 325             product_id != MMC5983_PRODUCT_ID_PRODUCT_SPI)
 326         {
 327                 AO_SENSOR_ERROR(AO_DATA_MMC5983);
 328         }
 329
 330         /* Calibrate */
 331         ao_mmc5983_cal();
 332
 333         /* Start automatic sampling */
 334         ao_mmc5983_run();
 335
 336         return 1;
 337 }
 338
 339 struct ao_mmc5983_sample ao_mmc5983_current;
 340
 341 static void
 342 ao_mmc5983(void)
 343 {
 344         struct ao_mmc5983_sample        sample;
 345         ao_mmc5983_setup();
 346         for (;;) {
 347                 if (ao_mmc5983_configured)
 348                         ao_mmc5983_sample(&sample);
 349                 sample.x = sat_sub(sample.x, ao_mmc5983_offset.x);
 350                 sample.y = sat_sub(sample.y, ao_mmc5983_offset.y);
 351                 sample.z = sat_sub(sample.z, ao_mmc5983_offset.z);
 352                 ao_arch_block_interrupts();
 353                 ao_mmc5983_current = sample;
 354                 AO_DATA_PRESENT(AO_DATA_MMC5983);
 355                 AO_DATA_WAIT();
 356                 ao_arch_release_interrupts();
 357         }
 358 }
 359
 360 static struct ao_task ao_mmc5983_task;
 361
 362 static void
 363 ao_mmc5983_show(void)
 364 {
 365 #if DEBUG_MMC5983
 366         printf ("x0 %02x x1 %02x y0 %02x y1 %02x z0 %02x z1 %02x\n",
 367                 raw.x0, raw.x1, raw.y0, raw.y1, raw.z0, raw.z1);
 368
 369         printf ("set.x %d set.y %d set.z %d\n",
 370                 set.x, set.y, set.z);
 371
 372         printf ("reset.x %d reset.y %d reset.z %d\n",
 373                 reset.x, reset.y, reset.z);
 374
 375         printf ("offset.x %d offset.y %d offset.z %d\n",
 376                 ao_mmc5983_offset.x,
 377                 ao_mmc5983_offset.y,
 378                 ao_mmc5983_offset.z);
 379 #endif
 380         printf ("MMC5983: %d %d %d\n",
 381                 ao_mmc5983_along(&ao_mmc5983_current),
 382                 ao_mmc5983_across(&ao_mmc5983_current),
 383                 ao_mmc5983_through(&ao_mmc5983_current));
 384 }
 385
 386 #if DEBUG_MMC5983
 387 static void
 388 ao_mmc5983_recal(void)
 389 {
 390         printf("recal\n"); fflush(stdout);
 391         ao_mmc5983_reboot();
 392         printf("reboot\n"); fflush(stdout);
 393         ao_mmc5983_cal();
 394         printf("cal\n"); fflush(stdout);
 395         ao_mmc5983_show();
 396         printf("show\n"); fflush(stdout);
 397         ao_mmc5983_run();
 398         printf("run\n"); fflush(stdout);
 399 }
 400 #endif
 401
 402 static const struct ao_cmds ao_mmc5983_cmds[] = {
 403         { ao_mmc5983_show,      "M\0Show MMC5983 status" },
 404 #if DEBUG_MMC5983
 405         { ao_mmc5983_recal,     "m\0Recalibrate MMC5983" },
 406 #endif
 407         { 0, NULL }
 408 };
 409
 410 void
 411 ao_mmc5983_init(void)
 412 {
 413         ao_mmc5983_configured = 0;
 414
 415 #ifndef MMC5983_I2C
 416         ao_enable_input(AO_MMC5983_SPI_MISO_PORT,
 417                         AO_MMC5983_SPI_MISO_PIN,
 418                         AO_EXTI_MODE_PULL_NONE);
 419
 420         ao_enable_output(AO_MMC5983_SPI_CLK_PORT,
 421                          AO_MMC5983_SPI_CLK_PIN,
 422                          1);
 423
 424         ao_enable_output(AO_MMC5983_SPI_MOSI_PORT,
 425                          AO_MMC5983_SPI_MOSI_PIN,
 426                          0);
 427
 428         ao_spi_init_cs(AO_MMC5983_SPI_CS_PORT, (1 << AO_MMC5983_SPI_CS_PIN));
 429 #endif
 430
 431         ao_add_task(&ao_mmc5983_task, ao_mmc5983, "mmc5983");
 432         ao_cmd_register(&ao_mmc5983_cmds[0]);
 433 }
 434
 435 #endif