1*c120c564SAndrew Turner /* 2*c120c564SAndrew Turner * \file trc_instr_decode_i.h 3*c120c564SAndrew Turner * \brief OpenCSD : Interface for instruction decode. 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 * Redistribution and use in source and binary forms, with or without modification, 10*c120c564SAndrew Turner * are permitted provided that the following conditions are met: 11*c120c564SAndrew Turner * 12*c120c564SAndrew Turner * 1. Redistributions of source code must retain the above copyright notice, 13*c120c564SAndrew Turner * this list of conditions and the following disclaimer. 14*c120c564SAndrew Turner * 15*c120c564SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright notice, 16*c120c564SAndrew Turner * this list of conditions and the following disclaimer in the documentation 17*c120c564SAndrew Turner * and/or other materials provided with the distribution. 18*c120c564SAndrew Turner * 19*c120c564SAndrew Turner * 3. Neither the name of the copyright holder nor the names of its contributors 20*c120c564SAndrew Turner * may be used to endorse or promote products derived from this software without 21*c120c564SAndrew Turner * specific prior written permission. 22*c120c564SAndrew Turner * 23*c120c564SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 24*c120c564SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 25*c120c564SAndrew Turner * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26*c120c564SAndrew Turner * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 27*c120c564SAndrew Turner * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28*c120c564SAndrew Turner * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29*c120c564SAndrew Turner * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 30*c120c564SAndrew Turner * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31*c120c564SAndrew Turner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 32*c120c564SAndrew Turner * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33*c120c564SAndrew Turner */ 34*c120c564SAndrew Turner 35*c120c564SAndrew Turner #ifndef ARM_TRC_INSTR_DECODE_I_H_INCLUDED 36*c120c564SAndrew Turner #define ARM_TRC_INSTR_DECODE_I_H_INCLUDED 37*c120c564SAndrew Turner 38*c120c564SAndrew Turner /*! 39*c120c564SAndrew Turner * @class IInstrDecode 40*c120c564SAndrew Turner * @ingroup ocsd_interfaces 41*c120c564SAndrew Turner * @brief Interface class to an instruction opcode decoder. 42*c120c564SAndrew Turner * 43*c120c564SAndrew Turner * The opcode decoder needs to be capable of limited decode required for trace 44*c120c564SAndrew Turner * execution flow determination. 45*c120c564SAndrew Turner * 46*c120c564SAndrew Turner */ 47*c120c564SAndrew Turner class IInstrDecode 48*c120c564SAndrew Turner { 49*c120c564SAndrew Turner public: IInstrDecode()50*c120c564SAndrew Turner IInstrDecode() {}; /**< Default constructor. */ ~IInstrDecode()51*c120c564SAndrew Turner virtual ~IInstrDecode() {}; /**< Default destructor. */ 52*c120c564SAndrew Turner 53*c120c564SAndrew Turner /*! 54*c120c564SAndrew Turner * Instruction opcode decode for the packet trace decoder to follow the 55*c120c564SAndrew Turner * instruction execution flow. 56*c120c564SAndrew Turner * 57*c120c564SAndrew Turner * @param *instr_info : Structure to pass current opcode, and receive required decode information. 58*c120c564SAndrew Turner * 59*c120c564SAndrew Turner * @return ocsd_err_t : OCSD_OK if successful. 60*c120c564SAndrew Turner */ 61*c120c564SAndrew Turner virtual ocsd_err_t DecodeInstruction(ocsd_instr_info *instr_info) = 0; 62*c120c564SAndrew Turner }; 63*c120c564SAndrew Turner 64*c120c564SAndrew Turner #endif // ARM_TRC_INSTR_DECODE_I_H_INCLUDED 65*c120c564SAndrew Turner 66*c120c564SAndrew Turner /* End of File trc_instr_decode_i.h */ 67