********************************************************************************************************************************************************************************************************
Test Client for Intel((R) System Data IPF Extension Providers
VERSION 03.03.1003 README
July 3rd 2025
Contact : ipfExtensionProvider.developers@intel.com
********************************************************************************************************************************************************************************************************

README Contents
============================================
1.  Introduction
2.  System Requirements
3.  Release Notes
4.  Features and Its Usage
5.  Known Issues and Bug Reporting
6.  License Agreement
7.  3rd party software

********************************************************************************************************************************************************************************************************

1.  Introduction
============================================
This README file contains release notes for the Test Client available in the Intel(R) System Data IPF Extension Provider Package, description and usage of all the features, any problems or issues that were known at the time of shipment.


Test Client:
--------------------------------------------
This contains the source for a test client application demonstrating how the providers can be used. The source file 'TestClient.cpp' initializes an IPF Client object and based on the providers installed on the target system,
displays the provider generated output on the console. This client is included solely for reference purposes as an example to help demonstrate how the providers can be used in any software solution.


2.  Software Requirements
============================================

a. To build/compile the source : 
        1. Microsoft® Visual Studio OR any corresponding C++ compiler
        
b. To run the test client application :
        1. Install VCRuntime from Microsoft® website https://aka.ms/vs/17/release/vc_redist.x64.exe
        2. IPF Extensible (V2.2.10204.7) Framework should be the minimum installed version available on the target system.

3.  Release Notes
============================================
Release 03.03.1002
    a. Fixes for stress and stability tests.
    b. Mod-s provider re-released. 

Release 03.03.1002
    a.PCD telemetry provider inclusion in the package 

Release 03.03.1001
    a. Pantherlake platform compliance.
    b. IPF Provider SDK updated to V2.2.10204.7 for perfmon and systemconfig provider.

Release 03.02.1003
    a. Fixes for crash issue seen during initialization in PMT and SOCThermal Provider.
    b. IPF Provider SDK updated to V2.2.10204.7.

Release 03.02.1002
    a. Graphics namespace related issue fixed in perfmon provider
    b. HLK issue fixed for perfmon provider
    c. Mod-s provider removed from the package due to high memory consumption issue.

Release 03.02.1001
    a. Fix for customer reported issues 
           - [SOCThermal IPF Provider] Platform.CPU.Performance.Core[].CoreScalabilityRatio namespace is NULL on ARL
           - [SOCThermal IPF Provider] Platform.CPU.Performance.Core[].Frequency namespace is NULL on ARL
           - [PMT IPF Provider] Platform.SOC.States.CState.PackageCstateLlcFlushedResidency is not reported in % as per schema on LNL
           - CSME Provider creates new entry in CSME.Firmware per get Node
           - SOCThermal Provider : Frequency NULL issue
           - ModS Provider exception issue
    b. Added PerfMon IPF Extension Provider.

Release 02.06.1002
    a. Bug-Fix release of the provider package for LNL and ARL PV.

Release 02.06.1001
    a. LNL and ARL PV Release of the provider package built with IPF SDK V2.1.10105.19.

Release 02.05.1002
    a. Bug-Fix release of the provider package for LNL and ARL Alpha.

Release 02.05.1001
    a. LNL and ARL Alpha Release of the provider package built with IPF SDK V2.1.10102.8

Release 02.04.1002
    a. Bug-Fix release for MTL PV.
    b. Fixes for DCH compliance issues. 
    c. Migrated Intel(R) Modern Standby IPF Extension Provider to IPF SDK V2.1.10100.37.

Release 02.04.1001
    a. MTL PV Release
    b. Migrated all providers except Intel(R) Modern Standby IPF Extension Provider to IPF SDK V2.1.10100.37.
    c. Provider specific updates in this release are available within the individual Provider Readme files.

Release 02.02.1002
    Bug-Fix release for MTL Beta.

Release 02.02.1001
    a. MTL Beta Release
    b. Migrated to IPF EF SDK V2.1.10060.30

Release 02.01.1001
    a. Migrated to IPF EF SDK V2.0.10100.55
    b. Provider specific updates in this release are available within the individual Provider Readme files

Release 2.0.1001
    Initial Release.


4.  Features and Its Usage
============================================

The Test Client source is a .cpp file which shows how the providers can be used. The test client is implemented as a generic application and will provide data for any given/all namespace paths 
depending on the providers installed on the system.

The test client source takes a set of command line arguments as given below.
    [1] --namespace
            Capability node path as defined in namespace document
    [2] --iterations
            Number of iterations for which the data will have to be collected
    [3] --interval
            Time interval to wait in micro seconds between every iteration
    [4] --QueryNode
            Query the set of child nodes and properties accessible on a node in the namespace
    [5] --GetSchema
            Get a schema describing the specified path
    [6] --output-format
            If "csv" is provided, the app will dump the data output in a csv file. By default, a json file is generated.
            
Default command line (i.e., no arguments) : E.g., testclient.exe
        1. Will print all the available namespace details using GetNode call
        2. Single iteration, no polling
        3. Will also dump the output in a json file
Command line with arguments : E.g., testclient.exe --namespace="Platform.Extensions" --iterations=3 --interval=2000 --output-format="csv"
        1. Print all the IPF namespace nodes under “Platform.Extensions”
        2. Iterate for 3 times with a polling interval of 2 seconds.
        3. Dump the output in a csv file


5.  Known Issues and Bug Reporting
============================================
a. To report a bug on this utility, please submit the bug report to your Intel Field Representative.


6.  License Agreement:
============================================
This ReadMe file as well as the software described in it is furnished under license and may only be used or copied in accordance with the terms of the license. The information in this manual is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Intel Corporation. Intel Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software that may be provided in association with this document.

Except as permitted by such license, no part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without the express written consent of Intel Corporation. 
Information in this document is provided in connection with Intel products. No license, expressed or implied otherwise, to any intellectual property rights is granted by this document. Except as provided in Intel's Terms and Conditions of Sale for such products, Intel assumes no liability whatsoever, and Intel disclaims any express or implied warranty, relating to sale and/or use of Intel products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Intel products are not intended for use in medical, lifesaving, or life sustaining applications. Intel may make changes to specifications and product descriptions at any time, without notice.
Copyright (C) 2025 Intel Corporation. All rights reserved.

Intel is a trademark or registered trademark of Intel Corporation or its subsidiaries in the registered trademark of Intel Corporation or its subsidiaries in the United States and other countries.


7.  3rd party software:
============================================

    No Third-party components are shipped with the Test Client.

********************************************************************************************************************************************************************************************************
*Third-party brands and names are the property of the respective owners.
