Skip to contentSkip to conversation

drm/imagination: Add driver documentation

PATCH In review Sarah Walker 2 participants 3 messages Aug 16, 2023 – Aug 18, 2023

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH v5 16/17 drm/imagination: Add driver documentation

Add documentation for the UAPI and for the virtual memory design.

---
 Documentation/gpu/drivers.rst                 |   2 +
 Documentation/gpu/imagination/index.rst       |  14 +
 Documentation/gpu/imagination/uapi.rst        | 174 +++++++
 .../gpu/imagination/virtual_memory.rst        | 462 ++++++++++++++++++
 MAINTAINERS                                   |   1 +
 5 files changed, 653 insertions(+)
 create mode 100644 Documentation/gpu/imagination/index.rst
 create mode 100644 Documentation/gpu/imagination/uapi.rst
 create mode 100644 Documentation/gpu/imagination/virtual_memory.rst
Documentation/gpu/drivers.rst +2 -0
index 3a52f48215a3..5487deb218a3 100644
@@ -3,9 +3,11 @@ GPU Driver Documentation
 ========================
 
 .. toctree::
+   :maxdepth: 3
 
    amdgpu/index
    i915
+   imagination/index
    mcde
    meson
    pl111
Documentation/gpu/imagination/index.rst new file +14 -0
new file mode 100644
index 000000000000..57f28e460a03
@@ -0,0 +1,14 @@
+=======================================
+drm/imagination PowerVR Graphics Driver
+=======================================
+
+.. kernel-doc:: drivers/gpu/drm/imagination/pvr_drv.c
+   :doc: PowerVR Graphics Driver
+
+Contents
+========
+.. toctree::
+   :maxdepth: 2
+
+   uapi
+   virtual_memory
Documentation/gpu/imagination/uapi.rst new file +174 -0

174 lines not on this page · raw message

Documentation/gpu/imagination/virtual_memory.rst new file +462 -0

462 lines not on this page · raw message

MAINTAINERS +1 -0
index 82b82cbdb22a..7f99999ceabb 100644
@@ -10144,6 +10144,7 @@ M:	Sarah Walker <[email protected]>
 M:	Donald Robson <[email protected]>
 S:	Supported
 F:	Documentation/devicetree/bindings/gpu/img,powervr.yaml
+F:	Documentation/gpu/imagination/
 F:	drivers/gpu/drm/imagination/
 F:	include/uapi/drm/pvr_drm.h
 
Signature · 1 line
2.41.0
maintainer
#1 lore raw
Quoted 1 line · Sarah Walker

Add documentation for the UAPI and for the virtual memory design.

One little thing I happened to notice on a quick glance:

Documentation/gpu/imagination/virtual_memory.rst line 45

Quoted 2 lines
Documentation/gpu/imagination/virtual_memory.rst new file +2 -0
+Begin by calling :c:func:`pvr_vm_create_context` to obtain a VM context. It is
+bound to a PowerVR device (:c:type:`pvr_device`) and holds a reference to it.

Rather than writing out the :c:func: incantation, just say pvr_vm_create_context(). All of the right things will happen, and your document will be a lot more readable.

Thanks,

jon

#2 lore raw
Quoted 6 lines · Jonathan Corbet

*** CAUTION: This email originates from a source not known to Imagination Technologies. Think before you click a link or open an attachment ***

Quoted 1 line · Sarah Walker

Add documentation for the UAPI and for the virtual memory design.

Quoted 8 lines

One little thing I happened to notice on a quick glance:

Documentation/gpu/imagination/virtual_memory.rst line 45

Quoted 2 lines
Documentation/gpu/imagination/virtual_memory.rst new file +2 -0
+Begin by calling :c:func:`pvr_vm_create_context` to obtain a VM context. It is
+bound to a PowerVR device (:c:type:`pvr_device`) and holds a reference to it.

Rather than writing out the :c:func: incantation, just say pvr_vm_create_context(). All of the right things will happen, and your document will be a lot more readable.

Thanks for this. Will get this sorted.

Thanks,
Sarah

Quoted 4 lines

Thanks,

jon