aboutsummaryrefslogtreecommitdiff
path: root/include/tpm-common.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/tpm-common.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value. find . -name '*.c' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; find . -name '*.h' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'include/tpm-common.h')
-rw-r--r--include/tpm-common.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/include/tpm-common.h b/include/tpm-common.h
index 998b4fbb415..a28629e7013 100644
--- a/include/tpm-common.h
+++ b/include/tpm-common.h
@@ -220,7 +220,7 @@ int tpm_close(struct udevice *dev);
* tpm_clear_and_reenable() - Force clear the TPM and reenable it
*
* @dev: TPM device
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
u32 tpm_clear_and_reenable(struct udevice *dev);
@@ -230,7 +230,7 @@ u32 tpm_clear_and_reenable(struct udevice *dev);
* @dev: Device to check
* @buf: Buffer to put the string
* @size: Maximum size of buffer
- * @return length of string, or -ENOSPC it no space
+ * Return: length of string, or -ENOSPC it no space
*/
int tpm_get_desc(struct udevice *dev, char *buf, int size);
@@ -263,14 +263,14 @@ int tpm_xfer(struct udevice *dev, const u8 *sendbuf, size_t send_size,
* Initialize TPM device. It must be called before any TPM commands.
*
* @dev - TPM device
- * @return 0 on success, non-0 on error.
+ * Return: 0 on success, non-0 on error.
*/
int tpm_init(struct udevice *dev);
/**
* Retrieve the array containing all the v1 (resp. v2) commands.
*
- * @return a struct cmd_tbl array.
+ * Return: a struct cmd_tbl array.
*/
#if defined(CONFIG_TPM_V1)
struct cmd_tbl *get_tpm1_commands(unsigned int *size);
@@ -296,7 +296,7 @@ static inline struct cmd_tbl *get_tpm2_commands(unsigned int *size)
* it supports.
*
* @dev: TPM device
- * @return version number (TPM_V1 or TPMV2)
+ * Return: version number (TPM_V1 or TPMV2)
*/
enum tpm_version tpm_get_version(struct udevice *dev);