summaryrefslogtreecommitdiff
path: root/gr-digital/include/gnuradio/digital/scrambler_bb.h
diff options
context:
space:
mode:
authorJohnathan Corgan <johnathan@corganlabs.com>2013-04-29 20:59:55 -0700
committerJohnathan Corgan <johnathan@corganlabs.com>2013-04-29 20:59:55 -0700
commitbc462ac6f6841c16fe3f6a777f32589c3b546aba (patch)
treec3561c5c8570caa004e4dedd977d548659920e51 /gr-digital/include/gnuradio/digital/scrambler_bb.h
parenta23eb76138baad68e2a6eb6a53b2d7f87bc1288a (diff)
digital: moved include dir to gnuradio/digital
Diffstat (limited to 'gr-digital/include/gnuradio/digital/scrambler_bb.h')
-rw-r--r--gr-digital/include/gnuradio/digital/scrambler_bb.h60
1 files changed, 60 insertions, 0 deletions
diff --git a/gr-digital/include/gnuradio/digital/scrambler_bb.h b/gr-digital/include/gnuradio/digital/scrambler_bb.h
new file mode 100644
index 0000000000..4ba83daf60
--- /dev/null
+++ b/gr-digital/include/gnuradio/digital/scrambler_bb.h
@@ -0,0 +1,60 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2008,2012 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef INCLUDED_GR_SCRAMBLER_BB_H
+#define INCLUDED_GR_SCRAMBLER_BB_H
+
+#include <gnuradio/digital/api.h>
+#include <gnuradio/sync_block.h>
+
+namespace gr {
+ namespace digital {
+
+ /*!
+ * \brief Scramble an input stream using an LFSR.
+ * \ingroup coding_blk
+ *
+ * \details
+ * This block works on the LSB only of the input data stream,
+ * i.e., on an "unpacked binary" stream, and produces the same
+ * format on its output.
+ */
+ class DIGITAL_API scrambler_bb : virtual public sync_block
+ {
+ public:
+ // gr::digital::scrambler_bb::sptr
+ typedef boost::shared_ptr<scrambler_bb> sptr;
+
+ /*!
+ * Make a scramber block.
+ *
+ * \param mask Polynomial mask for LFSR
+ * \param seed Initial shift register contents
+ * \param len Shift register length
+ */
+ static sptr make(int mask, int seed, int len);
+ };
+
+ } /* namespace digital */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_SCRAMBLER_BB_H */