Skip to content
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.

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

add extension docs for spir-v-related extensions #1123

Merged
merged 2 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 0 additions & 4 deletions OpenCL_Ext.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ include::ext/introduction.asciidoc[]
// included markup in the OpenCL API and C Language Specifications, rather
// than being included here as separate documents.

// These are SPIR-V Extensions:

include::ext/spirv_extensions.asciidoc[]

// Index and Appendices:

ifdef::backend-pdf[]
Expand Down
27 changes: 27 additions & 0 deletions api/cl_khr_spirv_extended_debug_info.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright 2017-2024 The Khronos Group Inc.
// SPDX-License-Identifier: CC-BY-4.0

include::{generated}/meta/{refprefix}cl_khr_spirv_extended_debug_info.txt[]

=== Other Extension Metadata

*Last Modified Date*::
2020-04-21
*IP Status*::
No known IP claims.
*Contributors*::
TBD

=== Description

`cl_khr_spirv_extended_debug_info` allows use of the SPIR-V
`OpenCL.DebugInfo.100` extended instruction set.

See the
link:{OpenCLEnvSpecURL}#_cl_khr_spirv_extended_debug_info[cl_khr_spirv_extended_debug_info]
section of the OpenCL SPIR-V Environment specification for more information.

=== Version History

* Revision 1.0.0, 2020-04-21
** First assigned version.
27 changes: 27 additions & 0 deletions api/cl_khr_spirv_linkonce_odr.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright 2017-2024 The Khronos Group Inc.
// SPDX-License-Identifier: CC-BY-4.0

include::{generated}/meta/{refprefix}cl_khr_spirv_linkonce_odr.txt[]

=== Other Extension Metadata

*Last Modified Date*::
2020-04-21
*IP Status*::
No known IP claims.
*Contributors*::
TBD

=== Description

`cl_khr_spirv_linkonce_odr` allows use of the SPIR-V extension
`SPV_KHR_linkonce_odr`.

See the
link:{OpenCLEnvSpecURL}#_cl_khr_spirv_linkonce_odr[cl_khr_spirv_linkonce_odr]
section of the OpenCL SPIR-V Environment specification for more information.

=== Version History

* Revision 1.0.0, 2020-04-21
** First assigned version.
28 changes: 28 additions & 0 deletions api/cl_khr_spirv_no_integer_wrap_decoration.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Copyright 2017-2024 The Khronos Group Inc.
// SPDX-License-Identifier: CC-BY-4.0

include::{generated}/meta/{refprefix}cl_khr_spirv_no_integer_wrap_decoration.txt[]

=== Other Extension Metadata

*Last Modified Date*::
2020-04-21
*IP Status*::
No known IP claims.
*Contributors*::
TBD

=== Description

`cl_khr_spirv_no_integer_wrap_decoration` allows use of the SPIR-V extension
`SPV_KHR_no_integer_wrap_decoration`, which adds new decorations to indicate
that a given instruction does not cause integer wrapping to occur.

See the
link:{OpenCLEnvSpecURL}#_cl_khr_spirv_no_integer_wrap_decoration[cl_khr_spirv_no_integer_wrap_decoration]
section of the OpenCL SPIR-V Environment specification for more information.

=== Version History

* Revision 1.0.0, 2020-04-21
** First assigned version.
1 change: 1 addition & 0 deletions config/opencl.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
:khronos-opencl-repo: https://github.com/KhronosGroup/OpenCL-Docs
:khronos-opencl-pr: {khronos-opencl-repo}/pull
:OpenCLCSpecURL: OpenCL_C.html
:OpenCLEnvSpecURL: OpenCL_Env.html

:blank: pass:[ +]
:pp: ++
Expand Down
12 changes: 12 additions & 0 deletions ext/quick_reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,18 @@ Language Specifications.
| Standard Portable Intermediate Representation Programs
| Extension, Superseded by IL Programs / SPIR-V

| [[cl_khr_spirv_extended_debug_info]] link:{APISpecURL}#cl_khr_spirv_extended_debug_info[`cl_khr_spirv_extended_debug_info`]
| Allows Use of the SPIR-V `OpenCL.DebugInfo.100` Extended Instruction Set
| Extension

| [[cl_khr_spirv_linkonce_odr]] link:{APISpecURL}#cl_khr_spirv_linkonce_odr[`cl_khr_spirv_linkonce_odr`]
| Allows Use of the SPIR-V `SPV_KHR_linkonce_odr` Extension
| Extension

| [[cl_khr_spirv_no_integer_wrap_decoration]] link:{APISpecURL}#cl_khr_spirv_no_integer_wrap_decoration[`cl_khr_spirv_no_integer_wrap_decoration`]
| Allows Use of the SPIR-V `SPV_KHR_no_integer_wrap_decoration` Extension
| Extension

| [[cl_khr_srgb_image_writes]] link:{APISpecURL}#cl_khr_srgb_image_writes[`cl_khr_srgb_image_writes`]
| Write to sRGB Images
| Extension
Expand Down
14 changes: 0 additions & 14 deletions ext/spirv_extensions.asciidoc

This file was deleted.

3 changes: 3 additions & 0 deletions xml/cl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7442,6 +7442,9 @@ server's OpenCL/api-docs repository.
<extension name="cl_khr_subgroup_clustered_reduce" supported="opencl" ratified="opencl" comment="OpenCL C only"/>
<extension name="cl_khr_subgroup_rotate" supported="opencl" ratified="opencl" comment="OpenCL C only"/>
<extension name="cl_khr_work_group_uniform_arithmetic" supported="opencl" ratified="opencl" comment="OpenCL C only"/>
<extension name="cl_khr_spirv_no_integer_wrap_decoration" supported="opencl" ratified="opencl" comment="SPIR-V only"/>
<extension name="cl_khr_spirv_extended_debug_info" supported="opencl" ratified="opencl" comment="SPIR-V only"/>
<extension name="cl_khr_spirv_linkonce_odr" supported="opencl" ratified="opencl" comment="SPIR-V only"/>
<extension name="cl_img_cancel_command" supported="opencl">
<require comment="Error codes">
<enum name="CL_CANCELLED_IMG"/>
Expand Down