4 * Global definitions for the zfcp device driver.
6 * Copyright IBM Corporation 2002, 2010
12 /*************************** INCLUDES *****************************************/
14 #include <linux/init.h>
15 #include <linux/moduleparam.h>
16 #include <linux/major.h>
17 #include <linux/blkdev.h>
18 #include <linux/delay.h>
19 #include <linux/timer.h>
20 #include <linux/slab.h>
21 #include <linux/mempool.h>
22 #include <linux/syscalls.h>
23 #include <linux/scatterlist.h>
24 #include <linux/ioctl.h>
25 #include <scsi/fc/fc_fs.h>
26 #include <scsi/fc/fc_gs.h>
27 #include <scsi/scsi.h>
28 #include <scsi/scsi_tcq.h>
29 #include <scsi/scsi_cmnd.h>
30 #include <scsi/scsi_device.h>
31 #include <scsi/scsi_host.h>
32 #include <scsi/scsi_transport.h>
33 #include <scsi/scsi_transport_fc.h>
34 #include <scsi/scsi_bsg_fc.h>
35 #include <asm/ccwdev.h>
36 #include <asm/debug.h>
37 #include <asm/ebcdic.h>
38 #include <asm/sysinfo.h>
40 #include "zfcp_qdio.h"
44 /********************* SCSI SPECIFIC DEFINES *********************************/
45 #define ZFCP_SCSI_ER_TIMEOUT (10*HZ)
47 /********************* FSF SPECIFIC DEFINES *********************************/
49 /* ATTENTION: value must not be used by hardware */
50 #define FSF_QTCB_UNSOLICITED_STATUS 0x6305
52 /* timeout value for "default timer" for fsf requests */
53 #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
55 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
58 * Note, the leftmost status byte is common among adapter, port
61 #define ZFCP_COMMON_FLAGS 0xfff00000
63 /* common status bits */
64 #define ZFCP_STATUS_COMMON_RUNNING 0x40000000
65 #define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000
66 #define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000
67 #define ZFCP_STATUS_COMMON_OPEN 0x04000000
68 #define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000
69 #define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000
70 #define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000
71 #define ZFCP_STATUS_COMMON_NOESC 0x00200000
74 #define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002
75 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008
76 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010
77 #define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100
78 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200
80 /* remote port status */
81 #define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001
82 #define ZFCP_STATUS_PORT_LINK_TEST 0x00000002
84 /* logical unit status */
85 #define ZFCP_STATUS_UNIT_SHARED 0x00000004
86 #define ZFCP_STATUS_UNIT_READONLY 0x00000008
88 /* FSF request status (this does not have a common part) */
89 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT 0x00000002
90 #define ZFCP_STATUS_FSFREQ_ERROR 0x00000008
91 #define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010
92 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040
93 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080
94 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200
95 #define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000
97 /************************* STRUCTURE DEFINITIONS *****************************/
101 /* holds various memory pools of an adapter */
102 struct zfcp_adapter_mempool {
104 mempool_t *gid_pn_req;
106 mempool_t *scsi_abort;
107 mempool_t *status_read_req;
108 mempool_t *status_read_data;
110 mempool_t *qtcb_pool;
113 struct zfcp_erp_action {
114 struct list_head list;
115 int action; /* requested action code */
116 struct zfcp_adapter *adapter; /* device which should be recovered */
117 struct zfcp_port *port;
118 struct zfcp_unit *unit;
119 u32 status; /* recovery status */
120 u32 step; /* active step of this erp action */
121 unsigned long fsf_req_id;
122 struct timer_list timer;
125 struct fsf_latency_record {
131 struct latency_cont {
132 struct fsf_latency_record channel;
133 struct fsf_latency_record fabric;
137 struct zfcp_latencies {
138 struct latency_cont read;
139 struct latency_cont write;
140 struct latency_cont cmd;
144 struct zfcp_adapter {
146 u64 peer_wwnn; /* P2P peer WWNN */
147 u64 peer_wwpn; /* P2P peer WWPN */
148 u32 peer_d_id; /* P2P peer D_ID */
149 struct ccw_device *ccw_device; /* S/390 ccw device */
150 struct zfcp_qdio *qdio;
151 u32 hydra_version; /* Hydra version */
153 u32 adapter_features; /* FCP channel features */
154 u32 connection_features; /* host connection features */
155 u32 hardware_version; /* of FCP channel */
156 u16 timer_ticks; /* time int for a tick */
157 struct Scsi_Host *scsi_host; /* Pointer to mid-layer */
158 struct list_head port_list; /* remote port list */
159 rwlock_t port_list_lock; /* port list lock */
160 unsigned long req_no; /* unique FSF req number */
161 struct zfcp_reqlist *req_list;
162 u32 fsf_req_seq_no; /* FSF cmnd seq number */
163 rwlock_t abort_lock; /* Protects against SCSI
166 atomic_t stat_miss; /* # missing status reads*/
167 unsigned int stat_read_buf_num;
168 struct work_struct stat_work;
169 atomic_t status; /* status of this adapter */
170 struct list_head erp_ready_head; /* error recovery for this
172 wait_queue_head_t erp_ready_wq;
173 struct list_head erp_running_head;
175 wait_queue_head_t erp_done_wqh;
176 struct zfcp_erp_action erp_action; /* pending error recovery */
177 atomic_t erp_counter;
178 u32 erp_total_count; /* total nr of enqueued erp
180 u32 erp_low_mem_count; /* nr of erp actions waiting
182 struct task_struct *erp_thread;
183 struct zfcp_fc_wka_ports *gs; /* generic services */
184 struct zfcp_dbf *dbf; /* debug traces */
185 struct zfcp_adapter_mempool pool; /* Adapter memory pools */
186 struct fc_host_statistics *fc_stats;
187 struct fsf_qtcb_bottom_port *stats_reset_data;
188 unsigned long stats_reset;
189 struct work_struct scan_work;
190 struct service_level service_level;
191 struct workqueue_struct *work_queue;
192 struct device_dma_parameters dma_parms;
197 struct fc_rport *rport; /* rport of fc transport class */
198 struct list_head list; /* list of remote ports */
199 struct zfcp_adapter *adapter; /* adapter used to access port */
200 struct list_head unit_list; /* head of logical unit list */
201 rwlock_t unit_list_lock; /* unit list lock */
202 atomic_t status; /* status of this remote port */
203 u64 wwnn; /* WWNN if known */
206 u32 handle; /* handle assigned by FSF */
207 struct zfcp_erp_action erp_action; /* pending error recovery */
208 atomic_t erp_counter;
210 u32 supported_classes;
211 struct work_struct gid_pn_work;
212 struct work_struct test_link_work;
213 struct work_struct rport_work;
214 enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task;
219 struct list_head list; /* list of logical units */
220 struct zfcp_port *port; /* remote port of unit */
221 atomic_t status; /* status of this logical unit */
222 u64 fcp_lun; /* own FCP_LUN */
223 u32 handle; /* handle assigned by FSF */
224 struct scsi_device *device; /* scsi device struct pointer */
225 struct zfcp_erp_action erp_action; /* pending error recovery */
226 atomic_t erp_counter;
227 struct zfcp_latencies latencies;
228 struct work_struct scsi_work;
232 * struct zfcp_fsf_req - basic FSF request structure
233 * @list: list of FSF requests
234 * @req_id: unique request ID
235 * @adapter: adapter this request belongs to
236 * @qdio_req: qdio queue related values
237 * @completion: used to signal the completion of the request
238 * @status: status of the request
239 * @fsf_command: FSF command issued
240 * @qtcb: associated QTCB
241 * @seq_no: sequence number of this request
242 * @data: private data
243 * @timer: timer data of this request
244 * @erp_action: reference to erp action if request issued on behalf of ERP
245 * @pool: reference to memory pool if used for this request
246 * @issued: time when request was send (STCK)
247 * @unit: reference to unit if this request is a SCSI request
248 * @handler: handler which should be called to process response
250 struct zfcp_fsf_req {
251 struct list_head list;
252 unsigned long req_id;
253 struct zfcp_adapter *adapter;
254 struct zfcp_qdio_req qdio_req;
255 struct completion completion;
258 struct fsf_qtcb *qtcb;
261 struct timer_list timer;
262 struct zfcp_erp_action *erp_action;
264 unsigned long long issued;
265 struct zfcp_unit *unit;
266 void (*handler)(struct zfcp_fsf_req *);
271 struct scsi_host_template scsi_host_template;
272 struct scsi_transport_template *scsi_transport_template;
273 struct kmem_cache *gpn_ft_cache;
274 struct kmem_cache *qtcb_cache;
275 struct kmem_cache *sr_buffer_cache;
276 struct kmem_cache *gid_pn_cache;
277 struct kmem_cache *adisc_cache;
280 /********************** ZFCP SPECIFIC DEFINES ********************************/
282 #define ZFCP_SET 0x00000100
283 #define ZFCP_CLEAR 0x00000200
285 #endif /* ZFCP_DEF_H */