[sca] Add reset & connect commands

Author: kostorr

README.md

@@ -80,10 +80,16 @@ The services are DIM RPC services. Every RPC is called with a string and expects
     * Operations may be:
     * An SCA command and data pair (e.g. `0x0000f00d,0x0000cafe`)
     * A wait operation (e.g. `30,wait`) in ms, defaults to 3
+    * An SCA connect operation (e.g. `connect`)
+    * An SCA reset operation (e.g. `reset`)
     * An instruction to execute the sequence atomically (`lock` - needs to lead the sequence)
 * Returns:
-  * Sequence of SCA command and SCA read pairs, and wait confirmations
-  * No entries for `lock` directives
+  * Sequence of SCA output as follows: 
+    * SCA command and SCA read pairs
+    * Wait confirmations with time waited
+    * Connect confirmations made up of a "connect" string
+    * No entries for `reset` directives
+    * No entries for `lock` directives
 
 * Example:
   * DIM input: `0x00000010,0x00000011\n3\n0x000000020,0x00000021`
@@ -227,12 +233,12 @@ typedef int TimeOut;
 
 /// Typedef for the Data type of an SWT sequence operation.
 /// Variant of TimeOut for reads, SwtWord for writes, std::string for Errors
-typedef boost::variant<boost::blank, TimeOut, SwtWord, std::string> Data;
+typedef boost::variant<boost::blank, TimeOut, WaitTime, SwtWord, std::string> Data;
 
 /// Enum for the different SWT operation types
 enum Operation { Read,
                  Write,
-                 WaitTime,
+                 Wait,
                  Reset,
                  Error };
                  

apps/AlfClient.cxx

@@ -189,7 +189,9 @@ class AlfClient : public AliceO2::Common::Program
     }
 
     if (mOptions.sca) {
-      auto scaOut = scaSequence.write({ std::make_pair("1000", "wait"),
+      auto scaOut = scaSequence.write({ std::make_pair("", "reset"),
+                                        std::make_pair("", "connect"),
+                                        std::make_pair("1000", "wait"),
                                         std::make_pair("0x00010002", "0xff000000"),
                                         std::make_pair("0x00020004", "0xff000000"),
                                         std::make_pair("0x00030006", "0xff000000"),

apps/AlfLibClient.cxx

@@ -68,8 +68,9 @@ class AlfLibClient : public AliceO2::Common::Program
       auto sca = Sca(roc::SerialId{ mOptions.serial, mOptions.endpoint }, mOptions.link);
       sca.reset();
 
-      std::cout << "Running simple SCA operation" << std::endl;
+      std::cout << "Running simple SCA operations" << std::endl;
       try {
+        sca.connect();
         auto scaOut = sca.executeCommand({ 0x00010002, 0xff000000 });
         std::cout << scaOut.command << " " << scaOut.data << std::endl;
       } catch (const ScaException& e) {
@@ -79,6 +80,8 @@ class AlfLibClient : public AliceO2::Common::Program
       std::cout << "Running an SCA sequence" << std::endl;
       std::vector<std::pair<Sca::Operation, Sca::Data>> ops;
       sca.setChannel(1);
+      ops.push_back({ Sca::Operation::Reset , {} });
+      ops.push_back({ Sca::Operation::Connect, {} });
       ops.push_back({ Sca::Operation::Command, Sca::CommandData{ 0x00100002, 0xff000000 } });
       ops.push_back({ Sca::Operation::Command, Sca::CommandData{ 0x00100003, 0xff000000 } });
       ops.push_back({ Sca::Operation::Wait, 100 });
@@ -89,6 +92,10 @@ class AlfLibClient : public AliceO2::Common::Program
           std::cout << "Command: " << boost::get<Sca::CommandData>(out.second) << std::endl;
         } else if (out.first == Sca::Operation::Wait) {
           std::cout << "Wait: " << std::dec << boost::get<Sca::WaitTime>(out.second) << std::endl;
+        } else if (out.first == Sca::Operation::Reset) {
+          std::cout << "Reset" << std::endl;
+        } else if (out.first == Sca::Operation::Connect) {
+          std::cout << "Connect " << std::endl;
         } else if (out.first == Sca::Operation::Error) {
           std::cout << "Error: " << boost::get<std::string>(out.second) << std::endl;
         } else {

include/Alf/Sca.h

@@ -52,6 +52,8 @@ class Sca
   /// Enum for the different SCA operation types as seen from DIM RPCs
   enum Operation { Command,
                    Wait,
+                   Reset,
+                   Connect,
                    Error,
                    Lock };
 
@@ -77,9 +79,12 @@ class Sca
   /// \throws o2::alf::ScaException if no SCA channel selected
   void checkChannelSet();
 
-  /// Executes an SC reset
+  /// Executes an SCA reset
   void reset();
 
+  /// Executes an SCA connect
+  void connect();
+
   /// Executes an SCA command
   /// \param commandData SCA command, data pair
   /// \param lock Boolean enabling implicit locking

src/AlfServer.cxx

@@ -296,6 +296,18 @@ std::pair<Sca::Operation, Sca::Data> AlfServer::stringToScaPair(const std::strin
     } catch (const std::exception& e) {
       BOOST_THROW_EXCEPTION(SwtException() << ErrorInfo::Message("SCA Wait Time provided cannot be converted to int"));
     }
+  } else if (scaPair[scaPair.size() - 1] == "reset") {
+    operation = Sca::Operation::Reset;
+    if (scaPair.size() != 1) {
+      BOOST_THROW_EXCEPTION(
+        AlfException() << ErrorInfo::Message("Too many arguments for RESET operation"));
+    }
+  } else if (scaPair[scaPair.size() - 1] == "connect") {
+    operation = Sca::Operation::Connect;
+    if (scaPair.size() != 1) {
+      BOOST_THROW_EXCEPTION(
+        AlfException() << ErrorInfo::Message("Too many arguments for CONNECT operation"));
+    }
   } else { // regular sca command
     operation = Sca::Operation::Command;
     if (scaPair.size() != 2) {

src/Sca.cxx

@@ -98,8 +98,18 @@ void Sca::checkChannelSet()
 
 void Sca::reset()
 {
-  barWrite(sc_regs::SC_RESET.index, 0x1);
-  barWrite(sc_regs::SC_RESET.index, 0x0);
+  barWrite(sc_regs::SCA_WR_CTRL.index, 0x1);
+  barWrite(sc_regs::SCA_WR_CTRL.index, 0x0);
+  /* DO I NEED THIS?
+  waitOnBusyClear(); */
+}
+
+void Sca::connect()
+{
+  barWrite(sc_regs::SCA_WR_CTRL.index, 0x2);
+  barWrite(sc_regs::SCA_WR_CTRL.index, 0x0);
+  /* DO I NEED THIS?
+  waitOnBusyClear(); */
 }
 
 Sca::CommandData Sca::executeCommand(uint32_t command, uint32_t data, bool lock)
@@ -286,6 +296,12 @@ std::vector<std::pair<Sca::Operation, Sca::Data>> Sca::executeSequence(const std
         }
         std::this_thread::sleep_for(std::chrono::milliseconds(waitTime));
         ret.push_back({ operation, waitTime });
+      } else if (operation == Operation::Reset) {
+        reset();
+        ret.push_back({ Operation::Reset, {} });
+      } else if (operation == Operation::Connect) {
+        connect();
+        ret.push_back({ Operation::Connect, {} });
       } else {
         BOOST_THROW_EXCEPTION(ScaException() << ErrorInfo::Message("SCA operation type unknown"));
       }
@@ -297,6 +313,10 @@ std::vector<std::pair<Sca::Operation, Sca::Data>> Sca::executeSequence(const std
         meaningfulMessage = (boost::format("SCA_SEQUENCE cmd=0x%08x data=0x%08x serialId=%s link=%d error='%s'") % boost::get<CommandData>(data).command % boost::get<CommandData>(data).data % mLink.serialId % mLink.linkId % e.what()).str();
       } else if (operation == Operation::Wait) {
         meaningfulMessage = (boost::format("SCA_SEQUENCE WAIT waitTime=%d serialId=%s link=%d error='%s'") % boost::get<WaitTime>(data) % mLink.serialId % mLink.linkId % e.what()).str();
+      } else if (operation == Operation::Reset) {
+        meaningfulMessage = (boost::format("SCA_SEQUENCE RESET serialId=%s link=%d error='%s'") % mLink.serialId % mLink.linkId % e.what()).str();
+      } else if (operation == Operation::Connect) {
+        meaningfulMessage = (boost::format("SCA_SEQUENCE CONNECT serialId=%s link=%d error='%s'") % mLink.serialId % mLink.linkId % e.what()).str();
       } else {
         meaningfulMessage = (boost::format("SCA_SEQUENCE UNKNOWN serialId=%s link=%d error='%s'") % mLink.serialId % mLink.linkId % e.what()).str();
       }
@@ -325,6 +345,10 @@ std::string Sca::writeSequence(const std::vector<std::pair<Operation, Data>>& op
       resultBuffer << data << "\n"; // "[cmd],[data]\n"
     } else if (operation == Operation::Wait) {
       resultBuffer << std::dec << data << "\n"; // "[time]\n"
+    } else if (operation == Operation::Reset) {
+      /* DO NOTHING */
+    } else if (operation == Operation::Connect) {
+      resultBuffer << "connect\n"; // echo
     } else if (operation == Operation::Error) {
       resultBuffer << data; // "[error_msg]"
       Logger::get().err() << data << endm;