git.gag.com Git - debian/gnuradio/blob - usrp2/firmware/include/usrp2_eth_packet.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007,2008 Free Software Foundation, Inc.
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef INCLUDED_USRP2_ETH_PACKET_H
  20 #define INCLUDED_USRP2_ETH_PACKET_H
  21
  22 #include "usrp2_cdefs.h"
  23 #include "usrp2_bytesex.h"
  24 #include "usrp2_mac_addr.h"
  25 #include "usrp2_mimo_config.h"
  26
  27 __U2_BEGIN_DECLS
  28
  29 #define U2_ETHERTYPE            0xBEEF  // used in our frames
  30 #define MAC_CTRL_ETHERTYPE      0x8808  // used in PAUSE frames
  31
  32 /*
  33  * All these data structures are BIG-ENDIAN on the wire
  34  */
  35
  36 // FIXME gcc specific.  Really ought to come from compiler.h
  37 #define _AL4   __attribute__((aligned (4)))
  38
  39 /*
  40  * \brief The classic 14-byte ethernet header
  41  */
  42 typedef struct {
  43   u2_mac_addr_t dst;
  44   u2_mac_addr_t src;
  45   uint16_t      ethertype;
  46 } __attribute__((packed)) u2_eth_hdr_t;
  47
  48 /*!
  49  * \brief USRP2 transport header
  50  *
  51  * This enables host->usrp2 flow control and dropped packet detection.
  52  */
  53 typedef struct {
  54   uint16_t      flags;          // MBZ, may be used for channel in future
  55   uint16_t      fifo_status;    // free space in Rx fifo in 32-bit lines
  56   uint8_t       seqno;          // sequence number of this packet
  57   uint8_t       ack;            // sequence number of next packet expected
  58 } __attribute__((packed)) u2_transport_hdr_t;
  59
  60
  61 /*
  62  * The fixed payload header of a USRP2 ethernet packet...
  63  *
  64  * Basically there's 1 word of flags and routing info, and 1 word
  65  * of timestamp that specifies when the data was received, or
  66  * when it should be transmitted. The data samples follow immediately.
  67  *
  68  * Transmit packets (from host to U2)
  69  *
  70  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  71  *  |  Chan   |                    mbz                        |I|S|E|
  72  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  73  *  |                           Timestamp                           |
  74  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  75  *
  76  *
  77  * Received packets (from U2 to host)
  78  *
  79  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  80  *  |  Chan   |                    mbz                              |
  81  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  82  *  |                           Timestamp                           |
  83  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  84  *
  85  *  mbz == must be zero
  86  */
  87
  88 typedef struct {
  89   uint32_t      word0;          // flags etc
  90   uint32_t      timestamp;      // time of rx or tx (100 MHz)
  91 } u2_fixed_hdr_t;
  92
  93
  94 #define U2P_CHAN_MASK           0x1f
  95 #define U2P_CHAN_SHIFT          27
  96
  97 #define U2P_TX_IMMEDIATE        0x00000004  // send samples NOW, else at timestamp
  98 #define U2P_TX_START_OF_BURST   0x00000002  // this frame is the start of a burst
  99 #define U2P_TX_END_OF_BURST     0x00000001  // this frame is the end of a burst
 100
 101 #define U2P_ALL_FLAGS           0x00000007
 102
 103 #define CONTROL_CHAN            0x1f
 104
 105 static inline int
 106 u2p_chan(u2_fixed_hdr_t *p)
 107 {
 108   return (ntohl(p->word0) >> U2P_CHAN_SHIFT) & U2P_CHAN_MASK;
 109 }
 110
 111 inline static uint32_t
 112 u2p_word0(u2_fixed_hdr_t *p)
 113 {
 114   return ntohl(p->word0);
 115 }
 116
 117 inline static uint32_t
 118 u2p_timestamp(u2_fixed_hdr_t *p)
 119 {
 120   return ntohl(p->timestamp);
 121 }
 122
 123 inline static void
 124 u2p_set_word0(u2_fixed_hdr_t *p, int flags, int chan)
 125 {
 126   p->word0 = htonl((flags & U2P_ALL_FLAGS)
 127                    | ((chan & U2P_CHAN_MASK) << U2P_CHAN_SHIFT));
 128 }
 129
 130 inline static void
 131 u2p_set_timestamp(u2_fixed_hdr_t *p, uint32_t ts)
 132 {
 133   p->timestamp = htonl(ts);
 134 }
 135
 136 /*!
 137  * \brief consolidated packet: ethernet header + transport header + fixed header
 138  */
 139 typedef struct {
 140   u2_eth_hdr_t          ehdr;
 141   u2_transport_hdr_t    thdr;
 142   u2_fixed_hdr_t        fixed;
 143 } u2_eth_packet_t;
 144
 145 /*
 146  * full load of samples:
 147  *   ethernet header + transport header + fixed header + maximum number of samples.
 148  *   sizeof(u2_eth_samples_t) == 1512
 149  *   (payload is 1498 bytes, two bytes shorter than 1500 byte MTU)
 150  */
 151
 152 #define U2_MAX_SAMPLES  371
 153
 154 typedef struct {
 155   u2_eth_packet_t       hdrs;
 156   uint32_t              samples[U2_MAX_SAMPLES];
 157 } u2_eth_samples_t;
 158
 159 /*
 160  * Opcodes for control channel
 161  *
 162  * Reply opcodes are the same as the request opcode with the OP_REPLY_BIT set (0x80).
 163  */
 164 #define OP_REPLY_BIT              0x80
 165
 166 #define OP_EOP                       0  // marks last subpacket in packet
 167
 168 #define OP_ID                        1
 169 #define OP_ID_REPLY                  (OP_ID | OP_REPLY_BIT)
 170 #define OP_BURN_MAC_ADDR             2
 171 #define OP_BURN_MAC_ADDR_REPLY       (OP_BURN_MAC_ADDR | OP_REPLY_BIT)
 172 #define OP_READ_TIME                 3  // What time is it? (100 MHz counter)
 173 #define OP_READ_TIME_REPLY           (OP_READ_TIME | OP_REPLY_BIT)
 174 #define OP_CONFIG_RX_V2              4
 175 #define OP_CONFIG_RX_REPLY_V2        (OP_CONFIG_RX_V2 | OP_REPLY_BIT)
 176 #define OP_CONFIG_TX_V2              5
 177 #define OP_CONFIG_TX_REPLY_V2        (OP_CONFIG_TX_V2 | OP_REPLY_BIT)
 178 #define OP_START_RX_STREAMING        6
 179 #define OP_START_RX_STREAMING_REPLY  (OP_START_RX_STREAMING | OP_REPLY_BIT)
 180 #define OP_STOP_RX                   7
 181 #define OP_STOP_RX_REPLY             (OP_STOP_RX | OP_REPLY_BIT)
 182 #define OP_CONFIG_MIMO               8
 183 #define OP_CONFIG_MIMO_REPLY         (OP_CONFIG_MIMO | OP_REPLY_BIT)
 184 #define OP_DBOARD_INFO               9
 185 #define OP_DBOARD_INFO_REPLY         (OP_DBOARD_INFO | OP_REPLY_BIT)
 186 #define OP_SYNC_TO_PPS               10
 187 #define OP_SYNC_TO_PPS_REPLY         (OP_SYNC_TO_PPS | OP_REPLY_BIT)
 188 #define OP_PEEK                      11
 189 #define OP_PEEK_REPLY                (OP_PEEK | OP_REPLY_BIT)
 190
 191 /*
 192  * All subpackets are a multiple of 4 bytes long.
 193  * All subpackets start with an 8-bit opcode, an 8-bit len and an 8-bit rid.
 194  */
 195
 196
 197 /*!
 198  * \brief Generic request and reply packet
 199  *
 200  * Used by:
 201  *  OP_EOP, OP_BURN_MAC_ADDR_REPLY, OP_START_RX_STREAMING_REPLY,
 202  *  OP_STOP_RX_REPLY, OP_DBOARD_INFO, OP_SYNC_TO_PPS
 203  */
 204 typedef struct {
 205   uint8_t       opcode;
 206   uint8_t       len;
 207   uint8_t       rid;
 208   uint8_t       ok;             // bool
 209 } _AL4 op_generic_t;
 210
 211 /*!
 212  * \brief Reply info from a USRP2
 213  */
 214 typedef struct {
 215   uint8_t       opcode;
 216   uint8_t       len;
 217   uint8_t       rid;
 218   uint8_t       mbz;
 219   u2_mac_addr_t addr;
 220   uint16_t      hw_rev;
 221   uint8_t       fpga_md5sum[16];
 222   uint8_t       sw_md5sum[16];
 223 } _AL4 op_id_reply_t;
 224
 225 typedef struct {
 226   uint8_t       opcode;
 227   uint8_t       len;
 228   uint8_t       rid;
 229   uint8_t       mbz;
 230   uint32_t      items_per_frame;  // # of 32-bit data items; MTU=1500: [9,371]
 231 } _AL4 op_start_rx_streaming_t;
 232
 233 typedef struct {
 234   uint8_t       opcode;
 235   uint8_t       len;
 236   uint8_t       rid;
 237   u2_mac_addr_t addr;
 238 } _AL4 op_burn_mac_addr_t;
 239
 240 typedef struct {
 241   uint8_t       opcode;
 242   uint8_t       len;
 243   uint8_t       rid;
 244   uint8_t       mbz;
 245   uint32_t      time;
 246 } _AL4 op_read_time_reply_t;
 247
 248
 249 /*!
 250  * \brief Configure receiver
 251  */
 252 typedef struct {
 253   uint8_t       opcode;
 254   uint8_t       len;
 255   uint8_t       rid;
 256   uint8_t       mbz;
 257   // bitmask indicating which of the following fields are valid
 258   uint16_t      valid;
 259   uint16_t      gain;           // fxpt_db (Q9.7)
 260   uint32_t      freq_hi;        // high 32-bits of 64-bit fxpt_freq (Q44.20)
 261   uint32_t      freq_lo;        // low  32-bits of 64-bit fxpt_freq (Q44.20)
 262   uint32_t      decim;          // desired decimation factor (NOT -1)
 263   uint32_t      scale_iq;       // (scale_i << 16) | scale_q [16.0 format]
 264 } _AL4 op_config_rx_v2_t;
 265
 266 // bitmask for "valid" field.  If the bit is set, there's
 267 // meaningful data in the corresonding field.
 268
 269 #define CFGV_GAIN               0x0001  // gain field is valid
 270 #define CFGV_FREQ               0x0002  // target_freq field is valid
 271 #define CFGV_INTERP_DECIM       0x0004  // interp or decim is valid
 272 #define CFGV_SCALE_IQ           0x0008  // scale_iq is valid
 273
 274 /*!
 275  * \brief Reply to receiver configuration
 276  */
 277 typedef struct {
 278   uint8_t       opcode;
 279   uint8_t       len;
 280   uint8_t       rid;
 281   uint8_t       mbz;
 282
 283   uint16_t      ok;             // config was successful (bool)
 284   uint16_t      inverted;       // spectrum is inverted (bool)
 285
 286   // RF frequency that corresponds to DC in the IF (fxpt_freq)
 287   uint32_t      baseband_freq_hi;
 288   uint32_t      baseband_freq_lo;
 289   // DDC frequency (fxpt_freq)
 290   uint32_t      ddc_freq_hi;
 291   uint32_t      ddc_freq_lo;
 292   // residual frequency (fxpt_freq)
 293   uint32_t      residual_freq_hi;
 294   uint32_t      residual_freq_lo;
 295
 296 } _AL4 op_config_rx_reply_v2_t;
 297
 298 /*!
 299  *  \brief Configure transmitter
 300  */
 301 typedef struct {
 302   uint8_t       opcode;
 303   uint8_t       len;
 304   uint8_t       rid;
 305   uint8_t       mbz;
 306
 307   // bitmask indicating which of the following fields are valid
 308   uint16_t      valid;
 309   uint16_t      gain;           // fxpt_db (Q9.7)
 310   uint32_t      freq_hi;        // high 32-bits of 64-bit fxpt_freq (Q44.20)
 311   uint32_t      freq_lo;        // low  32-bits of 64-bit fxpt_freq (Q44.20)
 312   uint32_t      interp;         // desired interpolation factor (NOT -1)
 313   uint32_t      scale_iq;       // (scale_i << 16) | scale_q [16.0 format]
 314 } _AL4 op_config_tx_v2_t;
 315
 316 /*!
 317  * \brief Reply to configure transmitter
 318  */
 319 typedef struct {
 320   uint8_t       opcode;
 321   uint8_t       len;
 322   uint8_t       rid;
 323   uint8_t       mbz;
 324
 325   uint16_t      ok;             // config was successful (bool)
 326   uint16_t      inverted;       // spectrum is inverted (bool)
 327
 328   // RF frequency that corresponds to DC in the IF (fxpt_freq)
 329   uint32_t      baseband_freq_hi;
 330   uint32_t      baseband_freq_lo;
 331   // DUC frequency (fxpt_freq)
 332   uint32_t      duc_freq_hi;
 333   uint32_t      duc_freq_lo;
 334   // residual frequency (fxpt_freq)
 335   uint32_t      residual_freq_hi;
 336   uint32_t      residual_freq_lo;
 337
 338 } _AL4 op_config_tx_reply_v2_t;
 339
 340 /*!
 341  * \brief Configure MIMO clocking, etc (uses generic reply)
 342  */
 343 typedef struct {
 344   uint8_t       opcode;
 345   uint8_t       len;
 346   uint8_t       rid;
 347   uint8_t       flags;  // from usrp_mimo_config.h
 348 } op_config_mimo_t;
 349
 350
 351 /*!
 352  * \brief High-level information about daughterboards
 353  */
 354 typedef struct {
 355   int32_t       dbid;           //< d'board ID (-1 none, -2 invalid eeprom)
 356   uint32_t      freq_min_hi;    //< high 32-bits of 64-bit fxpt_freq (Q44.20)
 357   uint32_t      freq_min_lo;    //< low  32-bits of 64-bit fxpt_freq (Q44.20)
 358   uint32_t      freq_max_hi;    //< high 32-bits of 64-bit fxpt_freq (Q44.20)
 359   uint32_t      freq_max_lo;    //< low  32-bits of 64-bit fxpt_freq (Q44.20)
 360   uint16_t      gain_min;       //< min gain that can be set. fxpt_db (Q9.7)
 361   uint16_t      gain_max;       //< max gain that can be set. fxpt_db (Q9.7)
 362   uint16_t      gain_step_size; //< fxpt_db (Q9.7)
 363 } u2_db_info_t;
 364
 365
 366 /*!
 367  * \brief Reply to d'board info request
 368  */
 369 typedef struct {
 370   uint8_t       opcode;
 371   uint8_t       len;
 372   uint8_t       rid;
 373   uint8_t       ok;             // request was successful (bool)
 374
 375   u2_db_info_t  tx_db_info;
 376   u2_db_info_t  rx_db_info;
 377 } _AL4 op_dboard_info_reply_t;
 378
 379 /*!
 380  * \brief Read from Wishbone memory
 381  */
 382 typedef struct {
 383   uint8_t       opcode;
 384   uint8_t       len;
 385   uint8_t       rid;
 386   uint8_t       mbz;
 387   uint32_t      addr;
 388   uint32_t      bytes;
 389 } _AL4 op_peek_t;
 390
 391 /*
 392  * ================================================================
 393  *             union of all of subpacket types
 394  * ================================================================
 395  */
 396 typedef union {
 397
 398   op_generic_t                  op_generic;
 399   op_id_reply_t                 op_id_reply;
 400   op_start_rx_streaming_t       op_start_rx_streaming;
 401   op_burn_mac_addr_t            op_burn_mac_addr;
 402   op_read_time_reply_t          op_read_time_reply;
 403   op_config_rx_v2_t             op_config_rx_v2;
 404   op_config_rx_reply_v2_t       op_config_rx_reply_v2;
 405   op_config_tx_v2_t             op_config_tx_v2;
 406   op_config_tx_reply_v2_t       op_config_tx_reply_v2;
 407   op_config_mimo_t              op_config_mimo;
 408   op_peek_t                     op_peek;
 409
 410 } u2_subpkt_t;
 411
 412
 413 __U2_END_DECLS
 414
 415 #endif /* INCLUDED_USRP2_ETH_PACKET_H */