1 /* 2 * \file ext_dcd_echo_test_fact.h 3 * \brief OpenCSD : Echo test custom decoder 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_EXT_DCD_ECHO_TEST_H_INCLUDED 35 #define ARM_EXT_DCD_ECHO_TEST_H_INCLUDED 36 37 #include <inttypes.h> 38 #include "opencsd/c_api/ocsd_c_api_custom.h" 39 40 /* 41 Echo test decoder designed to test the external decoder C - API infrastructure. 42 Echo decoders can be attached to any CS byte stream and will mainly echo the data 43 back with a simple "protocol" decoded - not based on real protocol. 44 45 Will test callback infrastructure and provide an implemntation example for a real external decoder. 46 47 */ 48 49 /*** decoder types ***/ 50 51 typedef struct _echo_dcd_cfg { 52 unsigned char cs_id; 53 } echo_dcd_cfg_t; 54 55 typedef struct _echo_dcd_pkt { 56 uint8_t header; 57 uint32_t data; 58 } echo_dcd_pkt_t; 59 60 typedef enum _echo_dcd_state { 61 DCD_INIT, 62 DCD_WAIT_SYNC, 63 DCD_PROC_PACKETS 64 } echo_dcd_stat_t; 65 66 /** 'packet' size is 5 bytes - 1 header + 4 data. */ 67 #define ECHO_DCD_PKT_SIZE 5 68 69 /** main decoder structure */ 70 typedef struct _echo_decoder { 71 uint8_t data_in[ECHO_DCD_PKT_SIZE]; /** input buffer for current incoming packet data bytes */ 72 int data_in_count; /** count up to the 5 bytes per packet to know when complete packet RX */ 73 echo_dcd_pkt_t curr_pkt; /** current packet */ 74 ocsd_trc_index_t curr_pkt_idx; /** buffer index for the current packet */ 75 echo_dcd_cfg_t reg_config; /** Decoder config "registers" - in this case just the CSID value */ 76 ocsd_extern_dcd_cb_fns lib_fns; /** Library Callback functions */ 77 int createFlags; /** creation / operational options -> packet only / full decode */ 78 echo_dcd_stat_t state; /** current state of the decoder. */ 79 ocsd_generic_trace_elem out_pkt; /** generic output packet */ 80 } echo_decoder_t; 81 82 83 84 /*** internal decoder API ***/ 85 86 /** decoder will contain packet printing logic */ 87 void echo_dcd_pkt_tostr(echo_dcd_pkt_t *pkt, char *buffer, const int buflen); 88 89 /** init decoder on creation, along with library instance structure */ 90 void echo_dcd_init(echo_decoder_t *decoder, ocsd_extern_dcd_inst_t *p_decoder_inst, const echo_dcd_cfg_t *p_config, const ocsd_extern_dcd_cb_fns *p_lib_callbacks); 91 92 #endif /* ARM_EXT_DCD_ECHO_TEST_H_INCLUDED */ 93 94