2 * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
3 * Bugreports.to..: <Linux390@de.ibm.com>
4 * Copyright IBM Corp. 1999, 2000
5 * EMC Symmetrix ioctl Copyright EMC Corporation, 2008
6 * Author.........: Nigel Hislop <hislop_nigel@emc.com>
8 * This file is the interface of the DASD device driver, which is exported to user space
9 * any future changes wrt the API will result in a change of the APIVERSION reported
10 * to userspace by the DASDAPIVER-ioctl
16 #include <linux/types.h>
17 #include <linux/ioctl.h>
19 #define DASD_IOCTL_LETTER 'D'
21 #define DASD_API_VERSION 6
24 * struct dasd_information2_t
25 * represents any data about the device, which is visible to userspace.
26 * including foramt and featueres.
28 typedef struct dasd_information2_t {
29 unsigned int devno; /* S/390 devno */
30 unsigned int real_devno; /* for aliases */
31 unsigned int schid; /* S/390 subchannel identifier */
32 unsigned int cu_type : 16; /* from SenseID */
33 unsigned int cu_model : 8; /* from SenseID */
34 unsigned int dev_type : 16; /* from SenseID */
35 unsigned int dev_model : 8; /* from SenseID */
36 unsigned int open_count;
37 unsigned int req_queue_len;
38 unsigned int chanq_len; /* length of chanq */
39 char type[4]; /* from discipline.name, 'none' for unknown */
40 unsigned int status; /* current device level */
41 unsigned int label_block; /* where to find the VOLSER */
42 unsigned int FBA_layout; /* fixed block size (like AIXVOL) */
43 unsigned int characteristics_size;
44 unsigned int confdata_size;
45 char characteristics[64]; /* from read_device_characteristics */
46 char configuration_data[256]; /* from read_configuration_data */
47 unsigned int format; /* format info like formatted/cdl/ldl/... */
48 unsigned int features; /* dasd features like 'ro',... */
49 unsigned int reserved0; /* reserved for further use ,... */
50 unsigned int reserved1; /* reserved for further use ,... */
51 unsigned int reserved2; /* reserved for further use ,... */
52 unsigned int reserved3; /* reserved for further use ,... */
53 unsigned int reserved4; /* reserved for further use ,... */
54 unsigned int reserved5; /* reserved for further use ,... */
55 unsigned int reserved6; /* reserved for further use ,... */
56 unsigned int reserved7; /* reserved for further use ,... */
57 } dasd_information2_t;
60 * values to be used for dasd_information_t.format
62 * 0x01: Linux disc layout
63 * 0x02: Common disc layout
65 #define DASD_FORMAT_NONE 0
66 #define DASD_FORMAT_LDL 1
67 #define DASD_FORMAT_CDL 2
69 * values to be used for dasd_information_t.features
70 * 0x00: default features
72 * 0x02: use diag discipline (diag)
73 * 0x04: set the device initially online (internal use only)
74 * 0x08: enable ERP related logging
75 * 0x20: give access to raw eckd data
77 #define DASD_FEATURE_DEFAULT 0x00
78 #define DASD_FEATURE_READONLY 0x01
79 #define DASD_FEATURE_USEDIAG 0x02
80 #define DASD_FEATURE_INITIAL_ONLINE 0x04
81 #define DASD_FEATURE_ERPLOG 0x08
82 #define DASD_FEATURE_FAILFAST 0x10
83 #define DASD_FEATURE_FAILONSLCK 0x20
84 #define DASD_FEATURE_USERAW 0x40
86 #define DASD_PARTN_BITS 2
89 * struct dasd_information_t
90 * represents any data about the data, which is visible to userspace
92 typedef struct dasd_information_t {
93 unsigned int devno; /* S/390 devno */
94 unsigned int real_devno; /* for aliases */
95 unsigned int schid; /* S/390 subchannel identifier */
96 unsigned int cu_type : 16; /* from SenseID */
97 unsigned int cu_model : 8; /* from SenseID */
98 unsigned int dev_type : 16; /* from SenseID */
99 unsigned int dev_model : 8; /* from SenseID */
100 unsigned int open_count;
101 unsigned int req_queue_len;
102 unsigned int chanq_len; /* length of chanq */
103 char type[4]; /* from discipline.name, 'none' for unknown */
104 unsigned int status; /* current device level */
105 unsigned int label_block; /* where to find the VOLSER */
106 unsigned int FBA_layout; /* fixed block size (like AIXVOL) */
107 unsigned int characteristics_size;
108 unsigned int confdata_size;
109 char characteristics[64]; /* from read_device_characteristics */
110 char configuration_data[256]; /* from read_configuration_data */
111 } dasd_information_t;
114 * Read Subsystem Data - Performance Statistics
116 typedef struct dasd_rssd_perf_stats_t {
117 unsigned char invalid:1;
118 unsigned char format:3;
119 unsigned char data_format:4;
120 unsigned char unit_address;
121 unsigned short device_status;
122 unsigned int nr_read_normal;
123 unsigned int nr_read_normal_hits;
124 unsigned int nr_write_normal;
125 unsigned int nr_write_fast_normal_hits;
126 unsigned int nr_read_seq;
127 unsigned int nr_read_seq_hits;
128 unsigned int nr_write_seq;
129 unsigned int nr_write_fast_seq_hits;
130 unsigned int nr_read_cache;
131 unsigned int nr_read_cache_hits;
132 unsigned int nr_write_cache;
133 unsigned int nr_write_fast_cache_hits;
134 unsigned int nr_inhibit_cache;
135 unsigned int nr_bybass_cache;
136 unsigned int nr_seq_dasd_to_cache;
137 unsigned int nr_dasd_to_cache;
138 unsigned int nr_cache_to_dasd;
139 unsigned int nr_delayed_fast_write;
140 unsigned int nr_normal_fast_write;
141 unsigned int nr_seq_fast_write;
142 unsigned int nr_cache_miss;
143 unsigned char status2;
144 unsigned int nr_quick_write_promotes;
145 unsigned char reserved;
147 unsigned char reseved2[96];
148 } __attribute__((packed)) dasd_rssd_perf_stats_t;
151 * struct profile_info_t
152 * holds the profinling information
154 typedef struct dasd_profile_info_t {
155 unsigned int dasd_io_reqs; /* number of requests processed at all */
156 unsigned int dasd_io_sects; /* number of sectors processed at all */
157 unsigned int dasd_io_secs[32]; /* histogram of request's sizes */
158 unsigned int dasd_io_times[32]; /* histogram of requests's times */
159 unsigned int dasd_io_timps[32]; /* histogram of requests's times per sector */
160 unsigned int dasd_io_time1[32]; /* histogram of time from build to start */
161 unsigned int dasd_io_time2[32]; /* histogram of time from start to irq */
162 unsigned int dasd_io_time2ps[32]; /* histogram of time from start to irq */
163 unsigned int dasd_io_time3[32]; /* histogram of time from irq to end */
164 unsigned int dasd_io_nr_req[32]; /* histogram of # of requests in chanq */
165 } dasd_profile_info_t;
168 * struct format_data_t
169 * represents all data necessary to format a dasd
171 typedef struct format_data_t {
172 unsigned int start_unit; /* from track */
173 unsigned int stop_unit; /* to track */
174 unsigned int blksize; /* sectorsize */
175 unsigned int intensity;
179 * values to be used for format_data_t.intensity
181 * 1/9: also write record zero
182 * 3/11: also write home address
183 * 4/12: invalidate track
185 #define DASD_FMT_INT_FMT_R0 1 /* write record zero */
186 #define DASD_FMT_INT_FMT_HA 2 /* write home address, also set FMT_R0 ! */
187 #define DASD_FMT_INT_INVAL 4 /* invalidate tracks */
188 #define DASD_FMT_INT_COMPAT 8 /* use OS/390 compatible disk layout */
191 * struct format_check_t
192 * represents all data necessary to evaluate the format of
193 * different tracks of a dasd
195 typedef struct format_check_t {
197 struct format_data_t expect;
200 unsigned int result; /* Error indication (DASD_FMT_ERR_*) */
201 unsigned int unit; /* Track that is in error */
202 unsigned int rec; /* Record that is in error */
203 unsigned int num_records; /* Records in the track in error */
204 unsigned int blksize; /* Blocksize of first record in error */
205 unsigned int key_length; /* Key length of first record in error */
208 /* Values returned in format_check_t when a format error is detected: */
209 /* Too few records were found on a single track */
210 #define DASD_FMT_ERR_TOO_FEW_RECORDS 1
211 /* Too many records were found on a single track */
212 #define DASD_FMT_ERR_TOO_MANY_RECORDS 2
213 /* Blocksize/data-length of a record was wrong */
214 #define DASD_FMT_ERR_BLKSIZE 3
215 /* A record ID is defined by cylinder, head, and record number (CHR). */
216 /* On mismatch, this error is set */
217 #define DASD_FMT_ERR_RECORD_ID 4
218 /* If key-length was != 0 */
219 #define DASD_FMT_ERR_KEY_LENGTH 5
222 * struct attrib_data_t
223 * represents the operation (cache) bits for the device.
224 * Used in DE to influence caching of the DASD.
226 typedef struct attrib_data_t {
227 unsigned char operation:3; /* cache operation mode */
228 unsigned char reserved:5; /* cache operation mode */
229 __u16 nr_cyl; /* no of cyliners for read ahaed */
230 __u8 reserved2[29]; /* for future use */
231 } __attribute__ ((packed)) attrib_data_t;
233 /* definition of operation (cache) bits within attributes of DE */
234 #define DASD_NORMAL_CACHE 0x0
235 #define DASD_BYPASS_CACHE 0x1
236 #define DASD_INHIBIT_LOAD 0x2
237 #define DASD_SEQ_ACCESS 0x3
238 #define DASD_SEQ_PRESTAGE 0x4
239 #define DASD_REC_ACCESS 0x5
242 * Perform EMC Symmetrix I/O
244 typedef struct dasd_symmio_parms {
245 unsigned char reserved[8]; /* compat with older releases */
246 unsigned long long psf_data; /* char * cast to u64 */
247 unsigned long long rssd_result; /* char * cast to u64 */
250 } __attribute__ ((packed)) dasd_symmio_parms_t;
253 * Data returned by Sense Path Group ID (SNID)
255 struct dasd_snid_data {
261 } __attribute__ ((packed)) path_state;
263 } __attribute__ ((packed));
265 struct dasd_snid_ioctl_data {
266 struct dasd_snid_data data;
268 } __attribute__ ((packed));
271 /********************************************************************************
272 * SECTION: Definition of IOCTLs
274 * Here ist how the ioctl-nr should be used:
275 * 0 - 31 DASD driver itself
276 * 32 - 239 still open
277 * 240 - 255 reserved for EMC
278 *******************************************************************************/
280 /* Disable the volume (for Linux) */
281 #define BIODASDDISABLE _IO(DASD_IOCTL_LETTER,0)
282 /* Enable the volume (for Linux) */
283 #define BIODASDENABLE _IO(DASD_IOCTL_LETTER,1)
284 /* Issue a reserve/release command, rsp. */
285 #define BIODASDRSRV _IO(DASD_IOCTL_LETTER,2) /* reserve */
286 #define BIODASDRLSE _IO(DASD_IOCTL_LETTER,3) /* release */
287 #define BIODASDSLCK _IO(DASD_IOCTL_LETTER,4) /* steal lock */
288 /* reset profiling information of a device */
289 #define BIODASDPRRST _IO(DASD_IOCTL_LETTER,5)
290 /* Quiesce IO on device */
291 #define BIODASDQUIESCE _IO(DASD_IOCTL_LETTER,6)
292 /* Resume IO on device */
293 #define BIODASDRESUME _IO(DASD_IOCTL_LETTER,7)
294 /* Abort all I/O on a device */
295 #define BIODASDABORTIO _IO(DASD_IOCTL_LETTER, 240)
296 /* Allow I/O on a device */
297 #define BIODASDALLOWIO _IO(DASD_IOCTL_LETTER, 241)
300 /* retrieve API version number */
301 #define DASDAPIVER _IOR(DASD_IOCTL_LETTER,0,int)
302 /* Get information on a dasd device */
303 #define BIODASDINFO _IOR(DASD_IOCTL_LETTER,1,dasd_information_t)
304 /* retrieve profiling information of a device */
305 #define BIODASDPRRD _IOR(DASD_IOCTL_LETTER,2,dasd_profile_info_t)
306 /* Get information on a dasd device (enhanced) */
307 #define BIODASDINFO2 _IOR(DASD_IOCTL_LETTER,3,dasd_information2_t)
308 /* Performance Statistics Read */
309 #define BIODASDPSRD _IOR(DASD_IOCTL_LETTER,4,dasd_rssd_perf_stats_t)
310 /* Get Attributes (cache operations) */
311 #define BIODASDGATTR _IOR(DASD_IOCTL_LETTER,5,attrib_data_t)
314 /* #define BIODASDFORMAT _IOW(IOCTL_LETTER,0,format_data_t) , deprecated */
315 #define BIODASDFMT _IOW(DASD_IOCTL_LETTER,1,format_data_t)
316 /* Set Attributes (cache operations) */
317 #define BIODASDSATTR _IOW(DASD_IOCTL_LETTER,2,attrib_data_t)
319 /* Get Sense Path Group ID (SNID) data */
320 #define BIODASDSNID _IOWR(DASD_IOCTL_LETTER, 1, struct dasd_snid_ioctl_data)
321 /* Check device format according to format_check_t */
322 #define BIODASDCHECKFMT _IOWR(DASD_IOCTL_LETTER, 2, format_check_t)
324 #define BIODASDSYMMIO _IOWR(DASD_IOCTL_LETTER, 240, dasd_symmio_parms_t)