Update documentation

Sync with the latest changes from upstream repo

Change-Id: I309880f5c7f77c58a8b186db320bbc0f0e634089


[ROCm/ROCR-Runtime commit: c48b858093]
This commit is contained in:
Chris Freehill
2024-07-23 19:05:40 -05:00
committed by David Yat Sin
parent 3bdfe00bb7
commit 5f20d2f242
12 changed files with 368 additions and 35 deletions
@@ -0,0 +1,84 @@
.. meta::
:description: HSA runtime implementation
:keywords: ROCR, ROCm, library, tool, runtime
.. _rocr-api:
API
===
:ref:`genindex`
:ref:`search`
Architected Queuing Language
############################
.. doxygengroup:: aql
:content-only:
:inner:
Code Objects [**DEPRECATED**]
#############################
.. doxygengroup:: code-object
:content-only:
:inner:
Executable
##########
.. doxygengroup:: executable
:content-only:
:inner:
Finalization Extensions
#######################
.. doxygengroup:: ext-alt-finalizer-extensions
:content-only:
:inner:
Finalization Program
####################
.. doxygengroup:: ext-alt-finalizer-program
:content-only:
:inner:
Images And Samplers
###################
.. doxygengroup:: ext-images
:content-only:
:inner:
Instruction Set Architecture
############################
.. doxygengroup:: instruction-set-architecture
:content-only:
:inner:
Memory
######
.. doxygengroup:: memory
:content-only:
:inner:
Queues
######
.. doxygengroup:: queue
:content-only:
:inner:
Runtime Notifications
#####################
.. doxygengroup:: status
:content-only:
:inner:
Signals
#######
.. doxygengroup:: signals
:content-only:
:inner:
System And Agent Information
############################
.. doxygengroup:: agentinfo
:content-only:
:inner:
@@ -0,0 +1,16 @@
.. meta::
:description: HSA runtime implementation
:keywords: ROCR, ROCm, library, tool, runtime
.. _c-interface-adaptors:
C interface adaptors
=====================
The C interface layer is the :ref:`top layer in ROCR <runtime-design>` that provides C++ APIs as defined in the `HSA Runtime Specification 1.2 <https://hsafoundation.com/wp-content/uploads/2021/02/HSA-Runtime-1.2.pdf>`_. The C interface layer also consists of the interfaces and default definitions for the standard extensions. The interface functions simply forward to a function pointer table defined here. The table is initialized to point to default definitions, which simply returns an appropriate error code. If available, the extension library is loaded as part of runtime initialization and the table is updated to point to the extension library.
Files present in this layer:
- ``hsa.h`` (cpp)
- ``hsa_ext_interface.h`` (cpp)
@@ -0,0 +1,34 @@
.. meta::
:description: HSA runtime implementation
:keywords: ROCR, ROCm, library, tool, runtime
.. _environment-variables:
Environment variables
========================
The following table lists the most often used environment variables.
.. list-table:: ROCR environment variables
:header-rows: 1
* - Environment variable
- Possible values
- Description
* - HSA_ENABLE_SDMA
-
* 0: Disabled
* 1: Enabled (default)
- This controls the use of DMA engines in all copy directions (Host-to-Device, Device-to-Host, Device-to-Device) when using the
``hsa_memory_copy``, ``hsa_amd_memory_fill``, ``hsa_amd_memory_async_copy``, ``hsa_amd_memory_async_copy_on_engine`` APIs
* - HSA_ENABLE_PEER_SDMA
-
* 0: Disabled
* 1: Enabled (default)
- This controls the use of DMA engines for Device-to-Device copies when using the ``hsa_memory_copy``, ``hsa_amd_memory_async_copy``, ``hsa_amd_memory_async_copy_on_engine`` APIs
.. note::
The value of ``HSA_ENABLE_PEER_SDMA`` is ignored if ``HSA_ENABLE_SDMA`` is used to disable the use of DMA engines.