packet-xdlc.h

Go to the documentation of this file.

/* xdlc.h
 * Define *DLC frame types, and routine to dissect the control field of
 * a *DLC frame.
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef __XDLC_H__
#define __XDLC_H__
 
#include "ws_symbol_export.h"
 
/*
 * Low-order bits of first (extended) or only (basic) octet of control
 * field, specifying the frame type.
 */
#define XDLC_I_MASK     0x01    
#define XDLC_I          0x00    
#define XDLC_S_U_MASK       0x03    
#define XDLC_S          0x01    
#define XDLC_U          0x03    
/*
 * N(S) and N(R) fields, in basic and extended operation.
 */
#define XDLC_N_R_MASK       0xE0    
#define XDLC_N_R_SHIFT      5
#define XDLC_N_R_EXT_MASK   0xFE00  
#define XDLC_N_R_EXT_SHIFT  9
#define XDLC_N_S_MASK       0x0E    
#define XDLC_N_S_SHIFT      1
#define XDLC_N_S_EXT_MASK   0x00FE  
#define XDLC_N_S_EXT_SHIFT  1
 
/*
 * Poll/Final bit, in basic and extended operation.
 */
#define XDLC_P_F        0x10    
#define XDLC_P_F_EXT    0x0100  
/*
 * S-format frame types.
 */
#define XDLC_S_FTYPE_MASK   0x0C
#define XDLC_RR         0x00    
#define XDLC_RNR        0x04    
#define XDLC_REJ        0x08    
#define XDLC_SREJ       0x0C    
/*
 * U-format modifiers.
 */
#define XDLC_U_MODIFIER_MASK    0xEC
#define XDLC_UI     0x00    
#define XDLC_UP     0x20    
#define XDLC_DISC   0x40    
#define XDLC_RD     0x40    
#define XDLC_UA     0x60    
#define XDLC_SNRM   0x80    
#define XDLC_TEST   0xE0    
#define XDLC_SIM    0x04    
#define XDLC_RIM    0x04    
#define XDLC_FRMR   0x84    
#define XDLC_CFGR   0xC4    
#define XDLC_SARM   0x0C    
#define XDLC_DM     0x0C    
#define XDLC_SABM   0x2C    
#define XDLC_SARME  0x4C    
#define XDLC_SABME  0x6C    
#define XDLC_RESET  0x8C    
#define XDLC_XID    0xAC    
#define XDLC_SNRME  0xCC    
#define XDLC_BCN    0xEC    
#define XDLC_IS_INFORMATION(control) \
    (((control) & XDLC_I_MASK) == XDLC_I || (control) == (XDLC_UI|XDLC_U))
 
#define XDLC_CONTROL_LEN(control, is_extended) \
    ((((control) & XDLC_S_U_MASK) == XDLC_U || !(is_extended)) ? 1 : 2)
 
typedef struct {
    int *hf_xdlc_n_r;
    int *hf_xdlc_n_s;
    int *hf_xdlc_p;
    int *hf_xdlc_f;
    int *hf_xdlc_s_ftype;
    int *hf_xdlc_u_modifier_cmd;
    int *hf_xdlc_u_modifier_resp;
    int *hf_xdlc_ftype_i;
    int *hf_xdlc_ftype_s_u;
} xdlc_cf_items;
 
extern const value_string ftype_vals[];
extern const value_string stype_vals[];
extern const value_string modifier_vals_cmd[];
extern const value_string modifier_vals_resp[];
 
extern int get_xdlc_control(const uint8_t *pd, int offset, bool is_extended);
 
WS_DLL_PUBLIC int dissect_xdlc_control(tvbuff_t *tvb, int offset, packet_info *pinfo,
  proto_tree *xdlc_tree, int hf_xdlc_control, int ett_xdlc_control,
  const xdlc_cf_items *cf_items_nonext, const xdlc_cf_items *cf_items_ext,
  const value_string *u_modifier_short_vals_cmd,
  const value_string *u_modifier_short_vals_resp, bool is_response,
  bool is_extended, bool append_info);
 
#endif