Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge to production #883

Merged
merged 70 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
81a70fa
First draft of LLM on Arm servers LP
pareenaverma Apr 12, 2024
89bf118
automatic update of stats files
Apr 15, 2024
4258da5
Merge branch 'ArmDeveloperEcosystem:main' into content_review
pareenaverma Apr 15, 2024
bb3d0bb
add Topdown to Telemetry Solution install guide title to better find it
jasonrandrews Apr 16, 2024
52df2af
Merge pull request #861 from jasonrandrews/review
jasonrandrews Apr 16, 2024
7a9e175
Updated LP
pareenaverma Apr 16, 2024
9581450
Updated LP
pareenaverma Apr 16, 2024
ffbaefd
Merge branch 'ArmDeveloperEcosystem:main' into content_review
pareenaverma Apr 16, 2024
2fc41d0
Updated LP
pareenaverma Apr 16, 2024
d8c560e
Updated LP
pareenaverma Apr 16, 2024
6a04cee
Updated LP authors
pareenaverma Apr 16, 2024
7411752
Update streamline.md
RonanSynnottArm Apr 17, 2024
36c12f3
Merge pull request #863 from RonanSynnottArm/Streamline-IG-fix
jasonrandrews Apr 17, 2024
f829128
Merge branch 'ArmDeveloperEcosystem:main' into content_review
pareenaverma Apr 18, 2024
bd94156
Added more trouble
KeilChris Apr 18, 2024
993aed5
Merge pull request #864 from KeilChris/cmsis6_migration_update
pareenaverma Apr 18, 2024
c86c329
Updated to LLM LP
pareenaverma Apr 18, 2024
dca6e60
Added a problem solution for uVision
KeilChris Apr 19, 2024
b017e10
Added install guide
KeilChris Apr 19, 2024
30d1266
Update _index.md
pareenaverma Apr 19, 2024
3572960
Update llama-chatbot.md
pareenaverma Apr 19, 2024
8525e2f
Merge pull request #865 from KeilChris/cmsis_6_mig_uvision
pareenaverma Apr 19, 2024
4198c32
Merge pull request #862 from pareenaverma/content_review
pareenaverma Apr 19, 2024
40ecdf9
TEMPLATE: Adding sitemap for context on images.
zachlasiuk Apr 19, 2024
4e283ac
showing names of all authors
zachlasiuk Apr 20, 2024
1079a2f
automatic update of stats files
Apr 22, 2024
00ecee1
Merge pull request #867 from zachlasiuk/main
pareenaverma Apr 22, 2024
dd4f196
Update _index.md
madeline-underwood Apr 22, 2024
946a673
Merge pull request #868 from madeline-underwood/patch-1
pareenaverma Apr 22, 2024
c589b3c
Update avh.md
RonanSynnottArm Apr 23, 2024
c05222d
Update ssh.md
madeline-underwood Apr 23, 2024
addf941
Update _index.md
madeline-underwood Apr 23, 2024
c9097ae
Update hello.md
madeline-underwood Apr 23, 2024
49727ca
Update _index.md
madeline-underwood Apr 23, 2024
7e7d0ad
Update _next-steps.md
madeline-underwood Apr 23, 2024
861ac32
Update llama-chatbot.md
madeline-underwood Apr 23, 2024
2ff2647
Update llama-chatbot.md
madeline-underwood Apr 23, 2024
f097ae1
Merge pull request #872 from madeline-underwood/patch-4
pareenaverma Apr 23, 2024
2db702b
Merge pull request #871 from madeline-underwood/patch-3
pareenaverma Apr 23, 2024
a72bc82
Merge pull request #870 from madeline-underwood/patch-2
pareenaverma Apr 23, 2024
d408f5b
Merge branch 'ArmDeveloperEcosystem:main' into llm_chatbot
madeline-underwood Apr 23, 2024
3986d5f
Update ambaviz.md
madeline-underwood Apr 23, 2024
04666a0
Update ambaviz.md
madeline-underwood Apr 23, 2024
1465e7c
Update llama-chatbot.md
madeline-underwood Apr 23, 2024
90930ff
Merge pull request #869 from RonanSynnottArm/avh132
pareenaverma Apr 23, 2024
b03da2e
Merge pull request #866 from KeilChris/fvps-on-macos-install-guide
pareenaverma Apr 23, 2024
6d7f640
Merge branch 'ArmDeveloperEcosystem:main' into amba_new
madeline-underwood Apr 24, 2024
3742d55
Update ambaviz.md
madeline-underwood Apr 24, 2024
ed3b3c4
Merge branch 'ArmDeveloperEcosystem:main' into llm_chatbot
madeline-underwood Apr 24, 2024
b725763
Update _next-steps.md
madeline-underwood Apr 24, 2024
1a1c1ed
Update _review.md
madeline-underwood Apr 24, 2024
8d9a482
Update llama-chatbot.md
madeline-underwood Apr 24, 2024
5abfc04
Update fvps-on-macos.md
madeline-underwood Apr 24, 2024
59a5d0f
Update fvps-on-macos.md
madeline-underwood Apr 24, 2024
115ce4b
Update 5run.md
madeline-underwood Apr 24, 2024
5ffc625
spelling udpates
jasonrandrews Apr 24, 2024
78c2be5
Merge pull request #877 from jasonrandrews/spelling
jasonrandrews Apr 24, 2024
1e33423
Merge pull request #875 from madeline-underwood/editorial
pareenaverma Apr 24, 2024
ee46f19
Update llama-chatbot.md
madeline-underwood Apr 24, 2024
b11a7d0
Update llama-chatbot.md
madeline-underwood Apr 24, 2024
b0b62ee
Update llama-chatbot.md
madeline-underwood Apr 24, 2024
44c943f
Merge branch 'main' into llm_chatbot
pareenaverma Apr 25, 2024
49aa033
remove framework from .NET Learning Path title
jasonrandrews Apr 25, 2024
29d8ebb
Merge pull request #881 from jasonrandrews/review
jasonrandrews Apr 25, 2024
56586d6
Update fvps-on-macos.md
madeline-underwood Apr 26, 2024
00625b6
Update fvps-on-macos.md
madeline-underwood Apr 26, 2024
9c509c2
Merge pull request #873 from madeline-underwood/amba_new
pareenaverma Apr 26, 2024
14c9c3a
Merge branch 'main' into fvps
pareenaverma Apr 26, 2024
c3b0b54
Merge pull request #874 from madeline-underwood/fvps
pareenaverma Apr 26, 2024
8ba744d
Merge pull request #878 from madeline-underwood/llm_chatbot
pareenaverma Apr 26, 2024
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
1 change: 1 addition & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ jobs:
- name: Build
run: |
hugo --minify
cp learn-image-sitemap.xml public/learn-image-sitemap.xml
bin/pagefind --site "public"

# Deploys website to AWS S3
Expand Down
21 changes: 21 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2633,3 +2633,24 @@ xy
zfs
zfsutils
zxf
CoreDebug
Cryptocell
GGUF
GenAI
Georgi
Gerganov
LLM
LLMs
STMU
TheBloke
XXS
quant
quantized
quantizing
impactful
symlinks
nlp
eval
datascience
chatbot
Guid
30 changes: 15 additions & 15 deletions content/install-guides/ambaviz.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
### Title the install tools article with the name of the tool to be installed
### Include vendor name where appropriate
title: Arm AMBA Viz
draft: true

### Optional additional search terms (one per line) to assist in finding the article
additional_search_terms:
- architecture
- soc
- ip
- coresight
- corelink
- success kits
- hsk
- SoC
- IP
- CoreSight
- CoreLink
- Success Kits
- HSK

### Estimated completion time in minutes (please use integer multiple of 5)
minutes_to_complete: 15
Expand All @@ -29,15 +29,15 @@ multitool_install_part: false # Set to true if a sub-page of a multi-page arti
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
---

[Arm AMBA Viz](https://www.arm.com/products/development-tools/embedded-and-software/amba-viz) is a tool used to visualize AMBA events to accelerate SoC verification.
[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.

## Download installer packages

AMBA Viz is a component of [Arm Hardware Success Kits](https://www.arm.com/products/development-tools/success-kits).

It is available to download via the [Arm Product Download Hub](https://developer.arm.com/downloads/view/HWSKT-KS-0002).
It is available to download at the [Arm Product Download Hub](https://developer.arm.com/downloads/view/HWSKT-KS-0002).

You can download AMBA Viz as an individual standalone component, or you can download the complete success kits.
You can download AMBA Viz as an individual standalone component, or you can download the complete Success Kits.

For more information on the Download Hub, refer to the [Arm Product Download Hub install guide](../pdh).

Expand All @@ -51,7 +51,7 @@ Extract the software from the bundle to the desired install location. For exampl
tar -xf ambaviz.tar.gz
```

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

#### sh/bash
```command
Expand All @@ -62,18 +62,18 @@ source sourceMe.sh
sourceMe.csh
```

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

## Set up the product license

AMBA Viz is license managed. License setup instructions are available in the [Arm License install guide](../license/).
AMBA Viz is license-managed. License set up instructions are available in the [Arm License install guide](../license/).

## Get started

Typically AMBA Viz is launched with a waveform file:
Typically, AMBA Viz is launched with a waveform file:
```command
ambaviz -f <waveform_file>
```
Expand All @@ -84,7 +84,7 @@ To convert `VCD` or `FSDB` files to this format, use the `wave2avdb` script, for
```command
wave2avdb -d cmn600 -f waves.vcd -o waves.avdb
```
Full usage instructions are given in the User Guide, located in the extracted directory at:
The User Guide provides full usage instructions, located in the extracted directory at:
```command
docs/public/assets/pdfs/ambaviz-user-guide.pdf
```
21 changes: 19 additions & 2 deletions content/install-guides/avh.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Information about launching an AWS instance is available in the [Getting Started

On your local machine, run the following command to connect to the instance (with user name `ubuntu`) with SSH Key `your_key.pem`.
```console
ssh -i <path_to>/your_key.pem ubuntu@<Instance_IP_address>
ssh -i <path_to>/your_key.pem ubuntu@<AMI_IP_address>
```
### Verify instance has launched successfully

Expand Down Expand Up @@ -92,8 +92,25 @@ Connect your VNC client to port `5901`. You will be prompted for the VNC passwor

A number of [example](https://arm-software.github.io/AVH/main/examples/html/index.html) projects are available to further help you get started.

### Use of FVP_Corstone-1000

When using the supplied `FVP_Corstone-1000`, you must disable the Cryptocell component therein, else you will see a licensing error.

To do this, add the parameter `se.cryptocell.DISABLE_DEVICE=1` to your launch command:

```console
FVP_Corstone-1000 -C se.cryptocell.DISABLE_DEVICE=1 ...
```

## Arm Virtual Hardware 3rd Party {#thirdparty}

A valid [Arm AVH account](https://www.arm.com/resources/contact-us/virtual-hardware-boards) is required.

When you login to the [AVH Dashboard](https://app.avh.arm.com) you can create virtual devices based on a growing library of real boards from Arm partners. To get started, a selection of [Quickstart Guides](https://intercom.help/arm-avh/en/collections/3380338-getting-started#quickstart) are provided to launch the particular platforms with ready made example images.
When you login to the [AVH Dashboard](https://app.avh.arm.com) you can create virtual devices based on a growing library of real devices and boards from Arm partners. Supported targets include:

* STMU5 IoT Discovery Kit
* Raspberry Pi 4
* i.MX 8M Plus
* i.MX 93

A selection of [Quickstart Guides](https://developer.arm.com/documentation/107660/latest/Getting-Started) are provided to launch the platforms with ready made example images.
73 changes: 73 additions & 0 deletions content/install-guides/fvps-on-macos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
### Title the install tools article with the name of the tool to be installed
### Include vendor name where appropriate
title: AVH FVPs on MacOS

### Optional additional search terms (one per line) to assist in finding the article
additional_search_terms:
- AVH
- Keil
- FVP
- Mac

### Estimated completion time in minutes (please use integer multiple of 5)
minutes_to_complete: 15

author_primary: Christopher Seidl

### Link to official documentation
official_docs: https://github.com/Arm-Examples/FVPs-on-Mac/blob/main/README.md


### PAGE SETUP
weight: 1 # Defines page ordering. Must be 1 for first (or only) page.
tool_install: true # Set to true to be listed in main selection page, else false
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
---
This guide is intended to get you up and running with the [Arm Virtual Hardware (AVH) Fixed Virtual Platforms (FVPs)](https://www.arm.com/products/development-tools/simulation/virtual-hardware) on MacOS. For a thorough review of all options, refer to the offical documentation.

## Prerequisites

[Install Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/).

If this is for commercial use, you might require a paid subscription.

## Clone the repo

Open a terminal and set the working directory to the location in which you would like to store the Fast Model. Then run:

```sh
git clone https://github.com/Arm-Examples/FVPs-on-Mac.git
```

This creates the subdirectory `FVPs-on-Mac` in the current working directory.

## Build the Docker wrapper

Run the build script to create the Docker image and populate the `bin` folder with model wrappers:

```sh
./build.sh
```


When this completes, inspect the created `bin` folder containing symlinks to `fvp.sh`.
These wrappers can be used exactly like any native model executable:

```sh
./bin/FVP_MPS2_Cortex-M3 --version
```

## Expose models to local environment

Add `$(pwd)/FVPs-on-Mac/bin` to `PATH` environment:

```sh
export PATH=$PATH:$(pwd)/FVPs-on-Mac/bin
```

Put this to your `~/.zshrc` to make it permanent.

For further information, refer to the [repository's README.md file](https://github.com/Arm-Examples/FVPs-on-Mac).
4 changes: 2 additions & 2 deletions content/install-guides/ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ Feel free to seek out additional SSH tutorials or add more information to this p

SSH is a client server application.

An SSH server, also called the SSH deamon, runs on a remote machine.
An SSH server, also called the SSH daemon, runs on a remote machine.

An SSH client runs on the local machine (the one you are typing on) and connects to the remote daemon.

### Decide if the SSH daemon is already running

For SSH to work, the SSH deamon must be running on the remote machine. Many Linux distributions install and run the SSH daemon automatically.
For SSH to work, the SSH daemon must be running on the remote machine. Many Linux distributions install and run the SSH daemon automatically.

To find out if the SSH daemon is already running running use the `ps` command.
```console
Expand Down
12 changes: 6 additions & 6 deletions content/install-guides/streamline.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ For other use cases, use Arm Streamline as provided with Arm Development Studio.

Download the appropriate package from the [Product Download Hub](https://developer.arm.com/downloads).

- [Arm Mobile Studio](https://developer.arm.com/downloads/view/MOBST-PRO0)
- [Arm Performance Studio](https://developer.arm.com/downloads/view/MOBST-PRO0)
- [Arm Development Studio](https://developer.arm.com/downloads/view/DEVST-GLD0)

Arm Performance Studio supports Windows, Linux, and MacOS hosts.
Expand All @@ -58,17 +58,17 @@ Arm Development Studio supports Windows and Linux hosts.

## Installation

#### Arm Performance Studio
### Arm Performance Studio

Install instructions are given in the Performance Studio [Release Notes](https://developer.arm.com/documentation/107649).
Full install instructions are given in section 3 of the Performance Studio [Release Notes](https://developer.arm.com/documentation/107649).

See also the Arm Performance Studio [install guide](../ams/).

If working with an Android target, you must also install Android Debug Bridge (`adb`) available with [Android SDK platform tools](https://developer.android.com/studio/releases/platform-tools).

Add the Android SDK platform tools directory to your `PATH` environment variable.

See also the Arm Performance Studio [install guide](../ams/).

#### Arm Development Studio
### Arm Development Studio

Install Arm Development Studio using the instructions in the [Arm Development Studio Getting Started Guide](https://developer.arm.com/documentation/101469/latest/Installing-and-configuring-Arm-Development-Studio).

Expand Down
2 changes: 1 addition & 1 deletion content/install-guides/topdown-tool.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
### Title the install tools article with the name of the tool to be installed
### Include vendor name where appropriate
title: Telemetry Solution
title: Telemetry Solution (Topdown Methodology)

### Optional additional search terms (one per line) to assist in finding the article
additional_search_terms:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ After the keyword is heard, you will see the `Please speak...` message indicatin
![the terminal, listening for you to speak after hearing the keyword](./terminal2.png)

{{% notice Note %}}
The errors are normal and do not effect the operation of the bot.
The errors are normal and do not affect the operation of the bot.
{{% /notice %}}

You have constructed a bot on your Raspberry Pi which wakes up on a keyword and answers your questions.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Build a Windows on Arm native application with .NET framework
title: Build a Windows on Arm native application with .NET

minutes_to_complete: 20

Expand Down
8 changes: 4 additions & 4 deletions content/learning-paths/microcontrollers/asm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ minutes_to_complete: 60

author_primary: Ronan Synnott

who_is_this_for: This is an introductory topic for software developers interested programming microcontrollers with C/Assembly.
who_is_this_for: This is an introductory topic for software developers who are interested in programming microcontrollers with C/Assembly.

learning_objectives:
- Write a mixed C program and assembly language subroutines for the microcontroller. 
- Call the subroutines written in assembly in a C function. 
- Use Arm register calling conventions when writing subroutines in assembly language. 
- Step through the code to understand operation
- Step through the code to understand operation.

prerequisites:
- Some familiarity with C/Assembly
- A Windows computer to run Keil MDK
- Some familiarity with C/Assembly.
- A Windows computer to run Keil MDK.

### Tags
skilllevels: Introductory
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This section provides an overview of the most common errors you might encounter
- [Linker warning L6314W](#linker-warning-l6314w)
- [Linker errors using the RTX5 library](#linker-errors-using-the-rtx5-library)
- [Run-time exceptions due to wrong processor mode in RTX5](#run-time-exceptions-due-to-wrong-processor-mode-in-rtx5)

- [Use of undeclared identifier CoreDebug error](#use-of-undeclared-identifier-coredebug-error)

### Missing device

Expand Down Expand Up @@ -196,3 +196,56 @@ If an exception occurs at run-time, check the "Default Processor Mode for Thread
Please note that you can also set the processor mode for threads individually (by setting the [osThreadPrivileged](https://arm-software.github.io/CMSIS_6/v6.0.0/RTOS2/group__CMSIS__RTOS__ThreadMgmt.html#ga7c2b7db42d23e4f56132e0ed739d02e5) define in the [osThread_Attr_t](https://arm-software.github.io/CMSIS_6/v6.0.0/RTOS2/group__CMSIS__RTOS__ThreadMgmt.html))
{{% /notice %}}

### Use of undeclared identifier CoreDebug error

Some symbol names were changed in CMSIS v6 which might lead to the following error:

```txt
/fsl_common_arm.c:126:9: error: use of undeclared identifier 'CoreDebug'
126 | CoreDebug->DEMCR |= CoreDebug_DEMCR_TRCENA_Msk;
| ^
```

This results in failing builds.

{{% notice Note %}}
In general, you should ask the provider of the software component that fails because of using legacy symbols to provide an updated version that is compliant to CMSIS v6.
{{% /notice %}}

If an update is not possible or pushed out, we have created a header file that patches the changes and allows you to run older software with CMSIS v6.

{{% notice Resolution for Csolution-based projects%}}
1. Please download this [header file](https://armkeil.blob.core.windows.net/developer/Files/downloads/cmsis/cmsis_5_to_6_patch.h) to a `<known_location>`.

1. In the `*.cproject.yml` file of your project, under the `add_path:` keyword, add `<known_location>`. Example:

```yml
project:
add-path:
- <known_location> #directory of any files you would like to include.
```

3. In the `*.cproject.yml` file of your project, under the `misc:` keyword, add the pre-include command for the compiler you are using. Example:

```yml
project:
misc:
- for-compiler: AC6
C:
- --include cmsis_5_to_6_patch.h
CPP:
- --include cmsis_5_to_6_patch.h
```

For more information on how to configure your *.cproject.yml file, please refer to [YML-Input-Format.md](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md#project). It has a comprehensive explanation of how to write your own *.cproject.yml along with some examples.
{{% /notice %}}

{{% notice Resolution for µVision projects%}}
1. Please download this [header file](https://armkeil.blob.core.windows.net/developer/Files/downloads/cmsis/cmsis_5_to_6_patch.h) to a `<known_location>`. A good place would be the project directory.

1. Go to **Project - Options for Target** and switch to the **C/C++ (AC6)** tab. Add `-include <known_location>\cmsis_5_to_6_patch.h` to the **Misc Controls**:

![Add patch file](./CoreDebug_uvision.png)

1. Rebuild the project.
{{% /notice %}}
Loading
Loading