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

* add extension docs for spir-v-related extensions cl_khr_spirv_extended_debug_info cl_khr_spirv_linkonce_odr cl_khr_spirv_no_integer_wrap_decoration * fix extension name
KhronosGroup · Apr 2, 2024 · 0f01c28 · 0f01c28
1 parent 45adff7
commit 0f01c28
Show file tree

Hide file tree

Showing 8 changed files with 98 additions and 18 deletions.
diff --git a/OpenCL_Ext.txt b/OpenCL_Ext.txt
@@ -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[]

diff --git a/api/cl_khr_spirv_extended_debug_info.asciidoc b/api/cl_khr_spirv_extended_debug_info.asciidoc
@@ -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.
diff --git a/api/cl_khr_spirv_linkonce_odr.asciidoc b/api/cl_khr_spirv_linkonce_odr.asciidoc
@@ -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.
diff --git a/api/cl_khr_spirv_no_integer_wrap_decoration.asciidoc b/api/cl_khr_spirv_no_integer_wrap_decoration.asciidoc
@@ -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.
diff --git a/config/opencl.asciidoc b/config/opencl.asciidoc
@@ -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: ++

diff --git a/ext/quick_reference.asciidoc b/ext/quick_reference.asciidoc
@@ -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

diff --git a/ext/spirv_extensions.asciidoc b/ext/spirv_extensions.asciidoc
diff --git a/xml/cl.xml b/xml/cl.xml
@@ -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"/>