1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,2012,2016 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 3, 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_DIGITAL_GLFSR_H
24 #define INCLUDED_DIGITAL_GLFSR_H
25 
26 #include <gnuradio/digital/api.h>
27 #include <boost/cstdint.hpp>
28 
29 namespace gr {
30 namespace digital {
31 
32 /*!
33  * \brief Galois Linear Feedback Shift Register using specified polynomial mask
34  * \ingroup waveform_generators_blk
35  *
36  * \details
37  * Generates a maximal length pseudo-random sequence of length 2^degree-1
38  */
39 class DIGITAL_API glfsr
40 {
41 private:
42     uint32_t d_shift_register;
43     uint32_t d_mask;
44 
45 public:
glfsr(uint32_t mask,uint32_t seed)46     glfsr(uint32_t mask, uint32_t seed)
47     {
48         d_shift_register = seed;
49         d_mask = mask;
50     }
51     ~glfsr();
52 
53     static uint32_t glfsr_mask(unsigned int degree);
54 
55     uint8_t next_bit();
56 
mask()57     uint32_t mask() const { return d_mask; }
58 };
59 
60 } /* namespace digital */
61 } /* namespace gr */
62 
63 #endif /* INCLUDED_DIGITAL_GLFSR_H */
64