trc_pkt_types_stm.h

Go to the documentation of this file.

/*
 * \file       trc_pkt_types_stm.h
 * \brief      OpenCSD : STM decoder
 * 
 * \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_TRC_PKT_TYPES_STM_H_INCLUDED
#define ARM_TRC_PKT_TYPES_STM_H_INCLUDED
 
#include "opencsd/trc_pkt_types.h"



typedef enum _ocsd_stm_pkt_type
{
/* markers for unknown packets  / state*/
    STM_PKT_NOTSYNC,            
    STM_PKT_INCOMPLETE_EOT,     
    STM_PKT_NO_ERR_TYPE,        
 
/* markers for valid packets*/
    STM_PKT_ASYNC,      
    STM_PKT_VERSION,    
    STM_PKT_FREQ,       
    STM_PKT_NULL,       
    STM_PKT_TRIG,       
 
    STM_PKT_GERR,       
    STM_PKT_MERR,       
 
    STM_PKT_M8,         
    STM_PKT_C8,         
    STM_PKT_C16,        
 
    STM_PKT_FLAG,       
 
    STM_PKT_D4,         
    STM_PKT_D8,         
    STM_PKT_D16,        
    STM_PKT_D32,        
    STM_PKT_D64,        
 
/* packet errors.*/
    STM_PKT_BAD_SEQUENCE,   
    STM_PKT_RESERVED,       
 
} ocsd_stm_pkt_type;

typedef enum _ocsd_stm_ts_type
{
    STM_TS_UNKNOWN,     
    STM_TS_NATBINARY,   
    STM_TS_GREY         
} ocsd_stm_ts_type;

typedef struct _ocsd_stm_pkt
{
    ocsd_stm_pkt_type type;        
 
    uint8_t     master;             
    uint16_t    channel;            
    
    uint64_t    timestamp;          
    uint8_t     pkt_ts_bits;        
    uint8_t     pkt_has_ts;         
    
    ocsd_stm_ts_type ts_type;      
 
    uint8_t     pkt_has_marker;     
 
    union {
        uint8_t  D8;    
        uint16_t D16;   
        uint32_t D32;   
        uint64_t D64;   
    } payload;
 
    ocsd_stm_pkt_type err_type;    
 
} ocsd_stm_pkt;

typedef enum _hw_event_feat {
    HwEvent_Unknown_Disabled,   
    HwEvent_Enabled,            
    HwEvent_UseRegisters        
} hw_event_feat_t;
 

typedef struct _ocsd_stm_cfg
{
    uint32_t reg_tcsr;          
    uint32_t reg_feat3r;        
    uint32_t reg_devid;         
 
    uint32_t reg_feat1r;        
    uint32_t reg_hwev_mast;     
    hw_event_feat_t hw_event;   
} ocsd_stm_cfg;

 
#endif // ARM_TRC_PKT_TYPES_STM_H_INCLUDED
 
/* End of File trc_pkt_types_stm.h */