]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/scsi/sd.c
[SCSI] gdth: Stop abusing ->done for internal commands
[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / sd.c
CommitLineData
1da177e4
LT
1/*
2 * sd.c Copyright (C) 1992 Drew Eckhardt
3 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
4 *
5 * Linux scsi disk driver
6 * Initial versions: Drew Eckhardt
7 * Subsequent revisions: Eric Youngdale
8 * Modification history:
9 * - Drew Eckhardt <drew@colorado.edu> original
10 * - Eric Youngdale <eric@andante.org> add scatter-gather, multiple
11 * outstanding request, and other enhancements.
12 * Support loadable low-level scsi drivers.
13 * - Jirka Hanika <geo@ff.cuni.cz> support more scsi disks using
14 * eight major numbers.
15 * - Richard Gooch <rgooch@atnf.csiro.au> support devfs.
16 * - Torben Mathiasen <tmm@image.dk> Resource allocation fixes in
17 * sd_init and cleanups.
18 * - Alex Davis <letmein@erols.com> Fix problem where partition info
19 * not being read in sd_open. Fix problem where removable media
20 * could be ejected after sd_open.
21 * - Douglas Gilbert <dgilbert@interlog.com> cleanup for lk 2.5.x
22 * - Badari Pulavarty <pbadari@us.ibm.com>, Matthew Wilcox
23 * <willy@debian.org>, Kurt Garloff <garloff@suse.de>:
24 * Support 32k/1M disks.
25 *
26 * Logging policy (needs CONFIG_SCSI_LOGGING defined):
27 * - setting up transfer: SCSI_LOG_HLQUEUE levels 1 and 2
28 * - end of transfer (bh + scsi_lib): SCSI_LOG_HLCOMPLETE level 1
29 * - entering sd_ioctl: SCSI_LOG_IOCTL level 1
30 * - entering other commands: SCSI_LOG_HLQUEUE level 3
31 * Note: when the logging level is set by the user, it must be greater
32 * than the level indicated above to trigger output.
33 */
34
1da177e4
LT
35#include <linux/module.h>
36#include <linux/fs.h>
37#include <linux/kernel.h>
1da177e4
LT
38#include <linux/mm.h>
39#include <linux/bio.h>
40#include <linux/genhd.h>
41#include <linux/hdreg.h>
42#include <linux/errno.h>
43#include <linux/idr.h>
44#include <linux/interrupt.h>
45#include <linux/init.h>
46#include <linux/blkdev.h>
47#include <linux/blkpg.h>
1da177e4 48#include <linux/delay.h>
0b950672 49#include <linux/mutex.h>
1da177e4
LT
50#include <asm/uaccess.h>
51
52#include <scsi/scsi.h>
53#include <scsi/scsi_cmnd.h>
54#include <scsi/scsi_dbg.h>
55#include <scsi/scsi_device.h>
56#include <scsi/scsi_driver.h>
57#include <scsi/scsi_eh.h>
58#include <scsi/scsi_host.h>
59#include <scsi/scsi_ioctl.h>
1da177e4 60#include <scsi/scsicam.h>
e73aec82 61#include <scsi/sd.h>
1da177e4
LT
62
63#include "scsi_logging.h"
64
f018fa55
RH
65MODULE_AUTHOR("Eric Youngdale");
66MODULE_DESCRIPTION("SCSI disk (sd) driver");
67MODULE_LICENSE("GPL");
68
69MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
70MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
71MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
72MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
73MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
74MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
75MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
76MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
77MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
78MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
79MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
80MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
81MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
82MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
83MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
84MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
d7b8bcb0
MT
85MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
86MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
87MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
f018fa55 88
1da177e4
LT
89static DEFINE_IDR(sd_index_idr);
90static DEFINE_SPINLOCK(sd_index_lock);
91
92/* This semaphore is used to mediate the 0->1 reference get in the
93 * face of object destruction (i.e. we can't allow a get on an
94 * object after last put) */
0b950672 95static DEFINE_MUTEX(sd_ref_mutex);
1da177e4 96
6bdaa1f1
JB
97static const char *sd_cache_types[] = {
98 "write through", "none", "write back",
99 "write back, no read (daft)"
100};
101
102static ssize_t sd_store_cache_type(struct class_device *cdev, const char *buf,
103 size_t count)
104{
105 int i, ct = -1, rcd, wce, sp;
106 struct scsi_disk *sdkp = to_scsi_disk(cdev);
107 struct scsi_device *sdp = sdkp->device;
108 char buffer[64];
109 char *buffer_data;
110 struct scsi_mode_data data;
111 struct scsi_sense_hdr sshdr;
112 int len;
113
114 if (sdp->type != TYPE_DISK)
115 /* no cache control on RBC devices; theoretically they
116 * can do it, but there's probably so many exceptions
117 * it's not worth the risk */
118 return -EINVAL;
119
6391a113 120 for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
6bdaa1f1
JB
121 const int len = strlen(sd_cache_types[i]);
122 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
123 buf[len] == '\n') {
124 ct = i;
125 break;
126 }
127 }
128 if (ct < 0)
129 return -EINVAL;
130 rcd = ct & 0x01 ? 1 : 0;
131 wce = ct & 0x02 ? 1 : 0;
132 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
133 SD_MAX_RETRIES, &data, NULL))
134 return -EINVAL;
a9312fb8 135 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
6bdaa1f1
JB
136 data.block_descriptor_length);
137 buffer_data = buffer + data.header_length +
138 data.block_descriptor_length;
139 buffer_data[2] &= ~0x05;
140 buffer_data[2] |= wce << 2 | rcd;
141 sp = buffer_data[0] & 0x80 ? 1 : 0;
142
143 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
144 SD_MAX_RETRIES, &data, &sshdr)) {
145 if (scsi_sense_valid(&sshdr))
e73aec82 146 sd_print_sense_hdr(sdkp, &sshdr);
6bdaa1f1
JB
147 return -EINVAL;
148 }
149 sd_revalidate_disk(sdkp->disk);
150 return count;
151}
152
c3c94c5a
TH
153static ssize_t sd_store_manage_start_stop(struct class_device *cdev,
154 const char *buf, size_t count)
155{
156 struct scsi_disk *sdkp = to_scsi_disk(cdev);
157 struct scsi_device *sdp = sdkp->device;
158
159 if (!capable(CAP_SYS_ADMIN))
160 return -EACCES;
161
162 sdp->manage_start_stop = simple_strtoul(buf, NULL, 10);
163
164 return count;
165}
166
a144c5ae
BK
167static ssize_t sd_store_allow_restart(struct class_device *cdev, const char *buf,
168 size_t count)
169{
170 struct scsi_disk *sdkp = to_scsi_disk(cdev);
171 struct scsi_device *sdp = sdkp->device;
172
173 if (!capable(CAP_SYS_ADMIN))
174 return -EACCES;
175
176 if (sdp->type != TYPE_DISK)
177 return -EINVAL;
178
179 sdp->allow_restart = simple_strtoul(buf, NULL, 10);
180
181 return count;
182}
183
6bdaa1f1
JB
184static ssize_t sd_show_cache_type(struct class_device *cdev, char *buf)
185{
186 struct scsi_disk *sdkp = to_scsi_disk(cdev);
187 int ct = sdkp->RCD + 2*sdkp->WCE;
188
189 return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
190}
191
192static ssize_t sd_show_fua(struct class_device *cdev, char *buf)
193{
194 struct scsi_disk *sdkp = to_scsi_disk(cdev);
195
196 return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
197}
198
c3c94c5a
TH
199static ssize_t sd_show_manage_start_stop(struct class_device *cdev, char *buf)
200{
201 struct scsi_disk *sdkp = to_scsi_disk(cdev);
202 struct scsi_device *sdp = sdkp->device;
203
204 return snprintf(buf, 20, "%u\n", sdp->manage_start_stop);
205}
206
a144c5ae
BK
207static ssize_t sd_show_allow_restart(struct class_device *cdev, char *buf)
208{
209 struct scsi_disk *sdkp = to_scsi_disk(cdev);
210
211 return snprintf(buf, 40, "%d\n", sdkp->device->allow_restart);
212}
213
6bdaa1f1
JB
214static struct class_device_attribute sd_disk_attrs[] = {
215 __ATTR(cache_type, S_IRUGO|S_IWUSR, sd_show_cache_type,
216 sd_store_cache_type),
217 __ATTR(FUA, S_IRUGO, sd_show_fua, NULL),
a144c5ae
BK
218 __ATTR(allow_restart, S_IRUGO|S_IWUSR, sd_show_allow_restart,
219 sd_store_allow_restart),
c3c94c5a
TH
220 __ATTR(manage_start_stop, S_IRUGO|S_IWUSR, sd_show_manage_start_stop,
221 sd_store_manage_start_stop),
6bdaa1f1
JB
222 __ATTR_NULL,
223};
224
225static struct class sd_disk_class = {
226 .name = "scsi_disk",
227 .owner = THIS_MODULE,
228 .release = scsi_disk_release,
229 .class_dev_attrs = sd_disk_attrs,
230};
1da177e4
LT
231
232static struct scsi_driver sd_template = {
233 .owner = THIS_MODULE,
234 .gendrv = {
235 .name = "sd",
236 .probe = sd_probe,
237 .remove = sd_remove,
c3c94c5a
TH
238 .suspend = sd_suspend,
239 .resume = sd_resume,
1da177e4
LT
240 .shutdown = sd_shutdown,
241 },
242 .rescan = sd_rescan,
1da177e4
LT
243};
244
245/*
246 * Device no to disk mapping:
247 *
248 * major disc2 disc p1
249 * |............|.............|....|....| <- dev_t
250 * 31 20 19 8 7 4 3 0
251 *
252 * Inside a major, we have 16k disks, however mapped non-
253 * contiguously. The first 16 disks are for major0, the next
254 * ones with major1, ... Disk 256 is for major0 again, disk 272
255 * for major1, ...
256 * As we stay compatible with our numbering scheme, we can reuse
257 * the well-know SCSI majors 8, 65--71, 136--143.
258 */
259static int sd_major(int major_idx)
260{
261 switch (major_idx) {
262 case 0:
263 return SCSI_DISK0_MAJOR;
264 case 1 ... 7:
265 return SCSI_DISK1_MAJOR + major_idx - 1;
266 case 8 ... 15:
267 return SCSI_DISK8_MAJOR + major_idx - 8;
268 default:
269 BUG();
270 return 0; /* shut up gcc */
271 }
272}
273
1da177e4
LT
274static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
275{
276 return container_of(disk->private_data, struct scsi_disk, driver);
277}
278
39b7f1e2 279static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
1da177e4
LT
280{
281 struct scsi_disk *sdkp = NULL;
282
39b7f1e2
AS
283 if (disk->private_data) {
284 sdkp = scsi_disk(disk);
285 if (scsi_device_get(sdkp->device) == 0)
6bdaa1f1 286 class_device_get(&sdkp->cdev);
39b7f1e2
AS
287 else
288 sdkp = NULL;
289 }
290 return sdkp;
291}
292
293static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
294{
295 struct scsi_disk *sdkp;
296
0b950672 297 mutex_lock(&sd_ref_mutex);
39b7f1e2 298 sdkp = __scsi_disk_get(disk);
0b950672 299 mutex_unlock(&sd_ref_mutex);
1da177e4 300 return sdkp;
39b7f1e2 301}
1da177e4 302
39b7f1e2
AS
303static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
304{
305 struct scsi_disk *sdkp;
306
0b950672 307 mutex_lock(&sd_ref_mutex);
39b7f1e2
AS
308 sdkp = dev_get_drvdata(dev);
309 if (sdkp)
310 sdkp = __scsi_disk_get(sdkp->disk);
0b950672 311 mutex_unlock(&sd_ref_mutex);
1da177e4
LT
312 return sdkp;
313}
314
315static void scsi_disk_put(struct scsi_disk *sdkp)
316{
317 struct scsi_device *sdev = sdkp->device;
318
0b950672 319 mutex_lock(&sd_ref_mutex);
6bdaa1f1 320 class_device_put(&sdkp->cdev);
1da177e4 321 scsi_device_put(sdev);
0b950672 322 mutex_unlock(&sd_ref_mutex);
1da177e4
LT
323}
324
325/**
326 * sd_init_command - build a scsi (read or write) command from
327 * information in the request structure.
328 * @SCpnt: pointer to mid-level's per scsi command structure that
329 * contains request and into which the scsi command is written
330 *
331 * Returns 1 if successful and 0 if error (or cannot be done now).
332 **/
7f9a6bc4 333static int sd_prep_fn(struct request_queue *q, struct request *rq)
1da177e4 334{
7f9a6bc4
JB
335 struct scsi_cmnd *SCpnt;
336 struct scsi_device *sdp = q->queuedata;
776b23a0
CH
337 struct gendisk *disk = rq->rq_disk;
338 sector_t block = rq->sector;
7f9a6bc4 339 unsigned int this_count = rq->nr_sectors;
776b23a0 340 unsigned int timeout = sdp->timeout;
7f9a6bc4
JB
341 int ret;
342
343 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
344 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
345 goto out;
346 } else if (rq->cmd_type != REQ_TYPE_FS) {
347 ret = BLKPREP_KILL;
348 goto out;
349 }
350 ret = scsi_setup_fs_cmnd(sdp, rq);
351 if (ret != BLKPREP_OK)
352 goto out;
353 SCpnt = rq->special;
354
355 /* from here on until we're complete, any goto out
356 * is used for a killable error condition */
357 ret = BLKPREP_KILL;
1da177e4 358
fa0d34be
MP
359 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
360 "sd_init_command: block=%llu, "
361 "count=%d\n",
362 (unsigned long long)block,
363 this_count));
1da177e4
LT
364
365 if (!sdp || !scsi_device_online(sdp) ||
366 block + rq->nr_sectors > get_capacity(disk)) {
fa0d34be
MP
367 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
368 "Finishing %ld sectors\n",
369 rq->nr_sectors));
370 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
371 "Retry with 0x%p\n", SCpnt));
7f9a6bc4 372 goto out;
1da177e4
LT
373 }
374
375 if (sdp->changed) {
376 /*
377 * quietly refuse to do anything to a changed disc until
378 * the changed bit has been reset
379 */
380 /* printk("SCSI disk has been changed. Prohibiting further I/O.\n"); */
7f9a6bc4 381 goto out;
1da177e4 382 }
7f9a6bc4 383
fa0d34be
MP
384 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
385 (unsigned long long)block));
1da177e4
LT
386
387 /*
388 * If we have a 1K hardware sectorsize, prevent access to single
389 * 512 byte sectors. In theory we could handle this - in fact
390 * the scsi cdrom driver must be able to handle this because
391 * we typically use 1K blocksizes, and cdroms typically have
392 * 2K hardware sectorsizes. Of course, things are simpler
393 * with the cdrom, since it is read-only. For performance
394 * reasons, the filesystems should be able to handle this
395 * and not force the scsi disk driver to use bounce buffers
396 * for this.
397 */
398 if (sdp->sector_size == 1024) {
399 if ((block & 1) || (rq->nr_sectors & 1)) {
e73aec82
MP
400 scmd_printk(KERN_ERR, SCpnt,
401 "Bad block number requested\n");
7f9a6bc4 402 goto out;
1da177e4
LT
403 } else {
404 block = block >> 1;
405 this_count = this_count >> 1;
406 }
407 }
408 if (sdp->sector_size == 2048) {
409 if ((block & 3) || (rq->nr_sectors & 3)) {
e73aec82
MP
410 scmd_printk(KERN_ERR, SCpnt,
411 "Bad block number requested\n");
7f9a6bc4 412 goto out;
1da177e4
LT
413 } else {
414 block = block >> 2;
415 this_count = this_count >> 2;
416 }
417 }
418 if (sdp->sector_size == 4096) {
419 if ((block & 7) || (rq->nr_sectors & 7)) {
e73aec82
MP
420 scmd_printk(KERN_ERR, SCpnt,
421 "Bad block number requested\n");
7f9a6bc4 422 goto out;
1da177e4
LT
423 } else {
424 block = block >> 3;
425 this_count = this_count >> 3;
426 }
427 }
428 if (rq_data_dir(rq) == WRITE) {
429 if (!sdp->writeable) {
7f9a6bc4 430 goto out;
1da177e4
LT
431 }
432 SCpnt->cmnd[0] = WRITE_6;
433 SCpnt->sc_data_direction = DMA_TO_DEVICE;
434 } else if (rq_data_dir(rq) == READ) {
435 SCpnt->cmnd[0] = READ_6;
436 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
437 } else {
e73aec82 438 scmd_printk(KERN_ERR, SCpnt, "Unknown command %x\n", rq->cmd_flags);
7f9a6bc4 439 goto out;
1da177e4
LT
440 }
441
fa0d34be
MP
442 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
443 "%s %d/%ld 512 byte blocks.\n",
444 (rq_data_dir(rq) == WRITE) ?
445 "writing" : "reading", this_count,
446 rq->nr_sectors));
1da177e4
LT
447
448 SCpnt->cmnd[1] = 0;
449
450 if (block > 0xffffffff) {
451 SCpnt->cmnd[0] += READ_16 - READ_6;
007365ad 452 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
1da177e4
LT
453 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
454 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
455 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
456 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
457 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
458 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
459 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
460 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
461 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
462 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
463 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
464 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
465 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
466 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
467 SCpnt->device->use_10_for_rw) {
468 if (this_count > 0xffff)
469 this_count = 0xffff;
470
471 SCpnt->cmnd[0] += READ_10 - READ_6;
007365ad 472 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
1da177e4
LT
473 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
474 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
475 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
476 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
477 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
478 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
479 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
480 } else {
007365ad
TH
481 if (unlikely(blk_fua_rq(rq))) {
482 /*
483 * This happens only if this drive failed
484 * 10byte rw command with ILLEGAL_REQUEST
485 * during operation and thus turned off
486 * use_10_for_rw.
487 */
e73aec82
MP
488 scmd_printk(KERN_ERR, SCpnt,
489 "FUA write on READ/WRITE(6) drive\n");
7f9a6bc4 490 goto out;
007365ad
TH
491 }
492
1da177e4
LT
493 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
494 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
495 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
496 SCpnt->cmnd[4] = (unsigned char) this_count;
497 SCpnt->cmnd[5] = 0;
498 }
631c228c 499 SCpnt->request_bufflen = this_count * sdp->sector_size;
1da177e4
LT
500
501 /*
502 * We shouldn't disconnect in the middle of a sector, so with a dumb
503 * host adapter, it's safe to assume that we can at least transfer
504 * this many bytes between each connect / disconnect.
505 */
506 SCpnt->transfersize = sdp->sector_size;
507 SCpnt->underflow = this_count << 9;
508 SCpnt->allowed = SD_MAX_RETRIES;
1da177e4
LT
509 SCpnt->timeout_per_command = timeout;
510
511 /*
512 * This is the completion routine we use. This is matched in terms
513 * of capability to this function.
514 */
515 SCpnt->done = sd_rw_intr;
516
517 /*
518 * This indicates that the command is ready from our end to be
519 * queued.
520 */
7f9a6bc4
JB
521 ret = BLKPREP_OK;
522 out:
523 return scsi_prep_return(q, rq, ret);
1da177e4
LT
524}
525
526/**
527 * sd_open - open a scsi disk device
528 * @inode: only i_rdev member may be used
529 * @filp: only f_mode and f_flags may be used
530 *
531 * Returns 0 if successful. Returns a negated errno value in case
532 * of error.
533 *
534 * Note: This can be called from a user context (e.g. fsck(1) )
535 * or from within the kernel (e.g. as a result of a mount(1) ).
536 * In the latter case @inode and @filp carry an abridged amount
537 * of information as noted above.
538 **/
539static int sd_open(struct inode *inode, struct file *filp)
540{
541 struct gendisk *disk = inode->i_bdev->bd_disk;
542 struct scsi_disk *sdkp;
543 struct scsi_device *sdev;
544 int retval;
545
546 if (!(sdkp = scsi_disk_get(disk)))
547 return -ENXIO;
548
549
fa0d34be 550 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1da177e4
LT
551
552 sdev = sdkp->device;
553
554 /*
555 * If the device is in error recovery, wait until it is done.
556 * If the device is offline, then disallow any access to it.
557 */
558 retval = -ENXIO;
559 if (!scsi_block_when_processing_errors(sdev))
560 goto error_out;
561
562 if (sdev->removable || sdkp->write_prot)
563 check_disk_change(inode->i_bdev);
564
565 /*
566 * If the drive is empty, just let the open fail.
567 */
568 retval = -ENOMEDIUM;
569 if (sdev->removable && !sdkp->media_present &&
570 !(filp->f_flags & O_NDELAY))
571 goto error_out;
572
573 /*
574 * If the device has the write protect tab set, have the open fail
575 * if the user expects to be able to write to the thing.
576 */
577 retval = -EROFS;
578 if (sdkp->write_prot && (filp->f_mode & FMODE_WRITE))
579 goto error_out;
580
581 /*
582 * It is possible that the disk changing stuff resulted in
583 * the device being taken offline. If this is the case,
584 * report this to the user, and don't pretend that the
585 * open actually succeeded.
586 */
587 retval = -ENXIO;
588 if (!scsi_device_online(sdev))
589 goto error_out;
590
591 if (!sdkp->openers++ && sdev->removable) {
592 if (scsi_block_when_processing_errors(sdev))
593 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
594 }
595
596 return 0;
597
598error_out:
599 scsi_disk_put(sdkp);
600 return retval;
601}
602
603/**
604 * sd_release - invoked when the (last) close(2) is called on this
605 * scsi disk.
606 * @inode: only i_rdev member may be used
607 * @filp: only f_mode and f_flags may be used
608 *
609 * Returns 0.
610 *
611 * Note: may block (uninterruptible) if error recovery is underway
612 * on this disk.
613 **/
614static int sd_release(struct inode *inode, struct file *filp)
615{
616 struct gendisk *disk = inode->i_bdev->bd_disk;
617 struct scsi_disk *sdkp = scsi_disk(disk);
618 struct scsi_device *sdev = sdkp->device;
619
56937f7b 620 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1da177e4
LT
621
622 if (!--sdkp->openers && sdev->removable) {
623 if (scsi_block_when_processing_errors(sdev))
624 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
625 }
626
627 /*
628 * XXX and what if there are packets in flight and this close()
629 * XXX is followed by a "rmmod sd_mod"?
630 */
631 scsi_disk_put(sdkp);
632 return 0;
633}
634
a885c8c4 635static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1da177e4
LT
636{
637 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
638 struct scsi_device *sdp = sdkp->device;
639 struct Scsi_Host *host = sdp->host;
640 int diskinfo[4];
641
642 /* default to most commonly used values */
643 diskinfo[0] = 0x40; /* 1 << 6 */
644 diskinfo[1] = 0x20; /* 1 << 5 */
645 diskinfo[2] = sdkp->capacity >> 11;
646
647 /* override with calculated, extended default, or driver values */
648 if (host->hostt->bios_param)
649 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
650 else
651 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
652
a885c8c4
CH
653 geo->heads = diskinfo[0];
654 geo->sectors = diskinfo[1];
655 geo->cylinders = diskinfo[2];
1da177e4
LT
656 return 0;
657}
658
659/**
660 * sd_ioctl - process an ioctl
661 * @inode: only i_rdev/i_bdev members may be used
662 * @filp: only f_mode and f_flags may be used
663 * @cmd: ioctl command number
664 * @arg: this is third argument given to ioctl(2) system call.
665 * Often contains a pointer.
666 *
667 * Returns 0 if successful (some ioctls return postive numbers on
668 * success as well). Returns a negated errno value in case of error.
669 *
670 * Note: most ioctls are forward onto the block subsystem or further
671 * down in the scsi subsytem.
672 **/
673static int sd_ioctl(struct inode * inode, struct file * filp,
674 unsigned int cmd, unsigned long arg)
675{
676 struct block_device *bdev = inode->i_bdev;
677 struct gendisk *disk = bdev->bd_disk;
678 struct scsi_device *sdp = scsi_disk(disk)->device;
679 void __user *p = (void __user *)arg;
680 int error;
681
682 SCSI_LOG_IOCTL(1, printk("sd_ioctl: disk=%s, cmd=0x%x\n",
683 disk->disk_name, cmd));
684
685 /*
686 * If we are in the middle of error recovery, don't let anyone
687 * else try and use this device. Also, if error recovery fails, it
688 * may try and take the device offline, in which case all further
689 * access to the device is prohibited.
690 */
691 error = scsi_nonblockable_ioctl(sdp, cmd, p, filp);
692 if (!scsi_block_when_processing_errors(sdp) || !error)
693 return error;
694
1da177e4
LT
695 /*
696 * Send SCSI addressing ioctls directly to mid level, send other
697 * ioctls to block level and then onto mid level if they can't be
698 * resolved.
699 */
700 switch (cmd) {
701 case SCSI_IOCTL_GET_IDLUN:
702 case SCSI_IOCTL_GET_BUS_NUMBER:
703 return scsi_ioctl(sdp, cmd, p);
704 default:
45e79a3a 705 error = scsi_cmd_ioctl(filp, disk->queue, disk, cmd, p);
1da177e4
LT
706 if (error != -ENOTTY)
707 return error;
708 }
709 return scsi_ioctl(sdp, cmd, p);
710}
711
712static void set_media_not_present(struct scsi_disk *sdkp)
713{
714 sdkp->media_present = 0;
715 sdkp->capacity = 0;
716 sdkp->device->changed = 1;
717}
718
719/**
720 * sd_media_changed - check if our medium changed
721 * @disk: kernel device descriptor
722 *
723 * Returns 0 if not applicable or no change; 1 if change
724 *
725 * Note: this function is invoked from the block subsystem.
726 **/
727static int sd_media_changed(struct gendisk *disk)
728{
729 struct scsi_disk *sdkp = scsi_disk(disk);
730 struct scsi_device *sdp = sdkp->device;
731 int retval;
732
fa0d34be 733 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_media_changed\n"));
1da177e4
LT
734
735 if (!sdp->removable)
736 return 0;
737
738 /*
739 * If the device is offline, don't send any commands - just pretend as
740 * if the command failed. If the device ever comes back online, we
741 * can deal with it then. It is only because of unrecoverable errors
742 * that we would ever take a device offline in the first place.
743 */
744 if (!scsi_device_online(sdp))
745 goto not_present;
746
747 /*
748 * Using TEST_UNIT_READY enables differentiation between drive with
749 * no cartridge loaded - NOT READY, drive with changed cartridge -
750 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
751 *
752 * Drives that auto spin down. eg iomega jaz 1G, will be started
753 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
754 * sd_revalidate() is called.
755 */
756 retval = -ENODEV;
757 if (scsi_block_when_processing_errors(sdp))
758 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES);
759
760 /*
761 * Unable to test, unit probably not ready. This usually
762 * means there is no disc in the drive. Mark as changed,
763 * and we will figure it out later once the drive is
764 * available again.
765 */
766 if (retval)
767 goto not_present;
768
769 /*
770 * For removable scsi disk we have to recognise the presence
771 * of a disk in the drive. This is kept in the struct scsi_disk
772 * struct and tested at open ! Daniel Roche (dan@lectra.fr)
773 */
774 sdkp->media_present = 1;
775
776 retval = sdp->changed;
777 sdp->changed = 0;
778
779 return retval;
780
781not_present:
782 set_media_not_present(sdkp);
783 return 1;
784}
785
e73aec82 786static int sd_sync_cache(struct scsi_disk *sdkp)
1da177e4 787{
1da177e4 788 int retries, res;
e73aec82 789 struct scsi_device *sdp = sdkp->device;
ea73a9f2 790 struct scsi_sense_hdr sshdr;
1da177e4
LT
791
792 if (!scsi_device_online(sdp))
793 return -ENODEV;
794
1da177e4 795
1da177e4
LT
796 for (retries = 3; retries > 0; --retries) {
797 unsigned char cmd[10] = { 0 };
798
799 cmd[0] = SYNCHRONIZE_CACHE;
800 /*
801 * Leave the rest of the command zero to indicate
802 * flush everything.
803 */
ea73a9f2
JB
804 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
805 SD_TIMEOUT, SD_MAX_RETRIES);
806 if (res == 0)
1da177e4
LT
807 break;
808 }
809
e73aec82
MP
810 if (res) {
811 sd_print_result(sdkp, res);
812 if (driver_byte(res) & DRIVER_SENSE)
813 sd_print_sense_hdr(sdkp, &sshdr);
1da177e4
LT
814 }
815
3721050a
TH
816 if (res)
817 return -EIO;
818 return 0;
1da177e4
LT
819}
820
03a5743a
JB
821static int sd_issue_flush(struct request_queue *q, struct gendisk *disk,
822 sector_t *error_sector)
1da177e4 823{
39b7f1e2 824 int ret = 0;
03a5743a
JB
825 struct scsi_device *sdp = q->queuedata;
826 struct scsi_disk *sdkp;
827
828 if (sdp->sdev_state != SDEV_RUNNING)
829 return -ENXIO;
830
831 sdkp = scsi_disk_get_from_dev(&sdp->sdev_gendev);
1da177e4
LT
832
833 if (!sdkp)
834 return -ENODEV;
835
39b7f1e2 836 if (sdkp->WCE)
e73aec82 837 ret = sd_sync_cache(sdkp);
39b7f1e2
AS
838 scsi_disk_put(sdkp);
839 return ret;
1da177e4
LT
840}
841
165125e1 842static void sd_prepare_flush(struct request_queue *q, struct request *rq)
1da177e4 843{
c0ed79a3 844 memset(rq->cmd, 0, sizeof(rq->cmd));
4aff5e23 845 rq->cmd_type = REQ_TYPE_BLOCK_PC;
c0ed79a3
JB
846 rq->timeout = SD_TIMEOUT;
847 rq->cmd[0] = SYNCHRONIZE_CACHE;
461d4e90 848 rq->cmd_len = 10;
1da177e4
LT
849}
850
851static void sd_rescan(struct device *dev)
852{
39b7f1e2
AS
853 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
854
855 if (sdkp) {
856 sd_revalidate_disk(sdkp->disk);
857 scsi_disk_put(sdkp);
858 }
1da177e4
LT
859}
860
861
862#ifdef CONFIG_COMPAT
863/*
864 * This gets directly called from VFS. When the ioctl
865 * is not recognized we go back to the other translation paths.
866 */
867static long sd_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
868{
7ac6207b 869 struct block_device *bdev = file->f_path.dentry->d_inode->i_bdev;
1da177e4
LT
870 struct gendisk *disk = bdev->bd_disk;
871 struct scsi_device *sdev = scsi_disk(disk)->device;
872
873 /*
874 * If we are in the middle of error recovery, don't let anyone
875 * else try and use this device. Also, if error recovery fails, it
876 * may try and take the device offline, in which case all further
877 * access to the device is prohibited.
878 */
879 if (!scsi_block_when_processing_errors(sdev))
880 return -ENODEV;
881
882 if (sdev->host->hostt->compat_ioctl) {
883 int ret;
884
885 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
886
887 return ret;
888 }
889
890 /*
891 * Let the static ioctl translation table take care of it.
892 */
893 return -ENOIOCTLCMD;
894}
895#endif
896
897static struct block_device_operations sd_fops = {
898 .owner = THIS_MODULE,
899 .open = sd_open,
900 .release = sd_release,
901 .ioctl = sd_ioctl,
a885c8c4 902 .getgeo = sd_getgeo,
1da177e4
LT
903#ifdef CONFIG_COMPAT
904 .compat_ioctl = sd_compat_ioctl,
905#endif
906 .media_changed = sd_media_changed,
907 .revalidate_disk = sd_revalidate_disk,
908};
909
910/**
911 * sd_rw_intr - bottom half handler: called when the lower level
912 * driver has completed (successfully or otherwise) a scsi command.
913 * @SCpnt: mid-level's per command structure.
914 *
915 * Note: potentially run from within an ISR. Must not block.
916 **/
917static void sd_rw_intr(struct scsi_cmnd * SCpnt)
918{
919 int result = SCpnt->result;
03aba2f7
LT
920 unsigned int xfer_size = SCpnt->request_bufflen;
921 unsigned int good_bytes = result ? 0 : xfer_size;
922 u64 start_lba = SCpnt->request->sector;
923 u64 bad_lba;
1da177e4
LT
924 struct scsi_sense_hdr sshdr;
925 int sense_valid = 0;
926 int sense_deferred = 0;
927 int info_valid;
928
929 if (result) {
930 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
931 if (sense_valid)
932 sense_deferred = scsi_sense_is_deferred(&sshdr);
933 }
1da177e4 934#ifdef CONFIG_SCSI_LOGGING
fa0d34be 935 SCSI_LOG_HLCOMPLETE(1, scsi_print_result(SCpnt));
1da177e4 936 if (sense_valid) {
fa0d34be
MP
937 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
938 "sd_rw_intr: sb[respc,sk,asc,"
939 "ascq]=%x,%x,%x,%x\n",
940 sshdr.response_code,
941 sshdr.sense_key, sshdr.asc,
942 sshdr.ascq));
1da177e4
LT
943 }
944#endif
03aba2f7
LT
945 if (driver_byte(result) != DRIVER_SENSE &&
946 (!sense_valid || sense_deferred))
947 goto out;
948
949 switch (sshdr.sense_key) {
950 case HARDWARE_ERROR:
951 case MEDIUM_ERROR:
952 if (!blk_fs_request(SCpnt->request))
953 goto out;
954 info_valid = scsi_get_sense_info_fld(SCpnt->sense_buffer,
955 SCSI_SENSE_BUFFERSIZE,
956 &bad_lba);
957 if (!info_valid)
958 goto out;
959 if (xfer_size <= SCpnt->device->sector_size)
960 goto out;
961 switch (SCpnt->device->sector_size) {
962 case 256:
963 start_lba <<= 1;
1da177e4 964 break;
03aba2f7 965 case 512:
1da177e4 966 break;
03aba2f7
LT
967 case 1024:
968 start_lba >>= 1;
969 break;
970 case 2048:
971 start_lba >>= 2;
972 break;
973 case 4096:
974 start_lba >>= 3;
1da177e4 975 break;
1da177e4 976 default:
03aba2f7
LT
977 /* Print something here with limiting frequency. */
978 goto out;
1da177e4
LT
979 break;
980 }
03aba2f7
LT
981 /* This computation should always be done in terms of
982 * the resolution of the device's medium.
983 */
984 good_bytes = (bad_lba - start_lba)*SCpnt->device->sector_size;
985 break;
986 case RECOVERED_ERROR:
987 case NO_SENSE:
988 /* Inform the user, but make sure that it's not treated
989 * as a hard error.
990 */
991 scsi_print_sense("sd", SCpnt);
992 SCpnt->result = 0;
993 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
994 good_bytes = xfer_size;
995 break;
996 case ILLEGAL_REQUEST:
997 if (SCpnt->device->use_10_for_rw &&
998 (SCpnt->cmnd[0] == READ_10 ||
999 SCpnt->cmnd[0] == WRITE_10))
1000 SCpnt->device->use_10_for_rw = 0;
1001 if (SCpnt->device->use_10_for_ms &&
1002 (SCpnt->cmnd[0] == MODE_SENSE_10 ||
1003 SCpnt->cmnd[0] == MODE_SELECT_10))
1004 SCpnt->device->use_10_for_ms = 0;
1005 break;
1006 default:
1007 break;
1da177e4 1008 }
03aba2f7
LT
1009 out:
1010 scsi_io_completion(SCpnt, good_bytes);
1da177e4
LT
1011}
1012
ea73a9f2
JB
1013static int media_not_present(struct scsi_disk *sdkp,
1014 struct scsi_sense_hdr *sshdr)
1da177e4 1015{
1da177e4 1016
ea73a9f2 1017 if (!scsi_sense_valid(sshdr))
1da177e4
LT
1018 return 0;
1019 /* not invoked for commands that could return deferred errors */
ea73a9f2
JB
1020 if (sshdr->sense_key != NOT_READY &&
1021 sshdr->sense_key != UNIT_ATTENTION)
1022 return 0;
1023 if (sshdr->asc != 0x3A) /* medium not present */
1024 return 0;
1025
1da177e4
LT
1026 set_media_not_present(sdkp);
1027 return 1;
1028}
1029
1030/*
1031 * spinup disk - called only in sd_revalidate_disk()
1032 */
1033static void
e73aec82 1034sd_spinup_disk(struct scsi_disk *sdkp)
ea73a9f2 1035{
1da177e4 1036 unsigned char cmd[10];
4451e472 1037 unsigned long spintime_expire = 0;
1da177e4
LT
1038 int retries, spintime;
1039 unsigned int the_result;
1040 struct scsi_sense_hdr sshdr;
1041 int sense_valid = 0;
1042
1043 spintime = 0;
1044
1045 /* Spin up drives, as required. Only do this at boot time */
1046 /* Spinup needs to be done for module loads too. */
1047 do {
1048 retries = 0;
1049
1050 do {
1051 cmd[0] = TEST_UNIT_READY;
1052 memset((void *) &cmd[1], 0, 9);
1053
ea73a9f2
JB
1054 the_result = scsi_execute_req(sdkp->device, cmd,
1055 DMA_NONE, NULL, 0,
1056 &sshdr, SD_TIMEOUT,
1057 SD_MAX_RETRIES);
1da177e4 1058
b4d38e38
AS
1059 /*
1060 * If the drive has indicated to us that it
1061 * doesn't have any media in it, don't bother
1062 * with any more polling.
1063 */
1064 if (media_not_present(sdkp, &sshdr))
1065 return;
1066
1da177e4 1067 if (the_result)
ea73a9f2 1068 sense_valid = scsi_sense_valid(&sshdr);
1da177e4
LT
1069 retries++;
1070 } while (retries < 3 &&
1071 (!scsi_status_is_good(the_result) ||
1072 ((driver_byte(the_result) & DRIVER_SENSE) &&
1073 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1074
1da177e4
LT
1075 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1076 /* no sense, TUR either succeeded or failed
1077 * with a status error */
e73aec82
MP
1078 if(!spintime && !scsi_status_is_good(the_result)) {
1079 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1080 sd_print_result(sdkp, the_result);
1081 }
1da177e4
LT
1082 break;
1083 }
1084
1085 /*
1086 * The device does not want the automatic start to be issued.
1087 */
1088 if (sdkp->device->no_start_on_add) {
1089 break;
1090 }
1091
1092 /*
1093 * If manual intervention is required, or this is an
1094 * absent USB storage device, a spinup is meaningless.
1095 */
1096 if (sense_valid &&
1097 sshdr.sense_key == NOT_READY &&
1098 sshdr.asc == 4 && sshdr.ascq == 3) {
1099 break; /* manual intervention required */
1100
1101 /*
1102 * Issue command to spin up drive when not ready
1103 */
1104 } else if (sense_valid && sshdr.sense_key == NOT_READY) {
1105 if (!spintime) {
e73aec82 1106 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1da177e4
LT
1107 cmd[0] = START_STOP;
1108 cmd[1] = 1; /* Return immediately */
1109 memset((void *) &cmd[2], 0, 8);
1110 cmd[4] = 1; /* Start spin cycle */
ea73a9f2
JB
1111 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1112 NULL, 0, &sshdr,
1113 SD_TIMEOUT, SD_MAX_RETRIES);
4451e472
AS
1114 spintime_expire = jiffies + 100 * HZ;
1115 spintime = 1;
1da177e4 1116 }
1da177e4
LT
1117 /* Wait 1 second for next try */
1118 msleep(1000);
1119 printk(".");
4451e472
AS
1120
1121 /*
1122 * Wait for USB flash devices with slow firmware.
1123 * Yes, this sense key/ASC combination shouldn't
1124 * occur here. It's characteristic of these devices.
1125 */
1126 } else if (sense_valid &&
1127 sshdr.sense_key == UNIT_ATTENTION &&
1128 sshdr.asc == 0x28) {
1129 if (!spintime) {
1130 spintime_expire = jiffies + 5 * HZ;
1131 spintime = 1;
1132 }
1133 /* Wait 1 second for next try */
1134 msleep(1000);
1da177e4
LT
1135 } else {
1136 /* we don't understand the sense code, so it's
1137 * probably pointless to loop */
1138 if(!spintime) {
e73aec82
MP
1139 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1140 sd_print_sense_hdr(sdkp, &sshdr);
1da177e4
LT
1141 }
1142 break;
1143 }
1144
4451e472 1145 } while (spintime && time_before_eq(jiffies, spintime_expire));
1da177e4
LT
1146
1147 if (spintime) {
1148 if (scsi_status_is_good(the_result))
1149 printk("ready\n");
1150 else
1151 printk("not responding...\n");
1152 }
1153}
1154
1155/*
1156 * read disk capacity
1157 */
1158static void
e73aec82 1159sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
ea73a9f2 1160{
1da177e4 1161 unsigned char cmd[16];
1da177e4
LT
1162 int the_result, retries;
1163 int sector_size = 0;
1164 int longrc = 0;
1165 struct scsi_sense_hdr sshdr;
1166 int sense_valid = 0;
ea73a9f2 1167 struct scsi_device *sdp = sdkp->device;
1da177e4
LT
1168
1169repeat:
1170 retries = 3;
1171 do {
1172 if (longrc) {
1173 memset((void *) cmd, 0, 16);
1174 cmd[0] = SERVICE_ACTION_IN;
1175 cmd[1] = SAI_READ_CAPACITY_16;
1176 cmd[13] = 12;
1177 memset((void *) buffer, 0, 12);
1178 } else {
1179 cmd[0] = READ_CAPACITY;
1180 memset((void *) &cmd[1], 0, 9);
1181 memset((void *) buffer, 0, 8);
1182 }
1183
ea73a9f2
JB
1184 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1185 buffer, longrc ? 12 : 8, &sshdr,
1186 SD_TIMEOUT, SD_MAX_RETRIES);
1da177e4 1187
ea73a9f2 1188 if (media_not_present(sdkp, &sshdr))
1da177e4
LT
1189 return;
1190
1da177e4 1191 if (the_result)
ea73a9f2 1192 sense_valid = scsi_sense_valid(&sshdr);
1da177e4
LT
1193 retries--;
1194
1195 } while (the_result && retries);
1196
1197 if (the_result && !longrc) {
e73aec82
MP
1198 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY failed\n");
1199 sd_print_result(sdkp, the_result);
1da177e4 1200 if (driver_byte(the_result) & DRIVER_SENSE)
e73aec82 1201 sd_print_sense_hdr(sdkp, &sshdr);
1da177e4 1202 else
e73aec82 1203 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
1da177e4
LT
1204
1205 /* Set dirty bit for removable devices if not ready -
1206 * sometimes drives will not report this properly. */
1207 if (sdp->removable &&
1208 sense_valid && sshdr.sense_key == NOT_READY)
1209 sdp->changed = 1;
1210
1211 /* Either no media are present but the drive didn't tell us,
1212 or they are present but the read capacity command fails */
1213 /* sdkp->media_present = 0; -- not always correct */
69bdd88c 1214 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
1da177e4
LT
1215
1216 return;
1217 } else if (the_result && longrc) {
1218 /* READ CAPACITY(16) has been failed */
e73aec82
MP
1219 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY(16) failed\n");
1220 sd_print_result(sdkp, the_result);
1221 sd_printk(KERN_NOTICE, sdkp, "Use 0xffffffff as device size\n");
1222
1da177e4
LT
1223 sdkp->capacity = 1 + (sector_t) 0xffffffff;
1224 goto got_data;
1225 }
1226
1227 if (!longrc) {
1228 sector_size = (buffer[4] << 24) |
1229 (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
1230 if (buffer[0] == 0xff && buffer[1] == 0xff &&
1231 buffer[2] == 0xff && buffer[3] == 0xff) {
1232 if(sizeof(sdkp->capacity) > 4) {
e73aec82
MP
1233 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
1234 "Trying to use READ CAPACITY(16).\n");
1da177e4
LT
1235 longrc = 1;
1236 goto repeat;
1237 }
e73aec82
MP
1238 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use "
1239 "a kernel compiled with support for large "
1240 "block devices.\n");
1da177e4
LT
1241 sdkp->capacity = 0;
1242 goto got_data;
1243 }
1244 sdkp->capacity = 1 + (((sector_t)buffer[0] << 24) |
1245 (buffer[1] << 16) |
1246 (buffer[2] << 8) |
1247 buffer[3]);
1248 } else {
1249 sdkp->capacity = 1 + (((u64)buffer[0] << 56) |
1250 ((u64)buffer[1] << 48) |
1251 ((u64)buffer[2] << 40) |
1252 ((u64)buffer[3] << 32) |
1253 ((sector_t)buffer[4] << 24) |
1254 ((sector_t)buffer[5] << 16) |
1255 ((sector_t)buffer[6] << 8) |
1256 (sector_t)buffer[7]);
1257
1258 sector_size = (buffer[8] << 24) |
1259 (buffer[9] << 16) | (buffer[10] << 8) | buffer[11];
1260 }
1261
1262 /* Some devices return the total number of sectors, not the
1263 * highest sector number. Make the necessary adjustment. */
61bf54b7 1264 if (sdp->fix_capacity) {
1da177e4
LT
1265 --sdkp->capacity;
1266
61bf54b7
ON
1267 /* Some devices have version which report the correct sizes
1268 * and others which do not. We guess size according to a heuristic
1269 * and err on the side of lowering the capacity. */
1270 } else {
1271 if (sdp->guess_capacity)
1272 if (sdkp->capacity & 0x01) /* odd sizes are odd */
1273 --sdkp->capacity;
1274 }
1275
1da177e4
LT
1276got_data:
1277 if (sector_size == 0) {
1278 sector_size = 512;
e73aec82
MP
1279 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
1280 "assuming 512.\n");
1da177e4
LT
1281 }
1282
1283 if (sector_size != 512 &&
1284 sector_size != 1024 &&
1285 sector_size != 2048 &&
1286 sector_size != 4096 &&
1287 sector_size != 256) {
e73aec82
MP
1288 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
1289 sector_size);
1da177e4
LT
1290 /*
1291 * The user might want to re-format the drive with
1292 * a supported sectorsize. Once this happens, it
1293 * would be relatively trivial to set the thing up.
1294 * For this reason, we leave the thing in the table.
1295 */
1296 sdkp->capacity = 0;
1297 /*
1298 * set a bogus sector size so the normal read/write
1299 * logic in the block layer will eventually refuse any
1300 * request on this device without tripping over power
1301 * of two sector size assumptions
1302 */
1303 sector_size = 512;
1304 }
1305 {
1306 /*
1307 * The msdos fs needs to know the hardware sector size
1308 * So I have created this table. See ll_rw_blk.c
1309 * Jacques Gelinas (Jacques@solucorp.qc.ca)
1310 */
1311 int hard_sector = sector_size;
7a691bd3 1312 sector_t sz = (sdkp->capacity/2) * (hard_sector/256);
165125e1 1313 struct request_queue *queue = sdp->request_queue;
7a691bd3 1314 sector_t mb = sz;
1da177e4
LT
1315
1316 blk_queue_hardsect_size(queue, hard_sector);
1317 /* avoid 64-bit division on 32-bit platforms */
7a691bd3 1318 sector_div(sz, 625);
1da177e4
LT
1319 mb -= sz - 974;
1320 sector_div(mb, 1950);
1321
e73aec82
MP
1322 sd_printk(KERN_NOTICE, sdkp,
1323 "%llu %d-byte hardware sectors (%llu MB)\n",
1324 (unsigned long long)sdkp->capacity,
1325 hard_sector, (unsigned long long)mb);
1da177e4
LT
1326 }
1327
1328 /* Rescale capacity to 512-byte units */
1329 if (sector_size == 4096)
1330 sdkp->capacity <<= 3;
1331 else if (sector_size == 2048)
1332 sdkp->capacity <<= 2;
1333 else if (sector_size == 1024)
1334 sdkp->capacity <<= 1;
1335 else if (sector_size == 256)
1336 sdkp->capacity >>= 1;
1337
1338 sdkp->device->sector_size = sector_size;
1339}
1340
1341/* called with buffer of length 512 */
1342static inline int
ea73a9f2
JB
1343sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
1344 unsigned char *buffer, int len, struct scsi_mode_data *data,
1345 struct scsi_sense_hdr *sshdr)
1da177e4 1346{
ea73a9f2 1347 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1cf72699 1348 SD_TIMEOUT, SD_MAX_RETRIES, data,
ea73a9f2 1349 sshdr);
1da177e4
LT
1350}
1351
1352/*
1353 * read write protect setting, if possible - called only in sd_revalidate_disk()
48970800 1354 * called with buffer of length SD_BUF_SIZE
1da177e4
LT
1355 */
1356static void
e73aec82 1357sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
ea73a9f2 1358{
1da177e4 1359 int res;
ea73a9f2 1360 struct scsi_device *sdp = sdkp->device;
1da177e4
LT
1361 struct scsi_mode_data data;
1362
1363 set_disk_ro(sdkp->disk, 0);
ea73a9f2 1364 if (sdp->skip_ms_page_3f) {
e73aec82 1365 sd_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1da177e4
LT
1366 return;
1367 }
1368
ea73a9f2
JB
1369 if (sdp->use_192_bytes_for_3f) {
1370 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1da177e4
LT
1371 } else {
1372 /*
1373 * First attempt: ask for all pages (0x3F), but only 4 bytes.
1374 * We have to start carefully: some devices hang if we ask
1375 * for more than is available.
1376 */
ea73a9f2 1377 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1da177e4
LT
1378
1379 /*
1380 * Second attempt: ask for page 0 When only page 0 is
1381 * implemented, a request for page 3F may return Sense Key
1382 * 5: Illegal Request, Sense Code 24: Invalid field in
1383 * CDB.
1384 */
1385 if (!scsi_status_is_good(res))
ea73a9f2 1386 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1da177e4
LT
1387
1388 /*
1389 * Third attempt: ask 255 bytes, as we did earlier.
1390 */
1391 if (!scsi_status_is_good(res))
ea73a9f2
JB
1392 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
1393 &data, NULL);
1da177e4
LT
1394 }
1395
1396 if (!scsi_status_is_good(res)) {
e73aec82
MP
1397 sd_printk(KERN_WARNING, sdkp,
1398 "Test WP failed, assume Write Enabled\n");
1da177e4
LT
1399 } else {
1400 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
1401 set_disk_ro(sdkp->disk, sdkp->write_prot);
e73aec82
MP
1402 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
1403 sdkp->write_prot ? "on" : "off");
1404 sd_printk(KERN_DEBUG, sdkp,
1405 "Mode Sense: %02x %02x %02x %02x\n",
1406 buffer[0], buffer[1], buffer[2], buffer[3]);
1da177e4
LT
1407 }
1408}
1409
1410/*
1411 * sd_read_cache_type - called only from sd_revalidate_disk()
48970800 1412 * called with buffer of length SD_BUF_SIZE
1da177e4
LT
1413 */
1414static void
e73aec82 1415sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
631e8a13 1416{
1da177e4 1417 int len = 0, res;
ea73a9f2 1418 struct scsi_device *sdp = sdkp->device;
1da177e4 1419
631e8a13
AV
1420 int dbd;
1421 int modepage;
1da177e4
LT
1422 struct scsi_mode_data data;
1423 struct scsi_sense_hdr sshdr;
1424
ea73a9f2 1425 if (sdp->skip_ms_page_8)
1da177e4
LT
1426 goto defaults;
1427
ea73a9f2 1428 if (sdp->type == TYPE_RBC) {
631e8a13
AV
1429 modepage = 6;
1430 dbd = 8;
1431 } else {
1432 modepage = 8;
1433 dbd = 0;
1434 }
1435
1da177e4 1436 /* cautiously ask */
ea73a9f2 1437 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, 4, &data, &sshdr);
1da177e4
LT
1438
1439 if (!scsi_status_is_good(res))
1440 goto bad_sense;
1441
6d73c851
AV
1442 if (!data.header_length) {
1443 modepage = 6;
e73aec82 1444 sd_printk(KERN_ERR, sdkp, "Missing header in MODE_SENSE response\n");
6d73c851
AV
1445 }
1446
1da177e4
LT
1447 /* that went OK, now ask for the proper length */
1448 len = data.length;
1449
1450 /*
1451 * We're only interested in the first three bytes, actually.
1452 * But the data cache page is defined for the first 20.
1453 */
1454 if (len < 3)
1455 goto bad_sense;
1456 if (len > 20)
1457 len = 20;
1458
1459 /* Take headers and block descriptors into account */
1460 len += data.header_length + data.block_descriptor_length;
48970800
AV
1461 if (len > SD_BUF_SIZE)
1462 goto bad_sense;
1da177e4
LT
1463
1464 /* Get the data */
ea73a9f2 1465 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len, &data, &sshdr);
1da177e4
LT
1466
1467 if (scsi_status_is_good(res)) {
631e8a13 1468 int offset = data.header_length + data.block_descriptor_length;
1da177e4 1469
48970800 1470 if (offset >= SD_BUF_SIZE - 2) {
e73aec82 1471 sd_printk(KERN_ERR, sdkp, "Malformed MODE SENSE response\n");
48970800
AV
1472 goto defaults;
1473 }
1474
631e8a13 1475 if ((buffer[offset] & 0x3f) != modepage) {
e73aec82 1476 sd_printk(KERN_ERR, sdkp, "Got wrong page\n");
631e8a13
AV
1477 goto defaults;
1478 }
1479
1480 if (modepage == 8) {
1481 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
1482 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
1483 } else {
1484 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
1485 sdkp->RCD = 0;
1486 }
1da177e4 1487
007365ad
TH
1488 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
1489 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
e73aec82
MP
1490 sd_printk(KERN_NOTICE, sdkp,
1491 "Uses READ/WRITE(6), disabling FUA\n");
007365ad
TH
1492 sdkp->DPOFUA = 0;
1493 }
1494
e73aec82
MP
1495 sd_printk(KERN_NOTICE, sdkp,
1496 "Write cache: %s, read cache: %s, %s\n",
fd44bab5
LT
1497 sdkp->WCE ? "enabled" : "disabled",
1498 sdkp->RCD ? "disabled" : "enabled",
1499 sdkp->DPOFUA ? "supports DPO and FUA"
1500 : "doesn't support DPO or FUA");
1da177e4
LT
1501
1502 return;
1503 }
1504
1505bad_sense:
ea73a9f2 1506 if (scsi_sense_valid(&sshdr) &&
1da177e4
LT
1507 sshdr.sense_key == ILLEGAL_REQUEST &&
1508 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
e73aec82
MP
1509 /* Invalid field in CDB */
1510 sd_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
1da177e4 1511 else
e73aec82 1512 sd_printk(KERN_ERR, sdkp, "Asking for cache data failed\n");
1da177e4
LT
1513
1514defaults:
e73aec82 1515 sd_printk(KERN_ERR, sdkp, "Assuming drive cache: write through\n");
1da177e4
LT
1516 sdkp->WCE = 0;
1517 sdkp->RCD = 0;
48970800 1518 sdkp->DPOFUA = 0;
1da177e4
LT
1519}
1520
1521/**
1522 * sd_revalidate_disk - called the first time a new disk is seen,
1523 * performs disk spin up, read_capacity, etc.
1524 * @disk: struct gendisk we care about
1525 **/
1526static int sd_revalidate_disk(struct gendisk *disk)
1527{
1528 struct scsi_disk *sdkp = scsi_disk(disk);
1529 struct scsi_device *sdp = sdkp->device;
1da177e4 1530 unsigned char *buffer;
461d4e90 1531 unsigned ordered;
1da177e4 1532
fa0d34be
MP
1533 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
1534 "sd_revalidate_disk\n"));
1da177e4
LT
1535
1536 /*
1537 * If the device is offline, don't try and read capacity or any
1538 * of the other niceties.
1539 */
1540 if (!scsi_device_online(sdp))
1541 goto out;
1542
a6123f14 1543 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
1da177e4 1544 if (!buffer) {
e73aec82
MP
1545 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
1546 "allocation failure.\n");
ea73a9f2 1547 goto out;
1da177e4
LT
1548 }
1549
1550 /* defaults, until the device tells us otherwise */
1551 sdp->sector_size = 512;
1552 sdkp->capacity = 0;
1553 sdkp->media_present = 1;
1554 sdkp->write_prot = 0;
1555 sdkp->WCE = 0;
1556 sdkp->RCD = 0;
1557
e73aec82 1558 sd_spinup_disk(sdkp);
1da177e4
LT
1559
1560 /*
1561 * Without media there is no reason to ask; moreover, some devices
1562 * react badly if we do.
1563 */
1564 if (sdkp->media_present) {
e73aec82
MP
1565 sd_read_capacity(sdkp, buffer);
1566 sd_read_write_protect_flag(sdkp, buffer);
1567 sd_read_cache_type(sdkp, buffer);
1da177e4 1568 }
461d4e90
TH
1569
1570 /*
1571 * We now have all cache related info, determine how we deal
1572 * with ordered requests. Note that as the current SCSI
1573 * dispatch function can alter request order, we cannot use
1574 * QUEUE_ORDERED_TAG_* even when ordered tag is supported.
1575 */
1576 if (sdkp->WCE)
007365ad
TH
1577 ordered = sdkp->DPOFUA
1578 ? QUEUE_ORDERED_DRAIN_FUA : QUEUE_ORDERED_DRAIN_FLUSH;
461d4e90
TH
1579 else
1580 ordered = QUEUE_ORDERED_DRAIN;
1581
1582 blk_queue_ordered(sdkp->disk->queue, ordered, sd_prepare_flush);
1583
1da177e4
LT
1584 set_capacity(disk, sdkp->capacity);
1585 kfree(buffer);
1586
1da177e4
LT
1587 out:
1588 return 0;
1589}
1590
1591/**
1592 * sd_probe - called during driver initialization and whenever a
1593 * new scsi device is attached to the system. It is called once
1594 * for each scsi device (not just disks) present.
1595 * @dev: pointer to device object
1596 *
1597 * Returns 0 if successful (or not interested in this scsi device
1598 * (e.g. scanner)); 1 when there is an error.
1599 *
1600 * Note: this function is invoked from the scsi mid-level.
1601 * This function sets up the mapping between a given
1602 * <host,channel,id,lun> (found in sdp) and new device name
1603 * (e.g. /dev/sda). More precisely it is the block device major
1604 * and minor number that is chosen here.
1605 *
1606 * Assume sd_attach is not re-entrant (for time being)
1607 * Also think about sd_attach() and sd_remove() running coincidentally.
1608 **/
1609static int sd_probe(struct device *dev)
1610{
1611 struct scsi_device *sdp = to_scsi_device(dev);
1612 struct scsi_disk *sdkp;
1613 struct gendisk *gd;
1614 u32 index;
1615 int error;
1616
1617 error = -ENODEV;
631e8a13 1618 if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
1da177e4
LT
1619 goto out;
1620
9ccfc756
JB
1621 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
1622 "sd_attach\n"));
1da177e4
LT
1623
1624 error = -ENOMEM;
24669f75 1625 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
1da177e4
LT
1626 if (!sdkp)
1627 goto out;
1628
1da177e4
LT
1629 gd = alloc_disk(16);
1630 if (!gd)
1631 goto out_free;
1632
1633 if (!idr_pre_get(&sd_index_idr, GFP_KERNEL))
1634 goto out_put;
1635
1636 spin_lock(&sd_index_lock);
1637 error = idr_get_new(&sd_index_idr, NULL, &index);
1638 spin_unlock(&sd_index_lock);
1639
1640 if (index >= SD_MAX_DISKS)
1641 error = -EBUSY;
1642 if (error)
1643 goto out_put;
1644
1645 sdkp->device = sdp;
1646 sdkp->driver = &sd_template;
1647 sdkp->disk = gd;
1648 sdkp->index = index;
1649 sdkp->openers = 0;
1650
1651 if (!sdp->timeout) {
631e8a13 1652 if (sdp->type != TYPE_MOD)
1da177e4
LT
1653 sdp->timeout = SD_TIMEOUT;
1654 else
1655 sdp->timeout = SD_MOD_TIMEOUT;
1656 }
1657
017f2e37
NST
1658 class_device_initialize(&sdkp->cdev);
1659 sdkp->cdev.dev = &sdp->sdev_gendev;
1660 sdkp->cdev.class = &sd_disk_class;
1661 strncpy(sdkp->cdev.class_id, sdp->sdev_gendev.bus_id, BUS_ID_SIZE);
1662
1663 if (class_device_add(&sdkp->cdev))
1664 goto out_put;
1665
1666 get_device(&sdp->sdev_gendev);
1667
1da177e4
LT
1668 gd->major = sd_major((index & 0xf0) >> 4);
1669 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
1670 gd->minors = 16;
1671 gd->fops = &sd_fops;
1672
1673 if (index < 26) {
1674 sprintf(gd->disk_name, "sd%c", 'a' + index % 26);
1675 } else if (index < (26 + 1) * 26) {
1676 sprintf(gd->disk_name, "sd%c%c",
1677 'a' + index / 26 - 1,'a' + index % 26);
1678 } else {
1679 const unsigned int m1 = (index / 26 - 1) / 26 - 1;
1680 const unsigned int m2 = (index / 26 - 1) % 26;
1681 const unsigned int m3 = index % 26;
1682 sprintf(gd->disk_name, "sd%c%c%c",
1683 'a' + m1, 'a' + m2, 'a' + m3);
1684 }
1685
1da177e4 1686 gd->private_data = &sdkp->driver;
461d4e90 1687 gd->queue = sdkp->device->request_queue;
1da177e4
LT
1688
1689 sd_revalidate_disk(gd);
1690
7f9a6bc4 1691 blk_queue_prep_rq(sdp->request_queue, sd_prep_fn);
03a5743a
JB
1692 blk_queue_issue_flush_fn(sdp->request_queue, sd_issue_flush);
1693
1da177e4
LT
1694 gd->driverfs_dev = &sdp->sdev_gendev;
1695 gd->flags = GENHD_FL_DRIVERFS;
1696 if (sdp->removable)
1697 gd->flags |= GENHD_FL_REMOVABLE;
1da177e4
LT
1698
1699 dev_set_drvdata(dev, sdkp);
1700 add_disk(gd);
1701
e73aec82
MP
1702 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
1703 sdp->removable ? "removable " : "");
1da177e4
LT
1704
1705 return 0;
1706
6bdaa1f1 1707 out_put:
1da177e4 1708 put_disk(gd);
6bdaa1f1 1709 out_free:
1da177e4 1710 kfree(sdkp);
6bdaa1f1 1711 out:
1da177e4
LT
1712 return error;
1713}
1714
1715/**
1716 * sd_remove - called whenever a scsi disk (previously recognized by
1717 * sd_probe) is detached from the system. It is called (potentially
1718 * multiple times) during sd module unload.
1719 * @sdp: pointer to mid level scsi device object
1720 *
1721 * Note: this function is invoked from the scsi mid-level.
1722 * This function potentially frees up a device name (e.g. /dev/sdc)
1723 * that could be re-used by a subsequent sd_probe().
1724 * This function is not called when the built-in sd driver is "exit-ed".
1725 **/
1726static int sd_remove(struct device *dev)
1727{
1728 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1729
6bdaa1f1 1730 class_device_del(&sdkp->cdev);
1da177e4
LT
1731 del_gendisk(sdkp->disk);
1732 sd_shutdown(dev);
39b7f1e2 1733
0b950672 1734 mutex_lock(&sd_ref_mutex);
39b7f1e2 1735 dev_set_drvdata(dev, NULL);
6bdaa1f1 1736 class_device_put(&sdkp->cdev);
0b950672 1737 mutex_unlock(&sd_ref_mutex);
1da177e4
LT
1738
1739 return 0;
1740}
1741
1742/**
1743 * scsi_disk_release - Called to free the scsi_disk structure
6bdaa1f1 1744 * @cdev: pointer to embedded class device
1da177e4 1745 *
0b950672 1746 * sd_ref_mutex must be held entering this routine. Because it is
1da177e4
LT
1747 * called on last put, you should always use the scsi_disk_get()
1748 * scsi_disk_put() helpers which manipulate the semaphore directly
6bdaa1f1 1749 * and never do a direct class_device_put().
1da177e4 1750 **/
6bdaa1f1 1751static void scsi_disk_release(struct class_device *cdev)
1da177e4 1752{
6bdaa1f1 1753 struct scsi_disk *sdkp = to_scsi_disk(cdev);
1da177e4
LT
1754 struct gendisk *disk = sdkp->disk;
1755
1756 spin_lock(&sd_index_lock);
1757 idr_remove(&sd_index_idr, sdkp->index);
1758 spin_unlock(&sd_index_lock);
1759
1760 disk->private_data = NULL;
1da177e4 1761 put_disk(disk);
39b7f1e2 1762 put_device(&sdkp->device->sdev_gendev);
1da177e4
LT
1763
1764 kfree(sdkp);
1765}
1766
cc5d2c8c 1767static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
c3c94c5a
TH
1768{
1769 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
1770 struct scsi_sense_hdr sshdr;
cc5d2c8c 1771 struct scsi_device *sdp = sdkp->device;
c3c94c5a
TH
1772 int res;
1773
1774 if (start)
1775 cmd[4] |= 1; /* START */
1776
1777 if (!scsi_device_online(sdp))
1778 return -ENODEV;
1779
1780 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
1781 SD_TIMEOUT, SD_MAX_RETRIES);
1782 if (res) {
cc5d2c8c
JB
1783 sd_printk(KERN_WARNING, sdkp, "START_STOP FAILED\n");
1784 sd_print_result(sdkp, res);
c3c94c5a 1785 if (driver_byte(res) & DRIVER_SENSE)
cc5d2c8c 1786 sd_print_sense_hdr(sdkp, &sshdr);
c3c94c5a
TH
1787 }
1788
1789 return res;
1790}
1791
1da177e4
LT
1792/*
1793 * Send a SYNCHRONIZE CACHE instruction down to the device through
1794 * the normal SCSI command structure. Wait for the command to
1795 * complete.
1796 */
1797static void sd_shutdown(struct device *dev)
1798{
39b7f1e2 1799 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
1da177e4
LT
1800
1801 if (!sdkp)
1802 return; /* this can happen */
1803
39b7f1e2 1804 if (sdkp->WCE) {
e73aec82
MP
1805 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
1806 sd_sync_cache(sdkp);
39b7f1e2 1807 }
c3c94c5a 1808
cc5d2c8c
JB
1809 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
1810 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
1811 sd_start_stop_device(sdkp, 0);
c3c94c5a
TH
1812 }
1813
39b7f1e2
AS
1814 scsi_disk_put(sdkp);
1815}
1da177e4 1816
c3c94c5a
TH
1817static int sd_suspend(struct device *dev, pm_message_t mesg)
1818{
c3c94c5a 1819 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
09ff92fe 1820 int ret = 0;
c3c94c5a
TH
1821
1822 if (!sdkp)
1823 return 0; /* this can happen */
1824
1825 if (sdkp->WCE) {
cc5d2c8c 1826 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
c3c94c5a
TH
1827 ret = sd_sync_cache(sdkp);
1828 if (ret)
09ff92fe 1829 goto done;
c3c94c5a
TH
1830 }
1831
cc5d2c8c
JB
1832 if (mesg.event == PM_EVENT_SUSPEND &&
1833 sdkp->device->manage_start_stop) {
1834 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
1835 ret = sd_start_stop_device(sdkp, 0);
c3c94c5a
TH
1836 }
1837
09ff92fe
AS
1838done:
1839 scsi_disk_put(sdkp);
1840 return ret;
c3c94c5a
TH
1841}
1842
1843static int sd_resume(struct device *dev)
1844{
c3c94c5a 1845 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
09ff92fe 1846 int ret = 0;
c3c94c5a 1847
cc5d2c8c 1848 if (!sdkp->device->manage_start_stop)
09ff92fe 1849 goto done;
c3c94c5a 1850
cc5d2c8c 1851 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
09ff92fe 1852 ret = sd_start_stop_device(sdkp, 1);
c3c94c5a 1853
09ff92fe
AS
1854done:
1855 scsi_disk_put(sdkp);
1856 return ret;
c3c94c5a
TH
1857}
1858
1da177e4
LT
1859/**
1860 * init_sd - entry point for this driver (both when built in or when
1861 * a module).
1862 *
1863 * Note: this function registers this driver with the scsi mid-level.
1864 **/
1865static int __init init_sd(void)
1866{
5e4009ba 1867 int majors = 0, i, err;
1da177e4
LT
1868
1869 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
1870
1871 for (i = 0; i < SD_MAJORS; i++)
1872 if (register_blkdev(sd_major(i), "sd") == 0)
1873 majors++;
1874
1875 if (!majors)
1876 return -ENODEV;
1877
5e4009ba
JG
1878 err = class_register(&sd_disk_class);
1879 if (err)
1880 goto err_out;
6bdaa1f1 1881
5e4009ba
JG
1882 err = scsi_register_driver(&sd_template.gendrv);
1883 if (err)
1884 goto err_out_class;
1885
1886 return 0;
1887
1888err_out_class:
1889 class_unregister(&sd_disk_class);
1890err_out:
1891 for (i = 0; i < SD_MAJORS; i++)
1892 unregister_blkdev(sd_major(i), "sd");
1893 return err;
1da177e4
LT
1894}
1895
1896/**
1897 * exit_sd - exit point for this driver (when it is a module).
1898 *
1899 * Note: this function unregisters this driver from the scsi mid-level.
1900 **/
1901static void __exit exit_sd(void)
1902{
1903 int i;
1904
1905 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
1906
1907 scsi_unregister_driver(&sd_template.gendrv);
5e4009ba
JG
1908 class_unregister(&sd_disk_class);
1909
1da177e4
LT
1910 for (i = 0; i < SD_MAJORS; i++)
1911 unregister_blkdev(sd_major(i), "sd");
1912}
1913
1da177e4
LT
1914module_init(init_sd);
1915module_exit(exit_sd);
e73aec82
MP
1916
1917static void sd_print_sense_hdr(struct scsi_disk *sdkp,
1918 struct scsi_sense_hdr *sshdr)
1919{
1920 sd_printk(KERN_INFO, sdkp, "");
1921 scsi_show_sense_hdr(sshdr);
1922 sd_printk(KERN_INFO, sdkp, "");
1923 scsi_show_extd_sense(sshdr->asc, sshdr->ascq);
1924}
1925
1926static void sd_print_result(struct scsi_disk *sdkp, int result)
1927{
1928 sd_printk(KERN_INFO, sdkp, "");
1929 scsi_show_result(result);
1930}
1931