aboutsummaryrefslogtreecommitdiff
path: root/sys/dev/qat/qat_api/include/icp_sal_versions.h
diff options
context:
space:
mode:
Diffstat (limited to 'sys/dev/qat/qat_api/include/icp_sal_versions.h')
-rw-r--r--sys/dev/qat/qat_api/include/icp_sal_versions.h97
1 files changed, 97 insertions, 0 deletions
diff --git a/sys/dev/qat/qat_api/include/icp_sal_versions.h b/sys/dev/qat/qat_api/include/icp_sal_versions.h
new file mode 100644
index 000000000000..0a013fe46b81
--- /dev/null
+++ b/sys/dev/qat/qat_api/include/icp_sal_versions.h
@@ -0,0 +1,97 @@
+/* SPDX-License-Identifier: BSD-3-Clause */
+/* Copyright(c) 2007-2022 Intel Corporation */
+/* $FreeBSD$ */
+/**
+ ***************************************************************************
+ * @file icp_sal_versions.h
+ *
+ * @defgroup SalVersions
+ *
+ * @ingroup SalVersions
+ *
+ * API and structures definition for obtaining software and hardware versions
+ *
+ ***************************************************************************/
+
+#ifndef _ICP_SAL_VERSIONS_H_
+#define _ICP_SAL_VERSIONS_H_
+
+#define ICP_SAL_VERSIONS_FW_VERSION_SIZE 16
+/**< Max length of firmware version string */
+#define ICP_SAL_VERSIONS_SW_VERSION_SIZE 16
+/**< Max length of software version string */
+#define ICP_SAL_VERSIONS_MMP_VERSION_SIZE 16
+/**< Max length of MMP binary version string */
+#define ICP_SAL_VERSIONS_HW_VERSION_SIZE 4
+/**< Max length of hardware version string */
+
+/* Part name and number of the accelerator device */
+#define SAL_INFO2_DRIVER_SW_VERSION_MAJ_NUMBER 3
+#define SAL_INFO2_DRIVER_SW_VERSION_MIN_NUMBER 11
+#define SAL_INFO2_DRIVER_SW_VERSION_PATCH_NUMBER 0
+
+/**
+*******************************************************************************
+ * @ingroup SalVersions
+ * Structure holding versions information
+ *
+ * @description
+ * This structure stores information about versions of software
+ * and hardware being run on a particular device.
+ *****************************************************************************/
+typedef struct icp_sal_dev_version_info_s {
+ Cpa32U devId;
+ /**< Number of acceleration device for which this structure holds
+ * version
+ * information */
+ Cpa8U firmwareVersion[ICP_SAL_VERSIONS_FW_VERSION_SIZE];
+ /**< String identifying the version of the firmware associated with
+ * the device. */
+ Cpa8U mmpVersion[ICP_SAL_VERSIONS_MMP_VERSION_SIZE];
+ /**< String identifying the version of the MMP binary associated with
+ * the device. */
+ Cpa8U softwareVersion[ICP_SAL_VERSIONS_SW_VERSION_SIZE];
+ /**< String identifying the version of the software associated with
+ * the device. */
+ Cpa8U hardwareVersion[ICP_SAL_VERSIONS_HW_VERSION_SIZE];
+ /**< String identifying the version of the hardware (stepping and
+ * revision ID) associated with the device. */
+} icp_sal_dev_version_info_t;
+
+/**
+*******************************************************************************
+ * @ingroup SalVersions
+ * Obtains the version information for a given device
+ * @description
+ * This function obtains hardware and software version information
+ * associated with a given device.
+ *
+ * @param[in] accelId ID of the acceleration device for which version
+ * information is to be obtained.
+ * @param[out] pVerInfo Pointer to a structure that will hold version
+ * information
+ *
+ * @context
+ * This function might sleep. It cannot be executed in a context that
+ * does not permit sleeping.
+ * @assumptions
+ * The system has been started
+ * @sideEffects
+ * None
+ * @blocking
+ * No
+ * @reentrant
+ * No
+ * @threadSafe
+ * Yes
+ *
+ * @return CPA_STATUS_SUCCESS Operation finished successfully
+ * @return CPA_STATUS_INVALID_PARAM Invalid parameter passed to the function
+ * @return CPA_STATUS_RESOURCE System resources problem
+ * @return CPA_STATUS_FAIL Operation failed
+ *
+ *****************************************************************************/
+CpaStatus icp_sal_getDevVersionInfo(Cpa32U accelId,
+ icp_sal_dev_version_info_t *pVerInfo);
+
+#endif