altos: minor type in comment about accel correction
[fw/altos] / src / ao_radio.c
1 /*
2  * Copyright © 2009 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; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 #include "ao.h"
19
20 /* Values from SmartRF® Studio for:
21  *
22  * Deviation:   20.507812 kHz
23  * Datarate:    38.360596 kBaud
24  * Modulation:  GFSK
25  * RF Freq:     434.549927 MHz
26  * Channel:     99.975586 kHz
27  * Channel:     0
28  * RX filter:   93.75 kHz
29  */
30
31 /*
32  * For IF freq of 140.62kHz, the IF value is:
33  *
34  * 140.62e3 / (24e6 / 2**10) = 6
35  */
36
37 #define IF_FREQ_CONTROL 6
38
39 /*
40  * For channel bandwidth of 93.75 kHz, the CHANBW_E and CHANBW_M values are
41  *
42  * BW = 24e6 / (8 * (4 + M) * 2 ** E)
43  *
44  * So, M = 0 and E = 3
45  */
46
47 #define CHANBW_M        0
48 #define CHANBW_E        3
49
50 /*
51  * For a symbol rate of 38360kBaud, the DRATE_E and DRATE_M values are:
52  *
53  * R = (256 + M) * 2** E * 24e6 / 2**28
54  *
55  * So M is 163 and E is 10
56  */
57
58 #define DRATE_E         10
59 #define DRATE_M         163
60
61 /*
62  * For a channel deviation of 20.5kHz, the DEVIATION_E and DEVIATION_M values are:
63  *
64  * F = 24e6/2**17 * (8 + DEVIATION_M) * 2**DEVIATION_E
65  *
66  * So M is 6 and E is 3
67  */
68
69 #define DEVIATION_M     6
70 #define DEVIATION_E     3
71
72 /*
73  * For our RDF beacon, set the symbol rate to 2kBaud (for a 1kHz tone),
74  * so the DRATE_E and DRATE_M values are:
75  *
76  * M is 94 and E is 6
77  *
78  * To make the tone last for 200ms, we need 2000 * .2 = 400 bits or 50 bytes
79  */
80
81 #define RDF_DRATE_E     6
82 #define RDF_DRATE_M     94
83 #define RDF_PACKET_LEN  50
84
85 /*
86  * RDF deviation should match the normal NFM value of 5kHz
87  *
88  * M is 6 and E is 1
89  *
90  */
91
92 #define RDF_DEVIATION_M 6
93 #define RDF_DEVIATION_E 1
94
95 /* This are from the table for 433MHz */
96
97 #define RF_POWER_M30_DBM        0x12
98 #define RF_POWER_M20_DBM        0x0e
99 #define RF_POWER_M15_DBM        0x1d
100 #define RF_POWER_M10_DBM        0x34
101 #define RF_POWER_M5_DBM         0x2c
102 #define RF_POWER_0_DBM          0x60
103 #define RF_POWER_5_DBM          0x84
104 #define RF_POWER_7_DBM          0xc8
105 #define RF_POWER_10_DBM         0xc0
106
107 #define RF_POWER                RF_POWER_10_DBM
108
109 static __code uint8_t radio_setup[] = {
110         RF_PA_TABLE7_OFF,       RF_POWER,
111         RF_PA_TABLE6_OFF,       RF_POWER,
112         RF_PA_TABLE5_OFF,       RF_POWER,
113         RF_PA_TABLE4_OFF,       RF_POWER,
114         RF_PA_TABLE3_OFF,       RF_POWER,
115         RF_PA_TABLE2_OFF,       RF_POWER,
116         RF_PA_TABLE1_OFF,       RF_POWER,
117         RF_PA_TABLE0_OFF,       RF_POWER,
118
119         RF_FSCTRL1_OFF,         (IF_FREQ_CONTROL << RF_FSCTRL1_FREQ_IF_SHIFT),
120         RF_FSCTRL0_OFF,         (0 << RF_FSCTRL0_FREQOFF_SHIFT),
121
122         RF_MDMCFG4_OFF,         ((CHANBW_E << RF_MDMCFG4_CHANBW_E_SHIFT) |
123                                  (CHANBW_M << RF_MDMCFG4_CHANBW_M_SHIFT) |
124                                  (DRATE_E << RF_MDMCFG4_DRATE_E_SHIFT)),
125         RF_MDMCFG3_OFF,         (DRATE_M << RF_MDMCFG3_DRATE_M_SHIFT),
126         RF_MDMCFG2_OFF,         (RF_MDMCFG2_DEM_DCFILT_OFF |
127                                  RF_MDMCFG2_MOD_FORMAT_GFSK |
128                                  RF_MDMCFG2_SYNC_MODE_15_16_THRES),
129         RF_MDMCFG1_OFF,         (RF_MDMCFG1_FEC_EN |
130                                  RF_MDMCFG1_NUM_PREAMBLE_4 |
131                                  (2 << RF_MDMCFG1_CHANSPC_E_SHIFT)),
132         RF_MDMCFG0_OFF,         (17 << RF_MDMCFG0_CHANSPC_M_SHIFT),
133
134         RF_CHANNR_OFF,          0,
135
136         RF_DEVIATN_OFF,         ((DEVIATION_E << RF_DEVIATN_DEVIATION_E_SHIFT) |
137                                  (DEVIATION_M << RF_DEVIATN_DEVIATION_M_SHIFT)),
138
139         /* SmartRF says set LODIV_BUF_CURRENT_TX to 0
140          * And, we're not using power ramping, so use PA_POWER 0
141          */
142         RF_FREND0_OFF,          ((1 << RF_FREND0_LODIV_BUF_CURRENT_TX_SHIFT) |
143                                  (0 << RF_FREND0_PA_POWER_SHIFT)),
144
145         RF_FREND1_OFF,          ((1 << RF_FREND1_LNA_CURRENT_SHIFT) |
146                                  (1 << RF_FREND1_LNA2MIX_CURRENT_SHIFT) |
147                                  (1 << RF_FREND1_LODIV_BUF_CURRENT_RX_SHIFT) |
148                                  (2 << RF_FREND1_MIX_CURRENT_SHIFT)),
149
150         RF_FSCAL3_OFF,          0xE9,
151         RF_FSCAL2_OFF,          0x0A,
152         RF_FSCAL1_OFF,          0x00,
153         RF_FSCAL0_OFF,          0x1F,
154
155         RF_TEST2_OFF,           0x88,
156         RF_TEST1_OFF,           0x31,
157         RF_TEST0_OFF,           0x09,
158
159         /* default sync values */
160         RF_SYNC1_OFF,           0xD3,
161         RF_SYNC0_OFF,           0x91,
162
163         /* max packet length */
164         RF_PKTCTRL1_OFF,        ((1 << PKTCTRL1_PQT_SHIFT)|
165                                  PKTCTRL1_APPEND_STATUS|
166                                  PKTCTRL1_ADR_CHK_NONE),
167         RF_PKTCTRL0_OFF,        (RF_PKTCTRL0_WHITE_DATA|
168                                  RF_PKTCTRL0_PKT_FORMAT_NORMAL|
169                                  RF_PKTCTRL0_CRC_EN|
170                                  RF_PKTCTRL0_LENGTH_CONFIG_FIXED),
171         RF_ADDR_OFF,            0x00,
172         RF_MCSM2_OFF,           (RF_MCSM2_RX_TIME_END_OF_PACKET),
173         RF_MCSM1_OFF,           (RF_MCSM1_CCA_MODE_RSSI_BELOW_UNLESS_RECEIVING|
174                                  RF_MCSM1_RXOFF_MODE_IDLE|
175                                  RF_MCSM1_TXOFF_MODE_IDLE),
176         RF_MCSM0_OFF,           (RF_MCSM0_FS_AUTOCAL_FROM_IDLE|
177                                  RF_MCSM0_MAGIC_3|
178                                  RF_MCSM0_CLOSE_IN_RX_0DB),
179         RF_FOCCFG_OFF,          (RF_FOCCFG_FOC_PRE_K_3K,
180                                  RF_FOCCFG_FOC_POST_K_PRE_K,
181                                  RF_FOCCFG_FOC_LIMIT_BW_OVER_4),
182         RF_BSCFG_OFF,           (RF_BSCFG_BS_PRE_K_2K|
183                                  RF_BSCFG_BS_PRE_KP_3KP|
184                                  RF_BSCFG_BS_POST_KI_PRE_KI|
185                                  RF_BSCFG_BS_POST_KP_PRE_KP|
186                                  RF_BSCFG_BS_LIMIT_0),
187         RF_AGCCTRL2_OFF,        0x43,
188         RF_AGCCTRL1_OFF,        0x40,
189         RF_AGCCTRL0_OFF,        0x91,
190
191         RF_IOCFG2_OFF,          0x00,
192         RF_IOCFG1_OFF,          0x00,
193         RF_IOCFG0_OFF,          0x00,
194 };
195
196 static __code uint8_t rdf_setup[] = {
197         RF_MDMCFG4_OFF,         ((CHANBW_E << RF_MDMCFG4_CHANBW_E_SHIFT) |
198                                  (CHANBW_M << RF_MDMCFG4_CHANBW_M_SHIFT) |
199                                  (RDF_DRATE_E << RF_MDMCFG4_DRATE_E_SHIFT)),
200         RF_MDMCFG3_OFF,         (RDF_DRATE_M << RF_MDMCFG3_DRATE_M_SHIFT),
201         RF_MDMCFG2_OFF,         (RF_MDMCFG2_DEM_DCFILT_OFF |
202                                  RF_MDMCFG2_MOD_FORMAT_GFSK |
203                                  RF_MDMCFG2_SYNC_MODE_15_16_THRES),
204         RF_MDMCFG1_OFF,         (RF_MDMCFG1_FEC_DIS |
205                                  RF_MDMCFG1_NUM_PREAMBLE_2 |
206                                  (2 << RF_MDMCFG1_CHANSPC_E_SHIFT)),
207
208         RF_DEVIATN_OFF,         ((RDF_DEVIATION_E << RF_DEVIATN_DEVIATION_E_SHIFT) |
209                                  (RDF_DEVIATION_M << RF_DEVIATN_DEVIATION_M_SHIFT)),
210
211         /* packet length is set in-line */
212         RF_PKTCTRL1_OFF,        ((1 << PKTCTRL1_PQT_SHIFT)|
213                                  PKTCTRL1_ADR_CHK_NONE),
214         RF_PKTCTRL0_OFF,        (RF_PKTCTRL0_PKT_FORMAT_NORMAL|
215                                  RF_PKTCTRL0_LENGTH_CONFIG_FIXED),
216 };
217
218 static __code uint8_t fixed_pkt_setup[] = {
219         RF_MDMCFG4_OFF,         ((CHANBW_E << RF_MDMCFG4_CHANBW_E_SHIFT) |
220                                  (CHANBW_M << RF_MDMCFG4_CHANBW_M_SHIFT) |
221                                  (DRATE_E << RF_MDMCFG4_DRATE_E_SHIFT)),
222         RF_MDMCFG3_OFF,         (DRATE_M << RF_MDMCFG3_DRATE_M_SHIFT),
223         RF_MDMCFG2_OFF,         (RF_MDMCFG2_DEM_DCFILT_OFF |
224                                  RF_MDMCFG2_MOD_FORMAT_GFSK |
225                                  RF_MDMCFG2_SYNC_MODE_15_16_THRES),
226         RF_MDMCFG1_OFF,         (RF_MDMCFG1_FEC_EN |
227                                  RF_MDMCFG1_NUM_PREAMBLE_4 |
228                                  (2 << RF_MDMCFG1_CHANSPC_E_SHIFT)),
229
230         RF_DEVIATN_OFF,         ((DEVIATION_E << RF_DEVIATN_DEVIATION_E_SHIFT) |
231                                  (DEVIATION_M << RF_DEVIATN_DEVIATION_M_SHIFT)),
232
233         /* max packet length -- now set inline */
234         RF_PKTCTRL1_OFF,        ((1 << PKTCTRL1_PQT_SHIFT)|
235                                  PKTCTRL1_APPEND_STATUS|
236                                  PKTCTRL1_ADR_CHK_NONE),
237         RF_PKTCTRL0_OFF,        (RF_PKTCTRL0_WHITE_DATA|
238                                  RF_PKTCTRL0_PKT_FORMAT_NORMAL|
239                                  RF_PKTCTRL0_CRC_EN|
240                                  RF_PKTCTRL0_LENGTH_CONFIG_FIXED),
241 };
242
243 __xdata uint8_t ao_radio_dma;
244 __xdata uint8_t ao_radio_dma_done;
245 __xdata uint8_t ao_radio_done;
246 __xdata uint8_t ao_radio_abort;
247 __xdata uint8_t ao_radio_mutex;
248
249 void
250 ao_radio_general_isr(void) __interrupt 16
251 {
252         S1CON &= ~0x03;
253         if (RFIF & RFIF_IM_TIMEOUT) {
254                 ao_radio_recv_abort();
255                 RFIF &= ~ RFIF_IM_TIMEOUT;
256         } else if (RFIF & RFIF_IM_DONE) {
257                 ao_radio_done = 1;
258                 ao_wakeup(&ao_radio_done);
259                 RFIF &= ~RFIF_IM_DONE;
260         }
261 }
262
263 void
264 ao_radio_set_packet(void)
265 {
266         uint8_t i;
267         for (i = 0; i < sizeof (fixed_pkt_setup); i += 2)
268                 RF[fixed_pkt_setup[i]] = fixed_pkt_setup[i+1];
269 }
270
271 void
272 ao_radio_idle(void)
273 {
274         if (RF_MARCSTATE != RF_MARCSTATE_IDLE)
275         {
276                 do {
277                         RFST = RFST_SIDLE;
278                         ao_yield();
279                 } while (RF_MARCSTATE != RF_MARCSTATE_IDLE);
280         }
281 }
282
283 void
284 ao_radio_get(uint8_t len)
285 {
286         ao_config_get();
287         ao_mutex_get(&ao_radio_mutex);
288         ao_radio_idle();
289         RF_CHANNR = ao_config.radio_channel;
290         RF_FREQ2 = (uint8_t) (ao_config.radio_setting >> 16);
291         RF_FREQ1 = (uint8_t) (ao_config.radio_setting >> 8);
292         RF_FREQ0 = (uint8_t) (ao_config.radio_setting);
293         RF_PKTLEN = len;
294 }
295
296
297 void
298 ao_radio_send(__xdata void *packet, uint8_t size) __reentrant
299 {
300         ao_radio_get(size);
301         ao_radio_done = 0;
302         ao_dma_set_transfer(ao_radio_dma,
303                             packet,
304                             &RFDXADDR,
305                             size,
306                             DMA_CFG0_WORDSIZE_8 |
307                             DMA_CFG0_TMODE_SINGLE |
308                             DMA_CFG0_TRIGGER_RADIO,
309                             DMA_CFG1_SRCINC_1 |
310                             DMA_CFG1_DESTINC_0 |
311                             DMA_CFG1_PRIORITY_HIGH);
312         ao_dma_start(ao_radio_dma);
313         RFST = RFST_STX;
314         __critical while (!ao_radio_done)
315                 ao_sleep(&ao_radio_done);
316         ao_radio_put();
317 }
318
319 uint8_t
320 ao_radio_recv(__xdata void *packet, uint8_t size) __reentrant
321 {
322         ao_radio_abort = 0;
323         ao_radio_get(size - 2);
324         ao_dma_set_transfer(ao_radio_dma,
325                             &RFDXADDR,
326                             packet,
327                             size,
328                             DMA_CFG0_WORDSIZE_8 |
329                             DMA_CFG0_TMODE_SINGLE |
330                             DMA_CFG0_TRIGGER_RADIO,
331                             DMA_CFG1_SRCINC_0 |
332                             DMA_CFG1_DESTINC_1 |
333                             DMA_CFG1_PRIORITY_HIGH);
334         ao_dma_start(ao_radio_dma);
335         RFST = RFST_SRX;
336
337         /* Wait for DMA to be done, for the radio receive process to
338          * get aborted or for a receive timeout to fire
339          */
340         __critical while (!ao_radio_dma_done && !ao_radio_abort)
341                            if (ao_sleep(&ao_radio_dma_done))
342                                    break;
343
344         /* If recv was aborted, clean up by stopping the DMA engine
345          * and idling the radio
346          */
347         if (!ao_radio_dma_done) {
348                 ao_dma_abort(ao_radio_dma);
349                 ao_radio_idle();
350         }
351         ao_radio_put();
352         return ao_radio_dma_done;
353 }
354
355 /*
356  * Wake up a task waiting to receive a radio packet
357  * and tell them to abort the transfer
358  */
359
360 void
361 ao_radio_recv_abort(void)
362 {
363         ao_radio_abort = 1;
364         ao_wakeup(&ao_radio_dma_done);
365 }
366
367 __xdata ao_radio_rdf_value = 0x55;
368
369 void
370 ao_radio_rdf(int ms)
371 {
372         uint8_t i;
373         uint8_t pkt_len;
374
375         /*
376          * Compute the packet length as follows:
377          *
378          * 2000 bps (for a 1kHz tone)
379          * so, for 'ms' milliseconds, we need
380          * 2 * ms bits, or ms / 4 bytes
381          */
382         if (ms > (255 * 4))
383                 ms = 255 * 4;
384         pkt_len = ms >> 2;
385
386         ao_radio_abort = 0;
387         ao_radio_get(pkt_len);
388         ao_radio_done = 0;
389         for (i = 0; i < sizeof (rdf_setup); i += 2)
390                 RF[rdf_setup[i]] = rdf_setup[i+1];
391
392         ao_dma_set_transfer(ao_radio_dma,
393                             &ao_radio_rdf_value,
394                             &RFDXADDR,
395                             pkt_len,
396                             DMA_CFG0_WORDSIZE_8 |
397                             DMA_CFG0_TMODE_SINGLE |
398                             DMA_CFG0_TRIGGER_RADIO,
399                             DMA_CFG1_SRCINC_0 |
400                             DMA_CFG1_DESTINC_0 |
401                             DMA_CFG1_PRIORITY_HIGH);
402         ao_dma_start(ao_radio_dma);
403         RFST = RFST_STX;
404         __critical while (!ao_radio_done && !ao_radio_abort)
405                            ao_sleep(&ao_radio_done);
406         if (!ao_radio_done) {
407                 ao_dma_abort(ao_radio_dma);
408                 ao_radio_idle();
409         }
410         ao_radio_set_packet();
411         ao_radio_put();
412 }
413
414 void
415 ao_radio_rdf_abort(void)
416 {
417         ao_radio_abort = 1;
418         ao_wakeup(&ao_radio_done);
419 }
420
421
422 /* Output carrier */
423 void
424 ao_radio_test(void)
425 {
426         uint8_t mode = 2;
427         static __xdata radio_on;
428         ao_cmd_white();
429         if (ao_cmd_lex_c != '\n') {
430                 ao_cmd_decimal();
431                 mode = (uint8_t) ao_cmd_lex_u32;
432         }
433         mode++;
434         if ((mode & 2) && !radio_on) {
435                 ao_set_monitor(0);
436 #if PACKET_HAS_SLAVE
437                 ao_packet_slave_stop();
438 #endif
439                 ao_radio_get(0xff);
440                 RFST = RFST_STX;
441                 radio_on = 1;
442         }
443         if (mode == 3) {
444                 printf ("Hit a character to stop..."); flush();
445                 getchar();
446                 putchar('\n');
447         }
448         if ((mode & 1) && radio_on) {
449                 ao_radio_idle();
450                 ao_radio_put();
451                 radio_on = 0;
452         }
453 }
454
455 __code struct ao_cmds ao_radio_cmds[] = {
456         { ao_radio_test,        "C <1 start, 0 stop, none both>\0Radio carrier test" },
457         { 0,    NULL },
458 };
459
460 void
461 ao_radio_init(void)
462 {
463         uint8_t i;
464         for (i = 0; i < sizeof (radio_setup); i += 2)
465                 RF[radio_setup[i]] = radio_setup[i+1];
466         ao_radio_set_packet();
467         ao_radio_dma_done = 1;
468         ao_radio_dma = ao_dma_alloc(&ao_radio_dma_done);
469         RFIF = 0;
470         RFIM = RFIM_IM_TIMEOUT|RFIM_IM_DONE;
471         IEN2 |= IEN2_RFIE;
472         ao_cmd_register(&ao_radio_cmds[0]);
473 }