Skip to content

Commit f7aa4b6

Browse files
Initial content for SoC Input Section added (#269)
1 parent 94140f9 commit f7aa4b6

File tree

1 file changed

+86
-1
lines changed

1 file changed

+86
-1
lines changed

docs/source/user_guide/SoC_index.rst

+86-1
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,102 @@ This section will document SoC input for Rapid Power Estimator.
77
Peripherals
88
###########
99

10+
To begin inputting SoC information the user must start with selecting peripherals needed for boot, debug & application. The peripherals input section is located on the bottom of the input interface.
11+
12+
Selecting the Peripheral section will display a list of available peripherals on the target device.
13+
14+
.. image:: figures/peripherals-figures-peripherals_selected.JPG
15+
16+
Use the checkboxes on left side to enable/disable peripherals.
17+
Then click on each enabled peripheral's action column button to configure the peripheral.
18+
19+
.. image:: figures/peripherals-figures-input_pwm_info.JPG
20+
21+
For each peripheral, select it's usage as well as performance.
22+
23+
*Note:* For PWM, selecting an IO is also required to drive the PWM signal.
24+
1025
BCPU - Boot Central Processing Unit
1126
#######################################
1227

28+
The BCPU section is found at the top of the SoC input section, to the left of the SoC Total power display.
29+
30+
Selecting the BCPU section will display the name of the CPU "N22 RISC-V", followed by it's configuration fields.
31+
32+
.. image:: figures/SoC-figures-BCPU-BPCU_selected.JPG
33+
34+
Enable/Disable encryption using the checkbox.
35+
36+
Select Boot Mode, SPI is selected by default.
37+
*note:* SPI is currently the only available mode.
38+
39+
Select Clock, BOOT CLK is selected by default.
40+
41+
Click on the "Add" button to connect peripherals with BCPU. These will be primarily used for debug and accessing memory.
42+
43+
.. image:: figures/SoC-figures-BCPU-input_BPCU_info.JPG
44+
45+
Select peripheral under the "Endpoint" dropdown, then enter it's active state, Read/Write Rate & Toggle Rate. Repeat this step for each peripheral.
46+
1347
Connectivity
1448
############
1549

50+
The Connectivity section is found below the BCPU section & SoC Total power display.
51+
52+
.. image:: figures/SoC-figures-connectivity-connectivity_selected.JPG
53+
54+
Selecting the Connectivity section will display an empty table, click on the "Add" button above the table to connect peripherals to the FPGA fabric.
55+
56+
.. image:: figures/SoC-figures-connectivity-input_connectivity_info.JPG
57+
58+
For each peripheral, first pick one of the clocks inputted from the FPGA clocking section.
59+
60+
Under the Endpoint dropdown, select the peripheral to connect to the FPGA fabric, followed by active state, read/write rate & toggle rate. Repeat for each FPGA fabric connection needed.
61+
1662
Memory
1763
########
1864

65+
The memory section is found below the FPGA input section.
66+
67+
.. image:: figures/memory-figures-memory_selected.JPG
68+
69+
Selecting the memory section will display a table below with the available memory options, click the "Add" button above the table to configure each memory.
70+
71+
.. image:: figures/memory-figures-input_OCM_memory_info.JPG
72+
73+
For each memory, select it's usage, then Memory Type, followed by required Data Rate & channel width.
74+
75+
*Note:* All devices will have OCM - on chip memory, DDR memory is only available on specific devices.
76+
77+
.. image:: figures/memory-figures-input_DDR_memory_info.JPG
78+
1979
ACPU - Application Central Processing Unit
2080
###########################################
2181

82+
The ACPU section is found on the top left of the SoC input display.
83+
84+
.. image:: figures/SoC-figures-ACPU-ACPU_selected.JPG
85+
86+
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.
87+
88+
Toggle the ACPU Power toggle switch on left hand side to enable ACPU, then select the load required from the Load dropdown.
89+
90+
Click the "Add" button above the empty table to connect peripherals to the ACPU.
91+
92+
.. image:: figures/SoC-figures-ACPU-input_ACPU_info.JPG
93+
94+
For each peripheral, select peripheral under Endpoint, then select active state, read/write rate & toggle rate.
95+
2296
DMA - Direct Memory Access
23-
###########################
97+
###########################
98+
99+
The DMA section is found below the ACPU section, clicking it will display a 4 channel table on the display.
100+
101+
.. image:: figures/SoC-figures-DMA-DMA_selected.JPG
102+
103+
Enable/disable each channel using the checkboxes under the Enable column, then click on the action column buttons to configure the channel connections.
104+
105+
.. image:: figures/SoC-figures-DMA-put_DMA_info.JPG
106+
107+
For each channel, select a source & destination, typically a peripheral will be connected to a memory or vice-versa. Then select the active state, read/write rate & toggle rate.
108+

0 commit comments

Comments
 (0)