packet-pn.h

/* packet-pn.h
 * Common functions for other PROFINET protocols like DCP, MRP, ...
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1999 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
/*
 * Cyclic PNIO RTC1 Data Dissection:
 *
 * Added new structures to packet-pn.h to transfer the gained data of
 * packet-pn-dcp.c and packet-dcerpc-pn-io.c to packet-pn-rtc-one.c for
 * detailed dissection of cyclic PNIO RTC1 dataframes.
 *
 */
 
#define FRAME_ID_DCP_HELLO      0xfefc
#define FRAME_ID_DCP_GETORSET   0xfefd
#define FRAME_ID_DCP_IDENT_REQ  0xfefe
#define FRAME_ID_DCP_IDENT_RES  0xfeff
 
 
/* ---- Structures for pnio_rtc1 ---- */
extern int       proto_pn_dcp;
extern int proto_pn_io_apdu_status;
extern int proto_pn_io_time_aware_status;
 
extern bool pnio_ps_selection;  /* given by pnio preferences */

typedef struct tagStationInfo {
    /* general information */
    char     *typeofstation;        
    char     *nameofstation;        
    uint16_t  u16Vendor_id;         
    uint16_t  u16Device_id;         
 
    /* frame structure */
    uint16_t  ioDataObjectNr_in;    
    uint16_t  ioDataObjectNr_out;   
    uint16_t  iocsNr_in;            
    uint16_t  iocsNr_out;           
 
    /* GSD file station information */
    bool      gsdFound;             
    bool      gsdPathLength;        
    char     *gsdLocation;          
 
    /* IOCS object data */
    wmem_list_t *iocs_data_in;      
    wmem_list_t *iocs_data_out;     
 
    /* IOData object data */
    wmem_list_t *ioobject_data_in;  
    wmem_list_t *ioobject_data_out; 
 
    /* Different ModuleIdentnumber */
    wmem_list_t *diff_module;       
 
    /* Flag for the extraction of PNIO Objects without AR */
    bool filled_with_objects;       
} stationInfo;

typedef struct tagApduStatusSwitch
{
    bool    isRedundancyActive; 
    address dl_dst;             
    address dl_src;             
} apduStatusSwitch;

typedef struct tagIocsObject {
    uint16_t slotNr;      
    uint16_t subSlotNr;   
    uint16_t frameOffset; 
} iocsObject;

typedef struct tagIoDataObject {
    uint16_t  slotNr;              
    uint16_t  subSlotNr;           
    uint32_t  api;                 
    uint32_t  moduleIdentNr;       
    uint32_t  subModuleIdentNr;    
    uint16_t  frameOffset;         
    uint16_t  length;              
    uint16_t  amountInGSDML;       
    uint32_t  fParameterIndexNr;   
    uint16_t  f_par_crc1;          
    uint16_t  f_src_adr;           
    uint16_t  f_dest_adr;          
    bool      f_crc_seed;          
    uint8_t   f_crc_len;           
    address   srcAddr;             
    address   dstAddr;             
    bool      profisafeSupported;  
    bool      discardIOXS;         
    char     *moduleNameStr;       
    tvbuff_t *tvb_slot;            
    tvbuff_t *tvb_subslot;         
 
    /* Status- or Controlbyte data */
    uint8_t   last_sb_cb;          
    uint8_t   lastToggleBit;       
} ioDataObject;

typedef struct tagModuleDiffInfo {
    uint16_t slotNr;  
    uint32_t modulID; 
} moduleDiffInfo;

typedef struct tagARUUIDFrame {
    e_guid_t aruuid;        
    uint32_t setupframe;    
    uint32_t releaseframe;  
    uint16_t outputframe;   
    uint16_t inputframe;    
} ARUUIDFrame;
 
extern wmem_list_t *aruuid_frame_setup_list; 

extern void init_pn(int proto);

extern void init_pn_io_rtc1(int proto);

extern void init_pn_rsi(int proto);

extern void pn_rsi_reassemble_init(void);

extern void init_pnio_rtc1_station(stationInfo *station_info);

extern unsigned dissect_pn_uint8(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                  proto_tree *tree, int hfindex, uint8_t *pdata);

extern unsigned dissect_pn_uint16_ret_item(tvbuff_t *tvb, unsigned offset, packet_info *pinfo _U_,
                       proto_tree *tree, int hfindex, uint16_t *pdata, proto_item ** new_item);

extern unsigned dissect_pn_uint16(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                       proto_tree *tree, int hfindex, uint16_t *pdata);

extern unsigned dissect_pn_int16(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                       proto_tree *tree, int hfindex, int16_t *pdata);

extern unsigned dissect_pn_oid(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, int hfindex, uint32_t *pdata);

extern unsigned dissect_pn_mac(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, int hfindex, uint8_t *pdata);

extern unsigned dissect_pn_ipv4(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, int hfindex, uint32_t *pdata);

extern unsigned dissect_pn_uuid(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, int hfindex, e_guid_t *uuid);

extern unsigned dissect_pn_undecoded(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, uint32_t length);

extern unsigned dissect_pn_user_data(tvbuff_t *tvb, unsigned offset, packet_info *pinfo _U_,
                    proto_tree *tree, uint32_t length, const char *text);

extern unsigned dissect_pn_pa_profile_data(tvbuff_t *tvb, unsigned offset, packet_info *pinfo _U_,
                    proto_tree *tree, uint32_t length, const char *text);

extern unsigned dissect_blocks(tvbuff_t *tvb, unsigned offset,
                    packet_info *pinfo, proto_tree *tree, uint8_t *drep);
 
#define PDU_TYPE_REQ 0x05
#define PDU_TYPE_RSP 0x06

extern unsigned dissect_rsi_blocks(tvbuff_t* tvb, unsigned offset, packet_info* pinfo, proto_tree* tree, uint8_t* drep, uint32_t u32FOpnumOffsetOpnum, int type);
 
#define SUBST_DATA  1
#define FRAG_DATA   2

extern unsigned dissect_pn_user_data_bytes(tvbuff_t *tvb, unsigned offset, packet_info *pinfo _U_,
                    proto_tree *tree, uint32_t length, int iSelect);

extern unsigned dissect_pn_malformed(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, uint32_t length);

extern unsigned dissect_pn_padding(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, unsigned length);

extern unsigned dissect_pn_align4(tvbuff_t *tvb, unsigned offset, packet_info *pinfo, proto_tree *tree);

extern unsigned dissect_PNIO_status(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, uint8_t *drep);

 
extern unsigned dissect_PNIO_C_SDU_RTC1(tvbuff_t* tvb, unsigned offset, packet_info* pinfo,
                    proto_tree* tree, uint8_t* drep _U_, uint16_t frameid);

 
extern unsigned dissect_PNIO_RTC1_with_security(tvbuff_t* tvb, unsigned offset, packet_info* pinfo,
                    proto_tree* tree, uint8_t* drep _U_, uint16_t frameid);

extern unsigned dissect_RTC3_with_security(tvbuff_t* tvb, unsigned offset, packet_info* pinfo,
                    proto_tree* tree, uint8_t* drep _U_, void* data);

extern unsigned dissect_PNIO_RSI(tvbuff_t *tvb, unsigned offset, packet_info *pinfo,
                    proto_tree *tree, uint8_t *drep);

extern unsigned dissect_PNIO_RSI_with_security(tvbuff_t* tvb, unsigned offset, packet_info* pinfo,
                    proto_tree* tree, uint8_t* drep);

extern unsigned dissect_SecurityMetaData_block(tvbuff_t* tvb, unsigned offset,
                    packet_info* pinfo, proto_item* item, proto_tree* tree, uint8_t* drep);

extern unsigned dissect_SecurityChecksum(tvbuff_t* tvb, unsigned offset, proto_tree* tree);
 

extern unsigned dissect_PDRsiInstances_block(tvbuff_t *tvb, unsigned offset,
                    packet_info *pinfo, proto_tree *tree, proto_item *item _U_, uint8_t *drep, uint8_t u8BlockVersionHigh, uint8_t u8BlockVersionLow);

extern void pn_append_info(packet_info *pinfo, proto_item *dcp_item, const char *text);

extern void pn_init_append_aruuid_frame_setup_list(e_guid_t aruuid, uint32_t setup);

extern ARUUIDFrame* pn_find_aruuid_frame_setup(packet_info* pinfo);

extern void pn_find_dcp_station_info(stationInfo* station_info, conversation_t* conversation);

extern bool dissect_CSF_SDU_heur(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data);

extern bool pn_is_valid_security_metadata(tvbuff_t *tvb, unsigned security_meta_data_offset, int expected_security_data_length);