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