..
 # SPDX-FileCopyrightText: <text>Copyright 2024-2025 Arm Limited and/or its
 # affiliates <open-source-office@arm.com></text>
 #
 # SPDX-License-Identifier: MIT

########
Overview
########

************
Introduction
************

The Arm Automotive Solutions Software Reference Stack contains a collection of
resources to provide a representative view of typical compute subsystems that
can be designed and implemented using specific generations of Arm Reference
Designs, targeting the automotive sector.

This document contains sections for :ref:`rd-aspen-index`.

********
Audience
********

The intended target audience of this document are software, hardware, and system
engineers who are planning to evaluate and use Arm Automotive Solutions.

It describes how to build and run images for Arm automotive reference designs
using the Yocto Project build framework. Basic instructions about the Yocto
Project can be found in the :link_subs:`common:yocto-q-start`.

In addition to having Yocto related knowledge, the target audience also needs
to have a certain understanding of the following technologies:


  * :link_subs:`rd-aspen:tf-m-doc`

  * :link_subs:`rd-aspen:scp-firmware`

  * :link_subs:`common:zephyr`

  * :link_subs:`rd-aspen:tf-a-doc`

  * :link_subs:`rd-aspen:op-tee-doc`

  * :link_subs:`rd-aspen:trusted-services-doc`

  * :link_subs:`rd-aspen:u-boot`

  * :link_subs:`common:xen-hypervisor`

Documentation structure
=======================

  * :ref:`User Guide <rd-aspen/user_guide/index:User Guide>`

    Provides guidance for configuring, building, and deploying the solutions
    on the FVP and running and validating the supported functionalities. Also
    provides instructions on additional, user-defined image customization.

  * :ref:`Solution Design <rd-aspen/design/index:Solution Design>`

    Provides more advanced developer-focused details of each solution, its
    implementation, and dependencies.

  * :ref:`License <license_link:License>`

    Defines the license under which Arm Automotive Solutions is provided.

  * :ref:`Release Notes <releasenotes:Release Notes>`

    Documents new features, bug fixes, limitations, and any other changes
    provided under each Arm Automotive Solutions release.


**********************************
Safety and security considerations
**********************************

Arm Automotive Solutions is a public example software project that tracks and
pulls upstream components, incorporating their respective security fixes
published over time. Arm partners are responsible for ensuring that the
components they use contain all the required security fixes, if and when they
deploy a product derived from Arm reference solutions.

********************
Repository structure
********************

The Arm Automotive Solutions repository (|arm auto solutions repository|) is
structured as follows:

  * ``sw-ref-stack``:

    * ``yocto``

      Directory implementing the Yocto layer as well as kas build configuration
      files.

    * ``components``

      Directory containing source code for components which can either be used
      directly or as part of the Yocto layer.

    * ``documentation``

      Directory which contains the documentation sources, defined in
      ReStructuredText (``.rst``) format for building via ``sphinx``.

    * ``test_automation``

      Directory containing the Test Automation solution used for validating our
      Software Reference Stack. It provides reusable test modules, utilities,
      and supporting configurations. This is however not yet integrated with
      the build system.

******************
Repository license
******************

The repository's standard license is the MIT license (more details in
:ref:`license_link:License`), under which most of the repository's content is
provided. Exceptions to this standard license relate to files that represent
modifications to externally licensed works (for example, patch files). These
files might therefore be included in the repository under alternative licenses in
order to be compliant with the licensing requirements of the associated external
works.

The Arm corporate logo and words marked with ® or ™ are registered trademarks
or trademarks of Arm Limited (or its affiliates) in the US and/or elsewhere.
All rights reserved. Other brands and names mentioned in this document might be
the trademarks of their respective owners.
Please follow Arm’s trademark usage guidelines at :link_subs:`common:arm-trademark`.

*********************************
Contributions and issue reporting
*********************************

This project has not put in place a process for contributions currently.

To report issues with the repository such as potential bugs, security concerns,
or feature requests, submit an Issue via :link_subs:`common:gitlab-issues`,
following the project's template.

********************
Feedback and support
********************

To request support contact Arm at support@arm.com. Arm licensees can
also contact Arm via their partner managers.