revert to 2024.1-1

Author: Jdavidbr-alt

latest/404.html

@@ -0,0 +1 @@
+f8e43c984bed2b2393e8119006e0fae46116aaed

latest/assets/.doxy/opae-code/hashChanges.yaml

@@ -0,0 +1,156 @@
+
+# File access.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sw**](dir_55721a669a8e0900d975c02921addb49.md) **>** [**include**](dir_97b4588afba69bf89bbe554642ac6431.md) **>** [**opae**](dir_ade97cd9199f278c0723672dd8647ba4.md) **>** [**access.h**](access_8h.md)
+
+[Go to the source code of this file.](access_8h_source.md)
+
+_Functions to acquire, release, and reset OPAE FPGA resources._ 
+
+* `#include <opae/types.h>`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions
+
+| Type | Name |
+| ---: | :--- |
+|  [**fpga\_result**](types__enum_8h.md#enum-fpga_result) | [**fpgaClose**](#function-fpgaclose) ([**fpga\_handle**](types_8h.md#typedef-fpga_handle) handle) <br>_Close a previously opened FPGA object._  |
+|  [**fpga\_result**](types__enum_8h.md#enum-fpga_result) | [**fpgaOpen**](#function-fpgaopen) ([**fpga\_token**](types_8h.md#typedef-fpga_token) token, [**fpga\_handle**](types_8h.md#typedef-fpga_handle) \* handle, int flags) <br>_Open an FPGA object._  |
+|  [**fpga\_result**](types__enum_8h.md#enum-fpga_result) | [**fpgaReset**](#function-fpgareset) ([**fpga\_handle**](types_8h.md#typedef-fpga_handle) handle) <br>_Reset an FPGA object._  |
+
+
+
+
+
+
+
+
+## Public Functions Documentation
+
+
+### function fpgaClose 
+
+_Close a previously opened FPGA object._ 
+```C++
+fpga_result fpgaClose (
+    fpga_handle handle
+) 
+```
+
+
+
+Relinquishes ownership of a previously [**fpgaOpen()**](access_8h.md#function-fpgaopen)ed resource. This enables others to acquire ownership if the resource was opened exclusively. Also deallocates / unmaps MMIO and UMsg memory areas.
+
+
+
+
+**Parameters:**
+
+
+* `handle` Handle to previously opened FPGA object 
+
+
+
+**Returns:**
+
+FPGA\_OK on success. FPGA\_INVALID\_PARAM if handle does not refer to an acquired resource, or if handle is NULL. FPGA\_EXCEPTION if an internal error occurred while accessing the handle. 
+
+
+
+
+
+        
+
+### function fpgaOpen 
+
+_Open an FPGA object._ 
+```C++
+fpga_result fpgaOpen (
+    fpga_token token,
+    fpga_handle * handle,
+    int flags
+) 
+```
+
+
+
+Acquires ownership of the FPGA resource referred to by 'token'.
+
+
+Most often this will be used to open an accelerator object to directly interact with an accelerator function, or to open an FPGA object to perform management functions.
+
+
+
+
+**Parameters:**
+
+
+* `token` Pointer to token identifying resource to acquire ownership of 
+* `handle` Pointer to preallocated memory to place a handle in. This handle will be used in subsequent API calls. 
+* `flags` One of the following flags:
+  * FPGA\_OPEN\_SHARED allows the resource to be opened multiple times (not supported in ASE) Shared resources (including buffers) are released when all associated handles have been closed (either explicitly with [**fpgaClose()**](access_8h.md#function-fpgaclose) or by process termination). 
+
+
+
+
+
+**Returns:**
+
+FPGA\_OK on success. FPGA\_NOT\_FOUND if the resource for 'token' could not be found. FPGA\_INVALID\_PARAM if 'token' does not refer to a resource that can be opened, or if either argument is NULL or invalid. FPGA\_EXCEPTION if an internal exception occurred while creating the handle. FPGA\_NO\_DRIVER if the driver is not loaded. FPGA\_BUSY if trying to open a resource that has already been opened in exclusive mode. FPGA\_NO\_ACCESS if the current process' privileges are not sufficient to open the resource. 
+
+
+
+
+
+        
+
+### function fpgaReset 
+
+_Reset an FPGA object._ 
+```C++
+fpga_result fpgaReset (
+    fpga_handle handle
+) 
+```
+
+
+
+Performs an accelerator reset.
+
+
+
+
+**Parameters:**
+
+
+* `handle` Handle to previously opened FPGA object 
+
+
+
+**Returns:**
+
+FPGA\_OK on success. FPGA\_INVALID\_PARAM if handle does not refer to an acquired resource or to a resource that cannot be reset. FPGA\_EXCEPTION if an internal error occurred while trying to access the handle or resetting the resource. 
+
+
+
+
+
+        
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sw/include/opae/access.h`

latest/assets/.doxy/opae-code/opae-code/access_8h.md

@@ -0,0 +1,58 @@
+
+# File access.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sw**](dir_55721a669a8e0900d975c02921addb49.md) **>** [**include**](dir_97b4588afba69bf89bbe554642ac6431.md) **>** [**opae**](dir_ade97cd9199f278c0723672dd8647ba4.md) **>** [**access.h**](access_8h.md)
+
+[Go to the documentation of this file.](access_8h.md) 
+
+```C++
+
+// Copyright(c) 2017, Intel Corporation
+//
+// Redistribution  and  use  in source  and  binary  forms,  with  or  without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of  source code  must retain the  above copyright notice,
+//   this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+// * Neither the name  of Intel Corporation  nor the names of its contributors
+//   may be used to  endorse or promote  products derived  from this  software
+//   without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,  BUT NOT LIMITED TO,  THE
+// IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED.  IN NO EVENT  SHALL THE COPYRIGHT OWNER  OR CONTRIBUTORS BE
+// LIABLE  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR
+// CONSEQUENTIAL  DAMAGES  (INCLUDING,  BUT  NOT LIMITED  TO,  PROCUREMENT  OF
+// SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE,  DATA, OR PROFITS;  OR BUSINESS
+// INTERRUPTION)  HOWEVER CAUSED  AND ON ANY THEORY  OF LIABILITY,  WHETHER IN
+// CONTRACT,  STRICT LIABILITY,  OR TORT  (INCLUDING NEGLIGENCE  OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,  EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+#ifndef __FPGA_ACCESS_H__
+#define __FPGA_ACCESS_H__
+
+#include <opae/types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+fpga_result fpgaOpen(fpga_token token, fpga_handle *handle,
+             int flags);
+
+fpga_result fpgaClose(fpga_handle handle);
+
+fpga_result fpgaReset(fpga_handle handle);
+
+#ifdef __cplusplus
+} // extern "C"
+#endif // __cplusplus
+
+#endif // __FPGA_ACCESS_H__
+
+```

latest/assets/.doxy/opae-code/opae-code/access_8h_source.md

@@ -0,0 +1,58 @@
+# Class List
+
+Here are the classes, structs, unions and interfaces with brief descriptions:
+
+
+* **struct** [**\_fpga\_token\_header**](struct__fpga__token__header.md) _Internal token type header._   
+* **struct** [**\_opae\_hash\_map**](struct__opae__hash__map.md) _Hash map object._   
+* **struct** [**\_opae\_hash\_map\_item**](struct__opae__hash__map__item.md) _List link item._   
+* **struct** [**cache\_line**](structcache__line.md)   
+* **struct** [**config**](structconfig.md)   
+* **struct** [**fpga\_error\_info**](structfpga__error__info.md)   
+* **struct** [**fpga\_metric**](structfpga__metric.md) _Metric struct._   
+* **struct** [**fpga\_metric\_info**](structfpga__metric__info.md) _Metric info struct._   
+* **struct** [**fpga\_version**](structfpga__version.md) _Semantic version._   
+* **struct** [**mem\_alloc**](structmem__alloc.md)   
+* **struct** [**mem\_link**](structmem__link.md) _Provides an API for allocating/freeing a logical address space._   
+* **struct** [**metric\_threshold**](structmetric__threshold.md)   
+* **union** [**metric\_value**](unionmetric__value.md) _Metric value union._   
+* **namespace** [**opae**](namespaceopae.md)   
+  * **namespace** [**fpga**](namespaceopae_1_1fpga.md)   
+    * **namespace** [**types**](namespaceopae_1_1fpga_1_1types.md)   
+      * **class** [**busy**](classopae_1_1fpga_1_1types_1_1busy.md) _busy exception_   
+      * **namespace** [**detail**](namespaceopae_1_1fpga_1_1types_1_1detail.md)   
+      * **class** [**error**](classopae_1_1fpga_1_1types_1_1error.md) _An error object represents an error register for a resource._   
+      * **class** [**event**](classopae_1_1fpga_1_1types_1_1event.md) _Wraps fpga event routines in OPAE C._   
+        * **struct** [**type\_t**](structopae_1_1fpga_1_1types_1_1event_1_1type__t.md) _C++ struct that is interchangeable with fpga\_event\_type enum._   
+      * **class** [**except**](classopae_1_1fpga_1_1types_1_1except.md) _Generic OPAE exception._   
+      * **class** [**exception**](classopae_1_1fpga_1_1types_1_1exception.md) _exception exception_   
+      * **struct** [**guid\_t**](structopae_1_1fpga_1_1types_1_1guid__t.md) _Representation of the guid member of a properties object._   
+      * **class** [**handle**](classopae_1_1fpga_1_1types_1_1handle.md) _An allocated accelerator resource._   
+      * **class** [**invalid\_param**](classopae_1_1fpga_1_1types_1_1invalid__param.md) [_**invalid\_param**_](classopae_1_1fpga_1_1types_1_1invalid__param.md) _exception_  
+      * **class** [**no\_access**](classopae_1_1fpga_1_1types_1_1no__access.md) [_**no\_access**_](classopae_1_1fpga_1_1types_1_1no__access.md) _exception_  
+      * **class** [**no\_daemon**](classopae_1_1fpga_1_1types_1_1no__daemon.md) [_**no\_daemon**_](classopae_1_1fpga_1_1types_1_1no__daemon.md) _exception_  
+      * **class** [**no\_driver**](classopae_1_1fpga_1_1types_1_1no__driver.md) [_**no\_driver**_](classopae_1_1fpga_1_1types_1_1no__driver.md) _exception_  
+      * **class** [**no\_memory**](classopae_1_1fpga_1_1types_1_1no__memory.md) [_**no\_memory**_](classopae_1_1fpga_1_1types_1_1no__memory.md) _exception_  
+      * **class** [**not\_found**](classopae_1_1fpga_1_1types_1_1not__found.md) [_**not\_found**_](classopae_1_1fpga_1_1types_1_1not__found.md) _exception_  
+      * **class** [**not\_supported**](classopae_1_1fpga_1_1types_1_1not__supported.md) [_**not\_supported**_](classopae_1_1fpga_1_1types_1_1not__supported.md) _exception_  
+      * **class** [**properties**](classopae_1_1fpga_1_1types_1_1properties.md) _Wraps an OPAE fpga\_properties object._   
+      * **struct** [**pvalue**](structopae_1_1fpga_1_1types_1_1pvalue.md) _Wraps OPAE properties defined in the OPAE C API by associating an_ `fpga_properties` _reference with the getters and setters defined for a property._  
+      * **class** [**reconf\_error**](classopae_1_1fpga_1_1types_1_1reconf__error.md) [_**reconf\_error**_](classopae_1_1fpga_1_1types_1_1reconf__error.md) _exception_  
+      * **class** [**shared\_buffer**](classopae_1_1fpga_1_1types_1_1shared__buffer.md) _Host/AFU shared memory blocks._   
+      * **class** [**src\_location**](classopae_1_1fpga_1_1types_1_1src__location.md) _Identify a particular line in a source file._   
+      * **class** [**sysobject**](classopae_1_1fpga_1_1types_1_1sysobject.md) _Wraps the OPAE fpga\_object primitive._   
+      * **class** [**token**](classopae_1_1fpga_1_1types_1_1token.md) _Wraps the OPAE fpga\_token primitive._   
+      * **class** [**version**](classopae_1_1fpga_1_1types_1_1version.md)   
+* **struct** [**opae\_uio**](structopae__uio.md) _OPAE UIO device abstraction._   
+* **struct** [**opae\_uio\_device\_region**](structopae__uio__device__region.md) _MMIO region info._   
+* **struct** [**opae\_vfio**](structopae__vfio.md) _OPAE VFIO device abstraction._   
+* **struct** [**opae\_vfio\_buffer**](structopae__vfio__buffer.md) _System DMA buffer._   
+* **struct** [**opae\_vfio\_device**](structopae__vfio__device.md) _VFIO device._   
+* **struct** [**opae\_vfio\_device\_irq**](structopae__vfio__device__irq.md) _Interrupt info._   
+* **struct** [**opae\_vfio\_device\_region**](structopae__vfio__device__region.md) _MMIO region info._   
+* **struct** [**opae\_vfio\_group**](structopae__vfio__group.md) _VFIO group._   
+* **struct** [**opae\_vfio\_iova\_range**](structopae__vfio__iova__range.md) _IO Virtual Address Range._   
+* **struct** [**opae\_vfio\_sparse\_info**](structopae__vfio__sparse__info.md) _MMIO sparse-mappable region info._   
+* **struct** [**ras\_inject\_error**](structras__inject__error.md)   
+* **namespace** [**std**](namespacestd.md) 
+* **struct** [**threshold**](structthreshold.md) _Threshold struct._