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