1*c120c564SAndrew Turner /*
2*c120c564SAndrew Turner * \file ocsd_pe_context.h
3*c120c564SAndrew Turner * \brief OpenCSD : Wrapper class for PE context
4*c120c564SAndrew Turner *
5*c120c564SAndrew Turner * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved.
6*c120c564SAndrew Turner */
7*c120c564SAndrew Turner
8*c120c564SAndrew Turner /*
9*c120c564SAndrew Turner * Redistribution and use in source and binary forms, with or without modification,
10*c120c564SAndrew Turner * are permitted provided that the following conditions are met:
11*c120c564SAndrew Turner *
12*c120c564SAndrew Turner * 1. Redistributions of source code must retain the above copyright notice,
13*c120c564SAndrew Turner * this list of conditions and the following disclaimer.
14*c120c564SAndrew Turner *
15*c120c564SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright notice,
16*c120c564SAndrew Turner * this list of conditions and the following disclaimer in the documentation
17*c120c564SAndrew Turner * and/or other materials provided with the distribution.
18*c120c564SAndrew Turner *
19*c120c564SAndrew Turner * 3. Neither the name of the copyright holder nor the names of its contributors
20*c120c564SAndrew Turner * may be used to endorse or promote products derived from this software without
21*c120c564SAndrew Turner * specific prior written permission.
22*c120c564SAndrew Turner *
23*c120c564SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
24*c120c564SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25*c120c564SAndrew Turner * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26*c120c564SAndrew Turner * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27*c120c564SAndrew Turner * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28*c120c564SAndrew Turner * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29*c120c564SAndrew Turner * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30*c120c564SAndrew Turner * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31*c120c564SAndrew Turner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32*c120c564SAndrew Turner * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33*c120c564SAndrew Turner */
34*c120c564SAndrew Turner #ifndef ARM_OCSD_PE_CONTEXT_H_INCLUDED
35*c120c564SAndrew Turner #define ARM_OCSD_PE_CONTEXT_H_INCLUDED
36*c120c564SAndrew Turner
37*c120c564SAndrew Turner #include "opencsd/ocsd_if_types.h"
38*c120c564SAndrew Turner
39*c120c564SAndrew Turner /*! @class OcsdPeContext
40*c120c564SAndrew Turner * @brief Handler for the ocsd_pe_context structure.
41*c120c564SAndrew Turner *
42*c120c564SAndrew Turner * Reads and writes structure values, enforcing interaction rules between values
43*c120c564SAndrew Turner * and flags.
44*c120c564SAndrew Turner */
45*c120c564SAndrew Turner class OcsdPeContext
46*c120c564SAndrew Turner {
47*c120c564SAndrew Turner public:
48*c120c564SAndrew Turner OcsdPeContext();
49*c120c564SAndrew Turner OcsdPeContext(const ocsd_pe_context *context);
~OcsdPeContext()50*c120c564SAndrew Turner ~OcsdPeContext() {};
51*c120c564SAndrew Turner
52*c120c564SAndrew Turner OcsdPeContext &operator =(const OcsdPeContext &ctxt);
53*c120c564SAndrew Turner OcsdPeContext &operator =(const ocsd_pe_context *context);
54*c120c564SAndrew Turner
55*c120c564SAndrew Turner void resetCtxt();
56*c120c564SAndrew Turner
setSecLevel(const ocsd_sec_level sl)57*c120c564SAndrew Turner void setSecLevel(const ocsd_sec_level sl) { m_context.security_level = sl; };
setEL(const ocsd_ex_level el)58*c120c564SAndrew Turner void setEL(const ocsd_ex_level el) { m_context.exception_level = el; m_context.el_valid = el > ocsd_EL_unknown ? 1 : 0; };
setCtxtID(const uint32_t id)59*c120c564SAndrew Turner void setCtxtID(const uint32_t id) { m_context.context_id = id; m_context.ctxt_id_valid = 1; };
setVMID(const uint32_t id)60*c120c564SAndrew Turner void setVMID(const uint32_t id) { m_context.vmid = id; m_context.vmid_valid = 1; };
set64bit(const bool is64bit)61*c120c564SAndrew Turner void set64bit(const bool is64bit) { m_context.bits64 = is64bit ? 1 : 0; };
62*c120c564SAndrew Turner
getSecLevel()63*c120c564SAndrew Turner const ocsd_sec_level getSecLevel() const { return m_context.security_level; };
getEL()64*c120c564SAndrew Turner const ocsd_ex_level getEL() const { return m_context.exception_level; };
ELvalid()65*c120c564SAndrew Turner const bool ELvalid() const { return (m_context.el_valid == 1); };
getCtxtID()66*c120c564SAndrew Turner const uint32_t getCtxtID() const { return (m_context.ctxt_id_valid == 1) ? m_context.context_id : 0; };
ctxtIDvalid()67*c120c564SAndrew Turner const bool ctxtIDvalid() const { return (m_context.ctxt_id_valid == 1); };
getVMID()68*c120c564SAndrew Turner const uint32_t getVMID() const { return (m_context.vmid_valid == 1) ? m_context.vmid : 0; };
VMIDvalid()69*c120c564SAndrew Turner const bool VMIDvalid() const { return (m_context.vmid_valid == 1); };
70*c120c564SAndrew Turner
71*c120c564SAndrew Turner // only allow an immutable copy of the structure out to C-API land.
72*c120c564SAndrew Turner operator const ocsd_pe_context &() const { return m_context; };
73*c120c564SAndrew Turner
74*c120c564SAndrew Turner private:
75*c120c564SAndrew Turner ocsd_pe_context m_context;
76*c120c564SAndrew Turner };
77*c120c564SAndrew Turner
OcsdPeContext()78*c120c564SAndrew Turner inline OcsdPeContext::OcsdPeContext()
79*c120c564SAndrew Turner {
80*c120c564SAndrew Turner resetCtxt();
81*c120c564SAndrew Turner }
82*c120c564SAndrew Turner
OcsdPeContext(const ocsd_pe_context * context)83*c120c564SAndrew Turner inline OcsdPeContext::OcsdPeContext(const ocsd_pe_context *context)
84*c120c564SAndrew Turner {
85*c120c564SAndrew Turner m_context = *context;
86*c120c564SAndrew Turner }
87*c120c564SAndrew Turner
resetCtxt()88*c120c564SAndrew Turner inline void OcsdPeContext::resetCtxt()
89*c120c564SAndrew Turner {
90*c120c564SAndrew Turner // initialise the context
91*c120c564SAndrew Turner m_context.bits64 = 0;
92*c120c564SAndrew Turner m_context.context_id = 0;
93*c120c564SAndrew Turner m_context.ctxt_id_valid = 0;
94*c120c564SAndrew Turner m_context.el_valid = 0;
95*c120c564SAndrew Turner m_context.exception_level = ocsd_EL_unknown;
96*c120c564SAndrew Turner m_context.security_level = ocsd_sec_secure;
97*c120c564SAndrew Turner m_context.vmid = 0;
98*c120c564SAndrew Turner m_context.vmid_valid = 0;
99*c120c564SAndrew Turner }
100*c120c564SAndrew Turner
101*c120c564SAndrew Turner inline OcsdPeContext & OcsdPeContext::operator =(const OcsdPeContext &ctxt)
102*c120c564SAndrew Turner {
103*c120c564SAndrew Turner m_context = ctxt;
104*c120c564SAndrew Turner return *this;
105*c120c564SAndrew Turner }
106*c120c564SAndrew Turner
107*c120c564SAndrew Turner inline OcsdPeContext & OcsdPeContext::operator =(const ocsd_pe_context *context)
108*c120c564SAndrew Turner {
109*c120c564SAndrew Turner m_context = *context;
110*c120c564SAndrew Turner return *this;
111*c120c564SAndrew Turner }
112*c120c564SAndrew Turner
113*c120c564SAndrew Turner
114*c120c564SAndrew Turner #endif // ARM_OCSD_PE_CONTEXT_H_INCLUDED
115*c120c564SAndrew Turner
116*c120c564SAndrew Turner /* End of File ocsd_pe_context.h */
117