From eced013ae486e9f8a2c135414dc4e3b804d4c72f Mon Sep 17 00:00:00 2001 From: Ben Sander Date: Wed, 23 Mar 2016 23:11:15 -0500 Subject: [PATCH] Update docs: - Some comments in hip_hcc.cpp - document hipHostRegister* flags. - expand docs on hipHostRegister/Unregister. Use "register" rather than "pin" to describe action these take. - change required CUDA version to 6 (require unified memory) - remake doxygen. --- docs/RuntimeAPI/html/Synchonization.html | 2 +- docs/RuntimeAPI/html/annotated.html | 25 +- docs/RuntimeAPI/html/bug.html | 10 +- docs/RuntimeAPI/html/classes.html | 27 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 8 +- .../dir_6d8604cb65fa6b83549668eb0ce09cac.html | 8 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 4 +- docs/RuntimeAPI/html/files.html | 6 +- docs/RuntimeAPI/html/functions.html | 25 +- docs/RuntimeAPI/html/functions_vars.html | 17 +- docs/RuntimeAPI/html/globals.html | 65 +- docs/RuntimeAPI/html/globals_defs.html | 17 +- docs/RuntimeAPI/html/globals_enum.html | 2 +- docs/RuntimeAPI/html/globals_eval.html | 2 +- docs/RuntimeAPI/html/globals_func.html | 82 +- docs/RuntimeAPI/html/globals_type.html | 2 +- docs/RuntimeAPI/html/globals_vars.html | 2 +- docs/RuntimeAPI/html/group__API.html | 2 +- docs/RuntimeAPI/html/group__Device.html | 96 +- docs/RuntimeAPI/html/group__Error.html | 2 +- docs/RuntimeAPI/html/group__Event.html | 6 +- docs/RuntimeAPI/html/group__GlobalDefs.html | 92 +- .../RuntimeAPI/html/group__HCC__Specific.html | 6 +- docs/RuntimeAPI/html/group__HIP-ENV.html | 2 +- docs/RuntimeAPI/html/group__Memory.html | 368 ++++++- docs/RuntimeAPI/html/group__PeerToPeer.html | 7 +- docs/RuntimeAPI/html/group__Profiler.html | 2 +- docs/RuntimeAPI/html/group__Stream.html | 26 +- docs/RuntimeAPI/html/group__Texture.html | 2 +- docs/RuntimeAPI/html/group__Version.html | 2 +- .../html/hcc__detail_2hip__runtime_8h.html | 62 +- .../hcc__detail_2hip__runtime_8h_source.html | 916 +++++++++--------- .../hcc__detail_2hip__runtime__api_8h.html | 104 +- ...__detail_2hip__runtime__api_8h_source.html | 624 ++++++------ .../hcc__detail_2hip__vector__types_8h.html | 4 +- ..._detail_2hip__vector__types_8h_source.html | 4 +- docs/RuntimeAPI/html/hierarchy.html | 27 +- .../html/hip__common_8h_source.html | 4 +- docs/RuntimeAPI/html/hip__hcc_8cpp.html | 428 ++++++-- .../html/hip__runtime_8h_source.html | 37 +- .../html/hip__runtime__api_8h_source.html | 333 ++++--- docs/RuntimeAPI/html/hip__texture_8h.html | 4 +- .../html/hip__texture_8h_source.html | 142 +-- .../html/hip__vector__types_8h_source.html | 4 +- docs/RuntimeAPI/html/host__defines_8h.html | 4 +- .../html/host__defines_8h_source.html | 4 +- docs/RuntimeAPI/html/index.html | 2 +- docs/RuntimeAPI/html/modules.html | 2 +- docs/RuntimeAPI/html/pages.html | 2 +- docs/RuntimeAPI/html/search/all_10.js | 7 +- docs/RuntimeAPI/html/search/all_11.js | 5 +- docs/RuntimeAPI/html/search/all_12.js | 2 +- docs/RuntimeAPI/html/search/all_13.js | 2 +- docs/RuntimeAPI/html/search/all_14.js | 2 +- docs/RuntimeAPI/html/search/all_3.js | 1 + docs/RuntimeAPI/html/search/all_6.js | 2 +- docs/RuntimeAPI/html/search/all_7.js | 143 +-- docs/RuntimeAPI/html/search/all_8.js | 165 +++- docs/RuntimeAPI/html/search/all_9.js | 7 +- docs/RuntimeAPI/html/search/all_a.js | 12 +- docs/RuntimeAPI/html/search/all_b.js | 13 +- docs/RuntimeAPI/html/search/all_c.js | 2 +- docs/RuntimeAPI/html/search/all_d.js | 3 +- docs/RuntimeAPI/html/search/all_e.js | 3 +- docs/RuntimeAPI/html/search/all_f.js | 3 +- docs/RuntimeAPI/html/search/classes_1.js | 5 +- docs/RuntimeAPI/html/search/classes_2.js | 8 +- docs/RuntimeAPI/html/search/classes_3.js | 7 +- docs/RuntimeAPI/html/search/classes_4.js | 5 +- docs/RuntimeAPI/html/search/classes_5.js | 6 +- docs/RuntimeAPI/html/search/enumvalues_0.js | 7 + docs/RuntimeAPI/html/search/functions_0.js | 45 +- docs/RuntimeAPI/html/search/search.js | 8 +- docs/RuntimeAPI/html/search/variables_1.js | 1 + docs/RuntimeAPI/html/search/variables_2.js | 6 +- docs/RuntimeAPI/html/search/variables_3.js | 2 +- docs/RuntimeAPI/html/search/variables_4.js | 10 +- docs/RuntimeAPI/html/search/variables_5.js | 11 +- docs/RuntimeAPI/html/search/variables_6.js | 3 +- docs/RuntimeAPI/html/search/variables_7.js | 3 +- docs/RuntimeAPI/html/search/variables_8.js | 2 +- docs/RuntimeAPI/html/search/variables_9.js | 3 +- docs/RuntimeAPI/html/search/variables_a.js | 3 +- docs/RuntimeAPI/html/search/variables_b.js | 2 +- docs/RuntimeAPI/html/search/variables_c.js | 2 +- docs/RuntimeAPI/html/search/variables_d.js | 2 +- docs/RuntimeAPI/html/structdim3-members.html | 2 +- docs/RuntimeAPI/html/structdim3.html | 4 +- .../structhipChannelFormatDesc-members.html | 2 +- .../html/structhipChannelFormatDesc.html | 4 +- .../html/structhipDeviceArch__t-members.html | 2 +- .../html/structhipDeviceArch__t.html | 4 +- .../html/structhipDeviceProp__t-members.html | 35 +- .../html/structhipDeviceProp__t.html | 18 +- .../html/structhipEvent__t-members.html | 2 +- docs/RuntimeAPI/html/structhipEvent__t.html | 4 +- .../html/structihipDevice__t-members.html | 18 +- docs/RuntimeAPI/html/structihipDevice__t.html | 72 +- .../html/structihipEvent__t-members.html | 13 +- docs/RuntimeAPI/html/structihipEvent__t.html | 12 +- .../html/structtexture-members.html | 2 +- docs/RuntimeAPI/html/structtexture.html | 4 +- .../html/structtextureReference-members.html | 2 +- .../html/structtextureReference.html | 4 +- docs/markdown/hip_faq.md | 2 +- include/hcc_detail/hip_runtime_api.h | 64 +- src/hip_hcc.cpp | 5 +- 107 files changed, 2766 insertions(+), 1646 deletions(-) diff --git a/docs/RuntimeAPI/html/Synchonization.html b/docs/RuntimeAPI/html/Synchonization.html index f60f0cc1e4..d1d49391dd 100644 --- a/docs/RuntimeAPI/html/Synchonization.html +++ b/docs/RuntimeAPI/html/Synchonization.html @@ -109,7 +109,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/annotated.html b/docs/RuntimeAPI/html/annotated.html index 4a61698f75..1d7e7e2a5b 100644 --- a/docs/RuntimeAPI/html/annotated.html +++ b/docs/RuntimeAPI/html/annotated.html @@ -90,21 +90,26 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Here are the classes, structs, unions and interfaces with brief descriptions:
- - - - - - - - - + + + + + + + + + + + + + +
oCdim3
oChipChannelFormatDesc
oChipDeviceArch_t
oChipDeviceProp_t
oChipEvent_t
oCihipDevice_t
oCihipEvent_t
oCihipStream_t
oCtexture
\CtextureReference
oCFakeMutex
oChipChannelFormatDesc
oChipDeviceArch_t
oChipDeviceProp_t
oChipEvent_t
oChipPointerAttribute_t
oCihipDevice_t
oCihipEvent_t
oCihipException
oCihipSignal_t
oCihipStream_t
oCStagingBuffer
oCtexture
\CtextureReference
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/bug.html b/docs/RuntimeAPI/html/bug.html index d9c64d7eb8..ef94caaa9f 100644 --- a/docs/RuntimeAPI/html/bug.html +++ b/docs/RuntimeAPI/html/bug.html @@ -80,22 +80,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
-
Member hipDeviceGetProperties (hipDeviceProp_t *prop, int device)
+
Member hipGetDeviceProperties (hipDeviceProp_t *prop, int device)

HCC always returns 0 for maxThreadsPerMultiProcessor

HCC always returns 0 for regsPerBlock

HCC always returns 0 for l2CacheSize

-
Member hipDeviceReset (void)
-
On HCC, hipDeviceReset is a nop and does not reset the device state.
Member hipMemcpyPeerAsync (void *dst, int dstDevice, const void *src, int srcDevice, size_t sizeBytes, hipStream_t stream=0)
This function uses a synchronous copy
Member hipStreamWaitEvent (hipStream_t stream, hipEvent_t event, unsigned int flags)
-
This function conservatively waits for all work in the specified stream to complete.
+
This function conservatively waits for all work in the specified stream to complete.
+
Member ihipDevice_t::getProperties (hipDeviceProp_t *prop)
+
: on HCC, isMultiGpuBoard returns True if system contains multiple GPUS (rather than if GPU is on a multi-ASIC board)
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/classes.html b/docs/RuntimeAPI/html/classes.html index 70491ef32f..205d994eda 100644 --- a/docs/RuntimeAPI/html/classes.html +++ b/docs/RuntimeAPI/html/classes.html @@ -87,25 +87,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Class Index
-
D | H | I | T
+
D | F | H | I | S | T
- - - + + + - - - - + + +
  d  
+
  F  
+
  d  
hipDeviceArch_t   ihipEvent_t   textureReference   
hipDeviceProp_t   ihipStream_t   
dim3   hipEvent_t   
  t  
+
hipDeviceProp_t   ihipException   
FakeMutex   dim3   hipEvent_t   ihipSignal_t   
  S  
+
  h  
+		hipPointerAttribute_t   ihipStream_t   
  i  
+
  t  
  h  
-
  i  
-
texture   
hipChannelFormatDesc   ihipDevice_t   
StagingBuffer   hipChannelFormatDesc   
ihipDevice_t   texture   
-
D | H | I | T
+
D | F | H | I | S | T
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/RuntimeAPI/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 7d6a9d0e72..71b55290ce 100644 --- a/docs/RuntimeAPI/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/RuntimeAPI/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -4,7 +4,7 @@ -HIP: Heterogenous-computing Interface for Portability: /home/bensander/HIP.public/src Directory Reference +HIP: Heterogenous-computing Interface for Portability: /home/bensander/HIP-privatestaging/src Directory Reference @@ -88,11 +88,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); Files file  hip_hcc.cpp   +file  hip_hcc2.cpp +  +file  staging_buffer.cpp + 
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/dir_6d8604cb65fa6b83549668eb0ce09cac.html b/docs/RuntimeAPI/html/dir_6d8604cb65fa6b83549668eb0ce09cac.html index 9fb345b393..32a8932ad9 100644 --- a/docs/RuntimeAPI/html/dir_6d8604cb65fa6b83549668eb0ce09cac.html +++ b/docs/RuntimeAPI/html/dir_6d8604cb65fa6b83549668eb0ce09cac.html @@ -4,7 +4,7 @@ -HIP: Heterogenous-computing Interface for Portability: /home/bensander/HIP.public/include/hcc_detail Directory Reference +HIP: Heterogenous-computing Interface for Portability: /home/bensander/HIP-privatestaging/include/hcc_detail Directory Reference @@ -101,11 +101,15 @@ Files file  host_defines.h [code]  TODO-doc.
  +file  staging_buffer.h [code] +  +file  trace_helper.h [code] + 
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/RuntimeAPI/html/dir_d44c64559bbebec7f509842c48db8b23.html index 34ef4a1333..1eaa18e079 100644 --- a/docs/RuntimeAPI/html/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/docs/RuntimeAPI/html/dir_d44c64559bbebec7f509842c48db8b23.html @@ -4,7 +4,7 @@ -HIP: Heterogenous-computing Interface for Portability: /home/bensander/HIP.public/include Directory Reference +HIP: Heterogenous-computing Interface for Portability: /home/bensander/HIP-privatestaging/include Directory Reference @@ -103,7 +103,7 @@ Files
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/files.html b/docs/RuntimeAPI/html/files.html index bbb7037a0e..0e4f7bba8b 100644 --- a/docs/RuntimeAPI/html/files.html +++ b/docs/RuntimeAPI/html/files.html @@ -93,7 +93,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); ||o*hip_runtime_api.hContains C function APIs for HIP runtime. This file does not use any HCC builtin or special language extensions (-hc mode) ; those functions in hip_runtime.h ||o*hip_texture.hHIP C++ Texture API for hcc compiler ||o*hip_vector_types.hDefines the different newt vector types for HIP runtime -||\*host_defines.hTODO-doc +||o*host_defines.hTODO-doc +||o*staging_buffer.h +||\*trace_helper.h |o*hip_common.h |o*hip_runtime.h |o*hip_runtime_api.h @@ -105,7 +107,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
-Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by   +Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by   doxygen 1.8.6
diff --git a/docs/RuntimeAPI/html/functions.html b/docs/RuntimeAPI/html/functions.html index ce1f2c7bf7..e6a4e60528 100644 --- a/docs/RuntimeAPI/html/functions.html +++ b/docs/RuntimeAPI/html/functions.html @@ -70,6 +70,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); @@ -77,7 +78,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');