decoder/include/c_api/rctdl_c_api_types.h

/*!
 * \file       rctdl_c_api_types.h
 * \brief      Reference CoreSight Trace Decoder : Trace Decoder "C" API types.
 * 
 * \copyright  Copyright (c) 2015, ARM Limited. All Rights Reserved.
 */

/* 
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution. 
 * 
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without 
 * specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */ 

#ifndef ARM_RCTDL_C_API_TYPES_H_INCLUDED
#define ARM_RCTDL_C_API_TYPES_H_INCLUDED

/* select the library types that are C compatible - the interface data types */
#include "rctdl_if_types.h"
#include "trc_gen_elem_types.h"
#include "trc_pkt_types.h"

/* pull in the protocol decoder types. */
#include "etmv3/trc_pkt_types_etmv3.h"
#include "etmv4/trc_pkt_types_etmv4.h"
#include "ptm/trc_pkt_types_ptm.h"
#include "stm/trc_pkt_types_stm.h"

/** @ingroup lib_c_api
@{*/


/* Specific C-API only types */

/** Handle to decode tree */
typedef void * dcd_tree_handle_t;

/** define invalid handle value for decode tree handle */
#define C_API_INVALID_TREE_HANDLE (dcd_tree_handle_t)0


/** Logger output printer - no output. */
#define C_API_MSGLOGOUT_FLG_NONE   0x0
/** Logger output printer - output to file. */
#define C_API_MSGLOGOUT_FLG_FILE   0x1
/** Logger output printer - output to stderr. */
#define C_API_MSGLOGOUT_FLG_STDERR 0x2
/** Logger output printer - output to stdout. */
#define C_API_MSGLOGOUT_FLG_STDOUT 0x4
/** Logger output printer - mask of valid flags. */
#define C_API_MSGLOGOUT_MASK       0x7

/** function pointer type for decoder outputs. all protocols, generic data element input */
typedef rctdl_datapath_resp_t (* FnTraceElemIn)(const void *p_context, const rctdl_trc_index_t index_sop, const uint8_t trc_chan_id, const rctdl_generic_trace_elem *elem); 

/** function pointer type for ETMv4 instruction packet processor output, packet analyser/decoder input */
typedef rctdl_datapath_resp_t (* FnEtmv4IPacketDataIn)(const void *p_context, const rctdl_datapath_op_t op, const rctdl_trc_index_t index_sop, const rctdl_etmv4_i_pkt *p_packet_in);

/** function pointer type for ETMv4 instruction packet processor monitor output, raw packet monitor / display input  */
typedef void (* FnEtmv4IPktMonDataIn)(  const void *p_context, 
                                        const rctdl_datapath_op_t op, 
                                        const rctdl_trc_index_t index_sop, 
                                        const rctdl_etmv4_i_pkt *p_packet_in,
                                        const uint32_t size,
                                        const uint8_t *p_data);

/** function pointer type for ETMv3 packet processor output, packet analyser/decoder input */
typedef rctdl_datapath_resp_t (* FnEtmv3PacketDataIn)(const void *p_context, const rctdl_datapath_op_t op, const rctdl_trc_index_t index_sop, const rctdl_etmv3_pkt *p_packet_in);

/** function pointer type for ETMv3 packet processor monitor output, raw packet monitor / display input  */
typedef void (* FnEtmv3PktMonDataIn)(   const void *p_context, 
                                        const rctdl_datapath_op_t op, 
                                        const rctdl_trc_index_t index_sop, 
                                        const rctdl_etmv3_pkt *p_packet_in,
                                        const uint32_t size,
                                        const uint8_t *p_data);

/** function pointer type for STM packet processor output, packet analyser/decoder input */
typedef rctdl_datapath_resp_t (* FnStmPacketDataIn)(const void *p_context, const rctdl_datapath_op_t op, const rctdl_trc_index_t index_sop, const rctdl_stm_pkt *p_packet_in);

/** function pointer type for STM packet processor monitor output, raw packet monitor / display input  */
typedef void (* FnStmPktMonDataIn)(     const void *p_context, 
                                        const rctdl_datapath_op_t op, 
                                        const rctdl_trc_index_t index_sop, 
                                        const rctdl_stm_pkt *p_packet_in,
                                        const uint32_t size,
                                        const uint8_t *p_data);


/** memory region type for adding multi-region binary files to memory access interface */
typedef struct _file_mem_region {
    size_t                  file_offset;    /**< Offset from start of file for memory region */
    rctdl_vaddr_t           start_address;  /**< Start address of memory region */
    size_t                  region_size;    /**< size in bytes of memory region */
} file_mem_region_t;

/** @}*/

#endif // ARM_RCTDL_C_API_TYPES_H_INCLUDED

/* End of File rctdl_c_api_types.h */