altos: Don't eliminate baro above mach speed, just trust it less
[fw/altos] / src / kernel / ao_sample.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_SAMPLE_H_
20 #define _AO_SAMPLE_H_
21
22 #include <ao_data.h>
23
24 /*
25  * ao_sample.c
26  */
27
28 #ifndef AO_VALUE_32
29 #define AO_VALUE_32     1
30 #endif
31
32 #if AO_VALUE_32
33 /*
34  * For 32-bit computed values, use 64-bit intermediates.
35  */
36 typedef int64_t                 ao_k_t;
37 typedef int32_t                 ao_v_t;
38 #else
39 /*
40  * For 16-bit computed values, use 32-bit intermediates.
41  */
42 typedef int32_t                 ao_k_t;
43 typedef int16_t                 ao_v_t;
44 #endif
45
46 /*
47  * Barometer calibration
48  *
49  * We directly sample the barometer. The specs say:
50  *
51  * Pressure range: 15-115 kPa
52  * Voltage at 115kPa: 2.82
53  * Output scale: 27mV/kPa
54  *
55  * If we want to detect launch with the barometer, we need
56  * a large enough bump to not be fooled by noise. At typical
57  * launch elevations (0-2000m), a 200Pa pressure change cooresponds
58  * to about a 20m elevation change. This is 5.4mV, or about 3LSB.
59  * As all of our calculations are done in 16 bits, we'll actually see a change
60  * of 16 times this though
61  *
62  * 27 mV/kPa * 32767 / 3300 counts/mV = 268.1 counts/kPa
63  */
64
65 /* Accelerometer calibration
66  *
67  * We're sampling the accelerometer through a resistor divider which
68  * consists of 5k and 10k resistors. This multiplies the values by 2/3.
69  * That goes into the cc1111 A/D converter, which is running at 11 bits
70  * of precision with the bits in the MSB of the 16 bit value. Only positive
71  * values are used, so values should range from 0-32752 for 0-3.3V. The
72  * specs say we should see 40mV/g (uncalibrated), multiply by 2/3 for what
73  * the A/D converter sees (26.67 mV/g). We should see 32752/3300 counts/mV,
74  * for a final computation of:
75  *
76  * 26.67 mV/g * 32767/3300 counts/mV = 264.8 counts/g
77  *
78  * Zero g was measured at 16000 (we would expect 16384).
79  * Note that this value is only require to tell if the
80  * rocket is standing upright. Once that is determined,
81  * the value of the accelerometer is averaged for 100 samples
82  * to find the resting accelerometer value, which is used
83  * for all further flight computations
84  */
85
86 /*
87  * Above this height, the baro sensor doesn't work
88  */
89 #if HAS_MS5607
90 #define AO_MAX_BARO_HEIGHT      30000
91 #else
92 #define AO_MAX_BARO_HEIGHT      12000
93 #endif
94
95 /*
96  * Above this speed, baro measurements are unreliable
97  */
98 #define AO_MAX_BARO_SPEED       248
99
100 /* The maximum amount (in a range of 0-256) to de-rate the
101  * baro sensor data based on speed.
102  */
103 #define AO_MAX_SPEED_DISTRUST   160
104
105 #define ACCEL_NOSE_UP   (ao_accel_2g >> 2)
106
107 /*
108  * Speed and acceleration are scaled by 16 to provide a bit more
109  * resolution while still having reasonable range. Note that this
110  * limits speed to 2047m/s (around mach 6) and acceleration to
111  * 2047m/s² (over 200g)
112  */
113
114 #define AO_M_TO_HEIGHT(m)       ((ao_v_t) (m))
115 #define AO_MS_TO_SPEED(ms)      ((ao_v_t) ((ms) * 16))
116 #define AO_MSS_TO_ACCEL(mss)    ((ao_v_t) ((mss) * 16))
117
118 extern __pdata uint16_t ao_sample_tick;         /* time of last data */
119 extern __data uint8_t   ao_sample_adc;          /* Ring position of last processed sample */
120 extern __data uint8_t   ao_sample_data;         /* Ring position of last processed sample */
121
122 #if HAS_BARO
123 extern __pdata pres_t   ao_sample_pres;         /* most recent pressure sensor reading */
124 extern __pdata alt_t    ao_sample_alt;          /* MSL of ao_sample_pres */
125 extern __pdata alt_t    ao_sample_height;       /* AGL of ao_sample_pres */
126 extern __pdata pres_t   ao_ground_pres;         /* startup pressure */
127 extern __pdata alt_t    ao_ground_height;       /* MSL of ao_ground_pres */
128 #endif
129
130 #if HAS_ACCEL
131 extern __pdata accel_t  ao_sample_accel;        /* most recent accel sensor reading */
132 extern __pdata accel_t  ao_ground_accel;        /* startup acceleration */
133 extern __pdata accel_t  ao_accel_2g;            /* factory accel calibration */
134 extern __pdata int32_t  ao_accel_scale;         /* sensor to m/s² conversion */
135 #endif
136 #if HAS_GYRO
137 extern __pdata accel_t  ao_ground_accel_along;
138 extern __pdata accel_t  ao_ground_accel_across;
139 extern __pdata accel_t  ao_ground_accel_through;
140 extern __pdata int32_t  ao_ground_pitch;        /* * 512 */
141 extern __pdata int32_t  ao_ground_yaw;          /* * 512 */
142 extern __pdata int32_t  ao_ground_roll;         /* * 512 */
143 extern __pdata accel_t  ao_sample_accel_along;
144 extern __pdata accel_t  ao_sample_accel_across;
145 extern __pdata accel_t  ao_sample_accel_through;
146 extern __pdata gyro_t   ao_sample_roll;
147 extern __pdata gyro_t   ao_sample_pitch;
148 extern __pdata gyro_t   ao_sample_yaw;
149 extern __pdata angle_t  ao_sample_orient;
150 #endif
151
152 void ao_sample_init(void);
153
154 /* returns FALSE in preflight mode, TRUE in flight mode */
155 uint8_t ao_sample(void);
156
157 /*
158  * ao_kalman.c
159  */
160
161 #define to_fix_16(x) ((int16_t) ((x) * 65536.0 + 0.5))
162 #define to_fix_32(x) ((int32_t) ((x) * 65536.0 + 0.5))
163 #define to_fix_64(x) ((int64_t) ((x) * 65536.0 + 0.5))
164
165 #ifdef AO_VALUE_32
166 #if AO_VALUE_32
167 #define to_fix_v(x)     to_fix_32(x)
168 #define to_fix_k(x)     to_fix_64(x)
169 #else
170 #define to_fix_v(x)     to_fix_16(x)
171 #define to_fix_k(x)     to_fix_32(x)
172 #endif
173
174 #define from_fix(x)     ((x) >> 16)
175
176 extern __pdata ao_v_t                   ao_height;      /* meters */
177 extern __pdata ao_v_t                   ao_speed;       /* m/s * 16 */
178 extern __pdata ao_v_t                   ao_accel;       /* m/s² * 16 */
179 extern __xdata ao_v_t                   ao_max_height;  /* max of ao_height */
180 extern __xdata ao_v_t                   ao_avg_height;  /* running average of height */
181
182 extern __pdata ao_v_t                   ao_error_h;
183 extern __pdata ao_v_t                   ao_error_h_sq_avg;
184
185 #if HAS_ACCEL
186 extern __pdata ao_v_t                   ao_error_a;
187 #endif
188 #endif
189
190 void ao_kalman(void);
191
192 #endif /* _AO_SAMPLE_H_ */