xref: /aosp_15_r20/external/OpenCSD/decoder/include/i_dec/trc_i_decode.h (revision 02ca8ccacfba7e0df68f3332a95f3180334d6649)
1 /*
2  * \file       trc_i_decode.h
3  * \brief      OpenCSD :
4  *
5  * \copyright  Copyright (c) 2015, 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 #ifndef ARM_TRC_I_DECODE_H_INCLUDED
35 #define ARM_TRC_I_DECODE_H_INCLUDED
36 
37 #include "interfaces/trc_instr_decode_i.h"
38 #include "opencsd/ocsd_if_types.h"
39 
40 /** Throw error if AA64 opcode top 2 bytes == 0x0000. This range is invalid in AA64 */
41 #define OCSD_ENV_ERR_ON_AA64_BAD_OPCODE "OPENCSD_ERR_ON_AA64_BAD_OPCODE"
42 
43 class TrcIDecode : public IInstrDecode
44 {
45 public:
46     TrcIDecode();
~TrcIDecode()47     virtual ~TrcIDecode() {};
48 
49     virtual ocsd_err_t DecodeInstruction(ocsd_instr_info* instr_info);
50 
51     /* control AA64 checking for invalid opcode */
52     void setAA64_errOnBadOpcode(bool bSet);
53     void envSetAA64_errOnBadOpcode();
54 
55 private:
56     ocsd_err_t DecodeA32(ocsd_instr_info *instr_info, struct decode_info *info);
57     ocsd_err_t DecodeA64(ocsd_instr_info *instr_info, struct decode_info *info);
58     ocsd_err_t DecodeT32(ocsd_instr_info *instr_info, struct decode_info *info);
59 
60     bool aa64_err_bad_opcode;   //< error if aa64 opcode is in invalid range (top 2 bytes = 0x0000).
61 };
62 
setAA64_errOnBadOpcode(bool bSet)63 inline void TrcIDecode::setAA64_errOnBadOpcode(bool bSet)
64 {
65     aa64_err_bad_opcode = bSet;
66 }
67 
68 #endif // ARM_TRC_I_DECODE_H_INCLUDED
69 
70 /* End of File trc_i_decode.h */
71