1/*- 2 * Copyright (c) 1995, David Greenman 3 * Copyright (c) 2001 Jonathan Lemon <jlemon@freebsd.org> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice unmodified, this list of conditions, and the following 11 * disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD: stable/11/sys/dev/fxp/if_fxpreg.h 345186 2019-03-15 15:16:31Z markj $ 29 */ 30 31#define FXP_PCI_MMBA 0x10 32#define FXP_PCI_IOBA 0x14 33 34/* 35 * Control/status registers. 36 */ 37#define FXP_CSR_SCB_RUSCUS 0 /* scb_rus/scb_cus (1 byte) */ 38#define FXP_CSR_SCB_STATACK 1 /* scb_statack (1 byte) */ 39#define FXP_CSR_SCB_COMMAND 2 /* scb_command (1 byte) */ 40#define FXP_CSR_SCB_INTRCNTL 3 /* scb_intrcntl (1 byte) */ 41#define FXP_CSR_SCB_GENERAL 4 /* scb_general (4 bytes) */ 42#define FXP_CSR_PORT 8 /* port (4 bytes) */ 43#define FXP_CSR_FLASHCONTROL 12 /* flash control (2 bytes) */ 44#define FXP_CSR_EEPROMCONTROL 14 /* eeprom control (2 bytes) */ 45#define FXP_CSR_MDICONTROL 16 /* mdi control (4 bytes) */ 46#define FXP_CSR_FC_THRESH 0x19 /* flow control (1 byte) */ 47#define FXP_CSR_FC_STATUS 0x1A /* flow control status (1 byte) */ 48#define FXP_CSR_PMDR 0x1B /* power management driver (1 byte) */ 49#define FXP_CSR_GENCONTROL 0x1C /* general control (1 byte) */ 50 51/* 52 * FOR REFERENCE ONLY, the old definition of FXP_CSR_SCB_RUSCUS: 53 * 54 * volatile uint8_t :2, 55 * scb_rus:4, 56 * scb_cus:2; 57 */ 58 59#define FXP_PORT_SOFTWARE_RESET 0 60#define FXP_PORT_SELFTEST 1 61#define FXP_PORT_SELECTIVE_RESET 2 62#define FXP_PORT_DUMP 3 63 64#define FXP_SCB_RUS_IDLE 0 65#define FXP_SCB_RUS_SUSPENDED 1 66#define FXP_SCB_RUS_NORESOURCES 2 67#define FXP_SCB_RUS_READY 4 68#define FXP_SCB_RUS_SUSP_NORBDS 9 69#define FXP_SCB_RUS_NORES_NORBDS 10 70#define FXP_SCB_RUS_READY_NORBDS 12 71 72#define FXP_SCB_CUS_IDLE 0 73#define FXP_SCB_CUS_SUSPENDED 1 74#define FXP_SCB_CUS_ACTIVE 2 75 76#define FXP_SCB_INTR_DISABLE 0x01 /* Disable all interrupts */ 77#define FXP_SCB_INTR_SWI 0x02 /* Generate SWI */ 78#define FXP_SCB_INTMASK_FCP 0x04 79#define FXP_SCB_INTMASK_ER 0x08 80#define FXP_SCB_INTMASK_RNR 0x10 81#define FXP_SCB_INTMASK_CNA 0x20 82#define FXP_SCB_INTMASK_FR 0x40 83#define FXP_SCB_INTMASK_CXTNO 0x80 84 85#define FXP_SCB_STATACK_FCP 0x01 /* Flow Control Pause */ 86#define FXP_SCB_STATACK_ER 0x02 /* Early Receive */ 87#define FXP_SCB_STATACK_SWI 0x04 88#define FXP_SCB_STATACK_MDI 0x08 89#define FXP_SCB_STATACK_RNR 0x10 90#define FXP_SCB_STATACK_CNA 0x20 91#define FXP_SCB_STATACK_FR 0x40 92#define FXP_SCB_STATACK_CXTNO 0x80 93 94#define FXP_SCB_COMMAND_CU_NOP 0x00 95#define FXP_SCB_COMMAND_CU_START 0x10 96#define FXP_SCB_COMMAND_CU_RESUME 0x20 97#define FXP_SCB_COMMAND_CU_DUMP_ADR 0x40 98#define FXP_SCB_COMMAND_CU_DUMP 0x50 99#define FXP_SCB_COMMAND_CU_BASE 0x60 100#define FXP_SCB_COMMAND_CU_DUMPRESET 0x70 101 102#define FXP_SCB_COMMAND_RU_NOP 0 103#define FXP_SCB_COMMAND_RU_START 1 104#define FXP_SCB_COMMAND_RU_RESUME 2 105#define FXP_SCB_COMMAND_RU_ABORT 4 106#define FXP_SCB_COMMAND_RU_LOADHDS 5 107#define FXP_SCB_COMMAND_RU_BASE 6 108#define FXP_SCB_COMMAND_RU_RBDRESUME 7 109 110/* 111 * Command block definitions 112 */ 113struct fxp_cb_nop { 114 uint16_t cb_status; 115 uint16_t cb_command; 116 uint32_t link_addr; 117}; 118struct fxp_cb_ias { 119 uint16_t cb_status; 120 uint16_t cb_command; 121 uint32_t link_addr; 122 uint8_t macaddr[6]; 123}; 124 125/* I hate bit-fields :-( */ 126#if BYTE_ORDER == LITTLE_ENDIAN 127#define __FXP_BITFIELD2(a, b) a, b 128#define __FXP_BITFIELD3(a, b, c) a, b, c 129#define __FXP_BITFIELD4(a, b, c, d) a, b, c, d 130#define __FXP_BITFIELD5(a, b, c, d, e) a, b, c, d, e 131#define __FXP_BITFIELD6(a, b, c, d, e, f) a, b, c, d, e, f 132#define __FXP_BITFIELD7(a, b, c, d, e, f, g) a, b, c, d, e, f, g 133#define __FXP_BITFIELD8(a, b, c, d, e, f, g, h) a, b, c, d, e, f, g, h 134#else 135#define __FXP_BITFIELD2(a, b) b, a 136#define __FXP_BITFIELD3(a, b, c) c, b, a 137#define __FXP_BITFIELD4(a, b, c, d) d, c, b, a 138#define __FXP_BITFIELD5(a, b, c, d, e) e, d, c, b, a 139#define __FXP_BITFIELD6(a, b, c, d, e, f) f, e, d, c, b, a 140#define __FXP_BITFIELD7(a, b, c, d, e, f, g) g, f, e, d, c, b, a 141#define __FXP_BITFIELD8(a, b, c, d, e, f, g, h) h, g, f, e, d, c, b, a 142#endif 143 144struct fxp_cb_config { 145 uint16_t cb_status; 146 uint16_t cb_command; 147 uint32_t link_addr; 148 149 /* Bytes 0 - 21 -- common to all i8255x */ 150 u_int __FXP_BITFIELD2(byte_count:6, :2); 151 u_int __FXP_BITFIELD3(rx_fifo_limit:4, tx_fifo_limit:3, :1); 152 uint8_t adaptive_ifs; 153 u_int __FXP_BITFIELD5(mwi_enable:1, /* 8,9 */ 154 type_enable:1, /* 8,9 */ 155 read_align_en:1, /* 8,9 */ 156 end_wr_on_cl:1, /* 8,9 */ 157 :4); 158 u_int __FXP_BITFIELD2(rx_dma_bytecount:7, :1); 159 u_int __FXP_BITFIELD2(tx_dma_bytecount:7, dma_mbce:1); 160 u_int __FXP_BITFIELD8(late_scb:1, /* 7 */ 161 direct_dma_dis:1, /* 8,9 */ 162 tno_int_or_tco_en:1, /* 7,9 */ 163 ci_int:1, 164 ext_txcb_dis:1, /* 8,9 */ 165 ext_stats_dis:1, /* 8,9 */ 166 keep_overrun_rx:1, 167 save_bf:1); 168 u_int __FXP_BITFIELD6(disc_short_rx:1, 169 underrun_retry:2, 170 :2, 171 ext_rfa:1, /* 550 */ 172 two_frames:1, /* 8,9 */ 173 dyn_tbd:1); /* 8,9 */ 174 u_int __FXP_BITFIELD3(mediatype:1, /* 7 */ 175 :6, 176 csma_dis:1); /* 8,9 */ 177 u_int __FXP_BITFIELD6(tcp_udp_cksum:1, /* 9 */ 178 :3, 179 vlan_tco:1, /* 8,9 */ 180 link_wake_en:1, /* 8,9 */ 181 arp_wake_en:1, /* 8 */ 182 mc_wake_en:1); /* 8 */ 183 u_int __FXP_BITFIELD4(:3, 184 nsai:1, 185 preamble_length:2, 186 loopback:2); 187 u_int __FXP_BITFIELD2(linear_priority:3, /* 7 */ 188 :5); 189 u_int __FXP_BITFIELD3(linear_pri_mode:1, /* 7 */ 190 :3, 191 interfrm_spacing:4); 192 u_int :8; 193 u_int :8; 194 u_int __FXP_BITFIELD8(promiscuous:1, 195 bcast_disable:1, 196 wait_after_win:1, /* 8,9 */ 197 :1, 198 ignore_ul:1, /* 8,9 */ 199 crc16_en:1, /* 9 */ 200 :1, 201 crscdt:1); 202 u_int fc_delay_lsb:8; /* 8,9 */ 203 u_int fc_delay_msb:8; /* 8,9 */ 204 u_int __FXP_BITFIELD6(stripping:1, 205 padding:1, 206 rcv_crc_xfer:1, 207 long_rx_en:1, /* 8,9 */ 208 pri_fc_thresh:3, /* 8,9 */ 209 :1); 210 u_int __FXP_BITFIELD8(ia_wake_en:1, /* 8 */ 211 magic_pkt_dis:1, /* 8,9,!9ER */ 212 tx_fc_dis:1, /* 8,9 */ 213 rx_fc_restop:1, /* 8,9 */ 214 rx_fc_restart:1, /* 8,9 */ 215 fc_filter:1, /* 8,9 */ 216 force_fdx:1, 217 fdx_pin_en:1); 218 u_int __FXP_BITFIELD4(:5, 219 pri_fc_loc:1, /* 8,9 */ 220 multi_ia:1, 221 :1); 222 u_int __FXP_BITFIELD3(:3, mc_all:1, :4); 223 224 /* Bytes 22 - 31 -- i82550 only */ 225 u_int __FXP_BITFIELD3(gamla_rx:1, 226 vlan_strip_en:1, 227 :6); 228 uint8_t pad[9]; 229}; 230 231#define MAXMCADDR 80 232struct fxp_cb_mcs { 233 uint16_t cb_status; 234 uint16_t cb_command; 235 uint32_t link_addr; 236 uint16_t mc_cnt; 237 uint8_t mc_addr[MAXMCADDR][6]; 238}; 239 240#define MAXUCODESIZE 192 241struct fxp_cb_ucode { 242 uint16_t cb_status; 243 uint16_t cb_command; 244 uint32_t link_addr; 245 uint32_t ucode[MAXUCODESIZE]; 246}; 247 248/* 249 * Number of DMA segments in a TxCB. 250 */ 251#define FXP_NTXSEG 35 252 253struct fxp_tbd { 254 uint32_t tb_addr; 255 uint32_t tb_size; 256}; 257 258struct fxp_ipcb { 259 /* 260 * The following fields are valid only when 261 * using the IPCB command block for TX checksum offload 262 * (and TCP large send, VLANs, and (I think) IPsec). To use 263 * them, you must enable extended TxCBs (available only 264 * on the 82559 and later) and use the IPCBXMIT command. 265 * Note that Intel defines the IPCB to be 32 bytes long, 266 * the last 8 bytes of which comprise the first entry 267 * in the TBD array (see note below). This means we only 268 * have to define 8 extra bytes here. 269 */ 270 uint16_t ipcb_schedule_low; 271 uint8_t ipcb_ip_schedule; 272 uint8_t ipcb_ip_activation_high; 273 uint16_t ipcb_vlan_id; 274 uint8_t ipcb_ip_header_offset; 275 uint8_t ipcb_tcp_header_offset; 276}; 277 278struct fxp_cb_tx { 279 uint16_t cb_status; 280 uint16_t cb_command; 281 uint32_t link_addr; 282 union { 283 struct { 284 uint32_t tbd_array_addr; 285 uint16_t byte_count; 286 uint8_t tx_threshold; 287 uint8_t tbd_number; 288 }; 289 struct fxp_tbd tbdtso; 290 }; 291 292 /* 293 * The following structure isn't actually part of the TxCB, 294 * unless the extended TxCB feature is being used. In this 295 * case, the first two elements of the structure below are 296 * fetched along with the TxCB. 297 */ 298 union { 299 struct fxp_ipcb ipcb; 300 struct fxp_tbd tbd[FXP_NTXSEG + 1]; 301 } tx_cb_u; 302}; 303 304#define tbd tx_cb_u.tbd 305#define ipcb_schedule_low tx_cb_u.ipcb.ipcb_schedule_low 306#define ipcb_ip_schedule tx_cb_u.ipcb.ipcb_ip_schedule 307#define ipcb_ip_activation_high tx_cb_u.ipcb.ipcb_ip_activation_high 308#define ipcb_vlan_id tx_cb_u.ipcb.ipcb_vlan_id 309#define ipcb_ip_header_offset tx_cb_u.ipcb.ipcb_ip_header_offset 310#define ipcb_tcp_header_offset tx_cb_u.ipcb.ipcb_tcp_header_offset 311 312/* 313 * IPCB field definitions 314 */ 315#define FXP_IPCB_IP_CHECKSUM_ENABLE 0x10 316#define FXP_IPCB_TCPUDP_CHECKSUM_ENABLE 0x20 317#define FXP_IPCB_TCP_PACKET 0x40 318#define FXP_IPCB_LARGESEND_ENABLE 0x80 319#define FXP_IPCB_HARDWAREPARSING_ENABLE 0x01 320#define FXP_IPCB_INSERTVLAN_ENABLE 0x02 321 322/* 323 * Control Block (CB) definitions 324 */ 325 326/* status */ 327#define FXP_CB_STATUS_OK 0x2000 328#define FXP_CB_STATUS_C 0x8000 329/* commands */ 330#define FXP_CB_COMMAND_NOP 0x0 331#define FXP_CB_COMMAND_IAS 0x1 332#define FXP_CB_COMMAND_CONFIG 0x2 333#define FXP_CB_COMMAND_MCAS 0x3 334#define FXP_CB_COMMAND_XMIT 0x4 335#define FXP_CB_COMMAND_UCODE 0x5 336#define FXP_CB_COMMAND_DUMP 0x6 337#define FXP_CB_COMMAND_DIAG 0x7 338#define FXP_CB_COMMAND_LOADFILT 0x8 339#define FXP_CB_COMMAND_IPCBXMIT 0x9 340 341/* command flags */ 342#define FXP_CB_COMMAND_SF 0x0008 /* simple/flexible mode */ 343#define FXP_CB_COMMAND_I 0x2000 /* generate interrupt on completion */ 344#define FXP_CB_COMMAND_S 0x4000 /* suspend on completion */ 345#define FXP_CB_COMMAND_EL 0x8000 /* end of list */ 346 347/* 348 * RFA definitions 349 */ 350 351struct fxp_rfa { 352 uint16_t rfa_status; 353 uint16_t rfa_control; 354 uint32_t link_addr; 355 uint32_t rbd_addr; 356 uint16_t actual_size; 357 uint16_t size; 358 359 /* 360 * The following fields are only available when using 361 * extended receive mode on an 82550/82551 chipset. 362 */ 363 uint16_t rfax_vlan_id; 364 uint8_t rfax_rx_parser_sts; 365 uint8_t rfax_rsvd0; 366 uint16_t rfax_security_sts; 367 uint8_t rfax_csum_sts; 368 uint8_t rfax_zerocopy_sts; 369 uint8_t rfax_pad[8]; 370} __packed; 371#define FXP_RFAX_LEN 16 372 373#define FXP_RFA_STATUS_RCOL 0x0001 /* receive collision */ 374#define FXP_RFA_STATUS_IAMATCH 0x0002 /* 0 = matches station address */ 375#define FXP_RFA_STATUS_NOAMATCH 0x0004 /* 1 = doesn't match anything */ 376#define FXP_RFA_STATUS_PARSE 0x0008 /* pkt parse ok (82550/1 only) */ 377#define FXP_RFA_STATUS_S4 0x0010 /* receive error from PHY */ 378#define FXP_RFA_STATUS_TL 0x0020 /* type/length */ 379#define FXP_RFA_STATUS_FTS 0x0080 /* frame too short */ 380#define FXP_RFA_STATUS_OVERRUN 0x0100 /* DMA overrun */ 381#define FXP_RFA_STATUS_RNR 0x0200 /* no resources */ 382#define FXP_RFA_STATUS_ALIGN 0x0400 /* alignment error */ 383#define FXP_RFA_STATUS_CRC 0x0800 /* CRC error */ 384#define FXP_RFA_STATUS_VLAN 0x1000 /* VLAN tagged frame */ 385#define FXP_RFA_STATUS_OK 0x2000 /* packet received okay */ 386#define FXP_RFA_STATUS_C 0x8000 /* packet reception complete */ 387#define FXP_RFA_CONTROL_SF 0x08 /* simple/flexible memory mode */ 388#define FXP_RFA_CONTROL_H 0x10 /* header RFD */ 389#define FXP_RFA_CONTROL_S 0x4000 /* suspend after reception */ 390#define FXP_RFA_CONTROL_EL 0x8000 /* end of list */ 391 392/* Bits in the 'csum_sts' byte */ 393#define FXP_RFDX_CS_TCPUDP_CSUM_BIT_VALID 0x10 394#define FXP_RFDX_CS_TCPUDP_CSUM_VALID 0x20 395#define FXP_RFDX_CS_IP_CSUM_BIT_VALID 0x01 396#define FXP_RFDX_CS_IP_CSUM_VALID 0x02 397 398/* Bits in the 'packet parser' byte */ 399#define FXP_RFDX_P_PARSE_BIT 0x08 400#define FXP_RFDX_P_CSUM_PROTOCOL_MASK 0x03 401#define FXP_RFDX_P_TCP_PACKET 0x00 402#define FXP_RFDX_P_UDP_PACKET 0x01 403#define FXP_RFDX_P_IP_PACKET 0x03 404 405/* 406 * Statistics dump area definitions 407 */ 408struct fxp_stats { 409 uint32_t tx_good; 410 uint32_t tx_maxcols; 411 uint32_t tx_latecols; 412 uint32_t tx_underruns; 413 uint32_t tx_lostcrs; 414 uint32_t tx_deffered; 415 uint32_t tx_single_collisions; 416 uint32_t tx_multiple_collisions; 417 uint32_t tx_total_collisions; 418 uint32_t rx_good; 419 uint32_t rx_crc_errors; 420 uint32_t rx_alignment_errors; 421 uint32_t rx_rnr_errors; 422 uint32_t rx_overrun_errors; 423 uint32_t rx_cdt_errors; 424 uint32_t rx_shortframes; 425 uint32_t tx_pause; 426 uint32_t rx_pause; 427 uint32_t rx_controls; 428 uint16_t tx_tco; 429 uint16_t rx_tco; 430 uint32_t completion_status; 431 uint32_t reserved0; 432 uint32_t reserved1; 433 uint32_t reserved2; 434}; 435#define FXP_STATS_DUMP_COMPLETE 0xa005 436#define FXP_STATS_DR_COMPLETE 0xa007 437 438/* 439 * Serial EEPROM control register bits 440 */ 441#define FXP_EEPROM_EESK 0x01 /* shift clock */ 442#define FXP_EEPROM_EECS 0x02 /* chip select */ 443#define FXP_EEPROM_EEDI 0x04 /* data in */ 444#define FXP_EEPROM_EEDO 0x08 /* data out */ 445 446/* 447 * Serial EEPROM opcodes, including start bit 448 */ 449#define FXP_EEPROM_OPC_ERASE 0x4 450#define FXP_EEPROM_OPC_WRITE 0x5 451#define FXP_EEPROM_OPC_READ 0x6 452 453/* 454 * EEPROM map 455 */ 456#define FXP_EEPROM_MAP_IA0 0x00 /* Station address */ 457#define FXP_EEPROM_MAP_IA1 0x01 458#define FXP_EEPROM_MAP_IA2 0x02 459#define FXP_EEPROM_MAP_COMPAT 0x03 /* Compatibility */ 460#define FXP_EEPROM_MAP_CNTR 0x05 /* Controller/connector type */ 461#define FXP_EEPROM_MAP_PRI_PHY 0x06 /* Primary PHY record */ 462#define FXP_EEPROM_MAP_SEC_PHY 0x07 /* Secondary PHY record */ 463#define FXP_EEPROM_MAP_PWA0 0x08 /* Printed wire assembly num. */ 464#define FXP_EEPROM_MAP_PWA1 0x09 /* Printed wire assembly num. */ 465#define FXP_EEPROM_MAP_ID 0x0A /* EEPROM ID */ 466#define FXP_EEPROM_MAP_SUBSYS 0x0B /* Subsystem ID */ 467#define FXP_EEPROM_MAP_SUBVEN 0x0C /* Subsystem vendor ID */ 468#define FXP_EEPROM_MAP_CKSUM64 0x3F /* 64-word EEPROM checksum */ 469#define FXP_EEPROM_MAP_CKSUM256 0xFF /* 256-word EEPROM checksum */ 470 471/* 472 * Management Data Interface opcodes 473 */ 474#define FXP_MDI_WRITE 0x1 475#define FXP_MDI_READ 0x2 476 477/* 478 * PHY device types 479 */ 480#define FXP_PHY_DEVICE_MASK 0x3f00 481#define FXP_PHY_SERIAL_ONLY 0x8000 482#define FXP_PHY_NONE 0 483#define FXP_PHY_82553A 1 484#define FXP_PHY_82553C 2 485#define FXP_PHY_82503 3 486#define FXP_PHY_DP83840 4 487#define FXP_PHY_80C240 5 488#define FXP_PHY_80C24 6 489#define FXP_PHY_82555 7 490#define FXP_PHY_DP83840A 10 491#define FXP_PHY_82555B 11 492 493/* 494 * Chip revision values. 495 */ 496#define FXP_REV_82557 1 /* catchall 82557 chip type */ 497#define FXP_REV_82558_A4 4 /* 82558 A4 stepping */ 498#define FXP_REV_82558_B0 5 /* 82558 B0 stepping */ 499#define FXP_REV_82559_A0 8 /* 82559 A0 stepping */ 500#define FXP_REV_82559S_A 9 /* 82559S A stepping */ 501#define FXP_REV_82550 12 502#define FXP_REV_82550_C 13 /* 82550 C stepping */ 503#define FXP_REV_82551_E 14 /* 82551 */ 504#define FXP_REV_82551_F 15 /* 82551 */ 505#define FXP_REV_82551_10 16 /* 82551 */ 506