git.gag.com Git - fw/altos/blob - src/drivers/ao_aprs.c

   1 /**
   2  * http://ad7zj.net/kd7lmo/aprsbeacon_code.html
   3  *
   4  * @mainpage Pico Beacon
   5  *
   6  * @section overview_sec Overview
   7  *
   8  * The Pico Beacon is an APRS based tracking beacon that operates in the UHF 420-450MHz band.  The device utilizes a
   9  * Microchip PIC 18F2525 embedded controller, Motorola M12+ GPS engine, and Analog Devices AD9954 DDS.  The device is capable
  10  * of generating a 1200bps A-FSK and 9600 bps FSK AX.25 compliant APRS (Automatic Position Reporting System) message.
  11
  12
  13  *
  14  * @section history_sec Revision History
  15  *
  16  * @subsection v305 V3.05
  17  * 23 Dec 2006, Change include; (1) change printf format width to conform to ANSI standard when new CCS 4.xx compiler released.
  18  *
  19  *
  20  * @subsection v304 V3.04
  21  * 10 Jan 2006, Change include; (1) added amplitude control to engineering mode,
  22  *                                     (2) corrected number of bytes reported in log,
  23  *                                     (3) add engineering command to set high rate position reports (5 seconds), and
  24  *                                     (4) corrected size of LOG_COORD block when searching for end of log.
  25  *
  26  * @subsection v303 V3.03
  27  * 15 Sep 2005, Change include; (1) removed AD9954 setting SDIO as input pin,
  28  *                                     (2) additional comments and Doxygen tags,
  29  *                                     (3) integration and test code calculates DDS FTW,
  30  *                                     (4) swapped bus and reference analog input ports (hardware change),
  31  *                                     (5) added message that indicates we are reading flash log and reports length,
  32  *                                     (6) report bus voltage in 10mV steps, and
  33  *                                     (7) change log type enumerated values to XORed nibbles for error detection.
  34  *
  35  *
  36  * @subsection v302 V3.02
  37  * 6 Apr 2005, Change include; (1) corrected tracked satellite count in NMEA-0183 $GPGGA message,
  38  *                                    (2) Doxygen documentation clean up and additions, and
  39  *                                    (3) added integration and test code to baseline.
  40  *
  41  *
  42  * @subsection v301 V3.01
  43  * 13 Jan 2005, Renamed project and files to Pico Beacon.
  44  *
  45  *
  46  * @subsection v300 V3.00
  47  * 15 Nov 2004, Change include; (1) Micro Beacon extreme hardware changes including integral transmitter,
  48  *                                     (2) PIC18F2525 processor,
  49  *                                     (3) AD9954 DDS support functions,
  50  *                                     (4) added comments and formatting for doxygen,
  51  *                                     (5) process GPS data with native Motorola protocol,
  52  *                                     (6) generate plain text $GPGGA and $GPRMC messages,
  53  *                                     (7) power down GPS 5 hours after lock,
  54  *                                     (8) added flight data recorder, and
  55  *                                     (9) added diagnostics terminal mode.
  56  *
  57  *
  58  * @subsection v201 V2.01
  59  * 30 Jan 2004, Change include; (1) General clean up of in-line documentation, and
  60  *                                     (2) changed temperature resolution to 0.1 degrees F.
  61  *
  62  *
  63  * @subsection v200 V2.00
  64  * 26 Oct 2002, Change include; (1) Micro Beacon II hardware changes including PIC18F252 processor,
  65  *                                     (2) serial EEPROM,
  66  *                                     (3) GPS power control,
  67  *                                     (4) additional ADC input, and
  68  *                                     (5) LM60 temperature sensor.
  69  *
  70  *
  71  * @subsection v101 V1.01
  72  * 5 Dec 2001, Change include; (1) Changed startup message, and
  73  *                                    (2) applied SEPARATE pragma to several methods for memory usage.
  74  *
  75  *
  76  * @subsection v100 V1.00
  77  * 25 Sep 2001, Initial release.  Flew ANSR-3 and ANSR-4.
  78  *
  79
  80
  81  *
  82  *
  83  * @section copyright_sec Copyright
  84  *
  85  * Copyright (c) 2001-2009 Michael Gray, KD7LMO
  86
  87
  88  *
  89  *
  90  * @section gpl_sec GNU General Public License
  91  *
  92  *  This program is free software; you can redistribute it and/or modify
  93  *  it under the terms of the GNU General Public License as published by
  94  *  the Free Software Foundation; either version 2 of the License, or
  95  *  (at your option) any later version.
  96  *
  97  *  This program is distributed in the hope that it will be useful,
  98  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  99  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 100  *  GNU General Public License for more details.
 101  *
 102  *  You should have received a copy of the GNU General Public License
 103  *  along with this program; if not, write to the Free Software
 104  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 105  *
 106
 107
 108  *
 109  *
 110  * @section design Design Details
 111  *
 112  * Provides design details on a variety of the components that make up the Pico Beacon.
 113  *
 114  *  @subpage power
 115  */
 116
 117 /**
 118  *  @page power Power Consumption
 119  *
 120  *  Measured DC power consumption.
 121  *
 122  *  3VDC prime power current
 123
 124  *
 125  *    7mA Held in reset
 126
 127  *   18mA Processor running, all I/O off
 128
 129  *  110mA GPS running
 130
 131  *  120mA GPS running w/antenna
 132
 133  *  250mA DDS running and GPS w/antenna
 134
 135  *  420mA DDS running, GPS w/antenna, and PA chain on with no RF
 136
 137  *  900mA Transmit
 138
 139  *
 140  */
 141
 142 #ifndef AO_APRS_TEST
 143 #include <ao.h>
 144 #endif
 145
 146 #include <ao_aprs.h>
 147
 148 // Public methods, constants, and data structures for each class.
 149
 150 static void timeInit(void);
 151
 152 static void tncInit(void);
 153 static void tnc1200TimerTick(void);
 154
 155 /** @} */
 156
 157 /**
 158  *  @defgroup sys System Library Functions
 159  *
 160  *  Generic system functions similiar to the run-time C library.
 161  *
 162  *  @{
 163  */
 164
 165 /**
 166  *    Calculate the CRC-16 CCITT of buffer that is length bytes long.
 167  *    The crc parameter allow the calculation on the CRC on multiple buffers.
 168  *
 169  *    @param buffer Pointer to data buffer.
 170  *    @param length number of bytes in data buffer
 171  *    @param crc starting value
 172  *
 173  *    @return CRC-16 of buffer[0 .. length]
 174  */
 175 static uint16_t sysCRC16(const uint8_t *buffer, uint8_t length, uint16_t crc)
 176 {
 177     uint8_t i, bit, value;
 178
 179     for (i = 0; i < length; ++i)
 180     {
 181         value = buffer[i];
 182
 183         for (bit = 0; bit < 8; ++bit)
 184         {
 185             crc ^= (value & 0x01);
 186             crc = ( crc & 0x01 ) ? ( crc >> 1 ) ^ 0x8408 : ( crc >> 1 );
 187             value = value >> 1;
 188         } // END for
 189     } // END for
 190
 191     return crc ^ 0xffff;
 192 }
 193
 194 /** @} */
 195
 196 /**
 197  *  @defgroup rtc Real Time Interrupt tick
 198  *
 199  *  Manage the built-in real time interrupt.  The interrupt clock PRI is 104uS (9600 bps).
 200  *
 201  *  @{
 202  */
 203
 204 /// 16-bit NCO where the upper 8-bits are used to index into the frequency generation table.
 205 static uint16_t timeNCO;
 206
 207 /// Audio tone NCO update step (phase).
 208 static uint16_t timeNCOFreq;
 209
 210 /**
 211  *   Initialize the real-time clock.
 212  */
 213 static void timeInit()
 214 {
 215     timeNCO = 0x00;
 216     timeNCOFreq = 0x2000;
 217 }
 218
 219 /** @} */
 220
 221 /**
 222  *  @defgroup tnc TNC (Terminal Node Controller)
 223  *
 224  *  Functions that provide a subset of the TNC functions.
 225  *
 226  *  @{
 227  */
 228
 229 /// The number of start flag bytes to send before the packet message.  (360bits * 1200bps = 300mS)
 230 #define TNC_TX_DELAY 45
 231
 232 /// The size of the TNC output buffer.
 233 #define TNC_BUFFER_SIZE 40
 234
 235 /// States that define the current mode of the 1200 bps (A-FSK) state machine.
 236 typedef enum
 237 {
 238     /// Stand by state ready to accept new message.
 239     TNC_TX_READY,
 240
 241     /// 0x7E bit stream pattern used to define start of APRS message.
 242     TNC_TX_SYNC,
 243
 244     /// Transmit the AX.25 header that contains the source/destination call signs, APRS path, and flags.
 245     TNC_TX_HEADER,
 246
 247     /// Transmit the message data.
 248     TNC_TX_DATA,
 249
 250     /// Transmit the end flag sequence.
 251     TNC_TX_END
 252 } TNC_TX_1200BPS_STATE;
 253
 254 /// AX.25 compliant packet header that contains destination, station call sign, and path.
 255 /// 0x76 for SSID-11, 0x78 for SSID-12
 256 static uint8_t TNC_AX25_HEADER[] = {
 257     'A' << 1, 'P' << 1, 'A' << 1, 'M' << 1, ' ' << 1, ' ' << 1, 0x60, \
 258     'N' << 1, '0' << 1, 'C' << 1, 'A' << 1, 'L' << 1, 'L' << 1, 0x78, \
 259     'W' << 1, 'I' << 1, 'D' << 1, 'E' << 1, '2' << 1, ' ' << 1, 0x65, \
 260     0x03, 0xf0 };
 261
 262 #define TNC_CALLSIGN_OFF        7
 263 #define TNC_CALLSIGN_LEN        6
 264
 265 static void
 266 tncSetCallsign(void)
 267 {
 268 #ifndef AO_APRS_TEST
 269         uint8_t i;
 270
 271         for (i = 0; i < TNC_CALLSIGN_LEN; i++) {
 272                 if (!ao_config.callsign[i])
 273                         break;
 274                 TNC_AX25_HEADER[TNC_CALLSIGN_OFF + i] = ao_config.callsign[i] << 1;
 275         }
 276         for (; i < TNC_CALLSIGN_LEN; i++)
 277                 TNC_AX25_HEADER[TNC_CALLSIGN_OFF + i] = ' ' << 1;
 278 #endif
 279 }
 280
 281 /// The next bit to transmit.
 282 static uint8_t tncTxBit;
 283
 284 /// Current mode of the 1200 bps state machine.
 285 static TNC_TX_1200BPS_STATE tncMode;
 286
 287 /// Counter for each bit (0 - 7) that we are going to transmit.
 288 static uint8_t tncBitCount;
 289
 290 /// A shift register that holds the data byte as we bit shift it for transmit.
 291 static uint8_t tncShift;
 292
 293 /// Index into the APRS header and data array for each byte as we transmit it.
 294 static uint8_t tncIndex;
 295
 296 /// The number of bytes in the message portion of the AX.25 message.
 297 static uint8_t tncLength;
 298
 299 /// A copy of the last 5 bits we've transmitted to determine if we need to bit stuff on the next bit.
 300 static uint8_t tncBitStuff;
 301
 302 /// Buffer to hold the message portion of the AX.25 packet as we prepare it.
 303 static uint8_t tncBuffer[TNC_BUFFER_SIZE];
 304
 305 /**
 306  *   Initialize the TNC internal variables.
 307  */
 308 static void tncInit()
 309 {
 310     tncTxBit = 0;
 311     tncMode = TNC_TX_READY;
 312 }
 313
 314 /**
 315  *   Method that is called every 833uS to transmit the 1200bps A-FSK data stream.
 316  *   The provides the pre and postamble as well as the bit stuffed data stream.
 317  */
 318 static void tnc1200TimerTick()
 319 {
 320     // Set the A-FSK frequency.
 321     if (tncTxBit == 0x00)
 322         timeNCOFreq = 0x2000;
 323     else
 324         timeNCOFreq = 0x3aab;
 325
 326     switch (tncMode)
 327     {
 328         case TNC_TX_READY:
 329             // Generate a test signal alteranting between high and low tones.
 330             tncTxBit = (tncTxBit == 0 ? 1 : 0);
 331             break;
 332
 333         case TNC_TX_SYNC:
 334             // The variable tncShift contains the lastest data byte.
 335             // NRZI enocde the data stream.
 336             if ((tncShift & 0x01) == 0x00) {
 337                 if (tncTxBit == 0)
 338                     tncTxBit = 1;
 339                 else
 340                     tncTxBit = 0;
 341             }
 342
 343             // When the flag is done, determine if we need to send more or data.
 344             if (++tncBitCount == 8)
 345             {
 346                 tncBitCount = 0;
 347                 tncShift = 0x7e;
 348
 349                 // Once we transmit x mS of flags, send the data.
 350                 // txDelay bytes * 8 bits/byte * 833uS/bit = x mS
 351                 if (++tncIndex == TNC_TX_DELAY)
 352                 {
 353                     tncIndex = 0;
 354                     tncShift = TNC_AX25_HEADER[0];
 355                     tncBitStuff = 0;
 356                     tncMode = TNC_TX_HEADER;
 357                 } // END if
 358             } else
 359                 tncShift = tncShift >> 1;
 360             break;
 361
 362         case TNC_TX_HEADER:
 363             // Determine if we have sent 5 ones in a row, if we have send a zero.
 364             if (tncBitStuff == 0x1f)
 365             {
 366                 if (tncTxBit == 0)
 367                     tncTxBit = 1;
 368                 else
 369                     tncTxBit = 0;
 370
 371                 tncBitStuff = 0x00;
 372                 return;
 373             }    // END if
 374
 375             // The variable tncShift contains the lastest data byte.
 376             // NRZI enocde the data stream.
 377             if ((tncShift & 0x01) == 0x00) {
 378                 if (tncTxBit == 0)
 379                     tncTxBit = 1;
 380                 else
 381                     tncTxBit = 0;
 382             }
 383
 384             // Save the data stream so we can determine if bit stuffing is
 385             // required on the next bit time.
 386             tncBitStuff = ((tncBitStuff << 1) | (tncShift & 0x01)) & 0x1f;
 387
 388             // If all the bits were shifted, get the next byte.
 389             if (++tncBitCount == 8)
 390             {
 391                 tncBitCount = 0;
 392
 393                 // After the header is sent, then send the data.
 394                 if (++tncIndex == sizeof(TNC_AX25_HEADER))
 395                 {
 396                     tncIndex = 0;
 397                     tncShift = tncBuffer[0];
 398                     tncMode = TNC_TX_DATA;
 399                 } else
 400                     tncShift = TNC_AX25_HEADER[tncIndex];
 401
 402             } else
 403                 tncShift = tncShift >> 1;
 404
 405             break;
 406
 407         case TNC_TX_DATA:
 408             // Determine if we have sent 5 ones in a row, if we have send a zero.
 409             if (tncBitStuff == 0x1f)
 410             {
 411                 if (tncTxBit == 0)
 412                     tncTxBit = 1;
 413                 else
 414                     tncTxBit = 0;
 415
 416                 tncBitStuff = 0x00;
 417                 return;
 418             }    // END if
 419
 420             // The variable tncShift contains the lastest data byte.
 421             // NRZI enocde the data stream.
 422             if ((tncShift & 0x01) == 0x00) {
 423                 if (tncTxBit == 0)
 424                     tncTxBit = 1;
 425                 else
 426                     tncTxBit = 0;
 427             }
 428
 429             // Save the data stream so we can determine if bit stuffing is
 430             // required on the next bit time.
 431             tncBitStuff = ((tncBitStuff << 1) | (tncShift & 0x01)) & 0x1f;
 432
 433             // If all the bits were shifted, get the next byte.
 434             if (++tncBitCount == 8)
 435             {
 436                 tncBitCount = 0;
 437
 438                 // If everything was sent, transmit closing flags.
 439                 if (++tncIndex == tncLength)
 440                 {
 441                     tncIndex = 0;
 442                     tncShift = 0x7e;
 443                     tncMode = TNC_TX_END;
 444                 } else
 445                     tncShift = tncBuffer[tncIndex];
 446
 447             } else
 448                 tncShift = tncShift >> 1;
 449
 450             break;
 451
 452         case TNC_TX_END:
 453             // The variable tncShift contains the lastest data byte.
 454             // NRZI enocde the data stream.
 455             if ((tncShift & 0x01) == 0x00) {
 456                 if (tncTxBit == 0)
 457                     tncTxBit = 1;
 458                 else
 459                     tncTxBit = 0;
 460             }
 461
 462             // If all the bits were shifted, get the next one.
 463             if (++tncBitCount == 8)
 464             {
 465                 tncBitCount = 0;
 466                 tncShift = 0x7e;
 467
 468                 // Transmit two closing flags.
 469                 if (++tncIndex == 2)
 470                 {
 471                     tncMode = TNC_TX_READY;
 472
 473                     return;
 474                 } // END if
 475             } else
 476                 tncShift = tncShift >> 1;
 477
 478             break;
 479     } // END switch
 480 }
 481
 482 /**
 483  *   Generate the plain text position packet.
 484  */
 485 static int tncPositionPacket(void)
 486 {
 487     int32_t     latitude = ao_gps_data.latitude;
 488     int32_t     longitude = ao_gps_data.longitude;
 489     int32_t     altitude = ao_gps_data.altitude;
 490
 491     uint16_t    lat_deg;
 492     uint16_t    lon_deg;
 493     uint16_t    lat_min;
 494     uint16_t    lat_frac;
 495     uint16_t    lon_min;
 496     uint16_t    lon_frac;
 497
 498     char        lat_sign = 'N', lon_sign = 'E';
 499
 500     if (latitude < 0) {
 501         lat_sign = 'S';
 502         latitude = -latitude;
 503     }
 504
 505     if (longitude < 0) {
 506         lon_sign = 'W';
 507         longitude = -longitude;
 508     }
 509
 510     /* Round latitude and longitude by 0.005 minutes */
 511     latitude = latitude + 833;
 512     if (latitude > 900000000)
 513         latitude = 900000000;
 514     longitude = longitude + 833;
 515     if (longitude > 1800000000)
 516             longitude = 1800000000;
 517
 518     lat_deg = latitude / 10000000;
 519     latitude -= lat_deg * 10000000;
 520     latitude *= 60;
 521     lat_min = latitude / 10000000;
 522     latitude -= lat_min * 10000000;
 523     lat_frac = latitude / 100000;
 524
 525     lon_deg = longitude / 10000000;
 526     longitude -= lon_deg * 10000000;
 527     longitude *= 60;
 528     lon_min = longitude / 10000000;
 529     longitude -= lon_min * 10000000;
 530     lon_frac = longitude / 100000;
 531
 532     if (altitude < 0)
 533         altitude = 0;
 534
 535     altitude = (altitude * (int32_t) 10000 + (3048/2)) / (int32_t) 3048;
 536
 537     return sprintf ((char *) tncBuffer, "=%02u%02u.%02u%c\\%03u%02u.%02u%cO /A=%06u\015",
 538                     lat_deg, lat_min, lat_frac, lat_sign,
 539                     lon_deg, lon_min, lon_frac, lon_sign,
 540                     altitude);
 541 }
 542
 543 static int16_t
 544 tncFill(uint8_t *buf, int16_t len)
 545 {
 546     int16_t     l = 0;
 547     uint8_t     b;
 548     uint8_t     bit;
 549
 550     while (tncMode != TNC_TX_READY && l < len) {
 551         b = 0;
 552         for (bit = 0; bit < 8; bit++) {
 553             b = b << 1 | (timeNCO >> 15);
 554             timeNCO += timeNCOFreq;
 555         }
 556         *buf++ = b;
 557         l++;
 558         tnc1200TimerTick();
 559     }
 560     if (tncMode == TNC_TX_READY)
 561         l = -l;
 562     return l;
 563 }
 564
 565 /**
 566  *    Prepare an AX.25 data packet.  Each time this method is called, it automatically
 567  *    rotates through 1 of 3 messages.
 568  *
 569  *    @param dataMode enumerated type that specifies 1200bps A-FSK or 9600bps FSK
 570  */
 571 void ao_aprs_send(void)
 572 {
 573     uint16_t crc;
 574
 575     timeInit();
 576     tncInit();
 577     tncSetCallsign();
 578
 579     tncLength = tncPositionPacket();
 580
 581     // Calculate the CRC for the header and message.
 582     crc = sysCRC16(TNC_AX25_HEADER, sizeof(TNC_AX25_HEADER), 0xffff);
 583     crc = sysCRC16(tncBuffer, tncLength, crc ^ 0xffff);
 584
 585     // Save the CRC in the message.
 586     tncBuffer[tncLength++] = crc & 0xff;
 587     tncBuffer[tncLength++] = (crc >> 8) & 0xff;
 588
 589     // Prepare the variables that are used in the real-time clock interrupt.
 590     tncBitCount = 0;
 591     tncShift = 0x7e;
 592     tncTxBit = 0;
 593     tncIndex = 0;
 594     tncMode = TNC_TX_SYNC;
 595
 596     ao_radio_send_lots(tncFill);
 597 }
 598
 599 /** @} */