drm/imagination: Add driver documentation
Add documentation for the UAPI. Changes since v5: - Remove obsolete VM documentation Co-developed-by: Matt Coster <matt.coster@imgtec.com> Signed-off-by: Matt Coster <matt.coster@imgtec.com> Co-developed-by: Donald Robson <donald.robson@imgtec.com> Signed-off-by: Donald Robson <donald.robson@imgtec.com> Signed-off-by: Sarah Walker <sarah.walker@imgtec.com> Reviewed-by: Maxime Ripard <mripard@kernel.org> Link: https://lore.kernel.org/r/76a7b18cfbe93066efcee3311ae795176ce7c65d.1700668843.git.donald.robson@imgtec.com Signed-off-by: Maxime Ripard <mripard@kernel.org>
This commit is contained in:
Sarah Walker
Maxime Ripard
parent
cb56cd6108
commit
815d8b0425
@ -3,9 +3,11 @@ GPU Driver Documentation
|
||||
========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
amdgpu/index
|
||||
i915
|
||||
imagination/index
|
||||
mcde
|
||||
meson
|
||||
pl111
|
||||
|
||||
13
Documentation/gpu/imagination/index.rst
Normal file
13
Documentation/gpu/imagination/index.rst
Normal file
@ -0,0 +1,13 @@
|
||||
=======================================
|
||||
drm/imagination PowerVR Graphics Driver
|
||||
=======================================
|
||||
|
||||
.. kernel-doc:: drivers/gpu/drm/imagination/pvr_drv.c
|
||||
:doc: PowerVR Graphics Driver
|
||||
|
||||
Contents
|
||||
========
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
uapi
|
||||
174
Documentation/gpu/imagination/uapi.rst
Normal file
174
Documentation/gpu/imagination/uapi.rst
Normal file
@ -0,0 +1,174 @@
|
||||
====
|
||||
UAPI
|
||||
====
|
||||
The sources associated with this section can be found in ``pvr_drm.h``.
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR UAPI
|
||||
|
||||
OBJECT ARRAYS
|
||||
=============
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_obj_array
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: DRM_PVR_OBJ_ARRAY
|
||||
|
||||
IOCTLS
|
||||
======
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL interface
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: PVR_IOCTL
|
||||
|
||||
DEV_QUERY
|
||||
---------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL DEV_QUERY interface
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_dev_query
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_dev_query_args
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_dev_query_gpu_info
|
||||
drm_pvr_dev_query_runtime_info
|
||||
drm_pvr_dev_query_hwrt_info
|
||||
drm_pvr_dev_query_quirks
|
||||
drm_pvr_dev_query_enhancements
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_heap_id
|
||||
drm_pvr_heap
|
||||
drm_pvr_dev_query_heap_info
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: Flags for DRM_PVR_DEV_QUERY_HEAP_INFO_GET.
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_static_data_area_usage
|
||||
drm_pvr_static_data_area
|
||||
drm_pvr_dev_query_static_data_areas
|
||||
|
||||
CREATE_BO
|
||||
---------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL CREATE_BO interface
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_create_bo_args
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: Flags for CREATE_BO
|
||||
|
||||
GET_BO_MMAP_OFFSET
|
||||
------------------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL GET_BO_MMAP_OFFSET interface
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_get_bo_mmap_offset_args
|
||||
|
||||
CREATE_VM_CONTEXT and DESTROY_VM_CONTEXT
|
||||
----------------------------------------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL CREATE_VM_CONTEXT and DESTROY_VM_CONTEXT interfaces
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_create_vm_context_args
|
||||
drm_pvr_ioctl_destroy_vm_context_args
|
||||
|
||||
VM_MAP and VM_UNMAP
|
||||
-------------------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL VM_MAP and VM_UNMAP interfaces
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_vm_map_args
|
||||
drm_pvr_ioctl_vm_unmap_args
|
||||
|
||||
CREATE_CONTEXT and DESTROY_CONTEXT
|
||||
----------------------------------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL CREATE_CONTEXT and DESTROY_CONTEXT interfaces
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_create_context_args
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ctx_priority
|
||||
drm_pvr_ctx_type
|
||||
drm_pvr_static_render_context_state
|
||||
drm_pvr_static_render_context_state_format
|
||||
drm_pvr_reset_framework
|
||||
drm_pvr_reset_framework_format
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_destroy_context_args
|
||||
|
||||
CREATE_FREE_LIST and DESTROY_FREE_LIST
|
||||
--------------------------------------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL CREATE_FREE_LIST and DESTROY_FREE_LIST interfaces
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_create_free_list_args
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_destroy_free_list_args
|
||||
|
||||
CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET
|
||||
--------------------------------------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET interfaces
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_create_hwrt_dataset_args
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_create_hwrt_geom_data_args
|
||||
drm_pvr_create_hwrt_rt_data_args
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_destroy_hwrt_dataset_args
|
||||
|
||||
SUBMIT_JOBS
|
||||
-----------
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: PowerVR IOCTL SUBMIT_JOBS interface
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: Flags for the drm_pvr_sync_op object.
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_ioctl_submit_jobs_args
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: Flags for SUBMIT_JOB ioctl geometry command.
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: Flags for SUBMIT_JOB ioctl fragment command.
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: Flags for SUBMIT_JOB ioctl compute command.
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:doc: Flags for SUBMIT_JOB ioctl transfer command.
|
||||
|
||||
.. kernel-doc:: include/uapi/drm/pvr_drm.h
|
||||
:identifiers: drm_pvr_sync_op
|
||||
drm_pvr_job_type
|
||||
drm_pvr_hwrt_data_ref
|
||||
drm_pvr_job
|
||||
|
||||
Internal notes
|
||||
==============
|
||||
.. kernel-doc:: drivers/gpu/drm/imagination/pvr_device.h
|
||||
:doc: IOCTL validation helpers
|
||||
|
||||
.. kernel-doc:: drivers/gpu/drm/imagination/pvr_device.h
|
||||
:identifiers: PVR_STATIC_ASSERT_64BIT_ALIGNED PVR_IOCTL_UNION_PADDING_CHECK
|
||||
pvr_ioctl_union_padding_check
|
||||
@ -10398,6 +10398,7 @@ M: Donald Robson <donald.robson@imgtec.com>
|
||||
M: Matt Coster <matt.coster@imgtec.com>
|
||||
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
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user