[python] Introduce python bindings

Author: kostorr

CMakeLists.txt

@@ -58,6 +58,18 @@ find_package(ReadoutCard REQUIRED)
 find_package(LLA REQUIRED)
 find_package(DIM REQUIRED)
 
+if(NOT APPLE)
+  find_package(Python3 3.6 COMPONENTS Interpreter Development)
+  if(Python3_FOUND)
+    set(boost_python_component "python${Python3_VERSION_MAJOR}${Python3_VERSION_MINOR}")
+  else()
+    # Backwards compatible. Can be removed once the Python3 recipe is stable
+    message(WARNING "Python 3 was not found: falling back to Python 2")
+    find_package(Python2 2.7 COMPONENTS Development REQUIRED)
+    set(boost_python_component "python27")
+  endif()
+endif()
+
 ####################################
 # Module, library and executable definition
 ####################################
@@ -75,6 +87,8 @@ target_sources(ALF PRIVATE
   src/DimServices/DimServices.cxx
   src/DimServices/ServiceNames.cxx
   src/Logger.cxx
+  $<$<BOOL:${Python2_FOUND}>:src/PythonInterface.cxx>
+  $<$<BOOL:${Python3_FOUND}>:src/PythonInterface.cxx>
 )
 
 target_include_directories(ALF
@@ -91,6 +105,10 @@ set(LINK_LIBS
     AliceO2::Common
     AliceO2::InfoLogger
     Boost::boost
+    $<$<BOOL:${Python2_FOUND}>:Boost::python27>
+    $<$<BOOL:${Python2_FOUND}>:Python2::Python>
+    $<$<BOOL:${Python3_FOUND}>:Boost::python${Python3_VERSION_MAJOR}${Python3_VERSION_MINOR}>
+    $<$<BOOL:${Python3_FOUND}>:Python3::Python>
 )
 
 # Link targets

include/Alf/Exception.h

@@ -31,6 +31,8 @@ struct SwtException : AliceO2::Common::Exception {
 };
 struct IcException : AliceO2::Common::Exception {
 };
+struct PythonException : AliceO2::Common::Exception {
+};
 
 namespace ErrorInfo
 {

include/Alf/Ic.h

@@ -74,10 +74,6 @@ class Ic
   /// \param gbtChannel The IC channel to set.
   void setChannel(int gbtChannel);
 
-  /// Checks if an IC channel is selected
-  /// \throws o2::alf::IcException if no IC channel selected
-  void checkChannelSet();
-
   /// Executes an SC reset
   void scReset();
 
@@ -133,8 +129,16 @@ class Ic
   ///         o2::lla::LlaException on lock fail
   std::string writeSequence(std::vector<std::pair<Operation, Data>> ops, bool lock = false);
 
+  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);
 

include/Alf/Sca.h

@@ -76,10 +76,6 @@ class Sca
   /// \param gbtChannel The channel to set
   void setChannel(int gbtChannel);
 
-  /// Checks if an SCA channel has been selected
-  /// \throws o2::alf::ScaException if no SCA channel selected
-  void checkChannelSet();
-
   /// Executes a global SC reset
   void scReset();
 
@@ -124,9 +120,16 @@ class Sca
   ///         o2::alf::ScaException on invalid operation or error
   std::string writeSequence(const std::vector<std::pair<Operation, Data>>& operations, bool lock = false);
 
+  static std::string ScaOperationToString(Operation op);
+  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);
 

include/Alf/Swt.h

@@ -80,10 +80,6 @@ class Swt
   /// \param gbtChannel The channel to set
   void setChannel(int gbtChannel);
 
-  /// Checks if an SWT channel has been selected
-  /// \throws o2::alf::SwtException if no SWT channel selected
-  void checkChannelSet();
-
   /// Executes an SC reset
   void scReset();
 
@@ -116,8 +112,18 @@ class Swt
   ///         o2::alf::SwtException on invalid operation or error
   std::string writeSequence(std::vector<std::pair<Operation, Data>> sequence, bool lock = false);
 
+  static std::string SwtOperationToString(Operation op);
+  static Operation StringToSwtOperation(std::string op);
+
+  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);
 
@@ -127,7 +133,6 @@ class Swt
   std::unique_ptr<LlaSession> mLlaSession;
 
   static constexpr int DEFAULT_SWT_WAIT_TIME_MS = 3;
-  static constexpr int DEFAULT_SWT_TIMEOUT_MS = 10;
 };
 
 } // namespace alf

include/Alf/SwtWord.h

@@ -50,6 +50,7 @@ class SwtWord
   void setMed(uint32_t med);
   void setHigh(uint16_t high);
   void setSize(Size size);
+  void setSize(std::string size);
   uint32_t getLow() const;
   uint32_t getMed() const;
   uint16_t getHigh() const;

src/Ic.cxx

@@ -277,5 +277,33 @@ std::string Ic::writeSequence(std::vector<std::pair<Operation, Data>> ops, bool
   return resultBuffer.str();
 }
 
+std::string Ic::IcOperationToString(Ic::Operation op) {
+  if (op == Ic::Operation::Read) {
+    return "read";
+  } else if (op == Ic::Operation::Write) {
+    return "write";
+  } else if (op == Ic::Operation::Error) {
+    return "error";
+  } else if (op == Ic::Operation::Lock) {
+    return "lock";
+  }
+
+  BOOST_THROW_EXCEPTION(IcException() << ErrorInfo::Message("Cannot convert Ic operation to string"));
+}
+
+Ic::Operation Ic::StringToIcOperation(std::string op) {
+  if (op == "read") {
+    return Ic::Operation::Read;
+  } else if (op == "write") {
+    return Ic::Operation::Write;
+  } else if (op == "error") {
+    return Ic::Operation::Error;
+  } else if (op == "lock") {
+    return Ic::Operation::Lock;
+  }
+
+  BOOST_THROW_EXCEPTION(IcException() << ErrorInfo::Message("Cannot convert IC operation to string " + op));
+}
+
 } // namespace alf
 } // namespace o2