All of lore.kernel.org
 help / color / mirror / Atom feed
* [Intel-xe] [PATCH] drm/xe: Expand XE_REG_OPTION_MASKED documentation
@ 2023-12-05 15:58 Lucas De Marchi
  2023-12-05 16:24 ` Dixit, Ashutosh
                   ` (8 more replies)
  0 siblings, 9 replies; 12+ messages in thread
From: Lucas De Marchi @ 2023-12-05 15:58 UTC (permalink / raw)
  To: intel-xe; +Cc: Lucas De Marchi, Matt Roper

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.

Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
---
 drivers/gpu/drm/xe/regs/xe_reg_defs.h | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/xe/regs/xe_reg_defs.h b/drivers/gpu/drm/xe/regs/xe_reg_defs.h
index 6e20fc2de9ff..c50e7650c09a 100644
--- a/drivers/gpu/drm/xe/regs/xe_reg_defs.h
+++ b/drivers/gpu/drm/xe/regs/xe_reg_defs.h
@@ -60,7 +60,16 @@ struct xe_reg_mcr {
 
 /**
  * XE_REG_OPTION_MASKED - Register is "masked", with upper 16 bits marking the
- * read/written bits on the lower 16 bits.
+ * written bits on the lower 16 bits.
+ *
+ * It only applies to registers explicitly marked in bspec with
+ * "Access: Masked". Registers with this option can have write operations to
+ * specific lower bits by setting the corresponding upper bits. Other bits will
+ * not be affected. This allows register writes without needing a RMW cycle and
+ * without caching in software the register value.
+ *
+ * Example: a write with value 0x00010001 will set bit 0 and all other bits
+ * retain their previous values.
  *
  * To be used with XE_REG(). XE_REG_MCR() and XE_REG_INITIALIZER()
  */
-- 
2.40.1


^ permalink raw reply related	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2023-12-05 21:37 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-12-05 15:58 [Intel-xe] [PATCH] drm/xe: Expand XE_REG_OPTION_MASKED documentation Lucas De Marchi
2023-12-05 16:24 ` Dixit, Ashutosh
2023-12-05 17:28 ` Matt Roper
2023-12-05 18:07   ` Lucas De Marchi
2023-12-05 18:14     ` Matt Roper
2023-12-05 20:44 ` [Intel-xe] ✓ CI.Patch_applied: success for " Patchwork
2023-12-05 20:44 ` [Intel-xe] ✓ CI.checkpatch: " Patchwork
2023-12-05 20:45 ` [Intel-xe] ✓ CI.KUnit: " Patchwork
2023-12-05 20:53 ` [Intel-xe] ✓ CI.Build: " Patchwork
2023-12-05 20:53 ` [Intel-xe] ✗ CI.Hooks: failure " Patchwork
2023-12-05 20:54 ` [Intel-xe] ✓ CI.checksparse: success " Patchwork
2023-12-05 21:37 ` [Intel-xe] ✓ CI.BAT: " Patchwork

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.