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