1 /*
2  * Copyright (c) 2011-2014, Intel Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #pragma once
31 
32 #include <stdint.h>
33 #include "ErrorContext.h"
34 #include <string>
35 
36 class CParameterBlackboard;
37 
38 class CParameterAccessContext : public CErrorContext
39 {
40 public:
41     CParameterAccessContext(std::string& strError,
42                             CParameterBlackboard* pParameterBlackboard,
43                             bool bValueSpaceIsRaw,
44                             bool bOutputRawFormatIsHex = false,
45                             uint32_t uiOffsetBase = 0);
46     CParameterAccessContext(std::string& strError,
47                             bool bBigEndianSubsystem,
48                             CParameterBlackboard* pParameterBlackboard,
49                             uint32_t uiOffsetBase = 0);
50     CParameterAccessContext(std::string& strError);
51 
52     // ParameterBlackboard
53     CParameterBlackboard* getParameterBlackboard();
54     void setParameterBlackboard(CParameterBlackboard* pBlackboard);
55 
56     // Value interpretation as Real or Raw
57     void setValueSpaceRaw(bool bIsRaw);
58     bool valueSpaceIsRaw() const;
59 
60     /**
61      * Assigns Output Raw Format for user get value interpretation.
62      *
63      * @param[in] bIsHex "true" for hexadecimal, "false" for decimal
64      *
65      */
66     void setOutputRawFormat(bool bIsHex);
67     /**
68      * Returns Output Raw Format for user get value interpretation.
69      *
70      * @return "true" for hexadecimal, "false" for decimal
71      *
72      */
73     bool outputRawFormatIsHex() const;
74 
75     // Endianness
76     void setBigEndianSubsystem(bool bBigEndian);
77     bool isBigEndianSubsystem() const;
78 
79     // Automatic synchronization to HW
80     void setAutoSync(bool bAutoSync);
81     bool getAutoSync() const;
82 
83     // Base offset for blackboard access
84     void setBaseOffset(uint32_t uiBaseOffset);
85     uint32_t getBaseOffset() const;
86 
87 private:
88     // Blackboard
89     CParameterBlackboard* _pParameterBlackboard;
90     // Value space
91     bool _bValueSpaceIsRaw;
92     // Output Raw Format
93     bool _bOutputRawFormatIsHex;
94     // Subsystem Endianness
95     bool _bBigEndianSubsystem;
96     // Automatic synchronization to HW
97     bool _bAutoSync;
98     // Base offset where parameters are stored in configuration blackboards
99     uint32_t _uiBaseOffset;
100 };
101 
102