Djam/arm-trusted-firmware
1
0
Fork 0
mirror of https://github.com/ARM-software/arm-trusted-firmware.git synced 2025-04-08 05:43:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor(docs): added versioning to smccc services

Browse source 
With addition of vendor-specific el3 monitor service calls debugfs and
pmf are moved from arm-sip to vendor-specific el3 range.

Going forward any changes to SMCCC services can be captured from docs
file table.

Use one FID allocated per sub-feature to track changes in sub-feature.
Modify top level version only when we break version probing or
discovery.

Change-Id: I14ceeab79f29ae57a5d7c523147f6ecaa5574f79
Signed-off-by: Govindraj Raja <govindraj.raja@arm.com>
This commit is contained in:
Govindraj Raja 2024-03-19 17:46:22 -05:00
parent 42cbefc727
commit 320fb2939b
2 changed files with 31 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/components/arm-sip-service.rst
View file

@ -20,6 +20,15 @@ The Arm SiP implementation offers the following services:
Source definitions for Arm SiP service are located in the ``arm_sip_svc.h`` header
file.
+----------------------------+----------------------------+---------------------------------------+
| ARM_SIP_SVC_VERSION_MAJOR | ARM_SIP_SVC_VERSION_MINOR | Changes |
+============================+============================+=======================================+
| 1 | 0 | Move DebugFS and PMF to the new vendor|
| | | specific FID range. The old FID range |
| | | for these services are deprecated |
+----------------------------+----------------------------+---------------------------------------+
*Table 1: Showing different versions of arm-sip-service and changes done with each version*
Execution State Switching service
---------------------------------

23
docs/components/ven-el3-service.rst
View file

@ -32,10 +32,31 @@ Vendor-specific EL3 monitor services are as follows:
+-----------------------------------+ Measurement Framework | | 2 - 15 are reserved for future expansion. |
| 0xC7000020 - 0xC700002F (SMC64) | (PMF) | |
+-----------------------------------+-----------------------+---------------------------------------------+
| 0x87000030 - 0x8700FFFF (SMC32) | Reserved | | reserved for future expansion |
+-----------------------------------+ | |
| 0xC7000030 - 0xC700FFFF (SMC64) | | |
+-----------------------------------+-----------------------+---------------------------------------------+
Source definitions for vendor-specific EL3 Monitor Service Calls are located in
Source definitions for vendor-specific EL3 Monitor Service Calls used by TF-A are located in
the ``ven_el3_svc.h`` header file.
+----------------------------+----------------------------+--------------------------------+
| VEN_EL3_SVC_VERSION_MAJOR | VEN_EL3_SVC_VERSION_MINOR | Changes |
+============================+============================+================================+
| 1 | 0 | Added Debugfs and PMF services.|
+----------------------------+----------------------------+--------------------------------+
*Table 1: Showing different versions of Vendor-specific service and changes done with each version*
Each sub service will have its own version, one FID allocated for sub service version.
Some ground rules when one should update top level version.
- VEN_EL3_SVC_VERSION_MAJOR is incremented when any of the sub service version discovery
FID changes or the FID that was allocated for discovery changes. So any breaking subfeature
discovery changes will lead to major version update.
- VEN_EL3_SVC_VERSION_MINOR is incremented when we add a new FID or a new sub service.
For example adding an new monitor service at 0x30, Debugfs starts at 0x10 and PMF
starts at 0x20 next one will start at 0x30, this will need a update to minor version.
Performance Measurement Framework (PMF)
---------------------------------------