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