[sc] Add SC base class

Author: kostorr

CMakeLists.txt

@@ -77,6 +77,7 @@ add_library(ALF SHARED
   src/Ic.cxx
   src/Lla.cxx
   src/Sca.cxx
+  src/ScBase.cxx
   src/Swt.cxx
   src/SwtWord.cxx
 )

apps/Alf.cxx

@@ -105,13 +105,13 @@ class Alf : public AliceO2::Common::Program
 
         Logger::get() << "CRU " << card.serialId << " registered" << LogInfoDevel << endm;
         bar = roc::ChannelFactory().getBar(card.serialId, 2);
-        for (int linkId = 0; linkId < CRU_NUM_LINKS; linkId++) {
+        for (int linkId = 0; linkId < kCruNumLinks; linkId++) {
           links.push_back({ alfId, card.serialId, linkId, card.serialId.getEndpoint() * 12 + linkId, bar, roc::CardType::Cru });
         }
 
       } else if (card.cardType == roc::CardType::Crorc) {
         Logger::get() << "CRORC " << card.serialId << " registered" << LogInfoDevel << endm;
-        for (int linkId = 0; linkId < CRORC_NUM_LINKS; linkId++) {
+        for (int linkId = 0; linkId < kCrorcNumLinks; linkId++) {
           bar = roc::ChannelFactory().getBar(card.serialId, linkId);
           links.push_back({ alfId, card.serialId, linkId, -1, bar, roc::CardType::Crorc });
         }

include/Alf/Common.h

@@ -28,8 +28,8 @@ namespace alf
 
 namespace roc = AliceO2::roc;
 
-static constexpr int CRU_NUM_LINKS(12);
-static constexpr int CRORC_NUM_LINKS(6);
+static constexpr int kCruNumLinks(12);
+static constexpr int kCrorcNumLinks(6);
 
 static constexpr auto BUSY_TIMEOUT = std::chrono::milliseconds(10);
 static constexpr auto CHANNEL_BUSY_TIMEOUT = std::chrono::milliseconds(10);

include/Alf/Exception.h

@@ -25,6 +25,8 @@ namespace alf
 
 struct AlfException : AliceO2::Common::Exception {
 };
+struct ScException : AliceO2::Common::Exception {
+};
 struct ScaException : AliceO2::Common::Exception {
 };
 struct SwtException : AliceO2::Common::Exception {

include/Alf/Ic.h

@@ -33,6 +33,7 @@
 
 #include "Common.h"
 #include "Alf/Lla.h"
+#include "Alf/ScBase.h"
 
 namespace roc = AliceO2::roc;
 
@@ -42,7 +43,7 @@ namespace alf
 {
 
 /// Class for IC Transactions with the CRU
-class Ic
+class Ic : public ScBase
 {
  public:
   /// Struct holding the IC address and data pair; useful to AlfServer
@@ -70,13 +71,6 @@ class Ic
   /// \param linkId The link ID for which to get the IC handle.
   Ic(std::string cardId, int linkId = -1);
 
-  /// Sets the IC channel
-  /// \param gbtChannel The IC channel to set.
-  void setChannel(int gbtChannel);
-
-  /// Executes an SC reset
-  void scReset();
-
   /// Performs an IC read
   /// \param address IC address to read from
   /// \return IC data requested
@@ -131,21 +125,6 @@ class Ic
 
   static std::string IcOperationToString(Operation op);
   static Ic::Operation StringToIcOperation(std::string op);
-
- private:
-  void init(const roc::Parameters::CardIdType& cardId, int linkId);
-
-  /// Checks if an IC channel is selected
-  /// \throws o2::alf::IcException if no IC channel selected
-  void checkChannelSet();
-
-  void barWrite(uint32_t offset, uint32_t data);
-  uint32_t barRead(uint32_t index);
-
-  std::shared_ptr<roc::BarInterface> mBar2;
-
-  AlfLink mLink;
-  std::unique_ptr<LlaSession> mLlaSession;
 };
 
 } // namespace alf

include/Alf/ScBase.h

@@ -0,0 +1,79 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \file ScBase.h
+/// \brief Definition of ALICE Lowlevel Frontend (ALF) SC base class
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef O2_ALF_INC_SCBASE_H
+#define O2_ALF_INC_SCBASE_H
+
+#include "ReadoutCard/BarInterface.h"
+#include "ReadoutCard/Parameters.h"
+
+#include "Common.h"
+#include "Alf/Lla.h"
+
+namespace roc = AliceO2::roc;
+
+namespace o2
+{
+namespace alf
+{
+
+/// Class for interfacing with the C-RORC's(?) and CRU's Slow-Control Adapter (SCA)
+class ScBase
+{
+ public:
+  /// Internal constructor for the AlfServer
+  /// \param link AlfLink holding useful information coming from the AlfServer class
+  ScBase(AlfLink link, std::shared_ptr<lla::Session> llaSession);
+
+  /// External constructor
+  /// \param cardId The card ID for which to get the SC handle.
+  /// \param linkId The link ID to set the channel to (optional).
+  ScBase(const roc::Parameters::CardIdType& cardId, int linkId = -1);
+
+  /// External constructor
+  /// \param cardId The card ID for which to get the SC handle.
+  /// \param linkId The link ID to set the channel to (optional).
+  ScBase(std::string cardId, int linkId = -1);
+
+  /// Sets the SC channel
+  /// \param gbtChannel The channel to set
+  void setChannel(int gbtChannel);
+
+  /// Executes a global SC reset
+  void scReset();
+
+    /// Checks if an SCA channel has been selected
+  /// \throws o2::alf::ScaException if no SCA channel selected
+  void checkChannelSet();
+
+ protected:
+  uint32_t barRead(uint32_t index);
+  void barWrite(uint32_t index, uint32_t data);
+
+  AlfLink mLink;
+  std::unique_ptr<LlaSession> mLlaSession;
+
+ private:
+  /// Does the necessary initializations after an object creating
+  void init(const roc::Parameters::CardIdType& cardId, int linkId);
+
+/// Interface for BAR 2
+  std::shared_ptr<roc::BarInterface> mBar2;
+};
+
+} // namespace alf
+} // namespace o2
+
+#endif // O2_ALF_INC_SCBASE_H

include/Alf/Sca.h

@@ -26,6 +26,7 @@
 
 #include "Common.h"
 #include "Alf/Lla.h"
+#include "Alf/ScBase.h"
 
 namespace roc = AliceO2::roc;
 
@@ -35,7 +36,7 @@ namespace alf
 {
 
 /// Class for interfacing with the C-RORC's(?) and CRU's Slow-Control Adapter (SCA)
-class Sca
+class Sca : public ScBase
 {
  public:
   /// Struct holding the command and data pair of an SCA command
@@ -72,13 +73,6 @@ class Sca
   /// \param linkId The link ID to set the channel to (optional).
   Sca(std::string cardId, int linkId = -1);
 
-  /// Sets the SCA channel
-  /// \param gbtChannel The channel to set
-  void setChannel(int gbtChannel);
-
-  /// Executes a global SC reset
-  void scReset();
-
   /// Executes an SCA reset
   void svlReset();
 
@@ -124,15 +118,6 @@ class Sca
   static Sca::Operation StringToScaOperation(std::string op);
 
  private:
-  void init(const roc::Parameters::CardIdType& cardId, int linkId);
-
-  /// Checks if an SCA channel has been selected
-  /// \throws o2::alf::ScaException if no SCA channel selected
-  void checkChannelSet();
-
-  uint32_t barRead(uint32_t index);
-  void barWrite(uint32_t index, uint32_t data);
-
   /// Performs an SCA read
   /// \return CommandData An SCA command, data pair
   /// \throws o2::alf::ScaException on SCA error
@@ -156,11 +141,6 @@ class Sca
   bool isChannelBusy(uint32_t command);
   void waitOnBusyClear();
 
-  /// Interface for BAR 2
-  std::shared_ptr<roc::BarInterface> mBar2;
-  AlfLink mLink;
-  std::unique_ptr<LlaSession> mLlaSession;
-
   static constexpr int DEFAULT_SCA_WAIT_TIME_MS = 3;
 };
 

include/Alf/Swt.h

@@ -33,9 +33,10 @@
 #include "ReadoutCard/BarInterface.h"
 #include "ReadoutCard/Parameters.h"
 
-#include "Alf/SwtWord.h"
 #include "Common.h"
 #include "Alf/Lla.h"
+#include "Alf/ScBase.h"
+#include "Alf/SwtWord.h"
 
 namespace roc = AliceO2::roc;
 
@@ -45,7 +46,7 @@ namespace alf
 {
 
 /// Class for Single Word Transactions with the CRU
-class Swt
+class Swt : public ScBase
 {
  public:
   typedef int TimeOut, WaitTime;
@@ -76,13 +77,6 @@ class Swt
   /// \param linkId The link ID to set the channel to (optional).
   Swt(std::string cardId, int linkId = -1);
 
-  /// Sets the SWT channel
-  /// \param gbtChannel The channel to set
-  void setChannel(int gbtChannel);
-
-  /// Executes an SC reset
-  void scReset();
-
   /// Writes an SWT word
   /// \param swtWord The SWT word to write
   /// \param wordSize The size of the SWT word to be written
@@ -118,20 +112,6 @@ class Swt
   static constexpr int DEFAULT_SWT_TIMEOUT_MS = 10;
 
  private:
-  void init(const roc::Parameters::CardIdType& cardId, int linkId);
-
-  /// Checks if an SWT channel has been selected
-  /// \throws o2::alf::SwtException if no SWT channel selected
-  void checkChannelSet();
-
-  void barWrite(uint32_t offset, uint32_t data);
-  uint32_t barRead(uint32_t index);
-
-  std::shared_ptr<roc::BarInterface> mBar2;
-
-  AlfLink mLink;
-  std::unique_ptr<LlaSession> mLlaSession;
-
   static constexpr int DEFAULT_SWT_WAIT_TIME_MS = 3;
 };