Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 11 additions & 7 deletions content/install-guides/ambaviz.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ tool_install: true # Set to true to be listed in main selection pag
multi_install: false # Set to true if first page of multi-page article, else false
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
test_maintenance: true
test_images:
- ubuntu:latest

---

[Arm AMBA Viz](https://www.arm.com/products/development-tools/embedded-and-software/amba-viz) is a tool to visualize AMBA events to accelerate SoC verification. This guide is for SoC verification and validation engineers to efficiently analyze hardware signals in their designs.
Expand All @@ -49,23 +53,23 @@ AMBA Viz requires a Linux host machine with Java 11 or JavaFX.

Extract the software from the bundle to the desired install location. For example:

```command
```console
tar -xf ambaviz.tar.gz
```

Navigate to the newly-created `ambaviz-<version>` folder, and run the following script to set up environment variables:

#### sh/bash
```command
```console
source sourceMe.sh
```
#### csh
```command
```console
sourceMe.csh
```

The AMBA Viz Release Notes provide full installation instructions, located in the extracted directory at:
```command
```console
docs/public/assets/pdfs/ambaviz-release-note.pdf
```

Expand All @@ -78,17 +82,17 @@ License set up instructions are available in the [Arm License install guide](/in
## Get started

Typically, AMBA Viz is launched with a waveform file:
```command
```console
ambaviz -f <waveform_file>
```

A proprietary `AVDB` waveform format is recommended to improve the performance of AMBA Viz.

To convert `VCD` or `FSDB` files to this format, use the `wave2avdb` script, for example:
```command
```console
wave2avdb -d cmn600 -f waves.vcd -o waves.avdb
```
The User Guide provides full usage instructions, located in the extracted directory at:
```command
```console
docs/public/assets/pdfs/ambaviz-user-guide.pdf
```
5 changes: 4 additions & 1 deletion content/install-guides/ams.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ tool_install: true # Set to true to be listed in main selection pag
multi_install: false # Set to true if first page of multi-page article, else false
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
test_maintenance: true
test_images:
- ubuntu:latest
---
[Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio%20for%20Mobile) (formally known as `Arm Mobile Studio`) is a performance analysis tool suite for various application developers:

Expand Down Expand Up @@ -57,7 +60,7 @@ Run the supplied `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer
### Linux

Unpack the supplied `Arm Performance Studio` bundle to the desired location. For example:
```command
```console
tar -xf Arm_Performance_Studio_2024.3_linux_x86-64.tgz
```
### macOS
Expand Down
8 changes: 4 additions & 4 deletions content/install-guides/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ minutes_to_complete: 10
multi_install: false
multitool_install_part: false
official_docs: https://docs.ansible.com/ansible/latest/index.html
test_maintenance: true
test_images:
- ubuntu:latest
test_link: null
test_maintenance: false
title: Ansible
tool_install: true
weight: 1
---

Ansible is an open source, command-line automation used to configure systems and deploy software.

Ansible command-line tools can be installed on a variety of Linux distributions.
Ansible command-line tools can be installed on a variety of Linux distributions.

[General installation information](https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html) is available which covers all supported operating systems, but it doesn't talk about Arm-based hosts.

Expand All @@ -41,7 +41,7 @@ aarch64

If you see a different result, you are not using an Arm-based machine running 64-bit Linux.

## How do I download and install Ansible for Ubuntu on Arm?
## How do I download and install Ansible for Ubuntu on Arm?

The easiest way to install the latest version of Ansible for Ubuntu on Arm is to use the PPA (Personal Package Archive).

Expand All @@ -54,7 +54,7 @@ sudo add-apt-repository --yes --update ppa:ansible/ansible
sudo apt install ansible -y
```

Confirm the Ansible command line tools are installed by running:
Confirm the Ansible command line tools are installed by running:

```bash
ansible-playbook --version
Expand Down
50 changes: 25 additions & 25 deletions content/install-guides/aperf.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ multitool_install_part: false
official_docs: https://github.com/aws/aperf
test_images:
- ubuntu:latest
test_maintenance: false
test_maintenance: true
title: AWS Perf (APerf)
tool_install: true
weight: 1
Expand All @@ -17,11 +17,11 @@ APerf (AWS Perf) is an open source command line performance analysis tool which

APerf was created by AWS to help with Linux performance analysis.

In addition to the CLI, APerf includes an HTML view to visualize the collected data.
In addition to the CLI, APerf includes an HTML view to visualize the collected data.

## Before you begin

APerf works on Linux, and is available as a single binary.
APerf works on Linux, and is available as a single binary.

APerf works best if `perf` is installed. Refer to the [Perf for Linux on Arm](/install-guides/perf) install guide for instructions.

Expand All @@ -43,9 +43,9 @@ If you see a different result, you are not using an Arm computer running 64-bit

## Download and install APerf

The easiest way to install APerf is to download a release from GitHub, extract it, and setup your `PATH` environment variable or copy the executable to a directory already in your search path.
The easiest way to install APerf is to download a release from GitHub, extract it, and setup your `PATH` environment variable or copy the executable to a directory already in your search path.

Visit the [releases page](https://github.com/aws/aperf/releases/) to see a list of available releases.
Visit the [releases page](https://github.com/aws/aperf/releases/) to see a list of available releases.

You can also download a release from the command line:

Expand All @@ -59,7 +59,7 @@ Extract the release:
tar xvfz aperf-v0.1.12-alpha-aarch64.tar.gz
```

Add the path to `aperf` in your `.bashrc` file.
Add the path to `aperf` in your `.bashrc` file.

```console
echo 'export PATH="$PATH:$HOME/aperf-v0.1.12-alpha-aarch64"' >> ~/.bashrc
Expand All @@ -69,12 +69,12 @@ source ~/.bashrc
Alternatively, you can copy the `aperf` executable to a directory already in your search path.

```bash { target="ubuntu:latest" }
sudo cp aperf-v0.1.12-alpha-aarch64/aperf /usr/local/bin
sudo cp aperf-v0.1.12-alpha-aarch64/aperf /usr/local/bin
```

Confirm `aperf` is installed by printing the version:

```bash { target="ubuntu:latest" }
```bash { target="ubuntu:latest" }
aperf --version
```

Expand All @@ -86,33 +86,33 @@ aperf 0.1.0 (4b910d2)

## Verify APerf is working

### Create and view a report
### Create and view a report

To confirm APerf is working, start it for 10 seconds and take a sample every 1 second.

```bash { target="ubuntu:latest" }
aperf record -i 1 -p 10 -r run1 --profile
```console
sudo aperf record -i 1 -p 10 -r run1 --profile
```

After 10 seconds `aperf` completes and you see a directory named `run1` and a tar file named `run1.tar.gz`.
After 10 seconds `aperf` completes and you see a directory named `run1` and a tar file named `run1.tar.gz`.

Next, generate a report from the recorded data:

```bash { target="ubuntu:latest" }
aperf report -r run1 -n report1
```console
sudo aperf report -r run1 -n report1
```

The name of the report is `report1` and you will see a `report1` directory and a tar file named `report1.tar.gz`.
The name of the report is `report1` and you will see a `report1` directory and a tar file named `report1.tar.gz`.

The tar files are useful if you want to copy them to another machine.

Using a web browser, open the file `index.html` in the `report1/` directory. To open the file use `Ctrl+O` for Linux and Windows and use `⌘+O` for macOS.

The report is now visible in the browser.
The report is now visible in the browser.

There are a number of tabs on the left side showing the collected data.
There are a number of tabs on the left side showing the collected data.

You can browse the data and see what has been collected.
You can browse the data and see what has been collected.

![APerf #center](/install-guides/_images/aperf0.png)

Expand All @@ -124,21 +124,21 @@ The Kernel Config and Sysctl Data tabs are blank unless you click No.

To demonstrate comparing 2 runs, create a second run with `aperf record`:

```bash { target="ubuntu:latest" }
aperf record -i 1 -p 10 -r run2 --profile
```console
sudo aperf record -i 1 -p 10 -r run2 --profile
```

After 10 seconds `aperf` completes and you see a directory named `run2` and a tar file named `run2.tar.gz`.
After 10 seconds `aperf` completes and you see a directory named `run2` and a tar file named `run2.tar.gz`.

Generate a report with both the first and second runs included:

```bash { target="ubuntu:latest" }
aperf report -r run1 -r run2 -n compare
```console
sudo aperf report -r run1 -r run2 -n compare
```

The name of the report is `compare` and you will see a `compare` directory and a tar file named `compare.tar.gz`.
The name of the report is `compare` and you will see a `compare` directory and a tar file named `compare.tar.gz`.

Open the `index.html` file in the `compare/` directory to see the 2 runs side by side.
Open the `index.html` file in the `compare/` directory to see the 2 runs side by side.

A screenshot is shown below:

Expand Down
15 changes: 8 additions & 7 deletions content/install-guides/arduino-pico.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ layout: installtoolsall
minutes_to_complete: 15
official_docs: https://docs.aws.amazon.com/greengrass/v2/developerguide/quick-installation.html
prerequisites: Arduino IDE
test_maintenance: true
test_images:
- ubuntu:latest
tool_install: true
Expand All @@ -19,15 +20,15 @@ multitool_install_part: false
weight: 1
---

You can install the Arduino IDE and Arduino core software for the Raspberry Pi Pico and the Raspberry Pi Pico W.
You can install the Arduino IDE and Arduino core software for the Raspberry Pi Pico and the Raspberry Pi Pico W.

Arduino core is the software stack that powers Arduino devices and development boards. While the Raspberry Pi Pico isn't an Arduino board, it uses the same RP2040 SoC as the Arduino RP2040 Connect, and therefore can run the same Arduino core software.

## Install Arduino IDE

First, you need to install the Arduino IDE on your laptop or desktop. You can download it for your operating system from [the Arduino Software website](https://www.arduino.cc/en/software). Follow the provided instructions for installing the IDE.

Start the IDE by clicking the Arduino IDE icon.
Start the IDE by clicking the Arduino IDE icon.

## Install board support package

Expand All @@ -43,9 +44,9 @@ When the `Boards Manager` opens search for `pico` and the `Arduino Mbed OS RP204

### Raspberry Pi Pico W

The `Boards Manager` package for for `Arduino Mbed OS RP2040 Boards` does not include the Raspberry Pi Pico W.
The `Boards Manager` package for for `Arduino Mbed OS RP2040 Boards` does not include the Raspberry Pi Pico W.

If you want to use the Pico W go to `File -> Preferences` (or `Arduino IDE -> Settings` on macOS) and enter the URL below into the `Additional Boards Manager URLs` field:
If you want to use the Pico W go to `File -> Preferences` (or `Arduino IDE -> Settings` on macOS) and enter the URL below into the `Additional Boards Manager URLs` field:

```console
https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
Expand All @@ -61,9 +62,9 @@ Once the support package is installed, you need to tell the Arduino IDE which su

## Upload to your board

Because the Raspberry Pi Pico doesn't come with the Arduino core software installed, the Arduino IDE won't recognize it.
Because the Raspberry Pi Pico doesn't come with the Arduino core software installed, the Arduino IDE won't recognize it.

To fix that, you must upload a sketch. A sketch is another name for an Arduino software application.
To fix that, you must upload a sketch. A sketch is another name for an Arduino software application.

Go to `File -> Examples -> 01.Basics -> Blink` and load the sketch.

Expand All @@ -75,4 +76,4 @@ You should see the LED on your Raspberry Pi Pico blink on and off every second.
If you have trouble uploading a sketch, unplug the board, press and hold the `BOOTSEL` button on the board, plug it in, and then release the button.
{{% /notice %}}

You are ready to start writing your own Arduino sketches for Raspberry Pi Pico.
You are ready to start writing your own Arduino sketches for Raspberry Pi Pico.
36 changes: 14 additions & 22 deletions content/install-guides/armclang.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,8 @@ multitool_install_part: false
official_docs: https://developer.arm.com/documentation/100748
test_images:
- ubuntu:latest
- fedora:latest
test_link: null
test_maintenance: false
test_status:
- passed
- passed
test_maintenance: true
title: Arm Compiler for Embedded
tool_install: true
weight: 1
Expand Down Expand Up @@ -57,7 +53,7 @@ These can either be used standalone or [integrated](#armds) into your Arm Develo

See also: [What should I do if I want to download a legacy release of Arm Compiler?](https://developer.arm.com/documentation/ka005184)

See [Arm Product Download Hub](/install-guides/pdh/) for additional information on usage.
See [Arm Product Download Hub](../pdh) for additional information on usage.

### Install compiler packages

Expand All @@ -67,22 +63,17 @@ win-x86_64\setup.exe
```
To install on Linux hosts, `untar` the downloaded package and run the install script (note the exact filenames are version and host dependent). For example:

#### x86_64
```console
mkdir tmp
mv ARMCompiler6.22_standalone_linux-x86_64.tar.gz tmp
cd tmp
tar xvfz ARMCompiler6.22_standalone_linux-x86_64.tar.gz
./install_x86_64.sh --i-agree-to-the-contained-eula --no-interactive -d /home/$USER/ArmCompilerforEmbedded6.22
```
#### aarch64
#### Linux
The `uname -m` call is used to determine whether your machine is running `aarch64` or `x86_64`, and target the downloaded package accordingly.

```console
mkdir tmp
mv ARMCompiler6.22_standalone_linux-aarch64.tar.gz tmp
mv ARMCompiler6.22_standalone_linux-`uname -m`.tar.gz tmp
cd tmp
tar xvfz ARMCompiler6.22_standalone_linux-aarch64.tar.gz
./install_aarch64.sh --i-agree-to-the-contained-eula --no-interactive -d /home/$USER/ArmCompilerforEmbedded6.22
tar xvfz ARMCompiler6.22_standalone_linux-`uname -m`.tar.gz
./install_`uname -m`.sh --i-agree-to-the-contained-eula --no-interactive -d /home/$USER/ArmCompilerforEmbedded6.22
```

Remove the install data when complete.
```console
cd ..
Expand All @@ -102,16 +93,17 @@ armclang --version

### Arm Tools Artifactory {#artifactory}

The Arm Compiler for Embedded, as well as other tools and utilities are available in the [Arm Tools Artifactory](https://www.keil.arm.com/artifacts/). The Keil Studio VS Code [Extensions](/install-guides/keilstudio_vs/) use the artifactory to fetch and install and the necessary components.
The Arm Compiler for Embedded, as well as other tools and utilities are available in the [Arm Tools Artifactory](https://www.keil.arm.com/artifacts/). The Keil Studio VS Code [Extensions](../keilstudio_vs) use the artifactory to fetch and install and the necessary components.

Available packages can also be fetched directly from the artifactory. This is particularly useful for automated CI/CD flows.

```command
```bash
wget https://artifacts.tools.arm.com/arm-compiler/6.22/45/standalone-linux-armv8l_64-rel.tar.gz
```

Note that the artifactory packages do not have their own installers. You should manually extract files and configure, for example:
```command

```bash
mkdir ArmCompilerforEmbedded6.22
tar xvzf ./standalone-linux-armv8l_64-rel.tar.gz -C ./ArmCompilerforEmbedded6.22 --strip-components=1
rm ./standalone-linux-armv8l_64-rel.tar.gz
Expand All @@ -121,7 +113,7 @@ export AC6_TOOLCHAIN_6_22_0=/home/$USER/ArmCompilerforEmbedded6.22/bin

## Set up the product license

Arm Compiler for Embedded and Arm Compiler for Embedded FuSa are license managed. License setup instructions are available in the [Arm Licensing install guide](/install-guides/license/).
Arm Compiler for Embedded and Arm Compiler for Embedded FuSa are license managed. License setup instructions are available in the [Arm Licensing install guide](../license/).

## Verify installation

Expand Down
Loading