Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_simple_framer_sync.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2005 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef INCLUDED_GR_SIMPLE_FRAMER_SYNC_H
24 #define INCLUDED_GR_SIMPLE_FRAMER_SYNC_H
25
26 /*
27  * Here are a couple of maximum length sequences (m-sequences) that were generated by the
28  * the "mseq" matlab/octave code downloaded from:
29  * http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=990&objectType=file
30  *
31  * 31-bit m-sequence:
32  *      0110100100001010111011000111110
33  *      0x690AEC76 (padded on right with a zero)
34  *
35  * 63-bit m-sequence:
36  *      101011001101110110100100111000101111001010001100001000001111110
37  *      0xACDDA4E2F28C20FC (padded on right with a zero)
38  */
39
40 static const unsigned long long GRSF_SYNC = 0xacdda4e2f28c20fcULL;
41
42 static const int GRSF_BITS_PER_BYTE = 8;
43 static const int GRSF_SYNC_OVERHEAD = sizeof(GRSF_SYNC);
44 static const int GRSF_PAYLOAD_OVERHEAD = 1;                     // 1 byte seqno
45 static const int GRSF_TAIL_PAD = 1;                             // one byte trailing padding
46 static const int GRSF_OVERHEAD = GRSF_SYNC_OVERHEAD + GRSF_PAYLOAD_OVERHEAD + GRSF_TAIL_PAD; 
47
48
49 #endif /* INCLUDED_GR_SIMPLE_FRAMER_SYNC_H */