2 * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
6 * Linux driver for Brocade Fibre Channel Host Bus Adapter.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License (GPL) Version 2 as
10 * published by the Free Software Foundation
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
22 #include "bfa_defs_svc.h"
29 #define BFI_FLASH_CHUNK_SZ 256 /* Flash chunk size */
30 #define BFI_FLASH_CHUNK_SZ_WORDS (BFI_FLASH_CHUNK_SZ/sizeof(u32))
33 * Msg header common to all msgs
36 u8 msg_class; /* @ref bfi_mclass_t */
37 u8 msg_id; /* msg opcode with in the class */
41 u8 lpu_id; /* msg destination */
43 u16 i2htok; /* token in msgs to host */
47 #define bfi_mhdr_2_qid(_mh) ((_mh)->mtag.h2i.qid)
49 #define bfi_h2i_set(_mh, _mc, _op, _lpuid) do { \
50 (_mh).msg_class = (_mc); \
51 (_mh).msg_id = (_op); \
52 (_mh).mtag.h2i.lpu_id = (_lpuid); \
55 #define bfi_i2h_set(_mh, _mc, _op, _i2htok) do { \
56 (_mh).msg_class = (_mc); \
57 (_mh).msg_id = (_op); \
58 (_mh).mtag.i2htok = (_i2htok); \
62 * Message opcodes: 0-127 to firmware, 128-255 to host
64 #define BFI_I2H_OPCODE_BASE 128
65 #define BFA_I2HM(_x) ((_x) + BFI_I2H_OPCODE_BASE)
68 ****************************************************************************
70 * Scatter Gather Element and Page definition
72 ****************************************************************************
75 #define BFI_SGE_INLINE 1
76 #define BFI_SGE_INLINE_MAX (BFI_SGE_INLINE + 1)
82 BFI_SGE_DATA = 0, /* data address, not last */
83 BFI_SGE_DATA_CPL = 1, /* data addr, last in current page */
84 BFI_SGE_DATA_LAST = 3, /* data address, last */
85 BFI_SGE_LINK = 2, /* link address */
86 BFI_SGE_PGDLEN = 2, /* cumulative data length for page */
100 * Scatter Gather Element used for fast-path IO requests
112 union bfi_addr_u sga;
116 * Generic DMA addr-len pair.
119 union bfi_addr_u al_addr; /* DMA addr of buffer */
120 u32 al_len; /* length of buffer */
124 * Scatter Gather Page
126 #define BFI_SGPG_DATA_SGES 7
127 #define BFI_SGPG_SGES_MAX (BFI_SGPG_DATA_SGES + 1)
128 #define BFI_SGPG_RSVD_WD_LEN 8
130 struct bfi_sge_s sges[BFI_SGPG_SGES_MAX];
131 u32 rsvd[BFI_SGPG_RSVD_WD_LEN];
135 * Large Message structure - 128 Bytes size Msgs
137 #define BFI_LMSG_SZ 128
138 #define BFI_LMSG_PL_WSZ \
139 ((BFI_LMSG_SZ - sizeof(struct bfi_mhdr_s)) / 4)
142 struct bfi_mhdr_s mhdr;
143 u32 pl[BFI_LMSG_PL_WSZ];
147 * Mailbox message structure
149 #define BFI_MBMSG_SZ 7
151 struct bfi_mhdr_s mh;
152 u32 pl[BFI_MBMSG_SZ];
156 * Supported PCI function class codes (personality)
158 enum bfi_pcifn_class {
159 BFI_PCIFN_CLASS_FC = 0x0c04,
160 BFI_PCIFN_CLASS_ETH = 0x0200,
167 BFI_MC_IOC = 1, /* IO Controller (IOC) */
168 BFI_MC_FCPORT = 5, /* FC port */
169 BFI_MC_IOCFC = 6, /* FC - IO Controller (IOC) */
170 BFI_MC_ABLK = 7, /* ASIC block configuration */
171 BFI_MC_UF = 8, /* Unsolicited frame receive */
172 BFI_MC_FCXP = 9, /* FC Transport */
173 BFI_MC_LPS = 10, /* lport fc login services */
174 BFI_MC_RPORT = 11, /* Remote port */
175 BFI_MC_ITN = 12, /* I-T nexus (Initiator mode) */
176 BFI_MC_IOIM_READ = 13, /* read IO (Initiator mode) */
177 BFI_MC_IOIM_WRITE = 14, /* write IO (Initiator mode) */
178 BFI_MC_IOIM_IO = 15, /* IO (Initiator mode) */
179 BFI_MC_IOIM = 16, /* IO (Initiator mode) */
180 BFI_MC_IOIM_IOCOM = 17, /* good IO completion */
181 BFI_MC_TSKIM = 18, /* Initiator Task management */
182 BFI_MC_PORT = 21, /* Physical port */
186 #define BFI_IOC_MAX_CQS 4
187 #define BFI_IOC_MAX_CQS_ASIC 8
188 #define BFI_IOC_MSGLEN_MAX 32 /* 32 bytes */
191 *----------------------------------------------------------------------
193 *----------------------------------------------------------------------
197 * Different asic generations
200 BFI_ASIC_GEN_CB = 1, /* crossbow 8G FC */
201 BFI_ASIC_GEN_CT = 2, /* catapult 8G FC or 10G CNA */
202 BFI_ASIC_GEN_CT2 = 3, /* catapult-2 16G FC or 10G CNA */
206 BFI_ASIC_MODE_FC = 1, /* FC upto 8G speed */
207 BFI_ASIC_MODE_FC16 = 2, /* FC upto 16G speed */
208 BFI_ASIC_MODE_ETH = 3, /* Ethernet ports */
209 BFI_ASIC_MODE_COMBO = 4, /* FC 16G and Ethernet 10G port */
212 enum bfi_ioc_h2i_msgs {
213 BFI_IOC_H2I_ENABLE_REQ = 1,
214 BFI_IOC_H2I_DISABLE_REQ = 2,
215 BFI_IOC_H2I_GETATTR_REQ = 3,
216 BFI_IOC_H2I_DBG_SYNC = 4,
217 BFI_IOC_H2I_DBG_DUMP = 5,
220 enum bfi_ioc_i2h_msgs {
221 BFI_IOC_I2H_ENABLE_REPLY = BFA_I2HM(1),
222 BFI_IOC_I2H_DISABLE_REPLY = BFA_I2HM(2),
223 BFI_IOC_I2H_GETATTR_REPLY = BFA_I2HM(3),
224 BFI_IOC_I2H_HBEAT = BFA_I2HM(4),
228 * BFI_IOC_H2I_GETATTR_REQ message
230 struct bfi_ioc_getattr_req_s {
231 struct bfi_mhdr_s mh;
232 union bfi_addr_u attr_addr;
235 struct bfi_ioc_attr_s {
236 wwn_t mfg_pwwn; /* Mfg port wwn */
237 wwn_t mfg_nwwn; /* Mfg node wwn */
238 mac_t mfg_mac; /* Mfg mac */
242 mac_t mac; /* PBC or Mfg mac */
246 char brcd_serialnum[STRSZ(BFA_MFG_SERIALNUM_SIZE)];
250 u8 rx_bbcredit; /* receive buffer credits */
251 u32 adapter_prop; /* adapter properties */
252 u16 maxfrsize; /* max receive frame size */
254 u8 ic; /* initial capability */
255 char fw_version[BFA_VERSION_LEN];
256 char optrom_version[BFA_VERSION_LEN];
257 struct bfa_mfg_vpd_s vpd;
258 u32 card_type; /* card type */
262 * BFI_IOC_I2H_GETATTR_REPLY message
264 struct bfi_ioc_getattr_reply_s {
265 struct bfi_mhdr_s mh; /* Common msg header */
266 u8 status; /* cfg reply status */
271 * Firmware memory page offsets
273 #define BFI_IOC_SMEM_PG0_CB (0x40)
274 #define BFI_IOC_SMEM_PG0_CT (0x180)
277 * Firmware statistic offset
279 #define BFI_IOC_FWSTATS_OFF (0x6B40)
280 #define BFI_IOC_FWSTATS_SZ (4096)
283 * Firmware trace offset
285 #define BFI_IOC_TRC_OFF (0x4b00)
286 #define BFI_IOC_TRC_ENTS 256
288 #define BFI_IOC_FW_SIGNATURE (0xbfadbfad)
289 #define BFI_IOC_MD5SUM_SZ 4
290 struct bfi_ioc_image_hdr_s {
291 u32 signature; /* constant signature */
292 u8 asic_gen; /* asic generation */
294 u8 port0_mode; /* device mode for port 0 */
295 u8 port1_mode; /* device mode for port 1 */
296 u32 exec; /* exec vector */
297 u32 bootenv; /* fimware boot env */
299 u32 md5sum[BFI_IOC_MD5SUM_SZ];
302 #define BFI_FWBOOT_DEVMODE_OFF 4
303 #define BFI_FWBOOT_TYPE_OFF 8
304 #define BFI_FWBOOT_ENV_OFF 12
305 #define BFI_FWBOOT_DEVMODE(__asic_gen, __asic_mode, __p0_mode, __p1_mode) \
306 (((u32)(__asic_gen)) << 24 | \
307 ((u32)(__asic_mode)) << 16 | \
308 ((u32)(__p0_mode)) << 8 | \
311 #define BFI_FWBOOT_TYPE_NORMAL 0
312 #define BFI_FWBOOT_TYPE_MEMTEST 1
313 #define BFI_FWBOOT_ENV_OS 0
316 BFI_PORT_MODE_FC = 1,
317 BFI_PORT_MODE_ETH = 2,
320 struct bfi_ioc_hbeat_s {
321 struct bfi_mhdr_s mh; /* common msg header */
322 u32 hb_count; /* current heart beat count */
326 * IOC hardware/firmware state
329 BFI_IOC_UNINIT = 0, /* not initialized */
330 BFI_IOC_INITING = 1, /* h/w is being initialized */
331 BFI_IOC_HWINIT = 2, /* h/w is initialized */
332 BFI_IOC_CFG = 3, /* IOC configuration in progress */
333 BFI_IOC_OP = 4, /* IOC is operational */
334 BFI_IOC_DISABLING = 5, /* IOC is being disabled */
335 BFI_IOC_DISABLED = 6, /* IOC is disabled */
336 BFI_IOC_CFG_DISABLED = 7, /* IOC is being disabled;transient */
337 BFI_IOC_FAIL = 8, /* IOC heart-beat failure */
338 BFI_IOC_MEMTEST = 9, /* IOC is doing memtest */
341 #define BFI_IOC_ENDIAN_SIG 0x12345678
344 BFI_ADAPTER_TYPE_FC = 0x01, /* FC adapters */
345 BFI_ADAPTER_TYPE_MK = 0x0f0000, /* adapter type mask */
346 BFI_ADAPTER_TYPE_SH = 16, /* adapter type shift */
347 BFI_ADAPTER_NPORTS_MK = 0xff00, /* number of ports mask */
348 BFI_ADAPTER_NPORTS_SH = 8, /* number of ports shift */
349 BFI_ADAPTER_SPEED_MK = 0xff, /* adapter speed mask */
350 BFI_ADAPTER_SPEED_SH = 0, /* adapter speed shift */
351 BFI_ADAPTER_PROTO = 0x100000, /* prototype adapaters */
352 BFI_ADAPTER_TTV = 0x200000, /* TTV debug capable */
353 BFI_ADAPTER_UNSUPP = 0x400000, /* unknown adapter type */
356 #define BFI_ADAPTER_GETP(__prop, __adap_prop) \
357 (((__adap_prop) & BFI_ADAPTER_ ## __prop ## _MK) >> \
358 BFI_ADAPTER_ ## __prop ## _SH)
359 #define BFI_ADAPTER_SETP(__prop, __val) \
360 ((__val) << BFI_ADAPTER_ ## __prop ## _SH)
361 #define BFI_ADAPTER_IS_PROTO(__adap_type) \
362 ((__adap_type) & BFI_ADAPTER_PROTO)
363 #define BFI_ADAPTER_IS_TTV(__adap_type) \
364 ((__adap_type) & BFI_ADAPTER_TTV)
365 #define BFI_ADAPTER_IS_UNSUPP(__adap_type) \
366 ((__adap_type) & BFI_ADAPTER_UNSUPP)
367 #define BFI_ADAPTER_IS_SPECIAL(__adap_type) \
368 ((__adap_type) & (BFI_ADAPTER_TTV | BFI_ADAPTER_PROTO | \
372 * BFI_IOC_H2I_ENABLE_REQ & BFI_IOC_H2I_DISABLE_REQ messages
374 struct bfi_ioc_ctrl_req_s {
375 struct bfi_mhdr_s mh;
380 #define bfi_ioc_enable_req_t struct bfi_ioc_ctrl_req_s;
381 #define bfi_ioc_disable_req_t struct bfi_ioc_ctrl_req_s;
384 * BFI_IOC_I2H_ENABLE_REPLY & BFI_IOC_I2H_DISABLE_REPLY messages
386 struct bfi_ioc_ctrl_reply_s {
387 struct bfi_mhdr_s mh; /* Common msg header */
388 u8 status; /* enable/disable status */
389 u8 port_mode; /* bfa_mode_s */
390 u8 cap_bm; /* capability bit mask */
393 #define bfi_ioc_enable_reply_t struct bfi_ioc_ctrl_reply_s;
394 #define bfi_ioc_disable_reply_t struct bfi_ioc_ctrl_reply_s;
396 #define BFI_IOC_MSGSZ 8
400 union bfi_ioc_h2i_msg_u {
401 struct bfi_mhdr_s mh;
402 struct bfi_ioc_ctrl_req_s enable_req;
403 struct bfi_ioc_ctrl_req_s disable_req;
404 struct bfi_ioc_getattr_req_s getattr_req;
405 u32 mboxmsg[BFI_IOC_MSGSZ];
411 union bfi_ioc_i2h_msg_u {
412 struct bfi_mhdr_s mh;
413 struct bfi_ioc_ctrl_reply_s fw_event;
414 u32 mboxmsg[BFI_IOC_MSGSZ];
419 *----------------------------------------------------------------------
421 *----------------------------------------------------------------------
424 #define BFI_PBC_MAX_BLUNS 8
425 #define BFI_PBC_MAX_VPORTS 16
426 #define BFI_PBC_PORT_DISABLED 2
429 * PBC boot lun configuration
431 struct bfi_pbc_blun_s {
433 struct scsi_lun tgt_lun;
437 * PBC virtual port configuration
439 struct bfi_pbc_vport_s {
445 * BFI pre-boot configuration information
457 struct bfi_pbc_blun_s blun[BFI_PBC_MAX_BLUNS];
458 struct bfi_pbc_vport_s vport[BFI_PBC_MAX_VPORTS];
462 *----------------------------------------------------------------------
464 *----------------------------------------------------------------------
466 #define BFI_MSGQ_FULL(_q) (((_q->pi + 1) % _q->q_depth) == _q->ci)
467 #define BFI_MSGQ_EMPTY(_q) (_q->pi == _q->ci)
468 #define BFI_MSGQ_UPDATE_CI(_q) (_q->ci = (_q->ci + 1) % _q->q_depth)
469 #define BFI_MSGQ_UPDATE_PI(_q) (_q->pi = (_q->pi + 1) % _q->q_depth)
471 /* q_depth must be power of 2 */
472 #define BFI_MSGQ_FREE_CNT(_q) ((_q->ci - _q->pi - 1) & (_q->q_depth - 1))
474 enum bfi_msgq_h2i_msgs_e {
475 BFI_MSGQ_H2I_INIT_REQ = 1,
476 BFI_MSGQ_H2I_DOORBELL = 2,
477 BFI_MSGQ_H2I_SHUTDOWN = 3,
480 enum bfi_msgq_i2h_msgs_e {
481 BFI_MSGQ_I2H_INIT_RSP = 1,
482 BFI_MSGQ_I2H_DOORBELL = 2,
486 /* Messages(commands/responsed/AENS will have the following header */
487 struct bfi_msgq_mhdr_s {
496 #define bfi_msgq_mhdr_set(_mh, _mc, _mid, _tok, _enet_id) do { \
497 (_mh).msg_class = (_mc); \
498 (_mh).msg_id = (_mid); \
499 (_mh).msg_token = (_tok); \
500 (_mh).enet_id = (_enet_id); \
504 * Mailbox for messaging interface
507 #define BFI_MSGQ_CMD_ENTRY_SIZE (64) /* TBD */
508 #define BFI_MSGQ_RSP_ENTRY_SIZE (64) /* TBD */
509 #define BFI_MSGQ_MSG_SIZE_MAX (2048) /* TBD */
512 union bfi_addr_u addr;
513 u16 q_depth; /* Total num of entries in the queue */
517 /* BFI_ENET_MSGQ_CFG_REQ TBD init or cfg? */
518 struct bfi_msgq_cfg_req_s {
519 struct bfi_mhdr_s mh;
520 struct bfi_msgq_s cmdq;
521 struct bfi_msgq_s rspq;
524 /* BFI_ENET_MSGQ_CFG_RSP */
525 struct bfi_msgq_cfg_rsp_s {
526 struct bfi_mhdr_s mh;
532 /* BFI_MSGQ_H2I_DOORBELL */
533 struct bfi_msgq_h2i_db_s {
534 struct bfi_mhdr_s mh;
539 /* BFI_MSGQ_I2H_DOORBELL */
540 struct bfi_msgq_i2h_db_s {
541 struct bfi_mhdr_s mh;
548 /* BFI port specific */
552 BFI_PORT_H2I_ENABLE_REQ = (1),
553 BFI_PORT_H2I_DISABLE_REQ = (2),
554 BFI_PORT_H2I_GET_STATS_REQ = (3),
555 BFI_PORT_H2I_CLEAR_STATS_REQ = (4),
559 BFI_PORT_I2H_ENABLE_RSP = BFA_I2HM(1),
560 BFI_PORT_I2H_DISABLE_RSP = BFA_I2HM(2),
561 BFI_PORT_I2H_GET_STATS_RSP = BFA_I2HM(3),
562 BFI_PORT_I2H_CLEAR_STATS_RSP = BFA_I2HM(4),
568 struct bfi_port_generic_req_s {
569 struct bfi_mhdr_s mh; /* msg header */
570 u32 msgtag; /* msgtag for reply */
577 struct bfi_port_generic_rsp_s {
578 struct bfi_mhdr_s mh; /* common msg header */
579 u8 status; /* port enable status */
581 u32 msgtag; /* msgtag for reply */
585 * BFI_PORT_H2I_GET_STATS_REQ
587 struct bfi_port_get_stats_req_s {
588 struct bfi_mhdr_s mh; /* common msg header */
589 union bfi_addr_u dma_addr;
592 union bfi_port_h2i_msg_u {
593 struct bfi_mhdr_s mh;
594 struct bfi_port_generic_req_s enable_req;
595 struct bfi_port_generic_req_s disable_req;
596 struct bfi_port_get_stats_req_s getstats_req;
597 struct bfi_port_generic_req_s clearstats_req;
600 union bfi_port_i2h_msg_u {
601 struct bfi_mhdr_s mh;
602 struct bfi_port_generic_rsp_s enable_rsp;
603 struct bfi_port_generic_rsp_s disable_rsp;
604 struct bfi_port_generic_rsp_s getstats_rsp;
605 struct bfi_port_generic_rsp_s clearstats_rsp;
609 *----------------------------------------------------------------------
611 *----------------------------------------------------------------------
613 enum bfi_ablk_h2i_msgs_e {
614 BFI_ABLK_H2I_QUERY = 1,
615 BFI_ABLK_H2I_ADPT_CONFIG = 2,
616 BFI_ABLK_H2I_PORT_CONFIG = 3,
617 BFI_ABLK_H2I_PF_CREATE = 4,
618 BFI_ABLK_H2I_PF_DELETE = 5,
619 BFI_ABLK_H2I_PF_UPDATE = 6,
620 BFI_ABLK_H2I_OPTROM_ENABLE = 7,
621 BFI_ABLK_H2I_OPTROM_DISABLE = 8,
624 enum bfi_ablk_i2h_msgs_e {
625 BFI_ABLK_I2H_QUERY = BFA_I2HM(BFI_ABLK_H2I_QUERY),
626 BFI_ABLK_I2H_ADPT_CONFIG = BFA_I2HM(BFI_ABLK_H2I_ADPT_CONFIG),
627 BFI_ABLK_I2H_PORT_CONFIG = BFA_I2HM(BFI_ABLK_H2I_PORT_CONFIG),
628 BFI_ABLK_I2H_PF_CREATE = BFA_I2HM(BFI_ABLK_H2I_PF_CREATE),
629 BFI_ABLK_I2H_PF_DELETE = BFA_I2HM(BFI_ABLK_H2I_PF_DELETE),
630 BFI_ABLK_I2H_PF_UPDATE = BFA_I2HM(BFI_ABLK_H2I_PF_UPDATE),
631 BFI_ABLK_I2H_OPTROM_ENABLE = BFA_I2HM(BFI_ABLK_H2I_OPTROM_ENABLE),
632 BFI_ABLK_I2H_OPTROM_DISABLE = BFA_I2HM(BFI_ABLK_H2I_OPTROM_DISABLE),
635 /* BFI_ABLK_H2I_QUERY */
636 struct bfi_ablk_h2i_query_s {
637 struct bfi_mhdr_s mh;
638 union bfi_addr_u addr;
641 /* BFI_ABL_H2I_ADPT_CONFIG, BFI_ABLK_H2I_PORT_CONFIG */
642 struct bfi_ablk_h2i_cfg_req_s {
643 struct bfi_mhdr_s mh;
651 * BFI_ABLK_H2I_PF_CREATE, BFI_ABLK_H2I_PF_DELETE,
653 struct bfi_ablk_h2i_pf_req_s {
654 struct bfi_mhdr_s mh;
661 /* BFI_ABLK_H2I_OPTROM_ENABLE, BFI_ABLK_H2I_OPTROM_DISABLE */
662 struct bfi_ablk_h2i_optrom_s {
663 struct bfi_mhdr_s mh;
668 * BFI_ABLK_I2H_PORT_CONFIG
669 * BFI_ABLK_I2H_PF_CREATE
670 * BFI_ABLK_I2H_PF_DELETE
671 * BFI_ABLK_I2H_PF_UPDATE
672 * BFI_ABLK_I2H_OPTROM_ENABLE
673 * BFI_ABLK_I2H_OPTROM_DISABLE
675 struct bfi_ablk_i2h_rsp_s {
676 struct bfi_mhdr_s mh;
684 #endif /* __BFI_H__ */