1 /* 2 * Copyright (C) 2005 - 2013 Emulex 3 * All rights reserved. 4 * 5 * This program is free software; you can redistribute it and/or 6 * modify it under the terms of the GNU General Public License version 2 7 * as published by the Free Software Foundation. The full GNU General 8 * Public License is included in this distribution in the file called COPYING. 9 * 10 * Contact Information: 11 * linux-drivers@emulex.com 12 * 13 * Emulex 14 * 3333 Susan Street 15 * Costa Mesa, CA 92626 16 */ 17 18 /********* Mailbox door bell *************/ 19 /* Used for driver communication with the FW. 20 * The software must write this register twice to post any command. First, 21 * it writes the register with hi=1 and the upper bits of the physical address 22 * for the MAILBOX structure. Software must poll the ready bit until this 23 * is acknowledged. Then, sotware writes the register with hi=0 with the lower 24 * bits in the address. It must poll the ready bit until the command is 25 * complete. Upon completion, the MAILBOX will contain a valid completion 26 * queue entry. 27 */ 28 #define MPU_MAILBOX_DB_OFFSET 0x160 29 #define MPU_MAILBOX_DB_RDY_MASK 0x1 /* bit 0 */ 30 #define MPU_MAILBOX_DB_HI_MASK 0x2 /* bit 1 */ 31 32 #define MPU_EP_CONTROL 0 33 34 /********** MPU semphore: used for SH & BE *************/ 35 #define SLIPORT_SEMAPHORE_OFFSET_BEx 0xac /* CSR BAR offset */ 36 #define SLIPORT_SEMAPHORE_OFFSET_SH 0x94 /* PCI-CFG offset */ 37 #define POST_STAGE_MASK 0x0000FFFF 38 #define POST_ERR_MASK 0x1 39 #define POST_ERR_SHIFT 31 40 41 /* MPU semphore POST stage values */ 42 #define POST_STAGE_AWAITING_HOST_RDY 0x1 /* FW awaiting goahead from host */ 43 #define POST_STAGE_HOST_RDY 0x2 /* Host has given go-ahed to FW */ 44 #define POST_STAGE_BE_RESET 0x3 /* Host wants to reset chip */ 45 #define POST_STAGE_ARMFW_RDY 0xc000 /* FW is done with POST */ 46 47 48 /* Lancer SLIPORT registers */ 49 #define SLIPORT_STATUS_OFFSET 0x404 50 #define SLIPORT_CONTROL_OFFSET 0x408 51 #define SLIPORT_ERROR1_OFFSET 0x40C 52 #define SLIPORT_ERROR2_OFFSET 0x410 53 #define PHYSDEV_CONTROL_OFFSET 0x414 54 55 #define SLIPORT_STATUS_ERR_MASK 0x80000000 56 #define SLIPORT_STATUS_RN_MASK 0x01000000 57 #define SLIPORT_STATUS_RDY_MASK 0x00800000 58 #define SLI_PORT_CONTROL_IP_MASK 0x08000000 59 #define PHYSDEV_CONTROL_FW_RESET_MASK 0x00000002 60 #define PHYSDEV_CONTROL_INP_MASK 0x40000000 61 62 #define SLIPORT_ERROR_NO_RESOURCE1 0x2 63 #define SLIPORT_ERROR_NO_RESOURCE2 0x9 64 65 /********* Memory BAR register ************/ 66 #define PCICFG_MEMBAR_CTRL_INT_CTRL_OFFSET 0xfc 67 /* Host Interrupt Enable, if set interrupts are enabled although "PCI Interrupt 68 * Disable" may still globally block interrupts in addition to individual 69 * interrupt masks; a mechanism for the device driver to block all interrupts 70 * atomically without having to arbitrate for the PCI Interrupt Disable bit 71 * with the OS. 72 */ 73 #define MEMBAR_CTRL_INT_CTRL_HOSTINTR_MASK (1 << 29) /* bit 29 */ 74 75 /********* PCI Function Capability *********/ 76 #define BE_FUNCTION_CAPS_RSS 0x2 77 #define BE_FUNCTION_CAPS_SUPER_NIC 0x40 78 79 /********* Power management (WOL) **********/ 80 #define PCICFG_PM_CONTROL_OFFSET 0x44 81 #define PCICFG_PM_CONTROL_MASK 0x108 /* bits 3 & 8 */ 82 83 /********* Online Control Registers *******/ 84 #define PCICFG_ONLINE0 0xB0 85 #define PCICFG_ONLINE1 0xB4 86 87 /********* UE Status and Mask Registers ***/ 88 #define PCICFG_UE_STATUS_LOW 0xA0 89 #define PCICFG_UE_STATUS_HIGH 0xA4 90 #define PCICFG_UE_STATUS_LOW_MASK 0xA8 91 #define PCICFG_UE_STATUS_HI_MASK 0xAC 92 93 /******** SLI_INTF ***********************/ 94 #define SLI_INTF_REG_OFFSET 0x58 95 #define SLI_INTF_VALID_MASK 0xE0000000 96 #define SLI_INTF_VALID 0xC0000000 97 #define SLI_INTF_HINT2_MASK 0x1F000000 98 #define SLI_INTF_HINT2_SHIFT 24 99 #define SLI_INTF_HINT1_MASK 0x00FF0000 100 #define SLI_INTF_HINT1_SHIFT 16 101 #define SLI_INTF_FAMILY_MASK 0x00000F00 102 #define SLI_INTF_FAMILY_SHIFT 8 103 #define SLI_INTF_IF_TYPE_MASK 0x0000F000 104 #define SLI_INTF_IF_TYPE_SHIFT 12 105 #define SLI_INTF_REV_MASK 0x000000F0 106 #define SLI_INTF_REV_SHIFT 4 107 #define SLI_INTF_FT_MASK 0x00000001 108 109 #define SLI_INTF_TYPE_2 2 110 #define SLI_INTF_TYPE_3 3 111 112 /********* ISR0 Register offset **********/ 113 #define CEV_ISR0_OFFSET 0xC18 114 #define CEV_ISR_SIZE 4 115 116 /********* Event Q door bell *************/ 117 #define DB_EQ_OFFSET DB_CQ_OFFSET 118 #define DB_EQ_RING_ID_MASK 0x1FF /* bits 0 - 8 */ 119 #define DB_EQ_RING_ID_EXT_MASK 0x3e00 /* bits 9-13 */ 120 #define DB_EQ_RING_ID_EXT_MASK_SHIFT (2) /* qid bits 9-13 placing at 11-15 */ 121 122 /* Clear the interrupt for this eq */ 123 #define DB_EQ_CLR_SHIFT (9) /* bit 9 */ 124 /* Must be 1 */ 125 #define DB_EQ_EVNT_SHIFT (10) /* bit 10 */ 126 /* Number of event entries processed */ 127 #define DB_EQ_NUM_POPPED_SHIFT (16) /* bits 16 - 28 */ 128 /* Rearm bit */ 129 #define DB_EQ_REARM_SHIFT (29) /* bit 29 */ 130 131 /********* Compl Q door bell *************/ 132 #define DB_CQ_OFFSET 0x120 133 #define DB_CQ_RING_ID_MASK 0x3FF /* bits 0 - 9 */ 134 #define DB_CQ_RING_ID_EXT_MASK 0x7C00 /* bits 10-14 */ 135 #define DB_CQ_RING_ID_EXT_MASK_SHIFT (1) /* qid bits 10-14 136 placing at 11-15 */ 137 138 /* Number of event entries processed */ 139 #define DB_CQ_NUM_POPPED_SHIFT (16) /* bits 16 - 28 */ 140 /* Rearm bit */ 141 #define DB_CQ_REARM_SHIFT (29) /* bit 29 */ 142 143 /********** TX ULP door bell *************/ 144 #define DB_TXULP1_OFFSET 0x60 145 #define DB_TXULP_RING_ID_MASK 0x7FF /* bits 0 - 10 */ 146 /* Number of tx entries posted */ 147 #define DB_TXULP_NUM_POSTED_SHIFT (16) /* bits 16 - 29 */ 148 #define DB_TXULP_NUM_POSTED_MASK 0x3FFF /* bits 16 - 29 */ 149 150 /********** RQ(erx) door bell ************/ 151 #define DB_RQ_OFFSET 0x100 152 #define DB_RQ_RING_ID_MASK 0x3FF /* bits 0 - 9 */ 153 /* Number of rx frags posted */ 154 #define DB_RQ_NUM_POSTED_SHIFT (24) /* bits 24 - 31 */ 155 156 /********** MCC door bell ************/ 157 #define DB_MCCQ_OFFSET 0x140 158 #define DB_MCCQ_RING_ID_MASK 0x7FF /* bits 0 - 10 */ 159 /* Number of entries posted */ 160 #define DB_MCCQ_NUM_POSTED_SHIFT (16) /* bits 16 - 29 */ 161 162 /********** SRIOV VF PCICFG OFFSET ********/ 163 #define SRIOV_VF_PCICFG_OFFSET (4096) 164 165 /********** FAT TABLE ********/ 166 #define RETRIEVE_FAT 0 167 #define QUERY_FAT 1 168 169 /* Flashrom related descriptors */ 170 #define MAX_FLASH_COMP 32 171 #define IMAGE_TYPE_FIRMWARE 160 172 #define IMAGE_TYPE_BOOTCODE 224 173 #define IMAGE_TYPE_OPTIONROM 32 174 175 #define NUM_FLASHDIR_ENTRIES 32 176 177 #define OPTYPE_ISCSI_ACTIVE 0 178 #define OPTYPE_REDBOOT 1 179 #define OPTYPE_BIOS 2 180 #define OPTYPE_PXE_BIOS 3 181 #define OPTYPE_FCOE_BIOS 8 182 #define OPTYPE_ISCSI_BACKUP 9 183 #define OPTYPE_FCOE_FW_ACTIVE 10 184 #define OPTYPE_FCOE_FW_BACKUP 11 185 #define OPTYPE_NCSI_FW 13 186 #define OPTYPE_PHY_FW 99 187 #define TN_8022 13 188 189 #define ILLEGAL_IOCTL_REQ 2 190 #define FLASHROM_OPER_PHY_FLASH 9 191 #define FLASHROM_OPER_PHY_SAVE 10 192 #define FLASHROM_OPER_FLASH 1 193 #define FLASHROM_OPER_SAVE 2 194 #define FLASHROM_OPER_REPORT 4 195 196 #define FLASH_IMAGE_MAX_SIZE_g2 (1310720) /* Max firmware image size */ 197 #define FLASH_BIOS_IMAGE_MAX_SIZE_g2 (262144) /* Max OPTION ROM image sz */ 198 #define FLASH_REDBOOT_IMAGE_MAX_SIZE_g2 (262144) /* Max Redboot image sz */ 199 #define FLASH_IMAGE_MAX_SIZE_g3 (2097152) /* Max firmware image size */ 200 #define FLASH_BIOS_IMAGE_MAX_SIZE_g3 (524288) /* Max OPTION ROM image sz */ 201 #define FLASH_REDBOOT_IMAGE_MAX_SIZE_g3 (1048576) /* Max Redboot image sz */ 202 #define FLASH_NCSI_IMAGE_MAX_SIZE_g3 (262144) 203 #define FLASH_PHY_FW_IMAGE_MAX_SIZE_g3 262144 204 205 #define FLASH_NCSI_MAGIC (0x16032009) 206 #define FLASH_NCSI_DISABLED (0) 207 #define FLASH_NCSI_ENABLED (1) 208 209 #define FLASH_NCSI_BITFILE_HDR_OFFSET (0x600000) 210 211 /* Offsets for components on Flash. */ 212 #define FLASH_iSCSI_PRIMARY_IMAGE_START_g2 (1048576) 213 #define FLASH_iSCSI_BACKUP_IMAGE_START_g2 (2359296) 214 #define FLASH_FCoE_PRIMARY_IMAGE_START_g2 (3670016) 215 #define FLASH_FCoE_BACKUP_IMAGE_START_g2 (4980736) 216 #define FLASH_iSCSI_BIOS_START_g2 (7340032) 217 #define FLASH_PXE_BIOS_START_g2 (7864320) 218 #define FLASH_FCoE_BIOS_START_g2 (524288) 219 #define FLASH_REDBOOT_START_g2 (0) 220 221 #define FLASH_NCSI_START_g3 (15990784) 222 #define FLASH_iSCSI_PRIMARY_IMAGE_START_g3 (2097152) 223 #define FLASH_iSCSI_BACKUP_IMAGE_START_g3 (4194304) 224 #define FLASH_FCoE_PRIMARY_IMAGE_START_g3 (6291456) 225 #define FLASH_FCoE_BACKUP_IMAGE_START_g3 (8388608) 226 #define FLASH_iSCSI_BIOS_START_g3 (12582912) 227 #define FLASH_PXE_BIOS_START_g3 (13107200) 228 #define FLASH_FCoE_BIOS_START_g3 (13631488) 229 #define FLASH_REDBOOT_START_g3 (262144) 230 #define FLASH_PHY_FW_START_g3 1310720 231 232 #define IMAGE_NCSI 16 233 #define IMAGE_OPTION_ROM_PXE 32 234 #define IMAGE_OPTION_ROM_FCoE 33 235 #define IMAGE_OPTION_ROM_ISCSI 34 236 #define IMAGE_FLASHISM_JUMPVECTOR 48 237 #define IMAGE_FLASH_ISM 49 238 #define IMAGE_JUMP_VECTOR 50 239 #define IMAGE_FIRMWARE_iSCSI 160 240 #define IMAGE_FIRMWARE_COMP_iSCSI 161 241 #define IMAGE_FIRMWARE_FCoE 162 242 #define IMAGE_FIRMWARE_COMP_FCoE 163 243 #define IMAGE_FIRMWARE_BACKUP_iSCSI 176 244 #define IMAGE_FIRMWARE_BACKUP_COMP_iSCSI 177 245 #define IMAGE_FIRMWARE_BACKUP_FCoE 178 246 #define IMAGE_FIRMWARE_BACKUP_COMP_FCoE 179 247 #define IMAGE_FIRMWARE_PHY 192 248 #define IMAGE_BOOT_CODE 224 249 250 /************* Rx Packet Type Encoding **************/ 251 #define BE_UNICAST_PACKET 0 252 #define BE_MULTICAST_PACKET 1 253 #define BE_BROADCAST_PACKET 2 254 #define BE_RSVD_PACKET 3 255 256 /* 257 * BE descriptors: host memory data structures whose formats 258 * are hardwired in BE silicon. 259 */ 260 /* Event Queue Descriptor */ 261 #define EQ_ENTRY_VALID_MASK 0x1 /* bit 0 */ 262 #define EQ_ENTRY_RES_ID_MASK 0xFFFF /* bits 16 - 31 */ 263 #define EQ_ENTRY_RES_ID_SHIFT 16 264 265 struct be_eq_entry { 266 u32 evt; 267 }; 268 269 /* TX Queue Descriptor */ 270 #define ETH_WRB_FRAG_LEN_MASK 0xFFFF 271 struct be_eth_wrb { 272 u32 frag_pa_hi; /* dword 0 */ 273 u32 frag_pa_lo; /* dword 1 */ 274 u32 rsvd0; /* dword 2 */ 275 u32 frag_len; /* dword 3: bits 0 - 15 */ 276 } __packed; 277 278 /* Pseudo amap definition for eth_hdr_wrb in which each bit of the 279 * actual structure is defined as a byte : used to calculate 280 * offset/shift/mask of each field */ 281 struct amap_eth_hdr_wrb { 282 u8 rsvd0[32]; /* dword 0 */ 283 u8 rsvd1[32]; /* dword 1 */ 284 u8 complete; /* dword 2 */ 285 u8 event; 286 u8 crc; 287 u8 forward; 288 u8 lso6; 289 u8 mgmt; 290 u8 ipcs; 291 u8 udpcs; 292 u8 tcpcs; 293 u8 lso; 294 u8 vlan; 295 u8 gso[2]; 296 u8 num_wrb[5]; 297 u8 lso_mss[14]; 298 u8 len[16]; /* dword 3 */ 299 u8 vlan_tag[16]; 300 } __packed; 301 302 struct be_eth_hdr_wrb { 303 u32 dw[4]; 304 }; 305 306 /* TX Compl Queue Descriptor */ 307 308 /* Pseudo amap definition for eth_tx_compl in which each bit of the 309 * actual structure is defined as a byte: used to calculate 310 * offset/shift/mask of each field */ 311 struct amap_eth_tx_compl { 312 u8 wrb_index[16]; /* dword 0 */ 313 u8 ct[2]; /* dword 0 */ 314 u8 port[2]; /* dword 0 */ 315 u8 rsvd0[8]; /* dword 0 */ 316 u8 status[4]; /* dword 0 */ 317 u8 user_bytes[16]; /* dword 1 */ 318 u8 nwh_bytes[8]; /* dword 1 */ 319 u8 lso; /* dword 1 */ 320 u8 cast_enc[2]; /* dword 1 */ 321 u8 rsvd1[5]; /* dword 1 */ 322 u8 rsvd2[32]; /* dword 2 */ 323 u8 pkts[16]; /* dword 3 */ 324 u8 ringid[11]; /* dword 3 */ 325 u8 hash_val[4]; /* dword 3 */ 326 u8 valid; /* dword 3 */ 327 } __packed; 328 329 struct be_eth_tx_compl { 330 u32 dw[4]; 331 }; 332 333 /* RX Queue Descriptor */ 334 struct be_eth_rx_d { 335 u32 fragpa_hi; 336 u32 fragpa_lo; 337 }; 338 339 /* RX Compl Queue Descriptor */ 340 341 /* Pseudo amap definition for BE2 and BE3 legacy mode eth_rx_compl in which 342 * each bit of the actual structure is defined as a byte: used to calculate 343 * offset/shift/mask of each field */ 344 struct amap_eth_rx_compl_v0 { 345 u8 vlan_tag[16]; /* dword 0 */ 346 u8 pktsize[14]; /* dword 0 */ 347 u8 port; /* dword 0 */ 348 u8 ip_opt; /* dword 0 */ 349 u8 err; /* dword 1 */ 350 u8 rsshp; /* dword 1 */ 351 u8 ipf; /* dword 1 */ 352 u8 tcpf; /* dword 1 */ 353 u8 udpf; /* dword 1 */ 354 u8 ipcksm; /* dword 1 */ 355 u8 l4_cksm; /* dword 1 */ 356 u8 ip_version; /* dword 1 */ 357 u8 macdst[6]; /* dword 1 */ 358 u8 vtp; /* dword 1 */ 359 u8 ip_frag; /* dword 1 */ 360 u8 fragndx[10]; /* dword 1 */ 361 u8 ct[2]; /* dword 1 */ 362 u8 sw; /* dword 1 */ 363 u8 numfrags[3]; /* dword 1 */ 364 u8 rss_flush; /* dword 2 */ 365 u8 cast_enc[2]; /* dword 2 */ 366 u8 vtm; /* dword 2 */ 367 u8 rss_bank; /* dword 2 */ 368 u8 rsvd1[23]; /* dword 2 */ 369 u8 lro_pkt; /* dword 2 */ 370 u8 rsvd2[2]; /* dword 2 */ 371 u8 valid; /* dword 2 */ 372 u8 rsshash[32]; /* dword 3 */ 373 } __packed; 374 375 /* Pseudo amap definition for BE3 native mode eth_rx_compl in which 376 * each bit of the actual structure is defined as a byte: used to calculate 377 * offset/shift/mask of each field */ 378 struct amap_eth_rx_compl_v1 { 379 u8 vlan_tag[16]; /* dword 0 */ 380 u8 pktsize[14]; /* dword 0 */ 381 u8 vtp; /* dword 0 */ 382 u8 ip_opt; /* dword 0 */ 383 u8 err; /* dword 1 */ 384 u8 rsshp; /* dword 1 */ 385 u8 ipf; /* dword 1 */ 386 u8 tcpf; /* dword 1 */ 387 u8 udpf; /* dword 1 */ 388 u8 ipcksm; /* dword 1 */ 389 u8 l4_cksm; /* dword 1 */ 390 u8 ip_version; /* dword 1 */ 391 u8 macdst[7]; /* dword 1 */ 392 u8 rsvd0; /* dword 1 */ 393 u8 fragndx[10]; /* dword 1 */ 394 u8 ct[2]; /* dword 1 */ 395 u8 sw; /* dword 1 */ 396 u8 numfrags[3]; /* dword 1 */ 397 u8 rss_flush; /* dword 2 */ 398 u8 cast_enc[2]; /* dword 2 */ 399 u8 vtm; /* dword 2 */ 400 u8 rss_bank; /* dword 2 */ 401 u8 port[2]; /* dword 2 */ 402 u8 vntagp; /* dword 2 */ 403 u8 header_len[8]; /* dword 2 */ 404 u8 header_split[2]; /* dword 2 */ 405 u8 rsvd1[13]; /* dword 2 */ 406 u8 valid; /* dword 2 */ 407 u8 rsshash[32]; /* dword 3 */ 408 } __packed; 409 410 struct be_eth_rx_compl { 411 u32 dw[4]; 412 }; 413 414 struct mgmt_hba_attribs { 415 u8 flashrom_version_string[32]; 416 u8 manufacturer_name[32]; 417 u32 supported_modes; 418 u32 rsvd0[3]; 419 u8 ncsi_ver_string[12]; 420 u32 default_extended_timeout; 421 u8 controller_model_number[32]; 422 u8 controller_description[64]; 423 u8 controller_serial_number[32]; 424 u8 ip_version_string[32]; 425 u8 firmware_version_string[32]; 426 u8 bios_version_string[32]; 427 u8 redboot_version_string[32]; 428 u8 driver_version_string[32]; 429 u8 fw_on_flash_version_string[32]; 430 u32 functionalities_supported; 431 u16 max_cdblength; 432 u8 asic_revision; 433 u8 generational_guid[16]; 434 u8 hba_port_count; 435 u16 default_link_down_timeout; 436 u8 iscsi_ver_min_max; 437 u8 multifunction_device; 438 u8 cache_valid; 439 u8 hba_status; 440 u8 max_domains_supported; 441 u8 phy_port; 442 u32 firmware_post_status; 443 u32 hba_mtu[8]; 444 u32 rsvd1[4]; 445 }; 446 447 struct mgmt_controller_attrib { 448 struct mgmt_hba_attribs hba_attribs; 449 u16 pci_vendor_id; 450 u16 pci_device_id; 451 u16 pci_sub_vendor_id; 452 u16 pci_sub_system_id; 453 u8 pci_bus_number; 454 u8 pci_device_number; 455 u8 pci_function_number; 456 u8 interface_type; 457 u64 unique_identifier; 458 u32 rsvd0[5]; 459 }; 460 461 struct controller_id { 462 u32 vendor; 463 u32 device; 464 u32 subvendor; 465 u32 subdevice; 466 }; 467 468 struct flash_comp { 469 unsigned long offset; 470 int optype; 471 int size; 472 int img_type; 473 }; 474 475 struct image_hdr { 476 u32 imageid; 477 u32 imageoffset; 478 u32 imagelength; 479 u32 image_checksum; 480 u8 image_version[32]; 481 }; 482 struct flash_file_hdr_g2 { 483 u8 sign[32]; 484 u32 cksum; 485 u32 antidote; 486 struct controller_id cont_id; 487 u32 file_len; 488 u32 chunk_num; 489 u32 total_chunks; 490 u32 num_imgs; 491 u8 build[24]; 492 }; 493 494 struct flash_file_hdr_g3 { 495 u8 sign[52]; 496 u8 ufi_version[4]; 497 u32 file_len; 498 u32 cksum; 499 u32 antidote; 500 u32 num_imgs; 501 u8 build[24]; 502 u8 asic_type_rev; 503 u8 rsvd[31]; 504 }; 505 506 struct flash_section_hdr { 507 u32 format_rev; 508 u32 cksum; 509 u32 antidote; 510 u32 num_images; 511 u8 id_string[128]; 512 u32 rsvd[4]; 513 } __packed; 514 515 struct flash_section_hdr_g2 { 516 u32 format_rev; 517 u32 cksum; 518 u32 antidote; 519 u32 build_num; 520 u8 id_string[128]; 521 u32 rsvd[8]; 522 } __packed; 523 524 struct flash_section_entry { 525 u32 type; 526 u32 offset; 527 u32 pad_size; 528 u32 image_size; 529 u32 cksum; 530 u32 entry_point; 531 u32 rsvd0; 532 u32 rsvd1; 533 u8 ver_data[32]; 534 } __packed; 535 536 struct flash_section_info { 537 u8 cookie[32]; 538 struct flash_section_hdr fsec_hdr; 539 struct flash_section_entry fsec_entry[32]; 540 } __packed; 541 542 struct flash_section_info_g2 { 543 u8 cookie[32]; 544 struct flash_section_hdr_g2 fsec_hdr; 545 struct flash_section_entry fsec_entry[32]; 546 } __packed; 547