Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
0b03c6c
Updated screenshots for device's parameters
maitaleonida Mar 29, 2025
463a3a0
Update requestaccess.rst
maitaleonida Mar 29, 2025
be4fb4b
Update requestaccess screenshots
maitaleonida Mar 29, 2025
76b8d0d
Improve inviteuser.rst
maitaleonida Mar 29, 2025
5bc9ce4
Improve activateaccount.rst
maitaleonida Mar 29, 2025
15f89b6
Improve otp.rst
maitaleonida Mar 29, 2025
11392f3
Update otp screenshot
maitaleonida Mar 29, 2025
3a87f76
Improve logout.rst
maitaleonida Mar 29, 2025
c63d429
Improve forgotpassword.rst
maitaleonida Mar 29, 2025
6268d2f
Update screenshots for forgotpassword
maitaleonida Mar 29, 2025
41904f5
Update createprojectncnoc.rst parameters
maitaleonida Apr 1, 2025
a73aa87
Update the parameters and description in initiatorconfiguration.rst
maitaleonida Apr 1, 2025
e88b402
Update contents of targetconfiguration.rst
maitaleonida Apr 1, 2025
e53ddc9
Update initiatorconfiguration.rst
maitaleonida Apr 1, 2025
237f7c2
Update routerconfiguration.rst
maitaleonida Apr 1, 2025
67aa82b
Update index.rst
maitaleonida Apr 1, 2025
d7cded1
Update index.rst
maitaleonida Apr 1, 2025
e514378
Update introduction.rst
maitaleonida Apr 1, 2025
2384117
Create exportpackage.rst
maitaleonida Apr 7, 2025
a37745c
Update exportpackage.rst
maitaleonida Apr 7, 2025
0314eb6
Add files for Export Package function
maitaleonida Apr 7, 2025
d9404f3
Update index.rst and add export package file
maitaleonida Apr 7, 2025
30dfffd
Update screenshot for initiator and target devices
maitaleonida Apr 8, 2025
b655041
Update initiatorconfiguration.rst (update Use Subtopology Clock)
maitaleonida Apr 8, 2025
d4ac94c
Update targetconfiguration.rst (updateUse Subtopology Clock)
maitaleonida Apr 8, 2025
c625795
Update initiatorconfiguration.rst (update Use Subtopology Clock)
maitaleonida Apr 8, 2025
4d6ac5d
Update virtualconfiguration.rst
maitaleonida Apr 8, 2025
8c59c43
Update screenshot for virtual devices.
maitaleonida Apr 8, 2025
646a6e4
Update initiatorconfiguration.rst
maitaleonida Apr 9, 2025
071a80f
Update targetconfiguration.rst
maitaleonida Apr 9, 2025
467eedc
Modified generatertlandtb.rst with the update in the table UI.
maitaleonida Apr 9, 2025
317fe8b
Modified simulation.rst based on the update of table UI
maitaleonida Apr 9, 2025
c465da4
Added files related to generateRTL and Simulation
maitaleonida Apr 9, 2025
69a63d8
Update generatertlandtb.rst with C-NoC generateRTL
maitaleonida Apr 10, 2025
f7a5a95
Add generateRTL for c-noc
maitaleonida Apr 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions source/activateaccount.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Activate Account
=====================================================
This function is for the formal acceptance and activation of user to create an account to
iNoCulator. To access this feature, user must click the ‘link’ from the Invitation email and it will
open a tab which will redirect to this screen:
This function is for the formal acceptance and activation of a user to create an account in iNoCulator. To access this feature, the user must click the link in the invitation email, which will open a tab that redirects to this screen.

.. image:: images/activate_account-fill_up_form2.png
:alt: activate_account-fill_up_form
Expand Down
15 changes: 1 addition & 14 deletions source/createprojectncnoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,10 @@ Create Project (NC-NoC Topology)

**Project Type** – A dropdown button that allows the user to select the type of project to design. The user can choose between Non-Coherent NoC, Coherent NoC, or Integration (which is not yet implemented).

**Drag ‘n drop an XLSX file here, or click to select one** – An area or button to upload an excel file for generating topology.
**Upload Topology XLSX file** – An area or button to upload an excel file for generating topology.

**Project Name** – This field is used to name your project. No spaces are allowed; only alphanumeric characters are permitted.

**Address Width** – The user needs to choose either 32 or 64 as the address width for the NoC project.

**Power Net Name** – This field is for naming Power Net.

**Ground Net Name** – This field is for naming Ground Net Name.

**Power Voltage** – This field is used to set the power voltage for the NoC project. The minimum configuration is 0.5, and the maximum configuration is 1.5.

**Disable frequency validation** – When unchecked, the frequency of each component within the topology must be set individually. When checked, the user does not need to set the frequency for each component.

**Enable Custom Traffic Behavior** – When unchecked, the Traffic Behavior configuration in the project is unavailable. When checked, configuring Traffic Behavior is available inside Initiator and Target device.



After setting up the Project Settings, the user needs to click the ‘Create’ button. A new project tile will be displayed on the Dashboard. The user must click the tile to start designing a topology within the project.

Expand Down
63 changes: 63 additions & 0 deletions source/exportpackage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
Export Package
========================================

iNoCulator offers two types of export packages: Encrypted and Unencrypted.
The type of package depends on the settings of the group the user belongs to. This function is available for NC-NoC projects.

**Encrypted**
-------------------------------------------------------

To export an 'Encrypted' package, tick the checkbox inside the Export button in the Action Bar.

.. image:: images/export_package_button.png
:alt: export_package_button
:align: center


.. image:: images/export_package_encrypted.png
:alt: export_package_encrypted
:align: center

Click the 'Export Package' button to export the RTL and wait for the result in the Export Design table.

.. image:: images/export_package_encrypted_result.png
:alt: export_package_encrypted_result
:align: center



**Unencrypted**
------------------------------------------------------------------------------

To export an 'Unencrypted' package, untick the checkbox inside the Export button in the Action Bar.

.. image:: images/export_package_button.png
:alt: export_package_button
:align: center


.. image:: images/export_package_unencrypted.png
:alt: export_package_unencrypted
:align: center


Click the 'Export Package' button to export the RTL and wait for the result in the Export Design table.

.. image:: images/export_package_unencrypted_result.png
:alt: export_package_unencrypted_result
:align: center


**Results**
---------------------------------------------------------------------

In the Export Design table, each package result has an 'Actions' column. Click the three dots in this column to select an action.

.. image:: images/export_package_actionbuttons.png
:alt: export_package_actionbuttons
:align: center

Select 'Download' to download the exported RTL result of the selected file.
Select 'Delete' to remove the selected file from the table.


4 changes: 2 additions & 2 deletions source/forgotpassword.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ This feature is designed to help users recover access to their accounts if they
1. From Sign in Page, click ‘Forgot Password’ to access the form.
2. When ‘Forgot Password’ is clicked, Forgot Password page will be displayed.

.. image:: images/forgot_password-reset_your_password_page2.png
.. image:: images/forgot_password-reset_your_password_page3.png
:alt: forgot_password-reset_your_password_page
:align: center


3. After sending the valid email, user will receive email notification which includes the link for resetting password.

.. image:: images/forgot_password-email_notification.png
.. image:: images/forgot_password-email_notification2.png
:alt: forgot_password-email_notification
:align: center

Expand Down
32 changes: 26 additions & 6 deletions source/generatertlandtb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,51 @@ Generating RTL and Testbench
1. NC-NoC
----------------------------------------

This feature is for generation of RTL Files and testbench for the created NC-NoC topology. To perform this function, user must click the ‘Generate RTL’ button in the Action bar, and the results will be displayed inside ‘Results’.
This feature generates RTL files and a testbench for the created NC-NoC topology. To use it, the user must click the ‘Generate RTL’ button in the Action Bar, then click the ‘New’ button to start the generation. Results will be displayed in the same table, including timestamps for when the action started and completed.

.. image:: images/generate_rtl2.png
.. image:: images/generate_rtl3.png
:alt: generate_rtl.png
:align: center


For downloading successful generateRTL files:

.. image:: images/generate_rtl_files_and_testbench.png
.. image:: images/generate_rtl_files_and_testbench2.png
:alt: generate_rtl_files_and_testbench
:align: center


.. image:: images/generate_rtl_actions.png
:alt: generate_rtl_actions
:align: center


Each result includes an ‘Action’ column, where the user can choose to either ‘Download’ or ‘Delete’ the result. The download option depends on the license assigned to the user’s group.



2. C-NoC
------------------------------------------------

This feature is for generation of RTL Files and testbench for the created C-NoC topology. To perform this function, user must click the ‘Generate RTL’ button in the Action bar, and the results will be displayed inside ‘Results’.
This feature generates RTL files and a testbench for the created C-NoC topology. To use it, the user must click the ‘Generate RTL’ button in the Action Bar, then click the ‘New’ button to start the generation. Results will be displayed in the same table, including timestamps for when the action started and completed.

.. image:: images/c-noc_generateRTL.png
:alt: c-noc_generateRTL.png
:align: center


.. image:: images/c-noc_generateRTL2.png
:alt: c-noc_generateRTL2.png
:align: center


.. image:: images/c-noc_generateRTL_actions.png
:alt: c-noc_generateRTL_actions
:align: center


Each result includes an ‘Action’ column, where the user can choose to either ‘Download’ or ‘Delete’ the result. The download option depends on the license assigned to the user’s group.



3. Download and viewing JSON
-------------------------------------------

Expand Down
Binary file added source/images/c-noc_generateRTL2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/c-noc_generateRTL_actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/export_package_actionbuttons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/export_package_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/export_package_encrypted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/export_package_encrypted_result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/export_package_unencrypted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/generate_rtl3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/generate_rtl_actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/initiator-parameters2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/initiator-parameters3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/initiator-timing2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/initiator-timing3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/request_access-sign_in_page3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/request_access_page3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/sign_in-otp_page3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/simulate-results2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/simulate_actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/simulation3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/target-parameters4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/target-timing2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/target-timing3.png
Binary file added source/images/virtual_device-settings5.png
43 changes: 31 additions & 12 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,17 @@ What's inside the iNoCulator?

getstarted
introduction
modificationhistory
faqs
appendix

.. toctree::
:maxdepth: 2
:caption: Using iNoCulator

requestaccess
inviteuser
activateaccount
signin
otp
logout
forgotpassword
expiredaccount
invalidcredentials
suspendedaccount
duplicateemail
expiredlink



.. toctree::
:maxdepth: 2
Expand All @@ -56,6 +50,7 @@ What's inside the iNoCulator?
topologyvalidation
generatertlandtb
simulation
exportpackage
downloadjson
implement
projectconfig
Expand All @@ -74,5 +69,29 @@ What's inside the iNoCulator?
configureroutercnoc
configuredevicecnoc
configuresystemparam


.. toctree::
:maxdepth: 2
:caption: TroubleShoot

forgotpassword
expiredaccount
invalidcredentials
suspendedaccount
duplicateemail
expiredlink

.. toctree::
:maxdepth: 2
:caption: Support

appendix
faqs


.. toctree::
:maxdepth: 2
:caption: Reference

modificationhistory

20 changes: 10 additions & 10 deletions source/initiatorconfiguration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@ Initiator Configuration

Configuring an Initiator device involves various settings. The Settings tab includes sections for Parameters, Timing, Security, and Others. The Timing section is available only if the 'Disable Frequency Validation' checkbox in the 'Create Project' settings is checked. The Traffic Behavior section is available only if the corresponding checkbox in the 'Create Project' settings is enabled.

.. image:: images/initiator-parameters.png
:alt: initiator-parameters
.. image:: images/initiator-parameters3.png
:alt: initiator-parameters3
:align: center

**Subtopology** – A dropdown list for changing subtopology assigned for the selected initiator.
**Subtopology** – A dropdown list allows users to change the subtopology assigned to the selected initiator. This dropdown can be modified and reassigned to another available subtopology based on the topology configuration.

**Name** – Label name assigned for selected initiator. This is an input field where only alphanumeric keys and underscores are allowed.

**Device ID** – This ID is unique for each component.
**Device ID** – This identifier is unique for each component.

**Bus Protocol** – The selected item here will be assigned as the protocol for the Initiator device. The available selections are AXI, AHB, APB, and SIG_NATIVE.

**Bus Protocol Version** – The list of versions depends in ‘Bus Protocol’ that has been selected. Please check the table below as reference.

**Bus Variant** – The list of variants for the selected 'Bus Protocol' will be displayed here. Please check the table below as reference.

**Write Transaction ID Width** – Refers to the number of bits allocated to identify write transactions.
**Write Transaction ID Width** – Refers to the number of bits allocated to identify write transactions. This parameter is displayed in all AXI devices except in AXI4-Lite.

**Read Transaction ID Width** – Refers to the number of bits used to identify read transaction.
**Read Transaction ID Width** – Refers to the number of bits used to identify read transaction. This parameter is displayed in all AXI devices except in AXI4-Lite.

**Port Data Width** – Refers to the Data Width you will be assigned to the connected port. Available list will depend on what Bus Protocol was selected.

Expand Down Expand Up @@ -63,15 +63,15 @@ Configuring an Initiator device involves various settings. The Settings tab incl



.. image:: images/initiator-timing.png
.. image:: images/initiator-timing3.png
:alt: initiator-timing
:align: center

Timing tab will be displayed if the checkbox for ‘Disable Frequency Validation’ in the 'Create Project' prompt is unchecked.
Timing tab displays the Use Subtopology Clock and Frequency parameters. By default, Use Subtopology Clock is enabled, and the Frequency value follows the frequency set in the Subtopology folder.

**Latency Clock Sync** – When enabled, Frequency will be same as Subtopology clock. When disabled, Frequency needs to be set in MHz.
**Use Subtopology Clock** – When enabled, the Frequency will be the same as the Subtopology clock. When disabled, the Frequency must be set in MHz.

**Frequency** – The rate of speed on how a processor can execute instructions. This field will be available if ‘Latency Clock Sync’ is disabled.
**Frequency** – TThis refers to the speed at which a processor can execute instructions. By default, the value displayed here follows the value set in the Subtopology folder. This field can be modified if 'Use Subtopology Clock' is disabled.


.. image:: images/initiator-security.png
Expand Down
15 changes: 7 additions & 8 deletions source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Introduction

The table below indicates the terms used in the web application.

Table 1. Definition of terms.


+----------------------+----------------------------------------------------------------------------------------------------+
| **Term** | **Definition** |
+======================+====================================================================================================+
Expand Down Expand Up @@ -50,13 +49,13 @@ The table below indicates the terms used in the web application.

-------------------------------------------------------------------------------------------------------------------------------------------------------

This web application is made for the following users:
This web application is made for the following users:

- Hardware engineer who wants to design a NOC topology.
- Hardware engineer who wants to evaluate the performance of a NOC topology.
- Hardware engineer who wants to become familiar in the usage of the tool.
- Software engineer who wants to develop software based on the current design module.
- Sales person who wants to provide a tool to their company.
- Hardware engineer who wants to design a NOC topology.
- Hardware engineer who wants to evaluate the performance of a NOC topology.
- Hardware engineer who wants to become familiar in the usage of the tool.
- Software engineer who wants to develop software based on the current design module.
- Sales person who wants to provide a tool to their company.

.. _overview:

Expand Down
6 changes: 3 additions & 3 deletions source/inviteuser.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Invite User
===================================
This function is for Admin Account. Once access is requested, all admins of Inoculator will be notified, and the next step is to send an invitation to the requester to activate their account. This will be discussed on ‘Admin’s User Guide’.
This function is for Admin accounts. Once access is requested, all Inoculator admins will be notified, and the next step is to send an invitation to the requester to activate their account. This process is discussed in the 'Admin User Guide.'

After an admin verifies the eligibility of the requester, admin will send an invite email to the requester. Request will receive this email content:
After verifying the requester's eligibility, an admin will send an invitation email. The requester will receive the following email content:

.. image:: images/invite_user-invitation_email.png
:align: center
:alt: invite_user-invitation_email

The invitation includes links to the Terms of Service and Privacy Policy, and Software Evaluation Agreement for the requester to access and review. This email also includes the link for activation
The invitation includes links to the Terms of Service, Privacy Policy, and Software Evaluation Agreement for the requester to access and review. It also contains a link for account activation.
3 changes: 2 additions & 1 deletion source/logout.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Logout
===================================

After using iNoCulator, user will logout his account. To do this, user must click the ‘Logout’ icon that can be found in upper right corner of the tool. Confirmation message will also prompt before successful logout.
After using iNoCulator, the user will log out of their account. To do this, the user must click the 'Logout' icon located in the upper right corner of the tool. A confirmation message will appear before the logout is successful.


.. image:: images/logout_icon_from_dashboard.png
:alt: logout_icon_from_dashboard
Expand Down
4 changes: 2 additions & 2 deletions source/otp.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
One-Time-Pin (OTP)
===================================

To use the iNoCulator, user must enter valid credentials and input valid OTP. One-time pin will be received thru users registered email.
TTo use iNoCulator, the user must enter valid credentials and input a valid OTP. The one-time PIN will be sent to the user's registered email.

.. image:: images/sign_in-otp_page2.png
.. image:: images/sign_in-otp_page3.png
:alt: sign_in-otp_page
:align: center

Expand Down
6 changes: 3 additions & 3 deletions source/requestaccess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ access the iNoCulator. To find this, from home page, click ‘Get started now!
:alt: request_access-home_page
:align: center

.. image:: images/request_access-sign_in_page2.png
.. image:: images/request_access-sign_in_page3.png
:alt: request_access-sign_in_page
:align: center

.. image:: images/request_access_page2.png
.. image:: images/request_access_page3.png
:alt: request_access_page
:align: center

Expand All @@ -24,7 +24,7 @@ Limitations:
- Use only alphanumeric keys including ñ and Ñ, spaces and no special characters.


After filling out the Request Access Form, confirmation page will be displayed and users registered email will receive a confirmation email from Admin that the request has been sent successfully.
After filling out the Request Access Form, a confirmation page will be displayed, and the user's registered email will receive a confirmation email from the admin indicating that the request has been sent successfully.

.. image:: images/request_access-confirmation_page2.png
:alt: request_access-confirmation_page
Expand Down
2 changes: 1 addition & 1 deletion source/routerconfiguration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Configuring a router includes setting up the power and routing table. To start e
:align: center


**Subtopology** – A dropdown list for changing subtopology assigned for the selected router.
**Subtopology** – A dropdown list allows users to change the subtopology assigned to the selected Router. This dropdown can be modified and reassigned to another available subtopology based on the topology configuration.

**Device ID** - This ID is unique for each component

Expand Down
Loading