Skip to content

Cosmetic tweaks to native enqueue spec #1850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
omarahmed1111 merged 1 commit into from
Aug 7, 2024
Merged

Cosmetic tweaks to native enqueue spec #1850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions scripts/core/EXP-NATIVE-ENQUEUE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ within the native API through the function passed to
${x}EnqueueNativeCommandExp, the function argument must only use the native
queue accessed through ${x}QueueGetNativeHandle. Use of a native queue that is
not the native queue returned by ${x}QueueGetNativeHandle results in undefined
behaviour.
behavior.

Any args that are needed by the func must be passed through a void* and unpacked
within the func. If ${x}_mem_handle_t arguments are to be used within
pfnNativeEnqueue, they must be accessed using ${x}MemGetNativeHandle.
${x}_mem_handle_t arguments must be packed in the void* argument that will be
used in pfnNativeEnqueue, as well as ${x}EnqueueNativeCommandExp's phMemList
Any args that are needed by the func must be passed through a ``void*`` and unpacked
within the func. If ``${x}_mem_handle_t`` arguments are to be used within
``pfnNativeEnqueue``, they must be accessed using ${x}MemGetNativeHandle.
``${x}_mem_handle_t`` arguments must be packed in the void* argument that will be
used in ``pfnNativeEnqueue``, as well as ${x}EnqueueNativeCommandExp's ``phMemList``
argument.

API
Expand All @@ -65,24 +65,25 @@ Functions
Changelog
--------------------------------------------------------------------------------

+-----------+-------------------------+
| Revision | Changes |
+===========+=========================+
| 1.0 | Initial Draft |
+-----------+-------------------------+
| 1.1 | Make `phEvent` optional |
+-----------+-------------------------+
+-----------+---------------------------+
| Revision | Changes |
+===========+===========================+
| 1.0 | Initial Draft |
+-----------+---------------------------+
| 1.1 | Make ``phEvent`` optional |
+-----------+---------------------------+


Support
--------------------------------------------------------------------------------

Adapters which support this experimental feature *must* return true for the new
`${X}_DEVICE_INFO_ENQUEUE_NATIVE_COMMAND_SUPPORT_EXP` device info query.
``${X}_DEVICE_INFO_ENQUEUE_NATIVE_COMMAND_SUPPORT_EXP`` device info query.


Contributors
--------------------------------------------------------------------------------

* Hugh Delaney `[email protected] <[email protected]>`_
* Kenneth Benzie (Benie) `[email protected] <[email protected]>`_
* Ewan Crawford `[email protected] <[email protected]>`_