epan/dissectors/packet-uhd.c

   1 /* packet-uhd.c
   2  * Routines for UHD captures
   3  *
   4  * (C) 2013 by Klyuchnikov Ivan <kluchnikovi@gmail.com>, Dario Lombardo <lomato@gmail.com>
   5  *
   6  * $Id$
   7  *
   8  * Wireshark - Network traffic analyzer
   9  * By Gerald Combs <gerald@wireshark.org>
  10  * Copyright 1998 Gerald Combs
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26
  27 /*
  28  * Original dissector can be found here
  29  * https://github.com/chemeris/uhd_dissector
  30 */
  31
  32
  33 #include "config.h"
  34
  35 #include <glib.h>
  36 #include <epan/packet.h>
  37 #include <epan/prefs.h>
  38
  39 static gint dissector_port_pref = 0;
  40
  41 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
  42
  43 #define    USRP2_CTRL_ID_HUH_WHAT    0x20  /* ' ' */
  44 #define    UMTRX_CTRL_ID_REQUEST     0x75  /* 'u' */
  45 #define    UMTRX_CTRL_ID_RESPONSE    0x55  /* 'U' */
  46 #define    USRP2_CTRL_ID_WAZZUP_BRO  0x61  /* 'a' */
  47 #define    USRP2_CTRL_ID_WAZZUP_DUDE 0x41  /* 'A' */
  48 #define    USRP2_CTRL_ID_TRANSACT_ME_SOME_SPI_BRO     0x73 /* 's' */
  49 #define    USRP2_CTRL_ID_OMG_TRANSACTED_SPI_DUDE      0x53 /* 'S' */
  50 #define    USRP2_CTRL_ID_DO_AN_I2C_READ_FOR_ME_BRO    0x69 /* 'i' */
  51 #define    USRP2_CTRL_ID_HERES_THE_I2C_DATA_DUDE      0x49 /* 'I' */
  52 #define    USRP2_CTRL_ID_WRITE_THESE_I2C_VALUES_BRO   0x68 /* 'h' */
  53 #define    USRP2_CTRL_ID_COOL_IM_DONE_I2C_WRITE_DUDE  0x48 /* 'H' */
  54 #define    USRP2_CTRL_ID_GET_THIS_REGISTER_FOR_ME_BRO 0x72 /* 'r' */
  55 #define    USRP2_CTRL_ID_OMG_GOT_REGISTER_SO_BAD_DUDE 0x52 /* 'R' */
  56 #define    USRP2_CTRL_ID_HOLLER_AT_ME_BRO 0x6c /* 'l' */
  57 #define    USRP2_CTRL_ID_HOLLER_BACK_DUDE 0x4c /* 'L' */
  58 #define    USRP2_CTRL_ID_PEACE_OUT        0x7e /* '~' */
  59
  60 #define     USRP2_REG_ACTION_FPGA_PEEK32 1
  61 #define     USRP2_REG_ACTION_FPGA_PEEK16 2
  62 #define     USRP2_REG_ACTION_FPGA_POKE32 3
  63 #define     USRP2_REG_ACTION_FPGA_POKE16 4
  64 #define     USRP2_REG_ACTION_FW_PEEK32   5
  65 #define     USRP2_REG_ACTION_FW_POKE32   6
  66
  67 #define UHD_UDP_PORT                            49152
  68
  69 /* This is the header as it is used by uhd-generating software.
  70  * It is not used by the wireshark dissector and provided for reference only.
  71 typedef struct{
  72     uint32_t proto_ver;
  73     uint32_t id;
  74     uint32_t seq;
  75     union{
  76         uint32_t ip_addr;
  77         struct {
  78             uint32_t dev;
  79             uint32_t data;
  80             uint8_t miso_edge;
  81             uint8_t mosi_edge;
  82             uint8_t num_bits;
  83             uint8_t readback;
  84         } spi_args;
  85         struct {
  86             uint8_t addr;
  87             uint8_t bytes;
  88             uint8_t data[20];
  89         } i2c_args;
  90         struct {
  91             uint32_t addr;
  92             uint32_t data;
  93             uint8_t action;
  94         } reg_args;
  95         struct {
  96             uint32_t len;
  97         } echo_args;
  98     } data;
  99 } usrp2_ctrl_data_t;
 100  */
 101
 102 static int proto_uhd = -1;
 103
 104 static int hf_uhd_version = -1;
 105 static int hf_uhd_id = -1;
 106 static int hf_uhd_seq = -1;
 107 static int hf_uhd_ip_addr = -1;
 108 static int hf_uhd_i2c_addr = -1;
 109 static int hf_uhd_i2c_bytes = -1;
 110 static int hf_uhd_i2c_data = -1;
 111 static int hf_uhd_spi_dev = -1;
 112 static int hf_uhd_spi_data = -1;
 113 static int hf_uhd_spi_miso_edge = -1;
 114 static int hf_uhd_spi_mosi_edge = -1;
 115 static int hf_uhd_spi_num_bits = -1;
 116 static int hf_uhd_spi_readback = -1;
 117 static int hf_uhd_reg_addr = -1;
 118 static int hf_uhd_reg_data = -1;
 119 static int hf_uhd_reg_action = -1;
 120 static int hf_uhd_echo_len = -1;
 121
 122
 123 static gint ett_uhd = -1;
 124
 125
 126 static const value_string uhd_ids[] = {
 127         { USRP2_CTRL_ID_HUH_WHAT,                     "HUH WHAT" },
 128         { UMTRX_CTRL_ID_REQUEST,                      "UMTRX REQUEST" },
 129         { UMTRX_CTRL_ID_RESPONSE,                     "UMTRX RESPONSE" },
 130         { USRP2_CTRL_ID_WAZZUP_BRO,                   "WAZZUP BRO" },
 131         { USRP2_CTRL_ID_WAZZUP_DUDE,                  "WAZZUP DUDE" },
 132         { USRP2_CTRL_ID_TRANSACT_ME_SOME_SPI_BRO,     "TRANSACT ME SOME SPI BRO" },
 133         { USRP2_CTRL_ID_OMG_TRANSACTED_SPI_DUDE,      "OMG TRANSACTED SPI DUDE" },
 134         { USRP2_CTRL_ID_DO_AN_I2C_READ_FOR_ME_BRO,    "DO AN I2C READ FOR ME BRO" },
 135         { USRP2_CTRL_ID_HERES_THE_I2C_DATA_DUDE,      "HERES THE I2C DATA DUDE" },
 136         { USRP2_CTRL_ID_WRITE_THESE_I2C_VALUES_BRO,   "WRITE THESE I2C VALUES BRO" },
 137         { USRP2_CTRL_ID_COOL_IM_DONE_I2C_WRITE_DUDE,  "COOL IM DONE I2C WRITE DUDE" },
 138         { USRP2_CTRL_ID_GET_THIS_REGISTER_FOR_ME_BRO, "GET THIS REGISTER FOR ME BRO" },
 139         { USRP2_CTRL_ID_OMG_GOT_REGISTER_SO_BAD_DUDE, "OMG GOT REGISTER SO BAD DUDE" },
 140         { USRP2_CTRL_ID_HOLLER_AT_ME_BRO,             "HOLLER AT ME BRO" },
 141         { USRP2_CTRL_ID_HOLLER_BACK_DUDE,             "HOLLER BACK DUDE" },
 142         { USRP2_CTRL_ID_PEACE_OUT,                    "PEACE OUT" },
 143         { 0, NULL }
 144 };
 145
 146 static const value_string uhd_reg_actions[] = {
 147         { USRP2_REG_ACTION_FPGA_PEEK32, "FPGA PEEK32" },
 148         { USRP2_REG_ACTION_FPGA_PEEK16, "FPGA PEEK16" },
 149         { USRP2_REG_ACTION_FPGA_POKE32, "FPGA POKE32" },
 150         { USRP2_REG_ACTION_FPGA_POKE16, "FPGA POKE16" },
 151         { USRP2_REG_ACTION_FW_PEEK32,   "FW PEEK32" },
 152         { USRP2_REG_ACTION_FW_POKE32,   "FW POKE32" },
 153         { 0, NULL }
 154 };
 155
 156 void proto_reg_handoff_uhd(void);
 157
 158 /* dissect a UHD header and hand payload off to respective dissector */
 159 static void
 160 dissect_uhd(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 161 {
 162         int ind;
 163         proto_item *ti;
 164         proto_tree *uhd_tree = NULL;
 165         guint32 id;
 166         guint8 i2c_bytes;
 167
 168         id = tvb_get_ntohl(tvb, 4);
 169
 170         col_set_str(pinfo->cinfo, COL_PROTOCOL, "UHD");
 171         col_add_str(pinfo->cinfo, COL_INFO, val_to_str(id, uhd_ids, "Unknown UHD message type '%c'"));
 172
 173         if (tree) {
 174
 175                 ti = proto_tree_add_protocol_format(tree, proto_uhd, tvb, 0, 34, "UHD id = %c ", id);
 176                 uhd_tree = proto_item_add_subtree(ti, ett_uhd);
 177                 proto_tree_add_item(uhd_tree, hf_uhd_version,
 178                                     tvb, 0, 4, ENC_BIG_ENDIAN);
 179                 proto_tree_add_item(uhd_tree, hf_uhd_id,
 180                                     tvb, 4, 4, ENC_BIG_ENDIAN);
 181                 proto_tree_add_item(uhd_tree, hf_uhd_seq,
 182                                     tvb, 8, 4, ENC_BIG_ENDIAN);
 183         }
 184
 185         switch (id) {
 186                 case UMTRX_CTRL_ID_REQUEST:
 187                 case UMTRX_CTRL_ID_RESPONSE:
 188                 case USRP2_CTRL_ID_WAZZUP_BRO:
 189                 case USRP2_CTRL_ID_WAZZUP_DUDE:
 190                 proto_tree_add_item(uhd_tree, hf_uhd_ip_addr, tvb, 12, 4, ENC_BIG_ENDIAN);
 191                         break;
 192                 case USRP2_CTRL_ID_TRANSACT_ME_SOME_SPI_BRO:
 193                 case USRP2_CTRL_ID_OMG_TRANSACTED_SPI_DUDE:
 194                         proto_tree_add_item(uhd_tree, hf_uhd_spi_dev, tvb, 12, 4, ENC_BIG_ENDIAN);
 195                         proto_tree_add_item(uhd_tree, hf_uhd_spi_data, tvb, 16, 4, ENC_BIG_ENDIAN);
 196                         proto_tree_add_item(uhd_tree, hf_uhd_spi_miso_edge, tvb, 20, 1, ENC_BIG_ENDIAN);
 197                         proto_tree_add_item(uhd_tree, hf_uhd_spi_mosi_edge, tvb, 21, 1, ENC_BIG_ENDIAN);
 198                         proto_tree_add_item(uhd_tree, hf_uhd_spi_num_bits, tvb, 22, 1, ENC_BIG_ENDIAN);
 199                         proto_tree_add_item(uhd_tree, hf_uhd_spi_readback, tvb, 23, 1, ENC_BIG_ENDIAN);
 200                         break;
 201                 case USRP2_CTRL_ID_DO_AN_I2C_READ_FOR_ME_BRO:
 202                 case USRP2_CTRL_ID_HERES_THE_I2C_DATA_DUDE:
 203                 case USRP2_CTRL_ID_WRITE_THESE_I2C_VALUES_BRO:
 204                 case USRP2_CTRL_ID_COOL_IM_DONE_I2C_WRITE_DUDE:
 205                         proto_tree_add_item(uhd_tree, hf_uhd_i2c_addr, tvb, 12, 1, ENC_BIG_ENDIAN);
 206                         i2c_bytes = tvb_get_guint8(tvb, 13);
 207                         proto_tree_add_item(uhd_tree, hf_uhd_i2c_bytes, tvb, 13, 1, ENC_BIG_ENDIAN);
 208                         for (ind = 0; ind < i2c_bytes; ind++) {
 209                                 proto_tree_add_item(uhd_tree, hf_uhd_i2c_data, tvb, 14 + ind, 1, ENC_BIG_ENDIAN);
 210                         }
 211                         break;
 212                 case USRP2_CTRL_ID_GET_THIS_REGISTER_FOR_ME_BRO:
 213                 case USRP2_CTRL_ID_OMG_GOT_REGISTER_SO_BAD_DUDE:
 214                         proto_tree_add_item(uhd_tree, hf_uhd_reg_addr, tvb, 12, 4, ENC_BIG_ENDIAN);
 215                         proto_tree_add_item(uhd_tree, hf_uhd_reg_data, tvb, 16, 4, ENC_BIG_ENDIAN);
 216                         proto_tree_add_item(uhd_tree, hf_uhd_reg_action, tvb, 20, 1, ENC_BIG_ENDIAN);
 217                         break;
 218                 case USRP2_CTRL_ID_HOLLER_AT_ME_BRO:
 219                 case USRP2_CTRL_ID_HOLLER_BACK_DUDE:
 220                 case USRP2_CTRL_ID_HUH_WHAT:
 221                 case USRP2_CTRL_ID_PEACE_OUT:
 222                         proto_tree_add_item(uhd_tree, hf_uhd_echo_len, tvb, 12, 4, ENC_BIG_ENDIAN);
 223                         break;
 224         }
 225 }
 226
 227 void
 228 proto_register_uhd(void)
 229 {
 230         static hf_register_info hf[] = {
 231                 { &hf_uhd_version, { "VERSION", "uhd.version",
 232                   FT_UINT32, BASE_DEC, NULL, 0, NULL, HFILL } },
 233                 { &hf_uhd_id, { "ID", "uhd.id",
 234                   FT_UINT32, BASE_HEX, VALS(uhd_ids), 0, NULL, HFILL } },
 235                 { &hf_uhd_seq, { "SEQ", "uhd.seq",
 236                   FT_UINT32, BASE_DEC, NULL, 0, NULL, HFILL } },
 237                 { &hf_uhd_ip_addr, { "IP ADDR", "uhd.ip_addr",
 238                   FT_IPv4, BASE_NONE, NULL, 0x0,"", HFILL } },
 239                 { &hf_uhd_i2c_addr, { "I2C ADDR", "uhd.i2c_addr",
 240                   FT_UINT8, BASE_HEX, NULL, 0, NULL, HFILL } },
 241                 { &hf_uhd_i2c_bytes, { "I2C BYTES", "uhd.i2c_bytes",
 242                   FT_UINT8, BASE_DEC, NULL, 0, NULL, HFILL } },
 243                 { &hf_uhd_i2c_data, { "I2C DATA", "uhd.i2c_data",
 244                   FT_UINT8, BASE_HEX, NULL, 0, NULL, HFILL } },
 245                 { &hf_uhd_spi_dev, { "SPI DEV", "uhd.spi_dev",
 246                   FT_UINT32, BASE_HEX, NULL, 0, NULL, HFILL } },
 247                 { &hf_uhd_spi_data, { "SPI DATA", "uhd.spi_data",
 248                   FT_UINT32, BASE_HEX, NULL, 0, NULL, HFILL } },
 249                 { &hf_uhd_spi_miso_edge, { "SPI MISO EDGE", "uhd.spi_miso_edge",
 250                   FT_UINT8, BASE_HEX, NULL, 0, NULL, HFILL } },
 251                 { &hf_uhd_spi_mosi_edge, { "SPI MOSI EDGE", "uhd.spi_mosi_edge",
 252                   FT_UINT8, BASE_HEX, NULL, 0, NULL, HFILL } },
 253                 { &hf_uhd_spi_num_bits, { "SPI NUM BITS", "uhd.spi_num_bits",
 254                   FT_UINT8, BASE_DEC, NULL, 0, NULL, HFILL } },
 255                 { &hf_uhd_spi_readback, { "SPI READBACK", "uhd.spi_readback",
 256                   FT_UINT8, BASE_HEX, NULL, 0, NULL, HFILL } },
 257                 { &hf_uhd_reg_addr, { "REG ADDR", "uhd.reg_addr",
 258                   FT_UINT32, BASE_HEX, NULL, 0, NULL, HFILL } },
 259                 { &hf_uhd_reg_data, { "REG DATA", "uhd.reg_data",
 260                   FT_UINT32, BASE_HEX, NULL, 0, NULL, HFILL } },
 261                 { &hf_uhd_reg_action, { "REG ACTION", "uhd.reg_action",
 262                   FT_UINT8, BASE_HEX, VALS(uhd_reg_actions), 0, NULL, HFILL } },
 263                 { &hf_uhd_echo_len, { "ECHO LEN", "uhd.echo_len",
 264                   FT_UINT32, BASE_DEC, NULL, 0, NULL, HFILL } },
 265         };
 266
 267         static gint *ett[] = {
 268                 &ett_uhd
 269         };
 270
 271     module_t *uhd_module;
 272
 273         proto_uhd = proto_register_protocol("UHD", "UHD", "uhd");
 274         proto_register_field_array(proto_uhd, hf, array_length(hf));
 275         proto_register_subtree_array(ett, array_length(ett));
 276
 277     uhd_module = prefs_register_protocol(proto_uhd, proto_reg_handoff_uhd);
 278     prefs_register_uint_preference(uhd_module,
 279         "dissector_port",
 280         "Dissector UDP port",
 281         "The UDP port used by this dissector",
 282         10, &dissector_port_pref);
 283 }
 284
 285 void
 286 proto_reg_handoff_uhd(void)
 287 {
 288         static gboolean uhd_prefs_initialized = FALSE;
 289         static dissector_handle_t uhd_handle;
 290         static gint dissector_port;
 291
 292         if (!uhd_prefs_initialized) {
 293                 uhd_handle = create_dissector_handle(dissect_uhd, proto_uhd);
 294                 uhd_prefs_initialized = TRUE;
 295         } else {
 296                 dissector_delete_uint("udp.port", dissector_port, uhd_handle);
 297         }
 298
 299         dissector_port = dissector_port_pref;
 300
 301         dissector_add_uint("udp.port", dissector_port, uhd_handle);
 302 }
 303
 304 /*
 305  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 306  *
 307  * Local variables:
 308  * c-basic-offset: 8
 309  * tab-width: 8
 310  * indent-tabs-mode: t
 311  * End:
 312  *
 313  * vi: set shiftwidth=8 tabstop=8 noexpandtab:
 314  * :indentSize=8:tabSize=8:noTabs=false:
 315  */