Updates to virtualmanagment API

Signed-off-by: Kumar, Sanil <sanil.kumar@intel.com>

Author: sanilkumar0

scripts/sysman/EXT_Exp_VirtualFunctionManagement.rst

@@ -21,20 +21,18 @@ API
 
 * Functions
 
-    * ${s}DeviceEnumActiveVFExp
-    * ${s}VFManagementGetVFPropertiesExp
+    * ${s}DeviceEnumEnabledVFExp
+    * ${s}VFManagementGetVFCapabilitiesExp
     * ${s}VFManagementGetVFMemoryUtilizationExp
     * ${s}VFManagementGetVFEngineUtilizationExp
 
 * Enumerations
 
     * ${s}_vf_management_exp_version_t
-    * ${s}_vf_info_mem_type_exp_flags_t
-    * ${s}_vf_info_util_exp_flags_t
 
 * Structures
 
-    * ${s}_vf_exp_properties_t
+    * ${s}_vf_exp_capabilities_t
     * ${s}_vf_util_mem_exp_t
     * ${s}_vf_util_engine_exp_t
 
@@ -51,33 +49,29 @@ The following pseudo-code demonstrates a sequence for obtaining the engine activ
 
     // Gather count of VF handles
     uint32_t numVf = 0;
-    ${s}_vf_exp_properties_t vfProps {};
-    ${s}DeviceEnumActiveVFExp(hDevice, &numVf, nullptr);
+    ${s}_vf_exp_capabilities_t vfProps {};
+    ${s}DeviceEnumEnabledVFExp(hDevice, &numVf, nullptr);
 
     // Allocate memory for vf handles and call back in to gather handles
     std::vector<${s}_vf_handle_t> vfs(numVf, nullptr);
-    ${s}DeviceEnumActiveVFExp(hDevice, &numVf, vfs.data());
+    ${s}DeviceEnumEnabledVFExp(hDevice, &numVf, vfs.data());
 
     // Gather VF properties
-    std::vector <${s}_vf_exp_properties_t> vfProps(numVf);
+    std::vector <${s}_vf_exp_capabilities_t> vfProps(numVf);
     for (uint32_t i = 0; i < numVf; i++) {
-        ${s}VFManagementGetVFPropertiesExp(vfs[i], &vfProps[i]);
+        ${s}VFManagementGetVFCapabilitiesExp(vfs[i], &vfProps[i]);
     }
 
     // Detect the info types a particular VF supports
 
     // Using VF# 0 to demonstrate how to detect engine info type and query engine util info
     ${s}_vf_handle_t activeVf = vfs[0];
-    uint32_t count = 1;
-    unit32_t engineUtilPercent = 0;
-    if (vfProps[0].flags & ZES_VF_INFO_ENGINE) {
-        ${s}_vf_util_engine_exp_t engineUtil0 = {};
-        ${s}VFManagementGetVFEngineUtilizationExp(activeVf, &count, &engineUtil0);
-        sleep(1)
-        ${s}_vf_util_engine_exp_t engineUtil1 = {};
-        ${s}VFManagementGetVFEngineUtilizationExp(activeVf, &count, &engineUtil1);
-        // Use formula to calculate engine utilization % based on the 2 snapshots above
-        engineUtilPercent = (engineUtil1.activeCounterValue - engineUtil0.activeCounterValue) / engineUtil1.samplingCounterValue - engineUtil0.samplingCounterValue
-    }
-
-
+    uint32_t engineStatCount = 0;
+    
+    ${s}VFManagementGetVFEngineUtilizationExp(activeVf, &engineStatCount, nullptr);
+    // Allocate memory for vf engine stats
+    ${s}_vf_util_engine_exp_t* engineStats0 = (${s}_vf_util_engine_exp_t*) allocate(engineStatCount * sizeof(${s}_vf_util_engine_exp_t));
+    ${s}VFManagementGetVFEngineUtilizationExp(activeVf, &engineStatCount, engineStats0);
+    sleep(1)
+    ${s}_vf_util_engine_exp_t* engineStats1 = (${s}_vf_util_engine_exp_t*) allocate(engineStatCount * sizeof(${s}_vf_util_engine_exp_t));
+    ${s}VFManagementGetVFEngineUtilizationExp(activeVf, &engineStatCount, &engineStats1);

scripts/sysman/common.yml

@@ -233,10 +233,10 @@ etors:
       value: "0x00020004"
       desc: $s_subdevice_exp_properties_t
       version: "1.9"
-    - name: VF_EXP_PROPERTIES
+    - name: VF_EXP_CAPABILITIES
       value: "0x00020005"
-      desc: $s_vf_exp_properties_t
-      version: "1.9"
+      desc: $s_vf_exp_capabilities_t
+      version: "1.10"
     - name: VF_UTIL_MEM_EXP
       value: "0x00020006"
       desc: $s_vf_util_mem_exp_t

scripts/sysman/virtualFunctionManagement.yml

@@ -28,65 +28,36 @@ etors:
       value: "$X_MAKE_VERSION( 1, 1 )"
       desc: "version 1.1"
 --- #--------------------------------------------------------------------------
-type: enum
-desc: "Virtual function memory types"
-version: "1.9"
-class: $sVFManagement
-name: $s_vf_info_mem_type_exp_flags_t
-etors:
-    - name: MEM_TYPE_SYSTEM
-      desc: "System memory"
-    - name: MEM_TYPE_DEVICE
-      desc: "Device local memory"
---- #--------------------------------------------------------------------------
-type: enum
-desc: "Virtual function utilization flag bit fields"
-version: "1.9"
-class: $sVFManagement
-name: $s_vf_info_util_exp_flags_t
-etors:
-    - name: INFO_NONE
-      desc: "No info associated with virtual function"
-    - name: INFO_MEM_CPU
-      desc: "System memory utilization associated with virtual function"
-    - name: INFO_MEM_GPU
-      desc: "Device memory utilization associated with virtual function"
-    - name: INFO_ENGINE
-      desc: 'Engine utilization associated with virtual function'
---- #--------------------------------------------------------------------------
 type: struct
-desc: "Virtual function management properties"
-version: "1.9"
+desc: "Virtual function management capabilities"
+version: "1.10"
 class: $sVFManagement
-name: $s_vf_exp_properties_t
+name: $s_vf_exp_capabilities_t
 base: $s_base_properties_t
 members:
     - type: $s_pci_address_t
       name: "address"
       desc: "[out] Virtual function BDF address"
-    - type: $s_uuid_t
-      name: uuid
-      desc: "[out] universal unique identifier of the device"
-    - type: $s_vf_info_util_exp_flags_t
-      name: "flags"
-      desc: "[out] utilization flags available. May be 0 or a valid combination of $s_vf_info_util_exp_flag_t."
+    - type: uint32_t
+      name: "vfDeviceMemSize"
+      desc: "[out] Virtual function memory size in bytes"
+    - type: uint32_t
+      name: "vfID"
+      desc: "[out] Virtual Function ID"
 --- #--------------------------------------------------------------------------
 type: struct
 desc: "Provides memory utilization values for a virtual function"
-version: "1.9"
+version: "1.10"
 class: $sVFManagement
 name: $s_vf_util_mem_exp_t
 base: $s_base_state_t
 members:
-    - type: $s_vf_info_mem_type_exp_flags_t
-      name: "memTypeFlags"
-      desc: "[out] Memory type flags."
+    - type: $s_mem_loc_t
+      name: "vfMemLocation"
+      desc: "[out] Location of this memory (system, device)"
     - type: uint64_t
-      name: "free"
+      name: "vfMemUtilized"
       desc: "[out] Free memory size in bytes."
-    - type: uint64_t
-      name: "size"
-      desc: "[out] Total allocatable memory in bytes."
 --- #--------------------------------------------------------------------------
 type: struct
 desc: "Provides engine utilization values for a virtual function"
@@ -98,7 +69,7 @@ name: $s_vf_util_engine_exp_t
 base: $s_base_state_t
 members:
     - type: $s_engine_group_t
-      name: "type"
+      name: "vfEngineType"
       desc: "[out] The engine group."
     - type: uint64_t
       name: "activeCounterValue"
@@ -111,7 +82,7 @@ type: function
 desc: "Get handle of virtual function modules"
 version: "1.9"
 class: $sDevice
-name: EnumActiveVFExp
+name: EnumEnabledVFExp
 details:
     - "The application may call this function from simultaneous threads."
     - "The implementation of this function should be lock-free."
@@ -132,20 +103,20 @@ params:
             if count is less than the number of components of this type that are available, then the driver shall only retrieve that number of component handles.
 --- #--------------------------------------------------------------------------
 type: function
-desc: "Get virtual function management properties"
-version: "1.9"
+desc: "Get virtual function management capabilities"
+version: "1.10"
 class: $sVFManagement
-name: GetVFPropertiesExp
+name: GetVFCapabilitiesExp
 details:
     - "The application may call this function from simultaneous threads."
     - "The implementation of this function should be lock-free."
 params:
     - type: $s_vf_handle_t
       name: hVFhandle
       desc: "[in] Sysman handle for the VF component."
-    - type: $s_vf_exp_properties_t*
-      name: pProperties
-      desc: "[in,out] Will contain VF properties."
+    - type: $s_vf_exp_capabilities_t*
+      name: pCapability
+      desc: "[in,out] Will contain VF capability."
 --- #--------------------------------------------------------------------------
 type: function
 desc: "Get memory activity stats for each available memory types associated with Virtual Function (VF)"
@@ -155,6 +126,7 @@ name: GetVFMemoryUtilizationExp
 details:
     - "The application may call this function from simultaneous threads."
     - "The implementation of this function should be lock-free."
+    - "If VF is disable/pause/not active, utilization will give zero value."
 params:
     - type: $s_vf_handle_t
       name: hVFhandle
@@ -180,6 +152,7 @@ name: GetVFEngineUtilizationExp
 details:
     - "The application may call this function from simultaneous threads."
     - "The implementation of this function should be lock-free."
+    - "If VF is disable/pause/not active, utilization will give zero value."
 params:
     - type: $s_vf_handle_t
       name: hVFhandle