Home | History | Annotate | Line # | Download | only in ic
ispmbox.h revision 1.1.1.1 
      1 /*	$NetBSD: ispmbox.h,v 1.1.1.1 1997/03/12 20:44:51 cgd Exp $ */
      2 
      3 /*
      4  * Mailbox and Command Definitions for for Qlogic ISP SCSI adapters.
      5  *
      6  * Copyright (c) 1997 by Matthew Jacob (for NASA/Ames Research Center)
      7  * All rights reserved.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice immediately at the beginning of the file, without modification,
     14  *    this list of conditions, and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     24  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
     25  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     31  * SUCH DAMAGE.
     32  *
     33  */
     34 #ifndef	_ISPMBOX_H
     35 #define	_ISPMBOX_H
     36 
     37 /*
     38  * Mailbox Command Opcodes
     39  */
     40 
     41 #define MBOX_NO_OP			0x0000
     42 #define MBOX_LOAD_RAM			0x0001
     43 #define MBOX_EXEC_FIRMWARE		0x0002
     44 #define MBOX_DUMP_RAM			0x0003
     45 #define MBOX_WRITE_RAM_WORD		0x0004
     46 #define MBOX_READ_RAM_WORD		0x0005
     47 #define MBOX_MAILBOX_REG_TEST		0x0006
     48 #define MBOX_VERIFY_CHECKSUM		0x0007
     49 #define MBOX_ABOUT_FIRMWARE		0x0008
     50 					/*   9 */
     51 					/*   a */
     52 					/*   b */
     53 					/*   c */
     54 					/*   d */
     55 #define MBOX_CHECK_FIRMWARE		0x000e
     56 					/*   f */
     57 #define MBOX_INIT_REQ_QUEUE		0x0010
     58 #define MBOX_INIT_RES_QUEUE		0x0011
     59 #define MBOX_EXECUTE_IOCB		0x0012
     60 #define MBOX_WAKE_UP			0x0013
     61 #define MBOX_STOP_FIRMWARE		0x0014
     62 #define MBOX_ABORT			0x0015
     63 #define MBOX_ABORT_DEVICE		0x0016
     64 #define MBOX_ABORT_TARGET		0x0017
     65 #define MBOX_BUS_RESET			0x0018
     66 #define MBOX_STOP_QUEUE			0x0019
     67 #define MBOX_START_QUEUE		0x001a
     68 #define MBOX_SINGLE_STEP_QUEUE		0x001b
     69 #define MBOX_ABORT_QUEUE		0x001c
     70 #define MBOX_GET_DEV_QUEUE_STATUS	0x001d
     71 					/*  1e */
     72 #define MBOX_GET_FIRMWARE_STATUS	0x001f
     73 #define MBOX_GET_INIT_SCSI_ID		0x0020
     74 #define MBOX_GET_SELECT_TIMEOUT		0x0021
     75 #define MBOX_GET_RETRY_COUNT		0x0022
     76 #define MBOX_GET_TAG_AGE_LIMIT		0x0023
     77 #define MBOX_GET_CLOCK_RATE		0x0024
     78 #define MBOX_GET_ACT_NEG_STATE		0x0025
     79 #define MBOX_GET_ASYNC_DATA_SETUP_TIME	0x0026
     80 #define MBOX_GET_SBUS_PARAMS		0x0027
     81 #define MBOX_GET_TARGET_PARAMS		0x0028
     82 #define MBOX_GET_DEV_QUEUE_PARAMS	0x0029
     83 					/*  2a */
     84 					/*  2b */
     85 					/*  2c */
     86 					/*  2d */
     87 					/*  2e */
     88 					/*  2f */
     89 #define MBOX_SET_INIT_SCSI_ID		0x0030
     90 #define MBOX_SET_SELECT_TIMEOUT		0x0031
     91 #define MBOX_SET_RETRY_COUNT		0x0032
     92 #define MBOX_SET_TAG_AGE_LIMIT		0x0033
     93 #define MBOX_SET_CLOCK_RATE		0x0034
     94 #define MBOX_SET_ACTIVE_NEG_STATE	0x0035
     95 #define MBOX_SET_ASYNC_DATA_SETUP_TIME	0x0036
     96 #define MBOX_SET_SBUS_CONTROL_PARAMS	0x0037
     97 #define MBOX_SET_TARGET_PARAMS		0x0038
     98 #define MBOX_SET_DEV_QUEUE_PARAMS	0x0039
     99 					/*  3a */
    100 					/*  3b */
    101 					/*  3c */
    102 					/*  3d */
    103 					/*  3e */
    104 					/*  3f */
    105 #define	MBOX_RETURN_BIOS_BLOCK_ADDR	0x0040
    106 #define	MBOX_WRITE_FOUR_RAM_WORDS	0x0041
    107 #define	MBOX_EXEC_BIOS_IOCB		0x0042
    108 
    109 #define	MBOX_BUSY			0x04
    110 
    111 typedef struct {
    112 	u_int16_t param[6];
    113 } mbreg_t;
    114 
    115 /*
    116  * Command Structure Definitions
    117  */
    118 
    119 typedef struct {
    120 	u_int32_t	ds_base;
    121 	u_int32_t	ds_count;
    122 } ispds_t;
    123 
    124 typedef struct {
    125 #if BYTE_ORDER == BIG_ENDIAN
    126 	u_int8_t	rqs_entry_count;
    127 	u_int8_t	rqs_entry_type;
    128 	u_int8_t	rqs_flags;
    129 	u_int8_t	rqs_seqno;
    130 #else
    131 	u_int8_t	rqs_entry_type;
    132 	u_int8_t	rqs_entry_count;
    133 	u_int8_t	rqs_seqno;
    134 	u_int8_t	rqs_flags;
    135 #endif
    136 } isphdr_t;
    137 
    138 /* RQS Flag definitions */
    139 #define	RQSFLAG_CONTINUATION	0x01
    140 #define	RQSFLAG_FULL		0x02
    141 #define	RQSFLAG_BADHEADER	0x04
    142 #define	RQSFLAG_BADPACKET	0x08
    143 /* RQS entry_type definitions */
    144 #define	RQSTYPE_REQUEST		1
    145 #define	RQSTYPE_DATASEG		2
    146 #define	RQSTYPE_RESPONSE	3
    147 #define	RQSTYPE_MARKER		4
    148 #define	RQSTYPE_CMDONLY		5
    149 
    150 
    151 #define	ISP_RQDSEG	4
    152 typedef struct {
    153 	isphdr_t	req_header;
    154 	u_int32_t	req_handle;
    155 #if BYTE_ORDER == BIG_ENDIAN
    156 	u_int8_t	req_target;
    157 	u_int8_t	req_lun_trn;
    158 #else
    159 	u_int8_t	req_lun_trn;
    160 	u_int8_t	req_target;
    161 #endif
    162 	u_int16_t	req_cdblen;
    163 #define	req_modifier	req_cdblen	/* marker packet */
    164 	u_int16_t	req_flags;
    165 	u_int16_t	_res1;
    166 	u_int16_t	req_time;
    167 	u_int16_t	req_seg_count;
    168 	u_int8_t	req_cdb[12];
    169 	ispds_t		req_dataseg[ISP_RQDSEG];
    170 } ispreq_t;
    171 
    172 /* req_flag values */
    173 #define	REQFLAG_NODISCON	0x0001
    174 #define	REQFLAG_HTAG		0x0002
    175 #define	REQFLAG_OTAG		0x0004
    176 #define	REQFLAG_STAG		0x0008
    177 #define	REQFLAG_TARGET_RTN	0x0010
    178 
    179 #define	REQFLAG_NODATA		0x0000
    180 #define	REQFLAG_DATA_IN		0x0020
    181 #define	REQFLAG_DATA_OUT	0x0040
    182 #define	REQFLAG_DATA_UNKNOWN	0x0060
    183 
    184 #define	REQFLAG_DISARQ		0x0100
    185 
    186 typedef struct {
    187 	isphdr_t	req_header;
    188 	u_int32_t	req_handle;
    189 #if	BYTE_ORDER == BIG_ENDIAN
    190 	u_int8_t	req_target;
    191 	u_int8_t	req_lun_trn;
    192 #else
    193 	u_int8_t	req_lun_trn;
    194 	u_int8_t	req_target;
    195 #endif
    196 	u_int16_t	req_cdblen;
    197 	u_int16_t	req_flags;
    198 	u_int16_t	_res1;
    199 	u_int16_t	req_time;
    200 	u_int16_t	req_seg_count;
    201 	u_int8_t	req_cdb[44];
    202 } ispextreq_t;
    203 
    204 #define	ISP_CDSEG	7
    205 typedef struct {
    206 	isphdr_t	req_header;
    207 	u_int32_t	_res1;
    208 	ispds_t		req_dataseg[ISP_CDSEG];
    209 } ispcontreq_t;
    210 
    211 typedef struct {
    212 	isphdr_t	req_header;
    213 	u_int32_t	_res1;
    214 #if	BYTE_ORDER == BIG_ENDIAN
    215 	u_int8_t	req_target;
    216 	u_int8_t	req_lun_trn;
    217 	u_int8_t	_res2;
    218 	u_int8_t	req_modifier;
    219 #else
    220 	u_int8_t	req_lun_trn;
    221 	u_int8_t	req_target;
    222 	u_int8_t	req_modifier;
    223 	u_int8_t	_res2;
    224 #endif
    225 } ipsmarkreq_t;
    226 
    227 #define SYNC_DEVICE	0
    228 #define SYNC_TARGET	1
    229 #define SYNC_ALL	2
    230 
    231 typedef struct {
    232 	isphdr_t	req_header;
    233 	u_int32_t	req_handle;
    234 	u_int16_t	req_scsi_status;
    235 	u_int16_t	req_completion_status;
    236 	u_int16_t	req_state_flags;
    237 	u_int16_t	req_status_flags;
    238 	u_int16_t	req_time;
    239 	u_int16_t	req_sense_len;
    240 	u_int32_t	req_resid;
    241 	u_int8_t	_res1[8];
    242 	u_int8_t	req_sense_data[32];
    243 } ispstatusreq_t;
    244 
    245 #define RQCS_COMPLETE			0x0000
    246 #define RQCS_INCOMPLETE			0x0001
    247 #define RQCS_DMA_ERROR			0x0002
    248 #define RQCS_TRANSPORT_ERROR		0x0003
    249 #define RQCS_RESET_OCCURRED		0x0004
    250 #define RQCS_ABORTED			0x0005
    251 #define RQCS_TIMEOUT			0x0006
    252 #define RQCS_DATA_OVERRUN		0x0007
    253 #define RQCS_COMMAND_OVERRUN		0x0008
    254 #define RQCS_STATUS_OVERRUN		0x0009
    255 #define RQCS_BAD_MESSAGE		0x000a
    256 #define RQCS_NO_MESSAGE_OUT		0x000b
    257 #define RQCS_EXT_ID_FAILED		0x000c
    258 #define RQCS_IDE_MSG_FAILED		0x000d
    259 #define RQCS_ABORT_MSG_FAILED		0x000e
    260 #define RQCS_REJECT_MSG_FAILED		0x000f
    261 #define RQCS_NOP_MSG_FAILED		0x0010
    262 #define RQCS_PARITY_ERROR_MSG_FAILED	0x0011
    263 #define RQCS_DEVICE_RESET_MSG_FAILED	0x0012
    264 #define RQCS_ID_MSG_FAILED		0x0013
    265 #define RQCS_UNEXP_BUS_FREE		0x0014
    266 #define RQCS_DATA_UNDERRUN		0x0015
    267 
    268 
    269 #define RQSF_GOT_BUS			0x0100
    270 #define RQSF_GOT_TARGET			0x0200
    271 #define RQSF_SENT_CDB			0x0400
    272 #define RQSF_TRANFERRED_DATA		0x0800
    273 #define RQSF_GOT_STATUS			0x1000
    274 #define RQSF_GOT_SENSE			0x2000
    275 
    276 #define RQSTF_DISCONNECT		0x0001
    277 #define RQSTF_SYNCHRONOUS		0x0002
    278 #define RQSTF_PARITY_ERROR		0x0004
    279 #define RQSTF_BUS_RESET			0x0008
    280 #define RQSTF_DEVICE_RESET		0x0010
    281 #define RQSTF_ABORTED			0x0020
    282 #define RQSTF_TIMEOUT			0x0040
    283 #define RQSTF_NEGOTIATION		0x0080
    284 
    285 #endif	/* _ISPMBOX_H */
    286