diff --git a/docs/source/user_guide/FPGA.rst b/docs/source/user_guide/FPGA.rst deleted file mode 100644 index 6631ff58..00000000 --- a/docs/source/user_guide/FPGA.rst +++ /dev/null @@ -1,30 +0,0 @@ -============= -FPGA Input -============= - -This section will document FPGA input for Rapid Power Estimator. - -Clocking -######### - -.. image:: figures/FPGA-figures-clocking-input_clock_info.JPG - :width: 300px - :align: center - :height: 350px - :alt: Setup Diagram - -.. image:: FPGA/figures/clocking-input_clock_info.JPG - :alt: Setup Diagram - :align: center - -FLE - Functional Logic Element -############################### - -BRAM - Block Randon Access Memory -################################## - -DSP - Digital Signal Processor -############################### - -IO - Input/Output -################## \ No newline at end of file diff --git a/docs/source/user_guide/FPGA_index.rst b/docs/source/user_guide/FPGA_index.rst index 22338716..adafabcc 100644 --- a/docs/source/user_guide/FPGA_index.rst +++ b/docs/source/user_guide/FPGA_index.rst @@ -61,7 +61,7 @@ The BRAM section is located directly below the clocking section. Selecting the BRAM section displays an empty table, click the "Add" button above the table to fill out the BRAM info. -.. image:: figures/FPGA-figures-BRAM-input_BRAM_info.JPG +.. image:: figures/FPGA-figures-BRAM-input_BRAM_info_v2.JPG .. image:: figures/FPGA-figures-BRAM-input_BRAM_ports_info.JPG @@ -84,7 +84,7 @@ The DSP section is located directly below the FLE section. Selecting the DSP section displays an empty table, click the "Add" button above the table to fill out the DSP info. -.. image:: figures/FPGA-figures-DSP-input_DSP_info.JPG +.. image:: figures/FPGA-figures-DSP-input_DSP_info_v2.JPG 1. Provide a name to label the DSP function within the hierarchy (optional) 2. Enter the no. of DSP multipliers diff --git a/docs/source/user_guide/SoC.rst b/docs/source/user_guide/SoC.rst deleted file mode 100644 index 1affda42..00000000 --- a/docs/source/user_guide/SoC.rst +++ /dev/null @@ -1,17 +0,0 @@ -============= -SoC Input -============= - -This section will document SoC input for Rapid Power Estimator. - -BCPU - Boot Central Processing Unit -####################################### - -ACPU - Application Central Processing Unit -########################################### - -DMA - Direct Memory Access -########################### - -Connectivity -############ \ No newline at end of file diff --git a/docs/source/user_guide/SoC_index.rst b/docs/source/user_guide/SoC_index.rst index 257807ff..30d86928 100644 --- a/docs/source/user_guide/SoC_index.rst +++ b/docs/source/user_guide/SoC_index.rst @@ -20,7 +20,7 @@ Then click on each enabled peripheral's action column button to configure the pe For each peripheral, select it's usage as well as performance. -*Note:* For PWM, selecting an IO is also required to drive the PWM signal. +*Note: For PWM, selecting an IO is also required to drive the PWM signal.* BCPU - Boot Central Processing Unit ####################################### @@ -29,12 +29,12 @@ The BCPU section is found at the top of the SoC input section, to the left of th Selecting the BCPU section will display the name of the CPU "N22 RISC-V", followed by it's configuration fields. -.. image:: figures/SoC-figures-BCPU-BPCU_selected.JPG +.. image:: figures/SoC-figures-BCPU-BCPU_selected_v2.JPG Enable/Disable encryption using the checkbox. Select Boot Mode, SPI is selected by default. -*note:* SPI is currently the only available mode. +*note: SPI is currently the only available mode.* Select Clock, BOOT CLK is selected by default. @@ -72,7 +72,7 @@ Selecting the memory section will display a table below with the available memor For each memory, select it's usage, then Memory Type, followed by required Data Rate & channel width. -*Note:* All devices will have OCM - on chip memory, DDR memory is only available on specific devices. +*Note: All devices will have OCM - on chip memory, DDR memory is only available on specific devices.* .. image:: figures/memory-figures-input_DDR_memory_info.JPG @@ -83,7 +83,7 @@ The ACPU section is found on the top left of the SoC input display. .. image:: figures/SoC-figures-ACPU-ACPU_selected.JPG -Selecting the ACPU section will display the name of the CPU, followed by it's operating frequency & Load selection. *Note:* Application CPU is not available on all devices. +Selecting the ACPU section will display the name of the CPU, followed by it's operating frequency & Load selection. *Note: Application CPU is not available on all devices.* Toggle the ACPU Power toggle switch on left hand side to enable ACPU, then select the load required from the Load dropdown. diff --git a/docs/source/user_guide/figures/FPGA-figures-BRAM-input_BRAM_info_v2.JPG b/docs/source/user_guide/figures/FPGA-figures-BRAM-input_BRAM_info_v2.JPG new file mode 100644 index 00000000..b5603e47 Binary files /dev/null and b/docs/source/user_guide/figures/FPGA-figures-BRAM-input_BRAM_info_v2.JPG differ diff --git a/docs/source/user_guide/figures/FPGA-figures-DSP-input_DSP_info_v2.JPG b/docs/source/user_guide/figures/FPGA-figures-DSP-input_DSP_info_v2.JPG new file mode 100644 index 00000000..7ece21ff Binary files /dev/null and b/docs/source/user_guide/figures/FPGA-figures-DSP-input_DSP_info_v2.JPG differ diff --git a/docs/source/user_guide/figures/SoC-figures-BCPU-BCPU_selected_v2.JPG b/docs/source/user_guide/figures/SoC-figures-BCPU-BCPU_selected_v2.JPG new file mode 100644 index 00000000..9530ae1e Binary files /dev/null and b/docs/source/user_guide/figures/SoC-figures-BCPU-BCPU_selected_v2.JPG differ diff --git a/docs/source/user_guide/figures/results-figures-Display.JPG b/docs/source/user_guide/figures/results-figures-Display.JPG new file mode 100644 index 00000000..08709731 Binary files /dev/null and b/docs/source/user_guide/figures/results-figures-Display.JPG differ diff --git a/docs/source/user_guide/figures/results-figures-FPGA_Complex_and_Core_Power.JPG b/docs/source/user_guide/figures/results-figures-FPGA_Complex_and_Core_Power.JPG new file mode 100644 index 00000000..f1a6c18e Binary files /dev/null and b/docs/source/user_guide/figures/results-figures-FPGA_Complex_and_Core_Power.JPG differ diff --git a/docs/source/user_guide/figures/results-figures-Overal_Power_Typical_and_Worst.JPG b/docs/source/user_guide/figures/results-figures-Overal_Power_Typical_and_Worst.JPG new file mode 100644 index 00000000..4b91e333 Binary files /dev/null and b/docs/source/user_guide/figures/results-figures-Overal_Power_Typical_and_Worst.JPG differ diff --git a/docs/source/user_guide/figures/results-figures-SoC_Processing_Complex_Power.JPG b/docs/source/user_guide/figures/results-figures-SoC_Processing_Complex_Power.JPG new file mode 100644 index 00000000..593b4057 Binary files /dev/null and b/docs/source/user_guide/figures/results-figures-SoC_Processing_Complex_Power.JPG differ diff --git a/docs/source/user_guide/figures/setup-figures-launching_RPE_from_windows_start_menu_v2.JPG b/docs/source/user_guide/figures/setup-figures-launching_RPE_from_windows_start_menu_v2.JPG new file mode 100644 index 00000000..cab45130 Binary files /dev/null and b/docs/source/user_guide/figures/setup-figures-launching_RPE_from_windows_start_menu_v2.JPG differ diff --git a/docs/source/user_guide/introduction.rst b/docs/source/user_guide/introduction.rst deleted file mode 100644 index a58cc832..00000000 --- a/docs/source/user_guide/introduction.rst +++ /dev/null @@ -1,6 +0,0 @@ -==================== -Introduction to RPE -==================== - -This section will document the Introduction of Rapid Power Estimator. - diff --git a/docs/source/user_guide/memory.rst b/docs/source/user_guide/memory_index.rst similarity index 100% rename from docs/source/user_guide/memory.rst rename to docs/source/user_guide/memory_index.rst diff --git a/docs/source/user_guide/peripherals.rst b/docs/source/user_guide/peripherals_index.rst similarity index 100% rename from docs/source/user_guide/peripherals.rst rename to docs/source/user_guide/peripherals_index.rst diff --git a/docs/source/user_guide/results.rst b/docs/source/user_guide/results.rst deleted file mode 100644 index 5290ee40..00000000 --- a/docs/source/user_guide/results.rst +++ /dev/null @@ -1,14 +0,0 @@ -==================== -Analyzing Results -==================== - -This section will document the results on Rapid Power Estimator. - -FPGA Complex & Core Power -######################### - -Processing Complex (SoC) Power -############################## - -Overall Typical & Worst Case Power -################################## \ No newline at end of file diff --git a/docs/source/user_guide/results_index.rst b/docs/source/user_guide/results_index.rst index 5290ee40..6718900c 100644 --- a/docs/source/user_guide/results_index.rst +++ b/docs/source/user_guide/results_index.rst @@ -3,12 +3,44 @@ Analyzing Results ==================== This section will document the results on Rapid Power Estimator. +The Rapid Power Estimator provides a comprehensive power data display on the right hand side of the user interface. + +.. image:: figures/results-figures-Display.JPG + FPGA Complex & Core Power ######################### +The FPGA Power Data is displayed below the save icon and top level module input field. + +.. image:: figures/results-figures-FPGA_Complex_and_Core_Power.JPG + +The Display shows each FPGA input section label with 2 columns for power in watts & the percentage of power used by each respective part of the FPGA design. + +The last 2 rows show FPGA Dynamic Power & FPGA Static Power. The power data in these rows is the sum of the respective static and dynamic power values from each of the FPGA input sections. + +At the bottom of the display, an overall percentage is given along with a percentage bar, this shows the percentage of power being used by the FPGA within the overall FPGA SoC. + Processing Complex (SoC) Power ############################## +The SoC Power Data is displayed on the far right of the screen, to the right of FPGA Power Data display. + +.. image:: figures/results-figures-SoC_Processing_Complex_Power.JPG + +The display shows each SoC input section label with 2 columns for power in watts & the percentage of power used by each respective part of the SoC's Processing Complex. + +The last 2 rows shows overall Dynamic & Static Power. The Power data in these rows is the sum of the respective static and dynamic power values from each of the SoC input sections. + +At the bottom of the display, an overall percentage is given along with a percentage bar, this shows the percentage of power being used by the Processing Complex within the overall FPGA SoC. + + Overall Typical & Worst Case Power -################################## \ No newline at end of file +################################## + +The Overall power budget numbers are displayed at the top right hand side of the screen, above the Processing Complex Power Display. + +.. image:: figures/results-figures-Overal_Power_Typical_and_Worst.JPG + +The displays show power in watts on a typical operating temperature of 25 degrees celcius as well as a power in watts on a worst case operating temperature of 81 degrees celcius. + diff --git a/docs/source/user_guide/setup.rst b/docs/source/user_guide/setup.rst deleted file mode 100644 index de66b2a2..00000000 --- a/docs/source/user_guide/setup.rst +++ /dev/null @@ -1,14 +0,0 @@ -========================== -Setting up an RPE Project -========================== - -This section will document how to setup a project on Rapid Power Estimator. - -Launching RPE -############## - -Project Creation -################# - -Device Selection -################# \ No newline at end of file diff --git a/docs/source/user_guide/setup_index.rst b/docs/source/user_guide/setup_index.rst index 208af2b9..72e10bbd 100644 --- a/docs/source/user_guide/setup_index.rst +++ b/docs/source/user_guide/setup_index.rst @@ -9,7 +9,7 @@ Launching RPE To launch the Rapid Power Estimator, simply navigate to your start menu and search for "Rapid Power Estimator". Once the application is found, click on the application icon to launch the tool. -.. image:: figures/setup-figures-launching_RPE_from_windows_start_menu.JPG +.. image:: figures/setup-figures-launching_RPE_from_windows_start_menu_v2.JPG :alt: RPE icon on windows start menu The Rapid Power Estimator will display the following screen upon launch.