[Intel-gfx] [PATCH v4 0/5] Documentation patch for batchbuffer submission

[kevin.rogovin at intel.com]

From: Kevin Rogovin <kevin.rogovin at intel.com>

Note: I want to make a one or two follow-up series that provide
narration and potentially additional documentation for GUC submission
and the breadcrumbs.

v4:
   Drop some details from narration to provide better focus.
   (suggested/requested by Chris Wilson)

   Spelling and grammar fixes.
   (errors caught by Tvrtko Ursuli)

   Move "at the bottom" details to part of documentation in
   i915_gem_execbuffer.c.
   (suggested by Chris Wilson)

   Place additional documentation of intel_engine_cs function
   pointers to inlined in struct.

   Fix documentation error about lazy creation of intel_ringbuffer
   and backing store in intel_lrc.c.
   (Caught by Chris Wilson)

v3:
   More documentation: emphasize that handling of batchbuffer
   requests creates a request struct that is added to the
   dependency tree and that the inform to the hardware that
   there is new data on a ringbuffer is deferred until dependencies
   are satsified.

   Break patch into more digestable chunks.  

v2:
   More documentation: intel_ringbuffer, sequence number.
   Expose to i915.rst existing documentation

   Call out GEM_EXECBUFFER as deprecated.
   Place code detailed documentation in source files.
   Call out INTEL_EXEC_RENDER.
   Reorder text to make it more readable.
   Refer to Command Buffer Parser instead of Batchbuffer Parser.
   (suggested by Joonas Lahtinen)

Kevin Rogovin (5):
  i915.rst: Narration overview on GEM + minor reorder to improve
    narration
  i915: add a text about what happens at bottom of stack in processing a
    batchbuffer
  i915.rst: add link to documentation in i915_gem_execbuffer.c
  i915: correct lazy ringbuffer and backing store documentation
  i915: add documentation to intel_engine_cs

 Documentation/gpu/i915.rst                 | 122 +++++++++++++++++++++++------
 drivers/gpu/drm/i915/i915_gem_execbuffer.c |  22 ++++++
 drivers/gpu/drm/i915/i915_vma.h            |  10 ++-
 drivers/gpu/drm/i915/intel_lrc.c           |  13 +--
 drivers/gpu/drm/i915/intel_ringbuffer.h    |  29 +++++++
 5 files changed, 158 insertions(+), 38 deletions(-)

-- 
2.16.2