cmd_des_t const cmd_des_sleep={
0, 0,
"sleep","Sleep the board",
- "=== Syntax ===\n"
+ "### Syntax ###\n"
"\n"
" sleep\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command configures the LIN and CAN peripherals to enter sleep mode\n"
"and turn the whole device into sleep mode. External signal on CAN or\n"
cmd_des_t const cmd_des_help={
0, 0,
"help","Print help for commands",
- "=== Syntax ===\n"
+ "### Syntax ###\n"
"\n"
" help [command]\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command without parameter prints the list of all available\n"
"commands with short help text for each of them. If a parameter is\n"
cmd_des_t const cmd_des_version={
0, 0,
"version","Print version of the software",
- "=== Syntax ===\n"
+ "### Syntax ###\n"
"\n"
" version\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command prints the version of the test software. The version\n"
"number is the output of 'git describe' command, i.e. it is composed\n"
"from the last tag in the git repository, the number of commits since\n"
"the tag and the abbreviated commit hash.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> version\n"
- " version=v0.2-109-ga81a9dd\n",
+ " --> version\n"
+ " version=v0.2-109-ga81a9dd\n",
CMD_HANDLER(cmd_do_version),
};
cmd_des_t const cmd_des_read_adc1={
0, 0,
"adcread","Read values from ADC inputs",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " adcread\n"
+ " adcread\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command reads values corresponding to analog voltages on ADC\n"
"inputs 1-12 and prints them as decimal numbers as well as converted to\n"
"Volts.\n"
"\n"
- "=== Example ===\n"
- "\n"
- " --> adcread\n"
- " ADC1 2332 lsb ~ 11.66 V\n"
- " ADC2 107 lsb ~ 0.54 V\n"
- " ADC3 108 lsb ~ 0.54 V\n"
- " ADC4 107 lsb ~ 0.54 V\n"
- " ADC5 108 lsb ~ 0.54 V\n"
- " ADC6 111 lsb ~ 0.56 V\n"
- " ADC7 110 lsb ~ 0.55 V\n"
- " ADC8 109 lsb ~ 0.55 V\n"
- " ADC9 107 lsb ~ 0.54 V\n"
- " ADC10 107 lsb ~ 0.54 V\n"
- " ADC11 110 lsb ~ 0.55 V\n"
- " ADC12 108 lsb ~ 0.54 V\n",
+ "### Example ###\n"
+ "\n"
+ " --> adcread\n"
+ " ADC1 2332 lsb ~ 11.66 V\n"
+ " ADC2 107 lsb ~ 0.54 V\n"
+ " ADC3 108 lsb ~ 0.54 V\n"
+ " ADC4 107 lsb ~ 0.54 V\n"
+ " ADC5 108 lsb ~ 0.54 V\n"
+ " ADC6 111 lsb ~ 0.56 V\n"
+ " ADC7 110 lsb ~ 0.55 V\n"
+ " ADC8 109 lsb ~ 0.55 V\n"
+ " ADC9 107 lsb ~ 0.54 V\n"
+ " ADC10 107 lsb ~ 0.54 V\n"
+ " ADC11 110 lsb ~ 0.55 V\n"
+ " ADC12 108 lsb ~ 0.54 V\n",
CMD_HANDLER(cmd_do_read_adc1_values), (void *)&cmd_list_adc
};
cmd_des_t const cmd_des_read_adc2={
0, 0,
"adcread*","Read a value from a single ADC input",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " adcread<PIN>\n"
"\n"
- "where <PIN> is a number in range 1 - 12.\n"
+ "where `<PIN>` is a number in range 1 - 12.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command reads the value corresponding to analog voltage on an ADC\n"
"input and prints it as decimal numbers as well as converted to Volts.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> adcread1\n"
- " ADC1 2331 lsb ~ 11.66 V\n",
+ " --> adcread1\n"
+ " ADC1 2331 lsb ~ 11.66 V\n",
CMD_HANDLER(cmd_do_read_adc1_values), (void *)&cmd_list_adc
};
cmd_des_t const cmd_des_adcwatch={
0, 0,
"adcwatch","Watch the values from ADC inputs",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " adcwatch\n"
+ " adcwatch\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command reads values corresponding to analog voltages on ADC\n"
"inputs 1-12 10 times per second and prints them as decimal numbers (in\n"
"lsb units) as well as converted to Volts. The command is ended by any\n"
"key.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> adcwatch\n"
- " ADC Inputs Test [1-12]:\n"
- " =======================================================================\n"
- " 1 2 3 4 5 6 7 8 9 10 11 12\n"
- " 2331 107 108 106 107 110 110 109 107 107 110 109 lsb\n"
- " 11.66 0.54 0.54 0.53 0.54 0.55 0.55 0.55 0.54 0.54 0.55 0.55 V\n",
+ " --> adcwatch\n"
+ " ADC Inputs Test [1-12]:\n"
+ " =======================================================================\n"
+ " 1 2 3 4 5 6 7 8 9 10 11 12\n"
+ " 2331 107 108 106 107 110 110 109 107 107 110 109 lsb\n"
+ " 11.66 0.54 0.54 0.53 0.54 0.55 0.55 0.55 0.54 0.54 0.55 0.55 V\n",
CMD_HANDLER(cmd_do_adc_watch), (void *)&cmd_list_adc
};
cmd_des_t const cmd_des_test_can_loopback={
0, 0,
"cantest*", "Test CAN loopback between two CAN interfaces",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " cantest<SOURCE> <DESTINATION>\n"
+ " cantest<SRC> <DST>\n"
"\n"
- "where <SOURCE> and <DESTINATION> are different numbers in range 1-3.\n"
+ "where `<SRC>` and `<DST>` are different numbers in range 1-3.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command tests CAN communication by sending and receiving messages\n"
"through external loopback. At the beginning, the involved CAN\n"
"When an error is detected during the test, the status of faulty CAN\n"
"controller is printed immediately.\n"
"\n"
- "=== Example ===\n"
- "\n"
- " --> cantest1 2\n"
- " Testing CAN loopback\n"
- " Messages transmitted: 100/100\n"
- " Messages received: 100/100\n"
- " TX timeouts: 0\n"
- " RX timeouts: 0\n"
- " Src TX error counter: 0\n"
- " Src RX error counter: 0\n"
- " Dst TX error counter: 0\n"
- " Dst RX error counter: 0\n"
- " CAN1 status: Bus-On, ES: 0x8\n"
- " CAN2 status: Bus-On, ES: 0x10\n",
+ "### Example ###\n"
+ "\n"
+ " --> cantest1 2\n"
+ " Testing CAN loopback\n"
+ " Messages transmitted: 100/100\n"
+ " Messages received: 100/100\n"
+ " TX timeouts: 0\n"
+ " RX timeouts: 0\n"
+ " Src TX error counter: 0\n"
+ " Src RX error counter: 0\n"
+ " Dst TX error counter: 0\n"
+ " Dst RX error counter: 0\n"
+ " CAN1 status: Bus-On, ES: 0x8\n"
+ " CAN2 status: Bus-On, ES: 0x10\n",
CMD_HANDLER(cmd_do_test_can_loopback), (void *)&cmd_list_can
};
cmd_des_t const cmd_des_can_init={
0, 0,
"caninit", "Initialize CAN controllers",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " caninit\n"
+ " caninit\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command (re-)initializes all CAN controllers using current\n"
"CAN configuration. This configuration can be changed using\n"
"In the default configuration the baudrate of all CAN controllers i set\n"
"to 500 kbit/s.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
" --> caninit\n",
CMD_HANDLER(cmd_do_can_init), (void *)&cmd_list_can
};
cmd_des_t const cmd_des_can_baudrate={
0, CDESM_OPCHR|CDESM_RW,
"canbaudrate#", "Change baudrate of CAN controller",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " canbaudrate<CONTROLLER>?\n"
- " canbaudrate<CONTROLLER>:<BAUDRATE>\n"
+ " canbaudrate<CONTROLLER>?\n"
+ " canbaudrate<CONTROLLER>:<BAUDRATE>\n"
"\n"
- "where <CONTROLLER> is number in range 1-3 and BAUDRATE is number in\n"
+ "where `<CONTROLLER>` is number in range 1-3 and BAUDRATE is number in\n"
"range 1000-10000000 specifying the baurdate in bits per second.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command is used to set or show the baudrate of a CAN controller.\n"
"The baudrate shown is the one which will be used by next invocation of\n"
"the caninit command.\n"
"\n"
- "=== Examples ===\n"
+ "### Examples ###\n"
"\n"
- " --> canbaudrate2?\n"
- " canbaudrate2=500000\n"
+ " --> canbaudrate2?\n"
+ " canbaudrate2=500000\n"
"\n"
- " --> canbaudrate2:100000\n",
+ " --> canbaudrate2:100000\n",
CMD_HANDLER(cmd_do_can_change_baudrate), (void *)&cmd_list_can
};
cmd_des_t const cmd_des_can_send={
0, 0,
"cansend", "Test sending message over CAN",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " cansend <CONTROLLER> <ID> <DATA>\n"
+ " cansend <CONTROLLER> <ID> <DATA>\n"
"\n"
- "where <CONTROLLER> is number in range 1-3, <ID> is a valid CAN ID\n"
- "and <DATA> is 0-8 bytes of data in hexadecimal representation.\n"
+ "where `<CONTROLLER>` is number in range 1-3, `<ID>` is a valid CAN ID\n"
+ "and `<DATA>` is 0-8 bytes of data in hexadecimal representation.\n"
"There may be any number of spaces between the data bytes.\n"
- "<ID> may be given in octal, decimal or hexadecimal base.\n"
+ "`<ID>` may be given in octal, decimal or hexadecimal base.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command sends a CAN frame using specified CAN controller.\n"
"\n"
"The caninit command must be called before using this command.\n"
"\n"
- "=== Example ===\n"
- " --> cansend 2 0x123 DEAD BEEF\n"
- " Sent: can2 123 [4] DE AD BE EF\n",
+ "### Example ###\n"
+ " --> cansend 2 0x123 DEAD BEEF\n"
+ " Sent: can2 123 [4] DE AD BE EF\n",
CMD_HANDLER(cmd_do_can_send), (void *)&cmd_list_can
};
cmd_des_t const cmd_des_can_dump={
0, 0,
"candump", "Dump all messages received over CAN",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " candump <CONTROLLER>\n"
+ " candump <CONTROLLER>\n"
"\n"
- "where <CONTROLLER> is a number in range 1-3.\n"
+ "where `<CONTROLLER>` is a number in range 1-3.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command prints out all CAN messages received via the specified\n"
"controller.\n"
"\n"
"caninit must be called before using this command.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> candump 2\n"
+ " --> candump 2\n"
"can2 0000FADE [2] 12 34\n",
CMD_HANDLER(cmd_do_can_dump), (void *)&cmd_list_can
};
cmd_des_t const cmd_des_dac_pin_setup = {
0, 0,
"dacpinenable*","Enable or disable a DAC pin",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dacpinenable<PIN> <VALUE>\n"
+ "
dacpinenable<PIN> <VALUE>\n"
"where\n"
- "* <PIN> is a number in range 1-4\n"
- "* <VALUE> is a number 0 (disable) or 1 (enable)\n"
"\n"
- "=== Description ===\n"
+ "- `<PIN>` is a number in range 1-4\n"
+ "- `<VALUE>` is a number 0 (disable) or 1 (enable)\n"
+ "\n"
+ "### Description ###\n"
"\n"
"Command for enabling or disabling of a DAC pin.\n"
"\n"
"Command always prints the actual state of the selected pin.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dacpinenable1 1\n"
- " dacpinenable1=1\n"
+ " --> dacpinenable1 1\n"
+ " dacpinenable1=1\n"
"\n"
"Enables pin DAC1 and prints its actual state (which will be 1)\n",
CMD_HANDLER(cmd_do_dac_pin_setup), (void *)&cmd_list_dac
cmd_des_t const cmd_des_dac_pin_set_val = {
0, 0,
"dacpinval*","Set raw value of a DAC register",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dacpinval<PIN> <VALUE>\n"
+ "
dacpinval<PIN> <VALUE>\n"
"where\n"
- "* <PIN> is a number in range 1-4\n"
- "* <VALUE> is a number in range 0-4095\n"
"\n"
- "=== Description ===\n"
+ "- `<PIN>` is a number in range 1-4\n"
+ "- `<VALUE>` is a number in range 0-4095\n"
+ "\n"
+ "### Description ###\n"
"\n"
"This command writes a raw value to DAC register that controls the DAC\n"
"output voltage according to the formula described in the datasheet.\n"
- "<PIN> parameter selects which DAC pin to use.\n"
+ "`<PIN>` parameter selects which DAC pin to use.\n"
"\n"
"Command always prints the written raw value of the selected pin. There\n"
"is no way how to read the value out of the register.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dacpinval1 4095\n"
- " dacpinval1 =4095\n"
+ " --> dacpinval1 4095\n"
+ " dacpinval1 =4095\n"
"\n"
"Set pin DAC1 voltage to 12V, and prints the value (4095).\n",
CMD_HANDLER(cmd_do_dac_pin_set_val), (void *)&cmd_list_dac
cmd_des_t const cmd_des_dac_pin_set_voltage = {
0, 0,
"dacpinvoltage*","Set voltage in mV of a DAC pin",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dacpinvoltage<PIN> <VALUE>\n"
+ "
dacpinvoltage<PIN> <VALUE>\n"
"where\n"
- "* <PIN> is a number in range 1-4\n"
- "* <VALUE> is a number in range 0-12000\n"
"\n"
- "=== Description ===\n"
+ "- `<PIN>` is a number in range 1-4\n"
+ "- `<VALUE>` is a number in range 0-12000\n"
+ "\n"
+ "### Description ###\n"
"\n"
"This command sets the voltage on a DAC pin.\n"
"\n"
"The command always prints the actually set voltage of selected pin.\n"
"There is no way how to read the value back out of the pin.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dacpinvoltage1 8000\n"
- " dacpinvoltage1 =8000\n"
+ " --> dacpinvoltage1 8000\n"
+ " dacpinvoltage1 =8000\n"
"\n"
"Sets pin DAC1 to 8V, prints the actual voltage (8000)\n"
"\n"
- " --> dacpinvoltage2 500\n"
- " dacpinvoltage2 =500\n"
+ " --> dacpinvoltage2 500\n"
+ " dacpinvoltage2 =500\n"
"\n"
"Sets pin DAC2 to 500mV, prints actual voltage (500)\n",
CMD_HANDLER(cmd_do_dac_pin_set_voltage), (void *)&cmd_list_dac
cmd_des_t const cmd_des_din_setup={
0, 0,
"dinsetup*", "Setup DIN pin parameters (Pull up/down, tristate/active, IRQ and wakeup disable/enable)",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dinsetup<PINS> [A [B [C]]]\n"
+ "
dinsetup<PINS> [A [B [C]]]\n"
"where\n"
- "* PINS is either a number in range 1-16 or a range written as <min>-<max>\n"
- "* A is an optional value - either 0 (pull down/switch to battery) or 1 (pull up/switch to ground). The default is 1.\n"
- "* B is an optional value - either 0 (tri-state) or 1 (active). The default is 0.\n"
- "* C is an optional value - either 0 (wake up and IRQ disabled) or 1 (wake up and IRQ disabled enabled). The default is 1.\n"
"\n"
- "=== Description ===\n"
+ "- PINS is either a number in range 1-16 or a range written as `<min>-<max>`\n"
+ "- A is an optional value - either 0 (pull down/switch to battery) or 1 (pull up/switch to ground). The default is 1.\n"
+ "- B is an optional value - either 0 (tri-state) or 1 (active). The default is 0.\n"
+ "- C is an optional value - either 0 (wake up and IRQ disabled) or 1 (wake up and IRQ disabled enabled). The default is 1.\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command setups properties of one or more DIN pins as specified by\n"
- "<PIN>. Pins 0-7 can be set as pull up (switch to ground) or pull down\n"
+ "`<PIN>`. Pins 0-7 can be set as pull up (switch to ground) or pull down\n"
"(switch to battery), pins 8-15 are hardcoded as switch to ground. All\n"
"pins can be set to either tri-state or active state and also can have\n"
"wake-up function with IRQ activated or not.\n"
"The command always prints the final settings of each set pin as ABC.\n"
"The actual configuration cannot be read out of the pin driver.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dinsetup1 1 0 0\n"
- " dinsetup1=100\n"
+ " --> dinsetup1 1 0 0\n"
+ " dinsetup1=100\n"
"\n"
"Sets the DIN1 as switch to ground, active and disables IRQ generation.\n"
"\n"
- " --> dinsetup2\n"
- " dinsetup2=101\n"
+ " --> dinsetup2\n"
+ " dinsetup2=101\n"
"\n"
"Sets the DIN2 as to the default values i.e. switch to battery,\n"
"tri-state, wake-up/IRQ enabled.\n"
"\n"
- " --> dinsetup0-7 1 1 1\n"
- " dinsetup0=111\n"
- " dinsetup1=111\n"
- " dinsetup2=111\n"
- " dinsetup3=111\n"
- " dinsetup4=111\n"
- " dinsetup5=111\n"
- " dinsetup6=111\n"
- " dinsetup7=111\n"
+ " --> dinsetup0-7 1 1 1\n"
+ " dinsetup0=111\n"
+ " dinsetup1=111\n"
+ " dinsetup2=111\n"
+ " dinsetup3=111\n"
+ " dinsetup4=111\n"
+ " dinsetup5=111\n"
+ " dinsetup6=111\n"
+ " dinsetup7=111\n"
"\n"
"Sets the DIN0 through DIN7 as switch to ground, tri-state, wake-up/IRQ\n"
"enabled.\n",
cmd_des_t const cmd_des_din_get={
0, 0,
"dinget*","Read the open/close status of a DIN pin (with the default treshold)", /* TODO add a command for reading with a treshold */
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dinget<PIN>\n"
"\n"
"where PIN is a number in range 0-15\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command reads and prints the status of the DIN pin. Value 0 means\n"
"switch is open, value 1 means switch is closed. The mapping between\n"
"the DIN voltage and the open/close status depends on the setup of the\n"
"pin (see dinsetup command).\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dinget1\n"
- " dinget1 =0\n"
+ " --> dinget1\n"
+ " dinget1 =0\n"
"\n"
"DIN1 is in open state.\n",
CMD_HANDLER(cmd_do_din_get), (void *)&cmd_list_din
cmd_des_t const cmd_des_din_diag={
0, 0,
"dindiag*","Read diagnostic value from DIN pin",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dindiag<PIN>\n"
"\n"
- "where <PIN> is in range 1-16\n"
+ "where `<PIN>` is in range 1-16\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command reads and prints the value of diagnostic bit corresponding\n"
"to a DIN pin. TODO check what the value actually mean.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dindiag1\n"
- " dindiag1 =0\n"
+ " --> dindiag1\n"
+ " dindiag1 =0\n"
"\n"
"Prints value of the diagnostic bit of DIN1.\n",
CMD_HANDLER(cmd_do_din_diag), (void *)&cmd_list_din
cmd_des_t const cmd_des_din_watch={
0, 0,
"dinwatch","Watch status of all DIN pins",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dinwatch\n"
+ " dinwatch\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command reads and prints the status of DIN pins every 100\n"
"milliseconds. Columns 0-15 correspond to open/close status of DIN pins\n"
"\n"
"Press any key to end this command.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dinwatch\n"
- " Digital Inputs Test [0-15]:\n"
- " ===========================================================\n"
- " 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 A B C D E F G H\n"
- " 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1\n",
+ " --> dinwatch\n"
+ " Digital Inputs Test [0-15]:\n"
+ " ===========================================================\n"
+ " 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 A B C D E F G H\n"
+ " 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1\n",
CMD_HANDLER(cmd_do_din_watch), (void *)&cmd_list_din
};
cmd_des_t const cmd_des_test_ethernet={
0, 0,
"ethernet", "Temporary command to test Ethernet communication",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " ethernet\n"
+ " ethernet\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"Command tries to send a few ethernet frames. No real connection or\n"
"meaningful packets are sent. This only tests, if Ethernet is just\n"
cmd_des_t const cmd_des_fr_user_config={
0, 0,
"frbtconfig*","Set the user configuration parameters",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtconfig<TYPE> <PARAMS>\n"
+ "
frbtconfig<TYPE> <PARAMS>\n"
"where\n"
- "* <TYPE> is a string specifying the type of parameters to be set. It can be: \"cluster\" or \"node\"\n"
- "* <PARAMS> is a sequence of numbers separated by spaces. Each number stands for one parameter.\n"
"\n"
- "=== Description ===\n"
+ "- `<TYPE>` is a string specifying the type of parameters to be set. It can be: \"cluster\" or \"node\"\n"
+ "- `<PARAMS>` is a sequence of numbers separated by spaces. Each number stands for one parameter.\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command takes the configuration parameters in the form of a string\n"
"and sets the appropriate type of the FlexRay parameters. It is\n"
"command are applied by the frbtinitU command. Once frbtinit is called,\n"
"it is no longer possible to change the parameters.\n"
"\n"
- "The type of the parameters can be selected by the <TYPE> selector.\n"
+ "The type of the parameters can be selected by the `<TYPE>` selector.\n"
"\n"
"Type \"cluster\" sets global FlexRay network parameters. It expects a\n"
"sequence of 25 parameters in this order:\n"
- "* 1) gColdStartAttempts\n"
- "* 2) gListenNoise\n"
- "* 3) gMacroPerCycle\n"
- "* 4) gMaxWithoutClockCorrectionFatal\n"
- "* 5) gMaxWithoutClockCorrectionPassive\n"
- "* 6) gNetworkManagementVectorLength\n"
- "* 7) gNumberOfMinislots\n"
- "* 8) gNumberOfStaticSlots\n"
- "* 9) gOffsetCorrectionStart\n"
- "* 10) gPayloadLengthStatic\n"
- "* 11) gSyncNodeMax\n"
- "* 12) gdActionPointOffset\n"
- "* 13) gdCASRxLowMax\n"
- "* 14) gdDynamicSlotIdlePhase\n"
- "* 15) gdMinislot\n"
- "* 16) gdMinislotActionPointOffset\n"
- "* 17) gdNIT\n"
- "* 18) gdSampleClockPeriod\n"
- "* 19) gdStaticSlot\n"
- "* 20) gdTSSTransmitter\n"
- "* 21) gdWakeupSymbolRxIdle\n"
- "* 22) gdWakeupSymbolRxLow\n"
- "* 23) gdWakeupSymbolRxWindow\n"
- "* 24) gdWakeupSymbolTxIdle\n"
- "* 25) gdWakeupSymbolTxLow\n"
+ "\n"
+ "- 1) gColdStartAttempts\n"
+ "- 2) gListenNoise\n"
+ "- 3) gMacroPerCycle\n"
+ "- 4) gMaxWithoutClockCorrectionFatal\n"
+ "- 5) gMaxWithoutClockCorrectionPassive\n"
+ "- 6) gNetworkManagementVectorLength\n"
+ "- 7) gNumberOfMinislots\n"
+ "- 8) gNumberOfStaticSlots\n"
+ "- 9) gOffsetCorrectionStart\n"
+ "- 10) gPayloadLengthStatic\n"
+ "- 11) gSyncNodeMax\n"
+ "- 12) gdActionPointOffset\n"
+ "- 13) gdCASRxLowMax\n"
+ "- 14) gdDynamicSlotIdlePhase\n"
+ "- 15) gdMinislot\n"
+ "- 16) gdMinislotActionPointOffset\n"
+ "- 17) gdNIT\n"
+ "- 18) gdSampleClockPeriod\n"
+ "- 19) gdStaticSlot\n"
+ "- 20) gdTSSTransmitter\n"
+ "- 21) gdWakeupSymbolRxIdle\n"
+ "- 22) gdWakeupSymbolRxLow\n"
+ "- 23) gdWakeupSymbolRxWindow\n"
+ "- 24) gdWakeupSymbolTxIdle\n"
+ "- 25) gdWakeupSymbolTxLow\n"
"\n"
"Type \"node\" sets local FlexRay network parameters. It expects a\n"
"sequence of 28 parameters in this order:\n"
- "* 1) pAllowHaltDueToClock\n"
- "* 2) pAllowPassiveToActive\n"
- "* 3) pChannels (0 - A, 1 - B, 2 - AB)\n"
- "* 4) pClusterDriftDamping\n"
- "* 5) pDelayCompensationA\n"
- "* 6) pDelayCompensationB\n"
- "* 7) pExternOffsetCorrection\n"
- "* 8) pExternRateCorrection\n"
- "* 9) pKeySlotUsedForStartup\n"
- "* 10) pKeySlotUsedForSync\n"
- "* 11) pLatestTx\n"
- "* 12) pMacroInitialOffsetA\n"
- "* 13) pMacroInitialOffsetB\n"
- "* 14) pMicroInitialOffsetA\n"
- "* 15) pMicroInitialOffsetB\n"
- "* 16) pMicroPerCycle\n"
- "* 17) pRateCorrectionOut\n"
- "* 18) pOffsetCorrectionOut\n"
- "* 19) pSamplesPerMicrotick\n"
- "* 20) pSingleSlotEnabled\n"
- "* 21) pWakeupChannel (0 - A, 1 - B)\n"
- "* 22) pWakeupPattern\n"
- "* 23) pdAcceptedStartupRange\n"
- "* 24) pdListenTimeout\n"
- "* 25) pdMaxDrift\n"
- "* 26) pDecodingCorrection\n"
- "* 27) syncFramePayloadMultiplexEnabled\n"
- "* 28) secureBuffers (0 - FR_SB_RECONFIG_ENABLED, 1 - FR_SB_STAT_REC_DISABLED_STAT_TR_DISABLED, 2 - FR_SB_ALL_REC_DISABLED, 3 - FR_SB_ALL_REC_DISABLED_STAT_TR_DISABLED)\n"
- "\n"
- "=== Example ===\n"
- "\n"
- " --> frbtconfigcluster 0x2 0xF 0x15E0 0xF 0xF 0xC 0x15A 0x8 0xAE4 0x9 0xF 0x4 0x43 0x1 0x4 0x2 0xAE3 0x0 0x56 0xA 0x12 0x12 0x4C 0xB4 0x3C\n"
- " FlexRay cluster configuration accepted.\n"
- " --> frbtconfignode 0x0 0x0 0x2 0x1 0x3 0x3 0x0 0x0 0x1 0x1 0x10D 0x6 0x6 0x18 0x18 0x36B00 0xCD 0x151 0x0 0x1 0x0 0x2 0x81 0x36DA2 0x151 0x33 0x0 0x0\n"
- " FlexRay node configuration accepted.\n",
+ "\n"
+ "- 1) pAllowHaltDueToClock\n"
+ "- 2) pAllowPassiveToActive\n"
+ "- 3) pChannels (0 - A, 1 - B, 2 - AB)\n"
+ "- 4) pClusterDriftDamping\n"
+ "- 5) pDelayCompensationA\n"
+ "- 6) pDelayCompensationB\n"
+ "- 7) pExternOffsetCorrection\n"
+ "- 8) pExternRateCorrection\n"
+ "- 9) pKeySlotUsedForStartup\n"
+ "- 10) pKeySlotUsedForSync\n"
+ "- 11) pLatestTx\n"
+ "- 12) pMacroInitialOffsetA\n"
+ "- 13) pMacroInitialOffsetB\n"
+ "- 14) pMicroInitialOffsetA\n"
+ "- 15) pMicroInitialOffsetB\n"
+ "- 16) pMicroPerCycle\n"
+ "- 17) pRateCorrectionOut\n"
+ "- 18) pOffsetCorrectionOut\n"
+ "- 19) pSamplesPerMicrotick\n"
+ "- 20) pSingleSlotEnabled\n"
+ "- 21) pWakeupChannel (0 - A, 1 - B)\n"
+ "- 22) pWakeupPattern\n"
+ "- 23) pdAcceptedStartupRange\n"
+ "- 24) pdListenTimeout\n"
+ "- 25) pdMaxDrift\n"
+ "- 26) pDecodingCorrection\n"
+ "- 27) syncFramePayloadMultiplexEnabled\n"
+ "- 28) secureBuffers (0 - FR_SB_RECONFIG_ENABLED, 1 - FR_SB_STAT_REC_DISABLED_STAT_TR_DISABLED, 2 - FR_SB_ALL_REC_DISABLED, 3 - FR_SB_ALL_REC_DISABLED_STAT_TR_DISABLED)\n"
+ "\n"
+ "### Example ###\n"
+ "\n"
+ " --> frbtconfigcluster 0x2 0xF 0x15E0 0xF 0xF 0xC 0x15A 0x8 0xAE4 0x9 0xF 0x4 0x43 0x1 0x4 0x2 0xAE3 0x0 0x56 0xA 0x12 0x12 0x4C 0xB4 0x3C\n"
+ " FlexRay cluster configuration accepted.\n"
+ " --> frbtconfignode 0x0 0x0 0x2 0x1 0x3 0x3 0x0 0x0 0x1 0x1 0x10D 0x6 0x6 0x18 0x18 0x36B00 0xCD 0x151 0x0 0x1 0x0 0x2 0x81 0x36DA2 0x151 0x33 0x0 0x0\n"
+ " FlexRay node configuration accepted.\n",
CMD_HANDLER(cmd_do_fr_user_config), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_config_buffer={
0, 0,
"frbtcfgbuf?*","Configure a message buffer in the user configuration",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtcfgbuf<TYPE><NUM> slot<SLOT> <CHN> cyc<CYC> <RXTX> max<MAX> <REP> ppi<PPI> int<INT>\n"
+ "
frbtcfgbuf<TYPE><NUM> slot<SLOT> <CHN> cyc<CYC> <RXTX> max<MAX> <REP> ppi<PPI> int<INT>\n"
"where\n"
- "* <TYPE> is 'S' for static segment buffers and 'D' for dynamic segment buffers,\n"
- "* <NUM> is the number of the buffer. Both static and dynamic buffers are numbered independently starting from zero,\n"
- "* <SLOT> is the number of the slot,\n"
- "* <CHN> is one of 'A', 'B' or 'AB' and identifies the used channel,\n"
- "* <CYC> is the cycle set when to send the buffer,\n"
- "* <RXTX> is either string \"rx\" or \"tx\",\n"
- "* <MAX> is the number determining the maximum payload (in hald-words),\n"
- "* <REP> is a string \"s\" or \"single\" for single transmission or \"c\" or \"continuous\" for continuous transmission,\n"
- "* <PPI> is 0 or 1 determining whether the payload preamble indicator is set,\n"
- "* <INT> is 0 or 1 and is currently ignored.\n"
- "\n"
- "=== Description ===\n"
+ "\n"
+ "- `<TYPE>` is 'S' for static segment buffers and 'D' for dynamic segment buffers,\n"
+ "- `<NUM>` is the number of the buffer. Both static and dynamic buffers are numbered independently starting from zero,\n"
+ "- `<SLOT>` is the number of the slot,\n"
+ "- `<CHN>` is one of 'A', 'B' or 'AB' and identifies the used channel,\n"
+ "- `<CYC>` is the cycle set when to send the buffer,\n"
+ "- `<RXTX>` is either string \"rx\" or \"tx\",\n"
+ "- `<MAX>` is the number determining the maximum payload (in hald-words),\n"
+ "- `<REP>` is a string \"s\" or \"single\" for single transmission or \"c\" or \"continuous\" for continuous transmission,\n"
+ "- `<PPI>` is 0 or 1 determining whether the payload preamble indicator is set,\n"
+ "- `<INT>` is 0 or 1 and is currently ignored.\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command sets the configuration parameters for static or dynamic\n"
"buffers in user configuration. The parameters set by this command are\n"
"applied by the frbtinitU command. Once frbtinit is called, it is no\n"
"longer possible to change the parameters.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtcfgbufS0 slot2 AB cyc0 tx max9 continous ppi0 int1\n"
- " frbtcfgbufS0 slot2 AB cyc0 tx max9 continous ppi0 int1\n"
- " --> frbtcfgbufS1 slot1 AB cyc0 rx max9 continuous ppi0 int1\n"
- " frbtcfgbufS1 slot1 AB cyc0 rx max9 continuous ppi0 int1\n"
- " --> frbtcfgbufD0 slot9 A cyc0 rx max0x40 single ppi0 int0\n"
- " frbtcfgbufD0 slot9 A cyc0 rx max64 single ppi0 int0\n"
- " --> frbtcfgbufD1 slot10 A cyc0 tx max0x40 single ppi0 int0\n"
- " frbtcfgbufD1 slot10 A cyc0 tx max64 single ppi0 int0\n",
+ " --> frbtcfgbufS0 slot2 AB cyc0 tx max9 continous ppi0 int1\n"
+ " frbtcfgbufS0 slot2 AB cyc0 tx max9 continous ppi0 int1\n"
+ " --> frbtcfgbufS1 slot1 AB cyc0 rx max9 continuous ppi0 int1\n"
+ " frbtcfgbufS1 slot1 AB cyc0 rx max9 continuous ppi0 int1\n"
+ " --> frbtcfgbufD0 slot9 A cyc0 rx max0x40 single ppi0 int0\n"
+ " frbtcfgbufD0 slot9 A cyc0 rx max64 single ppi0 int0\n"
+ " --> frbtcfgbufD1 slot10 A cyc0 tx max0x40 single ppi0 int0\n"
+ " frbtcfgbufD1 slot10 A cyc0 tx max64 single ppi0 int0\n",
CMD_HANDLER(cmd_do_fr_config_bufer), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_config_fifo={
0, 0,
"frbtcfgfifo*","Configure a RX FIFO message buffer in the user configuration",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtcfgfifo rejslot<SLOT> slotmask<MASK> depth<DEPTH> <CHN> cyc<CYC> max<MAX> <REJNULL> <REJSTAT>\n"
+ " frbtcfgfifo rejslot<SLOT> slotmask<MASK> depth<DEPTH> <CHN> cyc<CYC> max<MAX> <REJNULL> <REJSTAT>\n"
"where\n"
- "* <SLOT> is the number of the slot that will be rejected. If it is 0, no slot will be rejected,\n"
- "* <MASK> is a number specifying which bits of the <SLOT> will be ignored,"
- "* <DEPTH> is a number specifying the depth of the FIFO,\n"
- "* <CHN> is one of 'A', 'B' or 'AB' and identifies the used channel,\n"
- "* <CYC> is the cycle set when to send the buffer,\n"
- "* <MAX> is the number determining the maximum payload (in hald-words),\n"
- "* <REJNULL> is a string \"rejnull\" for rejecting NULL frames or \"accnull\" for accepting NULL frames,\n"
- "* <REJSTAT> is a string \"rejstat\" for rejecting frames in static segment or \"accstat\" for accepting frames from static segment,\n"
+ "- `<SLOT>` is the number of the slot that will be rejected. If it is 0, no slot will be rejected,\n"
+ "- `<MASK>` is a number specifying which bits of the `<SLOT>` will be ignored,"
+ "- `<DEPTH>` is a number specifying the depth of the FIFO,\n"
+ "- `<CHN>` is one of 'A', 'B' or 'AB' and identifies the used channel,\n"
+ "- `<CYC>` is the cycle set when to send the buffer,\n"
+ "- `<MAX>` is the number determining the maximum payload (in hald-words),\n"
+ "- `<REJNULL>` is a string \"rejnull\" for rejecting NULL frames or \"accnull\" for accepting NULL frames,\n"
+ "- `<REJSTAT>` is a string \"rejstat\" for rejecting frames in static segment or \"accstat\" for accepting frames from static segment,\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command sets the configuration parameters for RX FIFO buffer\n"
"in user configuration. The parameters set by this command are\n"
"Those messages, which are not accepted by any other buffer and pass the\n"
"FIFO rejection filter will be stored in the RX FIFO buffer.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtcfgfifo rejslot6 slotmask6 depth5 AB cyc0 max0x20 rejnull accstat\n"
- " frbtcfgfifo rejslot6 slotmask6 depth5 AB cyc0 max0x20 rejnull accstat\n",
+ " --> frbtcfgfifo rejslot6 slotmask6 depth5 AB cyc0 max0x20 rejnull accstat\n"
+ " frbtcfgfifo rejslot6 slotmask6 depth5 AB cyc0 max0x20 rejnull accstat\n",
CMD_HANDLER(cmd_do_fr_config_fifo), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_init={
0, 0,
"frbtinit?","Initialize a FlexRay node",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtinit<CFG>\n"
+ " frbtinit<CFG>\n"
"\n"
- "where <CFG> identifies the configuration to use. It can be one of A, B\n"
+ "where `<CFG>` identifies the configuration to use. It can be one of A, B\n"
"or U. The A and B are predefined configurations. If U is specified,\n"
"the user configuration previously set by frbtconfig command is used.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_Init and Fr_ControllerInit functions from\n"
"the Autosar specification. It initializes the internal data structures\n"
"to send NULL frames. This command should be called as the very first\n"
"command, when trying to communicate over the FlexRay bus.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtinitA\n"
- " FlexRay driver initialized.\n"
- " FlexRay controller initialized.\n",
+ " --> frbtinitA\n"
+ " FlexRay driver initialized.\n"
+ " FlexRay controller initialized.\n",
CMD_HANDLER(cmd_do_fr_init), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_start={
0, 0,
"frbtstart","Start a new FlexRay network or join to the existing one",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtstart\n"
+ " frbtstart\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_StartCommunication function from the Autosar\n"
"specification.\n"
"\n"
"The command should be called after the frbtinit command.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtstart\n"
- " FlexRay communication is running.\n",
+ " --> frbtstart\n"
+ " FlexRay communication is running.\n",
CMD_HANDLER(cmd_do_fr_start), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_allslots={
0, 0,
"frbtallslots","Enables communication for all frames",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtallslots\n"
+ " frbtallslots\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_AllSlots function from the Autosar\n"
"specification.\n"
"all frames. The command can be called after the controller\n"
"initialization.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtallslots\n"
- " FlexRay node started communication on all slots.\n",
+ " --> frbtallslots\n"
+ " FlexRay node started communication on all slots.\n",
CMD_HANDLER(cmd_do_fr_allslots), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_halt={
0, 0,
"frbthalt","Halt FlexRay communication after the end of the actual communication cycle",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbthalt\n"
+ " frbthalt\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_HaltCommunication function from the Autosar\n"
"specification. The command invokes the FlexRay POC command HALT, which\n"
"command, which stops the communication immediately. To restart the\n"
"communication, the frbtinit and frbtstart commands have to be called.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbthalt\n"
- " FlexRay node communication halted.\n",
+ " --> frbthalt\n"
+ " FlexRay node communication halted.\n",
CMD_HANDLER(cmd_do_fr_halt), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_abort={
0, 0,
"frbtabort","Abort FlexRay communication immediately",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtabort\n"
+ " frbtabort\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_AbortCommunication function from the Autosar\n"
"specification. The command invokes the FlexRay POC command FREEZE,\n"
"restart the communication, the frbtinit and frbtstart commands have\n"
"to be called.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtabort\n"
- " FlexRay node communication aborted.\n",
+ " --> frbtabort\n"
+ " FlexRay node communication aborted.\n",
CMD_HANDLER(cmd_do_fr_abort), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_sendwup={
0, 0,
"frbtwup","Initiate the wake up procedure",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtwup\n"
+ " frbtwup\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_SendWUP function from the Autosar\n"
"specification. It initiates the wake up procedure by switching FlexRay\n"
"controller state machine to WAKEUP state.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtwup\n"
- " Wake up pattern has been sent.\n",
+ " --> frbtwup\n"
+ " Wake up pattern has been sent.\n",
CMD_HANDLER(cmd_do_fr_sendwup), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_setwuchannel={
0, 0,
"frbtsetwuch?","Set wake up channel",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtsetwuch<CHANNEL>\n"
+ " frbtsetwuch<CHANNEL>\n"
"\n"
- "where <CHANNEL> is a character A or B, specifying the channel.\n"
+ "where `<CHANNEL>` is a character A or B, specifying the channel.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_SetWakeupChannel function from the Autosar\n"
"specification. Wake up channel is the channel, where Wake Up Pattern\n"
"initialized and before the communication is running. The actual\n"
"wake-up pattern is sent by the frbtwup command.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtsetwuchA\n"
- " Wake up channel has been set.\n",
+ " --> frbtsetwuchA\n"
+ " Wake up channel has been set.\n",
CMD_HANDLER(cmd_do_fr_setwuchannel), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getpocstatus={
0, 0,
"frbtgetpocst","Print FlexRay POC status",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtgetpocst\n"
+ " frbtgetpocst\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetPOCStatus function from the Autosar\n"
"specification. It prints the main FlexRay POC status values in the\n"
"form of a table. The command should be called after the frbtinit\n"
"command.\n"
"\n"
- "=== Example ===\n"
- "\n"
- " --> frbtgetpocst\n"
- " POC status:\n"
- " CHIHaltRequest: FALSE\n"
- " CHIReadyRequest: FALSE\n"
- " ColdstartNoise: FALSE\n"
- " Freeze: FALSE\n"
- " ErrorMode: ACTIVE\n"
- " SlotMode: ALL\n"
- " StartupState: UNDEFINED\n"
- " State: READY\n"
- " WakeupStatus: UNDEFINED\n",
+ "### Example ###\n"
+ "\n"
+ " --> frbtgetpocst\n"
+ " POC status:\n"
+ " CHIHaltRequest: FALSE\n"
+ " CHIReadyRequest: FALSE\n"
+ " ColdstartNoise: FALSE\n"
+ " Freeze: FALSE\n"
+ " ErrorMode: ACTIVE\n"
+ " SlotMode: ALL\n"
+ " StartupState: UNDEFINED\n"
+ " State: READY\n"
+ " WakeupStatus: UNDEFINED\n",
CMD_HANDLER(cmd_do_fr_getpocstatus), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_transmittxlpdu={
0, 0,
"frbttransmit*","Transmit data in selected frame",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbttransmit<FRID> <DATA>\n"
+ " frbttransmit<FRID> <DATA>\n"
"where\n"
- "* <FRID> is a decimal number specifying the ID of the frame for which a buffer has been configured.\n"
- "* <DATA> is a sequence of hexadecimal numbers separated by spaces. Each number represents one byte of the message.\n"
"\n"
- "=== Description ===\n"
+ "- `<FRID>` is a decimal number specifying the ID of the frame for which a buffer has been configured.\n"
+ "- `<DATA>` is a sequence of hexadecimal numbers separated by spaces. Each number represents one byte of the message.\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_TransmitTxLPdu function from the Autosar\n"
"specification. The command finds the first buffer assigned to the\n"
"transmission starts at the next occurrence of the frame in the\n"
"communication cycle.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbttransmit1 12 34 56 AA BB CC\n"
- " Data were set for transmission.\n",
+ " --> frbttransmit1 12 34 56 AA BB CC\n"
+ " Data were set for transmission.\n",
CMD_HANDLER(cmd_do_fr_transmittxlpdu), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_canceltxlpdu={
0, 0,
"frbtcanceltx*","Stop the transmission of the frame",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtcanceltx<FRID>\n"
+ " frbtcanceltx<FRID>\n"
"\n"
- "where <FRID> is a decimal number specifying the ID of the frame for\n"
+ "where `<FRID>` is a decimal number specifying the ID of the frame for\n"
"which a buffer has been configured.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_CancelTxLPdu function from the Autosar\n"
"specification. The command finds all buffers assigned to the specified\n"
"RAM configuration (secureBuffers configuration parameter). Only TX\n"
"buffers and buffers not used for startup frames can be canceled.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtcanceltx3\n"
- " Transmission canceled.\n",
+ " --> frbtcanceltx3\n"
+ " Transmission canceled.\n",
CMD_HANDLER(cmd_do_fr_canceltxlpdu), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_receiverxlpdu={
0, 0,
"frbtreceive*","Receive a new message",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtreceive<FRID>\n"
+ " frbtreceive<FRID>\n"
"\n"
- "where <FRID> is a decimal number specifying the ID of the frame for\n"
+ "where `<FRID>` is a decimal number specifying the ID of the frame for\n"
"which a buffer was configured.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_ReceiveRxLPdu function from the Autosar\n"
"specification. The command finds the first buffer assigned to the\n"
"from a FIFO buffer and more messages are available in it, \"More\n"
"messages are still in FIFO\" is printed.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtreceive0\n"
- " More messages are still in FIFO:\n"
- " Received message (32 B):\n"
- " ee ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00\n",
+ " --> frbtreceive0\n"
+ " More messages are still in FIFO:\n"
+ " Received message (32 B):\n"
+ " ee ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00\n",
CMD_HANDLER(cmd_do_fr_receiverxlpdu), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_checktxlpdustatus={
0, 0,
"frbtchecktx*","Print the status of the transmit buffer",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtchecktx<FRID>\n"
+ " frbtchecktx<FRID>\n"
"\n"
- "where <FRID> is a decimal number specifying the ID of the frame for\n"
+ "where `<FRID>` is a decimal number specifying the ID of the frame for\n"
"which a buffer has been configured.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_CheckTxLPduStatus function from the Autosar\n"
"specification. The command finds the first buffer assigned to the\n"
"specified frame ID, reads its status and prints it. The buffer can be\n"
"in one of the two states:\n"
- "* Message transmission is pending, which means that the buffer has not yet sent its message in single shot mode or that it is in continuous mode.\n"
- "* No message transmission is pending, which means that the buffer is in single shot mode and the message has already been sent.\n"
"\n"
- "=== Example ===\n"
+ "- Message transmission is pending, which means that the buffer has not yet sent its message in single shot mode or that it is in continuous mode.\n"
+ "- No message transmission is pending, which means that the buffer is in single shot mode and the message has already been sent.\n"
"\n"
- " --> frbtchecktx1\n"
- " Message transmission is not pending.\n",
+ "### Example ###\n"
+ "\n"
+ " --> frbtchecktx1\n"
+ " Message transmission is not pending.\n",
CMD_HANDLER(cmd_do_fr_checktxlpdustatus), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_disablelpdu={
0, 0,
"frbtdisable*","Disable the buffers assigned to the frame",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtdisable<FRID>\n"
+ " frbtdisable<FRID>\n"
"\n"
- "where <FRID> is a decimal number specifying the ID of a frame. The\n"
+ "where `<FRID>` is a decimal number specifying the ID of a frame. The\n"
"buffers configure for this frame will be disabled.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_DisableLPdu function from the Autosar\n"
"specification. The command finds all buffers assigned to the specified\n"
"is not yet implemented). Buffers used for startup frames and FIFO RX\n"
"buffers cannot be disabled.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtdisable3\n"
- " Buffer disabled.\n",
+ " --> frbtdisable3\n"
+ " Buffer disabled.\n",
CMD_HANDLER(cmd_do_fr_disablelpdu), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getglobaltime={
0, 0,
"frbtglobtime","Print actual global time of the network",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtglobtime\n"
+ " frbtglobtime\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetGlobalTime function from the Autosar\n"
"specification. The command prints the time as a number of the current\n"
"cycle and the offset in the cycle in macroticks.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtglobtime\n"
- " Cycle number: 23\n"
- " Macrotick number: 6\n",
+ " --> frbtglobtime\n"
+ " Cycle number: 23\n"
+ " Macrotick number: 6\n",
CMD_HANDLER(cmd_do_fr_getglobaltime), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getnmvector={
0, 0,
"frbtnmvector","Print network management vector of the node",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtnmvector\n"
+ " frbtnmvector\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetNmVector function from the Autosar\n"
"specification. It prints the values of the network management vector\n"
"as hexadecimal numbers.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtnmvector\n"
- " Network management vector: 0 0 0 0 0 0 0 0 0 0 0 0\n",
+ " --> frbtnmvector\n"
+ " Network management vector: 0 0 0 0 0 0 0 0 0 0 0 0\n",
CMD_HANDLER(cmd_do_fr_getnmvector), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_nmwatch={
0, 0,
"frbtnmwatch","Watch the changes of the network managment vector in real-time",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtnmwatch\n"
+ " frbtnmwatch\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"Reads the network management vector every 100 ms and prints it out.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtnmwatch\n"
- " Network management vector: 0 0 0 0 0 0 0 0 0 0 0 0\n",
+ " --> frbtnmwatch\n"
+ " Network management vector: 0 0 0 0 0 0 0 0 0 0 0 0\n",
CMD_HANDLER(cmd_do_fr_nmwatch), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getchannelstatus={
0, 0,
"frbtchstat","Print channel A and B status",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtchstat\n"
+ " frbtchstat\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetChannelStatus function from the Autosar\n"
"specification.\n"
"\n"
- "=== Example ===\n"
- "\n"
- " --> frbtchstat\n"
- " Channel A status:\n"
- " aggregated channel status vSS!ValidFrame: TRUE\n"
- " aggregated channel status vSS!SyntaxError: FALSE\n"
- " aggregated channel status vSS!ContentError: FALSE\n"
- " aggregated channel status additional communication: FALSE\n"
- " aggregated channel status vSS!Bviolation: FALSE\n"
- " aggregated channel status vSS!TxConflict: FALSE\n"
- " Not used (0): FALSE\n"
- " Not used (0): FALSE\n"
- " symbol window status data vSS!ValidMTS: FALSE\n"
- " symbol window status data vSS!SyntaxError: FALSE\n"
- " symbol window status data vSS!Bviolation: FALSE\n"
- " symbol window status data vSS!TxConflict: FALSE\n"
- " NIT status data vSS!SyntaxError: FALSE\n"
- " NIT status data vSS!Bviolation: FALSE\n"
- " Not used (0): FALSE\n"
- " Not used (0): FALSE\n"
- " Channel B status:\n"
- " aggregated channel status vSS!ValidFrame: TRUE\n"
- " aggregated channel status vSS!SyntaxError: FALSE\n"
- " aggregated channel status vSS!ContentError: FALSE\n"
- " aggregated channel status additional communication: FALSE\n"
- " aggregated channel status vSS!Bviolation: FALSE\n"
- " aggregated channel status vSS!TxConflict: FALSE\n"
- " Not used (0): FALSE\n"
- " Not used (0): FALSE\n"
- " symbol window status data vSS!ValidMTS: FALSE\n"
- " symbol window status data vSS!SyntaxError: FALSE\n"
- " symbol window status data vSS!Bviolation: FALSE\n"
- " symbol window status data vSS!TxConflict: FALSE\n"
- " NIT status data vSS!SyntaxError: FALSE\n"
- " NIT status data vSS!Bviolation: FALSE\n"
- " Not used (0): FALSE\n"
- " Not used (0): FALSE\n",
+ "### Example ###\n"
+ "\n"
+ " --> frbtchstat\n"
+ " Channel A status:\n"
+ " aggregated channel status vSS!ValidFrame: TRUE\n"
+ " aggregated channel status vSS!SyntaxError: FALSE\n"
+ " aggregated channel status vSS!ContentError: FALSE\n"
+ " aggregated channel status additional communication: FALSE\n"
+ " aggregated channel status vSS!Bviolation: FALSE\n"
+ " aggregated channel status vSS!TxConflict: FALSE\n"
+ " Not used (0): FALSE\n"
+ " Not used (0): FALSE\n"
+ " symbol window status data vSS!ValidMTS: FALSE\n"
+ " symbol window status data vSS!SyntaxError: FALSE\n"
+ " symbol window status data vSS!Bviolation: FALSE\n"
+ " symbol window status data vSS!TxConflict: FALSE\n"
+ " NIT status data vSS!SyntaxError: FALSE\n"
+ " NIT status data vSS!Bviolation: FALSE\n"
+ " Not used (0): FALSE\n"
+ " Not used (0): FALSE\n"
+ " Channel B status:\n"
+ " aggregated channel status vSS!ValidFrame: TRUE\n"
+ " aggregated channel status vSS!SyntaxError: FALSE\n"
+ " aggregated channel status vSS!ContentError: FALSE\n"
+ " aggregated channel status additional communication: FALSE\n"
+ " aggregated channel status vSS!Bviolation: FALSE\n"
+ " aggregated channel status vSS!TxConflict: FALSE\n"
+ " Not used (0): FALSE\n"
+ " Not used (0): FALSE\n"
+ " symbol window status data vSS!ValidMTS: FALSE\n"
+ " symbol window status data vSS!SyntaxError: FALSE\n"
+ " symbol window status data vSS!Bviolation: FALSE\n"
+ " symbol window status data vSS!TxConflict: FALSE\n"
+ " NIT status data vSS!SyntaxError: FALSE\n"
+ " NIT status data vSS!Bviolation: FALSE\n"
+ " Not used (0): FALSE\n"
+ " Not used (0): FALSE\n",
CMD_HANDLER(cmd_do_fr_getchannelstatus), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getclockcorrection={
0, 0,
"frbtclkcor","Print clock correction (rate and offset)",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtclkcor\n"
+ " frbtclkcor\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetClockCorrection function from the Autosar\n"
"specification.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtclkcor\n"
- " Rate correction: 0\n"
- " Offset correction: 0\n",
+ " --> frbtclkcor\n"
+ " Rate correction: 0\n"
+ " Offset correction: 0\n",
CMD_HANDLER(cmd_do_fr_getclockcorrection), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getsyncframelist={
0, 0,
"frbtgetsyncfrlist*","Print the list of sync frames transmitted on both channels via the odd and even communication cycle",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtgetsyncfrlist<LENGTH>\n"
+ " frbtgetsyncfrlist<LENGTH>\n"
"\n"
- "where <LENGTH> is a decimal number in range 0 - 15, specifying the\n"
+ "where `<LENGTH>` is a decimal number in range 0 - 15, specifying the\n"
"length of the list to be printed.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetSyncFrameList function from the Autosar\n"
"specification.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtgetsyncfrlist2\n"
- " | Channel A even | channel B even | channel A odd | channel B odd |\n"
- " |----------------|----------------|----------------|----------------|\n"
- " | 1 | 1 | 1 | 1 |\n"
- " | 2 | 2 | 2 | 2 |\n"
- " |----------------|----------------|----------------|----------------|\n",
+ " --> frbtgetsyncfrlist2\n"
+ " | Channel A even | channel B even | channel A odd | channel B odd |\n"
+ " |----------------|----------------|----------------|----------------|\n"
+ " | 1 | 1 | 1 | 1 |\n"
+ " | 2 | 2 | 2 | 2 |\n"
+ " |----------------|----------------|----------------|----------------|\n",
CMD_HANDLER(cmd_do_fr_getsyncframelist), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getwakeuprxstatus={
0, 0,
"frbtgetwurxstat","Prints whether the wake up pattern has been or has not been received",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtgetwurxstat\n"
+ " frbtgetwurxstat\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetWakeupRxStatus function from the Autosar\n"
"specification. The status of the wake up receiving is bitcoded in the\n"
"controller. This command decodes and prints it in a readable format.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtgetwurxstat\n"
- " Wake up pattern was not yet received on channel A.\n"
- " Wake up pattern was not yet received on channel B.\n",
+ " --> frbtgetwurxstat\n"
+ " Wake up pattern was not yet received on channel A.\n"
+ " Wake up pattern was not yet received on channel B.\n",
CMD_HANDLER(cmd_do_fr_getwakeuprxstatus), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_settimer={
0, 0,
"frbtsettimer*","Set and start timer",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtsettimer<TMID> <CYCLE> <OFFSET>\n"
+ " frbtsettimer<TMID> <CYCLE> <OFFSET>\n"
"where\n"
- "* <TMID> is a number (0, 1) specifying the timer.\n"
- "* <CYCLE> is a 7-bit number (0 - 127) specifying the set of cycles, in which timer interrupt should be requested. The first set bit determines the period (1, 2, ..., 64) and the lower bits determine the offset in cycles within the period.\n"
- "* <OFFSET> is a decimal number (0 - 16383) specifying the offset in macroticks, where precisely in the cycle should be the timer interrupt requested.\n"
"\n"
- "=== Description ===\n"
+ "- `<TMID>` is a number (0, 1) specifying the timer.\n"
+ "- `<CYCLE>` is a 7-bit number (0 - 127) specifying the set of cycles, in which timer interrupt should be requested. The first set bit determines the period (1, 2, ..., 64) and the lower bits determine the offset in cycles within the period.\n"
+ "- `<OFFSET>` is a decimal number (0 - 16383) specifying the offset in macroticks, where precisely in the cycle should be the timer interrupt requested.\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command is similar to Fr_SetAbsoluteTimer function from the\n"
"Autosar specification. The difference is that the command allows to\n"
"Before using this command, FlexRay communication has to be started\n"
"(see frbtstart).\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtsettimer0 32 50\n"
- " Timer was set for every 32-th cycle, offset 0, macrotick 50\n"
- " --> frbtsettimer0 31 50\n"
- " Timer was set for every 16-th cycle, offset 15, macrotick 50\n"
- " --> frbtsettimer0 0x42 0\n"
- " Timer was set for every 64-th cycle, offset 2, macrotick 0\n",
+ " --> frbtsettimer0 32 50\n"
+ " Timer was set for every 32-th cycle, offset 0, macrotick 50\n"
+ " --> frbtsettimer0 31 50\n"
+ " Timer was set for every 16-th cycle, offset 15, macrotick 50\n"
+ " --> frbtsettimer0 0x42 0\n"
+ " Timer was set for every 64-th cycle, offset 2, macrotick 0\n",
CMD_HANDLER(cmd_do_fr_settimer), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_canceltimer={
0, 0,
"frbtcanceltimer*","Stop the timer",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtcanceltimer<TMID>\n"
- "where <TMID> is a number (0 or 1) specifying the timer.\n"
+ " frbtcanceltimer<TMID>\n"
+ "where `<TMID>` is a number (0 or 1) specifying the timer.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_CancelAbsoluteTimer function from the\n"
"Autosar specification. It stops the timer selected by the parameter.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtcanceltimer0\n"
- " Timer was canceled.\n",
+ " --> frbtcanceltimer0\n"
+ " Timer was canceled.\n",
CMD_HANDLER(cmd_do_fr_canceltimer), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_timerirq={
0, 0,
"frbttimerirq*","Perform selected action on the timer IRQ",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbttimerirq<TMID> <ACTION> - Run the <ACTION> on specified timer\n"
- " frbttimerirq<TMID> - Get timer IRQ status\n"
+ "
frbttimerirq<TMID> <ACTION> - Run the <ACTION> on specified timer\n"
+ " frbttimerirq<TMID> - Get timer IRQ status\n"
"\n"
"where\n"
- "* <TMID> is a number (0, 1) specifying the timer.\n"
- "* where <ACTION> is a string specifying the action to be performed on the selected timer IRQ.\n"
"\n"
- "<ACTIONS> can be one of:\n"
- "* EN - Enable the IRQ on the selected timer\n"
- "* DIS - Disable the IRQ on the selected timer\n"
- "* ACK - Acknowledge the IRQ on the selected timer (reset flag in the register).\n"
+ "- `<TMID>` is a number (0, 1) specifying the timer.\n"
+ "- where `<ACTION>` is a string specifying the action to be performed on the selected timer IRQ.\n"
+ "\n"
+ "`<ACTIONS>` can be one of:\n"
"\n"
- "=== Description ===\n"
+ "- EN - Enable the IRQ on the selected timer\n"
+ "- DIS - Disable the IRQ on the selected timer\n"
+ "- ACK - Acknowledge the IRQ on the selected timer (reset flag in the register).\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_EnableAbsoluteTimerIRQ,\n"
"Fr_AckAbsoluteTimerIRQ, Fr_DisableAbsoluteTimerIRQ and\n"
"interrupt request. If no action is specified it prints whether the IRQ\n"
"is pending for the timer.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbttimerirq0\n"
- " IRQ = FALSE\n"
+ " --> frbttimerirq0\n"
+ " IRQ = FALSE\n"
"\n"
- " --> frbttimerirq0 EN\n"
- " OK\n",
+ " --> frbttimerirq0 EN\n"
+ " OK\n",
CMD_HANDLER(cmd_do_fr_timerirq), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_getversioninfo={
0, 0,
"frbtversion","Print FlexRay driver version information",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtversion\n"
+ " frbtversion\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_GetVersionInfo function from the Autosar\n"
"specification.\n"
"It reads and prints the information about vendor, module and version of\n"
"the FlexRay driver\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtversion\n"
- " vendorID: 0xAAAA\n"
- " moduleID: 0xBBBB\n"
- " sw_major_version: 0x1\n"
- " sw_minor_version: 0x2\n"
- " sw_patch_version: 0x4\n",
+ " --> frbtversion\n"
+ " vendorID: 0xAAAA\n"
+ " moduleID: 0xBBBB\n"
+ " sw_major_version: 0x1\n"
+ " sw_minor_version: 0x2\n"
+ " sw_patch_version: 0x4\n",
CMD_HANDLER(cmd_do_fr_getversioninfo), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_readcconfig={
0, 0,
"frbtccconfig*","Print value of a FlexRay cluster and node configuration parameter",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtccconfig<INDEX>\n"
+ " frbtccconfig<INDEX>\n"
"\n"
- "where <INDEX> is an identifier of the parameter.\n"
+ "where `<INDEX>` is an identifier of the parameter.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_ReadCCConfig function from the Autosar\n"
"specification. The driver stores the configuration parameters as an\n"
"(http://www.autosar.org/download/R4.1/AUTOSAR_SWS_FlexRayDriver.pdf),\n"
"section 8.2.1 for parameter indexes.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtccconfig1\n"
- " Value = 0x1\n",
+ " --> frbtccconfig1\n"
+ " Value = 0x1\n",
CMD_HANDLER(cmd_do_fr_readcconfig), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fr_reconfigure_buffer={
0, 0,
"frbtreconfigurebuf*","Reconfigure a buffer to communicate in another slot",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frbtreconfigurebuf id<ID> slot<SLOT> <CHN> cycset<CYCS> cycoffset<CYCO> max<MAX>\n"
+ " frbtreconfigurebuf id<ID> slot<SLOT> <CHN> cycset<CYCS> cycoffset<CYCO> max<MAX>\n"
"where\n"
- "* <ID> is a number specifying a slot, where the buffer is currently communicating,\n"
- "* <SLOT> is a number, where buffer will be communicating after the reconfiguration,\n"
- "* <CHN> is one of 'A', 'B' or 'AB' and identifies the used channel,\n"
- "* <CYCS> is the cycle set. It has to be one of 0, 1, 2, 4, 8, 16, 32, 64. It specifies together with <CYCO> the cycle filtering.\n"
- "* <CYCO> is the cycle offset. It has to be in range 0 - <CYCS>-1"
- "* <MAX> is the number determining the maximum payload (in hald-words).\n"
"\n"
- "=== Description ===\n"
+ "- `<ID>` is a number specifying a slot, where the buffer is currently communicating,\n"
+ "- `<SLOT>` is a number, where buffer will be communicating after the reconfiguration,\n"
+ "- `<CHN>` is one of 'A', 'B' or 'AB' and identifies the used channel,\n"
+ "- `<CYCS>` is the cycle set. It has to be one of 0, 1, 2, 4, 8, 16, 32, 64. It specifies together with `<CYCO>` the cycle filtering.\n"
+ "- `<CYCO>` is the cycle offset. It has to be in range 0 - `<CYCS>`-1"
+ "- `<MAX>` is the number determining the maximum payload (in hald-words).\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command stands for Fr_ReconfigLPDu function from the Autosar\n"
"specification. It reconfigures specified buffer to communicate in\n"
"are not reconfigurable.\n"
"The command can be called any time when the communication is running.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frbtreconfigurebuf id2 slot3 AB cycset1 cycoffset0 max9\n"
- " frbtreconfigurebuf id2 slot3 AB cycset1 cycoffset0 max9\n",
+ " --> frbtreconfigurebuf id2 slot3 AB cycset1 cycoffset0 max9\n"
+ " frbtreconfigurebuf id2 slot3 AB cycset1 cycoffset0 max9\n",
CMD_HANDLER(cmd_do_fr_reconfigure_buffer), (void *)&cmd_list_fr_basic_test
};
cmd_des_t const cmd_des_fray_stat={
0, 0,
"frayxcvrstat#","Get the status of a FlexRay transceiver in a human readable form",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " frayxcvrstat<CHN>\n"
+ " frayxcvrstat<CHN>\n"
"where CHN is a number in range 1-2\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command receives response from a FlexRay transceiver via SPI, and\n"
"prints in the form of attribute-value table.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> frayxcvrstat1\n"
+ " --> frayxcvrstat1\n"
"\n"
"Prints the status of FRAY1 transceiver.\n",
CMD_HANDLER(cmd_do_fray_status), (void *)&cmd_list_fray
cmd_des_t const cmd_des_test_fray_a={
0, 0,
"fraytestA","Run the FlexRay test as A node",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " fraytestA [<COUNT>]\n"
+ " fraytestA [<COUNT>]\n"
"\n"
- "where <COUNT> is an optional number of messages to send. The default\n"
+ "where `<COUNT>` is an optional number of messages to send. The default\n"
"is 100.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The commands creates FlexRay node A and starts sending a message\n"
"approximately every communication cycle. COUNT messages are sent for the\n"
cmd_des_t const cmd_des_test_fray_b={
0, 0,
"fraytestB","Run the FlexRay test as B node",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " fraytestB [<COUNT>]\n"
+ " fraytestB [<COUNT>]\n"
"\n"
- "where <COUNT> is an optional number of messages to receive. The default\n"
+ "where `<COUNT>` is an optional number of messages to receive. The default\n"
"is 100.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The commands creates FlexRay node B and starts receiving a messages.\n"
"100 messages should be received. The command should be run with two\n"
cmd_des_t const cmd_des_hbr_enable = {
0, 0,
"hbrenable*","Enable the H-bridge and set its PWM period",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " hbrenable<PER>\n"
"\n"
- "where <PER> is PWM period in microseconds.\n"
+ "where `<PER>` is PWM period in microseconds.\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command enables the H-bridge (HBR pin), i.e. the enable signal\n"
"the H-bridge chip is set, the watchdog reset task is started and the\n"
"starting with hbr is used. If H-bridge is already enabled, an error is\n"
"printed.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> hbrenable1000\n"
- " hbrenable =1000\n"
+ " --> hbrenable1000\n"
+ " hbrenable =1000\n"
"\n"
"Enables HBR with period 1000 microseconds (frequency 1 kHz). HBR\n"
"output is still inactive, but ready for other commands.\n",
cmd_des_t const cmd_des_hbr_control = {
0, 0,
"hbrcontrol*","Set the motor voltage direction and size in percent",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " hbrcontrol<SPEED>\n"
+ " hbrcontrol<SPEED>\n"
"\n"
- "where <SPEED> specifies direction and PWM duty cycle in percent (a\n"
+ "where `<SPEED>` specifies direction and PWM duty cycle in percent (a\n"
"number in range -100, 100).\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command sets the direction and the size of the voltage at HBR\n"
"output.\n"
"HBR has to be enabled by hbrenable command before calling this\n"
"command.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> hbrcontrol-25\n"
- " hbrcontrol =-25\n"
+ " --> hbrcontrol-25\n"
+ " hbrcontrol =-25\n"
"\n"
"Rotates the motor to the left with 25% speed.\n"
"\n"
- " --> hbrcontrol25\n"
- " hbrcontrol =25\n"
+ " --> hbrcontrol25\n"
+ " hbrcontrol =25\n"
"\n"
"Rotates the motor to the right with 25% speed.\n"
"\n"
- " --> hbrcontrol0\n"
- " hbrcontrol =0\n"
+ " --> hbrcontrol0\n"
+ " hbrcontrol =0\n"
"\n"
"Stops the motor.\n",
CMD_HANDLER(cmd_do_hbr_control), (void *)&cmd_list_hbr
cmd_des_t const cmd_des_hbr_disable = {
0, 0,
"hbrdisable","Disable the H-bridge",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " hbrdisable\n"
+ " hbrdisable\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command disables the H-bridge HBR, which means that the PWM is\n"
"stopped and the enable signal is cleared. The watchdog task is left\n"
"After H-bridge is disabled, it cannot be controlled by any command\n"
"until it is enabled again by the hbrenable command.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> hbrdisable\n"
- " hbrdisable=0\n"
+ " --> hbrdisable\n"
+ " hbrdisable=0\n"
"\n"
"Stops motor and disables the H-bridge.\n",
CMD_HANDLER(cmd_do_hbr_disable), (void *)&cmd_list_hbr
cmd_des_t const cmd_des_test_hout_fail = {
0, 0,
"houtfail*","Test if some HOUT pin is in the fault state",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " houtfail<PIN>\n"
- "where <PIN> is in range 1-6\n"
+ "where `<PIN>` is in range 1-6\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command tests, if HOUT pin is in a good condition. When the\n"
"circuit controlling HOUT pin detects some failure, it signals that on\n"
"print its state.\n"
"\n"
"Possible outputs of this command:\n"
- "* OK - no failure detected\n"
- "* FAIL - a failure detected\n"
- "* NOT RUNNING - PWM was set set up and started\n"
+ "\n"
+ "- OK - no failure detected\n"
+ "- FAIL - a failure detected\n"
+ "- NOT RUNNING - PWM was set set up and started\n"
"\n"
"Note: Before using this command, houtpwmstart and houtpwm commands\n"
"should be called.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> houtpwm6 1000 25\n"
- " --> houtpwmstart6\n"
- " --> houtfail6\n"
- " OK\n"
+ " --> houtpwm6 1000 25\n"
+ " --> houtpwmstart6\n"
+ " --> houtfail6\n"
+ " OK\n"
"\n"
"Detects the state of the HOUT1 and prints OK, FAIL or NOT RUNNING.\n",
CMD_HANDLER(cmd_do_test_hout_fault), (void *)&cmd_list_hout
cmd_des_t const cmd_des_read_hifbk={
0, 0,
"houtifbk","Read values from HOUT current feedback",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " houtifbk\n"
+ " houtifbk\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command reads analog values from HOUT_IFBK pins and prints\n"
"them in a table.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
" --> houtifbk\n"
" HOUT1: 0\n"
cmd_des_t const cmd_des_hout_pwm={
0, 0,
"houtpwm*","Set or get actual PWM parameters",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " houtpwm<PIN> <PER> <DUTY>\n"
- " houtpwm<PIN>\n"
+ "
houtpwm<PIN> <PER> <DUTY>\n"
"where\n"
- "* <PIN> is a number in range 1-6\n"
- "* <PER> is a length of the PWM period in microseconds\n"
- "* <DUTY> is a the PWM duty cycle in percent (0-100)\n"
"\n"
- "=== Description ===\n"
+ "- `<PIN>` is a number in range 1-6\n"
+ "- `<PER>` is a length of the PWM period in microseconds\n"
+ "- `<DUTY>` is a the PWM duty cycle in percent (0-100)\n"
+ "\n"
+ "### Description ###\n"
"\n"
"This command can be used to set or get HOUT PWM parameters.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> houtpwm1 1000 25\n"
+ " --> houtpwm1 1000 25\n"
"\n"
"HOUT1 PWM will have the period of 1ms and will be active for 25% of\n"
"this period.\n"
"\n"
- " --> houtpwm1\n"
- " houtpwm1_period=1000\n"
- " houtpwm1_duty=25\n"
+ " --> houtpwm1\n"
+ " houtpwm1_period=1000\n"
+ " houtpwm1_duty=25\n"
"\n"
"Prints the actual period of HOUT1 PWM in microseconds and the duty\n"
"cycle in percents.\n",
cmd_des_t const cmd_des_hout_pwm_start={
0, 0,
"houtstartpwm*","Start generating PWM signal on HOUT",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " houtstartpwm<PIN>\n"
- "where <PIN> is a number in range 1-6\n"
+ "where `<PIN>` is a number in range 1-6\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command starts to generate the PWM signal on the specified HOUT\n"
"pin. The HOUT PWM has to be previously set by the houtpwm command,\n"
"otherwise an error is printed.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> houtpwm1 1000 25\n"
- " --> houtstartpwm1\n"
+ " --> houtpwm1 1000 25\n"
+ " --> houtstartpwm1\n"
"\n"
"HOUT1 PWM generation will be started.\n",
CMD_HANDLER(cmd_do_hout_pwm_start), (void *)&cmd_list_hout
cmd_des_t const cmd_des_hout_pwm_stop={
0, 0,
"houtstoppwm*","Stop generating of PWM signal on HOUT",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " houtstoppwm<PIN>\n"
- "where <PIN> is a number in range 1-6\n"
+ "where `<PIN>` is a number in range 1-6\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command stops generating the PWM signal on the selected pin.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> houtstoppwm1\n"
+ " --> houtstoppwm1\n"
"\n"
"HOUT1 PWM generation will be deactivated.\n",
CMD_HANDLER(cmd_do_hout_pwm_stop), (void *)&cmd_list_hout
cmd_des_t const cmd_des_lin_loop_back={
0, 0,
"lintest","Test the digital loopback on LIN",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " lintest\n"
+ " lintest\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command can be used for testing the LIN. The command starts to\n"
"send a short message on the LIN port and is testing if it is correctly\n"
cmd_des_t const cmd_des_lout_set={
0, 0,
"loutset*","Set a value of the LOUT pin",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " loutset<PIN> <VALUE>\n"
+ "
loutset<PIN> <VALUE>\n"
"where\n"
- "* <PIN> is a number in range 1-8\n"
- "* <VALUE> is a binary value to be set (0 or 1)\n"
"\n"
- "=== Description ===\n"
+ "- `<PIN>` is a number in range 1-8\n"
+ "- `<VALUE>` is a binary value to be set (0 or 1)\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command sets the digital value on the LOUT pin.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> loutset1 1\n"
+ " --> loutset1 1\n"
"\n"
"Sets LOUT1 to 1.\n"
"\n"
- " --> loutset2 0\n"
+ " --> loutset2 0\n"
"\n"
"Sets LOUT2 to 0.\n",
CMD_HANDLER(cmd_do_lout_set), (void *)&cmd_list_lout
cmd_des_t const cmd_des_lout_diag={
0, 0,
"loutdiag*","Read a diagnostic value from an LOUT pin",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " loutdiag<PIN>\n"
"\n"
- "where <PIN> is a number in range 1-8\n"
+ "where `<PIN>` is a number in range 1-8\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command reads a logical value of the LOUT diagnostic signal.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> loutdiag1\n"
+ " --> loutdiag1\n"
"\n"
"Reads value of the LOUT1 diagnostic signal.\n",
CMD_HANDLER(cmd_do_lout_diag), (void *)&cmd_list_lout
cmd_des_t const cmd_des_control={
0, 0,
"demomotctrl","Run motor control demo - reads input and sends it",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " demomotctrl\n"
+ " demomotctrl\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command creates a FlexRay node and starts to read buttons\n"
"(connected to DIN0 and DIN1) and a potentiometer (ADC1) from a control\n"
cmd_des_t const cmd_des_motor={
0, 0,
"demomotdrive","Run motor control demo - drives the DC motor",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " demomotdrive\n"
+ " demomotdrive\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command creates a FlexRay node and starts to receive the data\n"
"from another node created by command demomotctrl. The received data\n"
0,CDESM_SPACE_SEP,
"ethnc","Start very simple netcat",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " ethnc <IP> <PORT> [-p <PORT>] [-u] [-m [-t] | -d [-t]] [-c]\n"
- " ethnc -l <PORT> [-u] [-m [-t] | -d [-t]] [-c]\n"
+ "
ethnc <IP> <PORT> [-p <PORT>] [-u] [-m [-t] | -d [-t]] [-c]\n"
+ "
ethnc -l <PORT> [-u] [-m [-t] | -d [-t]] [-c]\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"Netcat is a program which allows to communicate using TCP or UDP\n"
"protocols. First a connection is established by either:\n"
- "* connecting to a specified IP address and PORT (without option -l) or by\n"
- "* listening for a new connection on a given PORT (with option -l).\n"
+ "\n"
+ "- connecting to a specified IP address and PORT (without option -l) or by\n"
+ "- listening for a new connection on a given PORT (with option -l).\n"
"\n"
"When no -u option is specified ethnc command works with TCP\n"
"connections. With -u option UDP communication is used. Listening for\n"
"\n"
"Once the connection is established the command works in one of the\n"
"following modes:\n"
- "* interactive mode in which received data are forwarded to serial line and data received on serial line are sent to the connection when either new line is encountered or when internal buffer is full,\n"
- "* sending of testing data (increasing ASCII formatted numbers) (option -d),\n"
- "* looping of incoming data back to the connection's peer (option -m).\n"
+ "\n"
+ "- interactive mode in which received data are forwarded to serial line and data received on serial line are sent to the connection when either new line is encountered or when internal buffer is full,\n"
+ "- sending of testing data (increasing ASCII formatted numbers) (option -d),\n"
+ "- looping of incoming data back to the connection's peer (option -m).\n"
"\n"
"Note: When trying to use a same local TCP port number multiple times\n"
"in a row (-l or -p options) there might be several minutes delay\n"
"This situation is singled with ERROR 31.\n"
"\n"
"Other options:\n"
- "* -p specifies local port for outgoing connections.\n"
- "* -u use UDP protocol instead of the default TCP.\n"
- "* -t send and/or receive data in a background thread (works only with -d or -m options).\n"
- "* -c stop all running background tasks\n"
"\n"
- "=== Examples ===\n"
+ "- -p specifies local port for outgoing connections.\n"
+ "- -u use UDP protocol instead of the default TCP.\n"
+ "- -t send and/or receive data in a background thread (works only with -d or -m options).\n"
+ "- -c stop all running background tasks\n"
+ "\n"
+ "### Examples ###\n"
"\n"
"Listen for incoming TCP connection on local port 2000:\n"
- " --> ethnc -l 2000\n"
+ " --> ethnc -l 2000\n"
"\n"
"Connect using TCP to address 192.168.247.15 to remote port 80 using local port 1500:\n"
- " --> ethnc 192.168.247.15 80 -p 1500\n"
+ " --> ethnc 192.168.247.15 80 -p 1500\n"
"\n"
"Send testing data to the remote node:\n"
- " --> ethnc -d 192.168.247.2 1025\n"
+ " --> ethnc -d 192.168.247.2 1025\n"
"\n"
"Loop back all data coming from remote node's UDP port 1025:\n"
- " --> ethnc -m -u 192.168.247.2 1025\n"
+ " --> ethnc -m -u 192.168.247.2 1025\n"
"\n"
"Wait for a TCP connection on local port 30000 and loop all incoming data\n"
"back:\n"
- " --> ethnc -l 30000 -m\n",
+ " --> ethnc -l 30000 -m\n",
CMD_HANDLER(cmd_do_init_nc), (void *)&cmd_list_nc
};
0,0,
"ethlinkstat","Print current status of ethernet interface",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " ethlinkstat\n"
+ " ethlinkstat\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command reads PHY link status assigned to ethernet interface and\n"
"prints interface name and informs about PHY's status to the output.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> ethlinkstat\n"
- " et0 : UP\n"
+ " --> ethlinkstat\n"
+ " et0 : UP\n"
"\n"
- " --> ethlinkstat\n"
- " et0 : DOWN\n",
+ " --> ethlinkstat\n"
+ " et0 : DOWN\n",
CMD_HANDLER(cmd_do_read_linkstat), (void *)&cmd_list_netstats
};
0,0,
"ethmac","Print current MAC address of ethernet interface",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " ethmac\n"
+ " ethmac\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command obtains MAC address from ethernet interface structure\n"
"and prints it to the output.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> ethmac\n"
- " 12:34:56:78:9a:bc\n",
+ " --> ethmac\n"
+ " 12:34:56:78:9a:bc\n",
CMD_HANDLER(cmd_do_read_mac), (void *)&cmd_list_netstats
};
0,0,
"ethip","Print current IP address of network interface",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " ethip\n"
+ " ethip\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command reads current IP address, netmask and gateway of network\n"
"interface and prints these to the output.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> ethip\n"
- " Address: 192.168.247.1\n"
- " Netmask: 255.255.255.0\n"
- " Gateway: 192.168.247.255\n",
+ " --> ethip\n"
+ " Address: 192.168.247.1\n"
+ " Netmask: 255.255.255.0\n"
+ " Gateway: 192.168.247.255\n",
CMD_HANDLER(cmd_do_read_ip), (void *)&cmd_list_netstats
};
0,CDESM_SPACE_SEP,
"ethbd","Examine emac buffer descriptors",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " ethbd\n"
+ " ethbd\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"After startup you use keys to control what will be done.\n"
- "* q - quit\n"
- "* s - general statistics\n"
- "* t - transmit channel status\n"
- "* r - receive channel status\n"
- "* b - after giving address of bd it prints bd content\n"
- "* a - checks consistency of buffer descriptors\n"
"\n"
+ "- q - quit\n"
+ "- s - general statistics\n"
+ "- t - transmit channel status\n"
+ "- r - receive channel status\n"
+ "- b - after giving address of bd it prints bd content\n"
+ "- a - checks consistency of buffer descriptors\n"
"\n"
- "=== Example ===\n"
"\n"
- " --> ethbd\n"
- " \n",
+ "### Example ###\n"
+ "\n"
+ " --> ethbd\n",
CMD_HANDLER(cmd_do_bufferdescriptors), (void *)&cmd_list_netstats
};
0,0,
"dhcp","Prints and controls DHCP",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " dhcp\n"
+ " dhcp\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"\n"
".\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> dhcp\n"
- " \n",
+ " --> dhcp\n"
+ " \n",
CMD_HANDLER(cmd_do_dhcp), (void *)&cmd_list_netstats
};
#endif
0,0,
"lwip","Prints statistics for the LwIP stack",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " lwip\n"
+ " lwip\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"Sections printed:\n"
"LINK\n"
"SYS\n"
".\n"
"Shown sections depends on modules compiled in.\n"
- " \n",
+ " \n",
CMD_HANDLER(cmd_do_lwip), (void *)&cmd_list_netstats
};
#endif
0,0,
"ethinit","Post OS startup eth initialization",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " ethinit\n"
+ " ethinit\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"This command finishes autonegotiation of PHY and initialize LwIP stack.\n"
"\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> ethinit\n"
- " \n",
+ " --> ethinit\n"
+ " \n",
CMD_HANDLER(cmd_do_ethinit), (void *)&cmd_list_netstats
};
cmd_des_t const cmd_des_pin_list = {
0, 0,
"pinlist","Print a list of all defined pins.",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " pinlist\n"
+ " pinlist\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command prints a list of all defined pins accessible by pinval and\n"
"pindir commands.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> pinlist\n"
- " List of all defined pins. Those names can be used by pinval command.\n"
- " FANCTRL\n"
- " ETHRST\n"
- " VBAT1EN\n"
- " VBAT2EN\n"
- " VBAT3EN\n"
- " VBATEN\n"
- " SPICSA\n"
- " SPICSB\n"
- " MOUT1EN\n"
- " MOUT2EN\n"
- " CANNSTB\n"
- " CANEN\n"
- " LIN2NSLP\n"
- " LIN1NSLP\n"
- " DININT\n"
- " DIN8\n"
- " DIN9\n"
- " DIN10\n"
- " DIN11\n"
- " DIN12\n"
- " DIN13\n"
- " DIN14\n"
- " DIN15\n"
- " MOUT6EN\n"
- " MOUT5EN\n"
- " MOUT6IN\n"
- " MOUT5IN\n"
- " MOUT4EN\n"
- " MOUT3EN\n"
- " MOUT4IN\n"
- " MOUT3IN\n"
- " HBREN\n"
- " HBRDIR\n"
- " HBRPWM\n"
- " MOUT1IN\n"
- " MOUT2IN\n"
- " HOUT1IN\n"
- " HOUT1DIAG\n"
- " HOUT2IN\n"
- " HOUT2DIAG\n"
- " HOUT3IN\n"
- " HOUT3DIAG\n"
- " HOUT4IN\n"
- " HOUT4DIAG\n"
- " HOUT5IN\n"
- " HOUT5DIAG\n"
- " HOUT6IN\n"
- " HOUT6DIAG\n",
+ " --> pinlist\n"
+ " List of all defined pins. Those names can be used by pinval command.\n"
+ " FANCTRL\n"
+ " ETHRST\n"
+ " VBAT1EN\n"
+ " VBAT2EN\n"
+ " VBAT3EN\n"
+ " VBATEN\n"
+ " SPICSA\n"
+ " SPICSB\n"
+ " MOUT1EN\n"
+ " MOUT2EN\n"
+ " CANNSTB\n"
+ " CANEN\n"
+ " LIN2NSLP\n"
+ " LIN1NSLP\n"
+ " DININT\n"
+ " DIN8\n"
+ " DIN9\n"
+ " DIN10\n"
+ " DIN11\n"
+ " DIN12\n"
+ " DIN13\n"
+ " DIN14\n"
+ " DIN15\n"
+ " MOUT6EN\n"
+ " MOUT5EN\n"
+ " MOUT6IN\n"
+ " MOUT5IN\n"
+ " MOUT4EN\n"
+ " MOUT3EN\n"
+ " MOUT4IN\n"
+ " MOUT3IN\n"
+ " HBREN\n"
+ " HBRDIR\n"
+ " HBRPWM\n"
+ " MOUT1IN\n"
+ " MOUT2IN\n"
+ " HOUT1IN\n"
+ " HOUT1DIAG\n"
+ " HOUT2IN\n"
+ " HOUT2DIAG\n"
+ " HOUT3IN\n"
+ " HOUT3DIAG\n"
+ " HOUT4IN\n"
+ " HOUT4DIAG\n"
+ " HOUT5IN\n"
+ " HOUT5DIAG\n"
+ " HOUT6IN\n"
+ " HOUT6DIAG\n",
CMD_HANDLER(cmd_do_pin_list), (void *)&cmd_list_pin
};
cmd_des_t const cmd_des_pin_val={
0, 0,
"pinval*","Set or get the pin value",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " pinval<NAME> <VAL>\n"
- " pinval<NAME>\n"
+ " pinval<NAME> <VAL>\n"
+ " pinval<NAME>\n"
"where\n"
- "* <NAME> is a string identifying the pin\n"
- "* <VAL> can be 0 or 1\n"
"\n"
- "=== Description ===\n"
+ "- `<NAME>` is a string identifying the pin\n"
+ "- `<VAL>` can be 0 or 1\n"
+ "\n"
+ "### Description ###\n"
"\n"
"This command is sets or gets a value of the particular pin.\n"
"\n"
"This command serves as supplement to highlevel commands for testing\n"
"purpose.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> pinvalHBREN 1\n"
- " pinvalHBREN=1\n"
+ " --> pinvalHBREN 1\n"
+ " pinvalHBREN=1\n"
"\n"
"Sets the HBR_EN pin to 1.\n"
"\n"
- " --> pinvalHBREN\n"
- " pinvalHBREN=1\n"
+ " --> pinvalHBREN\n"
+ " pinvalHBREN=1\n"
"\n"
"Gets a value of the HBR_EN pin.\n",
CMD_HANDLER(cmd_do_pin_val), (void *)&cmd_list_pin
cmd_des_t const cmd_des_pin_dir={
0, 0,
"pindir*","Set the pin direction",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " pindir<NAME> <DIR>\n"
- " pindir<NAME>\n"
+ " pindir<NAME> <DIR>\n"
+ " pindir<NAME>\n"
"where\n"
- "* <NAME> is a string identifying the pin\n"
- "* DIR is be either 0 (input) or 1 (output)\n"
"\n"
- "=== Description ===\n"
+ "- `<NAME>` is a string identifying the pin\n"
+ "- DIR is be either 0 (input) or 1 (output)\n"
+ "\n"
+ "### Description ###\n"
"\n"
"This command is used to set or get direction of the particular pin.\n"
"\n"
"This command serves as supplement to highlevel commands for testing\n"
"purpose.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> pindirHBREN 1\n"
- " pindirHBREN=1\n"
+ " --> pindirHBREN 1\n"
+ " pindirHBREN=1\n"
"\n"
"Sets the HBR_EN pin as output.\n"
"\n"
- " --> pindirHBREN\n"
- " pindirHBREN=1\n"
+ " --> pindirHBREN\n"
+ " pindirHBREN=1\n"
"\n"
"Gets the direction of the HBR_EN pin.\n",
CMD_HANDLER(cmd_do_pin_dir), (void *)&cmd_list_pin
cmd_des_t const cmd_des_port_val={
0, 0,
"portval*","Read or write values from or to the port",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " portval<NAME> <VAL>\n"
- " portval<NAME>\n"
+ " portval<NAME> <VAL>\n"
+ " portval<NAME>\n"
"where\n"
- "* <NAME> is a string specifying the name of the port\n"
- "* <VAL> is a sequence of hexadecimal numbers, separated by spaces, e.g. 12 AA CD\n\n"
"\n"
- "=== Description ===\n"
+ "- `<NAME>` is a string specifying the name of the port\n"
+ "- `<VAL>` is a sequence of hexadecimal numbers, separated by spaces, e.g. 12 AA CD\n\n"
+ "\n"
+ "### Description ###\n"
"\n"
"This command sets or gets values of all pins on the specified port.\n"
"If the port is connected to the GPIO interface of the MCU, then\n"
"NOTE: For successful communication with the HBR, HBR_EN pin must\n"
"be set first.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> portvalMOUTIN 3A\n"
- " portvalMOUTIN=0\n"
- " --> portvalMOUTIN\n"
- " 0\n"
- " 1\n"
- " 0\n"
- " 1\n"
- " 1\n"
- " 1\n"
+ " --> portvalMOUTIN 3A\n"
+ " portvalMOUTIN=0\n"
+ " --> portvalMOUTIN\n"
+ " 0\n"
+ " 1\n"
+ " 0\n"
+ " 1\n"
+ " 1\n"
+ " 1\n"
"\n"
"This pair of commands sets:\nMOUT1IN"
"MOUT1IN=0\n"
cmd_des_t const cmd_des_port_list={
0, 0,
"portlist","Print a list of all port names",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " portlist\n"
+ " portlist\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command prints the list of all defined ports accessible via the\n"
"portval command. Each record of the list is a couple of\n"
"The type of the MCU<->port interface slightly modifies the meaning\n"
"of the portval command."
"\n"
- "=== Example ===\n"
- "\n"
- " --> portlist\n"
- " List of all defined ports with its type. Those names can be used by portval command.\n"
- " DINMCU, GPIO\n"
- " DINSPI, SPI\n"
- " HOUTDIAG, GPIO\n"
- " HOUTIN, GPIO\n"
- " HOUTIFBK, ADC\n"
- " ADC, ADC\n"
- " LOUT, SPI\n"
- " DAC12, SPI\n"
- " DAC34, SPI\n"
- " DACDREF, SPI\n"
- " HBR, SPI\n"
- " FRAY1, SPI\n"
- " FRAY2, SPI\n"
- " MOUTEN, GPIO\n"
- " MOUTIN, GPIO\n",
+ "### Example ###\n"
+ "\n"
+ " --> portlist\n"
+ " List of all defined ports with its type. Those names can be used by portval command.\n"
+ " DINMCU, GPIO\n"
+ " DINSPI, SPI\n"
+ " HOUTDIAG, GPIO\n"
+ " HOUTIN, GPIO\n"
+ " HOUTIFBK, ADC\n"
+ " ADC, ADC\n"
+ " LOUT, SPI\n"
+ " DAC12, SPI\n"
+ " DAC34, SPI\n"
+ " DACDREF, SPI\n"
+ " HBR, SPI\n"
+ " FRAY1, SPI\n"
+ " FRAY2, SPI\n"
+ " MOUTEN, GPIO\n"
+ " MOUTIN, GPIO\n",
CMD_HANDLER(cmd_do_port_list), (void *)&cmd_list_port
};
cmd_des_t const cmd_des_test_sdram={
0, 0,
"sdramtest","Test if the SDRAM module is connected and if so, measures its capacity",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " sdramtest\n"
+ " sdramtest\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command tests SDRAM address space by writing and reading a\n"
"pattern to/from it. It detects the SDRAM capacity.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> sdramtest\n"
- " SDRAM installed: 64 MB\n",
+ " --> sdramtest\n"
+ " SDRAM installed: 64 MB\n",
CMD_HANDLER(cmd_do_test_ram), (void *)&cmd_list_sdram
};
cmd_des_t const cmd_des_test_log={
0, 0,
"sdramlogtest","Open a command subprocessor for managing SDRAM logging",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " sdramlogtest\n"
+ " sdramlogtest\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"The command opens a subcommand processor, which contains testing\n"
"commands for logging into SDRAM.\n",
cmd_des_t const cmd_des_spi_translate={
0, CDESM_OPCHR|CDESM_RW,
"spitr*","Translate response from an SPI peripheral",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " spitr<NAME> <CMD> <RESP>\n"
+ " spitr<NAME> <CMD> <RESP>\n"
"where\n"
- "* <NAME> is a string specifying the name of the peripheral (one of DINSPI, LOUT, DAC12, DAC34, HBR, FRAY1 and FRAY2)\n"
- "* <CMD> is a hexadecimal number in range 0 - FFFFFFFF\n"
- "* <RESP> is a hexadecimal number in range 0 - FFFFFFFF\n"
"\n"
- "=== Description ===\n"
+ "- `<NAME>` is a string specifying the name of the peripheral (one of DINSPI, LOUT, DAC12, DAC34, HBR, FRAY1 and FRAY2)\n"
+ "- `<CMD>` is a hexadecimal number in range 0 - FFFFFFFF\n"
+ "- `<RESP>` is a hexadecimal number in range 0 - FFFFFFFF\n"
+ "\n"
+ "### Description ###\n"
"\n"
"This command translates a response from SPI from many different\n"
"peripherals into a human readable form. The SPI response is in the\n"
"response, the name of the peripheral and translates the response into\n"
"the attribute-value table.\n"
"\n"
- "=== Example ===\n"
- " --> portvalDINSPI 7F 00 00\n"
- " portvalDINSPI=AAC03F\n"
- " --> spitrDINSPI 7F0000 3FC0AA\n"
- " Thermal flag : 0\n"
- " INT flag : 0\n"
- " SP0 - DIN0 : 1\n"
- " SP1 - DIN1 : 1\n"
- " SP2 - DIN2 : 1\n"
- " SP3 - DIN3 : 1\n"
- " SP4 - DIN4 : 1\n"
- " SP5 - DIN5 : 1\n"
- " SP6 - DIN6 : 1\n"
- " SP7 - DIN7 : 1\n"
- " SG0 - DIN8 : 0\n"
- " SG1 - DIN9 : 1\n"
- " SG2 - DIN10 : 0\n"
- " SG3 - DIN11 : 1\n"
- " SG4 - DIN12 : 0\n"
- " SG5 - DIN13 : 1\n"
- " SG6 - DIN14 : 0\n"
- " SG7 - DIN15 : 1\n"
- " SG8 - NA : 0\n"
- " SG9 - NA : 0\n"
- " SG10 - NA : 0\n"
- " SG11 - NA : 0\n"
- " SG12 - NA : 0\n"
- " SG13 - NA : 0\n"
- " spitrDINSPI=24\n"
+ "### Example ###\n"
+ " --> portvalDINSPI 7F 00 00\n"
+ " portvalDINSPI=AAC03F\n"
+ " --> spitrDINSPI 7F0000 3FC0AA\n"
+ " Thermal flag : 0\n"
+ " INT flag : 0\n"
+ " SP0 - DIN0 : 1\n"
+ " SP1 - DIN1 : 1\n"
+ " SP2 - DIN2 : 1\n"
+ " SP3 - DIN3 : 1\n"
+ " SP4 - DIN4 : 1\n"
+ " SP5 - DIN5 : 1\n"
+ " SP6 - DIN6 : 1\n"
+ " SP7 - DIN7 : 1\n"
+ " SG0 - DIN8 : 0\n"
+ " SG1 - DIN9 : 1\n"
+ " SG2 - DIN10 : 0\n"
+ " SG3 - DIN11 : 1\n"
+ " SG4 - DIN12 : 0\n"
+ " SG5 - DIN13 : 1\n"
+ " SG6 - DIN14 : 0\n"
+ " SG7 - DIN15 : 1\n"
+ " SG8 - NA : 0\n"
+ " SG9 - NA : 0\n"
+ " SG10 - NA : 0\n"
+ " SG11 - NA : 0\n"
+ " SG12 - NA : 0\n"
+ " SG13 - NA : 0\n"
+ " spitrDINSPI=24\n"
"\n"
"Translates response 0x3FC0AA returned by command 0x7F0000 into a human\n"
"readable form.\n"
cmd_des_t const cmd_des_spimst = {
0, 0,
"spimst*", "Request SPI master communication",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " spimst<SPI> <ADDR> <DATA>\n"
+ "
spimst<SPI> <ADDR> <DATA>\n"
"where\n"
- "* <SPI> is a number in range 0 - 4\n"
- "* <ADDR> is a number in range 0 - 2\n"
- "* <DATA> is a sequence of hexadecimal numbers, separated by spaces, e.g. 12 AA CD\n"
"\n"
- "=== Description ===\n"
+ "- `<SPI>` is a number in range 0 - 4\n"
+ "- `<ADDR>` is a number in range 0 - 2\n"
+ "- `<DATA>` is a sequence of hexadecimal numbers, separated by spaces, e.g. 12 AA CD\n"
+ "\n"
+ "### Description ###\n"
"\n"
"The command sends given data to the SPI peripheral and prints the\n"
"response. The response contains the address and the received data in\n"
"parentheses.\n"
"\n"
- "=== Example ===\n"
+ "### Example ###\n"
"\n"
- " --> spimst1 0 7F 00 00\n"
- " spirx:0x0(0x3f,0xc0,0xff)\n"
+ " --> spimst1 0 7F 00 00\n"
+ " spirx:0x0(0x3f,0xc0,0xff)\n"
"\n"
"Sends reset command (0x7F0000) to the DIN peripheral.\n",
CMD_HANDLER(cmd_do_spimst), (void *)&cmd_list_spi
cmd_des_t const cmd_des_power_on = {
0, 0,
"poweron","Enable VBATEN and VBAT1EN power supply by using PWM hack",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " poweron\n"
+ " poweron\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command tries to work around error on VBAT power supply wiring\n"
"and attempts to switch the power supply on.\n"
cmd_des_t const cmd_des_power_off = {
0, 0,
"poweroff","Disables VBATEN and VBAT1EN power supply",
- "=== Command syntax ===\n"
+ "### Command syntax ###\n"
"\n"
- " poweroff\n"
+ " poweroff\n"
"\n"
- "=== Description ===\n"
+ "### Description ###\n"
"\n"
"This command turns off VBAT and VBAT1 voltages.\n",
CMD_HANDLER(cmd_do_power_off), (void *)&cmd_list_vbat
clean:
rm -f $(OBJS) docgen
-
-upload: docgen
- ./docgen wiki | ./wiki-edit.pl TestCommands -
+doc.mw: docgen
+ (echo '<div class="toclimit-2" style="float: right; margin-left: 1em;">__TOC__</div>'; ./docgen wiki) | pandoc -f markdown_strict -t mediawiki > $@
+
+doc.mdwn: docgen Makefile
+# ./docgen wiki | pandoc -f markdown_strict -t markdown_strict > $@
+ ./docgen wiki > $@
+
+doc.html: docgen Makefile
+ ./docgen wiki | pandoc -f markdown_strict -t html --base-header-level=2 > $@
+
+upload: upload-mw upload-web
+
+upload-mw: doc.mw
+ cat $< | ./wiki-edit.pl TestCommands -
+
+WEB=../../../../web/
+WEBDST=$(WEB)test-sw-commands/rpp-test-sw.mdwn
+upload-web: doc.mdwn
+ifneq ($(wildcard $(WEBDST)),)
+ cp $< $(WEBDST)
+ make -C $(WEB)
+ git -C $(WEB) add $(WEBDST:$(WEB)%=%)
+ if ! git -C $(WEB) diff --cached --quiet; then git -C $(WEB) commit -m 'Automatic update of command reference' $(WEBDST:$(WEB)%=%) && git -C $(WEB) push; fi
+endif
FORCE:
void print_wiki(const cmd_des_t *des)
{
- printf("== %s ==\n", des->name);
+ printf("## %s ##\n", des->name);
printf("%s\n", des->help);
printf("%s", des->long_help);
}
fflush(stdout);
system("git describe --always");
printf("\n");
- printf("<div class='toclimit-2'>__TOC__</div>\n");
}
else
mode = COMMAND_HELP;
projects / pes-rpp / rpp-test-sw.git / commitdiff