git.gag.com Git - fw/altos/blob - src/kernel/ao_data.h

   1 /*
   2  * Copyright © 2012 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 #ifndef _AO_DATA_H_
  20 #define _AO_DATA_H_
  21
  22 #define GRAVITY 9.80665
  23
  24 #if HAS_ADC
  25 #define AO_DATA_ADC     (1 << 0)
  26 #else
  27 #define AO_DATA_ADC     0
  28 #endif
  29
  30 #if HAS_MS5607
  31 #include <ao_ms5607.h>
  32 #define AO_DATA_MS5607  (1 << 1)
  33 #else
  34 #define AO_DATA_MS5607  0
  35 #endif
  36
  37 #if HAS_MPU6000
  38 #include <ao_mpu6000.h>
  39 #define AO_DATA_MPU6000 (1 << 2)
  40 #else
  41 #define AO_DATA_MPU6000 0
  42 #endif
  43
  44 #if HAS_MPU9250
  45 #include <ao_mpu9250.h>
  46 #define AO_DATA_MPU9250 (1 << 2)
  47 #else
  48 #define AO_DATA_MPU9250 0
  49 #endif
  50
  51 #if HAS_HMC5883
  52 #include <ao_hmc5883.h>
  53 #define AO_DATA_HMC5883 (1 << 3)
  54 #else
  55 #define AO_DATA_HMC5883 0
  56 #endif
  57
  58 #if HAS_MMC5983
  59 #include <ao_mmc5983.h>
  60 #define AO_DATA_MMC5983 (1 << 3)
  61 #else
  62 #define AO_DATA_MMC5983 0
  63 #endif
  64
  65 #if HAS_MMA655X
  66 #include <ao_mma655x.h>
  67 #define AO_DATA_MMA655X (1 << 4)
  68 #else
  69 #define AO_DATA_MMA655X 0
  70 #endif
  71
  72 #if HAS_ADXL375
  73 #include <ao_adxl375.h>
  74 #define AO_DATA_ADXL375 (1 << 4)
  75 #else
  76 #define AO_DATA_ADXL375 0
  77 #endif
  78
  79 #if HAS_MAX6691
  80 #include <ao_max6691.h>
  81 #define AO_DATA_MAX6691 (1 << 4)
  82 #else
  83 #define AO_DATA_MAX6691 0
  84 #endif
  85
  86 #if HAS_BMX160
  87 #include <ao_bmx160.h>
  88 #define AO_DATA_BMX160  (1 << 2)
  89 #else
  90 #define AO_DATA_BMX160  0
  91 #endif
  92
  93 #ifndef HAS_SENSOR_ERRORS
  94 #if HAS_IMU || HAS_MMA655X || HAS_MS5607 || HAS_MS5611
  95 #define HAS_SENSOR_ERRORS       1
  96 #endif
  97 #endif
  98
  99 #if HAS_SENSOR_ERRORS
 100 extern uint8_t                  ao_sensor_errors;
 101 #endif
 102
 103 #ifdef AO_DATA_RING
 104
 105 #define AO_DATA_ALL     (AO_DATA_ADC|AO_DATA_MS5607|AO_DATA_MPU6000|AO_DATA_HMC5883|AO_DATA_MMA655X|AO_DATA_MPU9250|AO_DATA_ADXL375|AO_DATA_BMX160|AO_DATA_MMC5983)
 106
 107 struct ao_data {
 108         AO_TICK_TYPE                    tick;
 109 #if HAS_ADC
 110         struct ao_adc                   adc;
 111 #endif
 112 #if HAS_MS5607
 113         struct ao_ms5607_sample         ms5607_raw;
 114         struct ao_ms5607_value          ms5607_cooked;
 115 #endif
 116 #if HAS_MPU6000
 117         struct ao_mpu6000_sample        mpu6000;
 118 #if !HAS_MMA655X
 119         int16_t                         z_accel;
 120 #endif
 121 #endif
 122 #if HAS_MPU9250
 123         struct ao_mpu9250_sample        mpu9250;
 124 #if !HAS_MMA655X
 125         int16_t                         z_accel;
 126 #endif
 127 #endif
 128 #if HAS_HMC5883
 129         struct ao_hmc5883_sample        hmc5883;
 130 #endif
 131 #if HAS_MMC5983
 132         struct ao_mmc5983_sample        mmc5983;
 133 #endif
 134 #if HAS_MMA655X
 135         uint16_t                        mma655x;
 136 #endif
 137 #if HAS_ADXL375
 138         struct ao_adxl375_sample        adxl375;
 139 #endif
 140 #if HAS_MAX6691
 141         struct ao_max6691_sample        max6691;
 142 #endif
 143 #if HAS_ADS131A0X
 144         struct ao_ads131a0x_sample      ads131a0x;
 145 #endif
 146 #if HAS_BMX160
 147         struct ao_bmx160_sample         bmx160;
 148 #if !HAS_ADXL375
 149         int16_t z_accel;
 150 #endif
 151 #endif
 152 };
 153
 154 #define ao_data_ring_next(n)    (((n) + 1) & (AO_DATA_RING - 1))
 155 #define ao_data_ring_prev(n)    (((n) - 1) & (AO_DATA_RING - 1))
 156
 157 /* Get a copy of the last complete sample set */
 158 void
 159 ao_data_get(struct ao_data *packet);
 160
 161 extern volatile struct ao_data  ao_data_ring[AO_DATA_RING];
 162 extern volatile uint8_t         ao_data_head;
 163 extern volatile uint8_t         ao_data_present;
 164 extern volatile uint8_t         ao_data_count;
 165
 166 /*
 167  * Mark a section of data as ready, check for data complete
 168  */
 169 #define AO_DATA_PRESENT(bit)    (ao_data_present |= (bit))
 170
 171 /*
 172  * Mark sensor failed, and unblock the sample collection code by
 173  * marking the data as present
 174  */
 175 #define AO_SENSOR_ERROR(bit)    (ao_data_present |= (ao_sensor_errors |= (bit)))
 176
 177 /*
 178  * Wait until it is time to write a sensor sample; this is
 179  * signaled by the timer tick
 180  */
 181 #define AO_DATA_WAIT()          ao_sleep((void *) &ao_data_count)
 182
 183 #endif /* AO_DATA_RING */
 184
 185 #define AO_ALT_TYPE     int32_t
 186
 187 typedef AO_ALT_TYPE     alt_t;
 188
 189 #if !HAS_BARO && HAS_MS5607
 190
 191 /* Either an MS5607 or an MS5611 hooked to a SPI port
 192  */
 193
 194 #define HAS_BARO        1
 195
 196 typedef int32_t pres_t;
 197
 198 #define ao_data_pres_cook(packet)       ao_ms5607_convert(&packet->ms5607_raw, &packet->ms5607_cooked)
 199
 200 #define ao_data_pres(packet)    ((packet)->ms5607_cooked.pres)
 201 #define ao_data_temp(packet)    ((int16_t) (packet)->ms5607_cooked.temp)
 202
 203 #define pres_to_altitude(p)     ao_pa_to_altitude(p)
 204
 205 #endif
 206
 207 /*
 208  * Need a few macros to pull data from the sensors:
 209  *
 210  * ao_data_accel_raw    - pull raw sensor
 211  * ao_data_accel_invert - flip rocket ends for positive acceleration
 212  */
 213
 214 #if HAS_ACCEL
 215
 216 /* This section is for an analog accelerometer hooked to one of the ADC pins. As
 217  * those are 5V parts, this also requires that the 5V supply be hooked to to anothe ADC
 218  * pin so that the both can be measured to correct for changes between the 3.3V and 5V rails
 219  */
 220
 221 typedef int16_t accel_t;
 222 #define ao_data_accel_raw(packet)               ((packet)->adc.accel)
 223 #define ao_data_accel_invert(a)                 (0x7fff -(a))
 224
 225 /*
 226  * Ok, the math here is a bit tricky.
 227  *
 228  * ao_sample_accel:  ADC output for acceleration
 229  * ao_accel_ref:  ADC output for the 5V reference.
 230  * ao_cook_accel: Corrected acceleration value
 231  * Vcc:           3.3V supply to the CC1111
 232  * Vac:           5V supply to the accelerometer
 233  * accel:         input voltage to accelerometer ADC pin
 234  * ref:           input voltage to 5V reference ADC pin
 235  *
 236  *
 237  * Measured acceleration is ratiometric to Vcc:
 238  *
 239  *     ao_sample_accel   accel
 240  *     ------------ = -----
 241  *        32767        Vcc
 242  *
 243  * Measured 5v reference is also ratiometric to Vcc:
 244  *
 245  *     ao_accel_ref    ref
 246  *     ------------ = -----
 247  *        32767        Vcc
 248  *
 249  *
 250  *      ao_accel_ref = 32767 * (ref / Vcc)
 251  *
 252  * Acceleration is measured ratiometric to the 5V supply,
 253  * so what we want is:
 254  *
 255  *      ao_cook_accel    accel
 256  *      ------------- =  -----
 257  *          32767         ref
 258  *
 259  *
 260  *                      accel    Vcc
 261  *                    = ----- *  ---
 262  *                       Vcc     ref
 263  *
 264  *                      ao_sample_accel       32767
 265  *                    = ------------ *  ------------
 266  *                         32767        ao_accel_ref
 267  *
 268  * Multiply through by 32767:
 269  *
 270  *                      ao_sample_accel * 32767
 271  *      ao_cook_accel = --------------------
 272  *                          ao_accel_ref
 273  *
 274  * Now, the tricky part. Getting this to compile efficiently
 275  * and keeping all of the values in-range.
 276  *
 277  * First off, we need to use a shift of 16 instead of * 32767 as SDCC
 278  * does the obvious optimizations for byte-granularity shifts:
 279  *
 280  *      ao_cook_accel = (ao_sample_accel << 16) / ao_accel_ref
 281  *
 282  * Next, lets check our input ranges:
 283  *
 284  *      0 <= ao_sample_accel <= 0x7fff          (singled ended ADC conversion)
 285  *      0x7000 <= ao_accel_ref <= 0x7fff        (the 5V ref value is close to 0x7fff)
 286  *
 287  * Plugging in our input ranges, we get an output range of 0 - 0x12490,
 288  * which is 17 bits. That won't work. If we take the accel ref and shift
 289  * by a bit, we'll change its range:
 290  *
 291  *      0xe000 <= ao_accel_ref<<1 <= 0xfffe
 292  *
 293  *      ao_cook_accel = (ao_sample_accel << 16) / (ao_accel_ref << 1)
 294  *
 295  * Now the output range is 0 - 0x9248, which nicely fits in 16 bits. It
 296  * is, however, one bit too large for our signed computations. So, we
 297  * take the result and shift that by a bit:
 298  *
 299  *      ao_cook_accel = ((ao_sample_accel << 16) / (ao_accel_ref << 1)) >> 1
 300  *
 301  * This finally creates an output range of 0 - 0x4924. As the ADC only
 302  * provides 11 bits of data, we haven't actually lost any precision,
 303  * just dropped a bit of noise off the low end.
 304  */
 305
 306 #if HAS_ACCEL_REF
 307
 308 #define ao_data_accel_raw(packet) \
 309         ((uint16_t) ((((uint32_t) (packet)->adc.accel << 16) / ((packet)->adc.accel_ref << 1))) >> 1)
 310
 311 #else
 312
 313 #define ao_data_accel_raw(packet) ((packet)->adc.accel)
 314
 315 #endif /* HAS_ACCEL_REF */
 316
 317 #endif  /* HAS_ACCEL */
 318
 319 #if !HAS_ACCEL && HAS_MMA655X
 320
 321 #define HAS_ACCEL       1
 322
 323 typedef int16_t accel_t;
 324
 325 /* MMA655X is hooked up so that positive values represent negative acceleration */
 326
 327 #define AO_ACCEL_INVERT         4095
 328
 329 #ifndef AO_MMA655X_INVERT
 330 #error AO_MMA655X_INVERT not defined
 331 #endif
 332
 333 #if AO_MMA655X_INVERT
 334 #define ao_data_accel_raw(packet)               ((accel_t) (AO_ACCEL_INVERT - (packet)->mma655x))
 335 #else
 336 #define ao_data_accel_raw(packet)               ((accel_t) (packet)->mma655x)
 337 #endif
 338 #define ao_data_accel_invert(accel)             (AO_ACCEL_INVERT - (accel))
 339
 340 #endif
 341
 342 #if !HAS_ACCEL && HAS_ADXL375
 343
 344 #define HAS_ACCEL       1
 345
 346 typedef int16_t accel_t;
 347
 348 #ifndef AO_ADXL375_INVERT
 349 #error AO_ADXL375_INVERT not defined
 350 #endif
 351
 352 #if AO_ADXL375_INVERT
 353 #define ao_data_accel_raw(packet)               (-(packet)->adxl375.AO_ADXL375_AXIS)
 354 #else
 355 #define ao_data_accel_raw(packet)               ((packet)->adxl375.AO_ADXL375_AXIS)
 356 #endif
 357 #define ao_data_accel_invert(accel)             (-(accel))
 358
 359 #if USE_ADXL375_IMU
 360 #define ao_data_along(packet)                   ((packet)->adxl375.AO_ADXL375_AXIS)
 361 #define ao_data_across(packet)                  ((packet)->adxl375.AO_ADXL375_ACROSS_AXIS)
 362 #define ao_data_through(packet)                 ((packet)->adxl375.z)
 363 #define ao_data_accel_to_sample(accel)          ao_adxl375_accel_to_sample(accel)
 364 #endif
 365
 366 #endif /* HAS_ADXL375 */
 367
 368 #if !HAS_ACCEL && HAS_MPU6000
 369
 370 #define HAS_ACCEL       1
 371
 372 typedef int16_t accel_t;
 373
 374 /* MPU6000 is hooked up so that positive y is positive acceleration */
 375 #define ao_data_accel_raw(packet)               (-(packet)->mpu6000.accel_y)
 376 #define ao_data_accel_invert(a)                 (-(a))
 377
 378 #endif
 379
 380 #if !HAS_GYRO && HAS_MPU6000
 381
 382 #define HAS_GYRO        1
 383
 384 typedef int16_t gyro_t;         /* in raw sample units */
 385 typedef int16_t angle_t;        /* in degrees */
 386
 387 /* Y axis is aligned with the direction of motion (along) */
 388 /* X axis is aligned in the other board axis (across) */
 389 /* Z axis is aligned perpendicular to the board (through) */
 390
 391 #ifndef ao_data_along
 392 #define ao_data_along(packet)   ((packet)->mpu6000.accel_y)
 393 #define ao_data_across(packet)  ((packet)->mpu6000.accel_x)
 394 #define ao_data_through(packet) ((packet)->mpu6000.accel_z)
 395
 396 #define ao_data_roll(packet)    ((packet)->mpu6000.gyro_y)
 397 #define ao_data_pitch(packet)   ((packet)->mpu6000.gyro_x)
 398 #define ao_data_yaw(packet)     ((packet)->mpu6000.gyro_z)
 399 #endif
 400
 401 static inline float ao_convert_gyro(float sensor)
 402 {
 403         return ao_mpu6000_gyro(sensor);
 404 }
 405
 406 static inline float ao_convert_accel(int16_t sensor)
 407 {
 408         return ao_mpu6000_accel(sensor);
 409 }
 410
 411 #endif
 412
 413 #if !HAS_ACCEL && HAS_MPU9250
 414
 415 #define HAS_ACCEL       1
 416
 417 typedef int16_t accel_t;
 418
 419 /* MPU9250 is hooked up so that positive y is positive acceleration */
 420 #define ao_data_accel_raw(packet)               (-(packet)->mpu9250.accel_y)
 421 #define ao_data_accel_invert(a)                 (-(a))
 422
 423 #endif
 424
 425 #if !HAS_GYRO && HAS_MPU9250
 426
 427 #define HAS_GYRO        1
 428
 429 typedef int16_t gyro_t;         /* in raw sample units */
 430 typedef int16_t angle_t;        /* in degrees */
 431
 432 /* Y axis is aligned with the direction of motion (along) */
 433 /* X axis is aligned in the other board axis (across) */
 434 /* Z axis is aligned perpendicular to the board (through) */
 435
 436 #ifndef ao_data_along
 437 #define ao_data_along(packet)   ((packet)->mpu9250.accel_y)
 438 #define ao_data_across(packet)  ((packet)->mpu9250.accel_x)
 439 #define ao_data_through(packet) ((packet)->mpu9250.accel_z)
 440
 441 #define ao_data_roll(packet)    ((packet)->mpu9250.gyro_y)
 442 #define ao_data_pitch(packet)   ((packet)->mpu9250.gyro_x)
 443 #define ao_data_yaw(packet)     ((packet)->mpu9250.gyro_z)
 444 #endif
 445
 446 static inline float ao_convert_gyro(float sensor)
 447 {
 448         return ao_mpu9250_gyro(sensor);
 449 }
 450
 451 static inline float ao_convert_accel(int16_t sensor)
 452 {
 453         return ao_mpu9250_accel(sensor);
 454 }
 455
 456 #endif
 457
 458 #if !HAS_ACCEL && HAS_BMX160
 459
 460 #define HAS_ACCEL       1
 461
 462 typedef int16_t accel_t;
 463
 464 #define ao_data_accel_raw(packet)               -ao_data_along(packet)
 465 #define ao_data_accel_invert(a)                 (-(a))
 466 #define ao_data_accel_to_sample(accel)          ao_bmx_accel_to_sample(accel)
 467
 468 #endif
 469
 470 #if !HAS_GYRO && HAS_BMX160
 471
 472 #define HAS_GYRO        1
 473
 474 typedef int16_t gyro_t;         /* in raw sample units */
 475 typedef int16_t angle_t;        /* in degrees */
 476
 477 /* X axis is aligned with the direction of motion (along) */
 478 /* Y axis is aligned in the other board axis (across) */
 479 /* Z axis is aligned perpendicular to the board (through) */
 480
 481 static inline float ao_convert_gyro(float sensor)
 482 {
 483         return ao_bmx160_gyro(sensor);
 484 }
 485
 486 static inline float ao_convert_accel(int16_t sensor)
 487 {
 488         return ao_bmx160_accel(sensor);
 489 }
 490
 491 #endif
 492
 493 #if !HAS_MAG && HAS_HMC5883
 494
 495 #define HAS_MAG         1
 496
 497 typedef int16_t ao_mag_t;               /* in raw sample units */
 498
 499 #define ao_data_mag_along(packet)       ((packet)->hmc5883.x)
 500 #define ao_data_mag_across(packet)      ((packet)->hmc5883.y)
 501 #define ao_data_mag_through(packet)     ((packet)->hmc5883.z)
 502
 503 #endif
 504
 505 #if !HAS_MAG && HAS_MMC5983
 506
 507 #define HAS_MAG         1
 508
 509 typedef int16_t ao_mag_t;               /* in raw sample units */
 510
 511 #endif
 512
 513 #if !HAS_MAG && HAS_MPU9250
 514
 515 #define HAS_MAG         1
 516
 517 typedef int16_t ao_mag_t;               /* in raw sample units */
 518
 519 /* Note that this order is different from the accel and gyro. For some
 520  * reason, the mag sensor axes aren't the same as the other two
 521  * sensors. Also, the Z axis is flipped in sign.
 522  */
 523
 524 #ifndef ao_data_mag_along
 525 #define ao_data_mag_along(packet)       ((packet)->mpu9250.mag_x)
 526 #define ao_data_mag_across(packet)      ((packet)->mpu9250.mag_y)
 527 #define ao_data_mag_through(packet)     ((packet)->mpu9250.mag_z)
 528 #endif
 529
 530 #endif
 531
 532 #ifdef AO_DATA_RING
 533
 534 static inline void
 535 ao_data_fill(int head) {
 536         if (ao_data_present == AO_DATA_ALL) {
 537 #if HAS_MS5607
 538                 ao_data_ring[head].ms5607_raw = ao_ms5607_current;
 539 #endif
 540 #if HAS_MMA655X
 541                 ao_data_ring[head].mma655x = ao_mma655x_current;
 542 #endif
 543 #if HAS_HMC5883
 544                 ao_data_ring[head].hmc5883 = ao_hmc5883_current;
 545 #endif
 546 #if HAS_MMC5983
 547                 ao_data_ring[head].mmc5983 = ao_mmc5983_current;
 548 #endif
 549 #if HAS_MPU6000
 550                 ao_data_ring[head].mpu6000 = ao_mpu6000_current;
 551 #endif
 552 #if HAS_MPU9250
 553                 ao_data_ring[head].mpu9250 = ao_mpu9250_current;
 554 #endif
 555 #if HAS_ADXL375
 556                 ao_data_ring[head].adxl375 = ao_adxl375_current;
 557 #endif
 558 #if HAS_MAX6691
 559                 ao_data_ring[head].max6691 = ao_max6691_current;
 560 #endif
 561 #if HAS_ADS131A0X
 562                 ao_data_ring[head].ads131a0x = ao_ads131a0x_current;
 563 #endif
 564 #if HAS_BMX160
 565                 ao_data_ring[head].bmx160 = ao_bmx160_current;
 566 #endif
 567                 ao_data_ring[head].tick = ao_tick_count;
 568                 ao_data_head = ao_data_ring_next(head);
 569                 ao_wakeup((void *) &ao_data_head);
 570         }
 571 }
 572
 573 #endif
 574
 575 #if HAS_ACCEL
 576 accel_t
 577 ao_data_accel(volatile struct ao_data *packet);
 578 #endif
 579
 580 #endif /* _AO_DATA_H_ */