diff mbox series

[3/3] powerpc: Document details on H_HTM hcall

Message ID 20240620174614.53751-3-maddy@linux.ibm.com (mailing list archive)
State Changes Requested
Headers show
Series [1/3] powerpc/pseries: Macros and wrapper functions for H_HTM call | expand

Checks

Context Check Description
snowpatch_ozlabs/github-powerpc_ppctests success Successfully ran 8 jobs.
snowpatch_ozlabs/github-powerpc_selftests success Successfully ran 8 jobs.
snowpatch_ozlabs/github-powerpc_sparse success Successfully ran 4 jobs.
snowpatch_ozlabs/github-powerpc_clang success Successfully ran 6 jobs.
snowpatch_ozlabs/github-powerpc_kernel_qemu success Successfully ran 23 jobs.

Commit Message

Madhavan Srinivasan June 20, 2024, 5:46 p.m. UTC
Add documentation to 'papr_hcalls.rst' describing the
input, output and return values of the H_HTM hcall as
per the internal specification.

Signed-off-by: Madhavan Srinivasan <maddy@linux.ibm.com>
---
 Documentation/arch/powerpc/papr_hcalls.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Ritesh Harjani (IBM) June 22, 2024, 8:27 a.m. UTC | #1
Madhavan Srinivasan <maddy@linux.ibm.com> writes:

> Add documentation to 'papr_hcalls.rst' describing the
> input, output and return values of the H_HTM hcall as
> per the internal specification.
>
> Signed-off-by: Madhavan Srinivasan <maddy@linux.ibm.com>
> ---
>  Documentation/arch/powerpc/papr_hcalls.rst | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/Documentation/arch/powerpc/papr_hcalls.rst b/Documentation/arch/powerpc/papr_hcalls.rst
> index 80d2c0aadab5..805e1cb9bab9 100644
> --- a/Documentation/arch/powerpc/papr_hcalls.rst
> +++ b/Documentation/arch/powerpc/papr_hcalls.rst
> @@ -289,6 +289,17 @@ to be issued multiple times in order to be completely serviced. The
>  subsequent hcalls to the hypervisor until the hcall is completely serviced
>  at which point H_SUCCESS or other error is returned by the hypervisor.
>  
> +**H_HTM**
> +
> +| Input: flags, target, operation (op), op-param1, op-param2, op-param3
> +| Out: *dumphtmbufferdata*
> +| Return Value: *H_Success,H_Busy,H_LongBusyOrder,H_Partial,H_Parameter,
> +		 H_P2,H_P3,H_P4,H_P5,H_P6,H_State,H_Not_Available,H_Authority*
> +
> +H_HTM supports setup, configuration, control and dumping of Hardware Trace
> +Macro (HTM) function and its data. HTM buffer stores tracing data for functions
> +like core instruction, core LLAT and nest.
> +

Minor nit: Maybe the set of debugfs cmds to collect the trace and some
example trace log? If it is not confidential?

>  References
>  ==========
>  .. [1] "Power Architecture Platform Reference"
> -- 
> 2.45.2
Madhavan Srinivasan June 26, 2024, 3:55 a.m. UTC | #2
On 6/22/24 1:57 PM, Ritesh Harjani (IBM) wrote:
> Madhavan Srinivasan <maddy@linux.ibm.com> writes:
>
>> Add documentation to 'papr_hcalls.rst' describing the
>> input, output and return values of the H_HTM hcall as
>> per the internal specification.
>>
>> Signed-off-by: Madhavan Srinivasan <maddy@linux.ibm.com>
>> ---
>>   Documentation/arch/powerpc/papr_hcalls.rst | 11 +++++++++++
>>   1 file changed, 11 insertions(+)
>>
>> diff --git a/Documentation/arch/powerpc/papr_hcalls.rst b/Documentation/arch/powerpc/papr_hcalls.rst
>> index 80d2c0aadab5..805e1cb9bab9 100644
>> --- a/Documentation/arch/powerpc/papr_hcalls.rst
>> +++ b/Documentation/arch/powerpc/papr_hcalls.rst
>> @@ -289,6 +289,17 @@ to be issued multiple times in order to be completely serviced. The
>>   subsequent hcalls to the hypervisor until the hcall is completely serviced
>>   at which point H_SUCCESS or other error is returned by the hypervisor.
>>   
>> +**H_HTM**
>> +
>> +| Input: flags, target, operation (op), op-param1, op-param2, op-param3
>> +| Out: *dumphtmbufferdata*
>> +| Return Value: *H_Success,H_Busy,H_LongBusyOrder,H_Partial,H_Parameter,
>> +		 H_P2,H_P3,H_P4,H_P5,H_P6,H_State,H_Not_Available,H_Authority*
>> +
>> +H_HTM supports setup, configuration, control and dumping of Hardware Trace
>> +Macro (HTM) function and its data. HTM buffer stores tracing data for functions
>> +like core instruction, core LLAT and nest.
>> +
> Minor nit: Maybe the set of debugfs cmds to collect the trace and some
> example trace log? If it is not confidential?

I could add the file structure in the commit message, but logs are just 
binary data.

Maddy

>
>>   References
>>   ==========
>>   .. [1] "Power Architecture Platform Reference"
>> -- 
>> 2.45.2
diff mbox series

Patch

diff --git a/Documentation/arch/powerpc/papr_hcalls.rst b/Documentation/arch/powerpc/papr_hcalls.rst
index 80d2c0aadab5..805e1cb9bab9 100644
--- a/Documentation/arch/powerpc/papr_hcalls.rst
+++ b/Documentation/arch/powerpc/papr_hcalls.rst
@@ -289,6 +289,17 @@  to be issued multiple times in order to be completely serviced. The
 subsequent hcalls to the hypervisor until the hcall is completely serviced
 at which point H_SUCCESS or other error is returned by the hypervisor.
 
+**H_HTM**
+
+| Input: flags, target, operation (op), op-param1, op-param2, op-param3
+| Out: *dumphtmbufferdata*
+| Return Value: *H_Success,H_Busy,H_LongBusyOrder,H_Partial,H_Parameter,
+		 H_P2,H_P3,H_P4,H_P5,H_P6,H_State,H_Not_Available,H_Authority*
+
+H_HTM supports setup, configuration, control and dumping of Hardware Trace
+Macro (HTM) function and its data. HTM buffer stores tracing data for functions
+like core instruction, core LLAT and nest.
+
 References
 ==========
 .. [1] "Power Architecture Platform Reference"