Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_lfsr_32k_source_s.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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_LFSR_32K_SOURCE_S_H
24 #define INCLUDED_GR_LFSR_32K_SOURCE_S_H
25
26 #include <gr_sync_block.h>
27 #include <gri_lfsr_32k.h>
28
29 class gr_lfsr_32k_source_s;
30 typedef boost::shared_ptr<gr_lfsr_32k_source_s> gr_lfsr_32k_source_s_sptr;
31
32 gr_lfsr_32k_source_s_sptr gr_make_lfsr_32k_source_s ();
33
34 /*!
35  * \brief LFSR pseudo-random source with period of 2^15 bits (2^11 shorts)
36  * \ingroup source
37  *
38  * This source is typically used along with gr_check_lfsr_32k_s to test
39  * the USRP using its digital loopback mode.
40  */
41 class gr_lfsr_32k_source_s : public gr_sync_block 
42 {
43   friend gr_lfsr_32k_source_s_sptr gr_make_lfsr_32k_source_s ();
44
45   
46   static const int BUFSIZE = 2048 - 1;  // ensure pattern isn't packet aligned
47   int           d_index;
48   short         d_buffer[BUFSIZE];
49
50   gr_lfsr_32k_source_s ();
51
52  public:
53
54   virtual int work (int noutput_items,
55                     gr_vector_const_void_star &input_items,
56                     gr_vector_void_star &output_items);
57 };
58
59
60 #endif