2 * Copyright (C) 2005 - 2015 Avago Technologies
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.
10 * Contact Information:
11 * linux-drivers@avagotech.com
15 * Costa Mesa, CA 92626
18 #ifndef BEISCSI_CMDS_H
19 #define BEISCSI_CMDS_H
22 * The driver sends configuration and managements command requests to the
23 * firmware in the BE. These requests are communicated to the processor
24 * using Work Request Blocks (WRBs) submitted to the MCC-WRB ring or via one
25 * WRB inside a MAILBOX.
26 * The commands are serviced by the ARM processor in the OneConnect's MPU.
34 #define MCC_WRB_SGE_CNT_SHIFT 3 /* bits 3 - 7 of dword 0 */
35 #define MCC_WRB_SGE_CNT_MASK 0x1F /* bits 3 - 7 of dword 0 */
37 u32 embedded; /* dword 0 */
38 u32 payload_length; /* dword 1 */
39 u32 tag0; /* dword 2 */
40 u32 tag1; /* dword 3 */
41 u32 rsvd; /* dword 4 */
43 #define EMBED_MBX_MAX_PAYLOAD_SIZE 220
44 u8 embedded_payload[236]; /* used by embedded cmds */
45 struct be_sge sgl[19]; /* used by non-embedded cmds */
49 #define CQE_FLAGS_VALID_MASK (1 << 31)
50 #define CQE_FLAGS_ASYNC_MASK (1 << 30)
51 #define CQE_FLAGS_COMPLETED_MASK (1 << 28)
52 #define CQE_FLAGS_CONSUMED_MASK (1 << 27)
54 /* Completion Status */
55 #define MCC_STATUS_SUCCESS 0x0
56 #define MCC_STATUS_FAILED 0x1
57 #define MCC_STATUS_ILLEGAL_REQUEST 0x2
58 #define MCC_STATUS_ILLEGAL_FIELD 0x3
59 #define MCC_STATUS_INSUFFICIENT_BUFFER 0x4
61 #define CQE_STATUS_COMPL_MASK 0xFFFF
62 #define CQE_STATUS_COMPL_SHIFT 0 /* bits 0 - 15 */
63 #define CQE_STATUS_EXTD_MASK 0xFFFF
64 #define CQE_STATUS_EXTD_SHIFT 16 /* bits 0 - 15 */
65 #define CQE_STATUS_ADDL_MASK 0xFF00
66 #define CQE_STATUS_MASK 0xFF
67 #define CQE_STATUS_ADDL_SHIFT 0x08
68 #define CQE_STATUS_WRB_MASK 0xFF0000
69 #define CQE_STATUS_WRB_SHIFT 16
70 #define BEISCSI_HOST_MBX_TIMEOUT (110 * 1000)
71 #define BEISCSI_FW_MBX_TIMEOUT 100
73 /* MBOX Command VER */
74 #define MBX_CMD_VER1 0x01
75 #define MBX_CMD_VER2 0x02
78 u32 status; /* dword 0 */
79 u32 tag0; /* dword 1 */
80 u32 tag1; /* dword 2 */
81 u32 flags; /* dword 3 */
84 /********* Mailbox door bell *************/
86 * Used for driver communication with the FW.
87 * The software must write this register twice to post any command. First,
88 * it writes the register with hi=1 and the upper bits of the physical address
89 * for the MAILBOX structure. Software must poll the ready bit until this
90 * is acknowledged. Then, sotware writes the register with hi=0 with the lower
91 * bits in the address. It must poll the ready bit until the command is
92 * complete. Upon completion, the MAILBOX will contain a valid completion
95 #define MPU_MAILBOX_DB_OFFSET 0x160
96 #define MPU_MAILBOX_DB_RDY_MASK 0x1 /* bit 0 */
97 #define MPU_MAILBOX_DB_HI_MASK 0x2 /* bit 1 */
99 /********** MPU semphore ******************/
100 #define MPU_EP_SEMAPHORE_OFFSET 0xac
101 #define EP_SEMAPHORE_POST_STAGE_MASK 0x0000FFFF
102 #define EP_SEMAPHORE_POST_ERR_MASK 0x1
103 #define EP_SEMAPHORE_POST_ERR_SHIFT 31
105 /********** MCC door bell ************/
106 #define DB_MCCQ_OFFSET 0x140
107 #define DB_MCCQ_RING_ID_MASK 0xFFFF /* bits 0 - 15 */
108 /* Number of entries posted */
109 #define DB_MCCQ_NUM_POSTED_SHIFT 16 /* bits 16 - 29 */
111 /* MPU semphore POST stage values */
112 #define POST_STAGE_ARMFW_RDY 0xc000 /* FW is done with POST */
115 * When the async bit of mcc_compl is set, the last 4 bytes of
116 * mcc_compl is interpreted as follows:
118 #define ASYNC_TRAILER_EVENT_CODE_SHIFT 8 /* bits 8 - 15 */
119 #define ASYNC_TRAILER_EVENT_CODE_MASK 0xFF
120 #define ASYNC_EVENT_CODE_LINK_STATE 0x1
121 #define ASYNC_EVENT_CODE_ISCSI 0x4
123 #define ASYNC_TRAILER_EVENT_TYPE_SHIFT 16 /* bits 16 - 23 */
124 #define ASYNC_TRAILER_EVENT_TYPE_MASK 0xF
125 #define ASYNC_EVENT_NEW_ISCSI_TGT_DISC 0x4
126 #define ASYNC_EVENT_NEW_ISCSI_CONN 0x5
127 #define ASYNC_EVENT_NEW_TCP_CONN 0x7
129 struct be_async_event_trailer {
134 ASYNC_EVENT_LINK_DOWN = 0x0,
135 ASYNC_EVENT_LINK_UP = 0x1,
136 ASYNC_EVENT_LOGICAL = 0x2
140 * When the event code of an async trailer is link-state, the mcc_compl
141 * must be interpreted as follows
143 struct be_async_event_link_state {
148 #define BEISCSI_PHY_LINK_FAULT_NONE 0x00
149 #define BEISCSI_PHY_LINK_FAULT_LOCAL 0x01
150 #define BEISCSI_PHY_LINK_FAULT_REMOTE 0x02
153 struct be_async_event_trailer trailer;
156 struct be_mcc_mailbox {
157 struct be_mcc_wrb wrb;
158 struct be_mcc_compl compl;
161 /* Type of subsystems supported by FW */
162 #define CMD_SUBSYSTEM_COMMON 0x1
163 #define CMD_SUBSYSTEM_ISCSI 0x2
164 #define CMD_SUBSYSTEM_ETH 0x3
165 #define CMD_SUBSYSTEM_ISCSI_INI 0x6
166 #define CMD_COMMON_TCP_UPLOAD 0x1
169 * List of common opcodes subsystem CMD_SUBSYSTEM_COMMON
170 * These opcodes are unique for each subsystem defined above
172 #define OPCODE_COMMON_CQ_CREATE 12
173 #define OPCODE_COMMON_EQ_CREATE 13
174 #define OPCODE_COMMON_MCC_CREATE 21
175 #define OPCODE_COMMON_ADD_TEMPLATE_HEADER_BUFFERS 24
176 #define OPCODE_COMMON_REMOVE_TEMPLATE_HEADER_BUFFERS 25
177 #define OPCODE_COMMON_GET_CNTL_ATTRIBUTES 32
178 #define OPCODE_COMMON_GET_FW_VERSION 35
179 #define OPCODE_COMMON_MODIFY_EQ_DELAY 41
180 #define OPCODE_COMMON_FIRMWARE_CONFIG 42
181 #define OPCODE_COMMON_MCC_DESTROY 53
182 #define OPCODE_COMMON_CQ_DESTROY 54
183 #define OPCODE_COMMON_EQ_DESTROY 55
184 #define OPCODE_COMMON_QUERY_FIRMWARE_CONFIG 58
185 #define OPCODE_COMMON_FUNCTION_RESET 61
188 * LIST of opcodes that are common between Initiator and Target
189 * used by CMD_SUBSYSTEM_ISCSI
190 * These opcodes are unique for each subsystem defined above
192 #define OPCODE_COMMON_ISCSI_CFG_POST_SGL_PAGES 2
193 #define OPCODE_COMMON_ISCSI_CFG_REMOVE_SGL_PAGES 3
194 #define OPCODE_COMMON_ISCSI_NTWK_GET_NIC_CONFIG 7
195 #define OPCODE_COMMON_ISCSI_NTWK_SET_VLAN 14
196 #define OPCODE_COMMON_ISCSI_NTWK_CONFIG_STATELESS_IP_ADDR 17
197 #define OPCODE_COMMON_ISCSI_NTWK_REL_STATELESS_IP_ADDR 18
198 #define OPCODE_COMMON_ISCSI_NTWK_MODIFY_IP_ADDR 21
199 #define OPCODE_COMMON_ISCSI_NTWK_GET_DEFAULT_GATEWAY 22
200 #define OPCODE_COMMON_ISCSI_NTWK_MODIFY_DEFAULT_GATEWAY 23
201 #define OPCODE_COMMON_ISCSI_NTWK_GET_ALL_IF_ID 24
202 #define OPCODE_COMMON_ISCSI_NTWK_GET_IF_INFO 25
203 #define OPCODE_COMMON_ISCSI_SET_FRAGNUM_BITS_FOR_SGL_CRA 61
204 #define OPCODE_COMMON_ISCSI_DEFQ_CREATE 64
205 #define OPCODE_COMMON_ISCSI_DEFQ_DESTROY 65
206 #define OPCODE_COMMON_ISCSI_WRBQ_CREATE 66
207 #define OPCODE_COMMON_ISCSI_WRBQ_DESTROY 67
209 struct be_cmd_req_hdr {
210 u8 opcode; /* dword 0 */
211 u8 subsystem; /* dword 0 */
212 u8 port_number; /* dword 0 */
213 u8 domain; /* dword 0 */
214 u32 timeout; /* dword 1 */
215 u32 request_length; /* dword 2 */
216 u8 version; /* dword 3 */
217 u8 rsvd0[3]; /* dword 3 */
220 struct be_cmd_resp_hdr {
221 u32 info; /* dword 0 */
222 u32 status; /* dword 1 */
223 u32 response_length; /* dword 2 */
224 u32 actual_resp_len; /* dword 3 */
236 /**************************
237 * BE Command definitions *
238 **************************/
241 * Pseudo amap definition in which each bit of the actual structure is defined
242 * as a byte - used to calculate offset/shift/mask of each field
244 struct amap_eq_context {
245 u8 cidx[13]; /* dword 0 */
246 u8 rsvd0[3]; /* dword 0 */
247 u8 epidx[13]; /* dword 0 */
248 u8 valid; /* dword 0 */
249 u8 rsvd1; /* dword 0 */
250 u8 size; /* dword 0 */
251 u8 pidx[13]; /* dword 1 */
252 u8 rsvd2[3]; /* dword 1 */
253 u8 pd[10]; /* dword 1 */
254 u8 count[3]; /* dword 1 */
255 u8 solevent; /* dword 1 */
256 u8 stalled; /* dword 1 */
257 u8 armed; /* dword 1 */
258 u8 rsvd3[4]; /* dword 2 */
259 u8 func[8]; /* dword 2 */
260 u8 rsvd4; /* dword 2 */
261 u8 delaymult[10]; /* dword 2 */
262 u8 rsvd5[2]; /* dword 2 */
263 u8 phase[2]; /* dword 2 */
264 u8 nodelay; /* dword 2 */
265 u8 rsvd6[4]; /* dword 2 */
266 u8 rsvd7[32]; /* dword 3 */
269 struct be_cmd_req_eq_create {
270 struct be_cmd_req_hdr hdr; /* dw[4] */
271 u16 num_pages; /* sword */
272 u16 rsvd0; /* sword */
273 u8 context[sizeof(struct amap_eq_context) / 8]; /* dw[4] */
274 struct phys_addr pages[8];
277 struct be_cmd_resp_eq_create {
278 struct be_cmd_resp_hdr resp_hdr;
279 u16 eq_id; /* sword */
280 u16 rsvd0; /* sword */
286 u32 delay_multiplier;
289 struct mgmt_chap_format {
291 u8 intr_chap_name[256];
293 u8 target_chap_name[256];
294 u8 target_secret[16];
295 u16 intr_chap_name_length;
296 u16 intr_secret_length;
297 u16 target_chap_name_length;
298 u16 target_secret_length;
301 struct mgmt_auth_method_format {
304 struct mgmt_chap_format chap;
307 struct mgmt_conn_login_options {
312 u32 max_recv_datasegment_len_ini;
313 u32 max_recv_datasegment_len_tgt;
316 struct mgmt_auth_method_format auth_data;
319 struct ip_addr_format {
320 u16 size_of_structure;
327 struct mgmt_conn_info {
328 u32 connection_handle;
329 u32 connection_status;
332 u16 dest_port_redirected;
334 u32 estimated_throughput;
335 struct ip_addr_format src_ipaddr;
336 struct ip_addr_format dest_ipaddr;
337 struct ip_addr_format dest_ipaddr_redirected;
338 struct mgmt_conn_login_options negotiated_login_options;
341 struct mgmt_session_login_options {
343 u8 error_recovery_level;
345 u32 first_burst_length;
346 u32 max_burst_length;
348 u16 max_outstanding_r2t;
349 u16 default_time2wait;
350 u16 default_time2retain;
353 struct mgmt_session_info {
362 u8 initiator_iscsiname[224];
363 struct mgmt_session_login_options negotiated_login_options;
364 struct mgmt_conn_info conn_list[1];
367 struct be_cmd_get_session_req {
368 struct be_cmd_req_hdr hdr;
372 struct be_cmd_get_session_resp {
373 struct be_cmd_resp_hdr hdr;
374 struct mgmt_session_info session_info;
378 u16 size_of_structure;
382 struct be_cmd_get_boot_target_req {
383 struct be_cmd_req_hdr hdr;
386 struct be_cmd_get_boot_target_resp {
387 struct be_cmd_resp_hdr hdr;
388 u32 boot_session_count;
389 int boot_session_handle;
392 struct be_cmd_reopen_session_req {
393 struct be_cmd_req_hdr hdr;
394 #define BE_REOPEN_ALL_SESSIONS 0x00
395 #define BE_REOPEN_BOOT_SESSIONS 0x01
396 #define BE_REOPEN_A_SESSION 0x02
402 struct be_cmd_reopen_session_resp {
403 struct be_cmd_resp_hdr hdr;
409 struct be_cmd_mac_query_req {
410 struct be_cmd_req_hdr hdr;
416 struct be_cmd_get_mac_resp {
417 struct be_cmd_resp_hdr hdr;
421 struct be_ip_addr_subnet_format {
422 u16 size_of_structure;
424 u8 ipv6_prefix_length;
430 struct be_cmd_get_if_info_req {
431 struct be_cmd_req_hdr hdr;
436 struct be_cmd_get_if_info_resp {
437 struct be_cmd_req_hdr hdr;
442 struct be_ip_addr_subnet_format ip_addr;
445 struct be_ip_addr_record {
448 struct be_ip_addr_subnet_format ip_addr;
452 struct be_ip_addr_record_params {
453 u32 record_entry_count;
454 struct be_ip_addr_record ip_record;
457 struct be_cmd_set_ip_addr_req {
458 struct be_cmd_req_hdr hdr;
459 struct be_ip_addr_record_params ip_params;
463 struct be_cmd_set_dhcp_req {
464 struct be_cmd_req_hdr hdr;
471 struct be_cmd_rel_dhcp_req {
472 struct be_cmd_req_hdr hdr;
477 struct be_cmd_set_def_gateway_req {
478 struct be_cmd_req_hdr hdr;
480 struct ip_addr_format ip_addr;
483 struct be_cmd_get_def_gateway_req {
484 struct be_cmd_req_hdr hdr;
488 struct be_cmd_get_def_gateway_resp {
489 struct be_cmd_req_hdr hdr;
490 struct ip_addr_format ip_addr;
493 #define BEISCSI_VLAN_DISABLE 0xFFFF
494 struct be_cmd_set_vlan_req {
495 struct be_cmd_req_hdr hdr;
499 /******************** Create CQ ***************************/
501 * Pseudo amap definition in which each bit of the actual structure is defined
502 * as a byte - used to calculate offset/shift/mask of each field
504 struct amap_cq_context {
505 u8 cidx[11]; /* dword 0 */
506 u8 rsvd0; /* dword 0 */
507 u8 coalescwm[2]; /* dword 0 */
508 u8 nodelay; /* dword 0 */
509 u8 epidx[11]; /* dword 0 */
510 u8 rsvd1; /* dword 0 */
511 u8 count[2]; /* dword 0 */
512 u8 valid; /* dword 0 */
513 u8 solevent; /* dword 0 */
514 u8 eventable; /* dword 0 */
515 u8 pidx[11]; /* dword 1 */
516 u8 rsvd2; /* dword 1 */
517 u8 pd[10]; /* dword 1 */
518 u8 eqid[8]; /* dword 1 */
519 u8 stalled; /* dword 1 */
520 u8 armed; /* dword 1 */
521 u8 rsvd3[4]; /* dword 2 */
522 u8 func[8]; /* dword 2 */
523 u8 rsvd4[20]; /* dword 2 */
524 u8 rsvd5[32]; /* dword 3 */
527 struct amap_cq_context_v2 {
528 u8 rsvd0[12]; /* dword 0 */
529 u8 coalescwm[2]; /* dword 0 */
530 u8 nodelay; /* dword 0 */
531 u8 rsvd1[12]; /* dword 0 */
532 u8 count[2]; /* dword 0 */
533 u8 valid; /* dword 0 */
534 u8 rsvd2; /* dword 0 */
535 u8 eventable; /* dword 0 */
536 u8 eqid[16]; /* dword 1 */
537 u8 rsvd3[15]; /* dword 1 */
538 u8 armed; /* dword 1 */
539 u8 cqecount[16];/* dword 2 */
540 u8 rsvd4[16]; /* dword 2 */
541 u8 rsvd5[32]; /* dword 3 */
544 struct be_cmd_req_cq_create {
545 struct be_cmd_req_hdr hdr;
549 u8 context[sizeof(struct amap_cq_context) / 8];
550 struct phys_addr pages[4];
553 struct be_cmd_resp_cq_create {
554 struct be_cmd_resp_hdr hdr;
559 /******************** Create MCCQ ***************************/
561 * Pseudo amap definition in which each bit of the actual structure is defined
562 * as a byte - used to calculate offset/shift/mask of each field
564 struct amap_mcc_context {
579 struct be_cmd_req_mcc_create {
580 struct be_cmd_req_hdr hdr;
583 u8 context[sizeof(struct amap_mcc_context) / 8];
584 struct phys_addr pages[8];
587 struct be_cmd_resp_mcc_create {
588 struct be_cmd_resp_hdr hdr;
593 /******************** Q Destroy ***************************/
594 /* Type of Queue to be destroyed */
604 struct be_cmd_req_q_destroy {
605 struct be_cmd_req_hdr hdr;
607 u16 bypass_flush; /* valid only for rx q destroy */
614 struct be_cmd_req_mcast_mac_config {
615 struct be_cmd_req_hdr hdr;
619 struct macaddr mac[32];
622 static inline void *embedded_payload(struct be_mcc_wrb *wrb)
624 return wrb->payload.embedded_payload;
627 static inline struct be_sge *nonembedded_sgl(struct be_mcc_wrb *wrb)
629 return &wrb->payload.sgl[0];
632 /******************** Modify EQ Delay *******************/
633 struct be_cmd_req_modify_eq_delay {
634 struct be_cmd_req_hdr hdr;
639 __le32 delay_multiplier;
643 /******************** Get MAC ADDR *******************/
647 struct be_cmd_get_nic_conf_req {
648 struct be_cmd_req_hdr hdr;
654 u16 size_of_structure;
655 u8 mac_address[ETH_ALEN];
659 struct be_cmd_get_nic_conf_resp {
660 struct be_cmd_resp_hdr hdr;
666 u16 size_of_structure;
671 #define BEISCSI_ALIAS_LEN 32
673 struct be_cmd_hba_name {
674 struct be_cmd_req_hdr hdr;
677 u8 initiator_name[ISCSI_NAME_LEN];
678 u8 initiator_alias[BEISCSI_ALIAS_LEN];
681 struct be_cmd_ntwk_link_status_req {
682 struct be_cmd_req_hdr hdr;
686 /*** Port Speed Values ***/
687 #define BE2ISCSI_LINK_SPEED_ZERO 0x00
688 #define BE2ISCSI_LINK_SPEED_10MBPS 0x01
689 #define BE2ISCSI_LINK_SPEED_100MBPS 0x02
690 #define BE2ISCSI_LINK_SPEED_1GBPS 0x03
691 #define BE2ISCSI_LINK_SPEED_10GBPS 0x04
692 struct be_cmd_ntwk_link_status_resp {
693 struct be_cmd_resp_hdr hdr;
701 u32 logical_link_speed;
704 int beiscsi_cmd_eq_create(struct be_ctrl_info *ctrl,
705 struct be_queue_info *eq, int eq_delay);
707 int beiscsi_cmd_cq_create(struct be_ctrl_info *ctrl,
708 struct be_queue_info *cq, struct be_queue_info *eq,
709 bool sol_evts, bool no_delay,
710 int num_cqe_dma_coalesce);
712 int beiscsi_cmd_q_destroy(struct be_ctrl_info *ctrl, struct be_queue_info *q,
714 int beiscsi_cmd_mccq_create(struct beiscsi_hba *phba,
715 struct be_queue_info *mccq,
716 struct be_queue_info *cq);
718 int be_poll_mcc(struct be_ctrl_info *ctrl);
719 int mgmt_check_supported_fw(struct be_ctrl_info *ctrl,
720 struct beiscsi_hba *phba);
721 unsigned int be_cmd_get_initname(struct beiscsi_hba *phba);
722 unsigned int be_cmd_get_port_speed(struct beiscsi_hba *phba);
724 void free_mcc_tag(struct be_ctrl_info *ctrl, unsigned int tag);
726 int be_cmd_modify_eq_delay(struct beiscsi_hba *phba, struct be_set_eqd *,
728 int beiscsi_mccq_compl(struct beiscsi_hba *phba,
729 uint32_t tag, struct be_mcc_wrb **wrb,
730 struct be_dma_mem *mbx_cmd_mem);
731 /*ISCSI Functuions */
732 int be_cmd_fw_initialize(struct be_ctrl_info *ctrl);
733 int be_cmd_fw_uninit(struct be_ctrl_info *ctrl);
735 struct be_mcc_wrb *wrb_from_mbox(struct be_dma_mem *mbox_mem);
736 struct be_mcc_wrb *wrb_from_mccq(struct beiscsi_hba *phba);
737 int be_mcc_notify_wait(struct beiscsi_hba *phba);
738 void be_mcc_notify(struct beiscsi_hba *phba);
739 unsigned int alloc_mcc_tag(struct beiscsi_hba *phba);
740 void beiscsi_async_link_state_process(struct beiscsi_hba *phba,
741 struct be_async_event_link_state *evt);
742 int be_mcc_compl_process_isr(struct be_ctrl_info *ctrl,
743 struct be_mcc_compl *compl);
745 int be_mbox_notify(struct be_ctrl_info *ctrl);
747 int be_cmd_create_default_pdu_queue(struct be_ctrl_info *ctrl,
748 struct be_queue_info *cq,
749 struct be_queue_info *dq, int length,
750 int entry_size, uint8_t is_header,
753 int be_cmd_iscsi_post_template_hdr(struct be_ctrl_info *ctrl,
754 struct be_dma_mem *q_mem);
756 int be_cmd_iscsi_remove_template_hdr(struct be_ctrl_info *ctrl);
758 int be_cmd_iscsi_post_sgl_pages(struct be_ctrl_info *ctrl,
759 struct be_dma_mem *q_mem, u32 page_offset,
762 int beiscsi_cmd_reset_function(struct beiscsi_hba *phba);
764 int be_cmd_wrbq_create(struct be_ctrl_info *ctrl, struct be_dma_mem *q_mem,
765 struct be_queue_info *wrbq,
766 struct hwi_wrb_context *pwrb_context,
769 bool is_link_state_evt(u32 trailer);
771 /* Configuration Functions */
772 int be_cmd_set_vlan(struct beiscsi_hba *phba, uint16_t vlan_tag);
774 struct be_default_pdu_context {
778 struct amap_be_default_pdu_context {
779 u8 dbuf_cindex[13]; /* dword 0 */
780 u8 rsvd0[3]; /* dword 0 */
781 u8 ring_size[4]; /* dword 0 */
782 u8 ring_state[4]; /* dword 0 */
783 u8 rsvd1[8]; /* dword 0 */
784 u8 dbuf_pindex[13]; /* dword 1 */
785 u8 rsvd2; /* dword 1 */
786 u8 pci_func_id[8]; /* dword 1 */
787 u8 rx_pdid[9]; /* dword 1 */
788 u8 rx_pdid_valid; /* dword 1 */
789 u8 default_buffer_size[16]; /* dword 2 */
790 u8 cq_id_recv[10]; /* dword 2 */
791 u8 rx_pdid_not_valid; /* dword 2 */
792 u8 rsvd3[5]; /* dword 2 */
793 u8 rsvd4[32]; /* dword 3 */
796 struct amap_default_pdu_context_ext {
797 u8 rsvd0[16]; /* dword 0 */
798 u8 ring_size[4]; /* dword 0 */
799 u8 rsvd1[12]; /* dword 0 */
800 u8 rsvd2[22]; /* dword 1 */
801 u8 rx_pdid[9]; /* dword 1 */
802 u8 rx_pdid_valid; /* dword 1 */
803 u8 default_buffer_size[16]; /* dword 2 */
804 u8 cq_id_recv[16]; /* dword 2 */
805 u8 rsvd3[32]; /* dword 3 */
808 struct be_defq_create_req {
809 struct be_cmd_req_hdr hdr;
812 #define BEISCSI_DUAL_ULP_AWARE_BIT 0 /* Byte 3 - Bit 0 */
813 #define BEISCSI_BIND_Q_TO_ULP_BIT 1 /* Byte 3 - Bit 1 */
815 struct be_default_pdu_context context;
816 struct phys_addr pages[8];
819 struct be_defq_create_resp {
820 struct be_cmd_req_hdr hdr;
829 struct be_post_template_pages_req {
830 struct be_cmd_req_hdr hdr;
832 #define BEISCSI_TEMPLATE_HDR_TYPE_ISCSI 0x1
834 struct phys_addr scratch_pa;
835 struct virt_addr scratch_va;
836 struct virt_addr pages_va;
837 struct phys_addr pages[16];
840 struct be_remove_template_pages_req {
841 struct be_cmd_req_hdr hdr;
846 struct be_post_sgl_pages_req {
847 struct be_cmd_req_hdr hdr;
851 struct phys_addr pages[26];
855 struct be_wrbq_create_req {
856 struct be_cmd_req_hdr hdr;
860 struct phys_addr pages[8];
863 struct be_wrbq_create_resp {
864 struct be_cmd_resp_hdr resp_hdr;
873 #define SOL_CID_MASK 0x0000FFC0
874 #define SOL_CODE_MASK 0x0000003F
875 #define SOL_WRB_INDEX_MASK 0x00FF0000
876 #define SOL_CMD_WND_MASK 0xFF000000
877 #define SOL_RES_CNT_MASK 0x7FFFFFFF
878 #define SOL_EXP_CMD_SN_MASK 0xFFFFFFFF
879 #define SOL_HW_STS_MASK 0x000000FF
880 #define SOL_STS_MASK 0x0000FF00
881 #define SOL_RESP_MASK 0x00FF0000
882 #define SOL_FLAGS_MASK 0x7F000000
883 #define SOL_S_MASK 0x80000000
889 struct amap_sol_cqe {
890 u8 hw_sts[8]; /* dword 0 */
891 u8 i_sts[8]; /* dword 0 */
892 u8 i_resp[8]; /* dword 0 */
893 u8 i_flags[7]; /* dword 0 */
895 u8 i_exp_cmd_sn[32]; /* dword 1 */
896 u8 code[6]; /* dword 2 */
897 u8 cid[10]; /* dword 2 */
898 u8 wrb_index[8]; /* dword 2 */
899 u8 i_cmd_wnd[8]; /* dword 2 */
900 u8 i_res_cnt[31]; /* dword 3 */
901 u8 valid; /* dword 3 */
904 #define SOL_ICD_INDEX_MASK 0x0003FFC0
905 struct amap_sol_cqe_ring {
906 u8 hw_sts[8]; /* dword 0 */
907 u8 i_sts[8]; /* dword 0 */
908 u8 i_resp[8]; /* dword 0 */
909 u8 i_flags[7]; /* dword 0 */
911 u8 i_exp_cmd_sn[32]; /* dword 1 */
912 u8 code[6]; /* dword 2 */
913 u8 icd_index[12]; /* dword 2 */
914 u8 rsvd[6]; /* dword 2 */
915 u8 i_cmd_wnd[8]; /* dword 2 */
916 u8 i_res_cnt[31]; /* dword 3 */
917 u8 valid; /* dword 3 */
920 struct amap_sol_cqe_v2 {
921 u8 hw_sts[8]; /* dword 0 */
922 u8 i_sts[8]; /* dword 0 */
923 u8 wrb_index[16]; /* dword 0 */
924 u8 i_exp_cmd_sn[32]; /* dword 1 */
925 u8 code[6]; /* dword 2 */
926 u8 cmd_cmpl; /* dword 2 */
927 u8 rsvd0; /* dword 2 */
928 u8 i_cmd_wnd[8]; /* dword 2 */
929 u8 cid[13]; /* dword 2 */
933 u8 i_res_cnt[31]; /* dword 3 */
934 u8 valid; /* dword 3 */
937 struct common_sol_cqe {
944 u8 res_flag; /* the s feild of structure */
945 u8 i_resp; /* for skh if cmd_complete is set then i_sts is response */
946 u8 i_flags; /* for skh or the u and o feilds */
947 u8 i_sts; /* for skh if cmd_complete is not-set then i_sts is status */
950 /*** iSCSI ack/driver message completions ***/
951 struct amap_it_dmsg_cqe {
952 u8 ack_num[32]; /* DWORD 0 */
953 u8 pdu_bytes_rcvd[32]; /* DWORD 1 */
954 u8 code[6]; /* DWORD 2 */
955 u8 cid[10]; /* DWORD 2 */
956 u8 wrb_idx[8]; /* DWORD 2 */
957 u8 rsvd0[8]; /* DWORD 2*/
958 u8 rsvd1[31]; /* DWORD 3*/
959 u8 valid; /* DWORD 3 */
962 struct amap_it_dmsg_cqe_v2 {
963 u8 ack_num[32]; /* DWORD 0 */
964 u8 pdu_bytes_rcvd[32]; /* DWORD 1 */
965 u8 code[6]; /* DWORD 2 */
966 u8 rsvd0[10]; /* DWORD 2 */
967 u8 wrb_idx[16]; /* DWORD 2 */
968 u8 rsvd1[16]; /* DWORD 3 */
969 u8 cid[13]; /* DWORD 3 */
970 u8 rsvd2[2]; /* DWORD 3 */
971 u8 valid; /* DWORD 3 */
976 * Post WRB Queue Doorbell Register used by the host Storage
977 * stack to notify the
978 * controller of a posted Work Request Block
980 #define DB_WRB_POST_CID_MASK 0xFFFF /* bits 0 - 16 */
981 #define DB_DEF_PDU_WRB_INDEX_MASK 0xFF /* bits 0 - 9 */
983 #define DB_DEF_PDU_WRB_INDEX_SHIFT 16
984 #define DB_DEF_PDU_NUM_POSTED_SHIFT 24
986 struct fragnum_bits_for_sgl_cra_in {
987 struct be_cmd_req_hdr hdr;
991 struct iscsi_cleanup_req {
992 struct be_cmd_req_hdr hdr;
1002 u32 delay_multiplier;
1005 struct be_eq_delay_params_in {
1006 struct be_cmd_req_hdr hdr;
1008 struct eq_delay delay[8];
1011 struct tcp_connect_and_offload_in {
1012 struct be_cmd_req_hdr hdr;
1013 struct ip_addr_format ip_address;
1018 struct phys_addr dataout_template_pa;
1025 struct tcp_connect_and_offload_in_v1 {
1026 struct be_cmd_req_hdr hdr;
1027 struct ip_addr_format ip_address;
1032 struct phys_addr dataout_template_pa;
1038 u16 tcp_window_size;
1039 u8 tcp_window_scale_count;
1045 struct tcp_connect_and_offload_out {
1046 struct be_cmd_resp_hdr hdr;
1047 u32 connection_handle;
1053 struct be_mcc_wrb_context {
1054 struct MCC_WRB *wrb;
1055 int *users_final_status;
1058 #define DB_DEF_PDU_RING_ID_MASK 0x3FFF /* bits 0 - 13 */
1059 #define DB_DEF_PDU_CQPROC_MASK 0x3FFF /* bits 16 - 29 */
1060 #define DB_DEF_PDU_REARM_SHIFT 14
1061 #define DB_DEF_PDU_EVENT_SHIFT 15
1062 #define DB_DEF_PDU_CQPROC_SHIFT 16
1068 struct tcp_upload_params_in {
1069 struct be_cmd_req_hdr hdr;
1075 struct tcp_upload_params_out {
1079 union tcp_upload_params {
1080 struct tcp_upload_params_in request;
1081 struct tcp_upload_params_out response;
1084 struct be_ulp_fw_cfg {
1085 #define BEISCSI_ULP_ISCSI_INI_MODE 0x10
1101 struct be_ulp_chain_icd {
1107 struct be_cmd_req_hdr hdr;
1108 u32 be_config_number;
1111 #define BEISCSI_FUNC_ISCSI_INI_MODE 0x10
1112 #define BEISCSI_FUNC_DUA_MODE 0x800
1114 struct be_ulp_fw_cfg ulp[2];
1120 struct be_ulp_chain_icd chain_icd[2];
1123 struct be_cmd_get_all_if_id_req {
1124 struct be_cmd_req_hdr hdr;
1126 u32 if_hndl_list[1];
1129 #define ISCSI_OPCODE_SCSI_DATA_OUT 5
1130 #define OPCODE_COMMON_NTWK_LINK_STATUS_QUERY 5
1131 #define OPCODE_COMMON_MODIFY_EQ_DELAY 41
1132 #define OPCODE_COMMON_ISCSI_CLEANUP 59
1133 #define OPCODE_COMMON_TCP_UPLOAD 56
1134 #define OPCODE_COMMON_ISCSI_TCP_CONNECT_AND_OFFLOAD 70
1135 #define OPCODE_COMMON_ISCSI_ERROR_RECOVERY_INVALIDATE_COMMANDS 1
1136 #define OPCODE_ISCSI_INI_CFG_GET_HBA_NAME 6
1137 #define OPCODE_ISCSI_INI_CFG_SET_HBA_NAME 7
1138 #define OPCODE_ISCSI_INI_SESSION_GET_A_SESSION 14
1139 #define OPCODE_ISCSI_INI_DRIVER_REOPEN_ALL_SESSIONS 36
1140 #define OPCODE_ISCSI_INI_DRIVER_OFFLOAD_SESSION 41
1141 #define OPCODE_ISCSI_INI_DRIVER_INVALIDATE_CONNECTION 42
1142 #define OPCODE_ISCSI_INI_BOOT_GET_BOOT_TARGET 52
1143 #define OPCODE_COMMON_WRITE_FLASH 96
1144 #define OPCODE_COMMON_READ_FLASH 97
1146 /* --- CMD_ISCSI_INVALIDATE_CONNECTION_TYPE --- */
1147 #define CMD_ISCSI_COMMAND_INVALIDATE 1
1148 #define CMD_ISCSI_CONNECTION_INVALIDATE 0x8001
1149 #define CMD_ISCSI_CONNECTION_ISSUE_TCP_RST 0x8002
1151 #define INI_WR_CMD 1 /* Initiator write command */
1152 #define INI_TMF_CMD 2 /* Initiator TMF command */
1153 #define INI_NOPOUT_CMD 3 /* Initiator; Send a NOP-OUT */
1154 #define INI_RD_CMD 5 /* Initiator requesting to send
1157 #define TGT_CTX_UPDT_CMD 7 /* Target context update */
1158 #define TGT_STS_CMD 8 /* Target R2T and other BHS
1159 * where only the status number
1160 * need to be updated
1162 #define TGT_DATAIN_CMD 9 /* Target Data-Ins in response
1165 #define TGT_SOS_PDU 10 /* Target:standalone status
1168 #define TGT_DM_CMD 11 /* Indicates that the bhs
1170 * driver should not be touched
1172 /* --- CMD_CHUTE_TYPE --- */
1173 #define CMD_CONNECTION_CHUTE_0 1
1174 #define CMD_CONNECTION_CHUTE_1 2
1175 #define CMD_CONNECTION_CHUTE_2 3
1177 #define EQ_MAJOR_CODE_COMPLETION 0
1179 #define CMD_ISCSI_SESSION_DEL_CFG_FROM_FLASH 0
1180 #define CMD_ISCSI_SESSION_SAVE_CFG_ON_FLASH 1
1182 /* --- CONNECTION_UPLOAD_PARAMS --- */
1183 /* These parameters are used to define the type of upload desired. */
1184 #define CONNECTION_UPLOAD_GRACEFUL 1 /* Graceful upload */
1185 #define CONNECTION_UPLOAD_ABORT_RESET 2 /* Abortive upload with
1188 #define CONNECTION_UPLOAD_ABORT 3 /* Abortive upload without
1191 #define CONNECTION_UPLOAD_ABORT_WITH_SEQ 4 /* Abortive upload with reset,
1192 * sequence number by driver */
1194 /* Returns the number of items in the field array. */
1195 #define BE_NUMBER_OF_FIELD(_type_, _field_) \
1196 (FIELD_SIZEOF(_type_, _field_)/sizeof((((_type_ *)0)->_field_[0])))\
1199 * Different types of iSCSI completions to host driver for both initiator
1203 #define SOL_CMD_COMPLETE 1 /* Solicited command completed
1206 #define SOL_CMD_KILLED_DATA_DIGEST_ERR 2 /* Solicited command got
1207 * invalidated internally due
1208 * to Data Digest error
1210 #define CXN_KILLED_PDU_SIZE_EXCEEDS_DSL 3 /* Connection got invalidated
1212 * due to a received PDU
1215 #define CXN_KILLED_BURST_LEN_MISMATCH 4 /* Connection got invalidated
1216 * internally due ti received
1217 * PDU sequence size >
1220 #define CXN_KILLED_AHS_RCVD 5 /* Connection got invalidated
1221 * internally due to a received
1224 #define CXN_KILLED_HDR_DIGEST_ERR 6 /* Connection got invalidated
1225 * internally due to Hdr Digest
1228 #define CXN_KILLED_UNKNOWN_HDR 7 /* Connection got invalidated
1230 * due to a bad opcode in the
1233 #define CXN_KILLED_STALE_ITT_TTT_RCVD 8 /* Connection got invalidated
1234 * internally due to a received
1235 * ITT/TTT that does not belong
1236 * to this Connection
1238 #define CXN_KILLED_INVALID_ITT_TTT_RCVD 9 /* Connection got invalidated
1239 * internally due to received
1240 * ITT/TTT value > Max
1241 * Supported ITTs/TTTs
1243 #define CXN_KILLED_RST_RCVD 10 /* Connection got invalidated
1244 * internally due to an
1247 #define CXN_KILLED_TIMED_OUT 11 /* Connection got invalidated
1248 * internally due to timeout on
1249 * tcp segment 12 retransmit
1252 #define CXN_KILLED_RST_SENT 12 /* Connection got invalidated
1253 * internally due to TCP RST
1254 * sent by the Tx side
1256 #define CXN_KILLED_FIN_RCVD 13 /* Connection got invalidated
1257 * internally due to an
1260 #define CXN_KILLED_BAD_UNSOL_PDU_RCVD 14 /* Connection got invalidated
1261 * internally due to bad
1262 * unsolicited PDU Unsolicited
1263 * PDUs are PDUs with
1266 #define CXN_KILLED_BAD_WRB_INDEX_ERROR 15 /* Connection got invalidated
1267 * internally due to bad WRB
1270 #define CXN_KILLED_OVER_RUN_RESIDUAL 16 /* Command got invalidated
1271 * internally due to received
1272 * command has residual
1275 #define CXN_KILLED_UNDER_RUN_RESIDUAL 17 /* Command got invalidated
1276 * internally due to received
1277 * command has residual under
1280 #define CMD_KILLED_INVALID_STATSN_RCVD 18 /* Command got invalidated
1281 * internally due to a received
1282 * PDU has an invalid StatusSN
1284 #define CMD_KILLED_INVALID_R2T_RCVD 19 /* Command got invalidated
1285 * internally due to a received
1286 * an R2T with some invalid
1289 #define CMD_CXN_KILLED_LUN_INVALID 20 /* Command got invalidated
1290 * internally due to received
1291 * PDU has an invalid LUN.
1293 #define CMD_CXN_KILLED_ICD_INVALID 21 /* Command got invalidated
1294 * internally due to the
1295 * corresponding ICD not in a
1298 #define CMD_CXN_KILLED_ITT_INVALID 22 /* Command got invalidated due
1299 * to received PDU has an
1302 #define CMD_CXN_KILLED_SEQ_OUTOFORDER 23 /* Command got invalidated due
1303 * to received sequence buffer
1304 * offset is out of order.
1306 #define CMD_CXN_KILLED_INVALID_DATASN_RCVD 24 /* Command got invalidated
1307 * internally due to a
1308 * received PDU has an invalid
1311 #define CXN_INVALIDATE_NOTIFY 25 /* Connection invalidation
1312 * completion notify.
1314 #define CXN_INVALIDATE_INDEX_NOTIFY 26 /* Connection invalidation
1316 * with data PDU index.
1318 #define CMD_INVALIDATED_NOTIFY 27 /* Command invalidation
1319 * completionnotifify.
1321 #define UNSOL_HDR_NOTIFY 28 /* Unsolicited header notify.*/
1322 #define UNSOL_DATA_NOTIFY 29 /* Unsolicited data notify.*/
1323 #define UNSOL_DATA_DIGEST_ERROR_NOTIFY 30 /* Unsolicited data digest
1326 #define DRIVERMSG_NOTIFY 31 /* TCP acknowledge based
1329 #define CXN_KILLED_CMND_DATA_NOT_ON_SAME_CONN 32 /* Connection got invalidated
1330 * internally due to command
1331 * and data are not on same
1334 #define SOL_CMD_KILLED_DIF_ERR 33 /* Solicited command got
1335 * invalidated internally due
1338 #define CXN_KILLED_SYN_RCVD 34 /* Connection got invalidated
1339 * internally due to incoming
1342 #define CXN_KILLED_IMM_DATA_RCVD 35 /* Connection got invalidated
1343 * internally due to an
1344 * incoming Unsolicited PDU
1345 * that has immediate data on
1349 int beiscsi_pci_soft_reset(struct beiscsi_hba *phba);
1350 int be_chk_reset_complete(struct beiscsi_hba *phba);
1352 void be_wrb_hdr_prepare(struct be_mcc_wrb *wrb, int payload_len,
1353 bool embedded, u8 sge_cnt);
1355 void be_cmd_hdr_prepare(struct be_cmd_req_hdr *req_hdr,
1356 u8 subsystem, u8 opcode, int cmd_len);
1358 void be2iscsi_fail_session(struct iscsi_cls_session *cls_session);
1359 #endif /* !BEISCSI_CMDS_H */