# r-profile-user-guide-examples

**Repository Path**: mirrors_ARM-software/r-profile-user-guide-examples

## Basic Information

- **Project Name**: r-profile-user-guide-examples
- **Description**: Example software projects to accompany Armv8-R architecture User Guides
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-17
- **Last Updated**: 2026-08-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
SPDX-FileCopyrightText: Copyright 2022-2025 Arm Limited <open-source-office@arm.com>
SPDX-License-Identifier: MIT
-->

# Armv8-R Architecture - User Guide Examples

## Introduction

The Arm®v8-R AArch64 architecture defines many aspects of a Cortex-R processor's behavior. Some major architecture extension categories include:

- Programmers' model
- Exception model
- Memory model
- Security extension
- Debug components

For more details on Armv8-R architecture rules and its pseudocode, please refer to [Arm Architecture Reference Manual Supplement - Armv8, for Armv8-R AArch64 architecture profile](https://developer.arm.com/documentation/ddi0600/latest/) and associated [R-Profile Architecture content on developer.arm.com](https://developer.arm.com/Architectures/R-Profile%20Architecture)

To assist users in understanding the Armv8-R architecture features, a set of user guides are developed to describe the architecture extension categories shown above. These user guides are written in simple language such that it is easy to learn and help users understand the architectural features along with example project source code (wherever applicable). The user guides also provide details on:

- Linkage between an architecture feature and its usage in the software
- Guidelines/recommendations for Software developers (Do's and Dont's)

User guides for Armv8-R architecture are available at [Learn The Architecture - R-Profile](https://www.arm.com/architecture/learn-the-architecture/r-profile). This repository contains example projects to give a practical explanation of architecture feature usage, some of which correspond with R-profile user guides. 

## Project Structure

The example software projects are organised as per either their architecture extension category or association with a specific architecture user guide.

| Architecture category | User Guide | Chapter | Folder name |
| --------------------- | -----------| --------| ------------| 
| Arm®v8-R AArch64 architecture Programmers' Model | [Arm Cortex-R82AE Processor Technical Reference Manual](https://developer.arm.com/documentation/101550/latest/) | [Armv8-R Programmers Model](https://developer.arm.com/documentation/101550/0001/Programmers--model) | - |
| R82 Boot | [Booting the Cortex-R82 Guide](https://developer.arm.com/documentation/109917/latest/) | - | [Cortex R82 Boot Code/](cortex_r82_boot_code) |


## Additional Notes

- The example projects are developed to demonstrate architectural concepts and features. These example projects should not be used as a test to validate all aspects of a feature.
- The example projects can be built with Arm Compiler 6 and GCC tool chain. Refer to the individual example project's Readme file for necessary settings.
- The tool chain version details are captured in each example project's Readme.md file. Though the example may work using other versions of a tool chain, it may not be verified.

## License
Example projects are licensed under the MIT2.0 license. Please see the [LICENSE](LICENSE)

## Feedback and Support

- For feedback and support on these example projects, use the GitHub [Issue Tracker](https://github.com/ARM-software/r-profile-user-guide-examples/issues) that is associated with this repository.
- For support on Armv8-R architecture features, follow the [Arm Community architectures and processors forum](https://community.arm.com/support-forums/f/architectures-and-processors-forum) using the Cortex-R tag where relevant.
- Arm licensees may contact Arm directly through their partner managers.


----

*Copyright 2022-2025 Arm Limited and/or its affiliates*