[SCSI] ibmvscsi: switch to block timeout
[linux-2.6.git] / drivers / scsi / ibmvscsi / viosrp.h
1 /*****************************************************************************/
2 /* srp.h -- SCSI RDMA Protocol definitions                                   */
3 /*                                                                           */
4 /* Written By: Colin Devilbis, IBM Corporation                               */
5 /*                                                                           */
6 /* Copyright (C) 2003 IBM Corporation                                        */
7 /*                                                                           */
8 /* This program is free software; you can redistribute it and/or modify      */
9 /* it under the terms of the GNU General Public License as published by      */
10 /* the Free Software Foundation; either version 2 of the License, or         */
11 /* (at your option) any later version.                                       */
12 /*                                                                           */
13 /* This program is distributed in the hope that it will be useful,           */
14 /* but WITHOUT ANY WARRANTY; without even the implied warranty of            */
15 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             */
16 /* GNU General Public License for more details.                              */
17 /*                                                                           */
18 /* You should have received a copy of the GNU General Public License         */
19 /* along with this program; if not, write to the Free Software               */
20 /* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
21 /*                                                                           */
22 /*                                                                           */
23 /* This file contains structures and definitions for IBM RPA (RS/6000        */
24 /* platform architecture) implementation of the SRP (SCSI RDMA Protocol)     */
25 /* standard.  SRP is used on IBM iSeries and pSeries platforms to send SCSI  */
26 /* commands between logical partitions.                                      */
27 /*                                                                           */
28 /* SRP Information Units (IUs) are sent on a "Command/Response Queue" (CRQ)  */
29 /* between partitions.  The definitions in this file are architected,        */
30 /* and cannot be changed without breaking compatibility with other versions  */
31 /* of Linux and other operating systems (AIX, OS/400) that talk this protocol*/
32 /* between logical partitions                                                */
33 /*****************************************************************************/
34 #ifndef VIOSRP_H
35 #define VIOSRP_H
36 #include <scsi/srp.h>
37
38 #define SRP_VERSION "16.a"
39 #define SRP_MAX_IU_LEN  256
40
41 union srp_iu {
42         struct srp_login_req login_req;
43         struct srp_login_rsp login_rsp;
44         struct srp_login_rej login_rej;
45         struct srp_i_logout i_logout;
46         struct srp_t_logout t_logout;
47         struct srp_tsk_mgmt tsk_mgmt;
48         struct srp_cmd cmd;
49         struct srp_rsp rsp;
50         u8 reserved[SRP_MAX_IU_LEN];
51 };
52
53 enum viosrp_crq_formats {
54         VIOSRP_SRP_FORMAT = 0x01,
55         VIOSRP_MAD_FORMAT = 0x02,
56         VIOSRP_OS400_FORMAT = 0x03,
57         VIOSRP_AIX_FORMAT = 0x04,
58         VIOSRP_LINUX_FORMAT = 0x06,
59         VIOSRP_INLINE_FORMAT = 0x07
60 };
61
62 enum viosrp_crq_status {
63         VIOSRP_OK = 0x0,
64         VIOSRP_NONRECOVERABLE_ERR = 0x1,
65         VIOSRP_VIOLATES_MAX_XFER = 0x2,
66         VIOSRP_PARTNER_PANIC = 0x3,
67         VIOSRP_DEVICE_BUSY = 0x8,
68         VIOSRP_ADAPTER_FAIL = 0x10,
69         VIOSRP_OK2 = 0x99,
70 };
71
72 struct viosrp_crq {
73         u8 valid;               /* used by RPA */
74         u8 format;              /* SCSI vs out-of-band */
75         u8 reserved;
76         u8 status;              /* non-scsi failure? (e.g. DMA failure) */
77         u16 timeout;            /* in seconds */
78         u16 IU_length;          /* in bytes */
79         u64 IU_data_ptr;        /* the TCE for transferring data */
80 };
81
82 /* MADs are Management requests above and beyond the IUs defined in the SRP
83  * standard.  
84  */
85 enum viosrp_mad_types {
86         VIOSRP_EMPTY_IU_TYPE = 0x01,
87         VIOSRP_ERROR_LOG_TYPE = 0x02,
88         VIOSRP_ADAPTER_INFO_TYPE = 0x03,
89         VIOSRP_HOST_CONFIG_TYPE = 0x04
90 };
91
92 /* 
93  * Common MAD header
94  */
95 struct mad_common {
96         u32 type;
97         u16 status;
98         u16 length;
99         u64 tag;
100 };
101
102 /*
103  * All SRP (and MAD) requests normally flow from the
104  * client to the server.  There is no way for the server to send
105  * an asynchronous message back to the client.  The Empty IU is used
106  * to hang out a meaningless request to the server so that it can respond
107  * asynchrouously with something like a SCSI AER 
108  */
109 struct viosrp_empty_iu {
110         struct mad_common common;
111         u64 buffer;
112         u32 port;
113 };
114
115 struct viosrp_error_log {
116         struct mad_common common;
117         u64 buffer;
118 };
119
120 struct viosrp_adapter_info {
121         struct mad_common common;
122         u64 buffer;
123 };
124
125 struct viosrp_host_config {
126         struct mad_common common;
127         u64 buffer;
128 };
129
130 union mad_iu {
131         struct viosrp_empty_iu empty_iu;
132         struct viosrp_error_log error_log;
133         struct viosrp_adapter_info adapter_info;
134         struct viosrp_host_config host_config;
135 };
136
137 union viosrp_iu {
138         union srp_iu srp;
139         union mad_iu mad;
140 };
141
142 struct mad_adapter_info_data {
143         char srp_version[8];
144         char partition_name[96];
145         u32 partition_number;
146         u32 mad_version;
147         u32 os_type;
148         u32 port_max_txu[8];    /* per-port maximum transfer */
149 };
150
151 #endif