Difference between revisions of "Additive Scrambler"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
m (add definition of LFSR)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Scramble an input stream using a Linear Feedback Shift Register (LFSR).
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
This block scrambles up to 8 bits per byte of the input data stream, starting at the LSB.
 +
The scrambler works by XORing the incoming bit stream by the output of the LFSR. Optionally, after  bits have been processed, the shift register is reset to the  value. This allows processing fixed length vectors of samples.
 +
 
 +
Alternatively, the LFSR can be reset using a reset tag to scramble variable length vectors. However, it cannot be reset between bytes.
 +
 
 +
For details on configuring the LFSR, see [https://www.gnuradio.org/doc/doxygen/classgr_1_1digital_1_1lfsr.html gr::digital::lfsr].
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Param 1 (''R'')
+
; Mask : Polynomial mask for LFSR
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
+
; Seed : Initial shift register contents
 
+
; Length : Shift register length
; Param 2
+
; Count: Number of bytes after which shift register is reset, 0=never
: blah blah blah
+
; Bits per byte : Number of bits per byte
 +
; Reset tag key : When a tag with this key is detected, the shift register is reset (when this is set, count is ignored!)
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==

Latest revision as of 16:00, 27 December 2019

Scramble an input stream using a Linear Feedback Shift Register (LFSR).

This block scrambles up to 8 bits per byte of the input data stream, starting at the LSB. The scrambler works by XORing the incoming bit stream by the output of the LFSR. Optionally, after bits have been processed, the shift register is reset to the value. This allows processing fixed length vectors of samples.

Alternatively, the LFSR can be reset using a reset tag to scramble variable length vectors. However, it cannot be reset between bytes.

For details on configuring the LFSR, see gr::digital::lfsr.

Parameters[edit]

(R): Run-time adjustable

Mask 
Polynomial mask for LFSR
Seed 
Initial shift register contents
Length 
Shift register length
Count
Number of bytes after which shift register is reset, 0=never
Bits per byte 
Number of bits per byte
Reset tag key 
When a tag with this key is detected, the shift register is reset (when this is set, count is ignored!)

Example Flowgraph[edit]

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files[edit]

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO