About this document¶

Release information¶

Prior to version 1.0.1, the definitions in this specification were released as part of Arm® Platform Security Architecture Firmware Framework [PSA-FFM].

The change history table lists the changes that have been made to this document.

Table 1 Document revision history¶
Date	Version	Confidentiality	Change
October 2022	1.0.1	Non-confidential	Definition of status codes moved to a separate specification. Incorporated some error codes from other PSA Certified APIs. Relicensed as open source under CC BY-SA 4.0.
December 2022	1.0.2	Non-confidential	Fixed whitespace error in status code definitions
January 2024	1.0.3	Non-confidential	Status code clarifications

For a detailed list of changes, see Change history.

PSA Certified Status code API

License¶

Text and illustrations

Text and illustrations in this work are licensed under Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). To view a copy of the license, visit creativecommons.org/licenses/by-sa/4.0.

Grant of patent license. Subject to the terms and conditions of this license (both the CC BY-SA 4.0 Public License and this Patent License), each Licensor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Licensed Material, where such license applies only to those patent claims licensable by such Licensor that are necessarily infringed by their contribution(s) alone or by combination of their contribution(s) with the Licensed Material to which such contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Licensed Material or a contribution incorporated within the Licensed Material constitutes direct or contributory patent infringement, then any licenses granted to You under this license for that Licensed Material shall terminate as of the date such litigation is filed.

The Arm trademarks featured here are registered trademarks or trademarks of Arm Limited (or its subsidiaries) in the US and/or elsewhere. All rights reserved. Please visit arm.com/company/policies/trademarks for more information about Arm’s trademarks.

About the license

The language in the additional patent license is largely identical to that in section 3 of the Apache License, Version 2.0 (Apache 2.0), with two exceptions:

Changes are made related to the defined terms, to align those defined terms with the terminology in CC BY-SA 4.0 rather than Apache 2.0 (for example, changing “Work” to “Licensed Material”).
The scope of the defensive termination clause is changed from “any patent licenses granted to You” to “any licenses granted to You”. This change is intended to help maintain a healthy ecosystem by providing additional protection to the community against patent litigation claims.

To view the full text of the Apache 2.0 license, visit apache.org/licenses/LICENSE-2.0.

Source code

Source code samples in this work are licensed under the Apache License, Version 2.0 (the “License”); you may not use such samples except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

References¶

This document refers to the following documents.

Table 2 Documents referenced by this document¶
Ref	Document Number	Title
[PSA-FFM]	DEN 0063	Arm® Platform Security Architecture Firmware Framework. developer.arm.com/documentation/den0063.html
[TF-M]		trustedfirmware.org, Trusted Firmware-M. git.trustedfirmware.org/trusted-firmware-m.git/about/

Terms and abbreviations¶

This document uses the following terms and abbreviations.

Table 3 Terms and abbreviations¶
Term	Meaning
Implementation Defined	Behavior that is not defined by the this specification, but is defined and documented by individual implementations. Software developers can choose to depend on IMPLEMENTATION DEFINED behavior, but must be aware that their code might not be portable to another implementation.
Programmer error	An error that is caused by the misuse of a programming interface. A PROGRAMMER ERROR is in the caller of the interface, but it is detected by the implementer of the interface.
Root of Trust (RoT)	This is the minimal set of software, hardware and data that is implicitly trusted in the platform — there is no software or hardware at a deeper level that can verify that the Root of Trust is authentic and unmodified.
Root of Trust Service (RoT Service)	A set of related security operations that are implemented in a Root of Trust.
RoT	See Root of Trust.
RoT Service	See Root of Trust Service.
Secure Partition Manager (SPM)	Part of Arm® Platform Security Architecture Firmware Framework [PSA-FFM] that is responsible for isolating software in Partitions, managing the execution of software within Partitions, and providing communication between Partitions.
SPM	See Secure Partition Manager.

Conventions¶

Typographical conventions¶

The typographical conventions are:

italic

Introduces special terminology, and denotes citations.

monospace

Used for assembler syntax descriptions, pseudocode, and source code examples.

Also used in the main text for instruction mnemonics and for references to other items appearing in assembler syntax descriptions, pseudocode, and source code examples.

small capitals

Used for some common terms such as implementation defined.

Used for a few terms that have specific technical meanings, and are included in the Terms and abbreviations.

Red text

Indicates an open issue.

Blue text

Indicates a link. This can be

A cross-reference to another location within the document
A URL, for example example.com

Numbers¶

Numbers are normally written in decimal. Binary numbers are preceded by 0b, and hexadecimal numbers by 0x.

In both cases, the prefix and the associated value are written in a monospace font, for example 0xFFFF0000. To improve readability, long numbers can be written with an underscore separator between every four characters, for example 0xFFFF_0000_0000_0000. Ignore any underscores when interpreting the value of a number.

Feedback¶

We welcome feedback on the PSA Certified API documentation.

If you have comments on the content of this book, visit github.com/arm-software/psa-api/issues to create a new issue at the PSA Certified API GitHub project. Give:

The title (Status code API).
The number and issue (IHI 0097 1.0.3).
The location in the document to which your comments apply.
A concise explanation of your comments.

We also welcome general suggestions for additions and improvements.