File: cmd_help.h.in

package info (click to toggle)
bladerf 0.2017.12~rc1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 14,620 kB
  • sloc: ansic: 50,123; vhdl: 12,873; python: 1,062; tcl: 1,060; xml: 1,017; makefile: 657; sh: 589; csh: 18; cpp: 9
file content (868 lines) | stat: -rw-r--r-- 32,444 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
/**
 * @file cmd_help.h
 *
 * @brief Autogenerated interactive CLI help
 *
 * This file is part of the bladeRF project
 *
 * Copyright (C) 2014-2016 Nuand LLC
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/**
 * WARNING: THIS FILE IS AUTOMATICALLY GENERATED BY GENERATE.BASH.
 * Any manual modifications to this file will be overwritten!
 * To edit the content of help strings, please edit interactive-help.md
 *
 * Last generated: Tue Jul 12 18:41:06 EDT 2016 by jynik
 */

#ifndef BLADERF_CLI_DOC_CMD_HELP_H__
#define BLADERF_CLI_DOC_CMD_HELP_H__



#define CLI_CMD_HELPTEXT_calibrate \
  "Usage: calibrate <operation> [options]\n" \
  "\n" \
  "Perform the specified transceiver calibration operation.\n" \
  "\n" \
  "Available operations:\n" \
  "\n" \
  "-   LMS internal DC offset auto-calibrations\n" \
  "\n" \
  "    -   calibrate lms [show]\n" \
  "    -   calibrate lms tuning [value]\n" \
  "    -   calibrate lms txlpf [<I filter> <Q filter>]\n" \
  "    -   calibrate lms rxlpf [<I filter> <Q filter>]\n" \
  "    -   calibrate lms rxvga2 [<DC ref> <I1> <Q1> <I2> <Q2>]\n" \
  "\n" \
  "    Perform the specified auto-calibration, or all of them if none\n" \
  "    are provided. When values are provided, these are used instead of\n" \
  "    the results of the auto-calibration procedure. Use lms show to\n" \
  "    read and print the current LMS calibration values.\n" \
  "\n" \
  "    For rxvga2, I1 and Q1 are the Stage 1 I and Q components\n" \
  "    respectively, and I2 and Q2 are the Stage 2 I and Q components.\n" \
  "\n" \
  "-   RX and TX I/Q DC offset correction parameter calibration\n" \
  "\n" \
  "    -   calibrate dc <rx|tx> [<I> <Q>]\n" \
  "    -   calibrate dc <rxtx>\n" \
  "\n" \
  "    Calibrate the DC offset correction parameters for the current\n" \
  "    frequency and gain settings. If a I/Q values are provided, they\n" \
  "    are applied directly. cal rxtx is shorthand for cal rx followed by\n" \
  "    cal tx.\n" \
  "\n" \
  "-   RX and TX I/Q balance correction parameter calibration\n" \
  "\n" \
  "    -   calibrate iq <rx|tx> <gain|phase> <value>\n" \
  "\n" \
  "    Set the specified IQ gain or phase balance parameters.\n" \
  "\n" \
  "-   Generate RX or TX I/Q DC correction parameter tables\n" \
  "\n" \
  "    -   calibrate table dc <rx|tx> [<f_min> <f_max> [f_inc]]\n" \
  "\n" \
  "    Generate and write an I/Q correction parameter table to the\n" \
  "    current working directory, in a file named\n" \
  "    <serial>_dc_<rx|tx>.tbl. f_min and f_max are min and max\n" \
  "    frequencies to include in the table. f_inc is the\n" \
  "    frequency increment.\n" \
  "\n" \
  "    By default, tables are generated over the entire frequency range,\n" \
  "    in 10 MHz steps.\n" \
  "\n" \
  "-   Generate RX or TX I/Q DC correction parameter tables for AGC Look Up Table\n" \
  "\n" \
  "    -   `calibrate table agc <rx|tx> [<f_min> <f_max> [f_inc]]`\n" \
  "\n" \
  "     Similar usage as `calibrate table dc` except the call will set gains to\n" \
  "     the AGC's base gain value before running `calibrate table dc`.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_clear \
  "Usage: clear\n" \
  "\n" \
  "Clears the screen.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_echo \
  "Usage: echo [arg 1] [arg 2] ... [arg n]\n" \
  "\n" \
  "Echo each argument on a new line.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_erase \
  "Usage: erase <offset> <count>\n" \
  "\n" \
  "Erase specified erase blocks SPI flash.\n" \
  "\n" \
  "-   <offset> - Erase block offset\n" \
  "-   <count> - Number of erase blocks to erase\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_flash_backup \
  "Usage: flash_backup <file> (<type> | <address> <length>)\n" \
  "\n" \
  "Back up flash data to the specified file. This command takes either\n" \
  "two or four arguments. The two-argument invocation is generally\n" \
  "recommended for non-development use.\n" \
  "\n" \
  "Parameters:\n" \
  "\n" \
  "-   <type> - Type of backup.\n" \
  "\n" \
  "    This selects the appropriate address and length values based upon\n" \
  "    the selected type.\n" \
  "\n" \
  "    Valid options are:\n" \
  "\n" \
  "            Option Description\n" \
  "      ------------ ------------------------------------------------------\n" \
  "               cal Calibration data\n" \
  "                fw Firmware\n" \
  "            fpga40 Metadata and bitstream for 40 kLE FPGA\n" \
  "           fpga115 Metadata and bitstream for 115 kLE FPGA\n" \
  "\n" \
  "-   <address> - Address of data to back up. Must be\n" \
  "    erase block-aligned.\n" \
  "-   <len> - Length of region to back up. Must be erase block-aligned.\n" \
  "\n" \
  "Note: When an address and length are provided, the image type will\n" \
  "default to raw.\n" \
  "\n" \
  "Examples:\n" \
  "\n" \
  "-   flash_backup cal.bin cal\n" \
  "\n" \
  "    Backs up the calibration data region.\n" \
  "\n" \
  "-   flash_backup cal_raw.bin 0x30000 0x10000\n" \
  "\n" \
  "    Backs up the calibration region as a raw data image.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_flash_image \
  "Usage: flash_image <image> [output options]\n" \
  "\n" \
  "Print a flash image's metadata or create a new flash image. When\n" \
  "provided with the name of a flash image file as the only argument,\n" \
  "this command will print the metadata contents of the image.\n" \
  "\n" \
  "The following options may be used to create a new flash image.\n" \
  "\n" \
  "-   data=<file>\n" \
  "\n" \
  "    File to containing data to store in the image.\n" \
  "\n" \
  "-   address=<addr>\n" \
  "\n" \
  "    Flash address. The default depends upon type parameter.\n" \
  "\n" \
  "-   type=<type>\n" \
  "\n" \
  "    Type of flash image. Defaults to raw.\n" \
  "\n" \
  "    Valid options are:\n" \
  "\n" \
  "      -------------------------------------------------------------------\n" \
  "            Option Description\n" \
  "      ------------ ------------------------------------------------------\n" \
  "               cal Calibration data\n" \
  "\n" \
  "                fw Firmware\n" \
  "\n" \
  "            fpga40 Metadata and bitstream for 40 kLE FPGA\n" \
  "\n" \
  "           fpga115 Metadata and bitstream for 115 kLE FPGA\n" \
  "\n" \
  "               raw Raw data. The address and length parameters must be\n" \
  "                   provided if this type is selected.\n" \
  "      -------------------------------------------------------------------\n" \
  "\n" \
  "-   serial=<serial>\n" \
  "\n" \
  "    Serial # to store in image. Defaults to zeros.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_flash_init_cal \
  "Usage: flash_init_cal <fpga_size> <vctcxo_trim> [<output_file>]\n" \
  "\n" \
  "Create and write a new calibration data region to the currently opened\n" \
  "device, or to a file. Be sure to back up calibration data prior to\n" \
  "running this command. (See the flash_backup command.)\n" \
  "\n" \
  "-   <fpga_size>\n" \
  "\n" \
  "    Either 40 or 115, depending on the device model.\n" \
  "\n" \
  "-   <vctcxo_trim>\n" \
  "\n" \
  "    VCTCXO/DAC trim value (0x0-0xffff)\n" \
  "\n" \
  "-   <output_file>\n" \
  "\n" \
  "    File to write calibration data to. When this argument is provided,\n" \
  "    no data will be written to the device's flash.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_flash_restore \
  "Usage: flash_restore <file> [<address> <length>]\n" \
  "\n" \
  "Restore flash data from a file, optionally overriding values in the\n" \
  "image metadata.\n" \
  "\n" \
  "-   <address>\n" \
  "\n" \
  "    Defaults to the address specified in the provided flash\n" \
  "    image file.\n" \
  "\n" \
  "-   <length>\n" \
  "\n" \
  "    Defaults to length of the data in the provided image file.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_fw_log \
  "Usage: fw_log [filename]\n" \
  "\n" \
  "Read the contents of the device's firmware log and write it to the\n" \
  "specified file. If no filename is specified, the log content is\n" \
  "written to stdout.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_help \
  "Usage: help [<command>]\n" \
  "\n" \
  "Provides extended help, like this, on any command.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_info \
  "Usage: info\n" \
  "\n" \
  "Prints the following information about an opened device:\n" \
  "\n" \
  "-   Serial number\n" \
  "-   VCTCXO DAC calibration value\n" \
  "-   FPGA size\n" \
  "-   Whether or not the FPGA is loaded\n" \
  "-   USB bus, address, and speed\n" \
  "-   Backend (Denotes which device interface code is being used.)\n" \
  "-   Instance number\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_jump_to_boot \
  "Usage: jump_to_boot\n" \
  "\n" \
  "Clear out a FW signature word in flash and jump to FX3 bootloader.\n" \
  "\n" \
  "The device will continue to boot into the FX3 bootloader across power\n" \
  "cycles until new firmware is written to the device.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_load \
  "Usage: load <fpga|fx3> <filename>\n" \
  "\n" \
  "Load an FPGA bitstream or program the FX3's SPI flash.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_xb \
  "Usage: xb <board_model> <subcommand> [parameters]\n" \
  "\n" \
  "Enable or configure an expansion board.\n" \
  "\n" \
  "Valid values for board_model:\n" \
  "\n" \
  "-   100\n" \
  "\n" \
  "    XB-100 GPIO expansion board\n" \
  "\n" \
  "-   200\n" \
  "\n" \
  "    XB-200 LF/MF/HF/VHF transverter expansion board\n" \
  "\n" \
  "-   300\n" \
  "\n" \
  "    XB-300 amplifier board\n" \
  "\n" \
  "Common subcommands:\n" \
  "\n" \
  "-   enable\n" \
  "\n" \
  "    Enable the XB-100, XB-200, or XB-300 expansion board.\n" \
  "\n" \
  "XB-200 subcommands:\n" \
  "\n" \
  "-   filter [rx|tx] [50|144|222|custom|auto_1db|auto_3db]\n" \
  "\n" \
  "    Selects the specified RX or TX filter on the XB-200 board. Below\n" \
  "    are descriptions of each of the filter options.\n" \
  "\n" \
  "    -   50\n" \
  "\n" \
  "            Select the 50-54 MHz (6 meter band) filter.\n" \
  "\n" \
  "    -   144\n" \
  "\n" \
  "            Select the 144-148 MHz (2 meter band) filter.\n" \
  "\n" \
  "    -   222\n" \
  "\n" \
  "            Select the 222-225 MHz (1.25 meter band) filter. Realistically,\n" \
  "            this filter option is actually slightly wider, covering\n" \
  "            206 MHz - 235 MHz.\n" \
  "\n" \
  "    -   custom\n" \
  "\n" \
  "            Selects the custom filter path. The user should connect a filter\n" \
  "            along the corresponding FILT and FILT-ANT connections when using\n" \
  "            this option.  Alternatively one may jumper the FILT and FILT-ANT\n" \
  "            connections to achieve \"no filter\" for reception. (However, this is\n" \
  "            _highly_ discouraged for transmissions.)\n" \
  "\n" \
  "    -   auto_1db\n" \
  "\n" \
  "            Automatically selects one of the above choices based upon frequency\n" \
  "            and the filters' 1dB points. The custom path is used for cases\n" \
  "            that are not associated with the on-board filters.\n" \
  "\n" \
  "    -   auto_3db\n" \
  "\n" \
  "            Automatically selects one of the above choices based upon frequency\n" \
  "            and the filters' 3dB points. The custom path is used for cases\n" \
  "            that are not associated with the on-board filters.\n" \
  "\n" \
  "XB-300 subcommands:\n" \
  "\n" \
  "-   <pa|lna|aux> [on|off]\n" \
  "\n" \
  "    Enable or disable the power amplifier (PA), low-noise\n" \
  "    amplifier (lna) or auxiliary LNA (aux). The current state if the\n" \
  "    specified device is printed if [on|off] is not specified.\n" \
  "\n" \
  "    Note: The auxiliary path on the XB-300 is not populated with\n" \
  "    components by default; the aux control will have no effect upon\n" \
  "    the RX signal. This option is available for users to modify their\n" \
  "    board with custom hardware.\n" \
  "\n" \
  "-   <pwr>\n" \
  "\n" \
  "    Read the current Power Detect (PDET) voltage and compute the\n" \
  "    output power.\n" \
  "\n" \
  "-   trx <rx|tx>\n" \
  "\n" \
  "    The default XB-300 hardware configuration includes separate RX and\n" \
  "    TX paths. However, users wishing to use only a single antenna for\n" \
  "    TRX can do so via a modification to resistor population options on\n" \
  "    the XB-300 and use this command to switch between RX an\n" \
  "    TX operation. (See R8, R10, and R23 on the schematic.)\n" \
  "\n" \
  "Examples:\n" \
  "\n" \
  "-   xb 200 enable\n" \
  "\n" \
  "    Enables and configures the XB-200 transverter expansion board.\n" \
  "\n" \
  "-   xb 200 filter rx 144\n" \
  "\n" \
  "    Selects the 144-148 MHz receive filter on the XB-200 transverter\n" \
  "    expansion board.\n" \
  "\n" \
  "-   xb 300 enable\n" \
  "\n" \
  "    Enables and configures the use of GPIOs to interact with\n" \
  "    the XB-300. The PA and LNA will disabled by default.\n" \
  "\n" \
  "-   xb 300 lna on\n" \
  "\n" \
  "    Enables the RX LNA on the XB-300. LED D1 (green) is illuminated\n" \
  "    when the LNA is enabled, and off when it is disabled.\n" \
  "\n" \
  "-   xb 300 pa off\n" \
  "\n" \
  "    Disables the TX PA on the XB-300. LED D2 (blue) is illuminated\n" \
  "    when the PA is enabled, and off when it is disabled.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_mimo \
  "Usage: mimo [master | slave]\n" \
  "\n" \
  "Modify device MIMO operation.\n" \
  "\n" \
  "IMPORTANT: This command is deprecated and has been superseded by\n" \
  "\"print/set smb_mode\". For usage text, run: \"set smb_mode\"\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_open \
  "Usage: open [device identifiers]\n" \
  "\n" \
  "Open the specified device for use with successive commands. Any\n" \
  "previously opened device will be closed.\n" \
  "\n" \
  "The general form of the device identifier string is:\n" \
  "\n" \
  "<backend>:[device=<bus>:<addr>] [instance=<n>] [serial=<serial>]\n" \
  "\n" \
  "See the bladerf_open() documentation in libbladeRF for the complete\n" \
  "device specifier format.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_peek \
  "Usage: peek <dac|lms|si> <address> [num_addresses]\n" \
  "\n" \
  "The peek command can read any of the devices hanging off the FPGA\n" \
  "which includes the LMS6002D transceiver, VCTCXO trim DAC or the Si5338\n" \
  "clock generator chip.\n" \
  "\n" \
  "If num_addresses is supplied, the address is incremented by 1 and\n" \
  "another peek is performed for that many addresses.\n" \
  "\n" \
  "Valid Address Ranges:\n" \
  "\n" \
  "    Device Address Range\n" \
  "  -------- ---------------\n" \
  "       dac 0 to 255\n" \
  "       lms 0 to 127\n" \
  "        si 0 to 255\n" \
  "\n" \
  "Example:\n" \
  "\n" \
  "-   peek si ...\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_poke \
  "Usage: poke <dac|lms|si> <address> <data>\n" \
  "\n" \
  "The poke command can write any of the devices hanging off the FPGA\n" \
  "which includes the LMS6002D transceiver, VCTCXO trim DAC or the Si5338\n" \
  "clock generator chip.\n" \
  "\n" \
  "Valid Address Ranges:\n" \
  "\n" \
  "    Device Address Range\n" \
  "  -------- ---------------\n" \
  "       dac 0 to 255\n" \
  "       lms 0 to 127\n" \
  "        si 0 to 255\n" \
  "\n" \
  "Example:\n" \
  "\n" \
  "-   poke lms ...\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_print \
  "Usage: print [parameter]\n" \
  "\n" \
  "The print command takes a parameter to print. Available parameters are\n" \
  "listed below. If no parameter is specified, all parameters are\n" \
  "printed.\n" \
  "\n" \
  "       Parameter Description\n" \
  "  -------------- --------------------------------------------------------\n" \
  "       bandwidth Bandwidth settings\n" \
  "       frequency Frequency settings\n" \
  "            gpio FX3 <-> FPGA GPIO state\n" \
  "        loopback Loopback settings\n" \
  "         lnagain Gain setting of the RX LNA, in dB\n" \
  "          rx_mux FPGA RX FIFO input mux setting\n" \
  "          rxvga1 Gain setting of RXVGA1, in dB\n" \
  "          rxvga2 Gain setting of RXVGA2, in dB\n" \
  "          txvga1 Gain setting of TXVGA1, in dB\n" \
  "          txvga2 Gain setting of TXVGA2, in dB\n" \
  "        sampling External or internal sampling mode\n" \
  "      samplerate Samplerate settings\n" \
  "        smb_mode SMB clock port mode of operation\n" \
  "         trimdac VCTCXO Trim DAC settings\n" \
  "    vctcxo_tamer Current VCTCXO tamer mode.\n" \
  "         xb_gpio Expansion board GPIO values\n" \
  "     xb_gpio_dir Expansion board GPIO direction (1=output, 0=input)\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_probe \
  "Usage: probe [strict]\n" \
  "\n" \
  "Search for attached bladeRF device and print a list of results.\n" \
  "\n" \
  "Without specifying strict, the lack of any available devices is not\n" \
  "considered an error.\n" \
  "\n" \
  "When provided the optional strict argument, this command will treat\n" \
  "the situation where no devices are found as an error, causing scripts\n" \
  "or lists of commands provided via the -e command line argument to\n" \
  "terminate immediately.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_quit \
  "Usage: quit\n" \
  "\n" \
  "Exit the CLI.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_recover \
  "Usage: recover [<bus> <address> <firmware file>]\n" \
  "\n" \
  "Load firmware onto a device running in bootloader mode, or list all\n" \
  "devices currently in bootloader mode.\n" \
  "\n" \
  "With no arguments, this command lists the USB bus and address for\n" \
  "FX3-based devices running in bootloader mode.\n" \
  "\n" \
  "When provided a bus, address, and path to a firmware file, the\n" \
  "specified device will be loaded with and begin executing the provided\n" \
  "firmware.\n" \
  "\n" \
  "In most cases, after successfully loading firmware into the device's\n" \
  "RAM, users should open the device with the \"open\" command, and write\n" \
  "the firmware to flash via \"load fx3 <firmware file>\"\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_run \
  "Usage: run <script>\n" \
  "\n" \
  "Run the provided script.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_rx \
  "Usage: rx <start | stop | wait | config [param=val [param=val [...]]>\n" \
  "\n" \
  "Receive IQ samples and write them to the specified file. Reception is\n" \
  "controlled and configured by one of the following:\n" \
  "\n" \
  "  -----------------------------------------------------------------------\n" \
  "       Command Description\n" \
  "  ------------ ----------------------------------------------------------\n" \
  "         start Start receiving samples\n" \
  "\n" \
  "          stop Stop receiving samples\n" \
  "\n" \
  "          wait Wait for sample transmission to complete, or until a\n" \
  "               specified amount of time elapses\n" \
  "\n" \
  "        config Configure sample reception. If no parameters are provided,\n" \
  "               the current parameters are printed.\n" \
  "  -----------------------------------------------------------------------\n" \
  "\n" \
  "Running rx without any additional commands is valid shorthand for\n" \
  "rx config.\n" \
  "\n" \
  "The wait command takes an optional timeout parameter. This parameter\n" \
  "defaults to units of milliseconds (ms). The timeout unit may be\n" \
  "specified using the ms or s suffixes. If this parameter is not\n" \
  "provided, the command will wait until the reception completes or\n" \
  "Ctrl-C is pressed.\n" \
  "\n" \
  "Configuration parameters take the form param=value, and may be\n" \
  "specified in a single or multiple rx config invocations. Below is a\n" \
  "list of available parameters.\n" \
  "\n" \
  "  -----------------------------------------------------------------------\n" \
  "         Parameter Description\n" \
  "  ---------------- ------------------------------------------------------\n" \
  "                 n Number of samples to receive. 0 = inf.\n" \
  "\n" \
  "              file Filename to write received samples to\n" \
  "\n" \
  "            format Output file format. One of the following:\n" \
  "\n" \
  "                   csv: CSV of SC16 Q11 samples\n" \
  "\n" \
  "                   bin: Raw SC16 Q11 DAC samples\n" \
  "\n" \
  "           samples Number of samples per buffer to use in the\n" \
  "                   asynchronous stream. Must be divisible by 1024 and >=\n" \
  "                   1024.\n" \
  "\n" \
  "           buffers Number of sample buffers to use in the asynchronous\n" \
  "                   stream. The min value is 4.\n" \
  "\n" \
  "             xfers Number of simultaneous transfers to allow the\n" \
  "                   asynchronous stream to use. This should be less than\n" \
  "                   the buffers parameter.\n" \
  "\n" \
  "           timeout Data stream timeout. With no suffix, the default unit\n" \
  "                   is ms. The default value is 1000 ms (1 s). Valid\n" \
  "                   suffixes are ms and s.\n" \
  "  -----------------------------------------------------------------------\n" \
  "\n" \
  "Example:\n" \
  "\n" \
  "-   rx config file=/tmp/data.bin format=bin n=10K\n" \
  "\n" \
  "    Receive (10240 = 10 * 1024) samples, writing them to /tmp/data.bin\n" \
  "    in the binary DAC format.\n" \
  "\n" \
  "Notes:\n" \
  "\n" \
  "-   The n, samples, buffers, and xfers parameters support the suffixes\n" \
  "    K, M, and G, which are multiples of 1024.\n" \
  "-   An rx stop followed by an rx start will result in the samples file\n" \
  "    being truncated. If this is not desired, be sure to run rx config\n" \
  "    to set another file before restarting the rx stream.\n" \
  "-   For higher sample rates, it is advised that the binary output\n" \
  "    format be used, and the output file be written to RAM (e.g. /tmp,\n" \
  "    /dev/shm), if space allows. For larger captures at higher sample\n" \
  "    rates, consider using an SSD instead of a HDD.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_trigger \
  "Usage: trigger [<trigger> <tx | rx> [<off slave master fire>]]\n" \
  "\n" \
  "If used without parameters, this command prints the state of all\n" \
  "triggers. When aand and supplied, the specified trigger is printed.\n" \
  "\n" \
  "Below are the available options for :\n" \
  "\n" \
  "       Trigger Description\n" \
  "  ------------ ----------------------------------------------------------\n" \
  "         J71-4 Trigger signal is on mini_exp1 (J71, pin 4).\n" \
  "\n" \
  "The trigger is controlled and configured by providing the last\n" \
  "argument, which may be one of the following:\n" \
  "\n" \
  "  -----------------------------------------------------------------------\n" \
  "       Command Description\n" \
  "  ------------ ----------------------------------------------------------\n" \
  "           off Clears fire request and disables trigger functionality.\n" \
  "\n" \
  "         slave Configures trigger as slave, clears fire request, and arms\n" \
  "               the device.\n" \
  "\n" \
  "        master Configures trigger as master, clears fire request, and\n" \
  "               arms the device.\n" \
  "\n" \
  "          fire Sets fire request. Only applicable to the master.\n" \
  "  -----------------------------------------------------------------------\n" \
  "\n" \
  "A trigger chain consists of a single or multiple bladeRF units and may\n" \
  "contain TX and RX modules. If multiple bladeRF units are used they\n" \
  "need to be connected via the signal specified by and a common ground.\n" \
  "\n" \
  "The following sequence of commands should be used to ensure proper\n" \
  "synchronization. It is assumed that all triggers are off initially.\n" \
  "\n" \
  "1.  Configure designated trigger master\n" \
  "\n" \
  "    IMPORTANT\n" \
  "\n" \
  "        Never configure two devices as trigger masters on a single chain.\n" \
  "        Contention on the same signal could damage the devices.\n" \
  "\n" \
  "2.  Configure all other devices as trigger slaves\n" \
  "\n" \
  "3.  Configure and start transmit or receive streams.\n" \
  "\n" \
  "        The operation will stall until the triggers fire. As such, sufficiently\n" \
  "        large timeouts should be used to allow the trigger signal to be emitted\n" \
  "        by the master and received by the slaves prior to libbladeRF returning\n" \
  "        BLADERF_ERR_TIMEOUT.\n" \
  "\n" \
  "4.  Set fire-request on master trigger\n" \
  "\n" \
  "        All devices will synchronously start transmitting or receiving data.\n" \
  "\n" \
  "5.  Finish the transmit and receive tasks as usual\n" \
  "\n" \
  "6.  Re-configure the master and slaves to clear fire requests\n" \
  "    and re-arm.\n" \
  "\n" \
  "        Steps 1 through 5 may be repeated as necessary.\n" \
  "\n" \
  "7.  Disable triggering on all slaves\n" \
  "\n" \
  "8.  Disable triggering on master\n" \
  "\n" \
  "Notes:\n" \
  "\n" \
  "-   Synchronizing transmitters and receivers on a single chain will\n" \
  "    cause an offset of 11 samples between TX and RX; these samples\n" \
  "    should be discarded. This is caused by different processing\n" \
  "    pipeline lengths of TX and RX. This value might change if the FPGA\n" \
  "    code is updated in the future.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_tx \
  "Usage: tx <start | stop | wait | config [parameters]>\n" \
  "\n" \
  "Read IQ samples from the specified file and transmit them.\n" \
  "Transmission is controlled and configured by one of the following:\n" \
  "\n" \
  "  -----------------------------------------------------------------------\n" \
  "       Command Description\n" \
  "  ------------ ----------------------------------------------------------\n" \
  "         start Start transmitting samples\n" \
  "\n" \
  "          stop Stop transmitting samples\n" \
  "\n" \
  "          wait Wait for sample transmission to complete, or until a\n" \
  "               specified amount of time elapses\n" \
  "\n" \
  "        config Configure sample transmission. If no parameters are\n" \
  "               provided, the current parameters are printed.\n" \
  "  -----------------------------------------------------------------------\n" \
  "\n" \
  "Running tx without any additional commands is valid shorthand for\n" \
  "tx config.\n" \
  "\n" \
  "The wait command takes an optional timeout parameter. This parameter\n" \
  "defaults to units of milliseconds (ms). The timeout unit may be\n" \
  "specified using the ms or s suffixes. If this parameter is not\n" \
  "provided, the command will wait until the transmission completes or\n" \
  "Ctrl-C is pressed.\n" \
  "\n" \
  "Configuration parameters take the form param=value, and may be\n" \
  "specified in a single or multiple tx config invocations. Below is a\n" \
  "list of available parameters.\n" \
  "\n" \
  "  -----------------------------------------------------------------------\n" \
  "         Parameter Description\n" \
  "  ---------------- ------------------------------------------------------\n" \
  "              file Filename to read samples from\n" \
  "\n" \
  "            format Input file format. One of the following:\n" \
  "\n" \
  "                   csv: CSV of SC16 Q11 samples ([-2048, 2047])\n" \
  "\n" \
  "                   bin: Raw SC16 Q11 DAC samples ([-2048, 2047])\n" \
  "\n" \
  "            repeat The number of times the file contents should be\n" \
  "                   transmitted. 0 implies repeat until stopped.\n" \
  "\n" \
  "             delay The number of microseconds to delay between\n" \
  "                   retransmitting file contents. 0 implies no delay.\n" \
  "\n" \
  "           samples Number of samples per buffer to use in the\n" \
  "                   asynchronous stream. Must be divisible by 1024 and >=\n" \
  "                   1024.\n" \
  "\n" \
  "           buffers Number of sample buffers to use in the asynchronous\n" \
  "                   stream. The min value is 4.\n" \
  "\n" \
  "             xfers Number of simultaneous transfers to allow the\n" \
  "                   asynchronous stream to use. This should be < the\n" \
  "                   buffers parameter.\n" \
  "\n" \
  "           timeout Data stream timeout. With no suffix, the default unit\n" \
  "                   is ms. The default value is 1000 ms (1 s). Valid\n" \
  "                   suffixes are 'ms' and 's'.\n" \
  "  -----------------------------------------------------------------------\n" \
  "\n" \
  "Example:\n" \
  "\n" \
  "-   tx config file=data.bin format=bin repeat=2 delay=250000\n" \
  "\n" \
  "    Transmitting the contents of data.bin two times, with a ~250ms\n" \
  "    delay between transmissions.\n" \
  "\n" \
  "Notes:\n" \
  "\n" \
  "-   The n, samples, buffers, and xfers parameters support the suffixes\n" \
  "    K, M, and G, which are multiples of 1024.\n" \
  "-   For higher sample rates, it is advised that the input file be\n" \
  "    stored in RAM (e.g. /tmp, /dev/shm) or on an SSD, rather than\n" \
  "    a HDD.\n" \
  "-   When providing CSV data, this command will first convert it to a\n" \
  "    binary format, stored in a file in the current working directory.\n" \
  "    During this process, out-of-range values will be clamped.\n" \
  "-   When using a binary format, the user is responsible for ensuring\n" \
  "    that the provided data values are within the allowed range. This\n" \
  "    prerequisite alleviates the need for this program to perform range\n" \
  "    checks in time-sensitive callbacks.\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_set \
  "Usage: set <parameter> <arguments>\n" \
  "\n" \
  "The set command takes a parameter and an arbitrary number of arguments\n" \
  "for that particular parameter. The parameter is one of:\n" \
  "\n" \
  "  -----------------------------------------------------------------------\n" \
  "       Parameter Description\n" \
  "  -------------- --------------------------------------------------------\n" \
  "       bandwidth Bandwidth settings\n" \
  "\n" \
  "       frequency Frequency settings\n" \
  "\n" \
  "            gpio FX3 <-> FPGA GPIO state\n" \
  "\n" \
  "        loopback Loopback settings. Run 'set loopback' to list modes.\n" \
  "\n" \
  "         lnagain Gain setting of the RX LNA, in dB. Values: 0, 3, 6\n" \
  "\n" \
  "          rxvga1 Gain setting of RXVGA1, in dB. Range: [5, 30]\n" \
  "\n" \
  "          rx_mux FPGA RX FIFO input mux mode. Options are: BASEBAND_LMS,\n" \
  "                 12BIT_COUNTER, 32BIT_COUNTER, DIGITAL_LOOPBACK\n" \
  "\n" \
  "          rxvga1 Gain setting of RXVGA1, in dB. Range: [5, 30]\n" \
  "\n" \
  "          rxvga2 Gain setting of RXVGA2, in dB. Range: [0, 30]\n" \
  "\n" \
  "          txvga1 Gain setting of TXVGA1, in dB. Range: [-35, -4]\n" \
  "\n" \
  "          txvga2 Gain setting of TXVGA2, in dB. Range: [0, 25]\n" \
  "\n" \
  "        sampling External or internal sampling mode\n" \
  "\n" \
  "      samplerate Sample rate settings\n" \
  "\n" \
  "        smb_mode SMB clock port mode of operation\n" \
  "\n" \
  "         trimdac VCTCXO trim DAC settings\n" \
  "\n" \
  "    vctcxo_tamer VCTCXO tamer mode. Options: Disabled, 1PPS, 10MHz\n" \
  "\n" \
  "         xb_gpio Expansion board GPIO values\n" \
  "\n" \
  "     xb_gpio_dir Expansion board GPIO direction (1=output, 0=input)\n" \
  "  -----------------------------------------------------------------------\n" \
  "\n" \


#define CLI_CMD_HELPTEXT_version \
  "Usage: version\n" \
  "\n" \
  "Prints version information for host software and the current device.\n" \
  "\n" \

#endif // BLADERF_CLI_VERSION_H__