From 6cc920ec330331075b6fc707de5fd7d531fbee14 Mon Sep 17 00:00:00 2001 From: Istvan Kiss Date: Mon, 30 Sep 2024 16:51:21 +0200 Subject: [PATCH] Update driver api reference page --- docs/how-to/hip_porting_driver_api.rst | 4 +- docs/index.md | 1 - docs/reference/driver_api_reference.rst | 47 ------------------- .../global_defines_enums_structs_files.rst | 1 + .../driver_types.rst | 12 +++++ docs/sphinx/_toc.yml.in | 2 +- 6 files changed, 16 insertions(+), 51 deletions(-) delete mode 100644 docs/reference/driver_api_reference.rst create mode 100644 docs/reference/hip_runtime_api/global_defines_enums_structs_files/driver_types.rst diff --git a/docs/how-to/hip_porting_driver_api.rst b/docs/how-to/hip_porting_driver_api.rst index 607c5f6d8a..ccc7f21e93 100644 --- a/docs/how-to/hip_porting_driver_api.rst +++ b/docs/how-to/hip_porting_driver_api.rst @@ -73,7 +73,7 @@ Notably, there is no fat binary format that can contain code for both NVCC and H The ``hipModule`` API can be used to load additional code objects. When used this way, it extends the capability of the automatically loaded code objects. HIP-Clang enables both of these capabilities to be used together. Of course, it is possible to create a program with no kernels and no automatic loading. -For module API reference, visit :ref:`driver_api_module_reference`. +For module API reference, visit :ref:`module_management_reference`. hipCtx API ---------- @@ -81,7 +81,7 @@ hipCtx API HIP provides a ``Ctx`` API as a thin layer over the existing device functions. The ``Ctx`` API can be used to set the current context or to query properties of the device associated with the context. The current context is implicitly used by other APIs, such as ``hipStreamCreate``. -For context reference, visit :ref:`driver_api_context_reference`. +For context reference, visit :ref:`context_management_reference`. HIPIFY translation of CUDA driver API ===================================== diff --git a/docs/index.md b/docs/index.md index 8dbc2441e5..a659b9b83a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -60,7 +60,6 @@ On non-AMD platforms, like NVIDIA, HIP provides header files required to support * [HSA runtime API for ROCm](./reference/virtual_rocr) * [C++ language extensions](./reference/cpp_language_extensions) * [C++ language support](./reference/cpp_language_support) -* [Driver API](./reference/driver_api_reference) * [HIP math API](./reference/math_api) * [Comparing syntax for different APIs](./reference/terms) * [List of deprecated APIs](./reference/deprecated_api_list) diff --git a/docs/reference/driver_api_reference.rst b/docs/reference/driver_api_reference.rst deleted file mode 100644 index b879ddc95f..0000000000 --- a/docs/reference/driver_api_reference.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. meta:: - :description: This chapter will present CUDA driver API porting and showcase equivalent operations in HIP. - :keywords: AMD, ROCm, HIP, CUDA, driver API - -.. _driver_api_reference: - -******************************************************************************* -Driver API reference -******************************************************************************* - -This page presents a list of driver API functions supported by HIP. - -For comparison, compatibility, and version information with the CUDA driver API, visit :doc:`hipify:index`. - -HIP driver API -============== - -.. _driver_api_context_reference: - -Context -------- - -.. doxygengroup:: Context - :content-only: - -.. _driver_api_module_reference: - -Module ------- - -.. doxygengroup:: Module - :content-only: - -.. _driver_api_entry_point_reference: - -Driver entry point access -------------------------- - -.. doxygenfunction:: hipGetProcAddress - -.. _driver_api_types_reference: - -Driver types ------------- - -.. doxygengroup:: DriverTypes - :content-only: \ No newline at end of file diff --git a/docs/reference/hip_runtime_api/global_defines_enums_structs_files.rst b/docs/reference/hip_runtime_api/global_defines_enums_structs_files.rst index 7123ab5d77..60236e5169 100644 --- a/docs/reference/hip_runtime_api/global_defines_enums_structs_files.rst +++ b/docs/reference/hip_runtime_api/global_defines_enums_structs_files.rst @@ -10,5 +10,6 @@ Global defines, enums, structs and files The structs, define macros, enums and files in the HIP runtime API. * :ref:`global_enum_defines_reference` +* :ref:`driver_types_reference` * :doc:`hip:doxygen/html/annotated` * :doc:`hip:doxygen/html/files` diff --git a/docs/reference/hip_runtime_api/global_defines_enums_structs_files/driver_types.rst b/docs/reference/hip_runtime_api/global_defines_enums_structs_files/driver_types.rst new file mode 100644 index 0000000000..552f344e69 --- /dev/null +++ b/docs/reference/hip_runtime_api/global_defines_enums_structs_files/driver_types.rst @@ -0,0 +1,12 @@ +.. meta:: + :description: The driver types reference page. + :keywords: AMD, ROCm, HIP, CUDA, driver types + +.. _driver_types_reference: + +******************************************************************************* +Driver types +******************************************************************************* + +.. doxygengroup:: DriverTypes + :content-only: diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 45360b5d71..6a70b9e2ad 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -78,6 +78,7 @@ subtrees: subtrees: - entries: - file: reference/hip_runtime_api/global_defines_enums_structs_files/global_enum_and_defines + - file: reference/hip_runtime_api/global_defines_enums_structs_files/driver_types - file: doxygen/html/annotated - file: doxygen/html/files - file: reference/virtual_rocr @@ -85,7 +86,6 @@ subtrees: title: C++ language extensions - file: reference/cpp_language_support title: C++ language support - - file: reference/driver_api_reference - file: reference/math_api - file: reference/terms title: Comparing syntax for different APIs