From 32d04368c4b508f44e6ee13a9ea78ef016eeb01a Mon Sep 17 00:00:00 2001 From: Mika Liljeberg Date: Fri, 3 Nov 2023 14:42:24 +0200 Subject: [PATCH] firmware-api: fix typos in the documentation Fix a few typos in the HSP-VM mailbox message documentation. Jira CAMERASW-14056 Change-Id: I02018f48740555b35f4a089c0d055f343b1623ea Reviewed-on: https://git-master.nvidia.com/r/c/tegra/camera/firmware-api/+/3010011 Signed-off-by: Mika Liljeberg Reviewed-on: https://git-master.nvidia.com/r/c/linux-nv-oot/+/3015131 (cherry picked from commit 13d815a11a3f9715aed8d9f1ab8f6e0208e630e0) Reviewed-on: https://git-master.nvidia.com/r/c/linux-nv-oot/+/3018634 Reviewed-by: Matti Ryttylainen Reviewed-by: Pekka Pessi Reviewed-by: Frank Chen GVS: Gerrit_Virtual_Submit --- include/soc/tegra/camrtc-commands.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/include/soc/tegra/camrtc-commands.h b/include/soc/tegra/camrtc-commands.h index 7d7d4dfb..9612a743 100644 --- a/include/soc/tegra/camrtc-commands.h +++ b/include/soc/tegra/camrtc-commands.h @@ -124,8 +124,8 @@ * * If no IVC group bits are set (sender likely does not support the * optimization) or the receiver itself does not support the - * optimization, it must always check all IVC channels for incoming - * messages after receiving a HSP message. + * optimization, the receiver must always inspect all IVC channels for + * state changes and incoming messages after receiving a HSP message. * * Other bits in the 32-bit @ref HspSsReg "shared semaphore register" * are reserved for additional signalling between CCPLEX VM and RCE. @@ -310,7 +310,9 @@ /** * @brief CH_SETUP message * - * The CAMRTC_CH_SETUP message is sent when VM wants to + * The CAMRTC_CH_SETUP message is sent when VM wants to set + * up shared memory areas for IVC channels, debug trace, or + * other purposes. * * @pre @ref CAMRTC_HSP_HELLO exchange has been completed. * @ref CAMRTC_HSP_PROTOCOL exchange is recommended to @@ -428,7 +430,7 @@ * * The CAMRTC_HSP_PROTOCOL message is used to exchange HSP-VM * protocol versions between client and RCE FW. While the message - * is optional, it is recommended to use it after the HELLOW + * is optional, it is recommended to use it after the HELLO * exchange in order to enable all supported protocol features. * * @pre @ref CAMRTC_HSP_HELLO exchange has been completed.