-#### Step 2 : Modify the contents of the project_{device}.js +### Step 2 : Modify the contents of the project_{device}.js This file uses 2 functions: getComponentProperty() and getComponentBuildProperty() where user can provide different values as per their requirements to build a PRU project of our choice, some of which are discussed as follows. @@ -326,7 +197,7 @@ This file uses 2 functions: getComponentProperty() and getComponentBuildProperty ], }; ``` -#### Step 3 : Add the path of the project.js file to the respective device's examples file list +### Step 3 : Add the path of the project.js file to the respective device's examples file list The path to the project.js of the new project needs to be added to the example file list of the required device. Go to open_pru/.project/device/project_{device}.js and add the path to the project.js of the new example to the example_file_list array. @@ -334,11 +205,11 @@ The path to the project.js of the new project needs to be added to the example f
-#### Step 4 : Generate build files +### Step 4 : Generate build files - Run one of the below command from the root folder of open-pru -##### Option 1: Prebuilt MCU PLUS SDK installers for specific devices are used +#### Option 1: Prebuilt MCU PLUS SDK installers for specific devices are used ```bash make gen-buildfiles DEVICE={device} ``` @@ -347,7 +218,7 @@ The path to the project.js of the new project needs to be added to the example f make gen-buildfiles DEVICE=am243x ``` -##### Option 2: MCU+ SDK repository which is core for all the Sitara MCU and MPU devices is used +#### Option 2: MCU+ SDK repository which is core for all the Sitara MCU and MPU devices is used ```bash make gen-buildfiles DEVICE={device} GEN_BUILDFILES_TARGET=development ``` @@ -356,7 +227,7 @@ The path to the project.js of the new project needs to be added to the example f make gen-buildfiles DEVICE=am243x GEN_BUILDFILES_TARGET=development ``` -#### Step 5 : Link or Copy source files to ccs workspace +### Step 5 : Link or Copy source files to ccs workspace - In order to link source files to workspace add below in getComponentBuildProperty ```bash build_property.projecspecFileAction = "link" @@ -366,10 +237,14 @@ The path to the project.js of the new project needs to be added to the example f build_property.projecspecFileAction = "copy" ``` -#### Step 6: Import to CCS +### Step 6: Import to CCS - After step4, example.projectspec, makefile and the files mentioned in build_property.templates get generated - Now one can simply import the project by browsing to that folder in CCS, then build and test it. -This project is currently not accepting contributions. Coming Soon! +## Contributing to the OPEN PRU project + +We hope to start accepting contributions to the OPEN PRU project sometime soon. Reach out to us on [TI's E2E forums](https://e2e.ti.com/) for updates! +## Technical Support +Reach out to us with questions on [TI's E2E forums](https://e2e.ti.com/). Please note that support may be limited for OPEN PRU projects in the examples/ folder. \ No newline at end of file diff --git a/getting_started.md b/getting_started.md new file mode 100644 index 000000000..a8ad9b063 --- /dev/null +++ b/getting_started.md @@ -0,0 +1,246 @@ +
+
+
+# Getting Started with OPEN PRU + +[Supported HOST environments](#supported-host-environments) | [Which core will initialize the PRU?](#which-core-will-initialize-the-pru) | [Install dependencies (manual installation)](#install-dependencies-manual-installation) | [Install dependencies (script)](#install-dependencies-script) | [Generate buildfiles](#generate-buildfiles) + +
+
+## Introduction
+
+This page discusses how to:
+
+1. Install the associated SDK and tools for your development platform (Windows or Linux). Install dependencies manually, or use the pru_dependencies script (AM243x, AM64x only)
+
+2. Generate project buildfiles
+
+After the OPEN PRU repository has been set up, refer back to the [README](./README.md) for build steps.
+
+## Supported HOST environments
+
+- Validated on Windows 10 64bit. Higher versions may work
+- Validated on Ubuntu 18.04 64bit & Ubuntu 22.04 64bit. Higher versions may work
+
+## Which core will initialize the PRU?
+
+In your final design, the PRU cores must be initialized by another processor core. Depending on the processor, PRU cores can be initialized and controlled by cores running RTOS, bare metal, or Linux.
+
+TI supports initializing the PRU from an RTOS/bare metal core on these processors:
+- AM243x (R5F)
+- AM261x (R5F)
+- AM263x (R5F)
+- AM263px (R5F)
+- AM64x (R5F)
+
+TI supports initializing the PRU from Linux on these processors:
+- AM62x (A53)
+- AM64x (A53)
+
+TI supports RTOS & bare metal development through the MCU+ SDK, and Linux development through the Linux SDK.
+
+## Install dependencies (manual installation)
+
+AM243x & AM64x customers who will use the MCU+ SDK alongside PRU can install dependencies with the pru_dependencies script if they prefer. For those steps, refer to [Install dependencies (script)](#install-dependencies-script).
+
+**Note:** In general, software dependencies should all be installed under the same folder. So Windows developers would put all software tools under C:\ti, and Linux developers would put all software tools under ${HOME}/ti.
+
+If you will initialize the PRU cores from an RTOS or bare metal core, follow the steps in [Windows or Linux: Install the MCU+ SDK & tools](#windows-or-linux-install-the-mcu-sdk--tools).
+
+If you will initialize the PRU cores from a Linux core, follow the steps in [Linux: Install the Linux SDK & tools](#linux-install-the-linux-sdk--tools).
+
+### Windows or Linux: Install the MCU+ SDK & tools
+
+The MCU+ SDK is only a dependency when building OPEN PRU projects that include code for an MCU+ core.
+
+#### Install the MCU+ SDK
+
+Users can either install the prebuilt MCU+ SDK, or clone the MCU+ SDK repository:
+
+1. Download the prebuilt MCU+ SDK. The prebuilt SDK takes up less space on the computer, since it is packaged specifically for a single device.
+
+Please use the links below to download the installers:
+ - [AM243x MCU+ SDK](https://www.ti.com/tool/download/MCU-PLUS-SDK-AM243X)
+ - [AM261x MCU+ SDK](https://www.ti.com/tool/download/MCU-PLUS-SDK-AM261X)
+ - [AM263x MCU+ SDK](https://www.ti.com/tool/download/MCU-PLUS-SDK-AM263X)
+ - [AM263Px MCU+ SDK](https://www.ti.com/tool/download/MCU-PLUS-SDK-AM263PX)
+ - [AM64x MCU+ SDK](https://www.ti.com/tool/download/MCU-PLUS-SDK-AM64X)
+
+2. Clone the [MCU+ SDK repository](https://github.com/TexasInstruments/mcupsdk-core). Follow the mcupsdk-core README.md file for additional steps.
+
+#### Install the tools
+
+Users of the prebuilt MCU+ SDK, refer to the documentation associated with your specific SDK release. Users of the MCU+ SDK repository, refer to the documentation associated with the latest version of the MCU+ SDK.
+
+1. Install the versions of the tools that are listed in these pages:
+ - MCU+ SDK docs > Getting Started > Download, Install, and Setup SDK and Tools
+ - MCU+ SDK docs > Getting Started > Download, Install, and Setup CCS
+ - Developers using a Linux computer, make sure to follow the additional steps at "CCS Linux Host Support"
+
+2. Download and install Node.js v12.18.4 LTS. Then install the node packages required for the open-pru:
+ - Go to the [NodeJS Website](https://nodejs.org/en/) and use the installer to
+ download and install v12.18.4 of node. Install in the default directory.
+ - After successful installation, run an `npm ci` inside the `open-pru` folder like so:
+ ```bash
+ $ cd open-pru/
+ $ npm ci
+ ```
+ - To specify a proxy server, use the --proxy option followed by the proxy server link, like this: `--proxy = +# Getting Started with OPEN PRU + +[Supported HOST environments](#supported-host-environments) | [Which core will initialize the PRU?](#which-core-will-initialize-the-pru) | [Install dependencies (manual installation)](#install-dependencies-manual-installation) | [Install dependencies (script)](#install-dependencies-script) | [Generate buildfiles](#generate-buildfiles) + +