[diag] Move otPlatDiagModeGet() check to ProcessCmd

All diagnostic commands (instead of `diag start`) should fail if
device is not in diagnostic mode. Previously it was verified by
each command's process method (with a missing check in
`ProcessEcho` and `ProcessGpio`). This commit moves the check
directly to `ProcessCmd` and cleans up redundant code.

Additionally clean the documentation and align the code as for
some commands `status 0x00` was added on success and for some not.

Signed-off-by: Maciej Baczmanski <maciej.baczmanski@nordicsemi.no>

Author: maciejbaczmanski

src/core/diags/README.md

@@ -38,7 +38,7 @@ Start diagnostics mode.
 ```bash
 > diag start
 start diagnostics mode
-status 0x00
+Done
 ```
 
 ### diag channel
@@ -48,6 +48,7 @@ Get the IEEE 802.15.4 Channel value for diagnostics module.
 ```bash
 > diag channel
 channel: 11
+Done
 ```
 
 ### diag channel \<channel\>
@@ -57,7 +58,7 @@ Set the IEEE 802.15.4 Channel value for diagnostics module.
 ```bash
 > diag channel 11
 set channel to 11
-status 0x00
+Done
 ```
 
 ### diag cw start
@@ -123,6 +124,7 @@ Get the tx power value(dBm) for diagnostics module.
 ```bash
 > diag power
 tx power: -10 dBm
+Done
 ```
 
 ### diag power \<power\>
@@ -132,7 +134,7 @@ Set the tx power value(dBm) for diagnostics module.
 ```bash
 > diag power -10
 set tx power to -10 dBm
-status 0x00
+Done
 ```
 
 ### diag powersettings
@@ -173,7 +175,7 @@ Send the frame set by `diag frame` if length is omitted. Otherwise overwrite the
 ```bash
 > diag send 20 100
 sending 0x14 packet(s), length 0x64
-status 0x00
+Done
 ```
 
 ### diag repeat \<delay\> [length]
@@ -185,7 +187,7 @@ Send the frame set by `diag frame` if length is omitted. Otherwise overwrite the
 ```bash
 > diag repeat 100 100
 sending packets of length 0x64 at the delay of 0x64 ms
-status 0x00
+Done
 ```
 
 ### diag repeat stop
@@ -195,7 +197,7 @@ Stop repeated packet transmission.
 ```bash
 > diag repeat stop
 repeated packet transmission is stopped
-status 0x00
+Done
 ```
 
 ### diag radio sleep
@@ -205,7 +207,7 @@ Enter radio sleep mode.
 ```bash
 > diag radio sleep
 set radio from receive to sleep
-status 0x00
+Done
 ```
 
 ### diag radio receive
@@ -215,7 +217,7 @@ Set radio from sleep mode to receive mode.
 ```bash
 > diag radio receive
 set radio from sleep to receive on channel 11
-status 0x00
+Done
 ```
 
 ### diag radio receive \[async\] \<number\> \[lpr\]
@@ -245,6 +247,7 @@ Return the state of the radio.
 ```bash
 > diag radio state
 sleep
+Done
 ```
 
 ### diag radio enable
@@ -312,6 +315,7 @@ received packets: 10
 sent packets: 10
 first received packet: rssi=-65, lqi=101
 last received packet: rssi=-64, lqi=98
+Done
 ```
 
 ### diag stats clear
@@ -321,6 +325,7 @@ Clear statistics during diagnostics mode.
 ```bash
 > diag stats clear
 stats cleared
+Done
 ```
 
 ### diag gpio get \<gpio\>
@@ -384,7 +389,7 @@ first received packet: rssi=-65, lqi=101
 last received packet: rssi=-61, lqi=98
 
 stop diagnostics mode
-status 0x00
+Done
 ```
 
 ### diag rcp

src/core/diags/factory_diags.cpp

@@ -334,8 +334,6 @@ Error Diags::ProcessChannel(uint8_t aArgsLength, char *aArgs[])
 {
     Error error = kErrorNone;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
-
     if (aArgsLength == 0)
     {
         Output("channel: %d\r\n", mChannel);
@@ -351,7 +349,7 @@ Error Diags::ProcessChannel(uint8_t aArgsLength, char *aArgs[])
         IgnoreError(Get<Radio>().Receive(mChannel));
         otPlatDiagChannelSet(mChannel);
 
-        Output("set channel to %d\r\nstatus 0x%02x\r\n", mChannel, error);
+        Output("set channel to %d\r\n", mChannel);
     }
 
 exit:
@@ -363,8 +361,6 @@ Error Diags::ProcessPower(uint8_t aArgsLength, char *aArgs[])
 {
     Error error = kErrorNone;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
-
     if (aArgsLength == 0)
     {
         Output("tx power: %d dBm\r\n", mTxPower);
@@ -379,7 +375,7 @@ Error Diags::ProcessPower(uint8_t aArgsLength, char *aArgs[])
         SuccessOrExit(error = Get<Radio>().SetTransmitPower(mTxPower));
         otPlatDiagTxPowerSet(mTxPower);
 
-        Output("set tx power to %d dBm\r\nstatus 0x%02x\r\n", mTxPower, error);
+        Output("set tx power to %d dBm\r\n", mTxPower);
     }
 
 exit:
@@ -391,14 +387,13 @@ Error Diags::ProcessRepeat(uint8_t aArgsLength, char *aArgs[])
 {
     Error error = kErrorNone;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
     VerifyOrExit(aArgsLength > 0, error = kErrorInvalidArgs);
 
     if (StringMatch(aArgs[0], "stop"))
     {
         otPlatAlarmMilliStop(&GetInstance());
         mRepeatActive = false;
-        Output("repeated packet transmission is stopped\r\nstatus 0x%02x\r\n", error);
+        Output("repeated packet transmission is stopped\r\n");
     }
     else
     {
@@ -431,8 +426,8 @@ Error Diags::ProcessRepeat(uint8_t aArgsLength, char *aArgs[])
         mRepeatActive = true;
         uint32_t now  = otPlatAlarmMilliGetNow();
         otPlatAlarmMilliStartAt(&GetInstance(), now, mTxPeriod);
-        Output("sending packets of length %#x at the delay of %#x ms\r\nstatus 0x%02x\r\n", static_cast<int>(mTxLen),
-               static_cast<int>(mTxPeriod), error);
+        Output("sending packets of length %#x at the delay of %#x ms\r\n", static_cast<int>(mTxLen),
+               static_cast<int>(mTxPeriod));
     }
 
 exit:
@@ -446,7 +441,6 @@ Error Diags::ProcessSend(uint8_t aArgsLength, char *aArgs[])
     uint32_t txPackets;
     uint8_t  txLength;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
     VerifyOrExit(aArgsLength >= 1, error = kErrorInvalidArgs);
 
     SuccessOrExit(error = Utils::CmdLineParser::ParseAsUint32(aArgs[0], txPackets));
@@ -470,8 +464,7 @@ Error Diags::ProcessSend(uint8_t aArgsLength, char *aArgs[])
     VerifyOrExit(txLength >= OT_RADIO_FRAME_MIN_SIZE, error = kErrorInvalidArgs);
     mTxLen = txLength;
 
-    Output("sending %#x packet(s), length %#x\r\nstatus 0x%02x\r\n", static_cast<int>(mTxPackets),
-           static_cast<int>(mTxLen), error);
+    Output("sending %#x packet(s), length %#x\r\n", static_cast<int>(mTxPackets), static_cast<int>(mTxLen));
     TransmitPacket();
 
 exit:
@@ -501,7 +494,7 @@ Error Diags::ProcessStart(uint8_t aArgsLength, char *aArgs[])
     SuccessOrExit(error = Get<Radio>().SetTransmitPower(mTxPower));
     otPlatDiagModeSet(true);
     mStats.Clear();
-    Output("start diagnostics mode\r\nstatus 0x%02x\r\n", error);
+    Output("start diagnostics mode\r\n");
 
 exit:
     AppendErrorResult(error);
@@ -512,8 +505,6 @@ Error Diags::ProcessStats(uint8_t aArgsLength, char *aArgs[])
 {
     Error error = kErrorNone;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
-
     if ((aArgsLength == 1) && StringMatch(aArgs[0], "clear"))
     {
         mStats.Clear();
@@ -540,10 +531,6 @@ Error Diags::ProcessStop(uint8_t aArgsLength, char *aArgs[])
     OT_UNUSED_VARIABLE(aArgsLength);
     OT_UNUSED_VARIABLE(aArgs);
 
-    Error error = kErrorNone;
-
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
-
     otPlatAlarmMilliStop(&GetInstance());
     otPlatDiagModeSet(false);
     Get<Radio>().SetPromiscuous(false);
@@ -552,14 +539,12 @@ Error Diags::ProcessStop(uint8_t aArgsLength, char *aArgs[])
     Output("received packets: %d\r\nsent packets: %d\r\n"
            "first received packet: rssi=%d, lqi=%d\r\n"
            "last received packet: rssi=%d, lqi=%d\r\n"
-           "\nstop diagnostics mode\r\nstatus 0x%02x\r\n",
+           "\nstop diagnostics mode\r\n",
            static_cast<int>(mStats.mReceivedPackets), static_cast<int>(mStats.mSentPackets),
            static_cast<int>(mStats.mFirstRssi), static_cast<int>(mStats.mFirstLqi), static_cast<int>(mStats.mLastRssi),
-           static_cast<int>(mStats.mLastLqi), error);
+           static_cast<int>(mStats.mLastLqi));
 
-exit:
-    AppendErrorResult(error);
-    return error;
+    return kErrorNone;
 }
 
 void Diags::TransmitPacket(void)
@@ -635,13 +620,12 @@ Error Diags::ProcessRadio(uint8_t aArgsLength, char *aArgs[])
 {
     Error error = kErrorInvalidArgs;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
     VerifyOrExit(aArgsLength > 0, error = kErrorInvalidArgs);
 
     if (StringMatch(aArgs[0], "sleep"))
     {
         SuccessOrExit(error = Get<Radio>().Sleep());
-        Output("set radio from receive to sleep \r\nstatus 0x%02x\r\n", error);
+        Output("set radio from receive to sleep \r\n");
     }
     else if (StringMatch(aArgs[0], "receive"))
     {
@@ -653,7 +637,7 @@ Error Diags::ProcessRadio(uint8_t aArgsLength, char *aArgs[])
         if (aArgsLength == 0)
         {
             SuccessOrExit(error = RadioReceive());
-            Output("set radio from sleep to receive on channel %d\r\nstatus 0x%02x\r\n", mChannel, error);
+            Output("set radio from sleep to receive on channel %d\r\n", mChannel);
             ExitNow();
         }
 
@@ -840,7 +824,6 @@ Error Diags::ProcessContinuousWave(uint8_t aArgsLength, char *aArgs[])
 {
     Error error = kErrorInvalidArgs;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
     VerifyOrExit(aArgsLength > 0, error = kErrorInvalidArgs);
 
     if (StringMatch(aArgs[0], "start"))
@@ -861,7 +844,6 @@ Error Diags::ProcessStream(uint8_t aArgsLength, char *aArgs[])
 {
     Error error = kErrorInvalidArgs;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
     VerifyOrExit(aArgsLength > 0, error = kErrorInvalidArgs);
 
     if (StringMatch(aArgs[0], "start"))
@@ -892,8 +874,6 @@ Error Diags::ProcessPowerSettings(uint8_t aArgsLength, char *aArgs[])
     uint8_t       channel;
     PowerSettings powerSettings;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
-
     if (aArgsLength == 0)
     {
         bool          isPrePowerSettingsValid = false;
@@ -951,8 +931,6 @@ Error Diags::ProcessRawPowerSetting(uint8_t aArgsLength, char *aArgs[])
     Error           error = kErrorInvalidArgs;
     RawPowerSetting setting;
 
-    VerifyOrExit(otPlatDiagModeGet(), error = kErrorInvalidState);
-
     if (aArgsLength == 0)
     {
         SuccessOrExit(error = GetRawPowerSetting(setting));
@@ -1112,6 +1090,12 @@ Error Diags::ProcessCmd(uint8_t aArgsLength, char *aArgs[])
         ExitNow();
     }
 
+    if (!otPlatDiagModeGet() && !StringMatch(aArgs[0], "start"))
+    {
+        Output("diagnostics mode is disabled\r\n");
+        ExitNow(error = kErrorInvalidState);
+    }
+
     for (const Command &command : sCommands)
     {
         if (StringMatch(aArgs[0], command.mName))