[PATCH v2 1/3] coresight: tmc: Add missing doc of tmc_drvdata::reading

[Jonathan Cameron]

On Fri, 20 Jun 2025 15:54:10 +0800
Junhao He <hejunhao3 at huawei.com> wrote:

> From: Yicong Yang <yangyicong at hisilicon.com>
> 
> tmc_drvdata::reading is used to indicate whether a reading process
> is performed through /dev/xyz.tmc. Document it.
> 
> Reviewed-by: James Clark <james.clark at linaro.org>
> Signed-off-by: Yicong Yang <yangyicong at hisilicon.com>
> Signed-off-by: Junhao He <hejunhao3 at huawei.com>
> ---
>  drivers/hwtracing/coresight/coresight-tmc.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/hwtracing/coresight/coresight-tmc.h b/drivers/hwtracing/coresight/coresight-tmc.h
> index 6541a27a018e..3ca0d40c580d 100644
> --- a/drivers/hwtracing/coresight/coresight-tmc.h
> +++ b/drivers/hwtracing/coresight/coresight-tmc.h
> @@ -220,6 +220,7 @@ struct tmc_resrv_buf {
>   * @pid:	Process ID of the process that owns the session that is using
>   *		this component. For example this would be the pid of the Perf
>   *		process.
> + * @reading:	buffer's in the reading through "/dev/xyz.tmc" entry
Hi,

Perhaps reword:

"buffer is being read through "/dev/xyz.tmc" entry" or
"buffer read in progress through "/dev/xyz.tmc" entry"

I've not checked what this actually means - just looking at what you have here.

>   * @stop_on_flush: Stop on flush trigger user configuration.
>   * @buf:	Snapshot of the trace data for ETF/ETB.
>   * @etr_buf:	details of buffer used in TMC-ETR