[PATCH] tpm: Remove duplicate documentation

From: Jarkko Sakkinen
Date: Thu Mar 06 2025 - 14:14:00 EST


The functions already have documentation as defined in

https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt

Remove duplicate documentation in order to reduce maintainer overhead.

Signed-off-by: Jarkko Sakkinen <jarkko@xxxxxxxxxx>
---
This is posted mainly for transparency and will be picked to the next
PR an all conditions. Ack are still welcome of course.
drivers/char/tpm/tpm2-sessions.c | 30 ------------------------------
1 file changed, 30 deletions(-)

diff --git a/drivers/char/tpm/tpm2-sessions.c b/drivers/char/tpm/tpm2-sessions.c
index b70165b588ec..e7d186637664 100644
--- a/drivers/char/tpm/tpm2-sessions.c
+++ b/drivers/char/tpm/tpm2-sessions.c
@@ -1,5 +1,4 @@
// SPDX-License-Identifier: GPL-2.0
-
/*
* Copyright (C) 2018 James.Bottomley@xxxxxxxxxxxxxxxxxxxxx
*
@@ -37,35 +36,6 @@
* file and never needs to be seen even by the kernel internal user. To
* the user there's an init function tpm2_sessions_init() that needs to
* be called once per TPM which generates the NULL seed primary key.
- *
- * These are the usage functions:
- *
- * tpm2_start_auth_session() which allocates the opaque auth structure
- * and gets a session from the TPM. This must be called before
- * any of the following functions. The session is protected by a
- * session_key which is derived from a random salt value
- * encrypted to the NULL seed.
- * tpm2_end_auth_session() kills the session and frees the resources.
- * Under normal operation this function is done by
- * tpm_buf_check_hmac_response(), so this is only to be used on
- * error legs where the latter is not executed.
- * tpm_buf_append_name() to add a handle to the buffer. This must be
- * used in place of the usual tpm_buf_append_u32() for adding
- * handles because handles have to be processed specially when
- * calculating the HMAC. In particular, for NV, volatile and
- * permanent objects you now need to provide the name.
- * tpm_buf_append_hmac_session() which appends the hmac session to the
- * buf in the same way tpm_buf_append_auth does().
- * tpm_buf_fill_hmac_session() This calculates the correct hash and
- * places it in the buffer. It must be called after the complete
- * command buffer is finalized so it can fill in the correct HMAC
- * based on the parameters.
- * tpm_buf_check_hmac_response() which checks the session response in
- * the buffer and calculates what it should be. If there's a
- * mismatch it will log a warning and return an error. If
- * tpm_buf_append_hmac_session() did not specify
- * TPM_SA_CONTINUE_SESSION then the session will be closed (if it
- * hasn't been consumed) and the auth structure freed.
*/

#include "tpm.h"
--
2.48.1