]> rtime.felk.cvut.cz Git - pes-rpp/rpp-test-sw.git/commitdiff
Long descriptio modified,
authorMichal Horn <hornmich@fel.cvut.cz>
Fri, 26 Jul 2013 15:52:26 +0000 (17:52 +0200)
committerMichal Horn <hornmich@fel.cvut.cz>
Fri, 26 Jul 2013 15:52:26 +0000 (17:52 +0200)
Output added to some of the exaples

15 files changed:
commands/cmd.c
commands/cmd_adc.c
commands/cmd_can.c
commands/cmd_dac.c
commands/cmd_din.c
commands/cmd_hbr.c
commands/cmd_hout.c
commands/cmd_lin.c
commands/cmd_lout.c
commands/cmd_motor_example.c
commands/cmd_pin.c
commands/cmd_port.c
commands/cmd_sdram.c
commands/cmd_spi.c
commands/cmd_vbat.c

index 6689484dd5b52b0984ea84832bc74d4ba9d057ad..a7874d34bf2727e48ee6d2199148549b40c505d7 100644 (file)
@@ -87,7 +87,7 @@ cmd_des_t const cmd_des_sleep={
     "\n"
     "=== Description ===\n"
     "\n"
-    "This command configures LIN and CAN peripherals to enter sleep mode\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"
     "LIN will wake the device up.\n",
     CMD_HANDLER(cmd_do_sleep), (void *)&cmd_list
@@ -96,7 +96,7 @@ cmd_des_t const cmd_des_sleep={
 /** Command descriptor for show help command */
 cmd_des_t const cmd_des_help={
     0, 0,
-    "help","prints help for commands.",
+    "help","Prints help for commands",
     "=== Syntax ===\n"
     "\n"
     " help [command]\n"
@@ -105,7 +105,7 @@ cmd_des_t const cmd_des_help={
     "\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"
-    "provided, the command prints help for the given command.\n",
+    "provided, the command prints a long description for given command.\n",
     CMD_HANDLER(cmd_do_help), (void *)&cmd_list
 };
 
index 13a51086a594f6dfb0d2fbc3c2bbaf104048bec5..e31c989f5a6ed104e3b0da149a7335aad3e1f3e1 100644 (file)
@@ -60,7 +60,7 @@ int cmd_do_read_adc1_values(cmd_io_t *cmd_io, const struct cmd_des *des, char *p
 /** Descriptor of command for adc port reading */
 cmd_des_t const cmd_des_read_adc1={
     0, 0,
-    "readadc","Reads values from ADC1.",
+    "readadc","Reads values from ADC1",
     "=== Command syntax ===\n"
     "\n"
     "   readadc\n"
@@ -68,7 +68,26 @@ cmd_des_t const cmd_des_read_adc1={
     "=== Description ===\n"
     "\n"
     "This command reads values of all ADIN 1-12 channels and prints it as\n"
-    "channel-value (hexadecimal) table.\n",
+    "channel-value (hexadecimal) table.\n"
+    "\n"
+       "=== Example ===\n"
+       "\n"
+       "   --> readadc\n"
+    "ADC1: values: \n"
+       "Channel: 1     value: 110\n"
+       "Channel: 2     value: 107\n"
+       "Channel: 3     value: 109\n"
+       "Channel: 4     value: 108\n"
+       "Channel: 5     value: 109\n"
+       "Channel: 6     value: 110\n"
+       "Channel: 7     value: 111\n"
+       "Channel: 8     value: 110\n"
+       "Channel: 9     value: 107\n"
+       "Channel: 10    value: 109\n"
+       "Channel: 11    value: 110\n"
+       "Channel: 12    value: 110\n"
+       "\n"
+       "Prints the values of all ADC channels.\n",
     CMD_HANDLER(cmd_do_read_adc1_values), (void *)&cmd_list_adc
 };
 
index 1ad000b9403c56f4226e0c1a0a16e57ca385635b..bcefa21f4764c93d88b8e20bbdf47a1139351ba0 100644 (file)
@@ -247,26 +247,26 @@ int cmd_do_test_can_loopback(cmd_io_t *cmd_io, const struct cmd_des *des, char *
 /** @brief command descriptor for test CAN loopback command */
 cmd_des_t const cmd_des_test_can_loopback={
     0, 0,
-    "testcan*", "Test CAN loopback between source and destination nodes.",
+    "cantest*", "Test CAN loopback between source and destination nodes.",
     "=== Command syntax ===\n"
     "\n"
-    "   testcan SOURCE DESTINATION\n"
-    "where SOURCE and DESTINATION is a number in the range 1-3 and SOURCE\n"
-    "is not equal DESTINATION.\n"
+    "   cantest <SOURCE> <DESTINATION>\n"
+    "where <SOURCE> and <DESTINATION> is a number in range 1-3 and <SOURCE>\n"
+    "is not equal <DESTINATION>.\n"
     "\n"
     "=== Description ===\n"
     "\n"
     "This command tests CAN bus by sending and receiving messages through\n"
-    "external loopback. When bus is in fault state, this command resets it\n"
+    "external loopback. When the bus is in fault state, this command resets it\n"
     "into functional state.\n"
     "\n"
-    "Command sends a message 100 times and measures number of TX errors, RX\n"
-    "errors and eventual timeouts. In the end the state of the bus and number\n"
+    "The command sends a message 100 times and measures number of TX errors, RX\n"
+    "errors and eventual timeouts. At the end the state of the bus and the number\n"
     "of errors is printed.\n"
     "\n"
     "=== Example ===\n"
     "\n"
-    "   --> testcan 1 2\n"
+    "   --> cantest 1 2\n"
     "\n"
     "Sends 100 times message from CAN1 to CAN2\n",
     CMD_HANDLER(cmd_do_test_can_loopback), (void *)&cmd_list_can
index 6bbdd089591d959881ff0df1d6acb7ba0d023d09..94db9efdb0be4d232743e8866624633e32c3fd9c 100644 (file)
@@ -173,6 +173,7 @@ cmd_des_t const cmd_des_dac_pin_setup = {
        "=== Example ===\n"
        "\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
@@ -201,6 +202,7 @@ cmd_des_t const cmd_des_dac_pin_set_val = {
        "=== Example ===\n"
        "\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
@@ -227,9 +229,13 @@ cmd_des_t const cmd_des_dac_pin_set_voltage = {
        "=== Example ===\n"
        "\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"
+       "\n"
        "Sets pin DAC2 to 500mV, prints actual voltage (500)\n",
        CMD_HANDLER(cmd_do_dac_pin_set_voltage), (void *)&cmd_list_dac
 };
index 72bcb35ae48b56a2fef784d8009c58d6d09b18e4..889cbf7e9d327d11b316b02452f8a4f0a12afd5a 100644 (file)
@@ -183,6 +183,7 @@ cmd_des_t const cmd_des_din_setup={
        "=== Example ===\n"
        "\n"
        "   --> dinsetup1:(1,0,0)\n"
+       "dinsetup1=10000\n"
        "\n"
        "Sets the DIN1 as switch to ground, active and disables IRQ generation\n"
        "and wake up function.\n",
@@ -205,6 +206,8 @@ cmd_des_t const cmd_des_din_get={
        "=== Example ===\n"
        "\n"
        "   --> dinget1?\n"
+       "dinget1=0\n"
+       "\n"
        "Prints the value of the DIN1 pin.\n",
        CMD_HANDLER(cmd_do_din_get), (void *)&cmd_list_din
 };
@@ -227,6 +230,8 @@ cmd_des_t const cmd_des_din_diag={
        "=== Example ===\n"
        "\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
 };
index ec93d2fb3f61fd87d0c0871f7e6725d81494f930..1103dd4c81c3c461c745d5cfdcfa59e9d77c910d 100644 (file)
@@ -60,7 +60,7 @@ int cmd_do_hbr_enable(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[]
                rpp_sci_printf("Enable procedure failed.");
        }
 
-       return cmd_opchar_replong(cmd_io, param, ret, 0, 16);
+       return cmd_opchar_replong(cmd_io, param, period, 0, 16);
 }
 
 /**
@@ -92,7 +92,7 @@ int cmd_do_hbr_control(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[
                rpp_sci_printf("Command out of range.");
                return -CMDERR_BADPAR;
        }
-       return cmd_opchar_replong(cmd_io, param, ret, 0, 16);
+       return cmd_opchar_replong(cmd_io, param, cmd, 0, 16);
 }
 
 /**
@@ -120,8 +120,8 @@ cmd_des_t const cmd_des_hbr_enable = {
     "hbrenable","Enables H-bridge with given period.",
        "=== Command syntax ===\n"
        "\n"
-       "   hbrenable:X\n"
-       "where X is PWM period in us\n"
+       "   hbrenable:<PER>\n"
+       "where <PER> is PWM period in us\n"
        "\n"
        "=== Description ===\n"
        "\n"
@@ -136,20 +136,21 @@ cmd_des_t const cmd_des_hbr_enable = {
        "=== Example ===\n"
        "\n"
        "   --> hbrenable:1000\n"
+       "hbrenable=3E8\n"
        "\n"
        "Enables HBR with period 1kHz. HBR output is still inactive, but ready for\n"
-    "other commands calls.\n",
+    "other commands.\n",
     CMD_HANDLER(cmd_do_hbr_enable), (void *)&cmd_list_hbr
 };
 
 /** Command descriptor for HBR control command */
 cmd_des_t const cmd_des_hbr_control = {
     0, CDESM_OPCHR|CDESM_WR,
-    "hbrcontrol","Sets direction and PWM duty cycle <-100; 100>.",
+    "hbrcontrol","Sets motor direction and speed in % <-100; 100>.",
        "=== Command syntax ===\n"
        "\n"
-       "   hbrcontrol:X\n"
-       "where X specifies direction and PWM duty cycle in % (is in range -100 - 100)\n"
+       "   hbrcontrol:<SPEED>\n"
+       "where <SPEED> specifies direction and PWM duty cycle in % (is in range -100 - 100)\n"
        "\n"
        "=== Description ===\n"
        "\n"
@@ -167,14 +168,17 @@ cmd_des_t const cmd_des_hbr_control = {
        "=== Example ===\n"
        "\n"
        "   --> hbrcontrol:-25\n"
+       "hbrcontrol=FFFFFFE7\n"
        "\n"
        "Activates motor rotation to the left with 25% speed.\n"
        "\n"
        "   --> hbrcontrol:25\n"
+       "hbrcontrol=19\n"
        "\n"
        "Activates motor rotation to the right with 25% speed.\n"
        "\n"
        "   --> hbrcontrol:0\n"
+       "hbrcontrol=0\n"
        "\n"
        "Deactivates motor rotation.\n",
     CMD_HANDLER(cmd_do_hbr_control), (void *)&cmd_list_hbr
@@ -199,6 +203,7 @@ cmd_des_t const cmd_des_hbr_disable = {
        "=== Example ===\n"
        "\n"
        "   --> hbrdisable\n"
+       "hbrdisable=0\n"
        "\n"
        "Stops motor and disables H-bridge.\n",
     CMD_HANDLER(cmd_do_hbr_disable), (void *)&cmd_list_hbr
index 881d94e59de4cb3ace052b3fbc9043893380c4ae..af914d0c128d9bb4fc8e6dc728ea56e1bed1af17 100644 (file)
@@ -195,16 +195,16 @@ int cmd_do_hout_pwm_stop(cmd_io_t *cmd_io, const struct cmd_des *des, char *para
 /** Command descriptor for test hout fault state command */
 cmd_des_t const cmd_des_test_hout_fail = {
     0, 0,
-    "houtfail","Test if some HOUT pin is in fault state.",
+    "houtfail","Test if some HOUT pin is in fault state",
     "=== Command syntax ===\n"
     "\n"
-    "   houtfail PIN\n"
-    "where PIN is in range 1-6\n"
+    "   houtfail <PIN>\n"
+    "where <PIN> is in range 1-6\n"
     "\n"
     "=== Description ===\n"
     "\n"
     "This command tests, if HOUT pin is in good condition. When a circuit,\n"
-    "controlling HOUT pin, detects some failure, it starts to generate signal\n"
+    "controlling HOUT pin, detects some failure, it starts to generate signal\n"
     "on HOUT_DIAG pin. This command is supposed to detect such a state.\n"
     "\n"
     "=== Example ===\n"
@@ -218,14 +218,14 @@ cmd_des_t const cmd_des_test_hout_fail = {
 /** Command descriptor for hout read IFBK command */
 cmd_des_t const cmd_des_read_hifbk={
     0, 0,
-    "readhifbk","Reads values from HOUT IFBK.",
+    "readhifbk","Reads values from HOUT IFBK",
     "=== Command syntax ===\n"
     "\n"
     "   readhifbk\n"
     "\n"
      "=== Description ===\n"
     "\n"
-    "Command reads analog values on HOUT_IFBK pins and prints\n"
+    "The command reads analog values from HOUT_IFBK pins and prints\n"
     "them in HOUTX-value table.\n",
    CMD_HANDLER(cmd_do_read_hout_ifbk_values), (void *)&cmd_list_hout
 };
@@ -233,17 +233,17 @@ cmd_des_t const cmd_des_read_hifbk={
 /** Command descriptor for HOUT set PWM command */
 cmd_des_t const cmd_des_hout_pwm={
     0, CDESM_OPCHR|CDESM_RW,
-    "houtpwm*","Set or get actual PWM parameters.",
+    "houtpwm*","Set or get actual PWM parameters",
     "=== Command syntax ===\n"
     "\n"
-    "   houtpwmPIN:(PER,DUTY)\n"
-    "   houtpwmPIN?\n"
+    "   houtpwm<PIN>:(<PER>,<DUTY>)\n"
+    "   houtpwm<PIN>?\n"
     "where\n"
-    "* PIN is in range 1-6\n"
-    "* : means set parameters and parameters in brackets are mandatory\n"
-    "* ? means get parameters and no parameters are used\n"
-    "* PER is greater than 0\n"
-    "* DUTY is in range 0-100\n"
+    "* <PIN> is a number in range 1-6\n"
+    "* : means set parameters\n"
+    "* ? means get parameters\n"
+    "* <PER> is a number greater than 0\n"
+    "* <DUTY> is a number in range 0-100\n"
     "\n"
     "=== Description ===\n"
     "\n"
@@ -265,16 +265,16 @@ cmd_des_t const cmd_des_hout_pwm={
 /** Command descriptor for PWM start command */
 cmd_des_t const cmd_des_hout_pwm_start={
     0, 0,
-    "houtpwmstart#","Start generating PWM signal on HOUT.",
+    "houtpwmstart#","Start generating PWM signal on HOUT",
     "=== Command syntax ===\n"
     "\n"
-    "   houtpwmstartPIN\n"
-    "where PIN is in range 1-6\n"
+    "   houtpwmstart<PIN>\n"
+    "where <PIN> is a number in range 1-6\n"
     "\n"
     "=== Description ===\n"
     "\n"
-    "If HOUT PWM was previously set by houtpwm command, this command starts to\n"
-    "generate PWM signal on specified pin.\n"
+    "If HOUT PWM was previously set by the houtpwm command, this command starts to\n"
+    "generate the PWM signal on specified pin.\n"
     "\n"
     "=== Example ===\n"
     "\n"
@@ -287,15 +287,15 @@ cmd_des_t const cmd_des_hout_pwm_start={
 /** Command descriptor for PWM stop command */
 cmd_des_t const cmd_des_hout_pwm_stop={
     0, 0,
-    "houtpwmstop#","Stop generating of PWM signal on HOUT.",
+    "houtpwmstop#","Stop generating of PWM signal on HOUT",
     "=== Command syntax ===\n"
     "\n"
-    "   houtpwmstopPIN\n"
-    "where PIN is in range 1-6\n"
+    "   houtpwmstop<PIN>\n"
+    "where <PIN> is a number in range 1-6\n"
     "\n"
     "=== Description ===\n"
     "\n"
-    "This command stops generating PWM signal on selected pin.\n"
+    "This command stops generating the PWM signal on selected pin.\n"
     "\n"
     "=== Example ===\n"
     "\n"
index d65031b2a15c24e3451190f4ce94e3ae9085b941..c38c8a55bbfd005deeb0482d65ed1b512ef27086 100644 (file)
@@ -114,16 +114,16 @@ int cmd_do_lin_loop_back(cmd_io_t *cmd_io, const struct cmd_des *des, char *para
 /** Descriptor of command for lin loopback test */
 cmd_des_t const cmd_des_lin_loop_back={
     0, 0,
-    "testlin","Test digital loopback on LIN.",
+    "lintest","Test digital loopback on LIN",
     "=== Command syntax ===\n"
     "\n"
-    "   testlin\n"
+    "   lintest\n"
     "\n"
     "=== Description ===\n"
     "\n"
-    "This command can be used for testing LIN. Command starts sending short\n"
-    "message on LIN port and is testing if it is correctly received through\n"
-    "internal loopback.\n",
+    "This command can be used for testing the LIN. The command starts to send\n"
+    "short message on the LIN port and is testing if it is correctly received\n"
+    "via an internal loopback.\n",
     CMD_HANDLER(cmd_do_lin_loop_back), (void *)&cmd_list_lin
 };
 
index cd1b58252be18835bf975287129fcc4a9fb67454..05dbf91fd94063c8704abd46b05af7c7e4474909 100644 (file)
@@ -111,17 +111,17 @@ int cmd_do_lout_diag(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 /** Command descriptor for lout set port value */
 cmd_des_t const cmd_des_lout_set={
        0, CDESM_OPCHR|CDESM_WR,
-       "loutset#","Set value to LOUT pin.",
+       "loutset#","Set a value to the LOUT pin",
     "=== Command syntax ===\n"
     "\n"
-    "   loutsetPIN:VALUE\n"
+    "   loutset<PIN>:<VALUE>\n"
     "where\n"
-    "* PIN is in range 1-8\n"
-    "* VALUE is binary value to be set\n"
+    "* <PIN> is a number in range 1-8\n"
+    "* <VALUE> is a binary value to be set\n"
        "\n"
     "=== Description ===\n"
     "\n"
-       "Command sets digital value on an output pin LOUT.\n"
+       "The command sets the digital value on the output pin LOUT.\n"
        "=== Example ===\n"
        "\n"
        "   --> loutset1:1\n"
@@ -137,16 +137,16 @@ cmd_des_t const cmd_des_lout_set={
 /** Command descriptor for lout get pin diag value */
 cmd_des_t const cmd_des_lout_diag={
        0, CDESM_OPCHR|CDESM_RD,
-       "loutdiag#","Reads diagnostic value from LOUT pin.",
+       "loutdiag#","Reads a diagnostic value from LOUT pin",
     "=== Command syntax ===\n"
     "\n"
-    "   loutdiagPIN?\n"
+    "   loutdiag<PIN>?\n"
     "where\n"
-    "* PIN is in range 1-8\n"
+    "* <PIN> is a number in range 1-8\n"
        "\n"
     "=== Description ===\n"
     "\n"
-       "Command reads digital value from LOUT diagnostic signal.\n"
+       "The command reads digital value from the LOUT diagnostic signal.\n"
     "\n"
        "=== Example ===\n"
        "\n"
index 1e367993ac95ef169df22b867d472e899d73159d..a9fcb09dd4f52005c9e689d202b80d76d1f41fbd 100644 (file)
@@ -386,16 +386,16 @@ cmd_des_t const cmd_des_control={
 /** Command descriptor for motor */
 cmd_des_t const cmd_des_motor={
                0, 0,
-               "motor","Run example - motor controller.",
+               "demomotmotor","Run motor control demo - drives the DC motor.",
                "=== Command syntax ===\n"
                "\n"
-               "   demomot\n"
+               "   demomotmotor\n"
                "\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"
-               "are applied to HBR to control DC motor.\n"
+               "are applied to HBR to control the DC motor.\n"
                "\n"
                "The purpose of this pair of commands is to demonstrate functionality\n"
                "of the FlexRay, ADC, DIN and HBR peripherals.\n",
index d9b716c0928462cbc74674d7ff51da0df216aedb..fe048b398e0bb58e8ef83176ae9d168cdd9952b9 100644 (file)
@@ -138,14 +138,14 @@ int cmd_do_pin_dir(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[]) {
 /** Command descriptor for pin list */
 cmd_des_t const cmd_des_pin_list = {
     0, 0,
-    "pinlist","Prints list of all defined pins.",
+    "pinlist","Prints list of all defined pins.",
     "=== Command syntax ===\n"
     "\n"
     "   pinlist\n"
     "\n"
     "=== Description ===\n"
     "\n"
-    "Commands prints list of all defined pins accessible by pinval\n"
+    "The command prints list of all defined pins accessible by a pinval\n"
     "and pindir commands\n",
     CMD_HANDLER(cmd_do_pin_list), (void *)&cmd_list_pin
 };
@@ -156,67 +156,69 @@ cmd_des_t const cmd_des_pin_val={
        "pinval*","Sets or get pin value.",
        "=== Command syntax ===\n"
        "\n"
-       "   pinvalNAME:VAL\n"
-       "   pinvalNAME?\n"
+       "   pinval<NAME>:<VAL>\n"
+       "   pinval<NAME>?\n"
        "where\n"
-       "* NAME is a string\n"
-       "* : means assign VAL to pin NAME\n"
-       "* ? means get value from pin NAME\n"
-       "* VAL can be 0 or 1\n"
+       "* <NAME> is a string specifying the name of the pin\n"
+       "* : means assign <VAL> to the pin <NAME>\n"
+       "* ? means get a value from the pin <NAME>\n"
+       "* <VAL> can be either 0 or 1\n"
        "\n"
        "=== Description ===\n"
        "\n"
-       "This command is used as setter or getter of a value of selected pin.\n"
+       "This command is used as setter or getter of a value of the selected pin.\n"
        "\n"
-       "Pin name can be obtained by pinlist command.\n"
+       "The pin name can be obtained by a pinlist command.\n"
        "\n"
        "Most of the pins are accessible indirectly via highlevel commands\n"
-       "HBR_EN is for example controlled by hbrenable command. This command\n"
+       "HBR_EN is for example controlled by the hbrenable command. This command\n"
        "serves as supplement to highlevel commands for testing purpose.\n"
        "\n"
        "=== Example ===\n"
        "\n"
        "   --> pinvalHBREN:1\n"
-       "Set pin HBR_EN to 1\n"
+       "Sets the HBR_EN pin to 1\n"
        "\n"
        "   ---> pinvalHBREN?\n"
+       "pinvalHBREN?\n"
        "\n"
-       "Get value of HBR_EN pin\n",
+       "Gets a value of the HBR_EN pin\n",
        CMD_HANDLER(cmd_do_pin_val), (void *)&cmd_list_pin
 };
 
 /** Command descriptor for pin get/set direction */
 cmd_des_t const cmd_des_pin_dir={
        0, CDESM_OPCHR|CDESM_RW,
-       "pindir*","Sets pin direction 1-out, 0-in.",
+       "pindir*","Sets the pin direction 1-out, 0-in",
        "=== Command syntax ===\n"
        "\n"
-       "   pinvdirNAME:DIR\n"
-       "   pinvdirNAME?\n"
+       "   pindir<NAME>:<DIR>\n"
+       "   pindir<NAME>?\n"
        "where\n"
-       "* NAME is a string\n"
-       "* : means assign DIR to pin NAME\n"
-       "* ? means get direction of pin NAME\n"
-       "* DIR can be 0 or 1\n"
+       "* <NAME> is a string specifying the name of the pin\n"
+       "* : means assign <DIR> to the pin <NAME>\n"
+       "* ? means get direction of the pin <NAME>\n"
+       "* <DIR> is either 0 (input) or 1 (output)\n"
        "\n"
        "=== Description ===\n"
        "\n"
-       "This command is used as setter or getter of a direction of selected pin.\n"
+       "This command is used as setter or getter of the direction of the selected pin.\n"
        "\n"
-       "Pin name can be obtained by pinlist command.\n"
+       "The pin name can be obtained by a pinlist command.\n"
        "\n"
        "Most of the pins are accessible indirectly via highlevel commands\n"
-       "HBR_EN is for example controlled by hbrenable command. This command\n"
+       "HBR_EN is for example controlled by the hbrenable command. This command\n"
        "serves as supplement to highlevel commands for testing purposes.\n"
        "\n"
        "=== Example ===\n"
        "\n"
        "   --> pindirHBREN:1\n"
-       "Set pin HBR_EN as output\n"
+       "Sets the HBR_EN pin as output\n"
        "\n"
        "   ---> pindirHBREN?\n"
+       "pindirHBREN=1\n"
        "\n"
-       "Get direction of HBR_EN pin\n",
+       "Gets direction of the HBR_EN pin\n",
        CMD_HANDLER(cmd_do_pin_dir), (void *)&cmd_list_pin
 };
 
index a1e1e890f6e6db794d4ee9141dbe8c7be886c7ad..4e4d7a5bb5fba2ca844b4542ff3f5f477ea14552 100644 (file)
@@ -96,23 +96,23 @@ int cmd_do_port_val(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 /** Command descriptor for read values from port command */
 cmd_des_t const cmd_des_port_val={
     0, CDESM_OPCHR|CDESM_RW,
-    "portval*","Read/write values from/to port.",
+    "portval*","Read or write values from or to the port",
     "=== Command syntax ===\n"
     "\n"
-    "   portvalNAME:(VAL)\n"
+    "   portval<NAME>:(<VAL>)\n"
     "where\n"
-    "* NAME is a string\n"
-    "* : means assign VAL to port NAME\n"
-    "* ? means get value from port NAME\n"
-    "* VAL is a hexadecimal value in range 00 - FF\n"
+    "* <NAME> is a string specifying the name of the port\n"
+    "* : means assign <VAL> to the port <NAME>\n"
+    "* ? means get a value from the port <NAME>\n"
+    "* <VAL> is a hexadecimal number in range 00 - FF\n"
     "\n"
     "=== Description ===\n"
     "\n"
-    "This command sets or gets values of all pins on specified port. First\n"
+    "This command sets or gets values of all pins on the specified port. First\n"
     "bit from the right is assigned to the first pin, second bit is assigned\n"
     "to the second pin, etc.\n"
     "\n"
-    "Port name can be obtained by portlist command.\n"
+    "Port name can be obtained by the portlist command.\n"
     "\n"
     "=== Example ===\n"
     "\n"
@@ -132,7 +132,7 @@ cmd_des_t const cmd_des_port_val={
 /** Command descriptor for port list printout */
 cmd_des_t const cmd_des_port_list={
     0, 0,
-    "portlist","Print list of port names.",
+    "portlist","Print list of all port names",
     "=== Command syntax ===\n"
     "\n"
     "   portlist\n"
@@ -140,7 +140,7 @@ cmd_des_t const cmd_des_port_list={
     "=== Description ===\n"
     "\n"
     "This command prints list of all defined ports accessible via\n"
-    "portval command.\n",
+    "the portval command.\n",
     CMD_HANDLER(cmd_do_port_list), (void *)&cmd_list_port
 };
 
index 4d9c541fb652faa940a42ad3748915c05aa8a736..afda36696a7cfddfc53fe57f56b6ff89d7d7a4c4 100644 (file)
@@ -237,29 +237,36 @@ int cmd_do_test_ram(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 /** Command descriptor for test SDRAM */
 cmd_des_t const cmd_des_test_sdram={
     0, 0,
-    "testsdram","Test if SDRAM module is connected and if it is, measure capacity.",
+    "sdramtest","Test if the SDRAM module is connected and if it is, measure capacity",
     "=== Command syntax ===\n"
     "\n"
-    "   testsdram\n"
+    "   sdramtest\n"
     "\n"
     "=== Description ===\n"
     "\n"
     "This command tests SDRAM address space by writing and reading a\n"
-    "pattern. It detects valid SDRAM capacity.\n",
+    "pattern. It detects valid SDRAM capacity.\n"
+       "\n"
+       "=== Example ===\n"
+       "\n"
+       "   --> pindirHBREN:1\n"
+       "SDRAM installed: 64 MB\n"
+       "\n"
+       "Sets the HBR_EN pin as output\n",
     CMD_HANDLER(cmd_do_test_ram), (void *)&cmd_list_sdram
 };
 
 /** Command descriptor for test log to SDRAM */
 cmd_des_t const cmd_des_test_log={
     0, 0,
-    "testlog","Open command subprocessor for managing SDRAM logging.",
+    "sdramlogtest","Open command subprocessor for managing SDRAM logging",
     "=== Command syntax ===\n"
     "\n"
-    "   testlog\n"
+    "   sdramlogtest\n"
     "\n"
     "=== Description ===\n"
      "\n"
-     "Command opens subcommand processor, which contains testing commands\n"
+     "The cmmand opens a subcommand processor, which contains testing commands\n"
     "for logging into SDRAM\n",
     CMD_HANDLER(cmd_do_test_log), (void *)&cmd_list_sdram
 };
index 138db43ad717d8e13599ec97f26fe4ba149f6778..6d19bbdde657e6c225e09d8721574d2a3962918a 100644 (file)
@@ -193,22 +193,22 @@ int cmd_do_spimst(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 /** Command descriptor for SPI response translation */
 cmd_des_t const cmd_des_spi_translate={
        0, CDESM_OPCHR|CDESM_RW,
-       "spitr*","Translate response from SPI peripheral.",
+       "spitr*","Translate response from an SPI peripheral",
        "=== Command syntax ===\n"
        "\n"
-       "   spitrNAME?(CMD,RESP)\n"
+       "   spitr<NAME>?(<CMD>,<RESP>)\n"
        "where\n"
-       "* NAME is a string\n"
-       "* CMD is in range 0 - FFFFFFFF\n"
-       "* RESP is in range 0 - FFFFFFFF\n"
+       "* <NAME> is a string specifying the name of the peripheral\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 can translate response from SPI from many different\n"
+       "This command can translate response from SPI from many different\n"
        "peripherals into human readable form. Standard SPI response is in form\n"
-       "of few bytes, which are encoding the information. This commands takes\n"
-       "this response, last command which evoked this response, name of the\n"
-       "peripheral and translates the response to the form of atribute-value table.\n"
+       "of a hexadecimal number, which encodes the information. This commands takes\n"
+       "this response, last command which evoked this response, the name of the\n"
+       "peripheral and translates the response into the attribute-value table.\n"
        "\n"
        "=== Example ===\n"
        "\n"
@@ -222,20 +222,20 @@ cmd_des_t const cmd_des_spi_translate={
 /** Command descriptor for SPI trasfer */
 cmd_des_t const cmd_des_spimst = {
        0, CDESM_OPCHR,
-       "spimst#", "SPI master communication request.",
+       "spimst#", "SPI master communication request",
        "=== Command syntax ===\n"
        " \n"
-       "   spimstSPI:ADDR([DATA])\n"
+       "   spimst<SPI>:<ADDR>(<DATA>)\n"
        "where\n"
-       "* SPI is in range 0 - 3\n"
-       "* ADDR is in range 0 - 3\n"
-       "* DATA is in form XX,XX,XX... where XX is in range 00 - FF\n"
+       "* <SPI> is a number in range 0 - 3\n"
+       "* <ADDR> is a number in range 0 - 3\n"
+       "* <DATA> is a sequence of hexadecimal number, separated by colons. (12,AA,CD)\n"
        " \n"
        "=== Description ===\n"
        "\n"
        "This is master SPI transfer command.\n"
        "\n"
-       "Command sends given data to the peripheral on SPI and prints the\n"
+       "The command sends given data to the peripheral on SPI and prints the\n"
        "response.\n"
        "\n"
        "=== Example ===\n"
index 2332b4975a8693f81a9143a4cfebd9f2c4e7e1ae..52238b6aeeab61c4674d9e8349b5e595ada68bb8 100644 (file)
@@ -118,7 +118,7 @@ int cmd_do_power_off(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 /** Command descriptor for poweron */
 cmd_des_t const cmd_des_power_on = {
     0, 0,
-    "poweron","Set VBATEN and VBAT1EN using PWM.",
+    "poweron","Set VBATEN and VBAT1EN using PWM",
     "=== Command syntax ===\n"
     "\n"
     "   poweron\n"
@@ -139,7 +139,7 @@ cmd_des_t const cmd_des_power_on = {
 /** Command descriptor for poweroff */
 cmd_des_t const cmd_des_power_off = {
     0, 0,
-    "poweroff","Clear VBATEN and VBAT1EN.",
+    "poweroff","Clear VBATEN and VBAT1EN",
     "=== Command syntax ===\n"
     "\n"
     "   poweroff\n"