1 /* 2 * \file ocsd_c_api_cust_fact.h 3 * \brief OpenCSD : Custom decoder factory API functions 4 * 5 * \copyright Copyright (c) 2016, 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_OCSD_C_API_CUST_FACT_H_INCLUDED 35 #define ARM_OCSD_C_API_CUST_FACT_H_INCLUDED 36 37 #include "ocsd_c_api_types.h" 38 #include "ocsd_c_api_custom.h" 39 40 /* Declarations for the functions implemented in the custom decoder factory. */ 41 42 /** Required function to create a decoder instance - fills in the decoder struct supplied. */ 43 ocsd_err_t CreateCustomDecoder(const int create_flags, const void *decoder_cfg, ocsd_extern_dcd_inst_t *p_decoder_inst); 44 45 /** Required Function to destroy a decoder instance - indicated by decoder handle */ 46 ocsd_err_t DestroyCustomDecoder(const void *decoder_handle); 47 48 /** Required Function to extract the CoreSight Trace ID from the configuration structure */ 49 ocsd_err_t GetCSIDFromConfig(const void *decoder_cfg, unsigned char *p_csid); 50 51 /** Optional Function to convert a protocol specific trace packet to human readable string */ 52 ocsd_err_t PacketToString(const void *trc_pkt, char *buffer, const int buflen); 53 54 #endif /* ARM_OCSD_C_API_CUST_FACT_H_INCLUDED */ 55