xref: /openbmc/linux/drivers/s390/block/dasd_int.h (revision 44ecda71)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
4  *		    Horst Hummel <Horst.Hummel@de.ibm.com>
5  *		    Martin Schwidefsky <schwidefsky@de.ibm.com>
6  * Bugreports.to..: <Linux390@de.ibm.com>
7  * Copyright IBM Corp. 1999, 2009
8  */
9 
10 #ifndef DASD_INT_H
11 #define DASD_INT_H
12 
13 /* we keep old device allocation scheme; IOW, minors are still in 0..255 */
14 #define DASD_PER_MAJOR (1U << (MINORBITS - DASD_PARTN_BITS))
15 #define DASD_PARTN_MASK ((1 << DASD_PARTN_BITS) - 1)
16 
17 /*
18  * States a dasd device can have:
19  *   new: the dasd_device structure is allocated.
20  *   known: the discipline for the device is identified.
21  *   basic: the device can do basic i/o.
22  *   unfmt: the device could not be analyzed (format is unknown).
23  *   ready: partition detection is done and the device is can do block io.
24  *   online: the device accepts requests from the block device queue.
25  *
26  * Things to do for startup state transitions:
27  *   new -> known: find discipline for the device and create devfs entries.
28  *   known -> basic: request irq line for the device.
29  *   basic -> ready: do the initial analysis, e.g. format detection,
30  *                   do block device setup and detect partitions.
31  *   ready -> online: schedule the device tasklet.
32  * Things to do for shutdown state transitions:
33  *   online -> ready: just set the new device state.
34  *   ready -> basic: flush requests from the block device layer, clear
35  *                   partition information and reset format information.
36  *   basic -> known: terminate all requests and free irq.
37  *   known -> new: remove devfs entries and forget discipline.
38  */
39 
40 #define DASD_STATE_NEW	  0
41 #define DASD_STATE_KNOWN  1
42 #define DASD_STATE_BASIC  2
43 #define DASD_STATE_UNFMT  3
44 #define DASD_STATE_READY  4
45 #define DASD_STATE_ONLINE 5
46 
47 #include <linux/module.h>
48 #include <linux/wait.h>
49 #include <linux/blkdev.h>
50 #include <linux/hdreg.h>
51 #include <linux/interrupt.h>
52 #include <linux/log2.h>
53 #include <asm/ccwdev.h>
54 #include <linux/workqueue.h>
55 #include <asm/debug.h>
56 #include <asm/dasd.h>
57 #include <asm/idals.h>
58 #include <linux/bitops.h>
59 #include <linux/blk-mq.h>
60 
61 /* DASD discipline magic */
62 #define DASD_ECKD_MAGIC 0xC5C3D2C4
63 #define DASD_DIAG_MAGIC 0xC4C9C1C7
64 #define DASD_FBA_MAGIC 0xC6C2C140
65 
66 /*
67  * SECTION: Type definitions
68  */
69 struct dasd_device;
70 struct dasd_block;
71 
72 /* BIT DEFINITIONS FOR SENSE DATA */
73 #define DASD_SENSE_BIT_0 0x80
74 #define DASD_SENSE_BIT_1 0x40
75 #define DASD_SENSE_BIT_2 0x20
76 #define DASD_SENSE_BIT_3 0x10
77 
78 /* BIT DEFINITIONS FOR SIM SENSE */
79 #define DASD_SIM_SENSE 0x0F
80 #define DASD_SIM_MSG_TO_OP 0x03
81 #define DASD_SIM_LOG 0x0C
82 
83 /* lock class for nested cdev lock */
84 #define CDEV_NESTED_FIRST 1
85 #define CDEV_NESTED_SECOND 2
86 
87 /*
88  * SECTION: MACROs for klogd and s390 debug feature (dbf)
89  */
90 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
91 do { \
92 	debug_sprintf_event(d_device->debug_area, \
93 			    d_level, \
94 			    d_str "\n", \
95 			    d_data); \
96 } while(0)
97 
98 #define DBF_EVENT(d_level, d_str, d_data...)\
99 do { \
100 	debug_sprintf_event(dasd_debug_area, \
101 			    d_level,\
102 			    d_str "\n", \
103 			    d_data); \
104 } while(0)
105 
106 #define DBF_EVENT_DEVID(d_level, d_cdev, d_str, d_data...)	\
107 do { \
108 	struct ccw_dev_id __dev_id;			\
109 	ccw_device_get_id(d_cdev, &__dev_id);		\
110 	debug_sprintf_event(dasd_debug_area,		\
111 			    d_level,					\
112 			    "0.%x.%04x " d_str "\n",			\
113 			    __dev_id.ssid, __dev_id.devno, d_data);	\
114 } while (0)
115 
116 /* limit size for an errorstring */
117 #define ERRORLENGTH 30
118 
119 /* definition of dbf debug levels */
120 #define	DBF_EMERG	0	/* system is unusable			*/
121 #define	DBF_ALERT	1	/* action must be taken immediately	*/
122 #define	DBF_CRIT	2	/* critical conditions			*/
123 #define	DBF_ERR		3	/* error conditions			*/
124 #define	DBF_WARNING	4	/* warning conditions			*/
125 #define	DBF_NOTICE	5	/* normal but significant condition	*/
126 #define	DBF_INFO	6	/* informational			*/
127 #define	DBF_DEBUG	6	/* debug-level messages			*/
128 
129 /* messages to be written via klogd and dbf */
130 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
131 do { \
132 	printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
133 	       dev_name(&d_device->cdev->dev), d_args); \
134 	DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
135 } while(0)
136 
137 #define MESSAGE(d_loglevel,d_string,d_args...)\
138 do { \
139 	printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
140 	DBF_EVENT(DBF_ALERT, d_string, d_args); \
141 } while(0)
142 
143 /* messages to be written via klogd only */
144 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
145 do { \
146 	printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
147 	       dev_name(&d_device->cdev->dev), d_args); \
148 } while(0)
149 
150 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
151 do { \
152 	printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
153 } while(0)
154 
155 /* Macro to calculate number of blocks per page */
156 #define BLOCKS_PER_PAGE(blksize) (PAGE_SIZE / blksize)
157 
158 struct dasd_ccw_req {
159 	unsigned int magic;		/* Eye catcher */
160 	int intrc;			/* internal error, e.g. from start_IO */
161 	struct list_head devlist;	/* for dasd_device request queue */
162 	struct list_head blocklist;	/* for dasd_block request queue */
163 	struct dasd_block *block;	/* the originating block device */
164 	struct dasd_device *memdev;	/* the device used to allocate this */
165 	struct dasd_device *startdev;	/* device the request is started on */
166 	struct dasd_device *basedev;	/* base device if no block->base */
167 	void *cpaddr;			/* address of ccw or tcw */
168 	short retries;			/* A retry counter */
169 	unsigned char cpmode;		/* 0 = cmd mode, 1 = itcw */
170 	char status;			/* status of this request */
171 	char lpm;			/* logical path mask */
172 	unsigned long flags;        	/* flags of this request */
173 	struct dasd_queue *dq;
174 	unsigned long starttime;	/* jiffies time of request start */
175 	unsigned long expires;		/* expiration period in jiffies */
176 	void *data;			/* pointer to data area */
177 	struct irb irb;			/* device status in case of an error */
178 	struct dasd_ccw_req *refers;	/* ERP-chain queueing. */
179 	void *function; 		/* originating ERP action */
180 	void *mem_chunk;
181 
182 	unsigned long buildclk;		/* TOD-clock of request generation */
183 	unsigned long startclk;		/* TOD-clock of request start */
184 	unsigned long stopclk;		/* TOD-clock of request interrupt */
185 	unsigned long endclk;		/* TOD-clock of request termination */
186 
187 	void (*callback)(struct dasd_ccw_req *, void *data);
188 	void *callback_data;
189 	unsigned int proc_bytes;	/* bytes for partial completion */
190 	unsigned int trkcount;		/* count formatted tracks */
191 };
192 
193 /*
194  * dasd_ccw_req -> status can be:
195  */
196 #define DASD_CQR_FILLED 	0x00	/* request is ready to be processed */
197 #define DASD_CQR_DONE		0x01	/* request is completed successfully */
198 #define DASD_CQR_NEED_ERP	0x02	/* request needs recovery action */
199 #define DASD_CQR_IN_ERP 	0x03	/* request is in recovery */
200 #define DASD_CQR_FAILED 	0x04	/* request is finally failed */
201 #define DASD_CQR_TERMINATED	0x05	/* request was stopped by driver */
202 
203 #define DASD_CQR_QUEUED 	0x80	/* request is queued to be processed */
204 #define DASD_CQR_IN_IO		0x81	/* request is currently in IO */
205 #define DASD_CQR_ERROR		0x82	/* request is completed with error */
206 #define DASD_CQR_CLEAR_PENDING	0x83	/* request is clear pending */
207 #define DASD_CQR_CLEARED	0x84	/* request was cleared */
208 #define DASD_CQR_SUCCESS	0x85	/* request was successful */
209 
210 /* default expiration time*/
211 #define DASD_EXPIRES	  300
212 #define DASD_EXPIRES_MAX  40000000
213 #define DASD_RETRIES	  256
214 #define DASD_RETRIES_MAX  32768
215 
216 /* per dasd_ccw_req flags */
217 #define DASD_CQR_FLAGS_USE_ERP   0	/* use ERP for this request */
218 #define DASD_CQR_FLAGS_FAILFAST  1	/* FAILFAST */
219 #define DASD_CQR_VERIFY_PATH	 2	/* path verification request */
220 #define DASD_CQR_ALLOW_SLOCK	 3	/* Try this request even when lock was
221 					 * stolen. Should not be combined with
222 					 * DASD_CQR_FLAGS_USE_ERP
223 					 */
224 /*
225  * The following flags are used to suppress output of certain errors.
226  */
227 #define DASD_CQR_SUPPRESS_NRF	4	/* Suppress 'No Record Found' error */
228 #define DASD_CQR_SUPPRESS_FP	5	/* Suppress 'File Protected' error*/
229 #define DASD_CQR_SUPPRESS_IL	6	/* Suppress 'Incorrect Length' error */
230 #define DASD_CQR_SUPPRESS_CR	7	/* Suppress 'Command Reject' error */
231 
232 #define DASD_REQ_PER_DEV 4
233 
234 /* Signature for error recovery functions. */
235 typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
236 
237 /*
238  * A single CQR can only contain a maximum of 255 CCWs. It is limited by
239  * the locate record and locate record extended count value which can only hold
240  * 1 Byte max.
241  */
242 #define DASD_CQR_MAX_CCW 255
243 
244 /*
245  * Unique identifier for dasd device.
246  */
247 #define UA_NOT_CONFIGURED  0x00
248 #define UA_BASE_DEVICE	   0x01
249 #define UA_BASE_PAV_ALIAS  0x02
250 #define UA_HYPER_PAV_ALIAS 0x03
251 
252 struct dasd_uid {
253 	__u8 type;
254 	char vendor[4];
255 	char serial[15];
256 	__u16 ssid;
257 	__u8 real_unit_addr;
258 	__u8 base_unit_addr;
259 	char vduit[33];
260 };
261 
262 /*
263  * PPRC Status data
264  */
265 struct dasd_pprc_header {
266 	__u8 entries;		/* 0     Number of device entries */
267 	__u8 unused;		/* 1     unused */
268 	__u16 entry_length;	/* 2-3   Length of device entry */
269 	__u32 unused2;		/* 4-7   unused */
270 } __packed;
271 
272 struct dasd_pprc_dev_info {
273 	__u8 state;		/* 0       Copy State */
274 	__u8 flags;		/* 1       Flags */
275 	__u8 reserved1[2];	/* 2-3     reserved */
276 	__u8 prim_lss;		/* 4       Primary device LSS */
277 	__u8 primary;		/* 5       Primary device address */
278 	__u8 sec_lss;		/* 6       Secondary device LSS */
279 	__u8 secondary;		/* 7       Secondary device address */
280 	__u16 pprc_id;		/* 8-9     Peer-to-Peer Remote Copy ID */
281 	__u8 reserved2[12];	/* 10-21   reserved */
282 	__u16 prim_cu_ssid;	/* 22-23   Pimary Control Unit SSID */
283 	__u8 reserved3[12];	/* 24-35   reserved */
284 	__u16 sec_cu_ssid;	/* 36-37   Secondary Control Unit SSID */
285 	__u8 reserved4[90];	/* 38-127  reserved */
286 } __packed;
287 
288 struct dasd_pprc_data_sc4 {
289 	struct dasd_pprc_header header;
290 	struct dasd_pprc_dev_info dev_info[5];
291 } __packed;
292 
293 #define DASD_BUS_ID_SIZE 20
294 #define DASD_CP_ENTRIES 5
295 
296 struct dasd_copy_entry {
297 	char busid[DASD_BUS_ID_SIZE];
298 	struct dasd_device *device;
299 	bool primary;
300 	bool configured;
301 };
302 
303 struct dasd_copy_relation {
304 	struct dasd_copy_entry entry[DASD_CP_ENTRIES];
305 	struct dasd_copy_entry *active;
306 };
307 
308 int dasd_devmap_set_device_copy_relation(struct ccw_device *,
309 					 bool pprc_enabled);
310 
311 /*
312  * the struct dasd_discipline is
313  * sth like a table of virtual functions, if you think of dasd_eckd
314  * inheriting dasd...
315  * no, currently we are not planning to reimplement the driver in C++
316  */
317 struct dasd_discipline {
318 	struct module *owner;
319 	char ebcname[8];	/* a name used for tagging and printks */
320 	char name[8];		/* a name used for tagging and printks */
321 
322 	struct list_head list;	/* used for list of disciplines */
323 
324 	/*
325 	 * Device recognition functions. check_device is used to verify
326 	 * the sense data and the information returned by read device
327 	 * characteristics. It returns 0 if the discipline can be used
328 	 * for the device in question. uncheck_device is called during
329 	 * device shutdown to deregister a device from its discipline.
330 	 */
331 	int (*check_device) (struct dasd_device *);
332 	void (*uncheck_device) (struct dasd_device *);
333 
334 	/*
335 	 * do_analysis is used in the step from device state "basic" to
336 	 * state "accept". It returns 0 if the device can be made ready,
337 	 * it returns -EMEDIUMTYPE if the device can't be made ready or
338 	 * -EAGAIN if do_analysis started a ccw that needs to complete
339 	 * before the analysis may be repeated.
340 	 */
341 	int (*do_analysis) (struct dasd_block *);
342 
343 	/*
344 	 * This function is called, when new paths become available.
345 	 * Disciplins may use this callback to do necessary setup work,
346 	 * e.g. verify that new path is compatible with the current
347 	 * configuration.
348 	 */
349 	int (*pe_handler)(struct dasd_device *, __u8, __u8);
350 
351 	/*
352 	 * Last things to do when a device is set online, and first things
353 	 * when it is set offline.
354 	 */
355 	int (*basic_to_ready) (struct dasd_device *);
356 	int (*online_to_ready) (struct dasd_device *);
357 	int (*basic_to_known)(struct dasd_device *);
358 
359 	/*
360 	 * Initialize block layer request queue.
361 	 */
362 	void (*setup_blk_queue)(struct dasd_block *);
363 	/* (struct dasd_device *);
364 	 * Device operation functions. build_cp creates a ccw chain for
365 	 * a block device request, start_io starts the request and
366 	 * term_IO cancels it (e.g. in case of a timeout). format_device
367 	 * formats the device and check_device_format compares the format of
368 	 * a device with the expected format_data.
369 	 * handle_terminated_request allows to examine a cqr and prepare
370 	 * it for retry.
371 	 */
372 	struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
373 					  struct dasd_block *,
374 					  struct request *);
375 	int (*start_IO) (struct dasd_ccw_req *);
376 	int (*term_IO) (struct dasd_ccw_req *);
377 	void (*handle_terminated_request) (struct dasd_ccw_req *);
378 	int (*format_device) (struct dasd_device *,
379 			      struct format_data_t *, int);
380 	int (*check_device_format)(struct dasd_device *,
381 				   struct format_check_t *, int);
382 	int (*free_cp) (struct dasd_ccw_req *, struct request *);
383 
384 	/*
385 	 * Error recovery functions. examine_error() returns a value that
386 	 * indicates what to do for an error condition. If examine_error()
387 	 * returns 'dasd_era_recover' erp_action() is called to create a
388 	 * special error recovery ccw. erp_postaction() is called after
389 	 * an error recovery ccw has finished its execution. dump_sense
390 	 * is called for every error condition to print the sense data
391 	 * to the console.
392 	 */
393 	dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
394 	dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
395 	void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
396 			    struct irb *);
397 	void (*dump_sense_dbf) (struct dasd_device *, struct irb *, char *);
398 	void (*check_for_device_change) (struct dasd_device *,
399 					 struct dasd_ccw_req *,
400 					 struct irb *);
401 
402         /* i/o control functions. */
403 	int (*fill_geometry) (struct dasd_block *, struct hd_geometry *);
404 	int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
405 	int (*ioctl) (struct dasd_block *, unsigned int, void __user *);
406 
407 	/* reload device after state change */
408 	int (*reload) (struct dasd_device *);
409 
410 	int (*get_uid) (struct dasd_device *, struct dasd_uid *);
411 	void (*kick_validate) (struct dasd_device *);
412 	int (*check_attention)(struct dasd_device *, __u8);
413 	int (*host_access_count)(struct dasd_device *);
414 	int (*hosts_print)(struct dasd_device *, struct seq_file *);
415 	void (*handle_hpf_error)(struct dasd_device *, struct irb *);
416 	void (*disable_hpf)(struct dasd_device *);
417 	int (*hpf_enabled)(struct dasd_device *);
418 	void (*reset_path)(struct dasd_device *, __u8);
419 
420 	/*
421 	 * Extent Space Efficient (ESE) relevant functions
422 	 */
423 	int (*is_ese)(struct dasd_device *);
424 	/* Capacity */
425 	int (*space_allocated)(struct dasd_device *);
426 	int (*space_configured)(struct dasd_device *);
427 	int (*logical_capacity)(struct dasd_device *);
428 	int (*release_space)(struct dasd_device *, struct format_data_t *);
429 	/* Extent Pool */
430 	int (*ext_pool_id)(struct dasd_device *);
431 	int (*ext_size)(struct dasd_device *);
432 	int (*ext_pool_cap_at_warnlevel)(struct dasd_device *);
433 	int (*ext_pool_warn_thrshld)(struct dasd_device *);
434 	int (*ext_pool_oos)(struct dasd_device *);
435 	int (*ext_pool_exhaust)(struct dasd_device *, struct dasd_ccw_req *);
436 	struct dasd_ccw_req *(*ese_format)(struct dasd_device *,
437 					   struct dasd_ccw_req *, struct irb *);
438 	int (*ese_read)(struct dasd_ccw_req *, struct irb *);
439 	int (*pprc_status)(struct dasd_device *, struct	dasd_pprc_data_sc4 *);
440 	bool (*pprc_enabled)(struct dasd_device *);
441 	int (*copy_pair_swap)(struct dasd_device *, char *, char *);
442 	int (*device_ping)(struct dasd_device *);
443 };
444 
445 extern struct dasd_discipline *dasd_diag_discipline_pointer;
446 
447 /*
448  * Notification numbers for extended error reporting notifications:
449  * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
450  * eer pointer) is freed. The error reporting module needs to do all necessary
451  * cleanup steps.
452  * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
453  */
454 #define DASD_EER_DISABLE 0
455 #define DASD_EER_TRIGGER 1
456 
457 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
458 #define DASD_EER_FATALERROR  1
459 #define DASD_EER_NOPATH      2
460 #define DASD_EER_STATECHANGE 3
461 #define DASD_EER_PPRCSUSPEND 4
462 #define DASD_EER_NOSPC	     5
463 
464 /* DASD path handling */
465 
466 #define DASD_PATH_OPERATIONAL  1
467 #define DASD_PATH_TBV	       2
468 #define DASD_PATH_PP	       3
469 #define DASD_PATH_NPP	       4
470 #define DASD_PATH_MISCABLED    5
471 #define DASD_PATH_NOHPF        6
472 #define DASD_PATH_CUIR	       7
473 #define DASD_PATH_IFCC	       8
474 #define DASD_PATH_FCSEC	       9
475 
476 #define DASD_THRHLD_MAX		4294967295U
477 #define DASD_INTERVAL_MAX	4294967295U
478 
479 /* FC Endpoint Security Capabilities */
480 #define DASD_FC_SECURITY_UNSUP		0
481 #define DASD_FC_SECURITY_AUTH		1
482 #define DASD_FC_SECURITY_ENC_FCSP2	2
483 #define DASD_FC_SECURITY_ENC_ERAS	3
484 
485 #define DASD_FC_SECURITY_ENC_STR	"Encryption"
486 static const struct {
487 	u8 value;
488 	char *name;
489 } dasd_path_fcs_mnemonics[] = {
490 	{ DASD_FC_SECURITY_UNSUP,	"Unsupported" },
491 	{ DASD_FC_SECURITY_AUTH,	"Authentication" },
492 	{ DASD_FC_SECURITY_ENC_FCSP2,	DASD_FC_SECURITY_ENC_STR },
493 	{ DASD_FC_SECURITY_ENC_ERAS,	DASD_FC_SECURITY_ENC_STR },
494 };
495 
496 static inline char *dasd_path_get_fcs_str(int val)
497 {
498 	int i;
499 
500 	for (i = 0; i < ARRAY_SIZE(dasd_path_fcs_mnemonics); i++) {
501 		if (dasd_path_fcs_mnemonics[i].value == val)
502 			return dasd_path_fcs_mnemonics[i].name;
503 	}
504 
505 	return dasd_path_fcs_mnemonics[0].name;
506 }
507 
508 struct dasd_path {
509 	unsigned long flags;
510 	u8 cssid;
511 	u8 ssid;
512 	u8 chpid;
513 	struct dasd_conf_data *conf_data;
514 	atomic_t error_count;
515 	unsigned long errorclk;
516 	u8 fc_security;
517 	struct kobject kobj;
518 	bool in_sysfs;
519 };
520 
521 #define to_dasd_path(path) container_of(path, struct dasd_path, kobj)
522 
523 static inline void dasd_path_release(struct kobject *kobj)
524 {
525 /* Memory for the dasd_path kobject is freed when dasd_free_device() is called */
526 }
527 
528 
529 struct dasd_profile_info {
530 	/* legacy part of profile data, as in dasd_profile_info_t */
531 	unsigned int dasd_io_reqs;	 /* number of requests processed */
532 	unsigned int dasd_io_sects;	 /* number of sectors processed */
533 	unsigned int dasd_io_secs[32];	 /* histogram of request's sizes */
534 	unsigned int dasd_io_times[32];	 /* histogram of requests's times */
535 	unsigned int dasd_io_timps[32];	 /* h. of requests's times per sector */
536 	unsigned int dasd_io_time1[32];	 /* hist. of time from build to start */
537 	unsigned int dasd_io_time2[32];	 /* hist. of time from start to irq */
538 	unsigned int dasd_io_time2ps[32]; /* hist. of time from start to irq */
539 	unsigned int dasd_io_time3[32];	 /* hist. of time from irq to end */
540 	unsigned int dasd_io_nr_req[32]; /* hist. of # of requests in chanq */
541 
542 	/* new data */
543 	struct timespec64 starttod;	   /* time of start or last reset */
544 	unsigned int dasd_io_alias;	   /* requests using an alias */
545 	unsigned int dasd_io_tpm;	   /* requests using transport mode */
546 	unsigned int dasd_read_reqs;	   /* total number of read  requests */
547 	unsigned int dasd_read_sects;	   /* total number read sectors */
548 	unsigned int dasd_read_alias;	   /* read request using an alias */
549 	unsigned int dasd_read_tpm;	   /* read requests in transport mode */
550 	unsigned int dasd_read_secs[32];   /* histogram of request's sizes */
551 	unsigned int dasd_read_times[32];  /* histogram of requests's times */
552 	unsigned int dasd_read_time1[32];  /* hist. time from build to start */
553 	unsigned int dasd_read_time2[32];  /* hist. of time from start to irq */
554 	unsigned int dasd_read_time3[32];  /* hist. of time from irq to end */
555 	unsigned int dasd_read_nr_req[32]; /* hist. of # of requests in chanq */
556 	unsigned long dasd_sum_times;	   /* sum of request times */
557 	unsigned long dasd_sum_time_str;   /* sum of time from build to start */
558 	unsigned long dasd_sum_time_irq;   /* sum of time from start to irq */
559 	unsigned long dasd_sum_time_end;   /* sum of time from irq to end */
560 };
561 
562 struct dasd_profile {
563 	struct dentry *dentry;
564 	struct dasd_profile_info *data;
565 	spinlock_t lock;
566 };
567 
568 struct dasd_format_entry {
569 	struct list_head list;
570 	sector_t track;
571 };
572 
573 struct dasd_device {
574 	/* Block device stuff. */
575 	struct dasd_block *block;
576 
577         unsigned int devindex;
578 	unsigned long flags;	   /* per device flags */
579 	unsigned short features;   /* copy of devmap-features (read-only!) */
580 
581 	/* extended error reporting stuff (eer) */
582 	struct dasd_ccw_req *eer_cqr;
583 
584 	/* Device discipline stuff. */
585 	struct dasd_discipline *discipline;
586 	struct dasd_discipline *base_discipline;
587 	void *private;
588 	struct dasd_path path[8];
589 	__u8 opm;
590 
591 	/* Device state and target state. */
592 	int state, target;
593 	struct mutex state_mutex;
594 	int stopped;		/* device (ccw_device_start) was stopped */
595 
596 	/* reference count. */
597         atomic_t ref_count;
598 
599 	/* ccw queue and memory for static ccw/erp buffers. */
600 	struct list_head ccw_queue;
601 	spinlock_t mem_lock;
602 	void *ccw_mem;
603 	void *erp_mem;
604 	void *ese_mem;
605 	struct list_head ccw_chunks;
606 	struct list_head erp_chunks;
607 	struct list_head ese_chunks;
608 
609 	atomic_t tasklet_scheduled;
610         struct tasklet_struct tasklet;
611 	struct work_struct kick_work;
612 	struct work_struct reload_device;
613 	struct work_struct kick_validate;
614 	struct work_struct suc_work;
615 	struct work_struct requeue_requests;
616 	struct timer_list timer;
617 
618 	debug_info_t *debug_area;
619 
620 	struct ccw_device *cdev;
621 
622 	/* hook for alias management */
623 	struct list_head alias_list;
624 
625 	/* default expiration time in s */
626 	unsigned long default_expires;
627 	unsigned long default_retries;
628 
629 	unsigned long blk_timeout;
630 
631 	unsigned long path_thrhld;
632 	unsigned long path_interval;
633 
634 	struct dentry *debugfs_dentry;
635 	struct dentry *hosts_dentry;
636 	struct dasd_profile profile;
637 	struct dasd_format_entry format_entry;
638 	struct kset *paths_info;
639 	struct dasd_copy_relation *copy;
640 };
641 
642 struct dasd_block {
643 	/* Block device stuff. */
644 	struct gendisk *gdp;
645 	spinlock_t request_queue_lock;
646 	struct blk_mq_tag_set tag_set;
647 	struct block_device *bdev;
648 	atomic_t open_count;
649 
650 	unsigned long blocks;	   /* size of volume in blocks */
651 	unsigned int bp_block;	   /* bytes per block */
652 	unsigned int s2b_shift;	   /* log2 (bp_block/512) */
653 
654 	struct dasd_device *base;
655 	struct list_head ccw_queue;
656 	spinlock_t queue_lock;
657 
658 	atomic_t tasklet_scheduled;
659 	struct tasklet_struct tasklet;
660 	struct timer_list timer;
661 
662 	struct dentry *debugfs_dentry;
663 	struct dasd_profile profile;
664 
665 	struct list_head format_list;
666 	spinlock_t format_lock;
667 	atomic_t trkcount;
668 };
669 
670 struct dasd_attention_data {
671 	struct dasd_device *device;
672 	__u8 lpum;
673 };
674 
675 struct dasd_queue {
676 	spinlock_t lock;
677 };
678 
679 /* reasons why device (ccw_device_start) was stopped */
680 #define DASD_STOPPED_NOT_ACC 1         /* not accessible */
681 #define DASD_STOPPED_QUIESCE 2         /* Quiesced */
682 #define DASD_STOPPED_PENDING 4         /* long busy */
683 #define DASD_STOPPED_DC_WAIT 8         /* disconnected, wait */
684 #define DASD_STOPPED_SU      16        /* summary unit check handling */
685 #define DASD_STOPPED_PPRC    32        /* PPRC swap */
686 #define DASD_STOPPED_NOSPC   128       /* no space left */
687 
688 /* per device flags */
689 #define DASD_FLAG_OFFLINE	3	/* device is in offline processing */
690 #define DASD_FLAG_EER_SNSS	4	/* A SNSS is required */
691 #define DASD_FLAG_EER_IN_USE	5	/* A SNSS request is running */
692 #define DASD_FLAG_DEVICE_RO	6	/* The device itself is read-only. Don't
693 					 * confuse this with the user specified
694 					 * read-only feature.
695 					 */
696 #define DASD_FLAG_IS_RESERVED	7	/* The device is reserved */
697 #define DASD_FLAG_LOCK_STOLEN	8	/* The device lock was stolen */
698 #define DASD_FLAG_SUSPENDED	9	/* The device was suspended */
699 #define DASD_FLAG_SAFE_OFFLINE	10	/* safe offline processing requested*/
700 #define DASD_FLAG_SAFE_OFFLINE_RUNNING	11	/* safe offline running */
701 #define DASD_FLAG_ABORTALL	12	/* Abort all noretry requests */
702 #define DASD_FLAG_PATH_VERIFY	13	/* Path verification worker running */
703 #define DASD_FLAG_SUC		14	/* unhandled summary unit check */
704 
705 #define DASD_SLEEPON_START_TAG	((void *) 1)
706 #define DASD_SLEEPON_END_TAG	((void *) 2)
707 
708 void dasd_put_device_wake(struct dasd_device *);
709 
710 /*
711  * return values to be returned from the copy pair swap function
712  * 0x00: swap successful
713  * 0x01: swap data invalid
714  * 0x02: no active device found
715  * 0x03: wrong primary specified
716  * 0x04: secondary device not found
717  * 0x05: swap already running
718  */
719 #define DASD_COPYPAIRSWAP_SUCCESS	0
720 #define DASD_COPYPAIRSWAP_INVALID	1
721 #define DASD_COPYPAIRSWAP_NOACTIVE	2
722 #define DASD_COPYPAIRSWAP_PRIMARY	3
723 #define DASD_COPYPAIRSWAP_SECONDARY	4
724 #define DASD_COPYPAIRSWAP_MULTIPLE	5
725 
726 /*
727  * Reference count inliners
728  */
729 static inline void
730 dasd_get_device(struct dasd_device *device)
731 {
732 	atomic_inc(&device->ref_count);
733 }
734 
735 static inline void
736 dasd_put_device(struct dasd_device *device)
737 {
738 	if (atomic_dec_return(&device->ref_count) == 0)
739 		dasd_put_device_wake(device);
740 }
741 
742 /*
743  * The static memory in ccw_mem and erp_mem is managed by a sorted
744  * list of free memory chunks.
745  */
746 struct dasd_mchunk
747 {
748 	struct list_head list;
749 	unsigned long size;
750 } __attribute__ ((aligned(8)));
751 
752 static inline void
753 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
754 		    unsigned long size)
755 {
756 	struct dasd_mchunk *chunk;
757 
758 	INIT_LIST_HEAD(chunk_list);
759 	chunk = (struct dasd_mchunk *) mem;
760 	chunk->size = size - sizeof(struct dasd_mchunk);
761 	list_add(&chunk->list, chunk_list);
762 }
763 
764 static inline void *
765 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
766 {
767 	struct dasd_mchunk *chunk, *tmp;
768 
769 	size = (size + 7L) & -8L;
770 	list_for_each_entry(chunk, chunk_list, list) {
771 		if (chunk->size < size)
772 			continue;
773 		if (chunk->size > size + sizeof(struct dasd_mchunk)) {
774 			char *endaddr = (char *) (chunk + 1) + chunk->size;
775 			tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
776 			tmp->size = size;
777 			chunk->size -= size + sizeof(struct dasd_mchunk);
778 			chunk = tmp;
779 		} else
780 			list_del(&chunk->list);
781 		return (void *) (chunk + 1);
782 	}
783 	return NULL;
784 }
785 
786 static inline void
787 dasd_free_chunk(struct list_head *chunk_list, void *mem)
788 {
789 	struct dasd_mchunk *chunk, *tmp;
790 	struct list_head *p, *left;
791 
792 	chunk = (struct dasd_mchunk *)
793 		((char *) mem - sizeof(struct dasd_mchunk));
794 	/* Find out the left neighbour in chunk_list. */
795 	left = chunk_list;
796 	list_for_each(p, chunk_list) {
797 		if (list_entry(p, struct dasd_mchunk, list) > chunk)
798 			break;
799 		left = p;
800 	}
801 	/* Try to merge with right neighbour = next element from left. */
802 	if (left->next != chunk_list) {
803 		tmp = list_entry(left->next, struct dasd_mchunk, list);
804 		if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
805 			list_del(&tmp->list);
806 			chunk->size += tmp->size + sizeof(struct dasd_mchunk);
807 		}
808 	}
809 	/* Try to merge with left neighbour. */
810 	if (left != chunk_list) {
811 		tmp = list_entry(left, struct dasd_mchunk, list);
812 		if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
813 			tmp->size += chunk->size + sizeof(struct dasd_mchunk);
814 			return;
815 		}
816 	}
817 	__list_add(&chunk->list, left, left->next);
818 }
819 
820 /*
821  * Check if bsize is in { 512, 1024, 2048, 4096 }
822  */
823 static inline int
824 dasd_check_blocksize(int bsize)
825 {
826 	if (bsize < 512 || bsize > 4096 || !is_power_of_2(bsize))
827 		return -EMEDIUMTYPE;
828 	return 0;
829 }
830 
831 /*
832  * return the callback data of the original request in case there are
833  * ERP requests build on top of it
834  */
835 static inline void *dasd_get_callback_data(struct dasd_ccw_req *cqr)
836 {
837 	while (cqr->refers)
838 		cqr = cqr->refers;
839 
840 	return cqr->callback_data;
841 }
842 
843 /* externals in dasd.c */
844 #define DASD_PROFILE_OFF	 0
845 #define DASD_PROFILE_ON 	 1
846 #define DASD_PROFILE_GLOBAL_ONLY 2
847 
848 extern debug_info_t *dasd_debug_area;
849 extern struct dasd_profile dasd_global_profile;
850 extern unsigned int dasd_global_profile_level;
851 extern const struct block_device_operations dasd_device_operations;
852 extern struct blk_mq_ops dasd_mq_ops;
853 
854 extern struct kmem_cache *dasd_page_cache;
855 
856 struct dasd_ccw_req *
857 dasd_smalloc_request(int, int, int, struct dasd_device *, struct dasd_ccw_req *);
858 struct dasd_ccw_req *dasd_fmalloc_request(int, int, int, struct dasd_device *);
859 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
860 void dasd_ffree_request(struct dasd_ccw_req *, struct dasd_device *);
861 void dasd_wakeup_cb(struct dasd_ccw_req *, void *);
862 
863 struct dasd_device *dasd_alloc_device(void);
864 void dasd_free_device(struct dasd_device *);
865 
866 struct dasd_block *dasd_alloc_block(void);
867 void dasd_free_block(struct dasd_block *);
868 
869 enum blk_eh_timer_return dasd_times_out(struct request *req);
870 
871 void dasd_enable_device(struct dasd_device *);
872 void dasd_set_target_state(struct dasd_device *, int);
873 void dasd_kick_device(struct dasd_device *);
874 void dasd_reload_device(struct dasd_device *);
875 void dasd_schedule_requeue(struct dasd_device *);
876 
877 void dasd_add_request_head(struct dasd_ccw_req *);
878 void dasd_add_request_tail(struct dasd_ccw_req *);
879 int  dasd_start_IO(struct dasd_ccw_req *);
880 int  dasd_term_IO(struct dasd_ccw_req *);
881 void dasd_schedule_device_bh(struct dasd_device *);
882 void dasd_schedule_block_bh(struct dasd_block *);
883 int  dasd_sleep_on(struct dasd_ccw_req *);
884 int  dasd_sleep_on_queue(struct list_head *);
885 int  dasd_sleep_on_immediatly(struct dasd_ccw_req *);
886 int  dasd_sleep_on_queue_interruptible(struct list_head *);
887 int  dasd_sleep_on_interruptible(struct dasd_ccw_req *);
888 void dasd_device_set_timer(struct dasd_device *, int);
889 void dasd_device_clear_timer(struct dasd_device *);
890 void dasd_block_set_timer(struct dasd_block *, int);
891 void dasd_block_clear_timer(struct dasd_block *);
892 int  dasd_cancel_req(struct dasd_ccw_req *);
893 int dasd_flush_device_queue(struct dasd_device *);
894 int dasd_generic_probe(struct ccw_device *);
895 void dasd_generic_free_discipline(struct dasd_device *);
896 void dasd_generic_remove (struct ccw_device *cdev);
897 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
898 int dasd_generic_set_offline (struct ccw_device *cdev);
899 int dasd_generic_notify(struct ccw_device *, int);
900 int dasd_generic_last_path_gone(struct dasd_device *);
901 int dasd_generic_path_operational(struct dasd_device *);
902 void dasd_generic_shutdown(struct ccw_device *);
903 
904 void dasd_generic_handle_state_change(struct dasd_device *);
905 enum uc_todo dasd_generic_uc_handler(struct ccw_device *, struct irb *);
906 void dasd_generic_path_event(struct ccw_device *, int *);
907 int dasd_generic_verify_path(struct dasd_device *, __u8);
908 void dasd_generic_space_exhaust(struct dasd_device *, struct dasd_ccw_req *);
909 void dasd_generic_space_avail(struct dasd_device *);
910 
911 int dasd_generic_requeue_all_requests(struct dasd_device *);
912 
913 int dasd_generic_read_dev_chars(struct dasd_device *, int, void *, int);
914 char *dasd_get_sense(struct irb *);
915 
916 void dasd_device_set_stop_bits(struct dasd_device *, int);
917 void dasd_device_remove_stop_bits(struct dasd_device *, int);
918 
919 int dasd_device_is_ro(struct dasd_device *);
920 
921 void dasd_profile_reset(struct dasd_profile *);
922 int dasd_profile_on(struct dasd_profile *);
923 void dasd_profile_off(struct dasd_profile *);
924 char *dasd_get_user_string(const char __user *, size_t);
925 
926 /* externals in dasd_devmap.c */
927 extern int dasd_max_devindex;
928 extern int dasd_probeonly;
929 extern int dasd_autodetect;
930 extern int dasd_nopav;
931 extern int dasd_nofcx;
932 
933 int dasd_devmap_init(void);
934 void dasd_devmap_exit(void);
935 
936 struct dasd_device *dasd_create_device(struct ccw_device *);
937 void dasd_delete_device(struct dasd_device *);
938 
939 int dasd_get_feature(struct ccw_device *, int);
940 int dasd_set_feature(struct ccw_device *, int, int);
941 
942 extern const struct attribute_group *dasd_dev_groups[];
943 void dasd_path_create_kobj(struct dasd_device *, int);
944 void dasd_path_create_kobjects(struct dasd_device *);
945 void dasd_path_remove_kobjects(struct dasd_device *);
946 
947 struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
948 struct dasd_device *dasd_device_from_cdev_locked(struct ccw_device *);
949 struct dasd_device *dasd_device_from_devindex(int);
950 
951 void dasd_add_link_to_gendisk(struct gendisk *, struct dasd_device *);
952 struct dasd_device *dasd_device_from_gendisk(struct gendisk *);
953 
954 int dasd_parse(void) __init;
955 int dasd_busid_known(const char *);
956 
957 /* externals in dasd_gendisk.c */
958 int  dasd_gendisk_init(void);
959 void dasd_gendisk_exit(void);
960 int dasd_gendisk_alloc(struct dasd_block *);
961 void dasd_gendisk_free(struct dasd_block *);
962 int dasd_scan_partitions(struct dasd_block *);
963 void dasd_destroy_partitions(struct dasd_block *);
964 
965 /* externals in dasd_ioctl.c */
966 int dasd_ioctl(struct block_device *, fmode_t, unsigned int, unsigned long);
967 int dasd_set_read_only(struct block_device *bdev, bool ro);
968 
969 /* externals in dasd_proc.c */
970 int dasd_proc_init(void);
971 void dasd_proc_exit(void);
972 
973 /* externals in dasd_erp.c */
974 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
975 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
976 struct dasd_ccw_req *dasd_alloc_erp_request(unsigned int, int, int,
977 					    struct dasd_device *);
978 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
979 void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
980 void dasd_log_sense_dbf(struct dasd_ccw_req *cqr, struct irb *irb);
981 
982 /* externals in dasd_3990_erp.c */
983 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
984 void dasd_3990_erp_handle_sim(struct dasd_device *, char *);
985 
986 /* externals in dasd_eer.c */
987 #ifdef CONFIG_DASD_EER
988 int dasd_eer_init(void);
989 void dasd_eer_exit(void);
990 int dasd_eer_enable(struct dasd_device *);
991 void dasd_eer_disable(struct dasd_device *);
992 void dasd_eer_write(struct dasd_device *, struct dasd_ccw_req *cqr,
993 		    unsigned int id);
994 void dasd_eer_snss(struct dasd_device *);
995 
996 static inline int dasd_eer_enabled(struct dasd_device *device)
997 {
998 	return device->eer_cqr != NULL;
999 }
1000 #else
1001 #define dasd_eer_init()		(0)
1002 #define dasd_eer_exit()		do { } while (0)
1003 #define dasd_eer_enable(d)	(0)
1004 #define dasd_eer_disable(d)	do { } while (0)
1005 #define dasd_eer_write(d,c,i)	do { } while (0)
1006 #define dasd_eer_snss(d)	do { } while (0)
1007 #define dasd_eer_enabled(d)	(0)
1008 #endif	/* CONFIG_DASD_ERR */
1009 
1010 
1011 /* DASD path handling functions */
1012 
1013 /*
1014  * helper functions to modify bit masks for a given channel path for a device
1015  */
1016 static inline int dasd_path_is_operational(struct dasd_device *device, int chp)
1017 {
1018 	return test_bit(DASD_PATH_OPERATIONAL, &device->path[chp].flags);
1019 }
1020 
1021 static inline int dasd_path_need_verify(struct dasd_device *device, int chp)
1022 {
1023 	return test_bit(DASD_PATH_TBV, &device->path[chp].flags);
1024 }
1025 
1026 static inline void dasd_path_verify(struct dasd_device *device, int chp)
1027 {
1028 	__set_bit(DASD_PATH_TBV, &device->path[chp].flags);
1029 }
1030 
1031 static inline void dasd_path_clear_verify(struct dasd_device *device, int chp)
1032 {
1033 	__clear_bit(DASD_PATH_TBV, &device->path[chp].flags);
1034 }
1035 
1036 static inline void dasd_path_clear_all_verify(struct dasd_device *device)
1037 {
1038 	int chp;
1039 
1040 	for (chp = 0; chp < 8; chp++)
1041 		dasd_path_clear_verify(device, chp);
1042 }
1043 
1044 static inline void dasd_path_fcsec(struct dasd_device *device, int chp)
1045 {
1046 	__set_bit(DASD_PATH_FCSEC, &device->path[chp].flags);
1047 }
1048 
1049 static inline void dasd_path_clear_fcsec(struct dasd_device *device, int chp)
1050 {
1051 	__clear_bit(DASD_PATH_FCSEC, &device->path[chp].flags);
1052 }
1053 
1054 static inline int dasd_path_need_fcsec(struct dasd_device *device, int chp)
1055 {
1056 	return test_bit(DASD_PATH_FCSEC, &device->path[chp].flags);
1057 }
1058 
1059 static inline void dasd_path_clear_all_fcsec(struct dasd_device *device)
1060 {
1061 	int chp;
1062 
1063 	for (chp = 0; chp < 8; chp++)
1064 		dasd_path_clear_fcsec(device, chp);
1065 }
1066 
1067 static inline void dasd_path_operational(struct dasd_device *device, int chp)
1068 {
1069 	__set_bit(DASD_PATH_OPERATIONAL, &device->path[chp].flags);
1070 	device->opm |= (0x80 >> chp);
1071 }
1072 
1073 static inline void dasd_path_nonpreferred(struct dasd_device *device, int chp)
1074 {
1075 	__set_bit(DASD_PATH_NPP, &device->path[chp].flags);
1076 }
1077 
1078 static inline int dasd_path_is_nonpreferred(struct dasd_device *device, int chp)
1079 {
1080 	return test_bit(DASD_PATH_NPP, &device->path[chp].flags);
1081 }
1082 
1083 static inline void dasd_path_clear_nonpreferred(struct dasd_device *device,
1084 						int chp)
1085 {
1086 	__clear_bit(DASD_PATH_NPP, &device->path[chp].flags);
1087 }
1088 
1089 static inline void dasd_path_preferred(struct dasd_device *device, int chp)
1090 {
1091 	__set_bit(DASD_PATH_PP, &device->path[chp].flags);
1092 }
1093 
1094 static inline int dasd_path_is_preferred(struct dasd_device *device, int chp)
1095 {
1096 	return test_bit(DASD_PATH_PP, &device->path[chp].flags);
1097 }
1098 
1099 static inline void dasd_path_clear_preferred(struct dasd_device *device,
1100 					     int chp)
1101 {
1102 	__clear_bit(DASD_PATH_PP, &device->path[chp].flags);
1103 }
1104 
1105 static inline void dasd_path_clear_oper(struct dasd_device *device, int chp)
1106 {
1107 	__clear_bit(DASD_PATH_OPERATIONAL, &device->path[chp].flags);
1108 	device->opm &= ~(0x80 >> chp);
1109 }
1110 
1111 static inline void dasd_path_clear_cable(struct dasd_device *device, int chp)
1112 {
1113 	__clear_bit(DASD_PATH_MISCABLED, &device->path[chp].flags);
1114 }
1115 
1116 static inline void dasd_path_cuir(struct dasd_device *device, int chp)
1117 {
1118 	__set_bit(DASD_PATH_CUIR, &device->path[chp].flags);
1119 }
1120 
1121 static inline int dasd_path_is_cuir(struct dasd_device *device, int chp)
1122 {
1123 	return test_bit(DASD_PATH_CUIR, &device->path[chp].flags);
1124 }
1125 
1126 static inline void dasd_path_clear_cuir(struct dasd_device *device, int chp)
1127 {
1128 	__clear_bit(DASD_PATH_CUIR, &device->path[chp].flags);
1129 }
1130 
1131 static inline void dasd_path_ifcc(struct dasd_device *device, int chp)
1132 {
1133 	set_bit(DASD_PATH_IFCC, &device->path[chp].flags);
1134 }
1135 
1136 static inline int dasd_path_is_ifcc(struct dasd_device *device, int chp)
1137 {
1138 	return test_bit(DASD_PATH_IFCC, &device->path[chp].flags);
1139 }
1140 
1141 static inline void dasd_path_clear_ifcc(struct dasd_device *device, int chp)
1142 {
1143 	clear_bit(DASD_PATH_IFCC, &device->path[chp].flags);
1144 }
1145 
1146 static inline void dasd_path_clear_nohpf(struct dasd_device *device, int chp)
1147 {
1148 	__clear_bit(DASD_PATH_NOHPF, &device->path[chp].flags);
1149 }
1150 
1151 static inline void dasd_path_miscabled(struct dasd_device *device, int chp)
1152 {
1153 	__set_bit(DASD_PATH_MISCABLED, &device->path[chp].flags);
1154 }
1155 
1156 static inline int dasd_path_is_miscabled(struct dasd_device *device, int chp)
1157 {
1158 	return test_bit(DASD_PATH_MISCABLED, &device->path[chp].flags);
1159 }
1160 
1161 static inline void dasd_path_nohpf(struct dasd_device *device, int chp)
1162 {
1163 	__set_bit(DASD_PATH_NOHPF, &device->path[chp].flags);
1164 }
1165 
1166 static inline int dasd_path_is_nohpf(struct dasd_device *device, int chp)
1167 {
1168 	return test_bit(DASD_PATH_NOHPF, &device->path[chp].flags);
1169 }
1170 
1171 /*
1172  * get functions for path masks
1173  * will return a path masks for the given device
1174  */
1175 
1176 static inline __u8 dasd_path_get_opm(struct dasd_device *device)
1177 {
1178 	return device->opm;
1179 }
1180 
1181 static inline __u8 dasd_path_get_tbvpm(struct dasd_device *device)
1182 {
1183 	int chp;
1184 	__u8 tbvpm = 0x00;
1185 
1186 	for (chp = 0; chp < 8; chp++)
1187 		if (dasd_path_need_verify(device, chp))
1188 			tbvpm |= 0x80 >> chp;
1189 	return tbvpm;
1190 }
1191 
1192 static inline int dasd_path_get_fcsecpm(struct dasd_device *device)
1193 {
1194 	int chp;
1195 
1196 	for (chp = 0; chp < 8; chp++)
1197 		if (dasd_path_need_fcsec(device, chp))
1198 			return 1;
1199 
1200 	return 0;
1201 }
1202 
1203 static inline __u8 dasd_path_get_nppm(struct dasd_device *device)
1204 {
1205 	int chp;
1206 	__u8 npm = 0x00;
1207 
1208 	for (chp = 0; chp < 8; chp++) {
1209 		if (dasd_path_is_nonpreferred(device, chp))
1210 			npm |= 0x80 >> chp;
1211 	}
1212 	return npm;
1213 }
1214 
1215 static inline __u8 dasd_path_get_ppm(struct dasd_device *device)
1216 {
1217 	int chp;
1218 	__u8 ppm = 0x00;
1219 
1220 	for (chp = 0; chp < 8; chp++)
1221 		if (dasd_path_is_preferred(device, chp))
1222 			ppm |= 0x80 >> chp;
1223 	return ppm;
1224 }
1225 
1226 static inline __u8 dasd_path_get_cablepm(struct dasd_device *device)
1227 {
1228 	int chp;
1229 	__u8 cablepm = 0x00;
1230 
1231 	for (chp = 0; chp < 8; chp++)
1232 		if (dasd_path_is_miscabled(device, chp))
1233 			cablepm |= 0x80 >> chp;
1234 	return cablepm;
1235 }
1236 
1237 static inline __u8 dasd_path_get_cuirpm(struct dasd_device *device)
1238 {
1239 	int chp;
1240 	__u8 cuirpm = 0x00;
1241 
1242 	for (chp = 0; chp < 8; chp++)
1243 		if (dasd_path_is_cuir(device, chp))
1244 			cuirpm |= 0x80 >> chp;
1245 	return cuirpm;
1246 }
1247 
1248 static inline __u8 dasd_path_get_ifccpm(struct dasd_device *device)
1249 {
1250 	int chp;
1251 	__u8 ifccpm = 0x00;
1252 
1253 	for (chp = 0; chp < 8; chp++)
1254 		if (dasd_path_is_ifcc(device, chp))
1255 			ifccpm |= 0x80 >> chp;
1256 	return ifccpm;
1257 }
1258 
1259 static inline __u8 dasd_path_get_hpfpm(struct dasd_device *device)
1260 {
1261 	int chp;
1262 	__u8 hpfpm = 0x00;
1263 
1264 	for (chp = 0; chp < 8; chp++)
1265 		if (dasd_path_is_nohpf(device, chp))
1266 			hpfpm |= 0x80 >> chp;
1267 	return hpfpm;
1268 }
1269 
1270 static inline u8 dasd_path_get_fcs_path(struct dasd_device *device, int chp)
1271 {
1272 	return device->path[chp].fc_security;
1273 }
1274 
1275 static inline int dasd_path_get_fcs_device(struct dasd_device *device)
1276 {
1277 	u8 fc_sec = 0;
1278 	int chp;
1279 
1280 	for (chp = 0; chp < 8; chp++) {
1281 		if (device->opm & (0x80 >> chp)) {
1282 			fc_sec = device->path[chp].fc_security;
1283 			break;
1284 		}
1285 	}
1286 	for (; chp < 8; chp++) {
1287 		if (device->opm & (0x80 >> chp))
1288 			if (device->path[chp].fc_security != fc_sec)
1289 				return -EINVAL;
1290 	}
1291 
1292 	return fc_sec;
1293 }
1294 
1295 /*
1296  * add functions for path masks
1297  * the existing path mask will be extended by the given path mask
1298  */
1299 static inline void dasd_path_add_tbvpm(struct dasd_device *device, __u8 pm)
1300 {
1301 	int chp;
1302 
1303 	for (chp = 0; chp < 8; chp++)
1304 		if (pm & (0x80 >> chp))
1305 			dasd_path_verify(device, chp);
1306 }
1307 
1308 static inline __u8 dasd_path_get_notoperpm(struct dasd_device *device)
1309 {
1310 	int chp;
1311 	__u8 nopm = 0x00;
1312 
1313 	for (chp = 0; chp < 8; chp++)
1314 		if (dasd_path_is_nohpf(device, chp) ||
1315 		    dasd_path_is_ifcc(device, chp) ||
1316 		    dasd_path_is_cuir(device, chp) ||
1317 		    dasd_path_is_miscabled(device, chp))
1318 			nopm |= 0x80 >> chp;
1319 	return nopm;
1320 }
1321 
1322 static inline void dasd_path_add_opm(struct dasd_device *device, __u8 pm)
1323 {
1324 	int chp;
1325 
1326 	for (chp = 0; chp < 8; chp++)
1327 		if (pm & (0x80 >> chp)) {
1328 			dasd_path_operational(device, chp);
1329 			/*
1330 			 * if the path is used
1331 			 * it should not be in one of the negative lists
1332 			 */
1333 			dasd_path_clear_nohpf(device, chp);
1334 			dasd_path_clear_cuir(device, chp);
1335 			dasd_path_clear_cable(device, chp);
1336 			dasd_path_clear_ifcc(device, chp);
1337 		}
1338 }
1339 
1340 static inline void dasd_path_add_cablepm(struct dasd_device *device, __u8 pm)
1341 {
1342 	int chp;
1343 
1344 	for (chp = 0; chp < 8; chp++)
1345 		if (pm & (0x80 >> chp))
1346 			dasd_path_miscabled(device, chp);
1347 }
1348 
1349 static inline void dasd_path_add_cuirpm(struct dasd_device *device, __u8 pm)
1350 {
1351 	int chp;
1352 
1353 	for (chp = 0; chp < 8; chp++)
1354 		if (pm & (0x80 >> chp))
1355 			dasd_path_cuir(device, chp);
1356 }
1357 
1358 static inline void dasd_path_add_ifccpm(struct dasd_device *device, __u8 pm)
1359 {
1360 	int chp;
1361 
1362 	for (chp = 0; chp < 8; chp++)
1363 		if (pm & (0x80 >> chp))
1364 			dasd_path_ifcc(device, chp);
1365 }
1366 
1367 static inline void dasd_path_add_nppm(struct dasd_device *device, __u8 pm)
1368 {
1369 	int chp;
1370 
1371 	for (chp = 0; chp < 8; chp++)
1372 		if (pm & (0x80 >> chp))
1373 			dasd_path_nonpreferred(device, chp);
1374 }
1375 
1376 static inline void dasd_path_add_nohpfpm(struct dasd_device *device, __u8 pm)
1377 {
1378 	int chp;
1379 
1380 	for (chp = 0; chp < 8; chp++)
1381 		if (pm & (0x80 >> chp))
1382 			dasd_path_nohpf(device, chp);
1383 }
1384 
1385 static inline void dasd_path_add_ppm(struct dasd_device *device, __u8 pm)
1386 {
1387 	int chp;
1388 
1389 	for (chp = 0; chp < 8; chp++)
1390 		if (pm & (0x80 >> chp))
1391 			dasd_path_preferred(device, chp);
1392 }
1393 
1394 static inline void dasd_path_add_fcsecpm(struct dasd_device *device, __u8 pm)
1395 {
1396 	int chp;
1397 
1398 	for (chp = 0; chp < 8; chp++)
1399 		if (pm & (0x80 >> chp))
1400 			dasd_path_fcsec(device, chp);
1401 }
1402 
1403 /*
1404  * set functions for path masks
1405  * the existing path mask will be replaced by the given path mask
1406  */
1407 static inline void dasd_path_set_tbvpm(struct dasd_device *device, __u8 pm)
1408 {
1409 	int chp;
1410 
1411 	for (chp = 0; chp < 8; chp++)
1412 		if (pm & (0x80 >> chp))
1413 			dasd_path_verify(device, chp);
1414 		else
1415 			dasd_path_clear_verify(device, chp);
1416 }
1417 
1418 static inline void dasd_path_set_opm(struct dasd_device *device, __u8 pm)
1419 {
1420 	int chp;
1421 
1422 	for (chp = 0; chp < 8; chp++) {
1423 		dasd_path_clear_oper(device, chp);
1424 		if (pm & (0x80 >> chp)) {
1425 			dasd_path_operational(device, chp);
1426 			/*
1427 			 * if the path is used
1428 			 * it should not be in one of the negative lists
1429 			 */
1430 			dasd_path_clear_nohpf(device, chp);
1431 			dasd_path_clear_cuir(device, chp);
1432 			dasd_path_clear_cable(device, chp);
1433 			dasd_path_clear_ifcc(device, chp);
1434 		}
1435 	}
1436 }
1437 
1438 /*
1439  * remove functions for path masks
1440  * the existing path mask will be cleared with the given path mask
1441  */
1442 static inline void dasd_path_remove_opm(struct dasd_device *device, __u8 pm)
1443 {
1444 	int chp;
1445 
1446 	for (chp = 0; chp < 8; chp++) {
1447 		if (pm & (0x80 >> chp))
1448 			dasd_path_clear_oper(device, chp);
1449 	}
1450 }
1451 
1452 /*
1453  * add the newly available path to the to be verified pm and remove it from
1454  * normal operation until it is verified
1455  */
1456 static inline void dasd_path_available(struct dasd_device *device, int chp)
1457 {
1458 	dasd_path_clear_oper(device, chp);
1459 	dasd_path_verify(device, chp);
1460 }
1461 
1462 static inline void dasd_path_notoper(struct dasd_device *device, int chp)
1463 {
1464 	dasd_path_clear_oper(device, chp);
1465 	dasd_path_clear_preferred(device, chp);
1466 	dasd_path_clear_nonpreferred(device, chp);
1467 }
1468 
1469 static inline void dasd_path_fcsec_update(struct dasd_device *device, int chp)
1470 {
1471 	dasd_path_fcsec(device, chp);
1472 }
1473 
1474 /*
1475  * remove all paths from normal operation
1476  */
1477 static inline void dasd_path_no_path(struct dasd_device *device)
1478 {
1479 	int chp;
1480 
1481 	for (chp = 0; chp < 8; chp++)
1482 		dasd_path_notoper(device, chp);
1483 
1484 	dasd_path_clear_all_verify(device);
1485 }
1486 
1487 /* end - path handling */
1488 
1489 #endif				/* DASD_H */
1490