qemu/roms/ipxe/src/drivers/net/phantom/phantom_hw.h

   1 #ifndef _PHANTOM_HW_H
   2 #define _PHANTOM_HW_H
   3
   4 /*
   5  * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
   6  * Copyright (C) 2008 NetXen, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License, or any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301, USA.
  22  */
  23
  24 FILE_LICENCE ( GPL2_OR_LATER );
  25
  26 /**
  27  * @file
  28  *
  29  * Phantom hardware definitions
  30  *
  31  */
  32
  33 /** A Phantom RX descriptor */
  34 struct phantom_rds_pb {
  35         pseudo_bit_t handle[16];                /**< Reference handle */
  36         pseudo_bit_t flags[16];                 /**< Flags */
  37         pseudo_bit_t length[32];                /**< Buffer length */
  38
  39         /* --------------------------------------------------------------- */
  40
  41         pseudo_bit_t dma_addr[64];              /**< Buffer DMA address */
  42
  43 };
  44
  45 /** A Phantom RX status descriptor */
  46 struct phantom_sds_pb {
  47         pseudo_bit_t port[4];                   /**< Port number */
  48         pseudo_bit_t status[4];                 /**< Checksum status */
  49         pseudo_bit_t type[4];                   /**< Type */
  50         pseudo_bit_t total_length[16];          /**< Total packet length */
  51         pseudo_bit_t handle[16];                /**< Reference handle */
  52         pseudo_bit_t protocol[4];               /**< Protocol */
  53         pseudo_bit_t pkt_offset[5];             /**< Offset to packet start */
  54         pseudo_bit_t desc_cnt[3];               /**< Descriptor count */
  55         pseudo_bit_t owner[2];                  /**< Owner */
  56         pseudo_bit_t opcode[6];                 /**< Opcode */
  57
  58         /* --------------------------------------------------------------- */
  59
  60         pseudo_bit_t hash_value[32];            /**< RSS hash value */
  61         pseudo_bit_t hash_type[8];              /**< RSS hash type */
  62         pseudo_bit_t lro[8];                    /**< LRO data */
  63 };
  64
  65 /** Phantom RX status opcodes */
  66 enum phantom_sds_opcode {
  67         UNM_SYN_OFFLOAD = 0x03,
  68         UNM_RXPKT_DESC = 0x04,
  69 };
  70
  71 /** A Phantom TX descriptor */
  72 struct phantom_tx_cds_pb {
  73         pseudo_bit_t tcp_hdr_offset[8];         /**< TCP header offset (LSO) */
  74         pseudo_bit_t ip_hdr_offset[8];          /**< IP header offset (LSO) */
  75         pseudo_bit_t flags[7];                  /**< Flags */
  76         pseudo_bit_t opcode[6];                 /**< Opcode */
  77         pseudo_bit_t hw_rsvd_0[3];              /**< (Reserved) */
  78         pseudo_bit_t num_buffers[8];            /**< Total number of buffers */
  79         pseudo_bit_t length[24];                /**< Total length */
  80
  81         /* --------------------------------------------------------------- */
  82
  83         pseudo_bit_t buffer2_dma_addr[64];      /**< Buffer 2 DMA address */
  84
  85         /* --------------------------------------------------------------- */
  86
  87         pseudo_bit_t handle[16];                /**< Reference handle (n/a) */
  88         pseudo_bit_t port_mss[16];              /**< TCP MSS (LSO) */
  89         pseudo_bit_t port[4];                   /**< Port */
  90         pseudo_bit_t context_id[4];             /**< Context ID */
  91         pseudo_bit_t total_hdr_length[8];       /**< MAC+IP+TCP header (LSO) */
  92         pseudo_bit_t conn_id[16];               /**< IPSec connection ID */
  93
  94         /* --------------------------------------------------------------- */
  95
  96         pseudo_bit_t buffer3_dma_addr[64];      /**< Buffer 3 DMA address */
  97
  98         /* --------------------------------------------------------------- */
  99
 100         pseudo_bit_t buffer1_dma_addr[64];      /**< Buffer 1 DMA address */
 101
 102         /* --------------------------------------------------------------- */
 103
 104         pseudo_bit_t buffer1_length[16];        /**< Buffer 1 length */
 105         pseudo_bit_t buffer2_length[16];        /**< Buffer 2 length */
 106         pseudo_bit_t buffer3_length[16];        /**< Buffer 3 length */
 107         pseudo_bit_t buffer4_length[16];        /**< Buffer 4 length */
 108
 109         /* --------------------------------------------------------------- */
 110
 111         pseudo_bit_t buffer4_dma_addr[64];      /**< Buffer 4 DMA address */
 112
 113         /* --------------------------------------------------------------- */
 114
 115         pseudo_bit_t hw_rsvd_1[64];             /**< (Reserved) */
 116 };
 117
 118 /** A Phantom MAC address request body */
 119 struct phantom_nic_request_body_mac_request_pb {
 120         pseudo_bit_t opcode[8];                 /**< Opcode */
 121         pseudo_bit_t tag[8];                    /**< Tag */
 122         pseudo_bit_t mac_addr_0[8];             /**< MAC address byte 0 */
 123         pseudo_bit_t mac_addr_1[8];             /**< MAC address byte 1 */
 124         pseudo_bit_t mac_addr_2[8];             /**< MAC address byte 2 */
 125         pseudo_bit_t mac_addr_3[8];             /**< MAC address byte 3 */
 126         pseudo_bit_t mac_addr_4[8];             /**< MAC address byte 4 */
 127         pseudo_bit_t mac_addr_5[8];             /**< MAC address byte 5 */
 128 };
 129
 130 /** Phantom MAC request opcodes */
 131 enum phantom_mac_request_opcode {
 132         UNM_MAC_ADD = 0x01,                     /**< Add MAC address */
 133         UNM_MAC_DEL = 0x02,                     /**< Delete MAC address */
 134 };
 135
 136 /** A Phantom NIC request command descriptor */
 137 struct phantom_nic_request_cds_pb {
 138         struct {
 139                 pseudo_bit_t dst_minor[18];
 140                 pseudo_bit_t dst_subq[1];
 141                 pseudo_bit_t dst_major[4];
 142                 pseudo_bit_t opcode[6];
 143                 pseudo_bit_t hw_rsvd_0[3];
 144                 pseudo_bit_t msginfo[24];
 145                 pseudo_bit_t hw_rsvd_1[2];
 146                 pseudo_bit_t qmsg_type[6];
 147         } common;
 148
 149         /* --------------------------------------------------------------- */
 150
 151         struct {
 152                 pseudo_bit_t opcode[8];
 153                 pseudo_bit_t comp_id [8];
 154                 pseudo_bit_t context_id[16];
 155                 pseudo_bit_t need_completion[1];
 156                 pseudo_bit_t hw_rsvd_0[23];
 157                 pseudo_bit_t sub_opcode[8];
 158         } header;
 159
 160         /* --------------------------------------------------------------- */
 161
 162         union {
 163                 struct phantom_nic_request_body_mac_request_pb mac_request;
 164                 pseudo_bit_t padding[384];
 165         } body;
 166 };
 167
 168 /** Phantom NIC request opcodes */
 169 enum phantom_nic_request_opcode {
 170         UNM_MAC_EVENT = 0x01,                   /**< Add/delete MAC address */
 171 };
 172
 173 /** A Phantom command descriptor */
 174 union phantom_cds_pb {
 175         struct phantom_tx_cds_pb tx;
 176         struct phantom_nic_request_cds_pb nic_request;
 177 };
 178
 179 /** Phantom command descriptor opcodes */
 180 enum phantom_cds_opcode {
 181         UNM_TX_ETHER_PKT = 0x01,                /**< Transmit raw Ethernet */
 182         UNM_NIC_REQUEST = 0x14,                 /**< NIC request */
 183 };
 184
 185 #endif /* _PHANTOM_HW_H */