2 * Copyright (C) 2005 - 2016 Broadcom
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@broadcom.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
60 #define MCC_STATUS_INVALID_LENGTH 0x74
62 #define CQE_STATUS_COMPL_MASK 0xFFFF
63 #define CQE_STATUS_COMPL_SHIFT 0 /* bits 0 - 15 */
64 #define CQE_STATUS_EXTD_MASK 0xFFFF
65 #define CQE_STATUS_EXTD_SHIFT 16 /* bits 31 - 16 */
66 #define CQE_STATUS_ADDL_MASK 0xFF00
67 #define CQE_STATUS_ADDL_SHIFT 8
68 #define CQE_STATUS_MASK 0xFF
69 #define CQE_STATUS_WRB_MASK 0xFF0000
70 #define CQE_STATUS_WRB_SHIFT 16
72 #define BEISCSI_HOST_MBX_TIMEOUT (110 * 1000)
73 #define BEISCSI_FW_MBX_TIMEOUT 100
75 /* MBOX Command VER */
76 #define MBX_CMD_VER1 0x01
77 #define MBX_CMD_VER2 0x02
80 u32 status
; /* dword 0 */
81 u32 tag0
; /* dword 1 */
82 u32 tag1
; /* dword 2 */
83 u32 flags
; /* dword 3 */
86 /********* Mailbox door bell *************/
88 * Used for driver communication with the FW.
89 * The software must write this register twice to post any command. First,
90 * it writes the register with hi=1 and the upper bits of the physical address
91 * for the MAILBOX structure. Software must poll the ready bit until this
92 * is acknowledged. Then, sotware writes the register with hi=0 with the lower
93 * bits in the address. It must poll the ready bit until the command is
94 * complete. Upon completion, the MAILBOX will contain a valid completion
97 #define MPU_MAILBOX_DB_OFFSET 0x160
98 #define MPU_MAILBOX_DB_RDY_MASK 0x1 /* bit 0 */
99 #define MPU_MAILBOX_DB_HI_MASK 0x2 /* bit 1 */
101 /********** MPU semphore: used for SH & BE ******************/
102 #define SLIPORT_SOFTRESET_OFFSET 0x5c /* CSR BAR offset */
103 #define SLIPORT_SEMAPHORE_OFFSET_BEx 0xac /* CSR BAR offset */
104 #define SLIPORT_SEMAPHORE_OFFSET_SH 0x94 /* PCI-CFG offset */
105 #define POST_STAGE_MASK 0x0000FFFF
106 #define POST_ERROR_BIT 0x80000000
107 #define POST_ERR_RECOVERY_CODE_MASK 0xF000
109 /* Soft Reset register masks */
110 #define SLIPORT_SOFTRESET_SR_MASK 0x00000080 /* SR bit */
112 /* MPU semphore POST stage values */
113 #define POST_STAGE_AWAITING_HOST_RDY 0x1 /* FW awaiting goahead from host */
114 #define POST_STAGE_HOST_RDY 0x2 /* Host has given go-ahed to FW */
115 #define POST_STAGE_BE_RESET 0x3 /* Host wants to reset chip */
116 #define POST_STAGE_ARMFW_RDY 0xC000 /* FW is done with POST */
117 #define POST_STAGE_RECOVERABLE_ERR 0xE000 /* Recoverable err detected */
119 /********** MCC door bell ************/
120 #define DB_MCCQ_OFFSET 0x140
121 #define DB_MCCQ_RING_ID_MASK 0xFFFF /* bits 0 - 15 */
122 /* Number of entries posted */
123 #define DB_MCCQ_NUM_POSTED_SHIFT 16 /* bits 16 - 29 */
126 * When the async bit of mcc_compl is set, the last 4 bytes of
127 * mcc_compl is interpreted as follows:
129 #define ASYNC_TRAILER_EVENT_CODE_SHIFT 8 /* bits 8 - 15 */
130 #define ASYNC_TRAILER_EVENT_CODE_MASK 0xFF
131 #define ASYNC_EVENT_CODE_LINK_STATE 0x1
132 #define ASYNC_EVENT_CODE_ISCSI 0x4
133 #define ASYNC_EVENT_CODE_SLI 0x11
135 #define ASYNC_TRAILER_EVENT_TYPE_SHIFT 16 /* bits 16 - 23 */
136 #define ASYNC_TRAILER_EVENT_TYPE_MASK 0xFF
139 #define ASYNC_EVENT_NEW_ISCSI_TGT_DISC 0x4
140 #define ASYNC_EVENT_NEW_ISCSI_CONN 0x5
141 #define ASYNC_EVENT_NEW_TCP_CONN 0x7
144 #define ASYNC_SLI_EVENT_TYPE_MISCONFIGURED 0x9
145 #define ASYNC_SLI_LINK_EFFECT_VALID(le) (le & 0x80)
146 #define ASYNC_SLI_LINK_EFFECT_SEV(le) ((le >> 1) & 0x03)
147 #define ASYNC_SLI_LINK_EFFECT_STATE(le) (le & 0x01)
149 struct be_async_event_trailer
{
154 ASYNC_EVENT_LINK_DOWN
= 0x0,
155 ASYNC_EVENT_LINK_UP
= 0x1,
159 * When the event code of an async trailer is link-state, the mcc_compl
160 * must be interpreted as follows
162 struct be_async_event_link_state
{
166 * ASYNC_EVENT_LINK_DOWN 0x0
167 * ASYNC_EVENT_LINK_UP 0x1
168 * ASYNC_EVENT_LINK_LOGICAL_DOWN 0x2
169 * ASYNC_EVENT_LINK_LOGICAL_UP 0x3
171 #define BE_ASYNC_LINK_UP_MASK 0x01
174 /* BE2ISCSI_LINK_SPEED_ZERO 0x00 - no link */
175 #define BE2ISCSI_LINK_SPEED_10MBPS 0x01
176 #define BE2ISCSI_LINK_SPEED_100MBPS 0x02
177 #define BE2ISCSI_LINK_SPEED_1GBPS 0x03
178 #define BE2ISCSI_LINK_SPEED_10GBPS 0x04
179 #define BE2ISCSI_LINK_SPEED_25GBPS 0x06
180 #define BE2ISCSI_LINK_SPEED_40GBPS 0x07
185 struct be_async_event_trailer trailer
;
189 * When async-trailer is SLI event, mcc_compl is interpreted as
191 struct be_async_event_sli
{
198 struct be_mcc_mailbox
{
199 struct be_mcc_wrb wrb
;
200 struct be_mcc_compl
compl;
203 /* Type of subsystems supported by FW */
204 #define CMD_SUBSYSTEM_COMMON 0x1
205 #define CMD_SUBSYSTEM_ISCSI 0x2
206 #define CMD_SUBSYSTEM_ETH 0x3
207 #define CMD_SUBSYSTEM_ISCSI_INI 0x6
208 #define CMD_COMMON_TCP_UPLOAD 0x1
211 * List of common opcodes subsystem CMD_SUBSYSTEM_COMMON
212 * These opcodes are unique for each subsystem defined above
214 #define OPCODE_COMMON_CQ_CREATE 12
215 #define OPCODE_COMMON_EQ_CREATE 13
216 #define OPCODE_COMMON_MCC_CREATE 21
217 #define OPCODE_COMMON_MCC_CREATE_EXT 90
218 #define OPCODE_COMMON_ADD_TEMPLATE_HEADER_BUFFERS 24
219 #define OPCODE_COMMON_REMOVE_TEMPLATE_HEADER_BUFFERS 25
220 #define OPCODE_COMMON_GET_CNTL_ATTRIBUTES 32
221 #define OPCODE_COMMON_GET_FW_VERSION 35
222 #define OPCODE_COMMON_MODIFY_EQ_DELAY 41
223 #define OPCODE_COMMON_FIRMWARE_CONFIG 42
224 #define OPCODE_COMMON_MCC_DESTROY 53
225 #define OPCODE_COMMON_CQ_DESTROY 54
226 #define OPCODE_COMMON_EQ_DESTROY 55
227 #define OPCODE_COMMON_QUERY_FIRMWARE_CONFIG 58
228 #define OPCODE_COMMON_FUNCTION_RESET 61
229 #define OPCODE_COMMON_GET_PORT_NAME 77
230 #define OPCODE_COMMON_SET_FEATURES 191
233 * LIST of opcodes that are common between Initiator and Target
234 * used by CMD_SUBSYSTEM_ISCSI
235 * These opcodes are unique for each subsystem defined above
237 #define OPCODE_COMMON_ISCSI_CFG_POST_SGL_PAGES 2
238 #define OPCODE_COMMON_ISCSI_CFG_REMOVE_SGL_PAGES 3
239 #define OPCODE_COMMON_ISCSI_NTWK_GET_NIC_CONFIG 7
240 #define OPCODE_COMMON_ISCSI_NTWK_SET_VLAN 14
241 #define OPCODE_COMMON_ISCSI_NTWK_CONFIG_STATELESS_IP_ADDR 17
242 #define OPCODE_COMMON_ISCSI_NTWK_REL_STATELESS_IP_ADDR 18
243 #define OPCODE_COMMON_ISCSI_NTWK_MODIFY_IP_ADDR 21
244 #define OPCODE_COMMON_ISCSI_NTWK_GET_DEFAULT_GATEWAY 22
245 #define OPCODE_COMMON_ISCSI_NTWK_MODIFY_DEFAULT_GATEWAY 23
246 #define OPCODE_COMMON_ISCSI_NTWK_GET_ALL_IF_ID 24
247 #define OPCODE_COMMON_ISCSI_NTWK_GET_IF_INFO 25
248 #define OPCODE_COMMON_ISCSI_SET_FRAGNUM_BITS_FOR_SGL_CRA 61
249 #define OPCODE_COMMON_ISCSI_DEFQ_CREATE 64
250 #define OPCODE_COMMON_ISCSI_DEFQ_DESTROY 65
251 #define OPCODE_COMMON_ISCSI_WRBQ_CREATE 66
252 #define OPCODE_COMMON_ISCSI_WRBQ_DESTROY 67
254 struct be_cmd_req_hdr
{
255 u8 opcode
; /* dword 0 */
256 u8 subsystem
; /* dword 0 */
257 u8 port_number
; /* dword 0 */
258 u8 domain
; /* dword 0 */
259 u32 timeout
; /* dword 1 */
260 u32 request_length
; /* dword 2 */
261 u8 version
; /* dword 3 */
262 u8 rsvd0
[3]; /* dword 3 */
265 struct be_cmd_resp_hdr
{
266 u32 info
; /* dword 0 */
267 u32 status
; /* dword 1 */
268 u32 response_length
; /* dword 2 */
269 u32 actual_resp_len
; /* dword 3 */
281 /**************************
282 * BE Command definitions *
283 **************************/
286 * Pseudo amap definition in which each bit of the actual structure is defined
287 * as a byte - used to calculate offset/shift/mask of each field
289 struct amap_eq_context
{
290 u8 cidx
[13]; /* dword 0 */
291 u8 rsvd0
[3]; /* dword 0 */
292 u8 epidx
[13]; /* dword 0 */
293 u8 valid
; /* dword 0 */
294 u8 rsvd1
; /* dword 0 */
295 u8 size
; /* dword 0 */
296 u8 pidx
[13]; /* dword 1 */
297 u8 rsvd2
[3]; /* dword 1 */
298 u8 pd
[10]; /* dword 1 */
299 u8 count
[3]; /* dword 1 */
300 u8 solevent
; /* dword 1 */
301 u8 stalled
; /* dword 1 */
302 u8 armed
; /* dword 1 */
303 u8 rsvd3
[4]; /* dword 2 */
304 u8 func
[8]; /* dword 2 */
305 u8 rsvd4
; /* dword 2 */
306 u8 delaymult
[10]; /* dword 2 */
307 u8 rsvd5
[2]; /* dword 2 */
308 u8 phase
[2]; /* dword 2 */
309 u8 nodelay
; /* dword 2 */
310 u8 rsvd6
[4]; /* dword 2 */
311 u8 rsvd7
[32]; /* dword 3 */
314 struct be_cmd_req_eq_create
{
315 struct be_cmd_req_hdr hdr
; /* dw[4] */
316 u16 num_pages
; /* sword */
317 u16 rsvd0
; /* sword */
318 u8 context
[sizeof(struct amap_eq_context
) / 8]; /* dw[4] */
319 struct phys_addr pages
[8];
322 struct be_cmd_resp_eq_create
{
323 struct be_cmd_resp_hdr resp_hdr
;
324 u16 eq_id
; /* sword */
325 u16 rsvd0
; /* sword */
331 u32 delay_multiplier
;
334 struct mgmt_chap_format
{
336 u8 intr_chap_name
[256];
338 u8 target_chap_name
[256];
339 u8 target_secret
[16];
340 u16 intr_chap_name_length
;
341 u16 intr_secret_length
;
342 u16 target_chap_name_length
;
343 u16 target_secret_length
;
346 struct mgmt_auth_method_format
{
349 struct mgmt_chap_format chap
;
352 struct be_cmd_req_logout_fw_sess
{
353 struct be_cmd_req_hdr hdr
; /* dw[4] */
354 uint32_t session_handle
;
357 struct be_cmd_resp_logout_fw_sess
{
358 struct be_cmd_resp_hdr hdr
; /* dw[4] */
359 uint32_t session_status
;
360 #define BE_SESS_STATUS_CLOSE 0x20
363 struct mgmt_conn_login_options
{
368 u32 max_recv_datasegment_len_ini
;
369 u32 max_recv_datasegment_len_tgt
;
372 struct mgmt_auth_method_format auth_data
;
375 struct ip_addr_format
{
376 u16 size_of_structure
;
379 #define BEISCSI_IP_TYPE_V4 0x1
380 #define BEISCSI_IP_TYPE_STATIC_V4 0x3
381 #define BEISCSI_IP_TYPE_DHCP_V4 0x5
382 /* type v4 values < type v6 values */
383 #define BEISCSI_IP_TYPE_V6 0x10
384 #define BEISCSI_IP_TYPE_ROUTABLE_V6 0x30
385 #define BEISCSI_IP_TYPE_LINK_LOCAL_V6 0x50
386 #define BEISCSI_IP_TYPE_AUTO_V6 0x90
391 struct mgmt_conn_info
{
392 u32 connection_handle
;
393 u32 connection_status
;
396 u16 dest_port_redirected
;
398 u32 estimated_throughput
;
399 struct ip_addr_format src_ipaddr
;
400 struct ip_addr_format dest_ipaddr
;
401 struct ip_addr_format dest_ipaddr_redirected
;
402 struct mgmt_conn_login_options negotiated_login_options
;
405 struct mgmt_session_login_options
{
407 u8 error_recovery_level
;
409 u32 first_burst_length
;
410 u32 max_burst_length
;
412 u16 max_outstanding_r2t
;
413 u16 default_time2wait
;
414 u16 default_time2retain
;
417 struct mgmt_session_info
{
426 u8 initiator_iscsiname
[224];
427 struct mgmt_session_login_options negotiated_login_options
;
428 struct mgmt_conn_info conn_list
[1];
431 struct be_cmd_get_session_req
{
432 struct be_cmd_req_hdr hdr
;
436 struct be_cmd_get_session_resp
{
437 struct be_cmd_resp_hdr hdr
;
438 struct mgmt_session_info session_info
;
442 u16 size_of_structure
;
446 struct be_cmd_get_boot_target_req
{
447 struct be_cmd_req_hdr hdr
;
450 struct be_cmd_get_boot_target_resp
{
451 struct be_cmd_resp_hdr hdr
;
452 u32 boot_session_count
;
453 u32 boot_session_handle
;
455 * FW returns 0xffffffff if it couldn't establish connection with
456 * configured boot target.
458 #define BE_BOOT_INVALID_SHANDLE 0xffffffff
461 struct be_cmd_reopen_session_req
{
462 struct be_cmd_req_hdr hdr
;
463 #define BE_REOPEN_ALL_SESSIONS 0x00
464 #define BE_REOPEN_BOOT_SESSIONS 0x01
465 #define BE_REOPEN_A_SESSION 0x02
471 struct be_cmd_reopen_session_resp
{
472 struct be_cmd_resp_hdr hdr
;
478 struct be_cmd_mac_query_req
{
479 struct be_cmd_req_hdr hdr
;
485 struct be_cmd_get_mac_resp
{
486 struct be_cmd_resp_hdr hdr
;
490 struct be_ip_addr_subnet_format
{
491 u16 size_of_structure
;
493 u8 ipv6_prefix_length
;
499 struct be_cmd_get_if_info_req
{
500 struct be_cmd_req_hdr hdr
;
505 struct be_cmd_get_if_info_resp
{
506 struct be_cmd_req_hdr hdr
;
511 struct be_ip_addr_subnet_format ip_addr
;
514 struct be_ip_addr_record
{
517 struct be_ip_addr_subnet_format ip_addr
;
521 struct be_ip_addr_record_params
{
522 u32 record_entry_count
;
523 struct be_ip_addr_record ip_record
;
526 struct be_cmd_set_ip_addr_req
{
527 struct be_cmd_req_hdr hdr
;
528 struct be_ip_addr_record_params ip_params
;
532 struct be_cmd_set_dhcp_req
{
533 struct be_cmd_req_hdr hdr
;
540 struct be_cmd_rel_dhcp_req
{
541 struct be_cmd_req_hdr hdr
;
546 struct be_cmd_set_def_gateway_req
{
547 struct be_cmd_req_hdr hdr
;
549 struct ip_addr_format ip_addr
;
552 struct be_cmd_get_def_gateway_req
{
553 struct be_cmd_req_hdr hdr
;
557 struct be_cmd_get_def_gateway_resp
{
558 struct be_cmd_req_hdr hdr
;
559 struct ip_addr_format ip_addr
;
562 #define BEISCSI_VLAN_DISABLE 0xFFFF
563 struct be_cmd_set_vlan_req
{
564 struct be_cmd_req_hdr hdr
;
568 /******************** Create CQ ***************************/
570 * Pseudo amap definition in which each bit of the actual structure is defined
571 * as a byte - used to calculate offset/shift/mask of each field
573 struct amap_cq_context
{
574 u8 cidx
[11]; /* dword 0 */
575 u8 rsvd0
; /* dword 0 */
576 u8 coalescwm
[2]; /* dword 0 */
577 u8 nodelay
; /* dword 0 */
578 u8 epidx
[11]; /* dword 0 */
579 u8 rsvd1
; /* dword 0 */
580 u8 count
[2]; /* dword 0 */
581 u8 valid
; /* dword 0 */
582 u8 solevent
; /* dword 0 */
583 u8 eventable
; /* dword 0 */
584 u8 pidx
[11]; /* dword 1 */
585 u8 rsvd2
; /* dword 1 */
586 u8 pd
[10]; /* dword 1 */
587 u8 eqid
[8]; /* dword 1 */
588 u8 stalled
; /* dword 1 */
589 u8 armed
; /* dword 1 */
590 u8 rsvd3
[4]; /* dword 2 */
591 u8 func
[8]; /* dword 2 */
592 u8 rsvd4
[20]; /* dword 2 */
593 u8 rsvd5
[32]; /* dword 3 */
596 struct amap_cq_context_v2
{
597 u8 rsvd0
[12]; /* dword 0 */
598 u8 coalescwm
[2]; /* dword 0 */
599 u8 nodelay
; /* dword 0 */
600 u8 rsvd1
[12]; /* dword 0 */
601 u8 count
[2]; /* dword 0 */
602 u8 valid
; /* dword 0 */
603 u8 rsvd2
; /* dword 0 */
604 u8 eventable
; /* dword 0 */
605 u8 eqid
[16]; /* dword 1 */
606 u8 rsvd3
[15]; /* dword 1 */
607 u8 armed
; /* dword 1 */
608 u8 cqecount
[16];/* dword 2 */
609 u8 rsvd4
[16]; /* dword 2 */
610 u8 rsvd5
[32]; /* dword 3 */
613 struct be_cmd_req_cq_create
{
614 struct be_cmd_req_hdr hdr
;
618 u8 context
[sizeof(struct amap_cq_context
) / 8];
619 struct phys_addr pages
[4];
622 struct be_cmd_resp_cq_create
{
623 struct be_cmd_resp_hdr hdr
;
628 /******************** Create MCCQ ***************************/
630 * Pseudo amap definition in which each bit of the actual structure is defined
631 * as a byte - used to calculate offset/shift/mask of each field
633 struct amap_mcc_context
{
648 struct be_cmd_req_mcc_create_ext
{
649 struct be_cmd_req_hdr hdr
;
652 u32 async_evt_bitmap
;
653 u8 context
[sizeof(struct amap_mcc_context
) / 8];
654 struct phys_addr pages
[8];
657 struct be_cmd_resp_mcc_create
{
658 struct be_cmd_resp_hdr hdr
;
663 /******************** Q Destroy ***************************/
664 /* Type of Queue to be destroyed */
674 struct be_cmd_req_q_destroy
{
675 struct be_cmd_req_hdr hdr
;
677 u16 bypass_flush
; /* valid only for rx q destroy */
684 struct be_cmd_req_mcast_mac_config
{
685 struct be_cmd_req_hdr hdr
;
689 struct macaddr mac
[32];
692 static inline void *embedded_payload(struct be_mcc_wrb
*wrb
)
694 return wrb
->payload
.embedded_payload
;
697 static inline struct be_sge
*nonembedded_sgl(struct be_mcc_wrb
*wrb
)
699 return &wrb
->payload
.sgl
[0];
702 /******************** Modify EQ Delay *******************/
703 struct be_cmd_req_modify_eq_delay
{
704 struct be_cmd_req_hdr hdr
;
709 __le32 delay_multiplier
;
713 /******************** Get MAC ADDR *******************/
715 struct be_cmd_get_nic_conf_resp
{
716 struct be_cmd_resp_hdr hdr
;
722 u16 size_of_structure
;
723 u8 mac_address
[ETH_ALEN
];
726 /******************** Get HBA NAME *******************/
728 struct be_cmd_hba_name
{
729 struct be_cmd_req_hdr hdr
;
732 u8 initiator_name
[ISCSI_NAME_LEN
];
733 #define BE_INI_ALIAS_LEN 32
734 u8 initiator_alias
[BE_INI_ALIAS_LEN
];
737 /******************** COMMON SET Features *******************/
738 #define BE_CMD_SET_FEATURE_UER 0x10
739 #define BE_CMD_UER_SUPP_BIT 0x1
751 struct be_cmd_set_features
{
753 struct be_cmd_req_hdr req_hdr
;
754 struct be_cmd_resp_hdr resp_hdr
;
759 struct be_uer_req req
;
760 struct be_uer_resp resp
;
765 int beiscsi_cmd_function_reset(struct beiscsi_hba
*phba
);
767 int beiscsi_cmd_special_wrb(struct be_ctrl_info
*ctrl
, u32 load
);
769 int beiscsi_check_fw_rdy(struct beiscsi_hba
*phba
);
771 int beiscsi_init_sliport(struct beiscsi_hba
*phba
);
773 int beiscsi_cmd_iscsi_cleanup(struct beiscsi_hba
*phba
, unsigned short ulp_num
);
775 int beiscsi_detect_ue(struct beiscsi_hba
*phba
);
777 int beiscsi_detect_tpe(struct beiscsi_hba
*phba
);
779 int beiscsi_cmd_eq_create(struct be_ctrl_info
*ctrl
,
780 struct be_queue_info
*eq
, int eq_delay
);
782 int beiscsi_cmd_cq_create(struct be_ctrl_info
*ctrl
,
783 struct be_queue_info
*cq
, struct be_queue_info
*eq
,
784 bool sol_evts
, bool no_delay
,
785 int num_cqe_dma_coalesce
);
787 int beiscsi_cmd_q_destroy(struct be_ctrl_info
*ctrl
, struct be_queue_info
*q
,
789 int beiscsi_cmd_mccq_create(struct beiscsi_hba
*phba
,
790 struct be_queue_info
*mccq
,
791 struct be_queue_info
*cq
);
793 unsigned int be_cmd_get_initname(struct beiscsi_hba
*phba
);
795 void free_mcc_wrb(struct be_ctrl_info
*ctrl
, unsigned int tag
);
797 int beiscsi_modify_eq_delay(struct beiscsi_hba
*phba
, struct be_set_eqd
*,
799 int beiscsi_mccq_compl_wait(struct beiscsi_hba
*phba
,
801 struct be_mcc_wrb
**wrb
,
802 struct be_dma_mem
*mbx_cmd_mem
);
803 int __beiscsi_mcc_compl_status(struct beiscsi_hba
*phba
,
805 struct be_mcc_wrb
**wrb
,
806 struct be_dma_mem
*mbx_cmd_mem
);
807 struct be_mcc_wrb
*wrb_from_mbox(struct be_dma_mem
*mbox_mem
);
808 void be_mcc_notify(struct beiscsi_hba
*phba
, unsigned int tag
);
809 struct be_mcc_wrb
*alloc_mcc_wrb(struct beiscsi_hba
*phba
,
810 unsigned int *ref_tag
);
811 void beiscsi_process_async_event(struct beiscsi_hba
*phba
,
812 struct be_mcc_compl
*compl);
813 int beiscsi_process_mcc_compl(struct be_ctrl_info
*ctrl
,
814 struct be_mcc_compl
*compl);
816 int be_cmd_create_default_pdu_queue(struct be_ctrl_info
*ctrl
,
817 struct be_queue_info
*cq
,
818 struct be_queue_info
*dq
, int length
,
819 int entry_size
, uint8_t is_header
,
822 int be_cmd_iscsi_post_template_hdr(struct be_ctrl_info
*ctrl
,
823 struct be_dma_mem
*q_mem
);
825 int be_cmd_iscsi_remove_template_hdr(struct be_ctrl_info
*ctrl
);
827 int be_cmd_iscsi_post_sgl_pages(struct be_ctrl_info
*ctrl
,
828 struct be_dma_mem
*q_mem
, u32 page_offset
,
831 int be_cmd_wrbq_create(struct be_ctrl_info
*ctrl
, struct be_dma_mem
*q_mem
,
832 struct be_queue_info
*wrbq
,
833 struct hwi_wrb_context
*pwrb_context
,
836 /* Configuration Functions */
837 int be_cmd_set_vlan(struct beiscsi_hba
*phba
, uint16_t vlan_tag
);
839 int beiscsi_check_supported_fw(struct be_ctrl_info
*ctrl
,
840 struct beiscsi_hba
*phba
);
842 int beiscsi_get_fw_config(struct be_ctrl_info
*ctrl
, struct beiscsi_hba
*phba
);
844 int beiscsi_get_port_name(struct be_ctrl_info
*ctrl
, struct beiscsi_hba
*phba
);
846 int beiscsi_set_uer_feature(struct beiscsi_hba
*phba
);
848 struct be_default_pdu_context
{
852 struct amap_be_default_pdu_context
{
853 u8 dbuf_cindex
[13]; /* dword 0 */
854 u8 rsvd0
[3]; /* dword 0 */
855 u8 ring_size
[4]; /* dword 0 */
856 u8 ring_state
[4]; /* dword 0 */
857 u8 rsvd1
[8]; /* dword 0 */
858 u8 dbuf_pindex
[13]; /* dword 1 */
859 u8 rsvd2
; /* dword 1 */
860 u8 pci_func_id
[8]; /* dword 1 */
861 u8 rx_pdid
[9]; /* dword 1 */
862 u8 rx_pdid_valid
; /* dword 1 */
863 u8 default_buffer_size
[16]; /* dword 2 */
864 u8 cq_id_recv
[10]; /* dword 2 */
865 u8 rx_pdid_not_valid
; /* dword 2 */
866 u8 rsvd3
[5]; /* dword 2 */
867 u8 rsvd4
[32]; /* dword 3 */
870 struct amap_default_pdu_context_ext
{
871 u8 rsvd0
[16]; /* dword 0 */
872 u8 ring_size
[4]; /* dword 0 */
873 u8 rsvd1
[12]; /* dword 0 */
874 u8 rsvd2
[22]; /* dword 1 */
875 u8 rx_pdid
[9]; /* dword 1 */
876 u8 rx_pdid_valid
; /* dword 1 */
877 u8 default_buffer_size
[16]; /* dword 2 */
878 u8 cq_id_recv
[16]; /* dword 2 */
879 u8 rsvd3
[32]; /* dword 3 */
882 struct be_defq_create_req
{
883 struct be_cmd_req_hdr hdr
;
886 #define BEISCSI_DUAL_ULP_AWARE_BIT 0 /* Byte 3 - Bit 0 */
887 #define BEISCSI_BIND_Q_TO_ULP_BIT 1 /* Byte 3 - Bit 1 */
889 struct be_default_pdu_context context
;
890 struct phys_addr pages
[8];
893 struct be_defq_create_resp
{
894 struct be_cmd_req_hdr hdr
;
903 struct be_post_template_pages_req
{
904 struct be_cmd_req_hdr hdr
;
906 #define BEISCSI_TEMPLATE_HDR_TYPE_ISCSI 0x1
908 struct phys_addr scratch_pa
;
909 struct virt_addr scratch_va
;
910 struct virt_addr pages_va
;
911 struct phys_addr pages
[16];
914 struct be_remove_template_pages_req
{
915 struct be_cmd_req_hdr hdr
;
920 struct be_post_sgl_pages_req
{
921 struct be_cmd_req_hdr hdr
;
925 struct phys_addr pages
[26];
929 struct be_wrbq_create_req
{
930 struct be_cmd_req_hdr hdr
;
934 struct phys_addr pages
[8];
937 struct be_wrbq_create_resp
{
938 struct be_cmd_resp_hdr resp_hdr
;
947 #define SOL_CID_MASK 0x0000FFC0
948 #define SOL_CODE_MASK 0x0000003F
949 #define SOL_WRB_INDEX_MASK 0x00FF0000
950 #define SOL_CMD_WND_MASK 0xFF000000
951 #define SOL_RES_CNT_MASK 0x7FFFFFFF
952 #define SOL_EXP_CMD_SN_MASK 0xFFFFFFFF
953 #define SOL_HW_STS_MASK 0x000000FF
954 #define SOL_STS_MASK 0x0000FF00
955 #define SOL_RESP_MASK 0x00FF0000
956 #define SOL_FLAGS_MASK 0x7F000000
957 #define SOL_S_MASK 0x80000000
963 struct amap_sol_cqe
{
964 u8 hw_sts
[8]; /* dword 0 */
965 u8 i_sts
[8]; /* dword 0 */
966 u8 i_resp
[8]; /* dword 0 */
967 u8 i_flags
[7]; /* dword 0 */
969 u8 i_exp_cmd_sn
[32]; /* dword 1 */
970 u8 code
[6]; /* dword 2 */
971 u8 cid
[10]; /* dword 2 */
972 u8 wrb_index
[8]; /* dword 2 */
973 u8 i_cmd_wnd
[8]; /* dword 2 */
974 u8 i_res_cnt
[31]; /* dword 3 */
975 u8 valid
; /* dword 3 */
978 #define SOL_ICD_INDEX_MASK 0x0003FFC0
979 struct amap_sol_cqe_ring
{
980 u8 hw_sts
[8]; /* dword 0 */
981 u8 i_sts
[8]; /* dword 0 */
982 u8 i_resp
[8]; /* dword 0 */
983 u8 i_flags
[7]; /* dword 0 */
985 u8 i_exp_cmd_sn
[32]; /* dword 1 */
986 u8 code
[6]; /* dword 2 */
987 u8 icd_index
[12]; /* dword 2 */
988 u8 rsvd
[6]; /* dword 2 */
989 u8 i_cmd_wnd
[8]; /* dword 2 */
990 u8 i_res_cnt
[31]; /* dword 3 */
991 u8 valid
; /* dword 3 */
994 struct amap_sol_cqe_v2
{
995 u8 hw_sts
[8]; /* dword 0 */
996 u8 i_sts
[8]; /* dword 0 */
997 u8 wrb_index
[16]; /* dword 0 */
998 u8 i_exp_cmd_sn
[32]; /* dword 1 */
999 u8 code
[6]; /* dword 2 */
1000 u8 cmd_cmpl
; /* dword 2 */
1001 u8 rsvd0
; /* dword 2 */
1002 u8 i_cmd_wnd
[8]; /* dword 2 */
1003 u8 cid
[13]; /* dword 2 */
1007 u8 i_res_cnt
[31]; /* dword 3 */
1008 u8 valid
; /* dword 3 */
1011 struct common_sol_cqe
{
1018 u8 res_flag
; /* the s feild of structure */
1019 u8 i_resp
; /* for skh if cmd_complete is set then i_sts is response */
1020 u8 i_flags
; /* for skh or the u and o feilds */
1021 u8 i_sts
; /* for skh if cmd_complete is not-set then i_sts is status */
1024 /*** iSCSI ack/driver message completions ***/
1025 struct amap_it_dmsg_cqe
{
1026 u8 ack_num
[32]; /* DWORD 0 */
1027 u8 pdu_bytes_rcvd
[32]; /* DWORD 1 */
1028 u8 code
[6]; /* DWORD 2 */
1029 u8 cid
[10]; /* DWORD 2 */
1030 u8 wrb_idx
[8]; /* DWORD 2 */
1031 u8 rsvd0
[8]; /* DWORD 2*/
1032 u8 rsvd1
[31]; /* DWORD 3*/
1033 u8 valid
; /* DWORD 3 */
1036 struct amap_it_dmsg_cqe_v2
{
1037 u8 ack_num
[32]; /* DWORD 0 */
1038 u8 pdu_bytes_rcvd
[32]; /* DWORD 1 */
1039 u8 code
[6]; /* DWORD 2 */
1040 u8 rsvd0
[10]; /* DWORD 2 */
1041 u8 wrb_idx
[16]; /* DWORD 2 */
1042 u8 rsvd1
[16]; /* DWORD 3 */
1043 u8 cid
[13]; /* DWORD 3 */
1044 u8 rsvd2
[2]; /* DWORD 3 */
1045 u8 valid
; /* DWORD 3 */
1050 * Post WRB Queue Doorbell Register used by the host Storage
1051 * stack to notify the
1052 * controller of a posted Work Request Block
1054 #define DB_WRB_POST_CID_MASK 0xFFFF /* bits 0 - 16 */
1055 #define DB_DEF_PDU_WRB_INDEX_MASK 0xFF /* bits 0 - 9 */
1057 #define DB_DEF_PDU_WRB_INDEX_SHIFT 16
1058 #define DB_DEF_PDU_NUM_POSTED_SHIFT 24
1060 struct fragnum_bits_for_sgl_cra_in
{
1061 struct be_cmd_req_hdr hdr
;
1065 struct iscsi_cleanup_req
{
1066 struct be_cmd_req_hdr hdr
;
1072 struct iscsi_cleanup_req_v1
{
1073 struct be_cmd_req_hdr hdr
;
1085 u32 delay_multiplier
;
1088 struct be_eq_delay_params_in
{
1089 struct be_cmd_req_hdr hdr
;
1091 struct eq_delay delay
[8];
1094 struct tcp_connect_and_offload_in
{
1095 struct be_cmd_req_hdr hdr
;
1096 struct ip_addr_format ip_address
;
1101 struct phys_addr dataout_template_pa
;
1108 struct tcp_connect_and_offload_in_v1
{
1109 struct be_cmd_req_hdr hdr
;
1110 struct ip_addr_format ip_address
;
1115 struct phys_addr dataout_template_pa
;
1121 u16 tcp_window_size
;
1122 u8 tcp_window_scale_count
;
1128 struct tcp_connect_and_offload_out
{
1129 struct be_cmd_resp_hdr hdr
;
1130 u32 connection_handle
;
1136 struct be_mcc_wrb_context
{
1137 struct MCC_WRB
*wrb
;
1138 int *users_final_status
;
1141 #define DB_DEF_PDU_RING_ID_MASK 0x3FFF /* bits 0 - 13 */
1142 #define DB_DEF_PDU_CQPROC_MASK 0x3FFF /* bits 16 - 29 */
1143 #define DB_DEF_PDU_REARM_SHIFT 14
1144 #define DB_DEF_PDU_EVENT_SHIFT 15
1145 #define DB_DEF_PDU_CQPROC_SHIFT 16
1151 struct tcp_upload_params_in
{
1152 struct be_cmd_req_hdr hdr
;
1158 struct tcp_upload_params_out
{
1162 union tcp_upload_params
{
1163 struct tcp_upload_params_in request
;
1164 struct tcp_upload_params_out response
;
1167 struct be_ulp_fw_cfg
{
1168 #define BEISCSI_ULP_ISCSI_INI_MODE 0x10
1184 struct be_ulp_chain_icd
{
1190 struct be_cmd_req_hdr hdr
;
1191 u32 be_config_number
;
1194 #define BEISCSI_FUNC_ISCSI_INI_MODE 0x10
1195 #define BEISCSI_FUNC_DUA_MODE 0x800
1197 struct be_ulp_fw_cfg ulp
[2];
1203 struct be_ulp_chain_icd chain_icd
[2];
1206 struct be_cmd_get_all_if_id_req
{
1207 struct be_cmd_req_hdr hdr
;
1209 u32 if_hndl_list
[1];
1212 struct be_cmd_get_port_name
{
1214 struct be_cmd_req_hdr req_hdr
;
1215 struct be_cmd_resp_hdr resp_hdr
;
1227 #define ISCSI_OPCODE_SCSI_DATA_OUT 5
1228 #define OPCODE_COMMON_NTWK_LINK_STATUS_QUERY 5
1229 #define OPCODE_COMMON_MODIFY_EQ_DELAY 41
1230 #define OPCODE_COMMON_ISCSI_CLEANUP 59
1231 #define OPCODE_COMMON_TCP_UPLOAD 56
1232 #define OPCODE_COMMON_ISCSI_TCP_CONNECT_AND_OFFLOAD 70
1233 #define OPCODE_COMMON_ISCSI_ERROR_RECOVERY_INVALIDATE_COMMANDS 1
1234 #define OPCODE_ISCSI_INI_CFG_GET_HBA_NAME 6
1235 #define OPCODE_ISCSI_INI_CFG_SET_HBA_NAME 7
1236 #define OPCODE_ISCSI_INI_SESSION_GET_A_SESSION 14
1237 #define OPCODE_ISCSI_INI_SESSION_LOGOUT_TARGET 24
1238 #define OPCODE_ISCSI_INI_DRIVER_REOPEN_ALL_SESSIONS 36
1239 #define OPCODE_ISCSI_INI_DRIVER_OFFLOAD_SESSION 41
1240 #define OPCODE_ISCSI_INI_DRIVER_INVALIDATE_CONNECTION 42
1241 #define OPCODE_ISCSI_INI_BOOT_GET_BOOT_TARGET 52
1242 #define OPCODE_COMMON_WRITE_FLASH 96
1243 #define OPCODE_COMMON_READ_FLASH 97
1245 /* --- CMD_ISCSI_INVALIDATE_CONNECTION_TYPE --- */
1246 #define CMD_ISCSI_COMMAND_INVALIDATE 1
1247 #define CMD_ISCSI_CONNECTION_INVALIDATE 0x8001
1248 #define CMD_ISCSI_CONNECTION_ISSUE_TCP_RST 0x8002
1250 #define INI_WR_CMD 1 /* Initiator write command */
1251 #define INI_TMF_CMD 2 /* Initiator TMF command */
1252 #define INI_NOPOUT_CMD 3 /* Initiator; Send a NOP-OUT */
1253 #define INI_RD_CMD 5 /* Initiator requesting to send
1256 #define TGT_CTX_UPDT_CMD 7 /* Target context update */
1257 #define TGT_STS_CMD 8 /* Target R2T and other BHS
1258 * where only the status number
1259 * need to be updated
1261 #define TGT_DATAIN_CMD 9 /* Target Data-Ins in response
1264 #define TGT_SOS_PDU 10 /* Target:standalone status
1267 #define TGT_DM_CMD 11 /* Indicates that the bhs
1269 * driver should not be touched
1271 /* --- CMD_CHUTE_TYPE --- */
1272 #define CMD_CONNECTION_CHUTE_0 1
1273 #define CMD_CONNECTION_CHUTE_1 2
1274 #define CMD_CONNECTION_CHUTE_2 3
1276 #define EQ_MAJOR_CODE_COMPLETION 0
1278 #define CMD_ISCSI_SESSION_DEL_CFG_FROM_FLASH 0
1279 #define CMD_ISCSI_SESSION_SAVE_CFG_ON_FLASH 1
1281 /* --- CONNECTION_UPLOAD_PARAMS --- */
1282 /* These parameters are used to define the type of upload desired. */
1283 #define CONNECTION_UPLOAD_GRACEFUL 1 /* Graceful upload */
1284 #define CONNECTION_UPLOAD_ABORT_RESET 2 /* Abortive upload with
1287 #define CONNECTION_UPLOAD_ABORT 3 /* Abortive upload without
1290 #define CONNECTION_UPLOAD_ABORT_WITH_SEQ 4 /* Abortive upload with reset,
1291 * sequence number by driver */
1293 /* Returns the number of items in the field array. */
1294 #define BE_NUMBER_OF_FIELD(_type_, _field_) \
1295 (FIELD_SIZEOF(_type_, _field_)/sizeof((((_type_ *)0)->_field_[0])))\
1298 * Different types of iSCSI completions to host driver for both initiator
1302 #define SOL_CMD_COMPLETE 1 /* Solicited command completed
1305 #define SOL_CMD_KILLED_DATA_DIGEST_ERR 2 /* Solicited command got
1306 * invalidated internally due
1307 * to Data Digest error
1309 #define CXN_KILLED_PDU_SIZE_EXCEEDS_DSL 3 /* Connection got invalidated
1311 * due to a received PDU
1314 #define CXN_KILLED_BURST_LEN_MISMATCH 4 /* Connection got invalidated
1315 * internally due ti received
1316 * PDU sequence size >
1319 #define CXN_KILLED_AHS_RCVD 5 /* Connection got invalidated
1320 * internally due to a received
1323 #define CXN_KILLED_HDR_DIGEST_ERR 6 /* Connection got invalidated
1324 * internally due to Hdr Digest
1327 #define CXN_KILLED_UNKNOWN_HDR 7 /* Connection got invalidated
1329 * due to a bad opcode in the
1332 #define CXN_KILLED_STALE_ITT_TTT_RCVD 8 /* Connection got invalidated
1333 * internally due to a received
1334 * ITT/TTT that does not belong
1335 * to this Connection
1337 #define CXN_KILLED_INVALID_ITT_TTT_RCVD 9 /* Connection got invalidated
1338 * internally due to received
1339 * ITT/TTT value > Max
1340 * Supported ITTs/TTTs
1342 #define CXN_KILLED_RST_RCVD 10 /* Connection got invalidated
1343 * internally due to an
1346 #define CXN_KILLED_TIMED_OUT 11 /* Connection got invalidated
1347 * internally due to timeout on
1348 * tcp segment 12 retransmit
1351 #define CXN_KILLED_RST_SENT 12 /* Connection got invalidated
1352 * internally due to TCP RST
1353 * sent by the Tx side
1355 #define CXN_KILLED_FIN_RCVD 13 /* Connection got invalidated
1356 * internally due to an
1359 #define CXN_KILLED_BAD_UNSOL_PDU_RCVD 14 /* Connection got invalidated
1360 * internally due to bad
1361 * unsolicited PDU Unsolicited
1362 * PDUs are PDUs with
1365 #define CXN_KILLED_BAD_WRB_INDEX_ERROR 15 /* Connection got invalidated
1366 * internally due to bad WRB
1369 #define CXN_KILLED_OVER_RUN_RESIDUAL 16 /* Command got invalidated
1370 * internally due to received
1371 * command has residual
1374 #define CXN_KILLED_UNDER_RUN_RESIDUAL 17 /* Command got invalidated
1375 * internally due to received
1376 * command has residual under
1379 #define CMD_KILLED_INVALID_STATSN_RCVD 18 /* Command got invalidated
1380 * internally due to a received
1381 * PDU has an invalid StatusSN
1383 #define CMD_KILLED_INVALID_R2T_RCVD 19 /* Command got invalidated
1384 * internally due to a received
1385 * an R2T with some invalid
1388 #define CMD_CXN_KILLED_LUN_INVALID 20 /* Command got invalidated
1389 * internally due to received
1390 * PDU has an invalid LUN.
1392 #define CMD_CXN_KILLED_ICD_INVALID 21 /* Command got invalidated
1393 * internally due to the
1394 * corresponding ICD not in a
1397 #define CMD_CXN_KILLED_ITT_INVALID 22 /* Command got invalidated due
1398 * to received PDU has an
1401 #define CMD_CXN_KILLED_SEQ_OUTOFORDER 23 /* Command got invalidated due
1402 * to received sequence buffer
1403 * offset is out of order.
1405 #define CMD_CXN_KILLED_INVALID_DATASN_RCVD 24 /* Command got invalidated
1406 * internally due to a
1407 * received PDU has an invalid
1410 #define CXN_INVALIDATE_NOTIFY 25 /* Connection invalidation
1411 * completion notify.
1413 #define CXN_INVALIDATE_INDEX_NOTIFY 26 /* Connection invalidation
1415 * with data PDU index.
1417 #define CMD_INVALIDATED_NOTIFY 27 /* Command invalidation
1418 * completionnotifify.
1420 #define UNSOL_HDR_NOTIFY 28 /* Unsolicited header notify.*/
1421 #define UNSOL_DATA_NOTIFY 29 /* Unsolicited data notify.*/
1422 #define UNSOL_DATA_DIGEST_ERROR_NOTIFY 30 /* Unsolicited data digest
1425 #define DRIVERMSG_NOTIFY 31 /* TCP acknowledge based
1428 #define CXN_KILLED_CMND_DATA_NOT_ON_SAME_CONN 32 /* Connection got invalidated
1429 * internally due to command
1430 * and data are not on same
1433 #define SOL_CMD_KILLED_DIF_ERR 33 /* Solicited command got
1434 * invalidated internally due
1437 #define CXN_KILLED_SYN_RCVD 34 /* Connection got invalidated
1438 * internally due to incoming
1441 #define CXN_KILLED_IMM_DATA_RCVD 35 /* Connection got invalidated
1442 * internally due to an
1443 * incoming Unsolicited PDU
1444 * that has immediate data on
1448 void be_wrb_hdr_prepare(struct be_mcc_wrb
*wrb
, int payload_len
,
1449 bool embedded
, u8 sge_cnt
);
1451 void be_cmd_hdr_prepare(struct be_cmd_req_hdr
*req_hdr
,
1452 u8 subsystem
, u8 opcode
, int cmd_len
);
1453 #endif /* !BEISCSI_CMDS_H */