diff mbox series

[v2,6/9] docs: sysfs: coresight: Add sysfs ABI documentation for TPDM

Message ID 20211209141543.21314-7-quic_jinlmao@quicinc.com (mailing list archive)
State Superseded
Headers show
Series Coresight: Add support for TPDM and TPDA | expand

Commit Message

Mao Jinlong Dec. 9, 2021, 2:15 p.m. UTC 
Add API usage document for sysfs API in TPDM driver.

Signed-off-by: Mao Jinlong <quic_jinlmao@quicinc.com>
---
 .../ABI/testing/sysfs-bus-coresight-devices-tpdm     | 12 ++++++++++++
 MAINTAINERS                                          |  1 +
 2 files changed, 13 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm

Comments

Mao Jinlong Dec. 9, 2021, 2:25 p.m. UTC | #1 
On 12/9/2021 10:15 PM, Mao Jinlong wrote:
> Add API usage document for sysfs API in TPDM driver.
>
> Signed-off-by: Mao Jinlong <quic_jinlmao@quicinc.com>
> ---
>   .../ABI/testing/sysfs-bus-coresight-devices-tpdm     | 12 ++++++++++++
>   MAINTAINERS                                          |  1 +
>   2 files changed, 13 insertions(+)
>   create mode 100644 Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> new file mode 100644
> index 000000000000..fdd0bd0e1c33
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> @@ -0,0 +1,12 @@
> +What:		/sys/bus/coresight/devices/<tpdm-name>/available_datasets
> +Date:		December 2021
> +KernelVersion	5.16
> +Contact:	Jinlong Mao or Tao Zhang
> +Description:	(Read) Show available datasets for TPDM.

Sorry, forgot to remove the document of available_datasets.

Please help to review first. I will update in next version.

> +
> +What:		/sys/bus/coresight/devices/<tpdm-name>/integration_test
> +Date:		December 2020
> +KernelVersion	5.16
> +Contact:	Jinlong Mao or Tao Zhang
> +Description:	(Write) Run integration test for tpdm.
> +
> diff --git a/MAINTAINERS b/MAINTAINERS
> index d763ba684b99..7e2898f1550b 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -15566,6 +15566,7 @@ M:	Jinlong Mao <quic_jinlmao@quicinc.com>
>   M:	Mathieu Poirier <mathieu.poirier@linaro.org>
>   M:	Suzuki K Poulose <suzuki.poulose@arm.com>
>   S:	Maintained
> +F:	Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
>   F:	Documentation/devicetree/bindings/arm/coresight-tpdm.yaml
>   F:	drivers/hwtracing/coresight/coresight-tpdm.c
>
Trilok Soni Dec. 9, 2021, 6:34 p.m. UTC | #2 
Hello Jinlong,

On 12/9/2021 6:15 AM, Mao Jinlong wrote:
> Add API usage document for sysfs API in TPDM driver.
> 
> Signed-off-by: Mao Jinlong <quic_jinlmao@quicinc.com>
> ---
>   .../ABI/testing/sysfs-bus-coresight-devices-tpdm     | 12 ++++++++++++
>   MAINTAINERS                                          |  1 +
>   2 files changed, 13 insertions(+)
>   create mode 100644 Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> new file mode 100644
> index 000000000000..fdd0bd0e1c33
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> @@ -0,0 +1,12 @@
> +What:		/sys/bus/coresight/devices/<tpdm-name>/available_datasets
> +Date:		December 2021
> +KernelVersion	5.16
> +Contact:	Jinlong Mao or Tao Zhang

Just keep one name? I am not sure if we are adding multiple names for 
other files.

> +Description:	(Read) Show available datasets for TPDM.
> +
> +What:		/sys/bus/coresight/devices/<tpdm-name>/integration_test
> +Date:		December 2020
> 

December 2021?
Mao Jinlong Dec. 10, 2021, 1:03 a.m. UTC | #3 
Hi Trilok,

Thanks for the review.

On 12/10/2021 2:34 AM, Trilok Soni wrote:
>
> Hello Jinlong,
>
> On 12/9/2021 6:15 AM, Mao Jinlong wrote:
>> Add API usage document for sysfs API in TPDM driver.
>>
>> Signed-off-by: Mao Jinlong <quic_jinlmao@quicinc.com>
>> ---
>>   .../ABI/testing/sysfs-bus-coresight-devices-tpdm     | 12 ++++++++++++
>>   MAINTAINERS                                          |  1 +
>>   2 files changed, 13 insertions(+)
>>   create mode 100644 
>> Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
>>
>> diff --git 
>> a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm 
>> b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
>> new file mode 100644
>> index 000000000000..fdd0bd0e1c33
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
>> @@ -0,0 +1,12 @@
>> +What: /sys/bus/coresight/devices/<tpdm-name>/available_datasets
>> +Date:        December 2021
>> +KernelVersion    5.16
>> +Contact:    Jinlong Mao or Tao Zhang
>
> Just keep one name? I am not sure if we are adding multiple names for 
> other files.

Yes. available_datasets need to be removed here as there is no changes 
for available_dataset.

I forgot to remove it after removing he available_dataset changes. I 
will update in next version.

>
>> +Description:    (Read) Show available datasets for TPDM.
>> +
>> +What: /sys/bus/coresight/devices/<tpdm-name>/integration_test
>> +Date:        December 2020
>>
>
> December 2021?

I will update it.
Greg Kroah-Hartman Dec. 17, 2021, 4:09 p.m. UTC | #4 
On Thu, Dec 09, 2021 at 10:15:40PM +0800, Mao Jinlong wrote:
> Add API usage document for sysfs API in TPDM driver.
> 
> Signed-off-by: Mao Jinlong <quic_jinlmao@quicinc.com>
> ---
>  .../ABI/testing/sysfs-bus-coresight-devices-tpdm     | 12 ++++++++++++
>  MAINTAINERS                                          |  1 +
>  2 files changed, 13 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> new file mode 100644
> index 000000000000..fdd0bd0e1c33
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> @@ -0,0 +1,12 @@
> +What:		/sys/bus/coresight/devices/<tpdm-name>/available_datasets
> +Date:		December 2021
> +KernelVersion	5.16

5.16 already has all of the new features, so this will not make it into
that release.

thanks,

greg k-h
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
new file mode 100644
index 000000000000..fdd0bd0e1c33
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
@@ -0,0 +1,12 @@ 
+What:		/sys/bus/coresight/devices/<tpdm-name>/available_datasets
+Date:		December 2021
+KernelVersion	5.16
+Contact:	Jinlong Mao or Tao Zhang
+Description:	(Read) Show available datasets for TPDM.
+
+What:		/sys/bus/coresight/devices/<tpdm-name>/integration_test
+Date:		December 2020
+KernelVersion	5.16
+Contact:	Jinlong Mao or Tao Zhang
+Description:	(Write) Run integration test for tpdm.
+
diff --git a/MAINTAINERS b/MAINTAINERS
index d763ba684b99..7e2898f1550b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -15566,6 +15566,7 @@  M:	Jinlong Mao <quic_jinlmao@quicinc.com>
 M:	Mathieu Poirier <mathieu.poirier@linaro.org>
 M:	Suzuki K Poulose <suzuki.poulose@arm.com>
 S:	Maintained
+F:	Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
 F:	Documentation/devicetree/bindings/arm/coresight-tpdm.yaml
 F:	drivers/hwtracing/coresight/coresight-tpdm.c