Fix for vf telemetry APIsFix for vf telemetry APIs

Signed-off-by: Kulkarni, Ashwin Kumar <[email protected]>

Author: AshwinKumarKulkarni

scripts/sysman/EXT_Exp_VirtualFunctionManagement.rst

@@ -24,6 +24,7 @@ API
     * ${s}DeviceEnumEnabledVFExp
     * ${s}DeviceEnumActiveVFExp
     * ${s}VFManagementGetVFCapabilitiesExp
+    * ${s}VFManagementGetVFCapabilitiesExp2
     * ${s}VFManagementGetVFMemoryUtilizationExp2
     * ${s}VFManagementGetVFEngineUtilizationExp2    
     * ${s}VFManagementGetVFPropertiesExp
@@ -46,6 +47,7 @@ API
     * ${s}_vf_exp_properties_t
     * ${s}_vf_util_mem_exp_t
     * ${s}_vf_util_engine_exp_t
+    * ${s}_vf_exp2_capabilities_t
 
 Virtual Function Management
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -67,10 +69,10 @@ The following pseudo-code demonstrates a sequence for obtaining the engine activ
     std::vector<${s}_vf_handle_t> vfs(numVf, nullptr);
     ${s}DeviceEnumEnabledVFExp(hDevice, &numVf, vfs.data());
 
-    // Gather VF properties
-    std::vector <${s}_vf_exp_capabilities_t> vfCapabs(numVf);
+    // Gather VF capabilities
+    std::vector <${s}_vf_exp2_capabilities_t> vfCapabs(numVf);
     for (uint32_t i = 0; i < numVf; i++) {
-        ${s}VFManagementGetVFCapabilitiesExp(vfs[i], &vfCapabs[i]);
+        ${s}VFManagementGetVFCapabilitiesExp2(vfs[i], &vfCapabs[i]);
     }
 
     // Detect the info types a particular VF supports
@@ -85,4 +87,4 @@ The following pseudo-code demonstrates a sequence for obtaining the engine activ
     ${s}VFManagementGetVFEngineUtilizationExp2(activeVf, &engineStatCount, engineStats0);
     sleep(1)
     ${s}_vf_util_engine_exp2_t* engineStats1 = (${s}_vf_util_engine_exp2_t*) allocate(engineStatCount * sizeof(${s}_vf_util_engine_exp2_t));
-    ${s}VFManagementGetVFEngineUtilizationExp2(activeVf, &engineStatCount, &engineStats1);
+    ${s}VFManagementGetVFEngineUtilizationExp2(activeVf, &engineStatCount, &engineStats1);

scripts/sysman/common.yml

@@ -256,7 +256,11 @@ etors:
     - name: VF_UTIL_ENGINE_EXP2
       value: "0x00020010"
       desc: $s_vf_util_engine_exp2_t
-      version: "1.10"  
+      version: "1.10"
+    - name: VF_EXP2_CAPABILITIES
+      value: "0x00020011"
+      desc: $s_vf_exp2_capabilities_t
+      version: "1.12"    
 --- #-------------------------------------------------------------------------
 type: struct
 desc: "Base for all properties types"

scripts/sysman/virtualFunctionManagement.yml

@@ -115,7 +115,7 @@ members:
       desc: "[out] Wall clock time when the activeCounterValue was sampled."
 --- #--------------------------------------------------------------------------
 type: struct
-desc: "Virtual function management capabilities"
+desc: "Virtual function management capabilities (deprecated)"
 version: "1.10"
 class: $sVFManagement
 name: $s_vf_exp_capabilities_t
@@ -125,6 +125,23 @@ members:
       name: "address"
       desc: "[out] Virtual function BDF address"
     - type: uint32_t
+      name: "vfDeviceMemSize"
+      desc: "[out] Virtual function memory size in kilo bytes"
+    - type: uint32_t
+      name: "vfID"
+      desc: "[out] Virtual Function ID"
+--- #--------------------------------------------------------------------------
+type: struct
+desc: "Virtual function management capabilities"
+version: "1.12"
+class: $sVFManagement
+name: $s_vf_exp2_capabilities_t
+base: $s_base_properties_t
+members:
+    - type: $s_pci_address_t
+      name: "address"
+      desc: "[out] Virtual function BDF address"
+    - type: uint64_t
       name: "vfDeviceMemSize"
       desc: "[out] Virtual function memory size in bytes"
     - type: uint32_t
@@ -143,7 +160,7 @@ members:
       desc: "[out] Location of this memory (system, device)"
     - type: uint64_t
       name: "vfMemUtilized"
-      desc: "[out] Free memory size in bytes."
+      desc: "[out] Utilized memory size in bytes."
 --- #--------------------------------------------------------------------------
 type: struct
 desc: "Provides engine utilization values for a virtual function"
@@ -330,6 +347,7 @@ version: "1.10"
 class: $sVFManagement
 name: GetVFCapabilitiesExp
 details:
+    - "1.12": "[DEPRECATED] No longer supported. Use $sVFManagementGetVFCapabilitiesExp2."
     - "The application may call this function from simultaneous threads."
     - "The implementation of this function should be lock-free."
 params:
@@ -392,6 +410,22 @@ params:
               - if count is less than the total number of engine stats available, then driver shall only retrieve that number of stats.
               - the implementation shall populate the vector pCount-1 number of VF engine stats.
 --- #--------------------------------------------------------------------------
+type: function
+desc: "Get virtual function management capabilities"
+version: "1.12"
+class: $sVFManagement
+name: GetVFCapabilitiesExp2
+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_exp2_capabilities_t*
+      name: pCapability
+      desc: "[in,out] Will contain VF capability."
+--- #--------------------------------------------------------------------------
 type: class
 desc: "C++ wrapper for a Sysman virtual function management  group"
 version: "1.9"
@@ -404,4 +438,4 @@ members:
       init: nullptr
     - type: $sDevice*
       name: pDevice
-      desc: "[in] pointer to owner object"
+      desc: "[in] pointer to owner object"