1 /* 2 * \file trc_pkt_proc_etmv4i.h 3 * \brief OpenCSD : Implementation of ETMv4 packet processing 4 * 5 * \copyright Copyright (c) 2015, 2019 ARM Limited. All Rights Reserved. 6 */ 7 8 /* 9 * Redistribution and use in source and binary forms, with or without modification, 10 * are permitted provided that the following conditions are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright notice, 13 * this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 19 * 3. Neither the name of the copyright holder nor the names of its contributors 20 * may be used to endorse or promote products derived from this software without 21 * specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 30 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #ifndef ARM_TRC_PKT_PROC_ETMV4I_IMPL_H_INCLUDED 36 #define ARM_TRC_PKT_PROC_ETMV4I_IMPL_H_INCLUDED 37 38 #include "trc_pkt_types_etmv4.h" 39 #include "opencsd/etmv4/trc_pkt_proc_etmv4.h" 40 #include "opencsd/etmv4/trc_cmp_cfg_etmv4.h" 41 #include "opencsd/etmv4/trc_pkt_elem_etmv4i.h" 42 #include "common/trc_raw_buffer.h" 43 #include "common/trc_pkt_proc_base.h" 44 45 class EtmV4ITrcPacket; 46 class EtmV4Config; 47 48 /** @addtogroup ocsd_pkt_proc 49 @{*/ 50 51 class TrcPktProcEtmV4I : public TrcPktProcBase< EtmV4ITrcPacket, ocsd_etmv4_i_pkt_type, EtmV4Config> 52 { 53 public: 54 TrcPktProcEtmV4I(); 55 TrcPktProcEtmV4I(int instIDNum); 56 virtual ~TrcPktProcEtmV4I(); 57 58 protected: 59 /* implementation packet processing interface */ 60 virtual ocsd_datapath_resp_t processData( const ocsd_trc_index_t index, 61 const uint32_t dataBlockSize, 62 const uint8_t *pDataBlock, 63 uint32_t *numBytesProcessed); 64 virtual ocsd_datapath_resp_t onEOT(); 65 virtual ocsd_datapath_resp_t onReset(); 66 virtual ocsd_datapath_resp_t onFlush(); 67 virtual ocsd_err_t onProtocolConfig(); 68 virtual const bool isBadPacket() const; 69 70 protected: 71 typedef enum _process_state { 72 PROC_HDR, 73 PROC_DATA, 74 SEND_PKT, 75 SEND_UNSYNCED, 76 PROC_ERR, 77 } process_state; 78 79 process_state m_process_state; 80 81 void InitPacketState(); // clear current packet state. 82 void InitProcessorState(); // clear all previous process state 83 84 /** packet processor configuration **/ 85 bool m_isInit; 86 87 // etmv4 hardware configuration 88 EtmV4Config m_config; 89 90 /** packet data **/ 91 TraceRawBuffer m_trcIn; // trace data in buffer 92 std::vector<uint8_t> m_currPacketData; // raw data packet 93 int m_currPktIdx; // index into raw packet when expanding 94 EtmV4ITrcPacket m_curr_packet; // expanded packet 95 ocsd_trc_index_t m_packet_index; // index of the start of the current packet 96 ocsd_trc_index_t m_blockIndex; // index at the start of the current data block being processed 97 98 // searching for sync 99 bool m_is_sync; //!< seen first sync packet 100 bool m_first_trace_info; //!< seen first trace info packet after sync 101 bool m_sent_notsync_packet; //!< send one not sync packet if we see any unsynced data on the channel 102 unsigned m_dump_unsynced_bytes; //!< number of unsynced bytes to send 103 ocsd_trc_index_t m_update_on_unsync_packet_index; 104 105 106 private: 107 // current processing state data - counts and flags to determine if a packet is complete. 108 109 // TraceInfo Packet 110 // flags to indicate processing progress for these sections is complete. 111 struct _t_info_pkt_prog { 112 uint8_t sectFlags; 113 uint8_t ctrlBytes; 114 } m_tinfo_sections; 115 116 #define TINFO_INFO_SECT 0x01 117 #define TINFO_KEY_SECT 0x02 118 #define TINFO_SPEC_SECT 0x04 119 #define TINFO_CYCT_SECT 0x08 120 #define TINFO_WNDW_SECT 0x10 121 #define TINFO_CTRL 0x20 122 #define TINFO_ALL_SECT 0x1F 123 #define TINFO_ALL 0x3F 124 125 126 // address and context packets 127 int m_addrBytes; 128 uint8_t m_addrIS; 129 bool m_bAddr64bit; 130 int m_vmidBytes; // bytes still to find 131 int m_ctxtidBytes; // bytes still to find 132 bool m_bCtxtInfoDone; 133 bool m_addr_done; 134 135 // timestamp 136 bool m_ccount_done; // done or not needed 137 bool m_ts_done; 138 int m_ts_bytes; 139 140 // exception 141 int m_excep_size; 142 143 // cycle count 144 bool m_has_count; 145 bool m_count_done; 146 bool m_commit_done; 147 148 // cond result 149 bool m_F1P1_done; // F1 payload 1 done 150 bool m_F1P2_done; // F1 payload 2 done 151 bool m_F1has_P2; // F1 has a payload 2 152 153 // Q packets (use some from above too) 154 bool m_has_addr; 155 bool m_addr_short; 156 bool m_addr_match; 157 uint8_t m_Q_type; 158 uint8_t m_QE; 159 160 ocsd_datapath_resp_t outputPacket(); 161 ocsd_datapath_resp_t outputUnsyncedRawPacket(); 162 163 void iNotSync(const uint8_t lastByte); // not synced yet 164 void iPktNoPayload(const uint8_t lastByte); // process a single byte packet 165 void iPktReserved(const uint8_t lastByte); // deal with reserved header value 166 void iPktExtension(const uint8_t lastByte); 167 void iPktASync(const uint8_t lastByte); 168 void iPktTraceInfo(const uint8_t lastByte); 169 void iPktTimestamp(const uint8_t lastByte); 170 void iPktException(const uint8_t lastByte); 171 void iPktCycleCntF123(const uint8_t lastByte); 172 void iPktSpeclRes(const uint8_t lastByte); 173 void iPktCondInstr(const uint8_t lastByte); 174 void iPktCondResult(const uint8_t lastByte); 175 void iPktContext(const uint8_t lastByte); 176 void iPktAddrCtxt(const uint8_t lastByte); 177 void iPktShortAddr(const uint8_t lastByte); 178 void iPktLongAddr(const uint8_t lastByte); 179 void iPktQ(const uint8_t lastByte); 180 void iAtom(const uint8_t lastByte); 181 void iPktInvalidCfg(const uint8_t lastByte); // packet invalid in current config. 182 void iPktITE(const uint8_t lastByte); 183 184 unsigned extractContField(const std::vector<uint8_t> &buffer, const unsigned st_idx, uint32_t &value, const unsigned byte_limit = 5); 185 unsigned extractTSField64(const std::vector<uint8_t> &buffer, const unsigned st_idx, uint64_t &value); 186 unsigned extractCondResult(const std::vector<uint8_t> &buffer, const unsigned st_idx, uint32_t& key, uint8_t &result); 187 void extractAndSetContextInfo(const std::vector<uint8_t> &buffer, const int st_idx); 188 int extract64BitLongAddr(const std::vector<uint8_t> &buffer, const int st_idx, const uint8_t IS, uint64_t &value); 189 int extract32BitLongAddr(const std::vector<uint8_t> &buffer, const int st_idx, const uint8_t IS, uint32_t &value); 190 int extractShortAddr(const std::vector<uint8_t> &buffer, const int st_idx, const uint8_t IS, uint32_t &value, int &bits); 191 192 // packet processing is table driven. 193 typedef void (TrcPktProcEtmV4I::*PPKTFN)(uint8_t); 194 PPKTFN m_pIPktFn; 195 196 struct _pkt_i_table_t { 197 ocsd_etmv4_i_pkt_type pkt_type; 198 PPKTFN pptkFn; 199 } m_i_table[256]; 200 201 void BuildIPacketTable(); 202 203 void throwBadSequenceError(const char *pszExtMsg); 204 }; 205 206 207 inline const bool TrcPktProcEtmV4I::isBadPacket() const 208 { 209 return m_curr_packet.isBadPacket(); 210 } 211 212 /** @}*/ 213 214 #endif // ARM_TRC_PKT_PROC_ETMV4I_IMPL_H_INCLUDED 215 216 /* End of File trc_pkt_proc_etmv4i_impl.h */ 217