Commit dc2f5a49 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Bjorn Andersson

soc: qcom: dcc: Fix examples list on /sys/kernel/debug/dcc/.../[list-number]/config documentation

kernel test robot reported htmldocs warnings:

Documentation/ABI/testing/debugfs-driver-dcc:34: WARNING: Unexpected indentation.
Documentation/ABI/testing/debugfs-driver-dcc:34: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix these by fixing numbered list syntax on description of
/sys/kernel/debug/dcc/.../[list-number]/config, including adding blank line
separators as appropriate.

Link: https://lore.kernel.org/linux-doc/202212300426.eMLsZsvA-lkp@intel.com/
Fixes: 4cbe60cf ("soc: qcom: dcc: Add driver support for Data Capture and Compare unit(DCC)")
Reported-by: default avatarkernel test robot <lkp@intel.com>
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Acked-by: default avatarSouradeep Chowdhury <quic_schowdhu@quicinc.com>
Signed-off-by: default avatarBjorn Andersson <andersson@kernel.org>
Link: https://lore.kernel.org/r/20221230135030.17002-2-bagasdotme@gmail.com
parent d4b2c748
...@@ -44,35 +44,54 @@ Description: ...@@ -44,35 +44,54 @@ Description:
example user can jump to list x only after list y is example user can jump to list x only after list y is
configured and enabled. The format for entering all configured and enabled. The format for entering all
types of instructions are explained in examples as types of instructions are explained in examples as
follows. follows:
Example:
i)Read Type Instruction i) Read Type Instruction
echo R <1> <2> <3> >/sys/kernel/debug/dcc/../[list-number]/config echo R <1> <2> <3> >/sys/kernel/debug/dcc/../[list-number]/config
1->Address to be considered for reading the value. 1->Address to be considered for reading the value.
2->The word count of the addresses, read n words 2->The word count of the addresses, read n words
starting from address <1>. Each word is of 32 bits. starting from address <1>. Each word is of 32 bits.
If not entered 1 is considered. If not entered 1 is considered.
3->Can be 'apb' or 'ahb' which indicates if it is apb or ahb 3->Can be 'apb' or 'ahb' which indicates if it is apb or ahb
bus respectively. If not entered ahb is considered. bus respectively. If not entered ahb is considered.
ii)Write Type Instruction
echo W <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config ii) Write Type Instruction
1->Address to be considered for writing the value.
2->The value that needs to be written at the location. echo W <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
3->Can be a 'apb' or 'ahb' which indicates if it is apb or ahb
but respectively. 1->Address to be considered for writing the value.
iii)Read Modify Write type instruction
echo RW <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config 2->The value that needs to be written at the location.
1->The address which needs to be considered for read then write.
2->The value that needs to be written on the address. 3->Can be a 'apb' or 'ahb' which indicates if it is apb or ahb
3->The mask of the value to be written. but respectively.
iv)Loop Type Instruction
echo L <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config iii) Read Modify Write type instruction
1->The loop count, the number of times the value of the addresses will be
captured. echo RW <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
2->The address count, total number of addresses to be entered in this
instruction. 1->The address which needs to be considered for read then write.
3->The series of addresses to be entered separated by a space like <addr1>
<addr2>... and so on. 2->The value that needs to be written on the address.
3->The mask of the value to be written.
iv) Loop Type Instruction
echo L <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
1->The loop count, the number of times the value of the addresses will be
captured.
2->The address count, total number of addresses to be entered in this
instruction.
3->The series of addresses to be entered separated by a space like <addr1>
<addr2>... and so on.
What: /sys/kernel/debug/dcc/.../[list-number]/enable What: /sys/kernel/debug/dcc/.../[list-number]/enable
Date: December 2022 Date: December 2022
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment