1 /* 2 * drivers/s390/char/tape.h 3 * tape device driver for 3480/3490E/3590 tapes. 4 * 5 * S390 and zSeries version 6 * Copyright (C) 2001,2005 IBM Deutschland Entwicklung GmbH, IBM Corporation 7 * Author(s): Carsten Otte <cotte@de.ibm.com> 8 * Tuan Ngo-Anh <ngoanh@de.ibm.com> 9 * Martin Schwidefsky <schwidefsky@de.ibm.com> 10 * Stefan Bader <shbader@de.ibm.com> 11 */ 12 13 #ifndef _TAPE_H 14 #define _TAPE_H 15 16 #include <asm/ccwdev.h> 17 #include <asm/debug.h> 18 #include <asm/idals.h> 19 #include <linux/config.h> 20 #include <linux/blkdev.h> 21 #include <linux/kernel.h> 22 #include <linux/module.h> 23 #include <linux/mtio.h> 24 #include <linux/interrupt.h> 25 #include <linux/workqueue.h> 26 27 struct gendisk; 28 29 /* 30 * Define DBF_LIKE_HELL for lots of messages in the debug feature. 31 */ 32 #define DBF_LIKE_HELL 33 #ifdef DBF_LIKE_HELL 34 #define DBF_LH(level, str, ...) \ 35 do { \ 36 debug_sprintf_event(TAPE_DBF_AREA, level, str, ## __VA_ARGS__); \ 37 } while (0) 38 #else 39 #define DBF_LH(level, str, ...) do {} while(0) 40 #endif 41 42 /* 43 * macros s390 debug feature (dbf) 44 */ 45 #define DBF_EVENT(d_level, d_str...) \ 46 do { \ 47 debug_sprintf_event(TAPE_DBF_AREA, d_level, d_str); \ 48 } while (0) 49 50 #define DBF_EXCEPTION(d_level, d_str...) \ 51 do { \ 52 debug_sprintf_exception(TAPE_DBF_AREA, d_level, d_str); \ 53 } while (0) 54 55 #define TAPE_VERSION_MAJOR 2 56 #define TAPE_VERSION_MINOR 0 57 #define TAPE_MAGIC "tape" 58 59 #define TAPE_MINORS_PER_DEV 2 /* two minors per device */ 60 #define TAPEBLOCK_HSEC_SIZE 2048 61 #define TAPEBLOCK_HSEC_S2B 2 62 #define TAPEBLOCK_RETRIES 5 63 64 enum tape_medium_state { 65 MS_UNKNOWN, 66 MS_LOADED, 67 MS_UNLOADED, 68 MS_SIZE 69 }; 70 71 enum tape_state { 72 TS_UNUSED=0, 73 TS_IN_USE, 74 TS_BLKUSE, 75 TS_INIT, 76 TS_NOT_OPER, 77 TS_SIZE 78 }; 79 80 enum tape_op { 81 TO_BLOCK, /* Block read */ 82 TO_BSB, /* Backward space block */ 83 TO_BSF, /* Backward space filemark */ 84 TO_DSE, /* Data security erase */ 85 TO_FSB, /* Forward space block */ 86 TO_FSF, /* Forward space filemark */ 87 TO_LBL, /* Locate block label */ 88 TO_NOP, /* No operation */ 89 TO_RBA, /* Read backward */ 90 TO_RBI, /* Read block information */ 91 TO_RFO, /* Read forward */ 92 TO_REW, /* Rewind tape */ 93 TO_RUN, /* Rewind and unload tape */ 94 TO_WRI, /* Write block */ 95 TO_WTM, /* Write tape mark */ 96 TO_MSEN, /* Medium sense */ 97 TO_LOAD, /* Load tape */ 98 TO_READ_CONFIG, /* Read configuration data */ 99 TO_READ_ATTMSG, /* Read attention message */ 100 TO_DIS, /* Tape display */ 101 TO_ASSIGN, /* Assign tape to channel path */ 102 TO_UNASSIGN, /* Unassign tape from channel path */ 103 TO_SIZE /* #entries in tape_op_t */ 104 }; 105 106 /* Forward declaration */ 107 struct tape_device; 108 109 /* tape_request->status can be: */ 110 enum tape_request_status { 111 TAPE_REQUEST_INIT, /* request is ready to be processed */ 112 TAPE_REQUEST_QUEUED, /* request is queued to be processed */ 113 TAPE_REQUEST_IN_IO, /* request is currently in IO */ 114 TAPE_REQUEST_DONE, /* request is completed. */ 115 TAPE_REQUEST_CANCEL, /* request should be canceled. */ 116 }; 117 118 /* Tape CCW request */ 119 struct tape_request { 120 struct list_head list; /* list head for request queueing. */ 121 struct tape_device *device; /* tape device of this request */ 122 struct ccw1 *cpaddr; /* address of the channel program. */ 123 void *cpdata; /* pointer to ccw data. */ 124 enum tape_request_status status;/* status of this request */ 125 int options; /* options for execution. */ 126 int retries; /* retry counter for error recovery. */ 127 int rescnt; /* residual count from devstat. */ 128 129 /* Callback for delivering final status. */ 130 void (*callback)(struct tape_request *, void *); 131 void *callback_data; 132 133 enum tape_op op; 134 int rc; 135 }; 136 137 /* Function type for magnetic tape commands */ 138 typedef int (*tape_mtop_fn)(struct tape_device *, int); 139 140 /* Size of the array containing the mtops for a discipline */ 141 #define TAPE_NR_MTOPS (MTMKPART+1) 142 143 /* Tape Discipline */ 144 struct tape_discipline { 145 struct module *owner; 146 int (*setup_device)(struct tape_device *); 147 void (*cleanup_device)(struct tape_device *); 148 int (*irq)(struct tape_device *, struct tape_request *, struct irb *); 149 struct tape_request *(*read_block)(struct tape_device *, size_t); 150 struct tape_request *(*write_block)(struct tape_device *, size_t); 151 void (*process_eov)(struct tape_device*); 152 #ifdef CONFIG_S390_TAPE_BLOCK 153 /* Block device stuff. */ 154 struct tape_request *(*bread)(struct tape_device *, struct request *); 155 void (*check_locate)(struct tape_device *, struct tape_request *); 156 void (*free_bread)(struct tape_request *); 157 #endif 158 /* ioctl function for additional ioctls. */ 159 int (*ioctl_fn)(struct tape_device *, unsigned int, unsigned long); 160 /* Array of tape commands with TAPE_NR_MTOPS entries */ 161 tape_mtop_fn *mtop_array; 162 }; 163 164 /* 165 * The discipline irq function either returns an error code (<0) which 166 * means that the request has failed with an error or one of the following: 167 */ 168 #define TAPE_IO_SUCCESS 0 /* request successful */ 169 #define TAPE_IO_PENDING 1 /* request still running */ 170 #define TAPE_IO_RETRY 2 /* retry to current request */ 171 #define TAPE_IO_STOP 3 /* stop the running request */ 172 173 /* Char Frontend Data */ 174 struct tape_char_data { 175 struct idal_buffer *idal_buf; /* idal buffer for user char data */ 176 int block_size; /* of size block_size. */ 177 }; 178 179 #ifdef CONFIG_S390_TAPE_BLOCK 180 /* Block Frontend Data */ 181 struct tape_blk_data 182 { 183 /* Block device request queue. */ 184 request_queue_t * request_queue; 185 spinlock_t request_queue_lock; 186 187 /* Task to move entries from block request to CCS request queue. */ 188 struct work_struct requeue_task; 189 atomic_t requeue_scheduled; 190 191 /* Current position on the tape. */ 192 long block_position; 193 int medium_changed; 194 struct gendisk * disk; 195 }; 196 #endif 197 198 /* Tape Info */ 199 struct tape_device { 200 /* entry in tape_device_list */ 201 struct list_head node; 202 203 int cdev_id; 204 struct ccw_device * cdev; 205 struct tape_class_device * nt; 206 struct tape_class_device * rt; 207 208 /* Device discipline information. */ 209 struct tape_discipline * discipline; 210 void * discdata; 211 212 /* Generic status flags */ 213 long tape_generic_status; 214 215 /* Device state information. */ 216 wait_queue_head_t state_change_wq; 217 enum tape_state tape_state; 218 enum tape_medium_state medium_state; 219 unsigned char * modeset_byte; 220 221 /* Reference count. */ 222 atomic_t ref_count; 223 224 /* Request queue. */ 225 struct list_head req_queue; 226 227 /* Each tape device has (currently) two minor numbers. */ 228 int first_minor; 229 230 /* Number of tapemarks required for correct termination. */ 231 int required_tapemarks; 232 233 /* Block ID of the BOF */ 234 unsigned int bof; 235 236 /* Character device frontend data */ 237 struct tape_char_data char_data; 238 #ifdef CONFIG_S390_TAPE_BLOCK 239 /* Block dev frontend data */ 240 struct tape_blk_data blk_data; 241 #endif 242 243 /* Function to start or stop the next request later. */ 244 struct work_struct tape_dnr; 245 }; 246 247 /* Externals from tape_core.c */ 248 extern struct tape_request *tape_alloc_request(int cplength, int datasize); 249 extern void tape_free_request(struct tape_request *); 250 extern int tape_do_io(struct tape_device *, struct tape_request *); 251 extern int tape_do_io_async(struct tape_device *, struct tape_request *); 252 extern int tape_do_io_interruptible(struct tape_device *, struct tape_request *); 253 extern int tape_cancel_io(struct tape_device *, struct tape_request *); 254 void tape_hotplug_event(struct tape_device *, int major, int action); 255 256 static inline int 257 tape_do_io_free(struct tape_device *device, struct tape_request *request) 258 { 259 int rc; 260 261 rc = tape_do_io(device, request); 262 tape_free_request(request); 263 return rc; 264 } 265 266 extern int tape_oper_handler(int irq, int status); 267 extern void tape_noper_handler(int irq, int status); 268 extern int tape_open(struct tape_device *); 269 extern int tape_release(struct tape_device *); 270 extern int tape_mtop(struct tape_device *, int, int); 271 extern void tape_state_set(struct tape_device *, enum tape_state); 272 273 extern int tape_generic_online(struct tape_device *, struct tape_discipline *); 274 extern int tape_generic_offline(struct tape_device *device); 275 276 /* Externals from tape_devmap.c */ 277 extern int tape_generic_probe(struct ccw_device *); 278 extern void tape_generic_remove(struct ccw_device *); 279 280 extern struct tape_device *tape_get_device(int devindex); 281 extern struct tape_device *tape_get_device_reference(struct tape_device *); 282 extern struct tape_device *tape_put_device(struct tape_device *); 283 284 /* Externals from tape_char.c */ 285 extern int tapechar_init(void); 286 extern void tapechar_exit(void); 287 extern int tapechar_setup_device(struct tape_device *); 288 extern void tapechar_cleanup_device(struct tape_device *); 289 290 /* Externals from tape_block.c */ 291 #ifdef CONFIG_S390_TAPE_BLOCK 292 extern int tapeblock_init (void); 293 extern void tapeblock_exit(void); 294 extern int tapeblock_setup_device(struct tape_device *); 295 extern void tapeblock_cleanup_device(struct tape_device *); 296 #else 297 static inline int tapeblock_init (void) {return 0;} 298 static inline void tapeblock_exit (void) {;} 299 static inline int tapeblock_setup_device(struct tape_device *t) {return 0;} 300 static inline void tapeblock_cleanup_device (struct tape_device *t) {;} 301 #endif 302 303 /* tape initialisation functions */ 304 #ifdef CONFIG_PROC_FS 305 extern void tape_proc_init (void); 306 extern void tape_proc_cleanup (void); 307 #else 308 static inline void tape_proc_init (void) {;} 309 static inline void tape_proc_cleanup (void) {;} 310 #endif 311 312 /* a function for dumping device sense info */ 313 extern void tape_dump_sense(struct tape_device *, struct tape_request *, 314 struct irb *); 315 extern void tape_dump_sense_dbf(struct tape_device *, struct tape_request *, 316 struct irb *); 317 318 /* functions for handling the status of a device */ 319 extern void tape_med_state_set(struct tape_device *, enum tape_medium_state); 320 321 /* The debug area */ 322 extern debug_info_t *TAPE_DBF_AREA; 323 324 /* functions for building ccws */ 325 static inline struct ccw1 * 326 tape_ccw_cc(struct ccw1 *ccw, __u8 cmd_code, __u16 memsize, void *cda) 327 { 328 ccw->cmd_code = cmd_code; 329 ccw->flags = CCW_FLAG_CC; 330 ccw->count = memsize; 331 ccw->cda = (__u32)(addr_t) cda; 332 return ccw + 1; 333 } 334 335 static inline struct ccw1 * 336 tape_ccw_end(struct ccw1 *ccw, __u8 cmd_code, __u16 memsize, void *cda) 337 { 338 ccw->cmd_code = cmd_code; 339 ccw->flags = 0; 340 ccw->count = memsize; 341 ccw->cda = (__u32)(addr_t) cda; 342 return ccw + 1; 343 } 344 345 static inline struct ccw1 * 346 tape_ccw_cmd(struct ccw1 *ccw, __u8 cmd_code) 347 { 348 ccw->cmd_code = cmd_code; 349 ccw->flags = 0; 350 ccw->count = 0; 351 ccw->cda = (__u32)(addr_t) &ccw->cmd_code; 352 return ccw + 1; 353 } 354 355 static inline struct ccw1 * 356 tape_ccw_repeat(struct ccw1 *ccw, __u8 cmd_code, int count) 357 { 358 while (count-- > 0) { 359 ccw->cmd_code = cmd_code; 360 ccw->flags = CCW_FLAG_CC; 361 ccw->count = 0; 362 ccw->cda = (__u32)(addr_t) &ccw->cmd_code; 363 ccw++; 364 } 365 return ccw; 366 } 367 368 static inline struct ccw1 * 369 tape_ccw_cc_idal(struct ccw1 *ccw, __u8 cmd_code, struct idal_buffer *idal) 370 { 371 ccw->cmd_code = cmd_code; 372 ccw->flags = CCW_FLAG_CC; 373 idal_buffer_set_cda(idal, ccw); 374 return ccw++; 375 } 376 377 static inline struct ccw1 * 378 tape_ccw_end_idal(struct ccw1 *ccw, __u8 cmd_code, struct idal_buffer *idal) 379 { 380 ccw->cmd_code = cmd_code; 381 ccw->flags = 0; 382 idal_buffer_set_cda(idal, ccw); 383 return ccw++; 384 } 385 386 /* Global vars */ 387 extern const char *tape_state_verbose[]; 388 extern const char *tape_op_verbose[]; 389 390 #endif /* for ifdef tape.h */ 391