Merge git://git.kernel.org/pub/scm/linux/kernel/git/sam/kbuild
[linux-2.6] / include / asm-s390 / dasd.h
1 /* 
2  * File...........: linux/drivers/s390/block/dasd.c
3  * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
4  * Bugreports.to..: <Linux390@de.ibm.com>
5  * (C) IBM Corporation, IBM Deutschland Entwicklung GmbH, 1999,2000
6  *
7  * This file is the interface of the DASD device driver, which is exported to user space
8  * any future changes wrt the API will result in a change of the APIVERSION reported
9  * to userspace by the DASDAPIVER-ioctl
10  *
11  */
12
13 #ifndef DASD_H
14 #define DASD_H
15 #include <linux/ioctl.h>
16
17 #define DASD_IOCTL_LETTER 'D'
18
19 #define DASD_API_VERSION 6
20
21 /* 
22  * struct dasd_information2_t
23  * represents any data about the device, which is visible to userspace.
24  *  including foramt and featueres.
25  */
26 typedef struct dasd_information2_t {
27         unsigned int devno;         /* S/390 devno */
28         unsigned int real_devno;    /* for aliases */
29         unsigned int schid;         /* S/390 subchannel identifier */
30         unsigned int cu_type  : 16; /* from SenseID */
31         unsigned int cu_model :  8; /* from SenseID */
32         unsigned int dev_type : 16; /* from SenseID */
33         unsigned int dev_model : 8; /* from SenseID */
34         unsigned int open_count; 
35         unsigned int req_queue_len; 
36         unsigned int chanq_len;     /* length of chanq */
37         char type[4];               /* from discipline.name, 'none' for unknown */
38         unsigned int status;        /* current device level */
39         unsigned int label_block;   /* where to find the VOLSER */
40         unsigned int FBA_layout;    /* fixed block size (like AIXVOL) */
41         unsigned int characteristics_size;
42         unsigned int confdata_size;
43         char characteristics[64];   /* from read_device_characteristics */
44         char configuration_data[256]; /* from read_configuration_data */
45         unsigned int format;          /* format info like formatted/cdl/ldl/... */
46         unsigned int features;        /* dasd features like 'ro',...            */
47         unsigned int reserved0;       /* reserved for further use ,...          */
48         unsigned int reserved1;       /* reserved for further use ,...          */
49         unsigned int reserved2;       /* reserved for further use ,...          */
50         unsigned int reserved3;       /* reserved for further use ,...          */
51         unsigned int reserved4;       /* reserved for further use ,...          */
52         unsigned int reserved5;       /* reserved for further use ,...          */
53         unsigned int reserved6;       /* reserved for further use ,...          */
54         unsigned int reserved7;       /* reserved for further use ,...          */
55 } dasd_information2_t;
56
57 /*
58  * values to be used for dasd_information_t.format
59  * 0x00: NOT formatted
60  * 0x01: Linux disc layout
61  * 0x02: Common disc layout
62  */
63 #define DASD_FORMAT_NONE 0
64 #define DASD_FORMAT_LDL  1
65 #define DASD_FORMAT_CDL  2
66 /*
67  * values to be used for dasd_information_t.features
68  * 0x00: default features
69  * 0x01: readonly (ro)
70  * 0x02: use diag discipline (diag)
71  * 0x04: set the device initially online (internal use only)
72  * 0x08: enable ERP related logging
73  */
74 #define DASD_FEATURE_DEFAULT         0x00
75 #define DASD_FEATURE_READONLY        0x01
76 #define DASD_FEATURE_USEDIAG         0x02
77 #define DASD_FEATURE_INITIAL_ONLINE  0x04
78 #define DASD_FEATURE_ERPLOG          0x08
79
80 #define DASD_PARTN_BITS 2
81
82 /* 
83  * struct dasd_information_t
84  * represents any data about the data, which is visible to userspace
85  */
86 typedef struct dasd_information_t {
87         unsigned int devno;         /* S/390 devno */
88         unsigned int real_devno;    /* for aliases */
89         unsigned int schid;         /* S/390 subchannel identifier */
90         unsigned int cu_type  : 16; /* from SenseID */
91         unsigned int cu_model :  8; /* from SenseID */
92         unsigned int dev_type : 16; /* from SenseID */
93         unsigned int dev_model : 8; /* from SenseID */
94         unsigned int open_count; 
95         unsigned int req_queue_len; 
96         unsigned int chanq_len;     /* length of chanq */
97         char type[4];               /* from discipline.name, 'none' for unknown */
98         unsigned int status;        /* current device level */
99         unsigned int label_block;   /* where to find the VOLSER */
100         unsigned int FBA_layout;    /* fixed block size (like AIXVOL) */
101         unsigned int characteristics_size;
102         unsigned int confdata_size;
103         char characteristics[64];   /* from read_device_characteristics */
104         char configuration_data[256]; /* from read_configuration_data */
105 } dasd_information_t;
106
107 /*
108  * Read Subsystem Data - Performance Statistics
109  */ 
110 typedef struct dasd_rssd_perf_stats_t {
111         unsigned char  invalid:1;
112         unsigned char  format:3;
113         unsigned char  data_format:4;
114         unsigned char  unit_address;
115         unsigned short device_status;
116         unsigned int   nr_read_normal;
117         unsigned int   nr_read_normal_hits;
118         unsigned int   nr_write_normal;
119         unsigned int   nr_write_fast_normal_hits;
120         unsigned int   nr_read_seq;
121         unsigned int   nr_read_seq_hits;
122         unsigned int   nr_write_seq;
123         unsigned int   nr_write_fast_seq_hits;
124         unsigned int   nr_read_cache;
125         unsigned int   nr_read_cache_hits;
126         unsigned int   nr_write_cache;
127         unsigned int   nr_write_fast_cache_hits;
128         unsigned int   nr_inhibit_cache;
129         unsigned int   nr_bybass_cache;
130         unsigned int   nr_seq_dasd_to_cache;
131         unsigned int   nr_dasd_to_cache;
132         unsigned int   nr_cache_to_dasd;
133         unsigned int   nr_delayed_fast_write;
134         unsigned int   nr_normal_fast_write;
135         unsigned int   nr_seq_fast_write;
136         unsigned int   nr_cache_miss;
137         unsigned char  status2;
138         unsigned int   nr_quick_write_promotes;
139         unsigned char  reserved;
140         unsigned short ssid;
141         unsigned char  reseved2[96];
142 } __attribute__((packed)) dasd_rssd_perf_stats_t;
143
144 /* 
145  * struct profile_info_t
146  * holds the profinling information 
147  */
148 typedef struct dasd_profile_info_t {
149         unsigned int dasd_io_reqs;       /* number of requests processed at all */
150         unsigned int dasd_io_sects;      /* number of sectors processed at all */
151         unsigned int dasd_io_secs[32];   /* histogram of request's sizes */
152         unsigned int dasd_io_times[32];  /* histogram of requests's times */
153         unsigned int dasd_io_timps[32];  /* histogram of requests's times per sector */
154         unsigned int dasd_io_time1[32];  /* histogram of time from build to start */
155         unsigned int dasd_io_time2[32];  /* histogram of time from start to irq */
156         unsigned int dasd_io_time2ps[32]; /* histogram of time from start to irq */
157         unsigned int dasd_io_time3[32];  /* histogram of time from irq to end */
158         unsigned int dasd_io_nr_req[32]; /* histogram of # of requests in chanq */
159 } dasd_profile_info_t;
160
161 /* 
162  * struct format_data_t
163  * represents all data necessary to format a dasd
164  */
165 typedef struct format_data_t {
166         int start_unit; /* from track */
167         int stop_unit;  /* to track */
168         int blksize;    /* sectorsize */
169         int intensity;  
170 } format_data_t;
171
172 /*
173  * values to be used for format_data_t.intensity
174  * 0/8: normal format
175  * 1/9: also write record zero
176  * 3/11: also write home address
177  * 4/12: invalidate track
178  */
179 #define DASD_FMT_INT_FMT_R0 1 /* write record zero */
180 #define DASD_FMT_INT_FMT_HA 2 /* write home address, also set FMT_R0 ! */
181 #define DASD_FMT_INT_INVAL  4 /* invalidate tracks */
182 #define DASD_FMT_INT_COMPAT 8 /* use OS/390 compatible disk layout */
183
184
185 /* 
186  * struct attrib_data_t
187  * represents the operation (cache) bits for the device.
188  * Used in DE to influence caching of the DASD.
189  */
190 typedef struct attrib_data_t {
191         unsigned char operation:3;     /* cache operation mode */
192         unsigned char reserved:5;      /* cache operation mode */
193         __u16         nr_cyl;          /* no of cyliners for read ahaed */
194         __u8          reserved2[29];   /* for future use */
195 } __attribute__ ((packed)) attrib_data_t;
196
197 /* definition of operation (cache) bits within attributes of DE */
198 #define DASD_NORMAL_CACHE  0x0
199 #define DASD_BYPASS_CACHE  0x1
200 #define DASD_INHIBIT_LOAD  0x2
201 #define DASD_SEQ_ACCESS    0x3
202 #define DASD_SEQ_PRESTAGE  0x4
203 #define DASD_REC_ACCESS    0x5
204
205
206 /********************************************************************************
207  * SECTION: Definition of IOCTLs
208  *
209  * Here ist how the ioctl-nr should be used:
210  *    0 -   31   DASD driver itself
211  *   32 -  239   still open
212  *  240 -  255   reserved for EMC 
213  *******************************************************************************/
214
215 /* Disable the volume (for Linux) */
216 #define BIODASDDISABLE _IO(DASD_IOCTL_LETTER,0) 
217 /* Enable the volume (for Linux) */
218 #define BIODASDENABLE  _IO(DASD_IOCTL_LETTER,1)  
219 /* Issue a reserve/release command, rsp. */
220 #define BIODASDRSRV    _IO(DASD_IOCTL_LETTER,2) /* reserve */
221 #define BIODASDRLSE    _IO(DASD_IOCTL_LETTER,3) /* release */
222 #define BIODASDSLCK    _IO(DASD_IOCTL_LETTER,4) /* steal lock */
223 /* reset profiling information of a device */
224 #define BIODASDPRRST   _IO(DASD_IOCTL_LETTER,5)
225 /* Quiesce IO on device */
226 #define BIODASDQUIESCE _IO(DASD_IOCTL_LETTER,6) 
227 /* Resume IO on device */
228 #define BIODASDRESUME  _IO(DASD_IOCTL_LETTER,7) 
229
230
231 /* retrieve API version number */
232 #define DASDAPIVER     _IOR(DASD_IOCTL_LETTER,0,int)
233 /* Get information on a dasd device */
234 #define BIODASDINFO    _IOR(DASD_IOCTL_LETTER,1,dasd_information_t)
235 /* retrieve profiling information of a device */
236 #define BIODASDPRRD    _IOR(DASD_IOCTL_LETTER,2,dasd_profile_info_t)
237 /* Get information on a dasd device (enhanced) */
238 #define BIODASDINFO2   _IOR(DASD_IOCTL_LETTER,3,dasd_information2_t)
239 /* Performance Statistics Read */
240 #define BIODASDPSRD    _IOR(DASD_IOCTL_LETTER,4,dasd_rssd_perf_stats_t)
241 /* Get Attributes (cache operations) */
242 #define BIODASDGATTR   _IOR(DASD_IOCTL_LETTER,5,attrib_data_t) 
243
244
245 /* #define BIODASDFORMAT  _IOW(IOCTL_LETTER,0,format_data_t) , deprecated */
246 #define BIODASDFMT     _IOW(DASD_IOCTL_LETTER,1,format_data_t) 
247 /* Set Attributes (cache operations) */
248 #define BIODASDSATTR   _IOW(DASD_IOCTL_LETTER,2,attrib_data_t) 
249
250
251 #endif                          /* DASD_H */
252
253 /*
254  * Overrides for Emacs so that we follow Linus's tabbing style.
255  * Emacs will notice this stuff at the end of the file and automatically
256  * adjust the settings for this buffer only.  This must remain at the end
257  * of the file.
258  * ---------------------------------------------------------------------------
259  * Local variables:
260  * c-indent-level: 4 
261  * c-brace-imaginary-offset: 0
262  * c-brace-offset: -4
263  * c-argdecl-indent: 4
264  * c-label-offset: -4
265  * c-continued-statement-offset: 4
266  * c-continued-brace-offset: 0
267  * indent-tabs-mode: nil
268  * tab-width: 8
269  * End:
270  */