trc_pkt_types_ptm.h

Go to the documentation of this file.

/*
 * \file       trc_pkt_ptm_types.h
 * \brief      OpenCSD : PTM specific 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_TRC_PKT_PTM_TYPES_H_INCLUDED
#define ARM_TRC_PKT_PTM_TYPES_H_INCLUDED
 
#include "opencsd/trc_pkt_types.h"


 
typedef enum _ocsd_ptm_pkt_type
{
// markers for unknown packets
    PTM_PKT_NOTSYNC,        
    PTM_PKT_INCOMPLETE_EOT, 
    PTM_PKT_NOERROR,        
 
// markers for valid packets
    PTM_PKT_BRANCH_ADDRESS, 
    PTM_PKT_A_SYNC,         
    PTM_PKT_I_SYNC,         
    PTM_PKT_TRIGGER,        
    PTM_PKT_WPOINT_UPDATE,  
    PTM_PKT_IGNORE,         
    PTM_PKT_CONTEXT_ID,     
    PTM_PKT_VMID,           
    PTM_PKT_ATOM,           
    PTM_PKT_TIMESTAMP,      
    PTM_PKT_EXCEPTION_RET,  
    PTM_PKT_BRANCH_OR_BYPASS_EOT, // interpreter FSM 'state' : unsure if branch 0 packet or bypass flush end of trace
    PTM_PKT_TPIU_PAD_EOB,   // pad end of a buffer - no valid trace at this point
 
// markers for bad packets
    PTM_PKT_BAD_SEQUENCE,   
    PTM_PKT_RESERVED,       
 
} ocsd_ptm_pkt_type;
 
typedef struct _ptm_context_t {
    struct {
        uint32_t curr_alt_isa:1;     
        uint32_t curr_NS:1;          
        uint32_t curr_Hyp:1;         
        uint32_t updated:1;          
        uint32_t updated_c:1;        
        uint32_t updated_v:1;        
    };
    uint32_t ctxtID;    
    uint8_t VMID;       
} ptm_context_t;
 
typedef struct _ocsd_ptm_excep {
    ocsd_armv7_exception type; 
    uint16_t number;    
    struct {
        uint32_t present:1;      
    } bits;
} ocsd_ptm_excep;
 
 
typedef struct _ocsd_ptm_pkt
{
    ocsd_ptm_pkt_type type;        
 
    ocsd_isa curr_isa;         
    ocsd_isa prev_isa;         
 
    ocsd_pkt_vaddr addr;       
    ptm_context_t   context;    
    ocsd_pkt_atom  atom;
 
    ocsd_iSync_reason i_sync_reason;   
 
    uint32_t cycle_count;       
    uint8_t cc_valid;           
    
    uint64_t timestamp;         
    uint8_t ts_update_bits;     
 
    ocsd_ptm_excep exception;  
 
    ocsd_ptm_pkt_type err_type;    
 
} ocsd_ptm_pkt;
 
typedef struct _ocsd_ptm_cfg 
{
    uint32_t                reg_idr;    
    uint32_t                reg_ctrl;   
    uint32_t                reg_ccer;   
    uint32_t                reg_trc_id; 
    ocsd_arch_version_t    arch_ver;   
    ocsd_core_profile_t    core_prof;  
} ocsd_ptm_cfg;

 

#endif // ARM_TRC_PKT_PTM_TYPES_H_INCLUDED
 
/* End of File trc_pkt_ptm_types.h */