2 * drivers/s390/char/tape.h
3 * tape device driver for 3480/3490E/3590 tapes.
5 * S390 and zSeries version
6 * Copyright IBM Corp. 2001,2006
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>
16 #include <asm/ccwdev.h>
17 #include <asm/debug.h>
18 #include <asm/idals.h>
19 #include <linux/blkdev.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/mtio.h>
23 #include <linux/interrupt.h>
24 #include <linux/workqueue.h>
29 * Define DBF_LIKE_HELL for lots of messages in the debug feature.
33 #define DBF_LH(level, str, ...) \
35 debug_sprintf_event(TAPE_DBF_AREA, level, str, ## __VA_ARGS__); \
38 #define DBF_LH(level, str, ...) do {} while(0)
42 * macros s390 debug feature (dbf)
44 #define DBF_EVENT(d_level, d_str...) \
46 debug_sprintf_event(TAPE_DBF_AREA, d_level, d_str); \
49 #define DBF_EXCEPTION(d_level, d_str...) \
51 debug_sprintf_exception(TAPE_DBF_AREA, d_level, d_str); \
54 #define TAPE_VERSION_MAJOR 2
55 #define TAPE_VERSION_MINOR 0
56 #define TAPE_MAGIC "tape"
58 #define TAPE_MINORS_PER_DEV 2 /* two minors per device */
59 #define TAPEBLOCK_HSEC_SIZE 2048
60 #define TAPEBLOCK_HSEC_S2B 2
61 #define TAPEBLOCK_RETRIES 5
63 enum tape_medium_state
{
80 TO_BLOCK
, /* Block read */
81 TO_BSB
, /* Backward space block */
82 TO_BSF
, /* Backward space filemark */
83 TO_DSE
, /* Data security erase */
84 TO_FSB
, /* Forward space block */
85 TO_FSF
, /* Forward space filemark */
86 TO_LBL
, /* Locate block label */
87 TO_NOP
, /* No operation */
88 TO_RBA
, /* Read backward */
89 TO_RBI
, /* Read block information */
90 TO_RFO
, /* Read forward */
91 TO_REW
, /* Rewind tape */
92 TO_RUN
, /* Rewind and unload tape */
93 TO_WRI
, /* Write block */
94 TO_WTM
, /* Write tape mark */
95 TO_MSEN
, /* Medium sense */
96 TO_LOAD
, /* Load tape */
97 TO_READ_CONFIG
, /* Read configuration data */
98 TO_READ_ATTMSG
, /* Read attention message */
99 TO_DIS
, /* Tape display */
100 TO_ASSIGN
, /* Assign tape to channel path */
101 TO_UNASSIGN
, /* Unassign tape from channel path */
102 TO_CRYPT_ON
, /* Enable encrpytion */
103 TO_CRYPT_OFF
, /* Disable encrpytion */
104 TO_KEKL_SET
, /* Set KEK label */
105 TO_KEKL_QUERY
, /* Query KEK label */
106 TO_SIZE
, /* #entries in tape_op_t */
109 /* Forward declaration */
112 /* tape_request->status can be: */
113 enum tape_request_status
{
114 TAPE_REQUEST_INIT
, /* request is ready to be processed */
115 TAPE_REQUEST_QUEUED
, /* request is queued to be processed */
116 TAPE_REQUEST_IN_IO
, /* request is currently in IO */
117 TAPE_REQUEST_DONE
, /* request is completed. */
118 TAPE_REQUEST_CANCEL
, /* request should be canceled. */
119 TAPE_REQUEST_LONG_BUSY
, /* request has to be restarted after long busy */
122 /* Tape CCW request */
123 struct tape_request
{
124 struct list_head list
; /* list head for request queueing. */
125 struct tape_device
*device
; /* tape device of this request */
126 struct ccw1
*cpaddr
; /* address of the channel program. */
127 void *cpdata
; /* pointer to ccw data. */
128 enum tape_request_status status
;/* status of this request */
129 int options
; /* options for execution. */
130 int retries
; /* retry counter for error recovery. */
131 int rescnt
; /* residual count from devstat. */
133 /* Callback for delivering final status. */
134 void (*callback
)(struct tape_request
*, void *);
141 /* Function type for magnetic tape commands */
142 typedef int (*tape_mtop_fn
)(struct tape_device
*, int);
144 /* Size of the array containing the mtops for a discipline */
145 #define TAPE_NR_MTOPS (MTMKPART+1)
147 /* Tape Discipline */
148 struct tape_discipline
{
149 struct module
*owner
;
150 int (*setup_device
)(struct tape_device
*);
151 void (*cleanup_device
)(struct tape_device
*);
152 int (*irq
)(struct tape_device
*, struct tape_request
*, struct irb
*);
153 struct tape_request
*(*read_block
)(struct tape_device
*, size_t);
154 struct tape_request
*(*write_block
)(struct tape_device
*, size_t);
155 void (*process_eov
)(struct tape_device
*);
156 #ifdef CONFIG_S390_TAPE_BLOCK
157 /* Block device stuff. */
158 struct tape_request
*(*bread
)(struct tape_device
*, struct request
*);
159 void (*check_locate
)(struct tape_device
*, struct tape_request
*);
160 void (*free_bread
)(struct tape_request
*);
162 /* ioctl function for additional ioctls. */
163 int (*ioctl_fn
)(struct tape_device
*, unsigned int, unsigned long);
164 /* Array of tape commands with TAPE_NR_MTOPS entries */
165 tape_mtop_fn
*mtop_array
;
169 * The discipline irq function either returns an error code (<0) which
170 * means that the request has failed with an error or one of the following:
172 #define TAPE_IO_SUCCESS 0 /* request successful */
173 #define TAPE_IO_PENDING 1 /* request still running */
174 #define TAPE_IO_RETRY 2 /* retry to current request */
175 #define TAPE_IO_STOP 3 /* stop the running request */
176 #define TAPE_IO_LONG_BUSY 4 /* delay the running request */
178 /* Char Frontend Data */
179 struct tape_char_data
{
180 struct idal_buffer
*idal_buf
; /* idal buffer for user char data */
181 int block_size
; /* of size block_size. */
184 #ifdef CONFIG_S390_TAPE_BLOCK
185 /* Block Frontend Data */
188 struct tape_device
* device
;
189 /* Block device request queue. */
190 request_queue_t
* request_queue
;
191 spinlock_t request_queue_lock
;
193 /* Task to move entries from block request to CCS request queue. */
194 struct work_struct requeue_task
;
195 atomic_t requeue_scheduled
;
197 /* Current position on the tape. */
200 struct gendisk
* disk
;
206 /* entry in tape_device_list */
207 struct list_head node
;
210 struct ccw_device
* cdev
;
211 struct tape_class_device
* nt
;
212 struct tape_class_device
* rt
;
214 /* Device discipline information. */
215 struct tape_discipline
* discipline
;
218 /* Generic status flags */
219 long tape_generic_status
;
221 /* Device state information. */
222 wait_queue_head_t state_change_wq
;
223 enum tape_state tape_state
;
224 enum tape_medium_state medium_state
;
225 unsigned char * modeset_byte
;
227 /* Reference count. */
231 struct list_head req_queue
;
233 /* Each tape device has (currently) two minor numbers. */
236 /* Number of tapemarks required for correct termination. */
237 int required_tapemarks
;
239 /* Block ID of the BOF */
242 /* Character device frontend data */
243 struct tape_char_data char_data
;
244 #ifdef CONFIG_S390_TAPE_BLOCK
245 /* Block dev frontend data */
246 struct tape_blk_data blk_data
;
249 /* Function to start or stop the next request later. */
250 struct delayed_work tape_dnr
;
252 /* Timer for long busy */
253 struct timer_list lb_timeout
;
257 /* Externals from tape_core.c */
258 extern struct tape_request
*tape_alloc_request(int cplength
, int datasize
);
259 extern void tape_free_request(struct tape_request
*);
260 extern int tape_do_io(struct tape_device
*, struct tape_request
*);
261 extern int tape_do_io_async(struct tape_device
*, struct tape_request
*);
262 extern int tape_do_io_interruptible(struct tape_device
*, struct tape_request
*);
263 extern int tape_cancel_io(struct tape_device
*, struct tape_request
*);
264 void tape_hotplug_event(struct tape_device
*, int major
, int action
);
267 tape_do_io_free(struct tape_device
*device
, struct tape_request
*request
)
271 rc
= tape_do_io(device
, request
);
272 tape_free_request(request
);
276 extern int tape_oper_handler(int irq
, int status
);
277 extern void tape_noper_handler(int irq
, int status
);
278 extern int tape_open(struct tape_device
*);
279 extern int tape_release(struct tape_device
*);
280 extern int tape_mtop(struct tape_device
*, int, int);
281 extern void tape_state_set(struct tape_device
*, enum tape_state
);
283 extern int tape_generic_online(struct tape_device
*, struct tape_discipline
*);
284 extern int tape_generic_offline(struct tape_device
*device
);
286 /* Externals from tape_devmap.c */
287 extern int tape_generic_probe(struct ccw_device
*);
288 extern void tape_generic_remove(struct ccw_device
*);
290 extern struct tape_device
*tape_get_device(int devindex
);
291 extern struct tape_device
*tape_get_device_reference(struct tape_device
*);
292 extern struct tape_device
*tape_put_device(struct tape_device
*);
294 /* Externals from tape_char.c */
295 extern int tapechar_init(void);
296 extern void tapechar_exit(void);
297 extern int tapechar_setup_device(struct tape_device
*);
298 extern void tapechar_cleanup_device(struct tape_device
*);
300 /* Externals from tape_block.c */
301 #ifdef CONFIG_S390_TAPE_BLOCK
302 extern int tapeblock_init (void);
303 extern void tapeblock_exit(void);
304 extern int tapeblock_setup_device(struct tape_device
*);
305 extern void tapeblock_cleanup_device(struct tape_device
*);
307 static inline int tapeblock_init (void) {return 0;}
308 static inline void tapeblock_exit (void) {;}
309 static inline int tapeblock_setup_device(struct tape_device
*t
) {return 0;}
310 static inline void tapeblock_cleanup_device (struct tape_device
*t
) {;}
313 /* tape initialisation functions */
314 #ifdef CONFIG_PROC_FS
315 extern void tape_proc_init (void);
316 extern void tape_proc_cleanup (void);
318 static inline void tape_proc_init (void) {;}
319 static inline void tape_proc_cleanup (void) {;}
322 /* a function for dumping device sense info */
323 extern void tape_dump_sense(struct tape_device
*, struct tape_request
*,
325 extern void tape_dump_sense_dbf(struct tape_device
*, struct tape_request
*,
328 /* functions for handling the status of a device */
329 extern void tape_med_state_set(struct tape_device
*, enum tape_medium_state
);
332 extern debug_info_t
*TAPE_DBF_AREA
;
334 /* functions for building ccws */
335 static inline struct ccw1
*
336 tape_ccw_cc(struct ccw1
*ccw
, __u8 cmd_code
, __u16 memsize
, void *cda
)
338 ccw
->cmd_code
= cmd_code
;
339 ccw
->flags
= CCW_FLAG_CC
;
340 ccw
->count
= memsize
;
341 ccw
->cda
= (__u32
)(addr_t
) cda
;
345 static inline struct ccw1
*
346 tape_ccw_end(struct ccw1
*ccw
, __u8 cmd_code
, __u16 memsize
, void *cda
)
348 ccw
->cmd_code
= cmd_code
;
350 ccw
->count
= memsize
;
351 ccw
->cda
= (__u32
)(addr_t
) cda
;
355 static inline struct ccw1
*
356 tape_ccw_cmd(struct ccw1
*ccw
, __u8 cmd_code
)
358 ccw
->cmd_code
= cmd_code
;
361 ccw
->cda
= (__u32
)(addr_t
) &ccw
->cmd_code
;
365 static inline struct ccw1
*
366 tape_ccw_repeat(struct ccw1
*ccw
, __u8 cmd_code
, int count
)
368 while (count
-- > 0) {
369 ccw
->cmd_code
= cmd_code
;
370 ccw
->flags
= CCW_FLAG_CC
;
372 ccw
->cda
= (__u32
)(addr_t
) &ccw
->cmd_code
;
378 static inline struct ccw1
*
379 tape_ccw_cc_idal(struct ccw1
*ccw
, __u8 cmd_code
, struct idal_buffer
*idal
)
381 ccw
->cmd_code
= cmd_code
;
382 ccw
->flags
= CCW_FLAG_CC
;
383 idal_buffer_set_cda(idal
, ccw
);
387 static inline struct ccw1
*
388 tape_ccw_end_idal(struct ccw1
*ccw
, __u8 cmd_code
, struct idal_buffer
*idal
)
390 ccw
->cmd_code
= cmd_code
;
392 idal_buffer_set_cda(idal
, ccw
);
397 extern const char *tape_state_verbose
[];
398 extern const char *tape_op_verbose
[];
400 #endif /* for ifdef tape.h */