Commit 737c375b authored by Luben Tuikov's avatar Luben Tuikov Committed by Alex Deucher

drm/amdgpu: Fix kernel-doc for the RAS sysfs interface

Imporve the kernel-doc for the RAS sysfs
interface. Fix the grammar, fix the context.

Cc: Alexander Deucher <Alexander.Deucher@amd.com>
Cc: Hawking Zhang <Hawking.Zhang@amd.com>
Signed-off-by: default avatarLuben Tuikov <luben.tuikov@amd.com>
Reviewed-by: default avatarHawking Zhang <Hawking.Zhang@amd.com>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent 7fb64071
...@@ -274,7 +274,7 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f, ...@@ -274,7 +274,7 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
/** /**
* DOC: AMDGPU RAS debugfs control interface * DOC: AMDGPU RAS debugfs control interface
* *
* It accepts struct ras_debug_if who has two members. * The control interface accepts struct ras_debug_if which has two members.
* *
* First member: ras_debug_if::head or ras_debug_if::inject. * First member: ras_debug_if::head or ras_debug_if::inject.
* *
...@@ -299,32 +299,33 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f, ...@@ -299,32 +299,33 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
* *
* How to use the interface? * How to use the interface?
* *
* Programs * In a program
* *
* Copy the struct ras_debug_if in your codes and initialize it. * Copy the struct ras_debug_if in your code and initialize it.
* Write the struct to the control node. * Write the struct to the control interface.
* *
* Shells * From shell
* *
* .. code-block:: bash * .. code-block:: bash
* *
* echo op block [error [sub_block address value]] > .../ras/ras_ctrl * echo "disable <block>" > /sys/kernel/debug/dri/<N>/ras/ras_ctrl
* echo "enable <block> <error>" > /sys/kernel/debug/dri/<N>/ras/ras_ctrl
* echo "inject <block> <error> <sub-block> <address> <value> > /sys/kernel/debug/dri/<N>/ras/ras_ctrl
* *
* Parameters: * Where N, is the card which you want to affect.
* *
* op: disable, enable, inject * "disable" requires only the block.
* disable: only block is needed * "enable" requires the block and error type.
* enable: block and error are needed * "inject" requires the block, error type, address, and value.
* inject: error, address, value are needed * The block is one of: umc, sdma, gfx, etc.
* block: umc, sdma, gfx, .........
* see ras_block_string[] for details * see ras_block_string[] for details
* error: ue, ce * The error type is one of: ue, ce, where,
* ue: multi_uncorrectable * ue is multi-uncorrectable
* ce: single_correctable * ce is single-correctable
* sub_block: * The sub-block is a the sub-block index, pass 0 if there is no sub-block.
* sub block index, pass 0 if there is no sub block * The address and value are hexadecimal numbers, leading 0x is optional.
* *
* here are some examples for bash commands: * For instance,
* *
* .. code-block:: bash * .. code-block:: bash
* *
...@@ -332,17 +333,17 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f, ...@@ -332,17 +333,17 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
* echo inject umc ce 0 0 0 > /sys/kernel/debug/dri/0/ras/ras_ctrl * echo inject umc ce 0 0 0 > /sys/kernel/debug/dri/0/ras/ras_ctrl
* echo disable umc > /sys/kernel/debug/dri/0/ras/ras_ctrl * echo disable umc > /sys/kernel/debug/dri/0/ras/ras_ctrl
* *
* How to check the result? * How to check the result of the operation?
* *
* For disable/enable, please check ras features at * To check disable/enable, see "ras" features at,
* /sys/class/drm/card[0/1/2...]/device/ras/features * /sys/class/drm/card[0/1/2...]/device/ras/features
* *
* For inject, please check corresponding err count at * To check inject, see the corresponding error count at,
* /sys/class/drm/card[0/1/2...]/device/ras/[gfx/sdma/...]_err_count * /sys/class/drm/card[0/1/2...]/device/ras/[gfx|sdma|umc|...]_err_count
* *
* .. note:: * .. note::
* Operations are only allowed on blocks which are supported. * Operations are only allowed on blocks which are supported.
* Please check ras mask at /sys/module/amdgpu/parameters/ras_mask * Check the "ras" mask at /sys/module/amdgpu/parameters/ras_mask
* to see which blocks support RAS on a particular asic. * to see which blocks support RAS on a particular asic.
* *
*/ */
......
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