BladeRF: updated documentation

plugins/samplesink/bladerf1output/readme.md

@@ -36,12 +36,12 @@ The BladeRF Host library is also provided by many Linux distributions (check its
 
 <h3>1: Start/Stop</h3>
 
-Device start / stop button. 
+Device start / stop button.
 
   - Blue triangle icon: device is ready and can be started
   - Red square icon: device is running and can be stopped
   - Magenta (or pink) square icon: an error occurred. In the case the device was accidentally disconnected you may click on the icon, plug back in and start again.
-  
+
 <h3>2: Baseband sample rate</h3>
 
 This is the baseband sample rate in kS/s before interpolation (4) to produce the final stream that is sent to the BladeRF device. Thus this is the device sample rate (6) divided by the interpolation factor (4).
@@ -54,13 +54,45 @@ For interpolation by 32 the size is fixed at 150000 samples, Delay is 150000 / B
 
 For lower interpolation rates the size is calculated to give a fixed delay of 250 ms or 75000 samples whichever is bigger. Below is the delay in seconds vs baseband sample rate in kS/s from 48 to 400 kS/s. The 250 ms delay is reached at 300 kS/s:
 
-![BladeRF1 output plugin FIFO delay other](../../../doc/img/BladeRF1Output_plugin_fifodly_other.png) 
+![BladeRF1 output plugin FIFO delay other](../../../doc/img/BladeRF1Output_plugin_fifodly_other.png)
-  
+
 <h3>3: Frequency</h3>
 
 This is the center frequency of transmission in kHz.
 
-<h3>4: Interpolation factor</h3>
+<h3>4: Tx filter bandwidth</h3>
+
+This is the Tx filter bandwidth in kHz in the LMS6002D device. Possible values are: 1500, 1750, 2500, 2750, 3000, 3840, 5000, 5500, 6000, 7000, 8750, 10000, 12000, 14000, 20000, 28000 kHz.
+
+<h3>5: XB-200 add-on control</h3>
+
+This controls the optional XB-200 add-on when it is fitted to the BladeRF main board. These controls have no effect if the XB-200 board is absent. Options are:
+
+  - **None**: XB-200 is ignored
+  - **Bypass**: XB-200 is passed through
+  - **Auto 1dB**: The 50, 144 and 220 MHz filters are switched on automatically according to the frequency of reception when it is within the -1 dB passband of the filters
+  - **Auto 3dB**: The 50, 144 and 220 MHz filters are switched on automatically according to the frequency of reception when it is within the -3 dB passband of the filters
+  - **Custom**: The signal is routed through a custom filter
+  - **50M**: The signal is routed through the 50 MHz filter
+  - **144M**: The signal is routed through the 144 MHz filter
+  - **222M**: The signal is routed through the 222 MHz filter
+
+<h3>6A: Host to device sample rate / Baseband sample rate input toggle</h3>
+
+Use this toggle button to switch the sample rate input next (6) between host to device sample rate and baseband sample rate input. The button shows the current mode:
+
+  - **SR**: host to device sample rate input mode. The baseband sample rate (2) is the host to device sample rate (6) divided by the interpolation factor (7).
+  - **BB**: baseband sample rate input mode. The host to device sample rate (2) is the baseband sample rate (6) multiplied by the interpolation factor (7).
+
+<h3>6: Sample rate</h3>
+
+This is the BladeRF device DAC sample rate sample rate or baseband sample rate in samples per second (S/s). The control (6A) is used to switch between the two input modes. The device to/from host stream sample rate is the same for the Rx and Tx systems.
+
+The limits are adjusted automatically. In baseband input mode the limits are driven by the interpolation factor (7). You may need to increase this interpolation factor to be able to reach lower values.
+
+Use the wheels to adjust the sample rate. Left click on a digit sets the cursor position at this digit. Right click on a digit sets all digits on the right to zero. This effectively floors value at the digit position. Wheels are moved with the mousewheel while pointing at the wheel or by selecting the wheel with the left mouse click and using the keyboard arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
+
+<h3>7: Interpolation factor</h3>
 
 The baseband stream is interpolated by this value before being sent to the BladeRF device. Possible values are:
 
@@ -71,34 +103,11 @@ The baseband stream is interpolated by this value before being sent to the Blade
   - **16**: multiply baseband stream sample rate by 16
   - **32**: multiply baseband stream sample rate by 32
 
-The main samples buffer is based on the baseband sample rate and will introduce ~500ms delay for interpolation by 16 or lower and ~1s for interpolation by 32. 
+The main samples buffer is based on the baseband sample rate and will introduce ~500ms delay for interpolation by 16 or lower and ~1s for interpolation by 32.
-
-<h3>5: XB-200 add-on control</h3>
-
-This controls the optional XB-200 add-on when it is fitted to the BladeRF main board. These controls have no effect if the XB-200 board is absent. Options are:
-
-  - **None**: XB-200 is ignored
-  - **Bypass**: XB-200 is passed through
-  - **Auto 1dB**: The 50, 144 and 220 MHz filters are switched on automatically according to the frequency of reception when it is within the -1 dB passband of the filters 
-  - **Auto 3dB**: The 50, 144 and 220 MHz filters are switched on automatically according to the frequency of reception when it is within the -3 dB passband of the filters
-  - **Custom**: The signal is routed through a custom filter
-  - **50M**: The signal is routed through the 50 MHz filter 
-  - **144M**: The signal is routed through the 144 MHz filter 
-  - **222M**: The signal is routed through the 222 MHz filter 
-
-<h3>6: Device sample rate</h3>
-
-This is the BladeRF device DAC sample rate in S/s.
-
-Use the wheels to adjust the sample rate. Left click on a digit sets the cursor position at this digit. Right click on a digit sets all digits on the right to zero. This effectively floors value at the digit position. Wheels are moved with the mousewheel while pointing at the wheel or by selecting the wheel with the left mouse click and using the keyboard arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
-
-<h3>7: Tx filter bandwidth</h3>
-
-This is the Tx filter bandwidth in kHz in the LMS6002D device. Possible values are: 1500, 1750, 2500, 2750, 3000, 3840, 5000, 5500, 6000, 7000, 8750, 10000, 12000, 14000, 20000, 28000 kHz.
 
 <h3>8: Variable gain amplifier #1 gain</h3>
 
-The VGA1 (relative) gain can be adjusted from -35 dB to -4 dB in 1 dB steps. The VGA1 is inside the LMS6002D chip and is placed between the baseband filter and the RF mixer. 
+The VGA1 (relative) gain can be adjusted from -35 dB to -4 dB in 1 dB steps. The VGA1 is inside the LMS6002D chip and is placed between the baseband filter and the RF mixer.
 
 <h3>9: Variable gain amplifier #2 gain</h3>
 

plugins/samplesource/bladerf1input/readme.md

@@ -26,19 +26,19 @@ This is the center frequency of reception in kHz.
 
 <h4>1.2: Start/Stop</h4>
 
-Device start / stop button. 
+Device start / stop button.
 
   - Blue triangle icon: device is ready and can be started
   - Green square icon: device is running and can be stopped
   - Magenta (or pink) square icon: an error occurred. In the case the device was accidentally disconnected you may click on the icon, plug back in and start again.
-  
+
 <h4>1.3: Record</h4>
 
 Record baseband I/Q stream toggle button
 
 <h4>1.4: Stream sample rate</h4>
 
-Baseband I/Q sample rate in kS/s. This is the device sample rate (4) divided by the decimation factor (6). 
+Baseband I/Q sample rate in kS/s. This is the device sample rate (4) divided by the decimation factor (6).
 
 <h3>2: Auto correction options</h3>
 
@@ -46,39 +46,48 @@ These buttons control the local DSP auto correction options:
 
   - **DC**: auto remove DC component
   - **IQ**: auto make I/Q balance. The DC correction must be enabled for this to be effective.
-  
+
 <h3>3: XB-200 add-on control</h3>
 
 This controls the optional XB-200 add-on when it is fitted to the BladeRF main board. These controls have no effect if the XB-200 board is absent. Options are:
 
   - **None**: XB-200 is ignored
   - **Bypass**: XB-200 is passed through
-  - **Auto 1dB**: The 50, 144 and 220 MHz filters are switched on automatically according to the frequency of reception when it is within the -1 dB passband of the filters 
+  - **Auto 1dB**: The 50, 144 and 220 MHz filters are switched on automatically according to the frequency of reception when it is within the -1 dB passband of the filters
   - **Auto 3dB**: The 50, 144 and 220 MHz filters are switched on automatically according to the frequency of reception when it is within the -3 dB passband of the filters
   - **Custom**: The signal is routed through a custom filter
-  - **50M**: The signal is routed through the 50 MHz filter 
+  - **50M**: The signal is routed through the 50 MHz filter
-  - **144M**: The signal is routed through the 144 MHz filter 
+  - **144M**: The signal is routed through the 144 MHz filter
-  - **222M**: The signal is routed through the 222 MHz filter 
+  - **222M**: The signal is routed through the 222 MHz filter
 
-<h3>4: Device sample rate</h3>
+<h3>4A: Device sample rate / Baseband sample rate input toggle</h3>
 
-This is the BladeRF device ADC sample rate in S/s.
+Use this toggle button to switch the sample rate input next (4) between device sample rate and baseband sample rate input. The button shows the current mode:
+
+  - **SR**: device sample rate input mode. The baseband sample rate (1.4) is the device sample rate (4) divided by the decimation factor (5).
+  - **BB**: baseband sample rate input mode. The device sample rate (1.4) is the baseband sample rate (4) multiplied by the decimation factor (5).
+
+<h3>4: Sample rate</h3>
+
+This is the BladeRF device ADC sample rate or baseband sample rate in samples per second (S/s). The control (4A) is used to switch between the two input modes.
+
+The limits are adjusted automatically. In baseband input mode the limits are driven by the decimation factor (5). You may need to increase this decimation factor to be able to reach lower values.
 
 Use the wheels to adjust the sample rate. Left click on a digit sets the cursor position at this digit. Right click on a digit sets all digits on the right to zero. This effectively floors value at the digit position. Wheels are moved with the mousewheel while pointing at the wheel or by selecting the wheel with the left mouse click and using the keyboard arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
 
 <h3>5: Decimation factor</h3>
 
-The I/Q stream from the BladeRF ADC is downsampled by a power of two before being sent to the passband. Possible values are increasing powers of two: 1 (no decimation), 2, 4, 8, 16, 32, 64.
+The I/Q stream from the BladeRF ADC is downsampled by a power of two before being sent to the baseband. Possible values are increasing powers of two: 1 (no decimation), 2, 4, 8, 16, 32, 64.
 
 <h3>6: Baseband center frequency position relative the the BladeRF Rx center frequency</h3>
 
 Possible values are:
 
   - **Cen**: the decimation operation takes place around the BladeRF Rx center frequency Fs
-  - **Inf**: the decimation operation takes place around Fs - Fc. 
+  - **Inf**: the decimation operation takes place around Fs - Fc.
   - **Sup**: the decimation operation takes place around Fs + Fc.
-  
+
-With SR as the sample rate before decimation Fc is calculated as: 
+With SR as the sample rate before decimation Fc is calculated as:
 
   - if decimation n is 4 or lower:  Fc = SR/2^(log2(n)-1). The device center frequency is on the side of the baseband. You need a RF filter bandwidth at least twice the baseband.
   - if decimation n is 8 or higher: Fc = SR/n. The device center frequency is half the baseband away from the side of the baseband. You need a RF filter bandwidth at least 3 times the baseband.
@@ -94,7 +103,7 @@ This is the LNA gain in dB. LNA is inside the LMS6002D chip and is placed before
   - **0dB**: no gain
   - **3dB**
   - **6dB**
-  
+
 <h3>9: Variable gain amplifier #1 gain</h3>
 
 The VGA1 gain can be adjusted from 5 dB to 30 dB in 1 dB steps. The VGA1 is inside the LMS6002D chip and is placed between the RF mixer and the baseband filter.