altos: Add the simplest possible viterbi decoder
[fw/altos] / 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 void
28 ao_fec_dump_bytes(uint8_t *bytes, uint8_t len, char *name);
29
30 uint16_t
31 ao_fec_crc(uint8_t *bytes, uint8_t len);
32
33 /*
34  * Append CRC and terminator bytes, returns resulting length.
35  * 'out' must be at least len + AO_FEC_PREPARE_EXTRA bytes long
36  */
37 uint8_t
38 ao_fec_prepare(uint8_t *in, uint8_t len, uint8_t *out);
39
40 /*
41  * Whiten data using the cc1111 PN9 sequence. 'out'
42  * must be 'len' bytes long. 'out' and 'in' can be
43  * the same array
44  */
45 uint8_t
46 ao_fec_whiten(uint8_t *in, uint8_t len, uint8_t *out);
47
48 /*
49  * Encode data. 'out' must be len*2 bytes long
50  */
51 uint8_t
52 ao_fec_encode(uint8_t *in, uint8_t len, uint8_t *out);
53
54 /*
55  * Interleave data. 'out' must be 'len' bytes long
56  */
57 uint8_t
58 ao_fec_interleave(uint8_t *in, uint8_t len, uint8_t *out);
59
60
61 /*
62  * Decode data. 'in' is one byte per bit, soft decision
63  * 'out' must be len/8 bytes long
64  */
65
66 uint8_t
67 ao_fec_decode(uint8_t *in, int in_len, uint8_t *out);
68
69 #endif /* _AO_FEC_H_ */