1*c120c564SAndrew Turner /*!
2*c120c564SAndrew Turner * \file ocsd_dcd_tree_elem.h
3*c120c564SAndrew Turner * \brief OpenCSD : Decode tree element.
4*c120c564SAndrew Turner *
5*c120c564SAndrew Turner * \copyright Copyright (c) 2015, 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
35*c120c564SAndrew Turner #ifndef ARM_OCSD_DCD_TREE_ELEM_H_INCLUDED
36*c120c564SAndrew Turner #define ARM_OCSD_DCD_TREE_ELEM_H_INCLUDED
37*c120c564SAndrew Turner
38*c120c564SAndrew Turner #include "common/ocsd_dcd_mngr_i.h"
39*c120c564SAndrew Turner #include "common/trc_component.h"
40*c120c564SAndrew Turner
41*c120c564SAndrew Turner /** @addtogroup dcd_tree
42*c120c564SAndrew Turner @{*/
43*c120c564SAndrew Turner
44*c120c564SAndrew Turner /*! @struct _decoder_elements
45*c120c564SAndrew Turner * @brief Decode tree element base structure.
46*c120c564SAndrew Turner *
47*c120c564SAndrew Turner * Element describes the protocol supported for this element and
48*c120c564SAndrew Turner * contains pointers to the decoder manager interface and component handle.
49*c120c564SAndrew Turner */
50*c120c564SAndrew Turner typedef struct _decoder_elements
51*c120c564SAndrew Turner {
52*c120c564SAndrew Turner std::string dcd_name; //!< Registered name of the decoder
53*c120c564SAndrew Turner TraceComponent *dcd_handle; //!< handle to the decoder object
54*c120c564SAndrew Turner IDecoderMngr *dcd_mngr; //!< pointer to the decoder manager interface for the decodcer
55*c120c564SAndrew Turner ocsd_trace_protocol_t protocol;//!< protocol type
56*c120c564SAndrew Turner bool created; /**< decode tree created this element (destroy it on tree destruction) */
57*c120c564SAndrew Turner } decoder_element;
58*c120c564SAndrew Turner
59*c120c564SAndrew Turner /*!
60*c120c564SAndrew Turner * @class DecodeTreeElement
61*c120c564SAndrew Turner * @brief Decode tree element
62*c120c564SAndrew Turner *
63*c120c564SAndrew Turner * Decoder tree elements are references to individual decoders in the tree.
64*c120c564SAndrew Turner * These allow iteration of all decoders in the tree to perform common operations.
65*c120c564SAndrew Turner *
66*c120c564SAndrew Turner * The DecodeTree contains a list of elements.
67*c120c564SAndrew Turner */
68*c120c564SAndrew Turner class DecodeTreeElement : protected decoder_element
69*c120c564SAndrew Turner {
70*c120c564SAndrew Turner public:
71*c120c564SAndrew Turner DecodeTreeElement();
~DecodeTreeElement()72*c120c564SAndrew Turner ~DecodeTreeElement() {};
73*c120c564SAndrew Turner
74*c120c564SAndrew Turner void SetDecoderElement(const std::string &name, IDecoderMngr *dcdMngr, TraceComponent *pHandle, bool bCreated);
75*c120c564SAndrew Turner void DestroyElem();
76*c120c564SAndrew Turner
getDecoderTypeName()77*c120c564SAndrew Turner const std::string &getDecoderTypeName() { return dcd_name; };
getDecoderMngr()78*c120c564SAndrew Turner IDecoderMngr *getDecoderMngr() { return dcd_mngr; };
getProtocol()79*c120c564SAndrew Turner ocsd_trace_protocol_t getProtocol() const { return protocol; };
getDecoderHandle()80*c120c564SAndrew Turner TraceComponent *getDecoderHandle() { return dcd_handle; };
81*c120c564SAndrew Turner };
82*c120c564SAndrew Turner
DecodeTreeElement()83*c120c564SAndrew Turner inline DecodeTreeElement::DecodeTreeElement()
84*c120c564SAndrew Turner {
85*c120c564SAndrew Turner dcd_name = "unknown";
86*c120c564SAndrew Turner dcd_mngr = 0;
87*c120c564SAndrew Turner dcd_handle = 0;
88*c120c564SAndrew Turner protocol = OCSD_PROTOCOL_END;
89*c120c564SAndrew Turner created = false;
90*c120c564SAndrew Turner }
91*c120c564SAndrew Turner
SetDecoderElement(const std::string & name,IDecoderMngr * dcdMngr,TraceComponent * pHandle,bool bCreated)92*c120c564SAndrew Turner inline void DecodeTreeElement::SetDecoderElement(const std::string &name, IDecoderMngr *dcdMngr, TraceComponent *pHandle, bool bCreated)
93*c120c564SAndrew Turner {
94*c120c564SAndrew Turner dcd_name = name;
95*c120c564SAndrew Turner dcd_mngr = dcdMngr;
96*c120c564SAndrew Turner dcd_handle = pHandle;
97*c120c564SAndrew Turner protocol = OCSD_PROTOCOL_UNKNOWN;
98*c120c564SAndrew Turner if(dcd_mngr)
99*c120c564SAndrew Turner protocol = dcd_mngr->getProtocolType();
100*c120c564SAndrew Turner created = bCreated;
101*c120c564SAndrew Turner }
102*c120c564SAndrew Turner
DestroyElem()103*c120c564SAndrew Turner inline void DecodeTreeElement::DestroyElem()
104*c120c564SAndrew Turner {
105*c120c564SAndrew Turner if(created && (dcd_mngr != 0) && (dcd_handle != 0))
106*c120c564SAndrew Turner dcd_mngr->destroyDecoder(dcd_handle);
107*c120c564SAndrew Turner }
108*c120c564SAndrew Turner
109*c120c564SAndrew Turner /** @}*/
110*c120c564SAndrew Turner #endif // ARM_OCSD_DCD_TREE_ELEM_H_INCLUDED
111*c120c564SAndrew Turner
112*c120c564SAndrew Turner /* End of File ocsd_dcd_tree_elem.h */
113