Home | History | Annotate | Line # | Download | only in ic
ispmbox.h revision 1.32
      1 /* $NetBSD: ispmbox.h,v 1.32 2001/04/05 02:28:53 mjacob Exp $ */
      2 /*
      3  * This driver, which is contained in NetBSD in the files:
      4  *
      5  *	sys/dev/ic/isp.c
      6  *	sys/dev/ic/isp_inline.h
      7  *	sys/dev/ic/isp_netbsd.c
      8  *	sys/dev/ic/isp_netbsd.h
      9  *	sys/dev/ic/isp_target.c
     10  *	sys/dev/ic/isp_target.h
     11  *	sys/dev/ic/isp_tpublic.h
     12  *	sys/dev/ic/ispmbox.h
     13  *	sys/dev/ic/ispreg.h
     14  *	sys/dev/ic/ispvar.h
     15  *	sys/microcode/isp/asm_sbus.h
     16  *	sys/microcode/isp/asm_1040.h
     17  *	sys/microcode/isp/asm_1080.h
     18  *	sys/microcode/isp/asm_12160.h
     19  *	sys/microcode/isp/asm_2100.h
     20  *	sys/microcode/isp/asm_2200.h
     21  *	sys/pci/isp_pci.c
     22  *	sys/sbus/isp_sbus.c
     23  *
     24  * Is being actively maintained by Matthew Jacob (mjacob (at) netbsd.org).
     25  * This driver also is shared source with FreeBSD, OpenBSD, Linux, Solaris,
     26  * Linux versions. This tends to be an interesting maintenance problem.
     27  *
     28  * Please coordinate with Matthew Jacob on changes you wish to make here.
     29  */
     30 /*
     31  * Copyright (C) 1997, 1998, 1999 National Aeronautics & Space Administration
     32  * All rights reserved.
     33  *
     34  * Redistribution and use in source and binary forms, with or without
     35  * modification, are permitted provided that the following conditions
     36  * are met:
     37  * 1. Redistributions of source code must retain the above copyright
     38  *    notice, this list of conditions and the following disclaimer.
     39  * 2. Redistributions in binary form must reproduce the above copyright
     40  *    notice, this list of conditions and the following disclaimer in the
     41  *    documentation and/or other materials provided with the distribution.
     42  * 3. The name of the author may not be used to endorse or promote products
     43  *    derived from this software without specific prior written permission
     44  *
     45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     55  */
     56 
     57 /*
     58  * Mailbox and Queue Entry Definitions for for Qlogic ISP SCSI adapters.
     59  * <mjacob (at) nas.nasa.gov>
     60  */
     61 #ifndef	_ISPMBOX_H
     62 #define	_ISPMBOX_H
     63 
     64 /*
     65  * Mailbox Command Opcodes
     66  */
     67 
     68 #define MBOX_NO_OP			0x0000
     69 #define MBOX_LOAD_RAM			0x0001
     70 #define MBOX_EXEC_FIRMWARE		0x0002
     71 #define MBOX_DUMP_RAM			0x0003
     72 #define MBOX_WRITE_RAM_WORD		0x0004
     73 #define MBOX_READ_RAM_WORD		0x0005
     74 #define MBOX_MAILBOX_REG_TEST		0x0006
     75 #define MBOX_VERIFY_CHECKSUM		0x0007
     76 #define MBOX_ABOUT_FIRMWARE		0x0008
     77 					/*   9 */
     78 					/*   a */
     79 					/*   b */
     80 					/*   c */
     81 					/*   d */
     82 #define MBOX_CHECK_FIRMWARE		0x000e
     83 					/*   f */
     84 #define MBOX_INIT_REQ_QUEUE		0x0010
     85 #define MBOX_INIT_RES_QUEUE		0x0011
     86 #define MBOX_EXECUTE_IOCB		0x0012
     87 #define MBOX_WAKE_UP			0x0013
     88 #define MBOX_STOP_FIRMWARE		0x0014
     89 #define MBOX_ABORT			0x0015
     90 #define MBOX_ABORT_DEVICE		0x0016
     91 #define MBOX_ABORT_TARGET		0x0017
     92 #define MBOX_BUS_RESET			0x0018
     93 #define MBOX_STOP_QUEUE			0x0019
     94 #define MBOX_START_QUEUE		0x001a
     95 #define MBOX_SINGLE_STEP_QUEUE		0x001b
     96 #define MBOX_ABORT_QUEUE		0x001c
     97 #define MBOX_GET_DEV_QUEUE_STATUS	0x001d
     98 					/*  1e */
     99 #define MBOX_GET_FIRMWARE_STATUS	0x001f
    100 #define MBOX_GET_INIT_SCSI_ID		0x0020
    101 #define MBOX_GET_SELECT_TIMEOUT		0x0021
    102 #define MBOX_GET_RETRY_COUNT		0x0022
    103 #define MBOX_GET_TAG_AGE_LIMIT		0x0023
    104 #define MBOX_GET_CLOCK_RATE		0x0024
    105 #define MBOX_GET_ACT_NEG_STATE		0x0025
    106 #define MBOX_GET_ASYNC_DATA_SETUP_TIME	0x0026
    107 #define MBOX_GET_SBUS_PARAMS		0x0027
    108 #define MBOX_GET_TARGET_PARAMS		0x0028
    109 #define MBOX_GET_DEV_QUEUE_PARAMS	0x0029
    110 #define	MBOX_GET_RESET_DELAY_PARAMS	0x002a
    111 					/*  2b */
    112 					/*  2c */
    113 					/*  2d */
    114 					/*  2e */
    115 					/*  2f */
    116 #define MBOX_SET_INIT_SCSI_ID		0x0030
    117 #define MBOX_SET_SELECT_TIMEOUT		0x0031
    118 #define MBOX_SET_RETRY_COUNT		0x0032
    119 #define MBOX_SET_TAG_AGE_LIMIT		0x0033
    120 #define MBOX_SET_CLOCK_RATE		0x0034
    121 #define MBOX_SET_ACT_NEG_STATE		0x0035
    122 #define MBOX_SET_ASYNC_DATA_SETUP_TIME	0x0036
    123 #define MBOX_SET_SBUS_CONTROL_PARAMS	0x0037
    124 #define		MBOX_SET_PCI_PARAMETERS	0x0037
    125 #define MBOX_SET_TARGET_PARAMS		0x0038
    126 #define MBOX_SET_DEV_QUEUE_PARAMS	0x0039
    127 #define	MBOX_SET_RESET_DELAY_PARAMS	0x003a
    128 					/*  3b */
    129 					/*  3c */
    130 					/*  3d */
    131 					/*  3e */
    132 					/*  3f */
    133 #define	MBOX_RETURN_BIOS_BLOCK_ADDR	0x0040
    134 #define	MBOX_WRITE_FOUR_RAM_WORDS	0x0041
    135 #define	MBOX_EXEC_BIOS_IOCB		0x0042
    136 #define	MBOX_SET_FW_FEATURES		0x004a
    137 #define	MBOX_GET_FW_FEATURES		0x004b
    138 #define		FW_FEATURE_LVD_NOTIFY	0x2
    139 #define		FW_FEATURE_FAST_POST	0x1
    140 
    141 #define	MBOX_ENABLE_TARGET_MODE		0x55
    142 #define		ENABLE_TARGET_FLAG	0x8000
    143 #define		ENABLE_TQING_FLAG	0x0004
    144 #define		ENABLE_MANDATORY_DISC	0x0002
    145 #define	MBOX_GET_TARGET_STATUS		0x56
    146 
    147 /* These are for the ISP2100 FC cards */
    148 #define	MBOX_GET_LOOP_ID		0x20
    149 #define	MBOX_GET_RESOURCE_COUNT		0x42
    150 #define	MBOX_EXEC_COMMAND_IOCB_A64	0x54
    151 #define	MBOX_INIT_FIRMWARE		0x60
    152 #define	MBOX_GET_INIT_CONTROL_BLOCK	0x61
    153 #define	MBOX_INIT_LIP			0x62
    154 #define	MBOX_GET_FC_AL_POSITION_MAP	0x63
    155 #define	MBOX_GET_PORT_DB		0x64
    156 #define	MBOX_CLEAR_ACA			0x65
    157 #define	MBOX_TARGET_RESET		0x66
    158 #define	MBOX_CLEAR_TASK_SET		0x67
    159 #define	MBOX_ABORT_TASK_SET		0x68
    160 #define	MBOX_GET_FW_STATE		0x69
    161 #define	MBOX_GET_PORT_NAME		0x6a
    162 #define	MBOX_GET_LINK_STATUS		0x6b
    163 #define	MBOX_INIT_LIP_RESET		0x6c
    164 #define	MBOX_SEND_SNS			0x6e
    165 #define	MBOX_FABRIC_LOGIN		0x6f
    166 #define	MBOX_SEND_CHANGE_REQUEST	0x70
    167 #define	MBOX_FABRIC_LOGOUT		0x71
    168 #define	MBOX_INIT_LIP_LOGIN		0x72
    169 
    170 #define	ISP2100_SET_PCI_PARAM		0x00ff
    171 
    172 #define	MBOX_BUSY			0x04
    173 
    174 typedef struct {
    175 	u_int16_t param[8];
    176 } mbreg_t;
    177 
    178 /*
    179  * Mailbox Command Complete Status Codes
    180  */
    181 #define	MBOX_COMMAND_COMPLETE		0x4000
    182 #define	MBOX_INVALID_COMMAND		0x4001
    183 #define	MBOX_HOST_INTERFACE_ERROR	0x4002
    184 #define	MBOX_TEST_FAILED		0x4003
    185 #define	MBOX_COMMAND_ERROR		0x4005
    186 #define	MBOX_COMMAND_PARAM_ERROR	0x4006
    187 #define	MBOX_PORT_ID_USED		0x4007
    188 #define	MBOX_LOOP_ID_USED		0x4008
    189 #define	MBOX_ALL_IDS_USED		0x4009
    190 #define	MBOX_NOT_LOGGED_IN		0x400A
    191 #define	MBLOGALL			0x000f
    192 #define	MBLOGNONE			0x0000
    193 #define	MBLOGMASK(x)			((x) & 0xf)
    194 
    195 /*
    196  * Asynchronous event status codes
    197  */
    198 #define	ASYNC_BUS_RESET			0x8001
    199 #define	ASYNC_SYSTEM_ERROR		0x8002
    200 #define	ASYNC_RQS_XFER_ERR		0x8003
    201 #define	ASYNC_RSP_XFER_ERR		0x8004
    202 #define	ASYNC_QWAKEUP			0x8005
    203 #define	ASYNC_TIMEOUT_RESET		0x8006
    204 #define	ASYNC_DEVICE_RESET		0x8007
    205 #define	ASYNC_EXTMSG_UNDERRUN		0x800A
    206 #define	ASYNC_SCAM_INT			0x800B
    207 #define	ASYNC_HUNG_SCSI			0x800C
    208 #define	ASYNC_KILLED_BUS		0x800D
    209 #define	ASYNC_BUS_TRANSIT		0x800E	/* LVD -> HVD, eg. */
    210 #define	ASYNC_CMD_CMPLT			0x8020
    211 #define	ASYNC_CTIO_DONE			0x8021
    212 
    213 /* for ISP2100 only */
    214 #define	ASYNC_LIP_OCCURRED		0x8010
    215 #define	ASYNC_LOOP_UP			0x8011
    216 #define	ASYNC_LOOP_DOWN			0x8012
    217 #define	ASYNC_LOOP_RESET		0x8013
    218 #define	ASYNC_PDB_CHANGED		0x8014
    219 #define	ASYNC_CHANGE_NOTIFY		0x8015
    220 
    221 /* for ISP2200 only */
    222 #define	ASYNC_PTPMODE			0x8030
    223 #define	ASYNC_CONNMODE			0x8036
    224 #define		ISP_CONN_LOOP		1
    225 #define		ISP_CONN_PTP		2
    226 #define		ISP_CONN_BADLIP		3
    227 #define		ISP_CONN_FATAL		4
    228 #define		ISP_CONN_LOOPBACK	5
    229 
    230 /*
    231  * Command Structure Definitions
    232  */
    233 
    234 typedef struct {
    235 	u_int32_t	ds_base;
    236 	u_int32_t	ds_count;
    237 } ispds_t;
    238 
    239 #define	_ISP_SWAP8(a, b)	{	\
    240 	u_int8_t tmp;			\
    241 	tmp = a;			\
    242 	a = b;				\
    243 	b = tmp;			\
    244 }
    245 
    246 /*
    247  * These elements get swizzled around for SBus instances.
    248  */
    249 typedef struct {
    250 	u_int8_t	rqs_entry_type;
    251 	u_int8_t	rqs_entry_count;
    252 	u_int8_t	rqs_seqno;
    253 	u_int8_t	rqs_flags;
    254 } isphdr_t;
    255 /*
    256  * There are no (for all intents and purposes) non-sparc SBus machines
    257  */
    258 #ifdef	__sparc__
    259 #define	ISP_SBUSIFY_ISPHDR(isp, hdrp)					\
    260     if ((isp)->isp_bustype == ISP_BT_SBUS) {				\
    261 	_ISP_SWAP8((hdrp)->rqs_entry_count, (hdrp)->rqs_entry_type);	\
    262 	_ISP_SWAP8((hdrp)->rqs_flags, (hdrp)->rqs_seqno);		\
    263     }
    264 #else
    265 #define	ISP_SBUSIFY_ISPHDR(a, b)
    266 #endif
    267 
    268 /* RQS Flag definitions */
    269 #define	RQSFLAG_CONTINUATION	0x01
    270 #define	RQSFLAG_FULL		0x02
    271 #define	RQSFLAG_BADHEADER	0x04
    272 #define	RQSFLAG_BADPACKET	0x08
    273 
    274 /* RQS entry_type definitions */
    275 #define	RQSTYPE_REQUEST		0x01
    276 #define	RQSTYPE_DATASEG		0x02
    277 #define	RQSTYPE_RESPONSE	0x03
    278 #define	RQSTYPE_MARKER		0x04
    279 #define	RQSTYPE_CMDONLY		0x05
    280 #define	RQSTYPE_ATIO		0x06	/* Target Mode */
    281 #define	RQSTYPE_CTIO		0x07	/* Target Mode */
    282 #define	RQSTYPE_SCAM		0x08
    283 #define	RQSTYPE_A64		0x09
    284 #define	RQSTYPE_A64_CONT	0x0a
    285 #define	RQSTYPE_ENABLE_LUN	0x0b	/* Target Mode */
    286 #define	RQSTYPE_MODIFY_LUN	0x0c	/* Target Mode */
    287 #define	RQSTYPE_NOTIFY		0x0d	/* Target Mode */
    288 #define	RQSTYPE_NOTIFY_ACK	0x0e	/* Target Mode */
    289 #define	RQSTYPE_CTIO1		0x0f	/* Target Mode */
    290 #define	RQSTYPE_STATUS_CONT	0x10
    291 #define	RQSTYPE_T2RQS		0x11
    292 
    293 #define	RQSTYPE_T4RQS		0x15
    294 #define	RQSTYPE_ATIO2		0x16
    295 #define	RQSTYPE_CTIO2		0x17
    296 #define	RQSTYPE_CSET0		0x18
    297 #define	RQSTYPE_T3RQS		0x19
    298 
    299 #define	RQSTYPE_CTIO3		0x1f
    300 
    301 
    302 #define	ISP_RQDSEG	4
    303 typedef struct {
    304 	isphdr_t	req_header;
    305 	u_int32_t	req_handle;
    306 	u_int8_t	req_lun_trn;
    307 	u_int8_t	req_target;
    308 	u_int16_t	req_cdblen;
    309 #define	req_modifier	req_cdblen	/* marker packet */
    310 	u_int16_t	req_flags;
    311 	u_int16_t	req_reserved;
    312 	u_int16_t	req_time;
    313 	u_int16_t	req_seg_count;
    314 	u_int8_t	req_cdb[12];
    315 	ispds_t		req_dataseg[ISP_RQDSEG];
    316 } ispreq_t;
    317 
    318 /*
    319  * A request packet can also be a marker packet.
    320  */
    321 #define SYNC_DEVICE	0
    322 #define SYNC_TARGET	1
    323 #define SYNC_ALL	2
    324 
    325 /*
    326  * There are no (for all intents and purposes) non-sparc SBus machines
    327  */
    328 #ifdef	__sparc__
    329 #define	ISP_SBUSIFY_ISPREQ(isp, rqp)					\
    330     if ((isp)->isp_bustype == ISP_BT_SBUS) {				\
    331 	_ISP_SWAP8((rqp)->req_target, (rqp)->req_lun_trn);		\
    332     }
    333 #else
    334 #define	ISP_SBUSIFY_ISPREQ(a, b)
    335 #endif
    336 
    337 #define	ISP_RQDSEG_T2	3
    338 typedef struct {
    339 	isphdr_t	req_header;
    340 	u_int32_t	req_handle;
    341 	u_int8_t	req_lun_trn;
    342 	u_int8_t	req_target;
    343 	u_int16_t	req_scclun;
    344 	u_int16_t	req_flags;
    345 	u_int16_t	_res2;
    346 	u_int16_t	req_time;
    347 	u_int16_t	req_seg_count;
    348 	u_int32_t	req_cdb[4];
    349 	u_int32_t	req_totalcnt;
    350 	ispds_t		req_dataseg[ISP_RQDSEG_T2];
    351 } ispreqt2_t;
    352 
    353 /* req_flag values */
    354 #define	REQFLAG_NODISCON	0x0001
    355 #define	REQFLAG_HTAG		0x0002
    356 #define	REQFLAG_OTAG		0x0004
    357 #define	REQFLAG_STAG		0x0008
    358 #define	REQFLAG_TARGET_RTN	0x0010
    359 
    360 #define	REQFLAG_NODATA		0x0000
    361 #define	REQFLAG_DATA_IN		0x0020
    362 #define	REQFLAG_DATA_OUT	0x0040
    363 #define	REQFLAG_DATA_UNKNOWN	0x0060
    364 
    365 #define	REQFLAG_DISARQ		0x0100
    366 #define	REQFLAG_FRC_ASYNC	0x0200
    367 #define	REQFLAG_FRC_SYNC	0x0400
    368 #define	REQFLAG_FRC_WIDE	0x0800
    369 #define	REQFLAG_NOPARITY	0x1000
    370 #define	REQFLAG_STOPQ		0x2000
    371 #define	REQFLAG_XTRASNS		0x4000
    372 #define	REQFLAG_PRIORITY	0x8000
    373 
    374 typedef struct {
    375 	isphdr_t	req_header;
    376 	u_int32_t	req_handle;
    377 	u_int8_t	req_lun_trn;
    378 	u_int8_t	req_target;
    379 	u_int16_t	req_cdblen;
    380 	u_int16_t	req_flags;
    381 	u_int16_t	_res1;
    382 	u_int16_t	req_time;
    383 	u_int16_t	req_seg_count;
    384 	u_int8_t	req_cdb[44];
    385 } ispextreq_t;
    386 
    387 #define	ISP_CDSEG	7
    388 typedef struct {
    389 	isphdr_t	req_header;
    390 	u_int32_t	_res1;
    391 	ispds_t		req_dataseg[ISP_CDSEG];
    392 } ispcontreq_t;
    393 
    394 typedef struct {
    395 	isphdr_t	req_header;
    396 	u_int32_t	req_handle;
    397 	u_int16_t	req_scsi_status;
    398 	u_int16_t	req_completion_status;
    399 	u_int16_t	req_state_flags;
    400 	u_int16_t	req_status_flags;
    401 	u_int16_t	req_time;
    402 #define	req_response_len	req_time	/* FC only */
    403 	u_int16_t	req_sense_len;
    404 	u_int32_t	req_resid;
    405 	u_int8_t	req_response[8];	/* FC only */
    406 	u_int8_t	req_sense_data[32];
    407 } ispstatusreq_t;
    408 
    409 /*
    410  * For Qlogic 2X00, the high order byte of SCSI status has
    411  * additional meaning.
    412  */
    413 #define	RQCS_RU	0x800	/* Residual Under */
    414 #define	RQCS_RO	0x400	/* Residual Over */
    415 #define	RQCS_RESID	(RQCS_RU|RQCS_RO)
    416 #define	RQCS_SV	0x200	/* Sense Length Valid */
    417 #define	RQCS_RV	0x100	/* FCP Response Length Valid */
    418 
    419 /*
    420  * Completion Status Codes.
    421  */
    422 #define RQCS_COMPLETE			0x0000
    423 #define RQCS_DMA_ERROR			0x0002
    424 #define RQCS_RESET_OCCURRED		0x0004
    425 #define RQCS_ABORTED			0x0005
    426 #define RQCS_TIMEOUT			0x0006
    427 #define RQCS_DATA_OVERRUN		0x0007
    428 #define RQCS_DATA_UNDERRUN		0x0015
    429 #define	RQCS_QUEUE_FULL			0x001C
    430 
    431 /* 1X00 Only Completion Codes */
    432 #define RQCS_INCOMPLETE			0x0001
    433 #define RQCS_TRANSPORT_ERROR		0x0003
    434 #define RQCS_COMMAND_OVERRUN		0x0008
    435 #define RQCS_STATUS_OVERRUN		0x0009
    436 #define RQCS_BAD_MESSAGE		0x000a
    437 #define RQCS_NO_MESSAGE_OUT		0x000b
    438 #define RQCS_EXT_ID_FAILED		0x000c
    439 #define RQCS_IDE_MSG_FAILED		0x000d
    440 #define RQCS_ABORT_MSG_FAILED		0x000e
    441 #define RQCS_REJECT_MSG_FAILED		0x000f
    442 #define RQCS_NOP_MSG_FAILED		0x0010
    443 #define RQCS_PARITY_ERROR_MSG_FAILED	0x0011
    444 #define RQCS_DEVICE_RESET_MSG_FAILED	0x0012
    445 #define RQCS_ID_MSG_FAILED		0x0013
    446 #define RQCS_UNEXP_BUS_FREE		0x0014
    447 #define	RQCS_XACT_ERR1			0x0018
    448 #define	RQCS_XACT_ERR2			0x0019
    449 #define	RQCS_XACT_ERR3			0x001A
    450 #define	RQCS_BAD_ENTRY			0x001B
    451 #define	RQCS_PHASE_SKIPPED		0x001D
    452 #define	RQCS_ARQS_FAILED		0x001E
    453 #define	RQCS_WIDE_FAILED		0x001F
    454 #define	RQCS_SYNCXFER_FAILED		0x0020
    455 #define	RQCS_LVD_BUSERR			0x0021
    456 
    457 /* 2X00 Only Completion Codes */
    458 #define	RQCS_PORT_UNAVAILABLE		0x0028
    459 #define	RQCS_PORT_LOGGED_OUT		0x0029
    460 #define	RQCS_PORT_CHANGED		0x002A
    461 #define	RQCS_PORT_BUSY			0x002B
    462 
    463 /*
    464  * 1X00 specific State Flags
    465  */
    466 #define RQSF_GOT_BUS			0x0100
    467 #define RQSF_GOT_TARGET			0x0200
    468 #define RQSF_SENT_CDB			0x0400
    469 #define RQSF_XFRD_DATA			0x0800
    470 #define RQSF_GOT_STATUS			0x1000
    471 #define RQSF_GOT_SENSE			0x2000
    472 #define	RQSF_XFER_COMPLETE		0x4000
    473 
    474 /*
    475  * 2X00 specific State Flags
    476  * (same as 1X00 except RQSF_GOT_BUS/RQSF_GOT_TARGET are not available)
    477  */
    478 #define	RQSF_DATA_IN			0x0020
    479 #define	RQSF_DATA_OUT			0x0040
    480 #define	RQSF_STAG			0x0008
    481 #define	RQSF_OTAG			0x0004
    482 #define	RQSF_HTAG			0x0002
    483 /*
    484  * 1X00 Status Flags
    485  */
    486 #define RQSTF_DISCONNECT		0x0001
    487 #define RQSTF_SYNCHRONOUS		0x0002
    488 #define RQSTF_PARITY_ERROR		0x0004
    489 #define RQSTF_BUS_RESET			0x0008
    490 #define RQSTF_DEVICE_RESET		0x0010
    491 #define RQSTF_ABORTED			0x0020
    492 #define RQSTF_TIMEOUT			0x0040
    493 #define RQSTF_NEGOTIATION		0x0080
    494 
    495 /*
    496  * 2X00 specific state flags
    497  */
    498 /* RQSF_SENT_CDB	*/
    499 /* RQSF_XFRD_DATA	*/
    500 /* RQSF_GOT_STATUS	*/
    501 /* RQSF_XFER_COMPLETE	*/
    502 
    503 /*
    504  * 2X00 specific status flags
    505  */
    506 /* RQSTF_ABORTED */
    507 /* RQSTF_TIMEOUT */
    508 #define	RQSTF_DMA_ERROR			0x0080
    509 #define	RQSTF_LOGOUT			0x2000
    510 
    511 /*
    512  * Miscellaneous
    513  */
    514 #ifndef	ISP_EXEC_THROTTLE
    515 #define	ISP_EXEC_THROTTLE	16
    516 #endif
    517 
    518 /*
    519  * About Firmware returns an 'attribute' word in mailbox 6.
    520  */
    521 #define	ISP_FW_ATTR_TMODE	0x01
    522 #define	ISP_FW_ATTR_SCCLUN	0x02
    523 #define	ISP_FW_ATTR_FABRIC	0x04
    524 #define	ISP_FW_ATTR_CLASS2	0x08
    525 #define	ISP_FW_ATTR_FCTAPE	0x10
    526 #define	ISP_FW_ATTR_IP		0x20
    527 
    528 /*
    529  * FC (ISP2100) specific data structures
    530  */
    531 
    532 /*
    533  * Initialization Control Block
    534  *
    535  * Version One (prime) format.
    536  */
    537 typedef struct isp_icb {
    538 	u_int8_t	icb_version;
    539 	u_int8_t	_reserved0;
    540 	u_int16_t	icb_fwoptions;
    541 	u_int16_t	icb_maxfrmlen;
    542 	u_int16_t	icb_maxalloc;
    543 	u_int16_t	icb_execthrottle;
    544 	u_int8_t	icb_retry_count;
    545 	u_int8_t	icb_retry_delay;
    546 	u_int8_t	icb_portname[8];
    547 	u_int16_t	icb_hardaddr;
    548 	u_int8_t	icb_iqdevtype;
    549 	u_int8_t	icb_logintime;
    550 	u_int8_t	icb_nodename[8];
    551 	u_int16_t	icb_rqstout;
    552 	u_int16_t	icb_rspnsin;
    553 	u_int16_t	icb_rqstqlen;
    554 	u_int16_t	icb_rsltqlen;
    555 	u_int16_t	icb_rqstaddr[4];
    556 	u_int16_t	icb_respaddr[4];
    557 	u_int16_t	icb_lunenables;
    558 	u_int8_t	icb_ccnt;
    559 	u_int8_t	icb_icnt;
    560 	u_int16_t	icb_lunetimeout;
    561 	u_int16_t	_reserved1;
    562 	u_int16_t	icb_xfwoptions;
    563 	u_int8_t	icb_racctimer;
    564 	u_int8_t	icb_idelaytimer;
    565 	u_int16_t	icb_zfwoptions;
    566 	u_int16_t	_reserved2[13];
    567 } isp_icb_t;
    568 #define	ICB_VERSION1	1
    569 
    570 #define	ICBOPT_HARD_ADDRESS	0x0001
    571 #define	ICBOPT_FAIRNESS		0x0002
    572 #define	ICBOPT_FULL_DUPLEX	0x0004
    573 #define	ICBOPT_FAST_POST	0x0008
    574 #define	ICBOPT_TGT_ENABLE	0x0010
    575 #define	ICBOPT_INI_DISABLE	0x0020
    576 #define	ICBOPT_INI_ADISC	0x0040
    577 #define	ICBOPT_INI_TGTTYPE	0x0080
    578 #define	ICBOPT_PDBCHANGE_AE	0x0100
    579 #define	ICBOPT_NOLIP		0x0200
    580 #define	ICBOPT_SRCHDOWN		0x0400
    581 #define	ICBOPT_PREVLOOP		0x0800
    582 #define	ICBOPT_STOP_ON_QFULL	0x1000
    583 #define	ICBOPT_FULL_LOGIN	0x2000
    584 #define	ICBOPT_BOTH_WWNS	0x4000
    585 #define	ICBOPT_EXTENDED		0x8000
    586 
    587 #define	ICBXOPT_CLASS2_ACK0	0x0200
    588 #define	ICBXOPT_CLASS2		0x0100
    589 #define	ICBXOPT_LOOP_ONLY	(0 << 4)
    590 #define	ICBXOPT_PTP_ONLY	(1 << 4)
    591 #define	ICBXOPT_LOOP_2_PTP	(2 << 4)
    592 #define	ICBXOPT_PTP_2_LOOP	(3 << 4)
    593 
    594 #define	ICBXOPT_RIO_OFF		0
    595 #define	ICBXOPT_RIO_16BIT	1
    596 #define	ICBXOPT_RIO_32BIT	2
    597 #define	ICBXOPT_RIO_16BIT_DELAY	3
    598 #define	ICBXOPT_RIO_32BIT_DELAY	4
    599 
    600 
    601 
    602 #define	ICB_MIN_FRMLEN		256
    603 #define	ICB_MAX_FRMLEN		2112
    604 #define	ICB_DFLT_FRMLEN		1024
    605 #define	ICB_DFLT_ALLOC		256
    606 #define	ICB_DFLT_THROTTLE	16
    607 #define	ICB_DFLT_RDELAY		5
    608 #define	ICB_DFLT_RCOUNT		3
    609 
    610 
    611 #define	RQRSP_ADDR0015	0
    612 #define	RQRSP_ADDR1631	1
    613 #define	RQRSP_ADDR3247	2
    614 #define	RQRSP_ADDR4863	3
    615 
    616 
    617 #define	ICB_NNM0	7
    618 #define	ICB_NNM1	6
    619 #define	ICB_NNM2	5
    620 #define	ICB_NNM3	4
    621 #define	ICB_NNM4	3
    622 #define	ICB_NNM5	2
    623 #define	ICB_NNM6	1
    624 #define	ICB_NNM7	0
    625 
    626 #define	MAKE_NODE_NAME_FROM_WWN(array, wwn)	\
    627 	array[ICB_NNM0] = (u_int8_t) ((wwn >>  0) & 0xff), \
    628 	array[ICB_NNM1] = (u_int8_t) ((wwn >>  8) & 0xff), \
    629 	array[ICB_NNM2] = (u_int8_t) ((wwn >> 16) & 0xff), \
    630 	array[ICB_NNM3] = (u_int8_t) ((wwn >> 24) & 0xff), \
    631 	array[ICB_NNM4] = (u_int8_t) ((wwn >> 32) & 0xff), \
    632 	array[ICB_NNM5] = (u_int8_t) ((wwn >> 40) & 0xff), \
    633 	array[ICB_NNM6] = (u_int8_t) ((wwn >> 48) & 0xff), \
    634 	array[ICB_NNM7] = (u_int8_t) ((wwn >> 56) & 0xff)
    635 
    636 /*
    637  * FC-AL Position Map
    638  *
    639  * This is an at most 128 byte map that returns either
    640  * the LILP or Firmware generated list of ports.
    641  *
    642  * We deviate a bit from the returned qlogic format to
    643  * use an extra bit to say whether this was a LILP or
    644  * f/w generated map.
    645  */
    646 typedef struct {
    647 	u_int8_t	fwmap	: 1,
    648 			count	: 7;
    649 	u_int8_t	map[127];
    650 } fcpos_map_t;
    651 
    652 /*
    653  * Port Data Base Element
    654  */
    655 
    656 typedef struct {
    657 	u_int16_t	pdb_options;
    658 	u_int8_t	pdb_mstate;
    659 	u_int8_t	pdb_sstate;
    660 #define	BITS2WORD(x)	((x)[0] << 16 | (x)[3] << 8 | (x)[2])
    661 	u_int8_t	pdb_hardaddr_bits[4];
    662 	u_int8_t	pdb_portid_bits[4];
    663 	u_int8_t	pdb_nodename[8];
    664 	u_int8_t	pdb_portname[8];
    665 	u_int16_t	pdb_execthrottle;
    666 	u_int16_t	pdb_exec_count;
    667 	u_int8_t	pdb_retry_count;
    668 	u_int8_t	pdb_retry_delay;
    669 	u_int16_t	pdb_resalloc;
    670 	u_int16_t	pdb_curalloc;
    671 	u_int16_t	pdb_qhead;
    672 	u_int16_t	pdb_qtail;
    673 	u_int16_t	pdb_tl_next;
    674 	u_int16_t	pdb_tl_last;
    675 	u_int16_t	pdb_features;	/* PLOGI, Common Service */
    676 	u_int16_t	pdb_pconcurrnt;	/* PLOGI, Common Service */
    677 	u_int16_t	pdb_roi;	/* PLOGI, Common Service */
    678 	u_int8_t	pdb_target;
    679 	u_int8_t	pdb_initiator;	/* PLOGI, Class 3 Control Flags */
    680 	u_int16_t	pdb_rdsiz;	/* PLOGI, Class 3 */
    681 	u_int16_t	pdb_ncseq;	/* PLOGI, Class 3 */
    682 	u_int16_t	pdb_noseq;	/* PLOGI, Class 3 */
    683 	u_int16_t	pdb_labrtflg;
    684 	u_int16_t	pdb_lstopflg;
    685 	u_int16_t	pdb_sqhead;
    686 	u_int16_t	pdb_sqtail;
    687 	u_int16_t	pdb_ptimer;
    688 	u_int16_t	pdb_nxt_seqid;
    689 	u_int16_t	pdb_fcount;
    690 	u_int16_t	pdb_prli_len;
    691 	u_int16_t	pdb_prli_svc0;
    692 	u_int16_t	pdb_prli_svc3;
    693 	u_int16_t	pdb_loopid;
    694 	u_int16_t	pdb_il_ptr;
    695 	u_int16_t	pdb_sl_ptr;
    696 } isp_pdb_t;
    697 
    698 #define	PDB_OPTIONS_XMITTING	(1<<11)
    699 #define	PDB_OPTIONS_LNKXMIT	(1<<10)
    700 #define	PDB_OPTIONS_ABORTED	(1<<9)
    701 #define	PDB_OPTIONS_ADISC	(1<<1)
    702 
    703 #define	PDB_STATE_DISCOVERY	0
    704 #define	PDB_STATE_WDISC_ACK	1
    705 #define	PDB_STATE_PLOGI		2
    706 #define	PDB_STATE_PLOGI_ACK	3
    707 #define	PDB_STATE_PRLI		4
    708 #define	PDB_STATE_PRLI_ACK	5
    709 #define	PDB_STATE_LOGGED_IN	6
    710 #define	PDB_STATE_PORT_UNAVAIL	7
    711 #define	PDB_STATE_PRLO		8
    712 #define	PDB_STATE_PRLO_ACK	9
    713 #define	PDB_STATE_PLOGO		10
    714 #define	PDB_STATE_PLOG_ACK	11
    715 
    716 #define		SVC3_TGT_ROLE		0x10
    717 #define 	SVC3_INI_ROLE		0x20
    718 #define			SVC3_ROLE_MASK	0x30
    719 #define			SVC3_ROLE_SHIFT	4
    720 
    721 #define	SNS_GAN	0x100
    722 #define	SNS_GP3	0x171
    723 #define	SNS_RFT	0x217
    724 typedef struct {
    725 	u_int16_t	snscb_rblen;	/* response buffer length (words) */
    726 	u_int16_t	snscb_res0;
    727 	u_int16_t	snscb_addr[4];	/* response buffer address */
    728 	u_int16_t	snscb_sblen;	/* subcommand buffer length (words) */
    729 	u_int16_t	snscb_res1;
    730 	u_int16_t	snscb_data[1];	/* variable data */
    731 } sns_screq_t;	/* Subcommand Request Structure */
    732 #define	SNS_GAN_REQ_SIZE	(sizeof (sns_screq_t)+(5*(sizeof (u_int16_t))))
    733 #define	SNS_GP3_REQ_SIZE	(sizeof (sns_screq_t)+(5*(sizeof (u_int16_t))))
    734 #define	SNS_RFT_REQ_SIZE	(sizeof (sns_screq_t)+(21*(sizeof (u_int16_t))))
    735 
    736 typedef struct {
    737 	u_int8_t	snscb_cthdr[16];
    738 	u_int8_t	snscb_port_type;
    739 	u_int8_t	snscb_port_id[3];
    740 	u_int8_t	snscb_portname[8];
    741 	u_int16_t	snscb_data[1];	/* variable data */
    742 } sns_scrsp_t;	/* Subcommand Response Structure */
    743 #define	SNS_GAN_RESP_SIZE	608	/* Maximum response size (bytes) */
    744 #define	SNS_GP3_RESP_SIZE	532	/* XXX: For 128 ports */
    745 #define	SNS_RFT_RESP_SIZE	16
    746 
    747 typedef struct {
    748 	u_int8_t	snscb_cthdr[16];
    749 	u_int8_t	snscb_port_type;
    750 	u_int8_t	snscb_port_id[3];
    751 	u_int8_t	snscb_portname[8];
    752 	u_int8_t	snscb_pnlen;		/* symbolic port name length */
    753 	u_int8_t	snscb_pname[255];	/* symbolic port name */
    754 	u_int8_t	snscb_nodename[8];
    755 	u_int8_t	snscb_nnlen;		/* symbolic node name length */
    756 	u_int8_t	snscb_nname[255];	/* symbolic node name */
    757 	u_int8_t	snscb_ipassoc[8];
    758 	u_int8_t	snscb_ipaddr[16];
    759 	u_int8_t	snscb_svc_class[4];
    760 	u_int8_t	snscb_fc4_types[32];
    761 	u_int8_t	snscb_fpname[8];
    762 	u_int8_t	snscb_reserved;
    763 	u_int8_t	snscb_hardaddr[3];
    764 } sns_ganrsp_t;	/* Subcommand Response Structure */
    765 
    766 #endif	/* _ISPMBOX_H */
    767