drm/i915: document caching related bits
authorMatthew Auld <matthew.auld@intel.com>
Fri, 23 Jul 2021 10:50:44 +0000 (11:50 +0100)
committerMatthew Auld <matthew.auld@intel.com>
Tue, 27 Jul 2021 08:16:44 +0000 (09:16 +0100)
commit3821cc7fc0b90a55c3708628336a97993e464dba
tree80c56c7a30f275b0beaa16bef9671031d86cbd49
parentcdb35d1ed6d216978521b75927acb3b8c50a6cac
drm/i915: document caching related bits

Try to document the object caching related bits, like cache_coherent and
cache_dirty.

v2(Ville):
 - As pointed out by Ville, fix the completely incorrect assumptions
   about the "partial" coherency on shared LLC platforms.
v3(Daniel):
 - Fix nonsense about "dirtying" the cache with reads.
v4(Daniel):
 - Various improvements, including adding some more details for WT.

Suggested-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Matthew Auld <matthew.auld@intel.com>
Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Cc: Mika Kuoppala <mika.kuoppala@linux.intel.com>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20210723105045.400841-1-matthew.auld@intel.com
drivers/gpu/drm/i915/gem/i915_gem_object_types.h
drivers/gpu/drm/i915/i915_drv.h