drm/xe: Expand XE_REG_OPTION_MASKED documentation
authorLucas De Marchi <lucas.demarchi@intel.com>
Tue, 5 Dec 2023 15:58:20 +0000 (07:58 -0800)
committerRodrigo Vivi <rodrigo.vivi@intel.com>
Thu, 21 Dec 2023 16:45:23 +0000 (11:45 -0500)
commitc3ab84efbd05936cfac87ef6801e03534dc4b0b7
tree48301939a30a1f955795348d99ce4c526719ecab
parent0f1d88f2786458a8986920669bd8fb3fec6e618d
drm/xe: Expand XE_REG_OPTION_MASKED documentation

Expand documentation and add an example to make clear this isn't about
generic masks in registers. Also, fix the doc regarding read operations:
the mask part has no effect on them.

Reviewed-by: Ashutosh Dixit <ashutosh.dixit@intel.com>
Reviewed-by: Matt Roper <matthew.d.roper@intel.com>
Link: https://lore.kernel.org/r/20231205155820.2133813-1-lucas.demarchi@intel.com
Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
drivers/gpu/drm/xe/regs/xe_reg_defs.h