Merge pull request #996 from slaclab/pre-release

Release Candidate v6.2.0

.clang-format

@@ -15,6 +15,7 @@ AlignConsecutiveAssignments: true
 AlignConsecutiveMacros: true
 AccessModifierOffset: -2
 SortIncludes: true
+IndentPPDirectives: BeforeHash
 IncludeBlocks: Regroup
 IncludeCategories:
     # Rogue Directives.h goes first

docs/src/installing/petalinux.rst

@@ -18,9 +18,9 @@ You will want to replace the file project-spec/meta-user/recipes-apps/rogue/rogu
 
 .. code::
 
-   ROGUE_VERSION = "6.1.3"
-   ROGUE_MD5SUM  = "1df912b8525c01930bb869c3a2b2e7e3"
-   
+   ROGUE_VERSION = "6.1.4"
+   ROGUE_MD5SUM  = "659c7f5c894f6915e2bd15f922cdab3b"
+
    SUMMARY = "Recipe to build Rogue"
    HOMEPAGE ="https://github.com/slaclab/rogue"
    LICENSE = "MIT"
@@ -33,8 +33,7 @@ You will want to replace the file project-spec/meta-user/recipes-apps/rogue/rogu
    PROVIDES = "rogue"
    EXTRA_OECMAKE += "-DROGUE_INSTALL=system -DROGUE_VERSION=v${ROGUE_VERSION}"
 
-   # Note: distutils3 is depreciated (not removed) in petalinux 2023.2 and need to switch to setuptools3 in petalinux 2024 release
-   inherit cmake python3native distutils3
+   inherit cmake python3native setuptools3
 
    DEPENDS += " \
       python3 \
@@ -78,6 +77,12 @@ You will want to replace the file project-spec/meta-user/recipes-apps/rogue/rogu
       cmake_do_install
    }
 
+   do_install:append() {
+      # Ensure the target directory exists
+      install -d ${D}${PYTHON_SITEPACKAGES_DIR}
+      # Install the rogue.so file into the Python site-packages directory
+      install -m 0755 ${S}/python/rogue.so ${D}${PYTHON_SITEPACKAGES_DIR}
+   }
 
 Update the ROGUE_VERSION line for an updated version when appropriate (min version is 6.1.3). You will need to first download the tar.gz file and compute the MD5SUM using the following commands if you update the ROGUE_VERSION line:
 

docs/src/migration/rogue_v6.rst

@@ -126,3 +126,30 @@ The reasoning is that a lot happens behind the scences when changing a
 poll interval, and masking this with a setter decorator gives the user
 the impression that it is much simpler than it is.
 
+Previously Deprecated Legacy GUI has Been Removed
+=================================================
+
+The legacy GUI has been removed. You can no longer use the following
+code to launch a generic tree GUI.
+
+.. code::
+   
+   import pyrogue.gui
+
+   with Root(...) as root:
+       appTop = pyrogue.gui.application(sys.argv)
+       guiTop = pyrogue.gui.GuiTop()
+       guiTop.addTree(root)
+       guiTop.resize(800, 800)
+       appTop.exec_()
+
+Instead, use the new PyDM GUI
+
+.. code::
+   
+   import pyrogue.pydm
+
+   with Root(...) as root:
+       pyrogue.pydm.runPyDM(
+           serverList=root.zmqServer.address,
+           title='GUI Window Title')

include/rogue/Directives.h

@@ -27,7 +27,7 @@
 #define CRCPP_USE_CPP11
 
 #ifndef __STDC_FORMAT_MACROS
-#define __STDC_FORMAT_MACROS
+    #define __STDC_FORMAT_MACROS
 #endif
 
 #endif

include/rogue/GeneralError.h

@@ -28,7 +28,7 @@
 #include <string>
 
 #ifndef NO_PYTHON
-#include <boost/python.hpp>
+    #include <boost/python.hpp>
 #endif
 
 namespace rogue {

include/rogue/GilRelease.h

@@ -23,7 +23,7 @@
 
 #include <stdint.h>
 #ifndef NO_PYTHON
-#include <boost/python.hpp>
+    #include <boost/python.hpp>
 #endif
 
 namespace rogue {

include/rogue/ScopedGil.h

@@ -22,7 +22,7 @@
 
 #include "rogue/Directives.h"
 #ifndef NO_PYTHON
-#include <boost/python.hpp>
+    #include <boost/python.hpp>
 #endif
 
 namespace rogue {

include/rogue/hardware/axi/AxiStreamDma.h

@@ -199,6 +199,45 @@ class AxiStreamDma : public rogue::interfaces::stream::Master, public rogue::int
 
     // Process Buffer Return
     void retBuffer(uint8_t* data, uint32_t meta, uint32_t rawSize);
+
+    //! Get the size of buffers (RX/TX)
+    uint32_t getBuffSize();
+
+    //! Get the number of RX buffers
+    uint32_t getRxBuffCount();
+
+    //! Get RX buffer in User count
+    uint32_t getRxBuffinUserCount();
+
+    //! Get RX buffer in HW count
+    uint32_t getRxBuffinHwCount();
+
+    //! Get RX buffer in Pre-HW Queue count
+    uint32_t getRxBuffinPreHwQCount();
+
+    //! Get RX buffer in SW Queue count
+    uint32_t getRxBuffinSwQCount();
+
+    //! Get RX buffer missing count
+    uint32_t getRxBuffMissCount();
+
+    //! Get the number of TX buffers
+    uint32_t getTxBuffCount();
+
+    //! Get TX buffer in User count
+    uint32_t getTxBuffinUserCount();
+
+    //! Get TX buffer in HW count
+    uint32_t getTxBuffinHwCount();
+
+    //! Get TX buffer in Pre-HW Queue count
+    uint32_t getTxBuffinPreHwQCount();
+
+    //! Get TX buffer in SW Queue count
+    uint32_t getTxBuffinSwQCount();
+
+    //! Get TX buffer missing count
+    uint32_t getTxBuffMissCount();
 };
 
 //! Alias for using shared pointer as AxiStreamDmaPtr

include/rogue/hardware/drivers/AxisDriver.h

@@ -25,8 +25,8 @@
 #include "DmaDriver.h"
 
 // Command definitions
-#define AXIS_Read_Ack 0x2001          // Command to acknowledge read
-#define AXIS_Write_ReqMissed 0x2002   // Command to indicate a missed write request
+#define AXIS_Read_Ack        0x2001  // Command to acknowledge read
+#define AXIS_Write_ReqMissed 0x2002  // Command to indicate a missed write request
 
 // Only define the following if not compiling for kernel space
 #ifndef DMA_IN_KERNEL
@@ -41,14 +41,14 @@
  * @return The combined flags value.
  */
 static inline uint32_t axisSetFlags(uint32_t fuser, uint32_t luser, uint32_t cont) {
-   uint32_t flags;
+    uint32_t flags;
 
-   // Set flags based on input parameters, ensuring each is in its correct position
-   flags  = fuser & 0xFF;            // First user-defined flag
-   flags |= (luser << 8) & 0xFF00;   // Last user-defined flag
-   flags |= (cont  << 16) & 0x10000; // Continuation flag
+    // Set flags based on input parameters, ensuring each is in its correct position
+    flags = fuser & 0xFF;             // First user-defined flag
+    flags |= (luser << 8) & 0xFF00;   // Last user-defined flag
+    flags |= (cont << 16) & 0x10000;  // Continuation flag
 
-   return flags;
+    return flags;
 }
 
 /**
@@ -59,7 +59,7 @@ static inline uint32_t axisSetFlags(uint32_t fuser, uint32_t luser, uint32_t con
  * @return The first user-defined flag.
  */
 static inline uint32_t axisGetFuser(uint32_t flags) {
-   return flags & 0xFF;
+    return flags & 0xFF;
 }
 
 /**
@@ -70,7 +70,7 @@ static inline uint32_t axisGetFuser(uint32_t flags) {
  * @return The last user-defined flag.
  */
 static inline uint32_t axisGetLuser(uint32_t flags) {
-   return (flags >> 8) & 0xFF;
+    return (flags >> 8) & 0xFF;
 }
 
 /**
@@ -81,7 +81,7 @@ static inline uint32_t axisGetLuser(uint32_t flags) {
  * @return The continuation flag.
  */
 static inline uint32_t axisGetCont(uint32_t flags) {
-   return (flags >> 16) & 0x1;
+    return (flags >> 16) & 0x1;
 }
 
 /**
@@ -90,7 +90,7 @@ static inline uint32_t axisGetCont(uint32_t flags) {
  * @param fd File descriptor for the AXIS device.
  */
 static inline void axisReadAck(int32_t fd) {
-   ioctl(fd, AXIS_Read_Ack, 0);
+    ioctl(fd, AXIS_Read_Ack, 0);
 }
 
 /**
@@ -99,8 +99,8 @@ static inline void axisReadAck(int32_t fd) {
  * @param fd File descriptor for the AXIS device.
  */
 static inline void axisWriteReqMissed(int32_t fd) {
-   ioctl(fd, AXIS_Write_ReqMissed, 0);
+    ioctl(fd, AXIS_Write_ReqMissed, 0);
 }
 
-#endif // !DMA_IN_KERNEL
-#endif // __ASIS_DRIVER_H__
+#endif  // !DMA_IN_KERNEL
+#endif  // __ASIS_DRIVER_H__