ALF: Added partial return sequence for SCA_WRITE_SEQUENCE

Author: PascalBoeschoten

src/CommandLineUtilities/AliceLowlevelFrontend/AlfException.h

@@ -13,8 +13,8 @@ namespace roc {
 namespace CommandLineUtilities {
 namespace Alf {
 
-//// RORC exception definitions
 struct AlfException : AliceO2::Common::Exception {};
+struct ScaException : AliceO2::Common::Exception {};
 
 namespace ErrorInfo
 {

src/CommandLineUtilities/AliceLowlevelFrontend/ProgramAliceLowlevelFrontendServer.cxx

@@ -397,19 +397,28 @@ class ProgramAliceLowlevelFrontendServer: public AliceO2::Common::Program
       boost::char_separator<char> sep(";", "", boost::drop_empty_tokens); // Drop ";" delimiters, keep none
       std::stringstream resultBuffer;
       auto sca = Sca(*bar2, bar2->getCardType());
+
       for (std::string token : tokenizer(parameter, sep)) {
         // Walk through the tokens, these should be the pairs. The pairs are comma-separated, so we split those.
         std::vector<std::string> pair = split(token, ",");
         if (pair.size() != 2) {
-          BOOST_THROW_EXCEPTION(AlfException() << ErrorInfo::Message("SCA command-data pair not formatted correctly"));
+          BOOST_THROW_EXCEPTION(
+            AlfException() << ErrorInfo::Message("SCA command-data pair not formatted correctly"));
         }
         auto command = convertHexString(pair[0]);
         auto data = convertHexString(pair[1]);
-        sca.write(command, data);
-        auto result = sca.read();
-        getInfoLogger() << (b::format("cmd=0x%x data=0x%x result=0x%x") % command % data % result.data).str() << endm;
-        resultBuffer << std::hex << result.data << ';';
+        try {
+          sca.write(command, data);
+          auto result = sca.read();
+          getInfoLogger() << (b::format("cmd=0x%x data=0x%x result=0x%x") % command % data % result.data).str() << endm;
+          resultBuffer << std::hex << result.data << ';';
+        } catch (const ScaException& e) {
+          // If an SCA error occurs, we stop executing the sequence of commands and return the results as far as we got
+          // them
+          break;
+        }
       }
+
       auto result = resultBuffer.str();
       if (result.size() > 0) {
         result.pop_back(); // Pop the last ';'

src/CommandLineUtilities/AliceLowlevelFrontend/README.md

@@ -72,6 +72,8 @@ Write a sequence of values to the SCA
     ~~~
     42;123;555
     ~~~
+    If an SCA error occurred, the sequence of return values will go up to that point.
+    If another type of error occurred (such as a formatting error), it will return a failure string. 
     
 
 #### SCA GPIO read

src/CommandLineUtilities/AliceLowlevelFrontend/Sca.cxx

@@ -100,7 +100,7 @@ void Sca::checkError(uint32_t command)
 
   for (int flag = 0; flag < 7; ++flag) {
     if (Utilities::getBit(command & 0xff, flag) == 1) {
-      BOOST_THROW_EXCEPTION(AlfException() << ErrorInfo::Message(toString(flag)));
+      BOOST_THROW_EXCEPTION(ScaException() << ErrorInfo::Message(toString(flag)));
     }
   }
 }
@@ -169,7 +169,7 @@ void Sca::waitOnBusyClear()
       return;
     }
   }
-  BOOST_THROW_EXCEPTION(AlfException() << ErrorInfo::Message("Exceeded timeout on busy wait"));
+  BOOST_THROW_EXCEPTION(ScaException() << ErrorInfo::Message("Exceeded timeout on busy wait"));
 }