packet-trdp-dict.h

/* packet-trdp-dict.h
 * Routines for trdp packet dissection, parser for IEC 61375-3-2 XML description
 *
 * Copyright Bombardier Transportation Inc. or its subsidiaries and others, 2013. Florian Weispfenning
 * Copyright Universität Rostock, 2019 (substantial changes leading to GLib-only version). Thorsten Schulz
 * Copyright Stadler Deutschland GmbH, 2024-2025. Thorsten Schulz
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef TRDP_CONFIG_HANDLER
#define TRDP_CONFIG_HANDLER
 
/*******************************************************************************
 * INCLUDES
 */
#include <epan/packet.h>
 
 /* packet-trdp-env.h */
#define TRDP_BITSET8 1     
#define TRDP_CHAR8 2       
#define TRDP_UTF16 3       
#define TRDP_INT8 4        
#define TRDP_INT16 5       
#define TRDP_INT32 6       
#define TRDP_INT64 7       
#define TRDP_UINT8 8       
#define TRDP_UINT16 9      
#define TRDP_UINT32 10     
#define TRDP_UINT64 11     
#define TRDP_REAL32 12     
#define TRDP_REAL64 13     
#define TRDP_TIMEDATE32 14 
#define TRDP_TIMEDATE48                                                        \
  15 
#define TRDP_TIMEDATE64 16 
#define TRDP_SC32 17       
#define TRDP_UUID 18       
#define TRDP_BITSUBTYPE_BITS 8
#define TRDP_BITSUBTYPE_BITSET8 0 
#define TRDP_BITSUBTYPE_BOOL8                                                  \
  1 
#define TRDP_BITSUBTYPE_ANTIVALENT8                                            \
  2 
#define TRDP_ENDSUBTYPE_BIG 0 
#define TRDP_ENDSUBTYPE_LIT 1 
#define TRDP_STANDARDTYPE_MAX TRDP_UUID 
#define TRDP_DEFAULT_UDPTCP_MD_PORT                                            \
  17225 
#define TRDP_DEFAULT_UDP_PD_PORT                                               \
  17224 
#define TRDP_DEFAULT_STR_PD_PORT "17224"
#define TRDP_DEFAULT_STR_MD_PORT "17225"
 
#define TRDP_DEFAULT_SC32_SID 0xFFFFFFFF
#define TRDP_DEFAULT_STR_SC32_SID "0xFFFFFFFF"
 
#define TRDP_MAX_DATASET_RECURSION \
  15 
#define PROTO_TAG_TRDP "TRDP"
#define PROTO_NAME_TRDP "Train Real Time Data Protocol"
#define PROTO_DISSECTORNAME_TRDP "TRDP"
#define PROTO_DISSECTORNAME_TRDPTCP "TRDP.tcp"
#define PROTO_FILTERNAME_TRDP "trdp"
#define PROTO_FILTERNAME_TRDP_PDU PROTO_FILTERNAME_TRDP ".pdu"
 
#define WS_LOG_DOMAIN PROTO_TAG_TRDP
 
#define TRDP_HEADER_OFFSET_SEQCNT 0
#define TRDP_HEADER_OFFSET_PROTOVER 4
#define TRDP_HEADER_OFFSET_TYPE 6
#define TRDP_HEADER_OFFSET_COMID 8
#define TRDP_HEADER_OFFSET_ETB_TOPOCNT 12
#define TRDP_HEADER_OFFSET_OP_TRN_TOPOCNT 16
#define TRDP_HEADER_OFFSET_DATASETLENGTH 20
 
#define TRDP_HEADER_PD_OFFSET_RESERVED 24
#define TRDP_HEADER_PD_OFFSET_REPLY_COMID 28
#define TRDP_HEADER_PD_OFFSET_REPLY_IPADDR 32
#define TRDP_HEADER_PD_OFFSET_FCSHEAD 36
#define TRDP_HEADER_PD_OFFSET_DATA 40
 
#define TRDP_HEADER_MD_OFFSET_REPLY_STATUS 24
#define TRDP_HEADER_MD_SESSIONID0 28
#define TRDP_HEADER_MD_SESSIONID1 32
#define TRDP_HEADER_MD_SESSIONID2 36
#define TRDP_HEADER_MD_SESSIONID3 40
#define TRDP_HEADER_MD_REPLY_TIMEOUT 44
#define TRDP_HEADER_MD_SRC_URI 48
#define TRDP_HEADER_MD_DEST_URI 80
#define TRDP_HEADER_MD_OFFSET_FCSHEAD 112
#define TRDP_HEADER_MD_OFFSET_DATA 116
 
#define TRDP_MD_HEADERLENGTH                                                   \
  TRDP_HEADER_MD_OFFSET_DATA 
#define TRDP_FCS_LENGTH                                                        \
  4 
#define TRDP_SC32_LENGTH                                                       \
  4 
int32_t trdp_dissect_width(uint32_t type);
 
/* end packet-trdp-env.h */
/*******************************************************************************
 * CLASS Definition
 */
 
/* Assistant type to cater the type duality of a BITSET8 */
typedef struct ElementType {
    char name[32];
    uint32_t id;
    uint32_t subtype;
} ElementType;
 
typedef struct Bit {
    char name[32];  
    int        hf_id;
    int        ett_id;
//      int        position;
//      struct Element *parent;
} Bit;
 
typedef struct Element {
/* R/O */
    char *name;  
    char *unit;  
/*public:*/
 
    ElementType type; 
    int32_t     array_size; 
    double      scale;      
    int32_t     offset;     
    Bit*        bits;       
    int32_t     bitindex;   
    int **      bitfields;  
    int         bits_ett_id;
 
    int32_t     width; 
    struct Dataset *linkedDS; 
    int         hf_id;
    int         ett_id;
    struct Element *next;
 
} Element;
 
typedef struct Dataset {
/* private */
    int32_t  size;            
    char     *name;           
/* public */
    uint32_t datasetId;       
    int      ett_id;          
    int      duplicates;      
    char     *source;         
    struct Element *listOfElements; 
    struct Element *lastOfElements; 
    struct Dataset *next;    
} Dataset;
 
 
typedef struct ComId {
    char    *name;       
/* public: */
    uint32_t comId;      
    uint32_t dataset;    
    int32_t  size;       
    int      ett_id;     
    int      duplicates; 
    char     *source;    
    struct Dataset *linkedDS; 
    struct ComId   *next;     
} ComId;
 
typedef struct TrdpDict {
 
/* pub */
    struct Dataset *mTableDataset; 
/* pub-R/O */
        struct Dataset *mCyclicDataset;
        size_t maxDatasetDepth;      
    unsigned int   knowledge;    
    unsigned int   datasets;     
    struct ComId  *mTableComId;  
    const char    *currentFile;  
    bool           isShippedXml; 
    uint32_t def_bitset_subtype; 
    uint32_t def_endian_subtype; 
} TrdpDict;
 
extern TrdpDict* TrdpDict_new(const char* baseXmlConfig, const char* customXmlConfig, uint32_t bitset_subtype, uint32_t endian_subtype, GError** error);
 
extern void         TrdpDict_delete (      TrdpDict *self, gint parent_id);
 
extern const ComId* TrdpDict_lookup_ComId(const TrdpDict *self, uint32_t comId);
 
extern const char* TrdpDict_lookup_ComId_Name(const TrdpDict *self, uint32_t comId);
 
extern       Dataset* TrdpDict_get_Dataset (const TrdpDict *self, uint32_t datasetId);
 
/* @fn     int32_t TrdpDict_element_size(const Element *element, uint32_t array_size);
 *
 * @brief  Calculate the size of an element and its subtree if there is one.
 *
 * @param  self       The element to calculate
 * @param  array_size Hand in the dynamic size of the array (kept from the previous element) or set to 1 to use the predefined size from the dictionary.
 * @return -1 on error, or the type-size multiplied by the array-size. */
extern       int32_t   TrdpDict_element_size(const Element  *self, uint32_t array_size /* = 1*/);
 
extern const ElementType ElBasics[];
 
#endif