Add 'projects/hip/' from commit 'e74b05a7bd9454b97dc04d7cc4b66d1fe6c534a7'

git-subtree-dir: projects/hip git-subtree-mainline: 64df0940b8 git-subtree-split: e74b05a7bd
2025-08-10 02:09:42 +00:00
parent 64df0940b8 e74b05a7bd
commit d76041b87b
231 changed files with 63214 additions and 0 deletions
@@ -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:
@@ -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:
@@ -0,0 +1,70 @@
+.. 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.
+  :keywords: AMD, ROCm, HIP, cooperative groups
+
+.. _cooperative_groups_reference:
+
+*******************************************************************************
+Cooperative groups
+*******************************************************************************
+
+Cooperative kernel launches
+===========================
+
+The following host-side functions are used for cooperative kernel launches.
+
+.. doxygengroup:: ModuleCooperativeG
+   :content-only:
+
+Cooperative groups classes
+==========================
+
+The following cooperative groups classes can be used on the device side.
+
+.. _thread_group_ref:
+
+.. doxygenclass:: cooperative_groups::thread_group
+   :members:
+
+.. _thread_block_ref:
+
+.. doxygenclass:: cooperative_groups::thread_block
+   :members:
+
+.. _grid_group_ref:
+
+.. doxygenclass:: cooperative_groups::grid_group
+   :members:
+
+.. _multi_grid_group_ref:
+
+.. doxygenclass:: cooperative_groups::multi_grid_group
+   :members:
+
+.. _thread_block_tile_ref:
+
+.. doxygenclass:: cooperative_groups::thread_block_tile
+   :members:
+
+.. _coalesced_group_ref:
+
+.. doxygenclass:: cooperative_groups::coalesced_group
+   :members:
+
+Cooperative groups construct functions
+======================================
+
+The following functions are used to construct different group-type instances on the device side.
+
+.. doxygengroup:: CooperativeGConstruct
+   :content-only:
+
+Cooperative groups exposed API functions
+========================================
+
+The following functions are the exposed API for different group-type instances on the device side.
+
+.. doxygengroup:: CooperativeGAPI
+   :content-only:
@@ -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:
@@ -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:
@@ -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:
@@ -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:
@@ -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:
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The Graphics interoperability reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, Graphics interoperability
+
+.. _graphics_interoperability_reference:
+
+*******************************************************************************
+Graphics interoperability
+*******************************************************************************
+
+.. doxygengroup:: GraphicsInterop
+   :content-only:
@@ -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:
@@ -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:
@@ -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:
@@ -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:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The deprecated memory management reference page.
+
+.. _memory_management_deprecated_reference:
+
+*******************************************************************************
+Memory management (deprecated)
+*******************************************************************************
+
+.. doxygengroup:: MemoryD
+   :content-only:
@@ -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:
@@ -0,0 +1,15 @@
+.. meta::
+  :description: The surface object reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, surface object, surface
+
+.. _surface_object_reference:
+
+*******************************************************************************
+Surface object
+*******************************************************************************
+
+.. doxygengroup:: Surface
+   :content-only:
+
+.. doxygengroup:: SurfaceAPI
+   :content-only:
@@ -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:
@@ -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:
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The managed memory reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, unified memory, unified, memory, UM, APU
+
+.. _unified_memory_reference:
+
+*******************************************************************************
+Managed memory
+*******************************************************************************
+
+.. doxygengroup:: MemoryM
+   :content-only:
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The virtual memory (VM) management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, virtual memory, virtual, memory, VM
+
+.. _virtual_memory_reference:
+
+*******************************************************************************
+Virtual memory management
+*******************************************************************************
+
+.. doxygengroup:: Virtual
+   :content-only:
@@ -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:
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The occupancy reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, occupancy
+
+.. _occupancy_reference:
+
+*******************************************************************************
+Occupancy
+*******************************************************************************
+
+.. doxygengroup:: Occupancy
+   :content-only:
@@ -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:
@@ -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:
@@ -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:
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The runtime compilation reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, runtime compilation
+
+.. _runtime_compilation_reference:
+
+*******************************************************************************
+Runtime compilation
+*******************************************************************************
+
+.. doxygengroup:: Runtime
+   :content-only:
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The stream management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, stream management, stream
+
+.. _stream_management_reference:
+
+*******************************************************************************
+Stream management
+*******************************************************************************
+
+.. doxygengroup:: Stream
+   :content-only:
@@ -0,0 +1,12 @@
+.. meta::
+  :description: The stream memory operations reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, stream memory operations
+
+.. _stream_memory_operations_reference:
+
+*******************************************************************************
+Stream memory operations
+*******************************************************************************
+
+.. doxygengroup:: StreamM
+   :content-only: