lpfc_scsi.h revision ea2151b4e142fa2de0319d9dd80413a997bf435a 
1/*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for         *
3 * Fibre Channel Host Bus Adapters.                                *
4 * Copyright (C) 2004-2006 Emulex.  All rights reserved.           *
5 * EMULEX and SLI are trademarks of Emulex.                        *
6 * www.emulex.com                                                  *
7 *                                                                 *
8 * This program is free software; you can redistribute it and/or   *
9 * modify it under the terms of version 2 of the GNU General       *
10 * Public License as published by the Free Software Foundation.    *
11 * This program is distributed in the hope that it will be useful. *
12 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
13 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
14 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
15 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
16 * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
17 * more details, a copy of which can be found in the file COPYING  *
18 * included with this package.                                     *
19 *******************************************************************/
20
21#include <asm/byteorder.h>
22
23struct lpfc_hba;
24
25#define list_remove_head(list, entry, type, member)		\
26	do {							\
27	entry = NULL;						\
28	if (!list_empty(list)) {				\
29		entry = list_entry((list)->next, type, member);	\
30		list_del_init(&entry->member);			\
31	}							\
32	} while(0)
33
34#define list_get_first(list, type, member)			\
35	(list_empty(list)) ? NULL :				\
36	list_entry((list)->next, type, member)
37
38/* per-port data that is allocated in the FC transport for us */
39struct lpfc_rport_data {
40	struct lpfc_nodelist *pnode;	/* Pointer to the node structure. */
41};
42
43struct fcp_rsp {
44	uint32_t rspRsvd1;	/* FC Word 0, byte 0:3 */
45	uint32_t rspRsvd2;	/* FC Word 1, byte 0:3 */
46
47	uint8_t rspStatus0;	/* FCP_STATUS byte 0 (reserved) */
48	uint8_t rspStatus1;	/* FCP_STATUS byte 1 (reserved) */
49	uint8_t rspStatus2;	/* FCP_STATUS byte 2 field validity */
50#define RSP_LEN_VALID  0x01	/* bit 0 */
51#define SNS_LEN_VALID  0x02	/* bit 1 */
52#define RESID_OVER     0x04	/* bit 2 */
53#define RESID_UNDER    0x08	/* bit 3 */
54	uint8_t rspStatus3;	/* FCP_STATUS byte 3 SCSI status byte */
55
56	uint32_t rspResId;	/* Residual xfer if residual count field set in
57				   fcpStatus2 */
58	/* Received in Big Endian format */
59	uint32_t rspSnsLen;	/* Length of sense data in fcpSnsInfo */
60	/* Received in Big Endian format */
61	uint32_t rspRspLen;	/* Length of FCP response data in fcpRspInfo */
62	/* Received in Big Endian format */
63
64	uint8_t rspInfo0;	/* FCP_RSP_INFO byte 0 (reserved) */
65	uint8_t rspInfo1;	/* FCP_RSP_INFO byte 1 (reserved) */
66	uint8_t rspInfo2;	/* FCP_RSP_INFO byte 2 (reserved) */
67	uint8_t rspInfo3;	/* FCP_RSP_INFO RSP_CODE byte 3 */
68
69#define RSP_NO_FAILURE       0x00
70#define RSP_DATA_BURST_ERR   0x01
71#define RSP_CMD_FIELD_ERR    0x02
72#define RSP_RO_MISMATCH_ERR  0x03
73#define RSP_TM_NOT_SUPPORTED 0x04	/* Task mgmt function not supported */
74#define RSP_TM_NOT_COMPLETED 0x05	/* Task mgmt function not performed */
75
76	uint32_t rspInfoRsvd;	/* FCP_RSP_INFO bytes 4-7 (reserved) */
77
78	uint8_t rspSnsInfo[128];
79#define SNS_ILLEGAL_REQ 0x05	/* sense key is byte 3 ([2]) */
80#define SNSCOD_BADCMD 0x20	/* sense code is byte 13 ([12]) */
81};
82
83struct fcp_cmnd {
84	struct scsi_lun  fcp_lun;
85
86	uint8_t fcpCntl0;	/* FCP_CNTL byte 0 (reserved) */
87	uint8_t fcpCntl1;	/* FCP_CNTL byte 1 task codes */
88#define  SIMPLE_Q        0x00
89#define  HEAD_OF_Q       0x01
90#define  ORDERED_Q       0x02
91#define  ACA_Q           0x04
92#define  UNTAGGED        0x05
93	uint8_t fcpCntl2;	/* FCP_CTL byte 2 task management codes */
94#define  FCP_ABORT_TASK_SET  0x02	/* Bit 1 */
95#define  FCP_CLEAR_TASK_SET  0x04	/* bit 2 */
96#define  FCP_BUS_RESET       0x08	/* bit 3 */
97#define  FCP_LUN_RESET       0x10	/* bit 4 */
98#define  FCP_TARGET_RESET    0x20	/* bit 5 */
99#define  FCP_CLEAR_ACA       0x40	/* bit 6 */
100#define  FCP_TERMINATE_TASK  0x80	/* bit 7 */
101	uint8_t fcpCntl3;
102#define  WRITE_DATA      0x01	/* Bit 0 */
103#define  READ_DATA       0x02	/* Bit 1 */
104
105	uint8_t fcpCdb[16];	/* SRB cdb field is copied here */
106	uint32_t fcpDl;		/* Total transfer length */
107
108};
109
110struct lpfc_scsicmd_bkt {
111	uint32_t cmd_count;
112};
113
114struct lpfc_scsi_buf {
115	struct list_head list;
116	struct scsi_cmnd *pCmd;
117	struct lpfc_rport_data *rdata;
118
119	uint32_t timeout;
120
121	uint16_t status;	/* From IOCB Word 7- ulpStatus */
122	uint32_t result;	/* From IOCB Word 4. */
123
124	uint32_t   seg_cnt;	/* Number of scatter-gather segments returned by
125				 * dma_map_sg.  The driver needs this for calls
126				 * to dma_unmap_sg. */
127	dma_addr_t nonsg_phys;	/* Non scatter-gather physical address. */
128
129	/*
130	 * data and dma_handle are the kernel virutal and bus address of the
131	 * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
132	 * gather bde list that supports the sg_tablesize value.
133	 */
134	void *data;
135	dma_addr_t dma_handle;
136
137	struct fcp_cmnd *fcp_cmnd;
138	struct fcp_rsp *fcp_rsp;
139	struct ulp_bde64 *fcp_bpl;
140
141	/* cur_iocbq has phys of the dma-able buffer.
142	 * Iotag is in here
143	 */
144	struct lpfc_iocbq cur_iocbq;
145	wait_queue_head_t *waitq;
146	unsigned long start_time;
147};
148
149#define LPFC_SCSI_DMA_EXT_SIZE 264
150#define LPFC_BPL_SIZE          1024
151
152#define MDAC_DIRECT_CMD                  0x22
153