parameter-framework: initial commit

BZ: 6081

Parameter-framework is still-under-development, Intel proprietary,
multi-platform (standard C++, for now only linux, no dependency on
Android) software that allows system-wide parameter management. It
relies on a number of configurations files, from which it knows how
/ when to hand out settings towards the hardware (subsystems) at
runtime.
3 kinds of configuration files are used:
- Structure description files indicating the actual parameter
structure, types, min/max values, data representation.
- Configurable domain description file containing the actual
distribution of parameters over different domains, that is, different
set of configurations, each of which being dynamically activated
based on selection criteria rules that are themselves configurable.
Configurable domains file contain the tuned settings along the tuning
process, that is during the period where the system is being tuned.
- Binary settings file used to store the settings when the tuning
process is complete.

Changing any of those files causes no recompilation of the framework.
This project is based on a open plugin architecture allowing any kind
of subsystems to be handled, whatever their respective Endianness.
It fully relies on the platform SW to provide it with with the
kowledge of exisitng selection criteria (selected device, current
mode), as well as change events that occuring on them, thus
triggering the application of corresponding configuration settings
wherever appropriate.
It supports handling mutliple parameter classes (Audio, Energy
management) through TCP/IP interface.
For now tuning commands can be sent to parameter-framework instances
through a command-line utility, via adb over USB or via ethernet/WIFI.

Change-Id: If7709c464db118f367f953e0824f49cce9fd0402
Orig-Change-Id: I7842e8808a4cfc0c615e0365e6d02101971ae2dc
Signed-off-by: Patrick Benavoli <patrickx.benavoli@intel.com>
Reviewed-on: http://android.intel.com:8080/16877
Reviewed-by: Mahe, Erwan <erwan.mahe@intel.com>
Tested-by: Barthes, FabienX <fabienx.barthes@intel.com>
Reviewed-by: buildbot <buildbot@intel.com>
Tested-by: buildbot <buildbot@intel.com>

1 files changed, 282 insertions, 0 deletions

diff --git a/parameter/ArrayParameter.cpp b/parameter/ArrayParameter.cpp
new file mode 100644
index 0000000..2cdae2f
--- /dev/null
+++ b/parameter/ArrayParameter.cpp
@@ -0,0 +1,282 @@
+/* <auto_header>
+ * <FILENAME>
+ * 
+ * INTEL CONFIDENTIAL
+ * Copyright © 2011 Intel 
+ * Corporation All Rights Reserved.
+ * 
+ * The source code contained or described herein and all documents related to
+ * the source code ("Material") are owned by Intel Corporation or its suppliers
+ * or licensors. Title to the Material remains with Intel Corporation or its
+ * suppliers and licensors. The Material contains trade secrets and proprietary
+ * and confidential information of Intel or its suppliers and licensors. The
+ * Material is protected by worldwide copyright and trade secret laws and
+ * treaty provisions. No part of the Material may be used, copied, reproduced,
+ * modified, published, uploaded, posted, transmitted, distributed, or
+ * disclosed in any way without Intel’s prior express written permission.
+ * 
+ * No license under any patent, copyright, trade secret or other intellectual
+ * property right is granted to or conferred upon you by disclosure or delivery
+ * of the Materials, either expressly, by implication, inducement, estoppel or
+ * otherwise. Any license under such intellectual property rights must be
+ * express and approved by Intel in writing.
+ * 
+ *  AUTHOR: Patrick Benavoli (patrickx.benavoli@intel.com)
+ * CREATED: 2011-06-01
+ * UPDATED: 2011-07-27
+ * 
+ * 
+ * </auto_header>
+ */
+#include "ArrayParameter.h"
+#include <sstream> // for istringstream
+#include "Tokenizer.h"
+#include "ParameterType.h"
+#include "ParameterAccessContext.h"
+#include "ConfigurationAccessContext.h"
+#include "ParameterBlackboard.h"
+
+#define base CParameter
+
+CArrayParameter::CArrayParameter(const string& strName, const CTypeElement* pTypeElement, uint32_t uiLength) : base(strName, pTypeElement), _uiLength(uiLength)
+{
+}
+
+uint32_t CArrayParameter::getFootPrint() const
+{
+    return getSize() * _uiLength;
+}
+
+// XML configuration settings parsing
+bool CArrayParameter::serializeXmlSettings(CXmlElement& xmlConfigurableElementSettingsElement, CConfigurationAccessContext& configurationAccessContext) const
+{
+    // Check for value space
+    handleValueSpaceAttribute(xmlConfigurableElementSettingsElement, configurationAccessContext);
+
+    // Handle access
+    if (!configurationAccessContext.serializeOut()) {
+
+        // Actually set values to blackboard
+        if (!setValues(0, configurationAccessContext.getBaseOffset(), xmlConfigurableElementSettingsElement.getTextContent(), configurationAccessContext)) {
+
+            return false;
+        }
+    } else {
+
+        // Get string value
+        string strValue;
+
+        // Whole array requested
+        getValues(configurationAccessContext.getBaseOffset(), strValue, configurationAccessContext);
+
+        // Populate value into xml text node
+        xmlConfigurableElementSettingsElement.setTextContent(strValue);
+    }
+
+    // Done
+    return true;
+}
+
+// User set/get
+bool CArrayParameter::setValue(CPathNavigator& pathNavigator, const string& strValue, CErrorContext& errorContext) const
+{
+    CParameterAccessContext& parameterContext = static_cast<CParameterAccessContext&>(errorContext);
+
+    uint32_t uiStartIndex;
+
+    if (!getIndex(pathNavigator, uiStartIndex, parameterContext)) {
+
+        return false;
+    }
+
+    if (uiStartIndex == (uint32_t)-1) {
+
+        // No index provided, start with 0
+        uiStartIndex = 0;
+    }
+
+    // Actually set values
+    if (!setValues(uiStartIndex, 0, strValue, parameterContext)) {
+
+        return false;
+    }
+
+    // Synchronize
+    if (parameterContext.getAutoSync() && !sync(parameterContext)) {
+
+        // Append parameter path to error
+        errorContext.appendToError(" " + getPath());
+
+        return false;
+    }
+
+    return true;
+}
+
+bool CArrayParameter::getValue(CPathNavigator& pathNavigator, string& strValue, CErrorContext& errorContext) const
+{
+    CParameterAccessContext& parameterContext = static_cast<CParameterAccessContext&>(errorContext);
+    uint32_t uiIndex;
+
+    if (!getIndex(pathNavigator, uiIndex, parameterContext)) {
+
+        return false;
+    }
+    if (uiIndex == (uint32_t)-1) {
+
+        // Whole array requested
+        getValues(0, strValue, parameterContext);
+
+    } else {
+        // Scalar requested
+        doGetValue(strValue, getOffset() + uiIndex * getSize(), parameterContext);
+    }
+
+    return true;
+}
+
+void CArrayParameter::logValue(string& strValue, CErrorContext& errorContext) const
+{
+    CParameterAccessContext& parameterContext = static_cast<CParameterAccessContext&>(errorContext);
+
+    // Dump values
+    getValues(0, strValue, parameterContext);
+
+    // Prepend unit if any
+    prependUnit(strValue);
+}
+
+// Used for simulation only
+void CArrayParameter::setDefaultValues(CParameterAccessContext& parameterAccessContext) const
+{
+    // Get default value from type
+    uint32_t uiDefaultValue = static_cast<const CParameterType*>(getTypeElement())->getDefaultValue();
+
+    // Write blackboard
+    CParameterBlackboard* pBlackboard = parameterAccessContext.getParameterBlackboard();
+
+    // Process
+    uint32_t uiValueIndex;
+    uint32_t uiSize = getSize();
+    uint32_t uiOffset = getOffset();
+    bool bSubsystemIsBigEndian = parameterAccessContext.isBigEndianSubsystem();
+
+    for (uiValueIndex = 0; uiValueIndex < _uiLength; uiValueIndex++) {
+
+        // Beware this code works on little endian architectures only!
+        pBlackboard->write(&uiDefaultValue, uiSize, uiOffset, bSubsystemIsBigEndian);
+
+        uiOffset += uiSize;
+    }
+}
+
+// Index from path
+bool CArrayParameter::getIndex(CPathNavigator& pathNavigator, uint32_t& uiIndex, CErrorContext& errorContext) const
+{
+    uiIndex = (uint32_t)-1;
+
+    string* pStrChildName = pathNavigator.next();
+
+    if (pStrChildName) {
+
+        // Check index is numeric
+        istringstream iss(*pStrChildName);
+
+        iss >> uiIndex;
+
+        if (!iss) {
+
+            errorContext.setError("Expected numerical expression as last item in " + pathNavigator.getCurrentPath());
+
+            return false;
+        }
+
+        if (uiIndex >= _uiLength) {
+            ostringstream oss;
+
+            oss << "Provided index out of range (max is " << _uiLength - 1 << ")";
+
+            errorContext.setError(oss.str());
+
+            return false;
+        }
+
+        // Check no other item provided in path
+        pStrChildName = pathNavigator.next();
+
+        if (pStrChildName) {
+
+            // Should be leaf element
+            errorContext.setError("Path not found: " + pathNavigator.getCurrentPath());
+
+            return false;
+        }
+    }
+
+    return true;
+}
+
+// Common set value processing
+bool CArrayParameter::setValues(uint32_t uiStartIndex, uint32_t uiBaseOffset, const string& strValue, CParameterAccessContext& parameterContext) const
+{
+    // Deal with value(s)
+    Tokenizer tok(strValue);
+
+    vector<string> astrValues = tok.split();
+    uint32_t uiNbValues = astrValues.size();
+
+    // Check number of provided values
+    if (uiNbValues + uiStartIndex > _uiLength) {
+
+        // Out of bounds
+        parameterContext.setError("Too many values provided");
+
+        return false;
+    }
+
+    // Process
+    uint32_t uiValueIndex;
+    uint32_t uiSize = getSize();
+    uint32_t uiOffset = getOffset() + uiStartIndex * uiSize - uiBaseOffset;
+
+    for (uiValueIndex = 0; uiValueIndex < uiNbValues; uiValueIndex++) {
+
+        if (!doSetValue(astrValues[uiValueIndex], uiOffset, parameterContext)) {
+
+            // Append parameter path to error
+            parameterContext.appendToError(" " + getPath() + "/" + getIndexAsString(uiValueIndex + uiStartIndex));
+
+            return false;
+        }
+
+        uiOffset += uiSize;
+    }
+    return true;
+}
+
+// Common get value processing
+void CArrayParameter::getValues(uint32_t uiBaseOffset, string& strValues, CParameterAccessContext& parameterContext) const
+{
+    uint32_t uiValueIndex;
+    uint32_t uiSize = getSize();
+    uint32_t uiOffset = getOffset() - uiBaseOffset;
+
+    for (uiValueIndex = 0; uiValueIndex < _uiLength; uiValueIndex++) {
+        string strReadValue;
+
+        doGetValue(strReadValue, uiOffset, parameterContext);
+
+        strValues += strReadValue + " ";
+
+        uiOffset += uiSize;
+    }
+}
+
+string CArrayParameter::getIndexAsString(uint32_t uiIndex)
+{
+    ostringstream strStream;
+
+    strStream << uiIndex;
+
+    return strStream.str();
+}