1*c120c564SAndrew Turner /*!
2*c120c564SAndrew Turner  * \file       opencsd/trc_pkt_types.h
3*c120c564SAndrew Turner  * \brief      OpenCSD: Common "C" types for trace packets.
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 /*
10*c120c564SAndrew Turner  * Redistribution and use in source and binary forms, with or without modification,
11*c120c564SAndrew Turner  * are permitted provided that the following conditions are met:
12*c120c564SAndrew Turner  *
13*c120c564SAndrew Turner  * 1. Redistributions of source code must retain the above copyright notice,
14*c120c564SAndrew Turner  * this list of conditions and the following disclaimer.
15*c120c564SAndrew Turner  *
16*c120c564SAndrew Turner  * 2. Redistributions in binary form must reproduce the above copyright notice,
17*c120c564SAndrew Turner  * this list of conditions and the following disclaimer in the documentation
18*c120c564SAndrew Turner  * and/or other materials provided with the distribution.
19*c120c564SAndrew Turner  *
20*c120c564SAndrew Turner  * 3. Neither the name of the copyright holder nor the names of its contributors
21*c120c564SAndrew Turner  * may be used to endorse or promote products derived from this software without
22*c120c564SAndrew Turner  * specific prior written permission.
23*c120c564SAndrew Turner  *
24*c120c564SAndrew Turner  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
25*c120c564SAndrew Turner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26*c120c564SAndrew Turner  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27*c120c564SAndrew Turner  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
28*c120c564SAndrew Turner  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29*c120c564SAndrew Turner  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30*c120c564SAndrew Turner  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31*c120c564SAndrew Turner  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32*c120c564SAndrew Turner  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33*c120c564SAndrew Turner  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34*c120c564SAndrew Turner  */
35*c120c564SAndrew Turner 
36*c120c564SAndrew Turner #ifndef ARM_TRC_PKT_TYPES_H_INCLUDED
37*c120c564SAndrew Turner #define ARM_TRC_PKT_TYPES_H_INCLUDED
38*c120c564SAndrew Turner 
39*c120c564SAndrew Turner #include <stdint.h>
40*c120c564SAndrew Turner #include "opencsd/ocsd_if_types.h"
41*c120c564SAndrew Turner 
42*c120c564SAndrew Turner /** @defgroup trc_pkts  OpenCSD Library : Trace Packet Types
43*c120c564SAndrew Turner 
44*c120c564SAndrew Turner     @brief Types used in trace packet description structures.
45*c120c564SAndrew Turner 
46*c120c564SAndrew Turner @{*/
47*c120c564SAndrew Turner 
48*c120c564SAndrew Turner 
49*c120c564SAndrew Turner /** @name Common Packet Types
50*c120c564SAndrew Turner @{*/
51*c120c564SAndrew Turner 
52*c120c564SAndrew Turner typedef enum _ocsd_pkt_va_size
53*c120c564SAndrew Turner {
54*c120c564SAndrew Turner     VA_32BIT,
55*c120c564SAndrew Turner     VA_64BIT
56*c120c564SAndrew Turner } ocsd_pkt_va_size;
57*c120c564SAndrew Turner 
58*c120c564SAndrew Turner typedef struct _ocsd_pkt_vaddr
59*c120c564SAndrew Turner {
60*c120c564SAndrew Turner     ocsd_pkt_va_size size;     /**< Virtual address size. */
61*c120c564SAndrew Turner     ocsd_vaddr_t val;  /**< Current value */
62*c120c564SAndrew Turner     uint8_t pkt_bits;   /**< Bits updated this packet */
63*c120c564SAndrew Turner     uint8_t valid_bits; /**< Currently valid bits */
64*c120c564SAndrew Turner } ocsd_pkt_vaddr;
65*c120c564SAndrew Turner 
66*c120c564SAndrew Turner typedef struct _ocsd_pkt_byte_sz_val
67*c120c564SAndrew Turner {
68*c120c564SAndrew Turner     uint32_t val;
69*c120c564SAndrew Turner     uint8_t  size_bytes;
70*c120c564SAndrew Turner     uint8_t  valid_bytes;
71*c120c564SAndrew Turner } ocsd_pkt_byte_sz_val;
72*c120c564SAndrew Turner 
73*c120c564SAndrew Turner typedef enum _ocsd_pkt_atm_type
74*c120c564SAndrew Turner {
75*c120c564SAndrew Turner     ATOM_PATTERN,   /**< set atom packet using pattern supplied */
76*c120c564SAndrew Turner     ATOM_REPEAT     /**< set atom packet using repeat value (convert to pattern) */
77*c120c564SAndrew Turner } ocsd_pkt_atm_type;
78*c120c564SAndrew Turner 
79*c120c564SAndrew Turner typedef enum _ocsd_atm_val {
80*c120c564SAndrew Turner     ATOM_N,
81*c120c564SAndrew Turner     ATOM_E
82*c120c564SAndrew Turner } ocsd_atm_val;
83*c120c564SAndrew Turner 
84*c120c564SAndrew Turner typedef struct _ocsd_pkt_atom
85*c120c564SAndrew Turner {
86*c120c564SAndrew Turner     /** pattern across num bits.
87*c120c564SAndrew Turner         Bit sequence:- ls bit = oldest atom (1st instruction executed), ms bit = newest (last instruction executed),
88*c120c564SAndrew Turner         Bit values  :-  1'b1 = E atom, 1'b0 = N atom.
89*c120c564SAndrew Turner       */
90*c120c564SAndrew Turner     uint32_t En_bits;
91*c120c564SAndrew Turner     uint8_t num;                /**< number of atoms represented */
92*c120c564SAndrew Turner } ocsd_pkt_atom;
93*c120c564SAndrew Turner 
94*c120c564SAndrew Turner /** Isync Reason - common to PTM and ETMv3 **/
95*c120c564SAndrew Turner typedef enum _ocsd_iSync_reason {
96*c120c564SAndrew Turner     iSync_Periodic = 0,
97*c120c564SAndrew Turner     iSync_TraceEnable,
98*c120c564SAndrew Turner     iSync_TraceRestartAfterOverflow,
99*c120c564SAndrew Turner     iSync_DebugExit
100*c120c564SAndrew Turner } ocsd_iSync_reason;
101*c120c564SAndrew Turner 
102*c120c564SAndrew Turner 
103*c120c564SAndrew Turner typedef enum _ocsd_armv7_exception {
104*c120c564SAndrew Turner     Excp_Reserved,
105*c120c564SAndrew Turner     Excp_NoException,
106*c120c564SAndrew Turner     Excp_Reset,
107*c120c564SAndrew Turner     Excp_IRQ,
108*c120c564SAndrew Turner     Excp_FIQ,
109*c120c564SAndrew Turner     Excp_AsyncDAbort,
110*c120c564SAndrew Turner     Excp_DebugHalt,
111*c120c564SAndrew Turner     Excp_Jazelle,
112*c120c564SAndrew Turner     Excp_SVC,
113*c120c564SAndrew Turner     Excp_SMC,
114*c120c564SAndrew Turner     Excp_Hyp,
115*c120c564SAndrew Turner     Excp_Undef,
116*c120c564SAndrew Turner     Excp_PrefAbort,
117*c120c564SAndrew Turner     Excp_Generic,
118*c120c564SAndrew Turner     Excp_SyncDataAbort,
119*c120c564SAndrew Turner     Excp_CMUsageFault,
120*c120c564SAndrew Turner     Excp_CMNMI,
121*c120c564SAndrew Turner     Excp_CMDebugMonitor,
122*c120c564SAndrew Turner     Excp_CMMemManage,
123*c120c564SAndrew Turner     Excp_CMPendSV,
124*c120c564SAndrew Turner     Excp_CMSysTick,
125*c120c564SAndrew Turner     Excp_CMBusFault,
126*c120c564SAndrew Turner     Excp_CMHardFault,
127*c120c564SAndrew Turner     Excp_CMIRQn,
128*c120c564SAndrew Turner     Excp_ThumbEECheckFail,
129*c120c564SAndrew Turner } ocsd_armv7_exception;
130*c120c564SAndrew Turner 
131*c120c564SAndrew Turner /** @}*/
132*c120c564SAndrew Turner 
133*c120c564SAndrew Turner /** @}*/
134*c120c564SAndrew Turner 
135*c120c564SAndrew Turner #endif // ARM_TRC_PKT_TYPES_H_INCLUDED
136*c120c564SAndrew Turner 
137*c120c564SAndrew Turner /* End of File opencsd/trc_pkt_types.h */
138