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 void
  30 ao_fec_dump_bytes(uint8_t *bytes, uint16_t len, char *name);
  31
  32 uint16_t
  33 ao_fec_crc(uint8_t *bytes, uint8_t len);
  34
  35 /*
  36  * 'len' is the length of the original data; 'bytes'
  37  * must  be four bytes longer than that, and the first
  38  * two after 'len' must be the received crc
  39  */
  40 uint8_t
  41 ao_fec_check_crc(uint8_t *bytes, uint8_t len);
  42
  43 /*
  44  * Append CRC and terminator bytes, returns resulting length.
  45  * 'out' must be at least len + AO_FEC_PREPARE_EXTRA bytes long
  46  */
  47 uint8_t
  48 ao_fec_prepare(uint8_t *in, uint8_t len, uint8_t *out);
  49
  50 /*
  51  * Whiten data using the cc1111 PN9 sequence. 'out'
  52  * must be 'len' bytes long. 'out' and 'in' can be
  53  * the same array
  54  */
  55 void
  56 ao_fec_whiten(uint8_t *in, uint8_t len, uint8_t *out);
  57
  58 /*
  59  * Encode and interleave data. 'out' must be len*2 bytes long
  60  */
  61 uint8_t
  62 ao_fec_encode(uint8_t *in, uint8_t len, uint8_t *out);
  63
  64 /*
  65  * Decode data. 'in' is one byte per bit, soft decision
  66  * 'out' must be len/8 bytes long
  67  */
  68
  69 #define AO_FEC_DECODE_BLOCK     (8 * 32)        /* callback must return multiples of this many bits */
  70
  71 uint8_t
  72 ao_fec_decode(uint8_t *in, uint16_t in_len, uint8_t *out, uint8_t out_len, uint16_t (*callback)());
  73
  74 /*
  75  * Interleave data packed in bytes. 'out' must be 'len' bytes long.
  76  */
  77 uint16_t
  78 ao_fec_interleave_bytes(uint8_t *in, uint16_t len, uint8_t *out);
  79
  80 #endif /* _AO_FEC_H_ */