xref: /linux/Documentation/gpu/imagination/uapi.rst (revision 0ea5c948cb64bab5bc7a5516774eb8536f05aa0d)
1815d8b04SSarah Walker====
2815d8b04SSarah WalkerUAPI
3815d8b04SSarah Walker====
4815d8b04SSarah WalkerThe sources associated with this section can be found in ``pvr_drm.h``.
5815d8b04SSarah Walker
6815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
7815d8b04SSarah Walker   :doc: PowerVR UAPI
8815d8b04SSarah Walker
9815d8b04SSarah WalkerOBJECT ARRAYS
10815d8b04SSarah Walker=============
11815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
12815d8b04SSarah Walker   :identifiers: drm_pvr_obj_array
13815d8b04SSarah Walker
14815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
15815d8b04SSarah Walker   :identifiers: DRM_PVR_OBJ_ARRAY
16815d8b04SSarah Walker
17815d8b04SSarah WalkerIOCTLS
18815d8b04SSarah Walker======
19815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
20815d8b04SSarah Walker   :doc: PowerVR IOCTL interface
21815d8b04SSarah Walker
22815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
23815d8b04SSarah Walker   :identifiers: PVR_IOCTL
24815d8b04SSarah Walker
25815d8b04SSarah WalkerDEV_QUERY
26815d8b04SSarah Walker---------
27815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
28815d8b04SSarah Walker   :doc: PowerVR IOCTL DEV_QUERY interface
29815d8b04SSarah Walker
30815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
31815d8b04SSarah Walker   :identifiers: drm_pvr_dev_query
32815d8b04SSarah Walker
33815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
34815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_dev_query_args
35815d8b04SSarah Walker
36815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
37815d8b04SSarah Walker   :identifiers: drm_pvr_dev_query_gpu_info
38815d8b04SSarah Walker                 drm_pvr_dev_query_runtime_info
39815d8b04SSarah Walker                 drm_pvr_dev_query_hwrt_info
40815d8b04SSarah Walker                 drm_pvr_dev_query_quirks
41815d8b04SSarah Walker                 drm_pvr_dev_query_enhancements
42815d8b04SSarah Walker
43815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
44815d8b04SSarah Walker   :identifiers: drm_pvr_heap_id
45815d8b04SSarah Walker                 drm_pvr_heap
46815d8b04SSarah Walker                 drm_pvr_dev_query_heap_info
47815d8b04SSarah Walker
48815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
49815d8b04SSarah Walker   :identifiers: drm_pvr_static_data_area_usage
50815d8b04SSarah Walker                 drm_pvr_static_data_area
51815d8b04SSarah Walker                 drm_pvr_dev_query_static_data_areas
52815d8b04SSarah Walker
53815d8b04SSarah WalkerCREATE_BO
54815d8b04SSarah Walker---------
55815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
56815d8b04SSarah Walker   :doc: PowerVR IOCTL CREATE_BO interface
57815d8b04SSarah Walker
58815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
59815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_create_bo_args
60815d8b04SSarah Walker
61815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
62815d8b04SSarah Walker   :doc: Flags for CREATE_BO
63815d8b04SSarah Walker
64815d8b04SSarah WalkerGET_BO_MMAP_OFFSET
65815d8b04SSarah Walker------------------
66815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
67815d8b04SSarah Walker   :doc: PowerVR IOCTL GET_BO_MMAP_OFFSET interface
68815d8b04SSarah Walker
69815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
70815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_get_bo_mmap_offset_args
71815d8b04SSarah Walker
72815d8b04SSarah WalkerCREATE_VM_CONTEXT and DESTROY_VM_CONTEXT
73815d8b04SSarah Walker----------------------------------------
74815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
75815d8b04SSarah Walker   :doc: PowerVR IOCTL CREATE_VM_CONTEXT and DESTROY_VM_CONTEXT interfaces
76815d8b04SSarah Walker
77815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
78815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_create_vm_context_args
79815d8b04SSarah Walker                 drm_pvr_ioctl_destroy_vm_context_args
80815d8b04SSarah Walker
81815d8b04SSarah WalkerVM_MAP and VM_UNMAP
82815d8b04SSarah Walker-------------------
83815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
84815d8b04SSarah Walker   :doc: PowerVR IOCTL VM_MAP and VM_UNMAP interfaces
85815d8b04SSarah Walker
86815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
87815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_vm_map_args
88815d8b04SSarah Walker                 drm_pvr_ioctl_vm_unmap_args
89815d8b04SSarah Walker
90815d8b04SSarah WalkerCREATE_CONTEXT and DESTROY_CONTEXT
91815d8b04SSarah Walker----------------------------------
92815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
93815d8b04SSarah Walker   :doc: PowerVR IOCTL CREATE_CONTEXT and DESTROY_CONTEXT interfaces
94815d8b04SSarah Walker
95815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
96815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_create_context_args
97815d8b04SSarah Walker
98815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
99815d8b04SSarah Walker   :identifiers: drm_pvr_ctx_priority
100815d8b04SSarah Walker                 drm_pvr_ctx_type
101815d8b04SSarah Walker                 drm_pvr_static_render_context_state
102815d8b04SSarah Walker                 drm_pvr_static_render_context_state_format
103815d8b04SSarah Walker                 drm_pvr_reset_framework
104815d8b04SSarah Walker                 drm_pvr_reset_framework_format
105815d8b04SSarah Walker
106815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
107815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_destroy_context_args
108815d8b04SSarah Walker
109815d8b04SSarah WalkerCREATE_FREE_LIST and DESTROY_FREE_LIST
110815d8b04SSarah Walker--------------------------------------
111815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
112815d8b04SSarah Walker   :doc: PowerVR IOCTL CREATE_FREE_LIST and DESTROY_FREE_LIST interfaces
113815d8b04SSarah Walker
114815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
115815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_create_free_list_args
116815d8b04SSarah Walker
117815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
118815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_destroy_free_list_args
119815d8b04SSarah Walker
120815d8b04SSarah WalkerCREATE_HWRT_DATASET and DESTROY_HWRT_DATASET
121*3cc808e3SDonald Robson--------------------------------------------
122815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
123815d8b04SSarah Walker   :doc: PowerVR IOCTL CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET interfaces
124815d8b04SSarah Walker
125815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
126815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_create_hwrt_dataset_args
127815d8b04SSarah Walker
128815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
129815d8b04SSarah Walker   :identifiers: drm_pvr_create_hwrt_geom_data_args
130815d8b04SSarah Walker                 drm_pvr_create_hwrt_rt_data_args
131815d8b04SSarah Walker
132815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
133815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_destroy_hwrt_dataset_args
134815d8b04SSarah Walker
135815d8b04SSarah WalkerSUBMIT_JOBS
136815d8b04SSarah Walker-----------
137815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
138815d8b04SSarah Walker   :doc: PowerVR IOCTL SUBMIT_JOBS interface
139815d8b04SSarah Walker
140815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
141815d8b04SSarah Walker   :doc: Flags for the drm_pvr_sync_op object.
142815d8b04SSarah Walker
143815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
144815d8b04SSarah Walker   :identifiers: drm_pvr_ioctl_submit_jobs_args
145815d8b04SSarah Walker
146815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
147815d8b04SSarah Walker   :doc: Flags for SUBMIT_JOB ioctl geometry command.
148815d8b04SSarah Walker
149815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
150815d8b04SSarah Walker   :doc: Flags for SUBMIT_JOB ioctl fragment command.
151815d8b04SSarah Walker
152815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
153815d8b04SSarah Walker   :doc: Flags for SUBMIT_JOB ioctl compute command.
154815d8b04SSarah Walker
155815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
156815d8b04SSarah Walker   :doc: Flags for SUBMIT_JOB ioctl transfer command.
157815d8b04SSarah Walker
158815d8b04SSarah Walker.. kernel-doc:: include/uapi/drm/pvr_drm.h
159815d8b04SSarah Walker   :identifiers: drm_pvr_sync_op
160815d8b04SSarah Walker                 drm_pvr_job_type
161815d8b04SSarah Walker                 drm_pvr_hwrt_data_ref
162815d8b04SSarah Walker                 drm_pvr_job
163815d8b04SSarah Walker
164815d8b04SSarah WalkerInternal notes
165815d8b04SSarah Walker==============
166815d8b04SSarah Walker.. kernel-doc:: drivers/gpu/drm/imagination/pvr_device.h
167815d8b04SSarah Walker   :doc: IOCTL validation helpers
168815d8b04SSarah Walker
169815d8b04SSarah Walker.. kernel-doc:: drivers/gpu/drm/imagination/pvr_device.h
170815d8b04SSarah Walker   :identifiers: PVR_STATIC_ASSERT_64BIT_ALIGNED PVR_IOCTL_UNION_PADDING_CHECK
171815d8b04SSarah Walker                 pvr_ioctl_union_padding_check
172