diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index efed5ed..dfe0866 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -284,6 +284,7 @@ TAB_SIZE = 4 # @} or use a double escape (\\{ and \\}) ALIASES = hipFileError_t="A hipFileError_t struct that holds both hipFile and HIP error values" +ALIASES += max_io_size_note="@note The maximum IO size is determined by the Linux kernel and is currently 2^31 - PAGE_SIZE" # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For diff --git a/include/hipfile.h b/include/hipfile.h index 6387481..0422f0b 100644 --- a/include/hipfile.h +++ b/include/hipfile.h @@ -532,6 +532,8 @@ hipFileError_t hipFileBufDeregister(const void *buffer_base); * hipFileRead() will transfer at most 0x7ffff000 (2,147,479,552) bytes, * returning the number of bytes actually transferred. * + * \max_io_size_note + * * @param [in] fh Opaque file handle for GPU IO operations * @param [in] buffer_base Base address of the GPU buffer * @param [in] size Number of bytes that should be read @@ -553,6 +555,8 @@ ssize_t hipFileRead(hipFileHandle_t fh, void *buffer_base, size_t size, hoff_t f * hipFileWrite() will transfer at most 0x7ffff000 (2,147,479,552) bytes, * returning the number of bytes actually transferred. * + * \max_io_size_note + * * @param [in] fh Opaque file handle for GPU IO operations * @param [in] buffer_base Base address of the GPU buffer * @param [in] size Number of bytes that should be written @@ -898,6 +902,8 @@ void hipFileBatchIODestroy(hipFileBatchHandle_t batch_idp); * @param [in] stream The hipStream to enqueue this async IO request. * If NULL, this request will be synchronous. * + * \max_io_size_note + * * @return \hipFileError_t * @return hipFileSuccess * @return hipFileDriverError @@ -912,6 +918,8 @@ hipFileError_t hipFileReadAsync(hipFileHandle_t fh, void *buffer_base, size_t *s * @brief Perform an asynchronous write to a stream * @ingroup async * + * \max_io_size_note + * * @param [in] fh Opaque file handle for GPU IO operations * @param [in] buffer_base Base address of the GPU buffer * @param [in] size_p Number of bytes that should be written