Merge branch 'main' into user-guide-ToC

Author: MustafaAbdaal

.github/workflows/rpe_test.yml

@@ -93,10 +93,11 @@ jobs:
         if: ${{ matrix.os != 'ubuntu-22.04' }}
         run: npm test
 
-      - name: E2E Playwright tests on Linux latest & MacOS
+      - name: E2E Playwright tests on Linux latest
         if: ${{ matrix.os == 'ubuntu-latest' }}     
         run: |
-            cp -rf Raptor/etc backend
+            cp -rvf Raptor/etc backend
+            ls -l backend/etc/device.xml
             npm run compile && xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- npx playwright test
 
       - name: cat RPE log

README.md

@@ -4,6 +4,8 @@
 
 # Rapid Power Estimator
 
+![RPE Logo](imgs/rpelogo.png)
+
 Rapid Power Estimation Tool allows you to estimate power consumption at various stages of your design cycle. It simplifies the input of design information through intuitive wizards and delivers comprehensive power and thermal data analysis.
 
 ## Pre-requisite

backend/restapi_server.py

@@ -4,6 +4,7 @@
 #
 import argparse
 import os
+import signal
 import sys
 from flask import Flask, request, jsonify
 from flasgger import Swagger
@@ -34,7 +35,7 @@ def main():
     args = parser.parse_args()
 
     # setup app logger
-    log_setup(filename=args.logfile, max_bytes=args.maxbytes*1024, backup_count=args.backupcount)
+    log_setup(filename=args.logfile, max_bytes=args.maxbytes * 1024, backup_count=args.backupcount)
 
     # Check if the device_file exists
     if os.path.exists(args.device_file) == False:
@@ -54,7 +55,7 @@ def main():
         "swagger": "2.0",
         "info": {
             "title": "RPE Backend API",
-            "description": "The RPE Backend APIs which consumed by the RPE frontend for power and thermal estimation of the Rapid Silicon devices.",
+            "description": "The RPE Backend APIs which are consumed by the RPE frontend for power and thermal estimation of the Rapid Silicon devices.",
             "version": "0.1.0"
         }
     }
@@ -81,6 +82,25 @@ def after_request(response):
         log(f"{request.method} {request.url} {response.status_code} - DONE")
         return response
 
+    # Graceful shutdown function
+    def shutdown_server():
+        log("Shutting down server...")
+        func = request.environ.get('werkzeug.server.shutdown')
+        if func is not None:
+            func()
+        else:
+            log("Server shutdown function not found.", RsLogLevel.ERROR)
+
+    # Signal handler for smooth shutdown
+    def signal_handler(signal_received, frame):
+        log(f"Signal {signal_received} received, initiating shutdown...")
+        shutdown_server()
+        sys.exit(0)
+
+    # Register the signal handler for SIGINT (Ctrl+C) and SIGTERM
+    signal.signal(signal.SIGINT, signal_handler)
+    signal.signal(signal.SIGTERM, signal_handler)
+
     # log app server started
     log("App server is running...")
 

backend/submodule/peripherals.py

@@ -70,10 +70,15 @@ class GpioStandard(RsEnum):
     SSTL_3_3V_Class_I     = 10, "SSTL 3.3V Class-I"
     SSTL_3_3V_Class_II    = 11, "SSTL 3.3V Class-II"
 
+#class N22_RISC_V_Clock(RsEnum):
+#    PLL_233MHz       = 0, "PLL (233 MHz)"
+#    BOOT_Clock_40MHz = 1, "BOOT CLK (40 MHz)"
+#    RC_OSC_50MHz     = 2, "RC OSC (50 MHz)"
+
 class N22_RISC_V_Clock(RsEnum):
-    PLL_233MHz       = 0, "PLL (233 MHz)"
-    BOOT_Clock_40MHz = 1, "BOOT CLK (40 MHz)"
-    RC_OSC_50MHz     = 2, "RC OSC (50 MHz)"
+    PLL_233MHz       = 0, "PLL"
+    BOOT_Clock_40MHz = 1, "BOOT CLK"
+    RC_OSC_50MHz     = 2, "RC OSC"    
 
 class Port_Activity(RsEnum):
     IDLE   = 0, "Idle"

cleanup.js

@@ -1,12 +1,36 @@
-const isWindows = process.platform === 'win32';
+const os = require('os');
+const platform = os.platform();
 
 const kill = (process) => {
-  if (isWindows) {
-    const kill = require('tree-kill');
-    kill(process.pid);
-  } else {
-    process.kill('SIGINT');
-  }
+    console.log(`Attempting to kill process with PID: ${process.pid}`);
+    const { spawn } = require('child_process');
+    if (platform === 'win32') {
+        // used taskkill for Windows to terminate the process tree
+        const taskKill = spawn('taskkill', ['/PID', process.pid, '/T', '/F']);
+        taskKill.on('close', (code) => {
+            if (code === 0) {
+                console.log('Process killed successfully on Windows.');
+            } else {
+                console.error(`taskkill failed with exit code: ${code}`);
+            }
+        });
+    } else if (platform === 'darwin' || platform === 'linux') {
+        const taskKill = spawn('kill', ['-9', process.pid]);
+        taskKill.on('close', (code) => {
+            if (code === 0) {
+                console.log('Process killed successfully on Unix.');
+            } else {
+                console.error(`taskkill failed with exit code: ${code}`);
+            }
+        });
+    } else {
+        try {
+            process.kill('SIGINT');
+            console.log('SIGINT sent to process');
+        } catch (error) {
+            console.error(`Failed to send SIGINT: ${error.message}`);
+        }
+    }
 };
 
 module.exports = { kill };

docs/source/user_guide/FPGA_index.rst

@@ -14,6 +14,7 @@ Clocking
 The clocking section is located on the top left of the FPGA input section.
 
 .. image:: figures/FPGA-figures-clocking-clocking_selected.JPG
+
 Selecting the clocking section will display an empty table at the botton of the screen, click the "+Add" button above the table to fill out clock information.
 
 .. image:: figures/FPGA-figures-clocking-input_clock_info.JPG
@@ -132,4 +133,5 @@ Selecting the IO section displays an empty table, click the "Add" button above t
 12. Enter input enable rate - default is **50%** for inputs
 13. Enter output enable rate - default is **50%** for outputs 
 14. select synchronization option - default is **none** for signals that are already clocked and don't cross domains
-15. Enter toggle rate - Industry standard default is **12.5%**
+15. Enter toggle rate - Industry standard default is **12.5%**
+

imgs/rpeicon.png

@@ -10,6 +10,7 @@ const log = require('electron-log');
 const config = require('./rpe.config.json');
 const { kill } = require('./cleanup');
 const { openProjectRequest, saveProjectRequest } = require('./projectFile');
+const now = new Date(); 
 
 const logFormat = '[{h}:{i}:{s}.{ms}] [{level}] {text}';
 log.transports.console.format = logFormat;
@@ -154,6 +155,13 @@ if (!isDev) {
   });
   log.transports.console.level = false; // silent console
 }
+
+console.log(`
+  =================================================
+    RPE - Session Start at ${now.toLocaleString()} 
+  =================================================
+  `);  
+
 const template = [
   {
     label: 'File',
@@ -212,19 +220,36 @@ const template = [
     label: 'Help',
     submenu: [
       {
+        label: 'User Guide',
         role: 'help',
         click: async () => {
-          await shell.openExternal('https://github.com/os-fpga/rapid_power_estimator/blob/main/README.md');
+          await shell.openExternal('https://rapidpowerestimator.readthedocs.io/en/latest/');
+        },
+      },
+      {
+        label: 'About',
+        click: () => {
+          // dynamically reading package.json
+          const packagePath = path.join(__dirname, 'package.json');
+          const packageData = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
+      
+          const message = `${packageData.build.productName}\nVersion: ${packageData.version}\nAuthor: ${packageData.author}\nCopyright: ${packageData.build.copyright}`;
+      
+          dialog.showMessageBox(mainWindow, {
+            type: 'info',
+            title: packageData.build.productName,
+            message: message,
+          });
         },
       },
     ],
-  },
+  },  
 ];
 
 const startFlaskServer = () => {
   let apiServer;
   const RestAPIscript = path.join(__dirname, 'backend/restapi_server.py');
-  const restAPIexe = path.join(app.getAppPath(), '..', '..', 'backend', 'restapi_server.exe');
+  const restAPIexe = path.join(app.getAppPath(), '..', '..', 'backend', 'restapi_server.exe', 'restapi_server.exe');
 
   const args = [
     '--port', store.get('port'),
@@ -267,6 +292,7 @@ const createWindow = () => {
   mainWindow = new BrowserWindow({
     width: 1400,
     height: 800,
+    icon: `${__dirname}/imgs/rpeicon.png`,
     webPreferences: {
       preload: path.join(app.getAppPath(), 'preload.js'),
       nodeIntegration: true,
@@ -289,7 +315,7 @@ const createWindow = () => {
     store.set('device_xml', arg.device_xml);
     store.set('useDefaultFile', arg.useDefaultFile);
 
-    serverProcess.kill();
+    kill(serverProcess);
 
     app.relaunch();
     app.quit();
@@ -317,7 +343,15 @@ app.whenReady().then(() => {
   });
 });
 
-app.on('window-all-closed', () => {
+app.on("before-quit", function () {
   kill(serverProcess);
+})
+
+app.on('window-all-closed', () => {
+  console.log(`
+    =================================================
+      RPE - Session closed at ${now.toLocaleString()} 
+    =================================================
+    `);  
   if (process.platform !== 'darwin') app.quit();
 });

imgs/rpelogo.png

@@ -13,7 +13,7 @@
     "test:playwright": "npx playwright test",
     "postinstall": "electron-builder install-app-deps",
     "pack": "electron-builder --dir",
-    "dist": "pyinstaller --distpath backend --workpath dist -y --clean -n restapi_server.exe --onefile backend/restapi_server.py && webpack --mode production && electron-builder -p never"
+    "dist": "pyinstaller --distpath backend --workpath dist -y --clean -n restapi_server.exe backend/restapi_server.py && webpack --mode development && electron-builder -p never"
   },
   "build": {
     "appId": "org.rapidsilicon.rapid_power_estimator",
@@ -28,6 +28,7 @@
       "node_modules/**/*",
       "package.json",
       "cleanup.js",
+      "imgs/*",
       "projectFile.js"
     ],
     "directories": {
@@ -38,6 +39,10 @@
         "from": "backend/restapi_server.exe",
         "to": "./backend/restapi_server.exe"
       },
+      {
+        "from": "backend/etc/devices",
+        "to": "./backend/etc/devices"
+      },
       {
         "from": "backend/etc/device.xml",
         "to": "./backend/etc/device.xml"
@@ -62,13 +67,13 @@
         }
       ],
       "publisherName": "Rapid Silicon, Inc.",
-      "icon": "RPE_icon.png",
+      "icon": "imgs/rpeicon.png",
       "artifactName": "${name}_windows_installer.${ext}"
     },
     "nsis": {
       "oneClick": false,
       "allowToChangeInstallationDirectory": true,
-      "installerSidebar": "imgs/rpesidebar.bmp"
+      "installerSidebar": "imgs/rpesidebar.png"
     },
     "mac": {
       "category": "public.app-category.productivity",
@@ -89,6 +94,7 @@
     "@babel/core": "^7.23.9",
     "@babel/preset-env": "^7.24.4",
     "@babel/preset-react": "^7.24.1",
+    "@playwright/test": "^1.48.1",
     "@testing-library/jest-dom": "^6.5.0",
     "@testing-library/react": "^14.3.1",
     "@testing-library/user-event": "^14.5.2",
@@ -109,7 +115,6 @@
     "react-test-renderer": "^18.3.1",
     "style-loader": "^3.3.4",
     "webpack": "^5.90.1",
-    "@playwright/test": "^1.48.1",
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
@@ -131,4 +136,4 @@
     "type": "git",
     "url": "https://github.com/os-fpga/rapid_power_estimator.git"
   }
-}
+}

imgs/rpesidebar.png

@@ -34,7 +34,7 @@ function BramModal({
         {
           fieldType: FieldType.number,
           id: 'bram_used',
-          text: 'Used',
+          text: 'BRAMs Used',
           value: defaultValue.bram_used,
         },
         {

main.js

@@ -38,7 +38,7 @@ function ClockingModal({
         {
           fieldType: FieldType.number,
           id: 'frequency',
-          text: 'Frequency',
+          text: 'Frequency (Hz)',
           value: defaultValue.frequency,
         },
         {

package.json

@@ -30,7 +30,7 @@ function DspModal({
         {
           fieldType: FieldType.number,
           id: 'number_of_multipliers',
-          text: 'XX',
+          text: 'Number of Multipliers',
           value: defaultValue.number_of_multipliers,
         },
         {

src/components/ModalWindows/BramModal.js

@@ -158,7 +158,7 @@ function BramTable({ device, update, notify }) {
   ];
 
   const mainTableHeader = [
-    '', 'Action', 'En', 'Name/Hierarchy', 'BRAM Type', 'Used', 'Port', 'Clock', 'Width', 'Write En', 'Read En',
+    '', 'Action', 'En', 'Name/Hierarchy', 'BRAM Type', 'BRAMs Used', 'Port', 'Clock', 'Width', 'Write En', 'Read En',
     'Toggle Rate', 'Clock Freq', 'RAM Depth', 'O/P Sig Rate', 'Block Power', 'Intc. Power', '%',
   ];
 

src/components/ModalWindows/ClockingModal.js

@@ -29,7 +29,7 @@ function ClockingTable({ device, update, notify }) {
   const sources = GetOptions('Source');
 
   const mainTableHeader = [
-    '', 'Action', 'En', 'Description', 'Source', 'Port/Signal name', 'Frequency', 'Clock Control', 'Fanout',
+    '', 'Action', 'En', 'Description', 'Source', 'Port/Signal name', 'Frequency (Hz)', 'Clock Control', 'Fanout',
     'Block Power', 'Intc. Power', '%',
   ];
 

src/components/ModalWindows/DspModal.js

@@ -106,7 +106,7 @@ function DspTable({ device, update, notify }) {
   ];
 
   const mainTableHeader = [
-    '', 'Action', 'En', 'Name/Hierarchy', 'XX', 'DSP Mode', { className: 'no-wrap', text: 'A-W' }, { className: 'no-wrap', text: 'B-W' },
+    '', 'Action', 'En', 'Name/Hierarchy', 'No. of Multipliers', 'DSP Mode', { className: 'no-wrap', text: 'A-W' }, { className: 'no-wrap', text: 'B-W' },
     'Clock', 'Pipeline', 'T-Rate',
     'Block Used', 'Clock Freq', 'O/P Sig Rate', 'Block Power', 'Intc. Power', '%',
   ];