git.gag.com Git - fw/altos/blob - src/core/ao_fec.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; 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 #ifndef _AO_FEC_H_
  19 #define _AO_FEC_H_
  20
  21 #include <stdint.h>
  22
  23 #define AO_FEC_CRC_INIT                 0xffff
  24 #define AO_FEC_TRELLIS_TERMINATOR       0x0b
  25 #define AO_FEC_PREPARE_EXTRA            4
  26
  27 extern const uint8_t ao_fec_whiten_table[];
  28
  29 #if AO_FEC_DEBUG
  30 void
  31 ao_fec_dump_bytes(const uint8_t *bytes, uint16_t len, const char *name);
  32 #endif
  33
  34 static inline uint16_t
  35 ao_fec_crc_byte(uint8_t byte, uint16_t crc)
  36 {
  37         uint8_t bit;
  38
  39         for (bit = 0; bit < 8; bit++) {
  40                 if (((crc & 0x8000) >> 8) ^ (byte & 0x80))
  41                         crc = (crc << 1) ^ 0x8005;
  42                 else
  43                         crc = (crc << 1);
  44                 byte <<= 1;
  45         }
  46         return crc;
  47 }
  48
  49 uint16_t
  50 ao_fec_crc(const uint8_t *bytes, uint8_t len);
  51
  52 /*
  53  * 'len' is the length of the original data; 'bytes'
  54  * must  be four bytes longer than that, and the first
  55  * two after 'len' must be the received crc
  56  */
  57 uint8_t
  58 ao_fec_check_crc(const uint8_t *bytes, uint8_t len);
  59
  60 /*
  61  * Compute CRC, whiten, convolve and interleave data. 'out' must be (len + 4) * 2 bytes long
  62  */
  63 uint8_t
  64 ao_fec_encode(const uint8_t *in, uint8_t len, uint8_t *out);
  65
  66 /*
  67  * Decode data. 'in' is one byte per bit, soft decision
  68  * 'out' must be len/8 bytes long
  69  */
  70
  71 #define AO_FEC_DECODE_BLOCK     (32)    /* callback must return multiples of this many bits */
  72
  73 #define AO_FEC_DECODE_CRC_OK    0x80    /* stored in out[out_len-1] */
  74
  75 uint8_t
  76 ao_fec_decode(const uint8_t *in, uint16_t in_len, uint8_t *out, uint8_t out_len, uint16_t (*callback)(void));
  77
  78 /*
  79  * Interleave data packed in bytes. 'out' must be 'len' bytes long.
  80  */
  81 uint16_t
  82 ao_fec_interleave_bytes(uint8_t *in, uint16_t len, uint8_t *out);
  83
  84 #endif /* _AO_FEC_H_ */