diff options
| author | Boyan Karatotev <boyan.karatotev@arm.com> | 2026-06-22 14:53:13 +0000 |
|---|---|---|
| committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2026-06-22 14:53:13 +0000 |
| commit | 552ca6fa44d0cb0225346f0bd0272823af7e30ea (patch) | |
| tree | 0e3de443da956fb56d0ecb91bd131bb1b6d997ae /docs | |
| parent | 0b28b47110ff9c7fd7bc2435b1bcf268e2c4cc9f (diff) | |
| parent | 88c90d25db89cb02943245df7d186639bb303661 (diff) | |
| download | arm-trusted-firmware-552ca6fa44d0cb0225346f0bd0272823af7e30ea.tar.gz arm-trusted-firmware-552ca6fa44d0cb0225346f0bd0272823af7e30ea.zip | |
Merge "fix(docs): correct plat_get_soc_name() documentation" into integration
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/porting-guide.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/porting-guide.rst b/docs/porting-guide.rst index 9d7f81a31..9dcb72f93 100644 --- a/docs/porting-guide.rst +++ b/docs/porting-guide.rst @@ -1523,17 +1523,17 @@ Function : plat_get_soc_name() :: - Argument : char ** + Argument : char * Return : int32_t The plat_get_soc_name() function allows a platform to expose the SoC name to -the firmware. It takes a pointer to a character pointer as an argument, which -must be set to point to a static, null-terminated SoC name string. The string -must be encoded in UTF-8 and should use only printable ASCII characters for -compatibility. It must not exceed 136 bytes, including the null terminator. On -success, the function returns SMC_ARCH_CALL_SUCCESS. If the platform does not -support SoC name retrieval, it returns SMC_ARCH_CALL_NOT_SUPPORTED. This API -allows platforms to support SoC name queries via SMCCC_ARCH_SOC_ID. +the firmware. It takes a character pointer as an argument, which should be +filled with the null-terminated SoC name string. The string must be encoded +in UTF-8 and should use only printable ASCII characters for compatibility. +It must not exceed 136 bytes, including the null terminator. On success, the +function returns SMC_ARCH_CALL_SUCCESS. If the platform does not support SoC +name retrieval, it returns SMC_ARCH_CALL_NOT_SUPPORTED. This API allows +platforms to support SoC name queries via SMCCC_ARCH_SOC_ID. Function : plat_is_smccc_feature_available() ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
