xref: /freebsd/contrib/opencsd/decoder/include/common/trc_cs_config.h (revision c120c5646da1a1d2c4d90fd069a7e2a8d559eb46)
1*c120c564SAndrew Turner /*
2*c120c564SAndrew Turner  * \file       trc_cs_config.h
3*c120c564SAndrew Turner  * \brief      OpenCSD : Trace component config base class.
4*c120c564SAndrew Turner  *
5*c120c564SAndrew Turner  * \copyright  Copyright (c) 2016, ARM Limited. All Rights Reserved.
6*c120c564SAndrew Turner  */
7*c120c564SAndrew Turner #ifndef ARM_TRC_CS_CONFIG_H_INCLUDED
8*c120c564SAndrew Turner #define ARM_TRC_CS_CONFIG_H_INCLUDED
9*c120c564SAndrew Turner 
10*c120c564SAndrew Turner 
11*c120c564SAndrew Turner /*
12*c120c564SAndrew Turner  * Redistribution and use in source and binary forms, with or without modification,
13*c120c564SAndrew Turner  * are permitted provided that the following conditions are met:
14*c120c564SAndrew Turner  *
15*c120c564SAndrew Turner  * 1. Redistributions of source code must retain the above copyright notice,
16*c120c564SAndrew Turner  * this list of conditions and the following disclaimer.
17*c120c564SAndrew Turner  *
18*c120c564SAndrew Turner  * 2. Redistributions in binary form must reproduce the above copyright notice,
19*c120c564SAndrew Turner  * this list of conditions and the following disclaimer in the documentation
20*c120c564SAndrew Turner  * and/or other materials provided with the distribution.
21*c120c564SAndrew Turner  *
22*c120c564SAndrew Turner  * 3. Neither the name of the copyright holder nor the names of its contributors
23*c120c564SAndrew Turner  * may be used to endorse or promote products derived from this software without
24*c120c564SAndrew Turner  * specific prior written permission.
25*c120c564SAndrew Turner  *
26*c120c564SAndrew Turner  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
27*c120c564SAndrew Turner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
28*c120c564SAndrew Turner  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29*c120c564SAndrew Turner  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
30*c120c564SAndrew Turner  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
31*c120c564SAndrew Turner  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32*c120c564SAndrew Turner  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
33*c120c564SAndrew Turner  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34*c120c564SAndrew Turner  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35*c120c564SAndrew Turner  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36*c120c564SAndrew Turner  */
37*c120c564SAndrew Turner 
38*c120c564SAndrew Turner /** @addtogroup ocsd_protocol_cfg
39*c120c564SAndrew Turner @{*/
40*c120c564SAndrew Turner 
41*c120c564SAndrew Turner /*!
42*c120c564SAndrew Turner  * @class CSConfig
43*c120c564SAndrew Turner  * @brief Base class for configuration data on CoreSight trace component.
44*c120c564SAndrew Turner  *
45*c120c564SAndrew Turner  *  Defines common access functionality, common to all components.
46*c120c564SAndrew Turner  *  (e.g. trace ID).
47*c120c564SAndrew Turner  *
48*c120c564SAndrew Turner  */
49*c120c564SAndrew Turner class CSConfig
50*c120c564SAndrew Turner {
51*c120c564SAndrew Turner public:
CSConfig()52*c120c564SAndrew Turner     CSConfig() {};
~CSConfig()53*c120c564SAndrew Turner     virtual ~CSConfig() {};
54*c120c564SAndrew Turner 
55*c120c564SAndrew Turner     virtual const uint8_t getTraceID() const = 0; //!< CoreSight Trace ID for this device.
56*c120c564SAndrew Turner };
57*c120c564SAndrew Turner 
58*c120c564SAndrew Turner /** @}*/
59*c120c564SAndrew Turner 
60*c120c564SAndrew Turner #endif // ARM_TRC_CS_CONFIG_H_INCLUDED
61*c120c564SAndrew Turner 
62*c120c564SAndrew Turner /* End of File trc_cs_config.h */