2 * \file trc_instr_decode_i.h
3 * \brief OpenCSD : Interface for instruction decode.
5 * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
9 * Redistribution and use in source and binary forms, with or without modification,
10 * are permitted provided that the following conditions are met:
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
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.
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.
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.
35 #ifndef ARM_TRC_INSTR_DECODE_I_H_INCLUDED
36 #define ARM_TRC_INSTR_DECODE_I_H_INCLUDED
40 * @ingroup ocsd_interfaces
41 * @brief Interface class to an instruction opcode decoder.
43 * The opcode decoder needs to be capable of limited decode required for trace
44 * execution flow determination.
50 IInstrDecode() {}; /**< Default constructor. */
51 virtual ~IInstrDecode() {}; /**< Default destructor. */
54 * Instruction opcode decode for the packet trace decoder to follow the
55 * instruction execution flow.
57 * @param *instr_info : Structure to pass current opcode, and receive required decode information.
59 * @return ocsd_err_t : OCSD_OK if successful.
61 virtual ocsd_err_t DecodeInstruction(ocsd_instr_info *instr_info) = 0;
64 #endif // ARM_TRC_INSTR_DECODE_I_H_INCLUDED
66 /* End of File trc_instr_decode_i.h */