HIP runtime API reference reorganize

ROCm · Sep 19, 2024 · 99492fc · 99492fc
1 parent 73e3005
commit 99492fc
Show file tree

Hide file tree

Showing 33 changed files with 390 additions and 56 deletions.
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -32,6 +32,7 @@ enqueues
 entrypoint
 entrypoints
 enum
+enums
 embeded
 extern
 fatbinary

diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile
@@ -829,8 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = mainpage.md \
-                         ../../include/hip \
+INPUT                  = ../../include/hip \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_hip_gl_interop.h \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_surface_functions.h \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_hip_cooperative_groups.h \
@@ -2207,6 +2206,7 @@ PREDEFINED             = "__HIP_PLATFORM_AMD__" \
                          "__CG_QUALIFIER__=" \
                          "__CG_STATIC_QUALIFIER__=static" \
                          "_CG_STATIC_CONST_DECL_=static constexpr" \
+                         "HIP_PUBLIC_API" \
                          "HIP_ENABLE_WARP_SYNC_BUILTINS"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this

diff --git a/docs/doxygen/mainpage.md b/docs/doxygen/mainpage.md
diff --git a/docs/index.md b/docs/index.md
@@ -53,15 +53,12 @@ On non-AMD platforms, like NVIDIA, HIP provides header files required to support
 
 :::{grid-item-card} Reference
 
-* {doc}`/doxygen/html/index`
+* [HIP runtime API](./reference/hip_runtime_api_reference)
+* [HSA runtime API for ROCm](./reference/virtual_rocr)
 * [C++ language extensions](./reference/cpp_language_extensions)
 * [C++ language support](./reference/cpp_language_support)
 * [HIP math API](./reference/math_api)
 * [Comparing syntax for different APIs](./reference/terms)
-* [HSA runtime API for ROCm](./reference/virtual_rocr)
-* [HIP managed memory allocation API](./reference/unified_memory_reference)
-* [HIP virtual memory management API](./reference/virtual_memory_reference)
-* [HIP Cooperative groups API](./reference/cooperative_groups_reference)
 * [List of deprecated APIs](./reference/deprecated_api_list)
 
 :::

diff --git a/docs/reference/hip_runtime_api/callback_activity_apis.rst b/docs/reference/hip_runtime_api/callback_activity_apis.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The callback activity APIs reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, callback activity APIs, callback activity
+
+.. _callback_activity_apis_reference:
+
+*******************************************************************************
+Callback activity APIs
+*******************************************************************************
+
+.. doxygengroup:: Callback
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/context_management.rst b/docs/reference/hip_runtime_api/context_management.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The context management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, context management, context
+
+.. _context_management_reference:
+
+*******************************************************************************
+Context management [deprecated]
+*******************************************************************************
+
+.. doxygengroup:: Context
+   :content-only:
diff --git a/...eference/cooperative_groups_reference.rst → ...time_api/cooperative_groups_reference.rst b/...eference/cooperative_groups_reference.rst → ...time_api/cooperative_groups_reference.rst
@@ -1,11 +1,13 @@
 .. meta::
-  :description: This chapter lists types and device API wrappers related to the Cooperative Group feature. Programmers can directly use these API features in their kernels.
+  :description: This chapter lists types and device API wrappers related to the 
+                Cooperative Group feature. Programmers can directly use these 
+                API features in their kernels.
   :keywords: AMD, ROCm, HIP, cooperative groups
 
 .. _cooperative_groups_reference:
 
 *******************************************************************************
-HIP Cooperative groups API
+Cooperative groups
 *******************************************************************************
 
 Cooperative kernel launches

diff --git a/docs/reference/hip_runtime_api/device_management.rst b/docs/reference/hip_runtime_api/device_management.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The device management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, device management, device
+
+.. _device_management_reference:
+
+*******************************************************************************
+Device management
+*******************************************************************************
+
+.. doxygengroup:: Device
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/error_handling.rst b/docs/reference/hip_runtime_api/error_handling.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The error handling reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, error handling, error
+
+.. _error_handling_reference:
+
+*******************************************************************************
+Error handling
+*******************************************************************************
+
+.. doxygengroup:: Error
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/event_management.rst b/docs/reference/hip_runtime_api/event_management.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The event management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, event management, event
+
+.. _event_management_reference:
+
+*******************************************************************************
+Event management
+*******************************************************************************
+
+.. doxygengroup:: Event
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/execution_control.rst b/docs/reference/hip_runtime_api/execution_control.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The execution control reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, execution control, execution
+
+.. _execution_control_reference:
+
+*******************************************************************************
+Execution control
+*******************************************************************************
+
+.. doxygengroup:: Execution
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/global_enum_and_defines.rst b/docs/reference/hip_runtime_api/global_enum_and_defines.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The global enum and defines reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, global enum, defines
+
+.. _global_enum_defines_reference:
+
+*******************************************************************************
+Global enum and defines
+*******************************************************************************
+
+.. doxygengroup:: GlobalDefs
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/graph_management.rst b/docs/reference/hip_runtime_api/graph_management.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The graph management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, graph management, graph
+
+.. _graph_management_reference:
+
+*******************************************************************************
+Graph management
+*******************************************************************************
+
+.. doxygengroup:: Graph
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/initialization_and_version.rst b/docs/reference/hip_runtime_api/initialization_and_version.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The initialization and version reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, initialization, version
+
+.. _initialization_version_reference:
+
+*******************************************************************************
+Initialization and version
+*******************************************************************************
+
+.. doxygengroup:: Driver
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/launch_api.rst b/docs/reference/hip_runtime_api/launch_api.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The launch API reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, launch API, triple-chevron
+
+.. _launch_api_reference:
+
+*******************************************************************************
+Launch API
+*******************************************************************************
+
+.. doxygengroup:: Clang
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/memory_management.rst b/docs/reference/hip_runtime_api/memory_management.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The memory management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, memory management, memory
+
+.. _memory_management_reference:
+
+*******************************************************************************
+Memory management
+*******************************************************************************
+
+.. doxygengroup:: Memory
+   :content-only:
diff --git a/...erence/hip_runtime_api/memory_management/external_resource_interoperability.rst b/...erence/hip_runtime_api/memory_management/external_resource_interoperability.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The external resource interoperability reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, external resource interoperability
+
+.. _external_resource_interoperability_reference:
+
+*******************************************************************************
+External resource interoperability
+*******************************************************************************
+
+.. doxygengroup:: External
+   :content-only:
diff --git a/...reference/hip_runtime_api/memory_management/stream_ordered_memory_allocator.rst b/...reference/hip_runtime_api/memory_management/stream_ordered_memory_allocator.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The stream ordered memory allocator reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, stream ordered memory allocator
+
+.. _stream_ordered_memory_allocator_reference:
+
+*******************************************************************************
+Stream ordered memory allocator
+*******************************************************************************
+
+.. doxygengroup:: StreamO
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/memory_management/surface_object.rst b/docs/reference/hip_runtime_api/memory_management/surface_object.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The surface object reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, surface object, surface
+
+.. _surface_object_reference:
+
+*******************************************************************************
+Surface object
+*******************************************************************************
+
+.. doxygengroup:: Surface
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/memory_management/texture_management.rst b/docs/reference/hip_runtime_api/memory_management/texture_management.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The texture management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, texture management, texture
+
+.. _texture_management_reference:
+
+*******************************************************************************
+Texture management
+*******************************************************************************
+
+.. doxygengroup:: Texture
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/memory_management/texture_management_deprecated.rst b/docs/reference/hip_runtime_api/memory_management/texture_management_deprecated.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The deprecated texture management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, deprecated texture management
+
+.. _texture_management_deprecated_reference:
+
+*******************************************************************************
+Texture management (deprecated)
+*******************************************************************************
+
+.. doxygengroup:: TextureD
+   :content-only:
diff --git a/docs/reference/unified_memory_reference.rst → ...y_management/unified_memory_reference.rst b/docs/reference/unified_memory_reference.rst → ...y_management/unified_memory_reference.rst
@@ -1,12 +1,11 @@
 .. meta::
-  :description: This chapter describes introduces Unified Memory (UM) and shows
-                how to use it in AMD HIP.
+  :description: The managed memory reference page.
   :keywords: AMD, ROCm, HIP, CUDA, unified memory, unified, memory, UM, APU
 
 .. _unified_memory_reference:
 
 *******************************************************************************
-HIP managed memory allocation API
+Managed memory
 *******************************************************************************
 
 .. doxygengroup:: MemoryM

diff --git a/docs/reference/virtual_memory_reference.rst → ...y_management/virtual_memory_reference.rst b/docs/reference/virtual_memory_reference.rst → ...y_management/virtual_memory_reference.rst
@@ -1,12 +1,11 @@
 .. meta::
-  :description: This topic describes introduces Virtual Memory (VM) and shows
-                how to use it in AMD HIP.
+  :description: The virtual memory (VM) management reference page.
   :keywords: AMD, ROCm, HIP, CUDA, virtual memory, virtual, memory, VM
 
 .. _virtual_memory_reference:
 
 *******************************************************************************
-HIP virtual memory management API
+Virtual memory management
 *******************************************************************************
 
 .. doxygengroup:: Virtual

diff --git a/docs/reference/hip_runtime_api/module_management.rst b/docs/reference/hip_runtime_api/module_management.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The module management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, module management, module
+
+.. _module_management_reference:
+
+*******************************************************************************
+Module management
+*******************************************************************************
+
+.. doxygengroup:: Module
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/occupancy.rst b/docs/reference/hip_runtime_api/occupancy.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The occupancy reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, occupancy
+
+.. _occupancy_reference:
+
+*******************************************************************************
+Occupancy
+*******************************************************************************
+
+.. doxygengroup:: Occupancy
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/opengl_interoperability.rst b/docs/reference/hip_runtime_api/opengl_interoperability.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The OpenGL interoperability reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, OpenGL interoperability, OpenGL interop
+
+.. _opengl_interoperability_reference:
+
+*******************************************************************************
+OpenGL interoperability
+*******************************************************************************
+
+.. doxygengroup:: GL
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/peer_to_peer_device_memory_access.rst b/docs/reference/hip_runtime_api/peer_to_peer_device_memory_access.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The peer to peer device memory access reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, peer to peer device memory access, peer to peer
+
+.. _peer_to_peer_device_memory_access_reference:
+
+*******************************************************************************
+Peer to peer device memory access
+*******************************************************************************
+
+.. doxygengroup:: PeerToPeer
+   :content-only:
diff --git a/docs/reference/hip_runtime_api/profiler_control.rst b/docs/reference/hip_runtime_api/profiler_control.rst
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The profiler control reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, profiler control, profiler
+
+.. _profiler_control_reference:
+
+*******************************************************************************
+Profiler control
+*******************************************************************************
+
+.. doxygengroup:: Profiler
+   :content-only: