Re: [PATCH v2] tee: qcomtee: fix kernel-doc warnings
Jens Wiklander via OP-TEE <[email protected]>
| Newsgroups | org.trustedfirmware.lists.op-tee,org.kernel.vger.linux-arm-msm,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <CAGgiveVhaDdh994HP42=kFEvt5=111QdW5Xzi0CWCe=kat5tQw@mail.gmail.com> |
Hi, On Fri, Aug 21, 2026 at 7:03 AM Babanpreet Singh <[email protected]> wrote: > > Fix kernel-doc issues present since the driver was added in commit > d6e290837e50 ("tee: add Qualcomm TEE driver"): > > - async_release() documents its second parameter as @msg, but the > parameter is named async_msg (msg is a local variable); > - struct qcomtee_msg_object_invoke documents member @ctx, but the > member is named cxt; > - enum qcomtee_arg_type leaves QCOMTEE_ARG_TYPE_NR undescribed. > > The cxt spelling is part of the QTEE message format and is used > throughout the driver; struct qcomtee_msg_callback in the same header > already documents it as @cxt, so the comment is corrected rather than > the member. > > No functional changes. > > Fixes: d6e290837e50 ("tee: add Qualcomm TEE driver") > Reviewed-by: Amirreza Zarrabi <[email protected]> > Assisted-by: Claude:claude-opus-5 [kernel-doc] > Signed-off-by: Babanpreet Singh <[email protected]> > --- > v2: > - add the Fixes tag Jens asked for; no code changes > - pick up Amirreza's Reviewed-by > > v1: https://lore.kernel.org/all/[email protected]/ > > drivers/tee/qcomtee/async.c | 4 ++-- > drivers/tee/qcomtee/qcomtee_msg.h | 2 +- > drivers/tee/qcomtee/qcomtee_object.h | 1 + > 3 files changed, 4 insertions(+), 3 deletions(-) Looks good. I'm picking this up. Cheers, Jens > > diff --git a/drivers/tee/qcomtee/async.c b/drivers/tee/qcomtee/async.c > index 31bff4309e672..5849e51612033 100644 > --- a/drivers/tee/qcomtee/async.c > +++ b/drivers/tee/qcomtee/async.c > @@ -97,10 +97,10 @@ static void qcomtee_get_async_buffer(struct qcomtee_object_invoke_ctx *oic, > /** > * async_release() - Process QTEE async release requests. > * @oic: context used for the current invocation. > - * @msg: async message for object release. > + * @async_msg: async message for object release. > * @size: size of the async buffer available. > * > - * Return: Size of the outbound buffer used when processing @msg. > + * Return: Size of the outbound buffer used when processing @async_msg. > */ > static size_t async_release(struct qcomtee_object_invoke_ctx *oic, > struct qcomtee_async_msg_hdr *async_msg, > diff --git a/drivers/tee/qcomtee/qcomtee_msg.h b/drivers/tee/qcomtee/qcomtee_msg.h > index 878f70178a5b6..5d7b21fdd3688 100644 > --- a/drivers/tee/qcomtee/qcomtee_msg.h > +++ b/drivers/tee/qcomtee/qcomtee_msg.h > @@ -112,7 +112,7 @@ union qcomtee_msg_arg { > > /** > * struct qcomtee_msg_object_invoke - Direct object invocation message. > - * @ctx: object ID hosted in QTEE. > + * @cxt: object ID hosted in QTEE. > * @op: operation for the object. > * @counts: number of different types of arguments in @args. > * @args: array of arguments. > diff --git a/drivers/tee/qcomtee/qcomtee_object.h b/drivers/tee/qcomtee/qcomtee_object.h > index 8b4401ecad48c..d5de02dcef3b9 100644 > --- a/drivers/tee/qcomtee/qcomtee_object.h > +++ b/drivers/tee/qcomtee/qcomtee_object.h > @@ -74,6 +74,7 @@ enum qcomtee_object_type { > * @QCOMTEE_ARG_TYPE_OO: output object (OO). > * @QCOMTEE_ARG_TYPE_IB: input buffer (IB). > * @QCOMTEE_ARG_TYPE_IO: input object (IO). > + * @QCOMTEE_ARG_TYPE_NR: number of argument types. > * > * Use the invalid type to specify the end of the argument array. > */ > > base-commit: 2d2338c93da79b3bfe4b6099a931d9468d539952 > -- > 2.43.0 >