Loading...
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
35#include <linux/module.h>
36#include <linux/fs.h>
37#include <linux/kernel.h>
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>
48#include <linux/delay.h>
49#include <linux/mutex.h>
50#include <linux/string_helpers.h>
51#include <linux/async.h>
52#include <linux/slab.h>
53#include <asm/uaccess.h>
54#include <asm/unaligned.h>
55
56#include <scsi/scsi.h>
57#include <scsi/scsi_cmnd.h>
58#include <scsi/scsi_dbg.h>
59#include <scsi/scsi_device.h>
60#include <scsi/scsi_driver.h>
61#include <scsi/scsi_eh.h>
62#include <scsi/scsi_host.h>
63#include <scsi/scsi_ioctl.h>
64#include <scsi/scsicam.h>
65
66#include "sd.h"
67#include "scsi_logging.h"
68
69MODULE_AUTHOR("Eric Youngdale");
70MODULE_DESCRIPTION("SCSI disk (sd) driver");
71MODULE_LICENSE("GPL");
72
73MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
74MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
75MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
76MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
77MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
78MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
79MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
80MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
81MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
82MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
83MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
84MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
85MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
86MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
87MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
88MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
89MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
90MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
91MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
92
93#if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
94#define SD_MINORS 16
95#else
96#define SD_MINORS 0
97#endif
98
99static void sd_config_discard(struct scsi_disk *, unsigned int);
100static int sd_revalidate_disk(struct gendisk *);
101static void sd_unlock_native_capacity(struct gendisk *disk);
102static int sd_probe(struct device *);
103static int sd_remove(struct device *);
104static void sd_shutdown(struct device *);
105static int sd_suspend(struct device *, pm_message_t state);
106static int sd_resume(struct device *);
107static void sd_rescan(struct device *);
108static int sd_done(struct scsi_cmnd *);
109static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
110static void scsi_disk_release(struct device *cdev);
111static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
112static void sd_print_result(struct scsi_disk *, int);
113
114static DEFINE_SPINLOCK(sd_index_lock);
115static DEFINE_IDA(sd_index_ida);
116
117/* This semaphore is used to mediate the 0->1 reference get in the
118 * face of object destruction (i.e. we can't allow a get on an
119 * object after last put) */
120static DEFINE_MUTEX(sd_ref_mutex);
121
122static struct kmem_cache *sd_cdb_cache;
123static mempool_t *sd_cdb_pool;
124
125static const char *sd_cache_types[] = {
126 "write through", "none", "write back",
127 "write back, no read (daft)"
128};
129
130static ssize_t
131sd_store_cache_type(struct device *dev, struct device_attribute *attr,
132 const char *buf, size_t count)
133{
134 int i, ct = -1, rcd, wce, sp;
135 struct scsi_disk *sdkp = to_scsi_disk(dev);
136 struct scsi_device *sdp = sdkp->device;
137 char buffer[64];
138 char *buffer_data;
139 struct scsi_mode_data data;
140 struct scsi_sense_hdr sshdr;
141 int len;
142
143 if (sdp->type != TYPE_DISK)
144 /* no cache control on RBC devices; theoretically they
145 * can do it, but there's probably so many exceptions
146 * it's not worth the risk */
147 return -EINVAL;
148
149 for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
150 len = strlen(sd_cache_types[i]);
151 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
152 buf[len] == '\n') {
153 ct = i;
154 break;
155 }
156 }
157 if (ct < 0)
158 return -EINVAL;
159 rcd = ct & 0x01 ? 1 : 0;
160 wce = ct & 0x02 ? 1 : 0;
161 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
162 SD_MAX_RETRIES, &data, NULL))
163 return -EINVAL;
164 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
165 data.block_descriptor_length);
166 buffer_data = buffer + data.header_length +
167 data.block_descriptor_length;
168 buffer_data[2] &= ~0x05;
169 buffer_data[2] |= wce << 2 | rcd;
170 sp = buffer_data[0] & 0x80 ? 1 : 0;
171
172 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
173 SD_MAX_RETRIES, &data, &sshdr)) {
174 if (scsi_sense_valid(&sshdr))
175 sd_print_sense_hdr(sdkp, &sshdr);
176 return -EINVAL;
177 }
178 revalidate_disk(sdkp->disk);
179 return count;
180}
181
182static ssize_t
183sd_store_manage_start_stop(struct device *dev, struct device_attribute *attr,
184 const char *buf, size_t count)
185{
186 struct scsi_disk *sdkp = to_scsi_disk(dev);
187 struct scsi_device *sdp = sdkp->device;
188
189 if (!capable(CAP_SYS_ADMIN))
190 return -EACCES;
191
192 sdp->manage_start_stop = simple_strtoul(buf, NULL, 10);
193
194 return count;
195}
196
197static ssize_t
198sd_store_allow_restart(struct device *dev, struct device_attribute *attr,
199 const char *buf, size_t count)
200{
201 struct scsi_disk *sdkp = to_scsi_disk(dev);
202 struct scsi_device *sdp = sdkp->device;
203
204 if (!capable(CAP_SYS_ADMIN))
205 return -EACCES;
206
207 if (sdp->type != TYPE_DISK)
208 return -EINVAL;
209
210 sdp->allow_restart = simple_strtoul(buf, NULL, 10);
211
212 return count;
213}
214
215static ssize_t
216sd_show_cache_type(struct device *dev, struct device_attribute *attr,
217 char *buf)
218{
219 struct scsi_disk *sdkp = to_scsi_disk(dev);
220 int ct = sdkp->RCD + 2*sdkp->WCE;
221
222 return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
223}
224
225static ssize_t
226sd_show_fua(struct device *dev, struct device_attribute *attr, char *buf)
227{
228 struct scsi_disk *sdkp = to_scsi_disk(dev);
229
230 return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
231}
232
233static ssize_t
234sd_show_manage_start_stop(struct device *dev, struct device_attribute *attr,
235 char *buf)
236{
237 struct scsi_disk *sdkp = to_scsi_disk(dev);
238 struct scsi_device *sdp = sdkp->device;
239
240 return snprintf(buf, 20, "%u\n", sdp->manage_start_stop);
241}
242
243static ssize_t
244sd_show_allow_restart(struct device *dev, struct device_attribute *attr,
245 char *buf)
246{
247 struct scsi_disk *sdkp = to_scsi_disk(dev);
248
249 return snprintf(buf, 40, "%d\n", sdkp->device->allow_restart);
250}
251
252static ssize_t
253sd_show_protection_type(struct device *dev, struct device_attribute *attr,
254 char *buf)
255{
256 struct scsi_disk *sdkp = to_scsi_disk(dev);
257
258 return snprintf(buf, 20, "%u\n", sdkp->protection_type);
259}
260
261static ssize_t
262sd_show_protection_mode(struct device *dev, struct device_attribute *attr,
263 char *buf)
264{
265 struct scsi_disk *sdkp = to_scsi_disk(dev);
266 struct scsi_device *sdp = sdkp->device;
267 unsigned int dif, dix;
268
269 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
270 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
271
272 if (!dix && scsi_host_dix_capable(sdp->host, SD_DIF_TYPE0_PROTECTION)) {
273 dif = 0;
274 dix = 1;
275 }
276
277 if (!dif && !dix)
278 return snprintf(buf, 20, "none\n");
279
280 return snprintf(buf, 20, "%s%u\n", dix ? "dix" : "dif", dif);
281}
282
283static ssize_t
284sd_show_app_tag_own(struct device *dev, struct device_attribute *attr,
285 char *buf)
286{
287 struct scsi_disk *sdkp = to_scsi_disk(dev);
288
289 return snprintf(buf, 20, "%u\n", sdkp->ATO);
290}
291
292static ssize_t
293sd_show_thin_provisioning(struct device *dev, struct device_attribute *attr,
294 char *buf)
295{
296 struct scsi_disk *sdkp = to_scsi_disk(dev);
297
298 return snprintf(buf, 20, "%u\n", sdkp->lbpme);
299}
300
301static const char *lbp_mode[] = {
302 [SD_LBP_FULL] = "full",
303 [SD_LBP_UNMAP] = "unmap",
304 [SD_LBP_WS16] = "writesame_16",
305 [SD_LBP_WS10] = "writesame_10",
306 [SD_LBP_ZERO] = "writesame_zero",
307 [SD_LBP_DISABLE] = "disabled",
308};
309
310static ssize_t
311sd_show_provisioning_mode(struct device *dev, struct device_attribute *attr,
312 char *buf)
313{
314 struct scsi_disk *sdkp = to_scsi_disk(dev);
315
316 return snprintf(buf, 20, "%s\n", lbp_mode[sdkp->provisioning_mode]);
317}
318
319static ssize_t
320sd_store_provisioning_mode(struct device *dev, struct device_attribute *attr,
321 const char *buf, size_t count)
322{
323 struct scsi_disk *sdkp = to_scsi_disk(dev);
324 struct scsi_device *sdp = sdkp->device;
325
326 if (!capable(CAP_SYS_ADMIN))
327 return -EACCES;
328
329 if (sdp->type != TYPE_DISK)
330 return -EINVAL;
331
332 if (!strncmp(buf, lbp_mode[SD_LBP_UNMAP], 20))
333 sd_config_discard(sdkp, SD_LBP_UNMAP);
334 else if (!strncmp(buf, lbp_mode[SD_LBP_WS16], 20))
335 sd_config_discard(sdkp, SD_LBP_WS16);
336 else if (!strncmp(buf, lbp_mode[SD_LBP_WS10], 20))
337 sd_config_discard(sdkp, SD_LBP_WS10);
338 else if (!strncmp(buf, lbp_mode[SD_LBP_ZERO], 20))
339 sd_config_discard(sdkp, SD_LBP_ZERO);
340 else if (!strncmp(buf, lbp_mode[SD_LBP_DISABLE], 20))
341 sd_config_discard(sdkp, SD_LBP_DISABLE);
342 else
343 return -EINVAL;
344
345 return count;
346}
347
348static struct device_attribute sd_disk_attrs[] = {
349 __ATTR(cache_type, S_IRUGO|S_IWUSR, sd_show_cache_type,
350 sd_store_cache_type),
351 __ATTR(FUA, S_IRUGO, sd_show_fua, NULL),
352 __ATTR(allow_restart, S_IRUGO|S_IWUSR, sd_show_allow_restart,
353 sd_store_allow_restart),
354 __ATTR(manage_start_stop, S_IRUGO|S_IWUSR, sd_show_manage_start_stop,
355 sd_store_manage_start_stop),
356 __ATTR(protection_type, S_IRUGO, sd_show_protection_type, NULL),
357 __ATTR(protection_mode, S_IRUGO, sd_show_protection_mode, NULL),
358 __ATTR(app_tag_own, S_IRUGO, sd_show_app_tag_own, NULL),
359 __ATTR(thin_provisioning, S_IRUGO, sd_show_thin_provisioning, NULL),
360 __ATTR(provisioning_mode, S_IRUGO|S_IWUSR, sd_show_provisioning_mode,
361 sd_store_provisioning_mode),
362 __ATTR_NULL,
363};
364
365static struct class sd_disk_class = {
366 .name = "scsi_disk",
367 .owner = THIS_MODULE,
368 .dev_release = scsi_disk_release,
369 .dev_attrs = sd_disk_attrs,
370};
371
372static struct scsi_driver sd_template = {
373 .owner = THIS_MODULE,
374 .gendrv = {
375 .name = "sd",
376 .probe = sd_probe,
377 .remove = sd_remove,
378 .suspend = sd_suspend,
379 .resume = sd_resume,
380 .shutdown = sd_shutdown,
381 },
382 .rescan = sd_rescan,
383 .done = sd_done,
384};
385
386/*
387 * Device no to disk mapping:
388 *
389 * major disc2 disc p1
390 * |............|.............|....|....| <- dev_t
391 * 31 20 19 8 7 4 3 0
392 *
393 * Inside a major, we have 16k disks, however mapped non-
394 * contiguously. The first 16 disks are for major0, the next
395 * ones with major1, ... Disk 256 is for major0 again, disk 272
396 * for major1, ...
397 * As we stay compatible with our numbering scheme, we can reuse
398 * the well-know SCSI majors 8, 65--71, 136--143.
399 */
400static int sd_major(int major_idx)
401{
402 switch (major_idx) {
403 case 0:
404 return SCSI_DISK0_MAJOR;
405 case 1 ... 7:
406 return SCSI_DISK1_MAJOR + major_idx - 1;
407 case 8 ... 15:
408 return SCSI_DISK8_MAJOR + major_idx - 8;
409 default:
410 BUG();
411 return 0; /* shut up gcc */
412 }
413}
414
415static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
416{
417 struct scsi_disk *sdkp = NULL;
418
419 if (disk->private_data) {
420 sdkp = scsi_disk(disk);
421 if (scsi_device_get(sdkp->device) == 0)
422 get_device(&sdkp->dev);
423 else
424 sdkp = NULL;
425 }
426 return sdkp;
427}
428
429static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
430{
431 struct scsi_disk *sdkp;
432
433 mutex_lock(&sd_ref_mutex);
434 sdkp = __scsi_disk_get(disk);
435 mutex_unlock(&sd_ref_mutex);
436 return sdkp;
437}
438
439static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
440{
441 struct scsi_disk *sdkp;
442
443 mutex_lock(&sd_ref_mutex);
444 sdkp = dev_get_drvdata(dev);
445 if (sdkp)
446 sdkp = __scsi_disk_get(sdkp->disk);
447 mutex_unlock(&sd_ref_mutex);
448 return sdkp;
449}
450
451static void scsi_disk_put(struct scsi_disk *sdkp)
452{
453 struct scsi_device *sdev = sdkp->device;
454
455 mutex_lock(&sd_ref_mutex);
456 put_device(&sdkp->dev);
457 scsi_device_put(sdev);
458 mutex_unlock(&sd_ref_mutex);
459}
460
461static void sd_prot_op(struct scsi_cmnd *scmd, unsigned int dif)
462{
463 unsigned int prot_op = SCSI_PROT_NORMAL;
464 unsigned int dix = scsi_prot_sg_count(scmd);
465
466 if (scmd->sc_data_direction == DMA_FROM_DEVICE) {
467 if (dif && dix)
468 prot_op = SCSI_PROT_READ_PASS;
469 else if (dif && !dix)
470 prot_op = SCSI_PROT_READ_STRIP;
471 else if (!dif && dix)
472 prot_op = SCSI_PROT_READ_INSERT;
473 } else {
474 if (dif && dix)
475 prot_op = SCSI_PROT_WRITE_PASS;
476 else if (dif && !dix)
477 prot_op = SCSI_PROT_WRITE_INSERT;
478 else if (!dif && dix)
479 prot_op = SCSI_PROT_WRITE_STRIP;
480 }
481
482 scsi_set_prot_op(scmd, prot_op);
483 scsi_set_prot_type(scmd, dif);
484}
485
486static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
487{
488 struct request_queue *q = sdkp->disk->queue;
489 unsigned int logical_block_size = sdkp->device->sector_size;
490 unsigned int max_blocks = 0;
491
492 q->limits.discard_zeroes_data = sdkp->lbprz;
493 q->limits.discard_alignment = sdkp->unmap_alignment *
494 logical_block_size;
495 q->limits.discard_granularity =
496 max(sdkp->physical_block_size,
497 sdkp->unmap_granularity * logical_block_size);
498
499 switch (mode) {
500
501 case SD_LBP_DISABLE:
502 q->limits.max_discard_sectors = 0;
503 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, q);
504 return;
505
506 case SD_LBP_UNMAP:
507 max_blocks = min_not_zero(sdkp->max_unmap_blocks, 0xffffffff);
508 break;
509
510 case SD_LBP_WS16:
511 max_blocks = min_not_zero(sdkp->max_ws_blocks, 0xffffffff);
512 break;
513
514 case SD_LBP_WS10:
515 max_blocks = min_not_zero(sdkp->max_ws_blocks, (u32)0xffff);
516 break;
517
518 case SD_LBP_ZERO:
519 max_blocks = min_not_zero(sdkp->max_ws_blocks, (u32)0xffff);
520 q->limits.discard_zeroes_data = 1;
521 break;
522 }
523
524 q->limits.max_discard_sectors = max_blocks * (logical_block_size >> 9);
525 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, q);
526
527 sdkp->provisioning_mode = mode;
528}
529
530/**
531 * scsi_setup_discard_cmnd - unmap blocks on thinly provisioned device
532 * @sdp: scsi device to operate one
533 * @rq: Request to prepare
534 *
535 * Will issue either UNMAP or WRITE SAME(16) depending on preference
536 * indicated by target device.
537 **/
538static int scsi_setup_discard_cmnd(struct scsi_device *sdp, struct request *rq)
539{
540 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
541 struct bio *bio = rq->bio;
542 sector_t sector = bio->bi_sector;
543 unsigned int nr_sectors = bio_sectors(bio);
544 unsigned int len;
545 int ret;
546 char *buf;
547 struct page *page;
548
549 if (sdkp->device->sector_size == 4096) {
550 sector >>= 3;
551 nr_sectors >>= 3;
552 }
553
554 rq->timeout = SD_TIMEOUT;
555
556 memset(rq->cmd, 0, rq->cmd_len);
557
558 page = alloc_page(GFP_ATOMIC | __GFP_ZERO);
559 if (!page)
560 return BLKPREP_DEFER;
561
562 switch (sdkp->provisioning_mode) {
563 case SD_LBP_UNMAP:
564 buf = page_address(page);
565
566 rq->cmd_len = 10;
567 rq->cmd[0] = UNMAP;
568 rq->cmd[8] = 24;
569
570 put_unaligned_be16(6 + 16, &buf[0]);
571 put_unaligned_be16(16, &buf[2]);
572 put_unaligned_be64(sector, &buf[8]);
573 put_unaligned_be32(nr_sectors, &buf[16]);
574
575 len = 24;
576 break;
577
578 case SD_LBP_WS16:
579 rq->cmd_len = 16;
580 rq->cmd[0] = WRITE_SAME_16;
581 rq->cmd[1] = 0x8; /* UNMAP */
582 put_unaligned_be64(sector, &rq->cmd[2]);
583 put_unaligned_be32(nr_sectors, &rq->cmd[10]);
584
585 len = sdkp->device->sector_size;
586 break;
587
588 case SD_LBP_WS10:
589 case SD_LBP_ZERO:
590 rq->cmd_len = 10;
591 rq->cmd[0] = WRITE_SAME;
592 if (sdkp->provisioning_mode == SD_LBP_WS10)
593 rq->cmd[1] = 0x8; /* UNMAP */
594 put_unaligned_be32(sector, &rq->cmd[2]);
595 put_unaligned_be16(nr_sectors, &rq->cmd[7]);
596
597 len = sdkp->device->sector_size;
598 break;
599
600 default:
601 ret = BLKPREP_KILL;
602 goto out;
603 }
604
605 blk_add_request_payload(rq, page, len);
606 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
607 rq->buffer = page_address(page);
608
609out:
610 if (ret != BLKPREP_OK) {
611 __free_page(page);
612 rq->buffer = NULL;
613 }
614 return ret;
615}
616
617static int scsi_setup_flush_cmnd(struct scsi_device *sdp, struct request *rq)
618{
619 rq->timeout = SD_FLUSH_TIMEOUT;
620 rq->retries = SD_MAX_RETRIES;
621 rq->cmd[0] = SYNCHRONIZE_CACHE;
622 rq->cmd_len = 10;
623
624 return scsi_setup_blk_pc_cmnd(sdp, rq);
625}
626
627static void sd_unprep_fn(struct request_queue *q, struct request *rq)
628{
629 if (rq->cmd_flags & REQ_DISCARD) {
630 free_page((unsigned long)rq->buffer);
631 rq->buffer = NULL;
632 }
633}
634
635/**
636 * sd_init_command - build a scsi (read or write) command from
637 * information in the request structure.
638 * @SCpnt: pointer to mid-level's per scsi command structure that
639 * contains request and into which the scsi command is written
640 *
641 * Returns 1 if successful and 0 if error (or cannot be done now).
642 **/
643static int sd_prep_fn(struct request_queue *q, struct request *rq)
644{
645 struct scsi_cmnd *SCpnt;
646 struct scsi_device *sdp = q->queuedata;
647 struct gendisk *disk = rq->rq_disk;
648 struct scsi_disk *sdkp;
649 sector_t block = blk_rq_pos(rq);
650 sector_t threshold;
651 unsigned int this_count = blk_rq_sectors(rq);
652 int ret, host_dif;
653 unsigned char protect;
654
655 /*
656 * Discard request come in as REQ_TYPE_FS but we turn them into
657 * block PC requests to make life easier.
658 */
659 if (rq->cmd_flags & REQ_DISCARD) {
660 ret = scsi_setup_discard_cmnd(sdp, rq);
661 goto out;
662 } else if (rq->cmd_flags & REQ_FLUSH) {
663 ret = scsi_setup_flush_cmnd(sdp, rq);
664 goto out;
665 } else if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
666 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
667 goto out;
668 } else if (rq->cmd_type != REQ_TYPE_FS) {
669 ret = BLKPREP_KILL;
670 goto out;
671 }
672 ret = scsi_setup_fs_cmnd(sdp, rq);
673 if (ret != BLKPREP_OK)
674 goto out;
675 SCpnt = rq->special;
676 sdkp = scsi_disk(disk);
677
678 /* from here on until we're complete, any goto out
679 * is used for a killable error condition */
680 ret = BLKPREP_KILL;
681
682 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
683 "sd_init_command: block=%llu, "
684 "count=%d\n",
685 (unsigned long long)block,
686 this_count));
687
688 if (!sdp || !scsi_device_online(sdp) ||
689 block + blk_rq_sectors(rq) > get_capacity(disk)) {
690 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
691 "Finishing %u sectors\n",
692 blk_rq_sectors(rq)));
693 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
694 "Retry with 0x%p\n", SCpnt));
695 goto out;
696 }
697
698 if (sdp->changed) {
699 /*
700 * quietly refuse to do anything to a changed disc until
701 * the changed bit has been reset
702 */
703 /* printk("SCSI disk has been changed or is not present. Prohibiting further I/O.\n"); */
704 goto out;
705 }
706
707 /*
708 * Some SD card readers can't handle multi-sector accesses which touch
709 * the last one or two hardware sectors. Split accesses as needed.
710 */
711 threshold = get_capacity(disk) - SD_LAST_BUGGY_SECTORS *
712 (sdp->sector_size / 512);
713
714 if (unlikely(sdp->last_sector_bug && block + this_count > threshold)) {
715 if (block < threshold) {
716 /* Access up to the threshold but not beyond */
717 this_count = threshold - block;
718 } else {
719 /* Access only a single hardware sector */
720 this_count = sdp->sector_size / 512;
721 }
722 }
723
724 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
725 (unsigned long long)block));
726
727 /*
728 * If we have a 1K hardware sectorsize, prevent access to single
729 * 512 byte sectors. In theory we could handle this - in fact
730 * the scsi cdrom driver must be able to handle this because
731 * we typically use 1K blocksizes, and cdroms typically have
732 * 2K hardware sectorsizes. Of course, things are simpler
733 * with the cdrom, since it is read-only. For performance
734 * reasons, the filesystems should be able to handle this
735 * and not force the scsi disk driver to use bounce buffers
736 * for this.
737 */
738 if (sdp->sector_size == 1024) {
739 if ((block & 1) || (blk_rq_sectors(rq) & 1)) {
740 scmd_printk(KERN_ERR, SCpnt,
741 "Bad block number requested\n");
742 goto out;
743 } else {
744 block = block >> 1;
745 this_count = this_count >> 1;
746 }
747 }
748 if (sdp->sector_size == 2048) {
749 if ((block & 3) || (blk_rq_sectors(rq) & 3)) {
750 scmd_printk(KERN_ERR, SCpnt,
751 "Bad block number requested\n");
752 goto out;
753 } else {
754 block = block >> 2;
755 this_count = this_count >> 2;
756 }
757 }
758 if (sdp->sector_size == 4096) {
759 if ((block & 7) || (blk_rq_sectors(rq) & 7)) {
760 scmd_printk(KERN_ERR, SCpnt,
761 "Bad block number requested\n");
762 goto out;
763 } else {
764 block = block >> 3;
765 this_count = this_count >> 3;
766 }
767 }
768 if (rq_data_dir(rq) == WRITE) {
769 if (!sdp->writeable) {
770 goto out;
771 }
772 SCpnt->cmnd[0] = WRITE_6;
773 SCpnt->sc_data_direction = DMA_TO_DEVICE;
774
775 if (blk_integrity_rq(rq) &&
776 sd_dif_prepare(rq, block, sdp->sector_size) == -EIO)
777 goto out;
778
779 } else if (rq_data_dir(rq) == READ) {
780 SCpnt->cmnd[0] = READ_6;
781 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
782 } else {
783 scmd_printk(KERN_ERR, SCpnt, "Unknown command %x\n", rq->cmd_flags);
784 goto out;
785 }
786
787 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
788 "%s %d/%u 512 byte blocks.\n",
789 (rq_data_dir(rq) == WRITE) ?
790 "writing" : "reading", this_count,
791 blk_rq_sectors(rq)));
792
793 /* Set RDPROTECT/WRPROTECT if disk is formatted with DIF */
794 host_dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
795 if (host_dif)
796 protect = 1 << 5;
797 else
798 protect = 0;
799
800 if (host_dif == SD_DIF_TYPE2_PROTECTION) {
801 SCpnt->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
802
803 if (unlikely(SCpnt->cmnd == NULL)) {
804 ret = BLKPREP_DEFER;
805 goto out;
806 }
807
808 SCpnt->cmd_len = SD_EXT_CDB_SIZE;
809 memset(SCpnt->cmnd, 0, SCpnt->cmd_len);
810 SCpnt->cmnd[0] = VARIABLE_LENGTH_CMD;
811 SCpnt->cmnd[7] = 0x18;
812 SCpnt->cmnd[9] = (rq_data_dir(rq) == READ) ? READ_32 : WRITE_32;
813 SCpnt->cmnd[10] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
814
815 /* LBA */
816 SCpnt->cmnd[12] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
817 SCpnt->cmnd[13] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
818 SCpnt->cmnd[14] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
819 SCpnt->cmnd[15] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
820 SCpnt->cmnd[16] = (unsigned char) (block >> 24) & 0xff;
821 SCpnt->cmnd[17] = (unsigned char) (block >> 16) & 0xff;
822 SCpnt->cmnd[18] = (unsigned char) (block >> 8) & 0xff;
823 SCpnt->cmnd[19] = (unsigned char) block & 0xff;
824
825 /* Expected Indirect LBA */
826 SCpnt->cmnd[20] = (unsigned char) (block >> 24) & 0xff;
827 SCpnt->cmnd[21] = (unsigned char) (block >> 16) & 0xff;
828 SCpnt->cmnd[22] = (unsigned char) (block >> 8) & 0xff;
829 SCpnt->cmnd[23] = (unsigned char) block & 0xff;
830
831 /* Transfer length */
832 SCpnt->cmnd[28] = (unsigned char) (this_count >> 24) & 0xff;
833 SCpnt->cmnd[29] = (unsigned char) (this_count >> 16) & 0xff;
834 SCpnt->cmnd[30] = (unsigned char) (this_count >> 8) & 0xff;
835 SCpnt->cmnd[31] = (unsigned char) this_count & 0xff;
836 } else if (block > 0xffffffff) {
837 SCpnt->cmnd[0] += READ_16 - READ_6;
838 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
839 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
840 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
841 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
842 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
843 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
844 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
845 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
846 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
847 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
848 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
849 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
850 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
851 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
852 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
853 scsi_device_protection(SCpnt->device) ||
854 SCpnt->device->use_10_for_rw) {
855 if (this_count > 0xffff)
856 this_count = 0xffff;
857
858 SCpnt->cmnd[0] += READ_10 - READ_6;
859 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
860 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
861 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
862 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
863 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
864 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
865 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
866 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
867 } else {
868 if (unlikely(rq->cmd_flags & REQ_FUA)) {
869 /*
870 * This happens only if this drive failed
871 * 10byte rw command with ILLEGAL_REQUEST
872 * during operation and thus turned off
873 * use_10_for_rw.
874 */
875 scmd_printk(KERN_ERR, SCpnt,
876 "FUA write on READ/WRITE(6) drive\n");
877 goto out;
878 }
879
880 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
881 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
882 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
883 SCpnt->cmnd[4] = (unsigned char) this_count;
884 SCpnt->cmnd[5] = 0;
885 }
886 SCpnt->sdb.length = this_count * sdp->sector_size;
887
888 /* If DIF or DIX is enabled, tell HBA how to handle request */
889 if (host_dif || scsi_prot_sg_count(SCpnt))
890 sd_prot_op(SCpnt, host_dif);
891
892 /*
893 * We shouldn't disconnect in the middle of a sector, so with a dumb
894 * host adapter, it's safe to assume that we can at least transfer
895 * this many bytes between each connect / disconnect.
896 */
897 SCpnt->transfersize = sdp->sector_size;
898 SCpnt->underflow = this_count << 9;
899 SCpnt->allowed = SD_MAX_RETRIES;
900
901 /*
902 * This indicates that the command is ready from our end to be
903 * queued.
904 */
905 ret = BLKPREP_OK;
906 out:
907 return scsi_prep_return(q, rq, ret);
908}
909
910/**
911 * sd_open - open a scsi disk device
912 * @inode: only i_rdev member may be used
913 * @filp: only f_mode and f_flags may be used
914 *
915 * Returns 0 if successful. Returns a negated errno value in case
916 * of error.
917 *
918 * Note: This can be called from a user context (e.g. fsck(1) )
919 * or from within the kernel (e.g. as a result of a mount(1) ).
920 * In the latter case @inode and @filp carry an abridged amount
921 * of information as noted above.
922 *
923 * Locking: called with bdev->bd_mutex held.
924 **/
925static int sd_open(struct block_device *bdev, fmode_t mode)
926{
927 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
928 struct scsi_device *sdev;
929 int retval;
930
931 if (!sdkp)
932 return -ENXIO;
933
934 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
935
936 sdev = sdkp->device;
937
938 retval = scsi_autopm_get_device(sdev);
939 if (retval)
940 goto error_autopm;
941
942 /*
943 * If the device is in error recovery, wait until it is done.
944 * If the device is offline, then disallow any access to it.
945 */
946 retval = -ENXIO;
947 if (!scsi_block_when_processing_errors(sdev))
948 goto error_out;
949
950 if (sdev->removable || sdkp->write_prot)
951 check_disk_change(bdev);
952
953 /*
954 * If the drive is empty, just let the open fail.
955 */
956 retval = -ENOMEDIUM;
957 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
958 goto error_out;
959
960 /*
961 * If the device has the write protect tab set, have the open fail
962 * if the user expects to be able to write to the thing.
963 */
964 retval = -EROFS;
965 if (sdkp->write_prot && (mode & FMODE_WRITE))
966 goto error_out;
967
968 /*
969 * It is possible that the disk changing stuff resulted in
970 * the device being taken offline. If this is the case,
971 * report this to the user, and don't pretend that the
972 * open actually succeeded.
973 */
974 retval = -ENXIO;
975 if (!scsi_device_online(sdev))
976 goto error_out;
977
978 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
979 if (scsi_block_when_processing_errors(sdev))
980 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
981 }
982
983 return 0;
984
985error_out:
986 scsi_autopm_put_device(sdev);
987error_autopm:
988 scsi_disk_put(sdkp);
989 return retval;
990}
991
992/**
993 * sd_release - invoked when the (last) close(2) is called on this
994 * scsi disk.
995 * @inode: only i_rdev member may be used
996 * @filp: only f_mode and f_flags may be used
997 *
998 * Returns 0.
999 *
1000 * Note: may block (uninterruptible) if error recovery is underway
1001 * on this disk.
1002 *
1003 * Locking: called with bdev->bd_mutex held.
1004 **/
1005static int sd_release(struct gendisk *disk, fmode_t mode)
1006{
1007 struct scsi_disk *sdkp = scsi_disk(disk);
1008 struct scsi_device *sdev = sdkp->device;
1009
1010 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1011
1012 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1013 if (scsi_block_when_processing_errors(sdev))
1014 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1015 }
1016
1017 /*
1018 * XXX and what if there are packets in flight and this close()
1019 * XXX is followed by a "rmmod sd_mod"?
1020 */
1021
1022 scsi_autopm_put_device(sdev);
1023 scsi_disk_put(sdkp);
1024 return 0;
1025}
1026
1027static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1028{
1029 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1030 struct scsi_device *sdp = sdkp->device;
1031 struct Scsi_Host *host = sdp->host;
1032 int diskinfo[4];
1033
1034 /* default to most commonly used values */
1035 diskinfo[0] = 0x40; /* 1 << 6 */
1036 diskinfo[1] = 0x20; /* 1 << 5 */
1037 diskinfo[2] = sdkp->capacity >> 11;
1038
1039 /* override with calculated, extended default, or driver values */
1040 if (host->hostt->bios_param)
1041 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
1042 else
1043 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
1044
1045 geo->heads = diskinfo[0];
1046 geo->sectors = diskinfo[1];
1047 geo->cylinders = diskinfo[2];
1048 return 0;
1049}
1050
1051/**
1052 * sd_ioctl - process an ioctl
1053 * @inode: only i_rdev/i_bdev members may be used
1054 * @filp: only f_mode and f_flags may be used
1055 * @cmd: ioctl command number
1056 * @arg: this is third argument given to ioctl(2) system call.
1057 * Often contains a pointer.
1058 *
1059 * Returns 0 if successful (some ioctls return positive numbers on
1060 * success as well). Returns a negated errno value in case of error.
1061 *
1062 * Note: most ioctls are forward onto the block subsystem or further
1063 * down in the scsi subsystem.
1064 **/
1065static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1066 unsigned int cmd, unsigned long arg)
1067{
1068 struct gendisk *disk = bdev->bd_disk;
1069 struct scsi_device *sdp = scsi_disk(disk)->device;
1070 void __user *p = (void __user *)arg;
1071 int error;
1072
1073 SCSI_LOG_IOCTL(1, printk("sd_ioctl: disk=%s, cmd=0x%x\n",
1074 disk->disk_name, cmd));
1075
1076 /*
1077 * If we are in the middle of error recovery, don't let anyone
1078 * else try and use this device. Also, if error recovery fails, it
1079 * may try and take the device offline, in which case all further
1080 * access to the device is prohibited.
1081 */
1082 error = scsi_nonblockable_ioctl(sdp, cmd, p,
1083 (mode & FMODE_NDELAY) != 0);
1084 if (!scsi_block_when_processing_errors(sdp) || !error)
1085 goto out;
1086
1087 /*
1088 * Send SCSI addressing ioctls directly to mid level, send other
1089 * ioctls to block level and then onto mid level if they can't be
1090 * resolved.
1091 */
1092 switch (cmd) {
1093 case SCSI_IOCTL_GET_IDLUN:
1094 case SCSI_IOCTL_GET_BUS_NUMBER:
1095 error = scsi_ioctl(sdp, cmd, p);
1096 break;
1097 default:
1098 error = scsi_cmd_ioctl(disk->queue, disk, mode, cmd, p);
1099 if (error != -ENOTTY)
1100 break;
1101 error = scsi_ioctl(sdp, cmd, p);
1102 break;
1103 }
1104out:
1105 return error;
1106}
1107
1108static void set_media_not_present(struct scsi_disk *sdkp)
1109{
1110 if (sdkp->media_present)
1111 sdkp->device->changed = 1;
1112
1113 if (sdkp->device->removable) {
1114 sdkp->media_present = 0;
1115 sdkp->capacity = 0;
1116 }
1117}
1118
1119static int media_not_present(struct scsi_disk *sdkp,
1120 struct scsi_sense_hdr *sshdr)
1121{
1122 if (!scsi_sense_valid(sshdr))
1123 return 0;
1124
1125 /* not invoked for commands that could return deferred errors */
1126 switch (sshdr->sense_key) {
1127 case UNIT_ATTENTION:
1128 case NOT_READY:
1129 /* medium not present */
1130 if (sshdr->asc == 0x3A) {
1131 set_media_not_present(sdkp);
1132 return 1;
1133 }
1134 }
1135 return 0;
1136}
1137
1138/**
1139 * sd_check_events - check media events
1140 * @disk: kernel device descriptor
1141 * @clearing: disk events currently being cleared
1142 *
1143 * Returns mask of DISK_EVENT_*.
1144 *
1145 * Note: this function is invoked from the block subsystem.
1146 **/
1147static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1148{
1149 struct scsi_disk *sdkp = scsi_disk(disk);
1150 struct scsi_device *sdp = sdkp->device;
1151 struct scsi_sense_hdr *sshdr = NULL;
1152 int retval;
1153
1154 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1155
1156 /*
1157 * If the device is offline, don't send any commands - just pretend as
1158 * if the command failed. If the device ever comes back online, we
1159 * can deal with it then. It is only because of unrecoverable errors
1160 * that we would ever take a device offline in the first place.
1161 */
1162 if (!scsi_device_online(sdp)) {
1163 set_media_not_present(sdkp);
1164 goto out;
1165 }
1166
1167 /*
1168 * Using TEST_UNIT_READY enables differentiation between drive with
1169 * no cartridge loaded - NOT READY, drive with changed cartridge -
1170 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1171 *
1172 * Drives that auto spin down. eg iomega jaz 1G, will be started
1173 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1174 * sd_revalidate() is called.
1175 */
1176 retval = -ENODEV;
1177
1178 if (scsi_block_when_processing_errors(sdp)) {
1179 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
1180 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
1181 sshdr);
1182 }
1183
1184 /* failed to execute TUR, assume media not present */
1185 if (host_byte(retval)) {
1186 set_media_not_present(sdkp);
1187 goto out;
1188 }
1189
1190 if (media_not_present(sdkp, sshdr))
1191 goto out;
1192
1193 /*
1194 * For removable scsi disk we have to recognise the presence
1195 * of a disk in the drive.
1196 */
1197 if (!sdkp->media_present)
1198 sdp->changed = 1;
1199 sdkp->media_present = 1;
1200out:
1201 /*
1202 * sdp->changed is set under the following conditions:
1203 *
1204 * Medium present state has changed in either direction.
1205 * Device has indicated UNIT_ATTENTION.
1206 */
1207 kfree(sshdr);
1208 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1209 sdp->changed = 0;
1210 return retval;
1211}
1212
1213static int sd_sync_cache(struct scsi_disk *sdkp)
1214{
1215 int retries, res;
1216 struct scsi_device *sdp = sdkp->device;
1217 struct scsi_sense_hdr sshdr;
1218
1219 if (!scsi_device_online(sdp))
1220 return -ENODEV;
1221
1222
1223 for (retries = 3; retries > 0; --retries) {
1224 unsigned char cmd[10] = { 0 };
1225
1226 cmd[0] = SYNCHRONIZE_CACHE;
1227 /*
1228 * Leave the rest of the command zero to indicate
1229 * flush everything.
1230 */
1231 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
1232 SD_FLUSH_TIMEOUT, SD_MAX_RETRIES, NULL);
1233 if (res == 0)
1234 break;
1235 }
1236
1237 if (res) {
1238 sd_print_result(sdkp, res);
1239 if (driver_byte(res) & DRIVER_SENSE)
1240 sd_print_sense_hdr(sdkp, &sshdr);
1241 }
1242
1243 if (res)
1244 return -EIO;
1245 return 0;
1246}
1247
1248static void sd_rescan(struct device *dev)
1249{
1250 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
1251
1252 if (sdkp) {
1253 revalidate_disk(sdkp->disk);
1254 scsi_disk_put(sdkp);
1255 }
1256}
1257
1258
1259#ifdef CONFIG_COMPAT
1260/*
1261 * This gets directly called from VFS. When the ioctl
1262 * is not recognized we go back to the other translation paths.
1263 */
1264static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1265 unsigned int cmd, unsigned long arg)
1266{
1267 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1268
1269 /*
1270 * If we are in the middle of error recovery, don't let anyone
1271 * else try and use this device. Also, if error recovery fails, it
1272 * may try and take the device offline, in which case all further
1273 * access to the device is prohibited.
1274 */
1275 if (!scsi_block_when_processing_errors(sdev))
1276 return -ENODEV;
1277
1278 if (sdev->host->hostt->compat_ioctl) {
1279 int ret;
1280
1281 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
1282
1283 return ret;
1284 }
1285
1286 /*
1287 * Let the static ioctl translation table take care of it.
1288 */
1289 return -ENOIOCTLCMD;
1290}
1291#endif
1292
1293static const struct block_device_operations sd_fops = {
1294 .owner = THIS_MODULE,
1295 .open = sd_open,
1296 .release = sd_release,
1297 .ioctl = sd_ioctl,
1298 .getgeo = sd_getgeo,
1299#ifdef CONFIG_COMPAT
1300 .compat_ioctl = sd_compat_ioctl,
1301#endif
1302 .check_events = sd_check_events,
1303 .revalidate_disk = sd_revalidate_disk,
1304 .unlock_native_capacity = sd_unlock_native_capacity,
1305};
1306
1307static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1308{
1309 u64 start_lba = blk_rq_pos(scmd->request);
1310 u64 end_lba = blk_rq_pos(scmd->request) + (scsi_bufflen(scmd) / 512);
1311 u64 bad_lba;
1312 int info_valid;
1313 /*
1314 * resid is optional but mostly filled in. When it's unused,
1315 * its value is zero, so we assume the whole buffer transferred
1316 */
1317 unsigned int transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1318 unsigned int good_bytes;
1319
1320 if (scmd->request->cmd_type != REQ_TYPE_FS)
1321 return 0;
1322
1323 info_valid = scsi_get_sense_info_fld(scmd->sense_buffer,
1324 SCSI_SENSE_BUFFERSIZE,
1325 &bad_lba);
1326 if (!info_valid)
1327 return 0;
1328
1329 if (scsi_bufflen(scmd) <= scmd->device->sector_size)
1330 return 0;
1331
1332 if (scmd->device->sector_size < 512) {
1333 /* only legitimate sector_size here is 256 */
1334 start_lba <<= 1;
1335 end_lba <<= 1;
1336 } else {
1337 /* be careful ... don't want any overflows */
1338 u64 factor = scmd->device->sector_size / 512;
1339 do_div(start_lba, factor);
1340 do_div(end_lba, factor);
1341 }
1342
1343 /* The bad lba was reported incorrectly, we have no idea where
1344 * the error is.
1345 */
1346 if (bad_lba < start_lba || bad_lba >= end_lba)
1347 return 0;
1348
1349 /* This computation should always be done in terms of
1350 * the resolution of the device's medium.
1351 */
1352 good_bytes = (bad_lba - start_lba) * scmd->device->sector_size;
1353 return min(good_bytes, transferred);
1354}
1355
1356/**
1357 * sd_done - bottom half handler: called when the lower level
1358 * driver has completed (successfully or otherwise) a scsi command.
1359 * @SCpnt: mid-level's per command structure.
1360 *
1361 * Note: potentially run from within an ISR. Must not block.
1362 **/
1363static int sd_done(struct scsi_cmnd *SCpnt)
1364{
1365 int result = SCpnt->result;
1366 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1367 struct scsi_sense_hdr sshdr;
1368 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
1369 int sense_valid = 0;
1370 int sense_deferred = 0;
1371 unsigned char op = SCpnt->cmnd[0];
1372
1373 if ((SCpnt->request->cmd_flags & REQ_DISCARD) && !result)
1374 scsi_set_resid(SCpnt, 0);
1375
1376 if (result) {
1377 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1378 if (sense_valid)
1379 sense_deferred = scsi_sense_is_deferred(&sshdr);
1380 }
1381#ifdef CONFIG_SCSI_LOGGING
1382 SCSI_LOG_HLCOMPLETE(1, scsi_print_result(SCpnt));
1383 if (sense_valid) {
1384 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
1385 "sd_done: sb[respc,sk,asc,"
1386 "ascq]=%x,%x,%x,%x\n",
1387 sshdr.response_code,
1388 sshdr.sense_key, sshdr.asc,
1389 sshdr.ascq));
1390 }
1391#endif
1392 if (driver_byte(result) != DRIVER_SENSE &&
1393 (!sense_valid || sense_deferred))
1394 goto out;
1395
1396 switch (sshdr.sense_key) {
1397 case HARDWARE_ERROR:
1398 case MEDIUM_ERROR:
1399 good_bytes = sd_completed_bytes(SCpnt);
1400 break;
1401 case RECOVERED_ERROR:
1402 good_bytes = scsi_bufflen(SCpnt);
1403 break;
1404 case NO_SENSE:
1405 /* This indicates a false check condition, so ignore it. An
1406 * unknown amount of data was transferred so treat it as an
1407 * error.
1408 */
1409 scsi_print_sense("sd", SCpnt);
1410 SCpnt->result = 0;
1411 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1412 break;
1413 case ABORTED_COMMAND:
1414 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
1415 good_bytes = sd_completed_bytes(SCpnt);
1416 break;
1417 case ILLEGAL_REQUEST:
1418 if (sshdr.asc == 0x10) /* DIX: Host detected corruption */
1419 good_bytes = sd_completed_bytes(SCpnt);
1420 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
1421 if ((sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
1422 (op == UNMAP || op == WRITE_SAME_16 || op == WRITE_SAME))
1423 sd_config_discard(sdkp, SD_LBP_DISABLE);
1424 break;
1425 default:
1426 break;
1427 }
1428 out:
1429 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt))
1430 sd_dif_complete(SCpnt, good_bytes);
1431
1432 if (scsi_host_dif_capable(sdkp->device->host, sdkp->protection_type)
1433 == SD_DIF_TYPE2_PROTECTION && SCpnt->cmnd != SCpnt->request->cmd) {
1434
1435 /* We have to print a failed command here as the
1436 * extended CDB gets freed before scsi_io_completion()
1437 * is called.
1438 */
1439 if (result)
1440 scsi_print_command(SCpnt);
1441
1442 mempool_free(SCpnt->cmnd, sd_cdb_pool);
1443 SCpnt->cmnd = NULL;
1444 SCpnt->cmd_len = 0;
1445 }
1446
1447 return good_bytes;
1448}
1449
1450/*
1451 * spinup disk - called only in sd_revalidate_disk()
1452 */
1453static void
1454sd_spinup_disk(struct scsi_disk *sdkp)
1455{
1456 unsigned char cmd[10];
1457 unsigned long spintime_expire = 0;
1458 int retries, spintime;
1459 unsigned int the_result;
1460 struct scsi_sense_hdr sshdr;
1461 int sense_valid = 0;
1462
1463 spintime = 0;
1464
1465 /* Spin up drives, as required. Only do this at boot time */
1466 /* Spinup needs to be done for module loads too. */
1467 do {
1468 retries = 0;
1469
1470 do {
1471 cmd[0] = TEST_UNIT_READY;
1472 memset((void *) &cmd[1], 0, 9);
1473
1474 the_result = scsi_execute_req(sdkp->device, cmd,
1475 DMA_NONE, NULL, 0,
1476 &sshdr, SD_TIMEOUT,
1477 SD_MAX_RETRIES, NULL);
1478
1479 /*
1480 * If the drive has indicated to us that it
1481 * doesn't have any media in it, don't bother
1482 * with any more polling.
1483 */
1484 if (media_not_present(sdkp, &sshdr))
1485 return;
1486
1487 if (the_result)
1488 sense_valid = scsi_sense_valid(&sshdr);
1489 retries++;
1490 } while (retries < 3 &&
1491 (!scsi_status_is_good(the_result) ||
1492 ((driver_byte(the_result) & DRIVER_SENSE) &&
1493 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1494
1495 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1496 /* no sense, TUR either succeeded or failed
1497 * with a status error */
1498 if(!spintime && !scsi_status_is_good(the_result)) {
1499 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1500 sd_print_result(sdkp, the_result);
1501 }
1502 break;
1503 }
1504
1505 /*
1506 * The device does not want the automatic start to be issued.
1507 */
1508 if (sdkp->device->no_start_on_add)
1509 break;
1510
1511 if (sense_valid && sshdr.sense_key == NOT_READY) {
1512 if (sshdr.asc == 4 && sshdr.ascq == 3)
1513 break; /* manual intervention required */
1514 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
1515 break; /* standby */
1516 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
1517 break; /* unavailable */
1518 /*
1519 * Issue command to spin up drive when not ready
1520 */
1521 if (!spintime) {
1522 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1523 cmd[0] = START_STOP;
1524 cmd[1] = 1; /* Return immediately */
1525 memset((void *) &cmd[2], 0, 8);
1526 cmd[4] = 1; /* Start spin cycle */
1527 if (sdkp->device->start_stop_pwr_cond)
1528 cmd[4] |= 1 << 4;
1529 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1530 NULL, 0, &sshdr,
1531 SD_TIMEOUT, SD_MAX_RETRIES,
1532 NULL);
1533 spintime_expire = jiffies + 100 * HZ;
1534 spintime = 1;
1535 }
1536 /* Wait 1 second for next try */
1537 msleep(1000);
1538 printk(".");
1539
1540 /*
1541 * Wait for USB flash devices with slow firmware.
1542 * Yes, this sense key/ASC combination shouldn't
1543 * occur here. It's characteristic of these devices.
1544 */
1545 } else if (sense_valid &&
1546 sshdr.sense_key == UNIT_ATTENTION &&
1547 sshdr.asc == 0x28) {
1548 if (!spintime) {
1549 spintime_expire = jiffies + 5 * HZ;
1550 spintime = 1;
1551 }
1552 /* Wait 1 second for next try */
1553 msleep(1000);
1554 } else {
1555 /* we don't understand the sense code, so it's
1556 * probably pointless to loop */
1557 if(!spintime) {
1558 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1559 sd_print_sense_hdr(sdkp, &sshdr);
1560 }
1561 break;
1562 }
1563
1564 } while (spintime && time_before_eq(jiffies, spintime_expire));
1565
1566 if (spintime) {
1567 if (scsi_status_is_good(the_result))
1568 printk("ready\n");
1569 else
1570 printk("not responding...\n");
1571 }
1572}
1573
1574
1575/*
1576 * Determine whether disk supports Data Integrity Field.
1577 */
1578static void sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
1579{
1580 struct scsi_device *sdp = sdkp->device;
1581 u8 type;
1582
1583 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
1584 return;
1585
1586 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
1587
1588 if (type == sdkp->protection_type || !sdkp->first_scan)
1589 return;
1590
1591 sdkp->protection_type = type;
1592
1593 if (type > SD_DIF_TYPE3_PROTECTION) {
1594 sd_printk(KERN_ERR, sdkp, "formatted with unsupported " \
1595 "protection type %u. Disabling disk!\n", type);
1596 sdkp->capacity = 0;
1597 return;
1598 }
1599
1600 if (scsi_host_dif_capable(sdp->host, type))
1601 sd_printk(KERN_NOTICE, sdkp,
1602 "Enabling DIF Type %u protection\n", type);
1603 else
1604 sd_printk(KERN_NOTICE, sdkp,
1605 "Disabling DIF Type %u protection\n", type);
1606}
1607
1608static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
1609 struct scsi_sense_hdr *sshdr, int sense_valid,
1610 int the_result)
1611{
1612 sd_print_result(sdkp, the_result);
1613 if (driver_byte(the_result) & DRIVER_SENSE)
1614 sd_print_sense_hdr(sdkp, sshdr);
1615 else
1616 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
1617
1618 /*
1619 * Set dirty bit for removable devices if not ready -
1620 * sometimes drives will not report this properly.
1621 */
1622 if (sdp->removable &&
1623 sense_valid && sshdr->sense_key == NOT_READY)
1624 set_media_not_present(sdkp);
1625
1626 /*
1627 * We used to set media_present to 0 here to indicate no media
1628 * in the drive, but some drives fail read capacity even with
1629 * media present, so we can't do that.
1630 */
1631 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
1632}
1633
1634#define RC16_LEN 32
1635#if RC16_LEN > SD_BUF_SIZE
1636#error RC16_LEN must not be more than SD_BUF_SIZE
1637#endif
1638
1639#define READ_CAPACITY_RETRIES_ON_RESET 10
1640
1641static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
1642 unsigned char *buffer)
1643{
1644 unsigned char cmd[16];
1645 struct scsi_sense_hdr sshdr;
1646 int sense_valid = 0;
1647 int the_result;
1648 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
1649 unsigned int alignment;
1650 unsigned long long lba;
1651 unsigned sector_size;
1652
1653 if (sdp->no_read_capacity_16)
1654 return -EINVAL;
1655
1656 do {
1657 memset(cmd, 0, 16);
1658 cmd[0] = SERVICE_ACTION_IN;
1659 cmd[1] = SAI_READ_CAPACITY_16;
1660 cmd[13] = RC16_LEN;
1661 memset(buffer, 0, RC16_LEN);
1662
1663 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1664 buffer, RC16_LEN, &sshdr,
1665 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1666
1667 if (media_not_present(sdkp, &sshdr))
1668 return -ENODEV;
1669
1670 if (the_result) {
1671 sense_valid = scsi_sense_valid(&sshdr);
1672 if (sense_valid &&
1673 sshdr.sense_key == ILLEGAL_REQUEST &&
1674 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
1675 sshdr.ascq == 0x00)
1676 /* Invalid Command Operation Code or
1677 * Invalid Field in CDB, just retry
1678 * silently with RC10 */
1679 return -EINVAL;
1680 if (sense_valid &&
1681 sshdr.sense_key == UNIT_ATTENTION &&
1682 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
1683 /* Device reset might occur several times,
1684 * give it one more chance */
1685 if (--reset_retries > 0)
1686 continue;
1687 }
1688 retries--;
1689
1690 } while (the_result && retries);
1691
1692 if (the_result) {
1693 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY(16) failed\n");
1694 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
1695 return -EINVAL;
1696 }
1697
1698 sector_size = get_unaligned_be32(&buffer[8]);
1699 lba = get_unaligned_be64(&buffer[0]);
1700
1701 sd_read_protection_type(sdkp, buffer);
1702
1703 if ((sizeof(sdkp->capacity) == 4) && (lba >= 0xffffffffULL)) {
1704 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
1705 "kernel compiled with support for large block "
1706 "devices.\n");
1707 sdkp->capacity = 0;
1708 return -EOVERFLOW;
1709 }
1710
1711 /* Logical blocks per physical block exponent */
1712 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
1713
1714 /* Lowest aligned logical block */
1715 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
1716 blk_queue_alignment_offset(sdp->request_queue, alignment);
1717 if (alignment && sdkp->first_scan)
1718 sd_printk(KERN_NOTICE, sdkp,
1719 "physical block alignment offset: %u\n", alignment);
1720
1721 if (buffer[14] & 0x80) { /* LBPME */
1722 sdkp->lbpme = 1;
1723
1724 if (buffer[14] & 0x40) /* LBPRZ */
1725 sdkp->lbprz = 1;
1726
1727 sd_config_discard(sdkp, SD_LBP_WS16);
1728 }
1729
1730 sdkp->capacity = lba + 1;
1731 return sector_size;
1732}
1733
1734static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
1735 unsigned char *buffer)
1736{
1737 unsigned char cmd[16];
1738 struct scsi_sense_hdr sshdr;
1739 int sense_valid = 0;
1740 int the_result;
1741 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
1742 sector_t lba;
1743 unsigned sector_size;
1744
1745 do {
1746 cmd[0] = READ_CAPACITY;
1747 memset(&cmd[1], 0, 9);
1748 memset(buffer, 0, 8);
1749
1750 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1751 buffer, 8, &sshdr,
1752 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1753
1754 if (media_not_present(sdkp, &sshdr))
1755 return -ENODEV;
1756
1757 if (the_result) {
1758 sense_valid = scsi_sense_valid(&sshdr);
1759 if (sense_valid &&
1760 sshdr.sense_key == UNIT_ATTENTION &&
1761 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
1762 /* Device reset might occur several times,
1763 * give it one more chance */
1764 if (--reset_retries > 0)
1765 continue;
1766 }
1767 retries--;
1768
1769 } while (the_result && retries);
1770
1771 if (the_result) {
1772 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY failed\n");
1773 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
1774 return -EINVAL;
1775 }
1776
1777 sector_size = get_unaligned_be32(&buffer[4]);
1778 lba = get_unaligned_be32(&buffer[0]);
1779
1780 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
1781 /* Some buggy (usb cardreader) devices return an lba of
1782 0xffffffff when the want to report a size of 0 (with
1783 which they really mean no media is present) */
1784 sdkp->capacity = 0;
1785 sdkp->physical_block_size = sector_size;
1786 return sector_size;
1787 }
1788
1789 if ((sizeof(sdkp->capacity) == 4) && (lba == 0xffffffff)) {
1790 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
1791 "kernel compiled with support for large block "
1792 "devices.\n");
1793 sdkp->capacity = 0;
1794 return -EOVERFLOW;
1795 }
1796
1797 sdkp->capacity = lba + 1;
1798 sdkp->physical_block_size = sector_size;
1799 return sector_size;
1800}
1801
1802static int sd_try_rc16_first(struct scsi_device *sdp)
1803{
1804 if (sdp->host->max_cmd_len < 16)
1805 return 0;
1806 if (sdp->scsi_level > SCSI_SPC_2)
1807 return 1;
1808 if (scsi_device_protection(sdp))
1809 return 1;
1810 return 0;
1811}
1812
1813/*
1814 * read disk capacity
1815 */
1816static void
1817sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
1818{
1819 int sector_size;
1820 struct scsi_device *sdp = sdkp->device;
1821 sector_t old_capacity = sdkp->capacity;
1822
1823 if (sd_try_rc16_first(sdp)) {
1824 sector_size = read_capacity_16(sdkp, sdp, buffer);
1825 if (sector_size == -EOVERFLOW)
1826 goto got_data;
1827 if (sector_size == -ENODEV)
1828 return;
1829 if (sector_size < 0)
1830 sector_size = read_capacity_10(sdkp, sdp, buffer);
1831 if (sector_size < 0)
1832 return;
1833 } else {
1834 sector_size = read_capacity_10(sdkp, sdp, buffer);
1835 if (sector_size == -EOVERFLOW)
1836 goto got_data;
1837 if (sector_size < 0)
1838 return;
1839 if ((sizeof(sdkp->capacity) > 4) &&
1840 (sdkp->capacity > 0xffffffffULL)) {
1841 int old_sector_size = sector_size;
1842 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
1843 "Trying to use READ CAPACITY(16).\n");
1844 sector_size = read_capacity_16(sdkp, sdp, buffer);
1845 if (sector_size < 0) {
1846 sd_printk(KERN_NOTICE, sdkp,
1847 "Using 0xffffffff as device size\n");
1848 sdkp->capacity = 1 + (sector_t) 0xffffffff;
1849 sector_size = old_sector_size;
1850 goto got_data;
1851 }
1852 }
1853 }
1854
1855 /* Some devices are known to return the total number of blocks,
1856 * not the highest block number. Some devices have versions
1857 * which do this and others which do not. Some devices we might
1858 * suspect of doing this but we don't know for certain.
1859 *
1860 * If we know the reported capacity is wrong, decrement it. If
1861 * we can only guess, then assume the number of blocks is even
1862 * (usually true but not always) and err on the side of lowering
1863 * the capacity.
1864 */
1865 if (sdp->fix_capacity ||
1866 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
1867 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
1868 "from its reported value: %llu\n",
1869 (unsigned long long) sdkp->capacity);
1870 --sdkp->capacity;
1871 }
1872
1873got_data:
1874 if (sector_size == 0) {
1875 sector_size = 512;
1876 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
1877 "assuming 512.\n");
1878 }
1879
1880 if (sector_size != 512 &&
1881 sector_size != 1024 &&
1882 sector_size != 2048 &&
1883 sector_size != 4096 &&
1884 sector_size != 256) {
1885 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
1886 sector_size);
1887 /*
1888 * The user might want to re-format the drive with
1889 * a supported sectorsize. Once this happens, it
1890 * would be relatively trivial to set the thing up.
1891 * For this reason, we leave the thing in the table.
1892 */
1893 sdkp->capacity = 0;
1894 /*
1895 * set a bogus sector size so the normal read/write
1896 * logic in the block layer will eventually refuse any
1897 * request on this device without tripping over power
1898 * of two sector size assumptions
1899 */
1900 sector_size = 512;
1901 }
1902 blk_queue_logical_block_size(sdp->request_queue, sector_size);
1903
1904 {
1905 char cap_str_2[10], cap_str_10[10];
1906 u64 sz = (u64)sdkp->capacity << ilog2(sector_size);
1907
1908 string_get_size(sz, STRING_UNITS_2, cap_str_2,
1909 sizeof(cap_str_2));
1910 string_get_size(sz, STRING_UNITS_10, cap_str_10,
1911 sizeof(cap_str_10));
1912
1913 if (sdkp->first_scan || old_capacity != sdkp->capacity) {
1914 sd_printk(KERN_NOTICE, sdkp,
1915 "%llu %d-byte logical blocks: (%s/%s)\n",
1916 (unsigned long long)sdkp->capacity,
1917 sector_size, cap_str_10, cap_str_2);
1918
1919 if (sdkp->physical_block_size != sector_size)
1920 sd_printk(KERN_NOTICE, sdkp,
1921 "%u-byte physical blocks\n",
1922 sdkp->physical_block_size);
1923 }
1924 }
1925
1926 /* Rescale capacity to 512-byte units */
1927 if (sector_size == 4096)
1928 sdkp->capacity <<= 3;
1929 else if (sector_size == 2048)
1930 sdkp->capacity <<= 2;
1931 else if (sector_size == 1024)
1932 sdkp->capacity <<= 1;
1933 else if (sector_size == 256)
1934 sdkp->capacity >>= 1;
1935
1936 blk_queue_physical_block_size(sdp->request_queue,
1937 sdkp->physical_block_size);
1938 sdkp->device->sector_size = sector_size;
1939}
1940
1941/* called with buffer of length 512 */
1942static inline int
1943sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
1944 unsigned char *buffer, int len, struct scsi_mode_data *data,
1945 struct scsi_sense_hdr *sshdr)
1946{
1947 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1948 SD_TIMEOUT, SD_MAX_RETRIES, data,
1949 sshdr);
1950}
1951
1952/*
1953 * read write protect setting, if possible - called only in sd_revalidate_disk()
1954 * called with buffer of length SD_BUF_SIZE
1955 */
1956static void
1957sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
1958{
1959 int res;
1960 struct scsi_device *sdp = sdkp->device;
1961 struct scsi_mode_data data;
1962 int old_wp = sdkp->write_prot;
1963
1964 set_disk_ro(sdkp->disk, 0);
1965 if (sdp->skip_ms_page_3f) {
1966 sd_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1967 return;
1968 }
1969
1970 if (sdp->use_192_bytes_for_3f) {
1971 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1972 } else {
1973 /*
1974 * First attempt: ask for all pages (0x3F), but only 4 bytes.
1975 * We have to start carefully: some devices hang if we ask
1976 * for more than is available.
1977 */
1978 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1979
1980 /*
1981 * Second attempt: ask for page 0 When only page 0 is
1982 * implemented, a request for page 3F may return Sense Key
1983 * 5: Illegal Request, Sense Code 24: Invalid field in
1984 * CDB.
1985 */
1986 if (!scsi_status_is_good(res))
1987 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1988
1989 /*
1990 * Third attempt: ask 255 bytes, as we did earlier.
1991 */
1992 if (!scsi_status_is_good(res))
1993 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
1994 &data, NULL);
1995 }
1996
1997 if (!scsi_status_is_good(res)) {
1998 sd_printk(KERN_WARNING, sdkp,
1999 "Test WP failed, assume Write Enabled\n");
2000 } else {
2001 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
2002 set_disk_ro(sdkp->disk, sdkp->write_prot);
2003 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2004 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2005 sdkp->write_prot ? "on" : "off");
2006 sd_printk(KERN_DEBUG, sdkp,
2007 "Mode Sense: %02x %02x %02x %02x\n",
2008 buffer[0], buffer[1], buffer[2], buffer[3]);
2009 }
2010 }
2011}
2012
2013/*
2014 * sd_read_cache_type - called only from sd_revalidate_disk()
2015 * called with buffer of length SD_BUF_SIZE
2016 */
2017static void
2018sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
2019{
2020 int len = 0, res;
2021 struct scsi_device *sdp = sdkp->device;
2022
2023 int dbd;
2024 int modepage;
2025 int first_len;
2026 struct scsi_mode_data data;
2027 struct scsi_sense_hdr sshdr;
2028 int old_wce = sdkp->WCE;
2029 int old_rcd = sdkp->RCD;
2030 int old_dpofua = sdkp->DPOFUA;
2031
2032 first_len = 4;
2033 if (sdp->skip_ms_page_8) {
2034 if (sdp->type == TYPE_RBC)
2035 goto defaults;
2036 else {
2037 if (sdp->skip_ms_page_3f)
2038 goto defaults;
2039 modepage = 0x3F;
2040 if (sdp->use_192_bytes_for_3f)
2041 first_len = 192;
2042 dbd = 0;
2043 }
2044 } else if (sdp->type == TYPE_RBC) {
2045 modepage = 6;
2046 dbd = 8;
2047 } else {
2048 modepage = 8;
2049 dbd = 0;
2050 }
2051
2052 /* cautiously ask */
2053 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2054 &data, &sshdr);
2055
2056 if (!scsi_status_is_good(res))
2057 goto bad_sense;
2058
2059 if (!data.header_length) {
2060 modepage = 6;
2061 first_len = 0;
2062 sd_printk(KERN_ERR, sdkp, "Missing header in MODE_SENSE response\n");
2063 }
2064
2065 /* that went OK, now ask for the proper length */
2066 len = data.length;
2067
2068 /*
2069 * We're only interested in the first three bytes, actually.
2070 * But the data cache page is defined for the first 20.
2071 */
2072 if (len < 3)
2073 goto bad_sense;
2074 else if (len > SD_BUF_SIZE) {
2075 sd_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
2076 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2077 len = SD_BUF_SIZE;
2078 }
2079 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2080 len = 192;
2081
2082 /* Get the data */
2083 if (len > first_len)
2084 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2085 &data, &sshdr);
2086
2087 if (scsi_status_is_good(res)) {
2088 int offset = data.header_length + data.block_descriptor_length;
2089
2090 while (offset < len) {
2091 u8 page_code = buffer[offset] & 0x3F;
2092 u8 spf = buffer[offset] & 0x40;
2093
2094 if (page_code == 8 || page_code == 6) {
2095 /* We're interested only in the first 3 bytes.
2096 */
2097 if (len - offset <= 2) {
2098 sd_printk(KERN_ERR, sdkp, "Incomplete "
2099 "mode parameter data\n");
2100 goto defaults;
2101 } else {
2102 modepage = page_code;
2103 goto Page_found;
2104 }
2105 } else {
2106 /* Go to the next page */
2107 if (spf && len - offset > 3)
2108 offset += 4 + (buffer[offset+2] << 8) +
2109 buffer[offset+3];
2110 else if (!spf && len - offset > 1)
2111 offset += 2 + buffer[offset+1];
2112 else {
2113 sd_printk(KERN_ERR, sdkp, "Incomplete "
2114 "mode parameter data\n");
2115 goto defaults;
2116 }
2117 }
2118 }
2119
2120 if (modepage == 0x3F) {
2121 sd_printk(KERN_ERR, sdkp, "No Caching mode page "
2122 "present\n");
2123 goto defaults;
2124 } else if ((buffer[offset] & 0x3f) != modepage) {
2125 sd_printk(KERN_ERR, sdkp, "Got wrong page\n");
2126 goto defaults;
2127 }
2128 Page_found:
2129 if (modepage == 8) {
2130 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2131 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2132 } else {
2133 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2134 sdkp->RCD = 0;
2135 }
2136
2137 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
2138 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
2139 sd_printk(KERN_NOTICE, sdkp,
2140 "Uses READ/WRITE(6), disabling FUA\n");
2141 sdkp->DPOFUA = 0;
2142 }
2143
2144 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2145 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2146 sd_printk(KERN_NOTICE, sdkp,
2147 "Write cache: %s, read cache: %s, %s\n",
2148 sdkp->WCE ? "enabled" : "disabled",
2149 sdkp->RCD ? "disabled" : "enabled",
2150 sdkp->DPOFUA ? "supports DPO and FUA"
2151 : "doesn't support DPO or FUA");
2152
2153 return;
2154 }
2155
2156bad_sense:
2157 if (scsi_sense_valid(&sshdr) &&
2158 sshdr.sense_key == ILLEGAL_REQUEST &&
2159 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
2160 /* Invalid field in CDB */
2161 sd_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
2162 else
2163 sd_printk(KERN_ERR, sdkp, "Asking for cache data failed\n");
2164
2165defaults:
2166 sd_printk(KERN_ERR, sdkp, "Assuming drive cache: write through\n");
2167 sdkp->WCE = 0;
2168 sdkp->RCD = 0;
2169 sdkp->DPOFUA = 0;
2170}
2171
2172/*
2173 * The ATO bit indicates whether the DIF application tag is available
2174 * for use by the operating system.
2175 */
2176static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
2177{
2178 int res, offset;
2179 struct scsi_device *sdp = sdkp->device;
2180 struct scsi_mode_data data;
2181 struct scsi_sense_hdr sshdr;
2182
2183 if (sdp->type != TYPE_DISK)
2184 return;
2185
2186 if (sdkp->protection_type == 0)
2187 return;
2188
2189 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2190 SD_MAX_RETRIES, &data, &sshdr);
2191
2192 if (!scsi_status_is_good(res) || !data.header_length ||
2193 data.length < 6) {
2194 sd_printk(KERN_WARNING, sdkp,
2195 "getting Control mode page failed, assume no ATO\n");
2196
2197 if (scsi_sense_valid(&sshdr))
2198 sd_print_sense_hdr(sdkp, &sshdr);
2199
2200 return;
2201 }
2202
2203 offset = data.header_length + data.block_descriptor_length;
2204
2205 if ((buffer[offset] & 0x3f) != 0x0a) {
2206 sd_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
2207 return;
2208 }
2209
2210 if ((buffer[offset + 5] & 0x80) == 0)
2211 return;
2212
2213 sdkp->ATO = 1;
2214
2215 return;
2216}
2217
2218/**
2219 * sd_read_block_limits - Query disk device for preferred I/O sizes.
2220 * @disk: disk to query
2221 */
2222static void sd_read_block_limits(struct scsi_disk *sdkp)
2223{
2224 unsigned int sector_sz = sdkp->device->sector_size;
2225 const int vpd_len = 64;
2226 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
2227
2228 if (!buffer ||
2229 /* Block Limits VPD */
2230 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2231 goto out;
2232
2233 blk_queue_io_min(sdkp->disk->queue,
2234 get_unaligned_be16(&buffer[6]) * sector_sz);
2235 blk_queue_io_opt(sdkp->disk->queue,
2236 get_unaligned_be32(&buffer[12]) * sector_sz);
2237
2238 if (buffer[3] == 0x3c) {
2239 unsigned int lba_count, desc_count;
2240
2241 sdkp->max_ws_blocks =
2242 (u32) min_not_zero(get_unaligned_be64(&buffer[36]),
2243 (u64)0xffffffff);
2244
2245 if (!sdkp->lbpme)
2246 goto out;
2247
2248 lba_count = get_unaligned_be32(&buffer[20]);
2249 desc_count = get_unaligned_be32(&buffer[24]);
2250
2251 if (lba_count && desc_count)
2252 sdkp->max_unmap_blocks = lba_count;
2253
2254 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
2255
2256 if (buffer[32] & 0x80)
2257 sdkp->unmap_alignment =
2258 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
2259
2260 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2261
2262 if (sdkp->max_unmap_blocks)
2263 sd_config_discard(sdkp, SD_LBP_UNMAP);
2264 else
2265 sd_config_discard(sdkp, SD_LBP_WS16);
2266
2267 } else { /* LBP VPD page tells us what to use */
2268
2269 if (sdkp->lbpu && sdkp->max_unmap_blocks)
2270 sd_config_discard(sdkp, SD_LBP_UNMAP);
2271 else if (sdkp->lbpws)
2272 sd_config_discard(sdkp, SD_LBP_WS16);
2273 else if (sdkp->lbpws10)
2274 sd_config_discard(sdkp, SD_LBP_WS10);
2275 else
2276 sd_config_discard(sdkp, SD_LBP_DISABLE);
2277 }
2278 }
2279
2280 out:
2281 kfree(buffer);
2282}
2283
2284/**
2285 * sd_read_block_characteristics - Query block dev. characteristics
2286 * @disk: disk to query
2287 */
2288static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2289{
2290 unsigned char *buffer;
2291 u16 rot;
2292 const int vpd_len = 64;
2293
2294 buffer = kmalloc(vpd_len, GFP_KERNEL);
2295
2296 if (!buffer ||
2297 /* Block Device Characteristics VPD */
2298 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2299 goto out;
2300
2301 rot = get_unaligned_be16(&buffer[4]);
2302
2303 if (rot == 1)
2304 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, sdkp->disk->queue);
2305
2306 out:
2307 kfree(buffer);
2308}
2309
2310/**
2311 * sd_read_block_provisioning - Query provisioning VPD page
2312 * @disk: disk to query
2313 */
2314static void sd_read_block_provisioning(struct scsi_disk *sdkp)
2315{
2316 unsigned char *buffer;
2317 const int vpd_len = 8;
2318
2319 if (sdkp->lbpme == 0)
2320 return;
2321
2322 buffer = kmalloc(vpd_len, GFP_KERNEL);
2323
2324 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
2325 goto out;
2326
2327 sdkp->lbpvpd = 1;
2328 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
2329 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
2330 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
2331
2332 out:
2333 kfree(buffer);
2334}
2335
2336static int sd_try_extended_inquiry(struct scsi_device *sdp)
2337{
2338 /*
2339 * Although VPD inquiries can go to SCSI-2 type devices,
2340 * some USB ones crash on receiving them, and the pages
2341 * we currently ask for are for SPC-3 and beyond
2342 */
2343 if (sdp->scsi_level > SCSI_SPC_2)
2344 return 1;
2345 return 0;
2346}
2347
2348/**
2349 * sd_revalidate_disk - called the first time a new disk is seen,
2350 * performs disk spin up, read_capacity, etc.
2351 * @disk: struct gendisk we care about
2352 **/
2353static int sd_revalidate_disk(struct gendisk *disk)
2354{
2355 struct scsi_disk *sdkp = scsi_disk(disk);
2356 struct scsi_device *sdp = sdkp->device;
2357 unsigned char *buffer;
2358 unsigned flush = 0;
2359
2360 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
2361 "sd_revalidate_disk\n"));
2362
2363 /*
2364 * If the device is offline, don't try and read capacity or any
2365 * of the other niceties.
2366 */
2367 if (!scsi_device_online(sdp))
2368 goto out;
2369
2370 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
2371 if (!buffer) {
2372 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
2373 "allocation failure.\n");
2374 goto out;
2375 }
2376
2377 sd_spinup_disk(sdkp);
2378
2379 /*
2380 * Without media there is no reason to ask; moreover, some devices
2381 * react badly if we do.
2382 */
2383 if (sdkp->media_present) {
2384 sd_read_capacity(sdkp, buffer);
2385
2386 if (sd_try_extended_inquiry(sdp)) {
2387 sd_read_block_provisioning(sdkp);
2388 sd_read_block_limits(sdkp);
2389 sd_read_block_characteristics(sdkp);
2390 }
2391
2392 sd_read_write_protect_flag(sdkp, buffer);
2393 sd_read_cache_type(sdkp, buffer);
2394 sd_read_app_tag_own(sdkp, buffer);
2395 }
2396
2397 sdkp->first_scan = 0;
2398
2399 /*
2400 * We now have all cache related info, determine how we deal
2401 * with flush requests.
2402 */
2403 if (sdkp->WCE) {
2404 flush |= REQ_FLUSH;
2405 if (sdkp->DPOFUA)
2406 flush |= REQ_FUA;
2407 }
2408
2409 blk_queue_flush(sdkp->disk->queue, flush);
2410
2411 set_capacity(disk, sdkp->capacity);
2412 kfree(buffer);
2413
2414 out:
2415 return 0;
2416}
2417
2418/**
2419 * sd_unlock_native_capacity - unlock native capacity
2420 * @disk: struct gendisk to set capacity for
2421 *
2422 * Block layer calls this function if it detects that partitions
2423 * on @disk reach beyond the end of the device. If the SCSI host
2424 * implements ->unlock_native_capacity() method, it's invoked to
2425 * give it a chance to adjust the device capacity.
2426 *
2427 * CONTEXT:
2428 * Defined by block layer. Might sleep.
2429 */
2430static void sd_unlock_native_capacity(struct gendisk *disk)
2431{
2432 struct scsi_device *sdev = scsi_disk(disk)->device;
2433
2434 if (sdev->host->hostt->unlock_native_capacity)
2435 sdev->host->hostt->unlock_native_capacity(sdev);
2436}
2437
2438/**
2439 * sd_format_disk_name - format disk name
2440 * @prefix: name prefix - ie. "sd" for SCSI disks
2441 * @index: index of the disk to format name for
2442 * @buf: output buffer
2443 * @buflen: length of the output buffer
2444 *
2445 * SCSI disk names starts at sda. The 26th device is sdz and the
2446 * 27th is sdaa. The last one for two lettered suffix is sdzz
2447 * which is followed by sdaaa.
2448 *
2449 * This is basically 26 base counting with one extra 'nil' entry
2450 * at the beginning from the second digit on and can be
2451 * determined using similar method as 26 base conversion with the
2452 * index shifted -1 after each digit is computed.
2453 *
2454 * CONTEXT:
2455 * Don't care.
2456 *
2457 * RETURNS:
2458 * 0 on success, -errno on failure.
2459 */
2460static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
2461{
2462 const int base = 'z' - 'a' + 1;
2463 char *begin = buf + strlen(prefix);
2464 char *end = buf + buflen;
2465 char *p;
2466 int unit;
2467
2468 p = end - 1;
2469 *p = '\0';
2470 unit = base;
2471 do {
2472 if (p == begin)
2473 return -EINVAL;
2474 *--p = 'a' + (index % unit);
2475 index = (index / unit) - 1;
2476 } while (index >= 0);
2477
2478 memmove(begin, p, end - p);
2479 memcpy(buf, prefix, strlen(prefix));
2480
2481 return 0;
2482}
2483
2484/*
2485 * The asynchronous part of sd_probe
2486 */
2487static void sd_probe_async(void *data, async_cookie_t cookie)
2488{
2489 struct scsi_disk *sdkp = data;
2490 struct scsi_device *sdp;
2491 struct gendisk *gd;
2492 u32 index;
2493 struct device *dev;
2494
2495 sdp = sdkp->device;
2496 gd = sdkp->disk;
2497 index = sdkp->index;
2498 dev = &sdp->sdev_gendev;
2499
2500 gd->major = sd_major((index & 0xf0) >> 4);
2501 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
2502 gd->minors = SD_MINORS;
2503
2504 gd->fops = &sd_fops;
2505 gd->private_data = &sdkp->driver;
2506 gd->queue = sdkp->device->request_queue;
2507
2508 /* defaults, until the device tells us otherwise */
2509 sdp->sector_size = 512;
2510 sdkp->capacity = 0;
2511 sdkp->media_present = 1;
2512 sdkp->write_prot = 0;
2513 sdkp->WCE = 0;
2514 sdkp->RCD = 0;
2515 sdkp->ATO = 0;
2516 sdkp->first_scan = 1;
2517
2518 sd_revalidate_disk(gd);
2519
2520 blk_queue_prep_rq(sdp->request_queue, sd_prep_fn);
2521 blk_queue_unprep_rq(sdp->request_queue, sd_unprep_fn);
2522
2523 gd->driverfs_dev = &sdp->sdev_gendev;
2524 gd->flags = GENHD_FL_EXT_DEVT;
2525 if (sdp->removable) {
2526 gd->flags |= GENHD_FL_REMOVABLE;
2527 gd->events |= DISK_EVENT_MEDIA_CHANGE;
2528 }
2529
2530 add_disk(gd);
2531 sd_dif_config_host(sdkp);
2532
2533 sd_revalidate_disk(gd);
2534
2535 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
2536 sdp->removable ? "removable " : "");
2537 scsi_autopm_put_device(sdp);
2538 put_device(&sdkp->dev);
2539}
2540
2541/**
2542 * sd_probe - called during driver initialization and whenever a
2543 * new scsi device is attached to the system. It is called once
2544 * for each scsi device (not just disks) present.
2545 * @dev: pointer to device object
2546 *
2547 * Returns 0 if successful (or not interested in this scsi device
2548 * (e.g. scanner)); 1 when there is an error.
2549 *
2550 * Note: this function is invoked from the scsi mid-level.
2551 * This function sets up the mapping between a given
2552 * <host,channel,id,lun> (found in sdp) and new device name
2553 * (e.g. /dev/sda). More precisely it is the block device major
2554 * and minor number that is chosen here.
2555 *
2556 * Assume sd_attach is not re-entrant (for time being)
2557 * Also think about sd_attach() and sd_remove() running coincidentally.
2558 **/
2559static int sd_probe(struct device *dev)
2560{
2561 struct scsi_device *sdp = to_scsi_device(dev);
2562 struct scsi_disk *sdkp;
2563 struct gendisk *gd;
2564 int index;
2565 int error;
2566
2567 error = -ENODEV;
2568 if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
2569 goto out;
2570
2571 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
2572 "sd_attach\n"));
2573
2574 error = -ENOMEM;
2575 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
2576 if (!sdkp)
2577 goto out;
2578
2579 gd = alloc_disk(SD_MINORS);
2580 if (!gd)
2581 goto out_free;
2582
2583 do {
2584 if (!ida_pre_get(&sd_index_ida, GFP_KERNEL))
2585 goto out_put;
2586
2587 spin_lock(&sd_index_lock);
2588 error = ida_get_new(&sd_index_ida, &index);
2589 spin_unlock(&sd_index_lock);
2590 } while (error == -EAGAIN);
2591
2592 if (error)
2593 goto out_put;
2594
2595 if (index >= SD_MAX_DISKS) {
2596 error = -ENODEV;
2597 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name space exhausted.\n");
2598 goto out_free_index;
2599 }
2600
2601 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
2602 if (error)
2603 goto out_free_index;
2604
2605 sdkp->device = sdp;
2606 sdkp->driver = &sd_template;
2607 sdkp->disk = gd;
2608 sdkp->index = index;
2609 atomic_set(&sdkp->openers, 0);
2610
2611 if (!sdp->request_queue->rq_timeout) {
2612 if (sdp->type != TYPE_MOD)
2613 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
2614 else
2615 blk_queue_rq_timeout(sdp->request_queue,
2616 SD_MOD_TIMEOUT);
2617 }
2618
2619 device_initialize(&sdkp->dev);
2620 sdkp->dev.parent = dev;
2621 sdkp->dev.class = &sd_disk_class;
2622 dev_set_name(&sdkp->dev, dev_name(dev));
2623
2624 if (device_add(&sdkp->dev))
2625 goto out_free_index;
2626
2627 get_device(dev);
2628 dev_set_drvdata(dev, sdkp);
2629
2630 get_device(&sdkp->dev); /* prevent release before async_schedule */
2631 async_schedule(sd_probe_async, sdkp);
2632
2633 return 0;
2634
2635 out_free_index:
2636 spin_lock(&sd_index_lock);
2637 ida_remove(&sd_index_ida, index);
2638 spin_unlock(&sd_index_lock);
2639 out_put:
2640 put_disk(gd);
2641 out_free:
2642 kfree(sdkp);
2643 out:
2644 return error;
2645}
2646
2647/**
2648 * sd_remove - called whenever a scsi disk (previously recognized by
2649 * sd_probe) is detached from the system. It is called (potentially
2650 * multiple times) during sd module unload.
2651 * @sdp: pointer to mid level scsi device object
2652 *
2653 * Note: this function is invoked from the scsi mid-level.
2654 * This function potentially frees up a device name (e.g. /dev/sdc)
2655 * that could be re-used by a subsequent sd_probe().
2656 * This function is not called when the built-in sd driver is "exit-ed".
2657 **/
2658static int sd_remove(struct device *dev)
2659{
2660 struct scsi_disk *sdkp;
2661
2662 sdkp = dev_get_drvdata(dev);
2663 scsi_autopm_get_device(sdkp->device);
2664
2665 async_synchronize_full();
2666 blk_queue_prep_rq(sdkp->device->request_queue, scsi_prep_fn);
2667 blk_queue_unprep_rq(sdkp->device->request_queue, NULL);
2668 device_del(&sdkp->dev);
2669 del_gendisk(sdkp->disk);
2670 sd_shutdown(dev);
2671
2672 mutex_lock(&sd_ref_mutex);
2673 dev_set_drvdata(dev, NULL);
2674 put_device(&sdkp->dev);
2675 mutex_unlock(&sd_ref_mutex);
2676
2677 return 0;
2678}
2679
2680/**
2681 * scsi_disk_release - Called to free the scsi_disk structure
2682 * @dev: pointer to embedded class device
2683 *
2684 * sd_ref_mutex must be held entering this routine. Because it is
2685 * called on last put, you should always use the scsi_disk_get()
2686 * scsi_disk_put() helpers which manipulate the semaphore directly
2687 * and never do a direct put_device.
2688 **/
2689static void scsi_disk_release(struct device *dev)
2690{
2691 struct scsi_disk *sdkp = to_scsi_disk(dev);
2692 struct gendisk *disk = sdkp->disk;
2693
2694 spin_lock(&sd_index_lock);
2695 ida_remove(&sd_index_ida, sdkp->index);
2696 spin_unlock(&sd_index_lock);
2697
2698 disk->private_data = NULL;
2699 put_disk(disk);
2700 put_device(&sdkp->device->sdev_gendev);
2701
2702 kfree(sdkp);
2703}
2704
2705static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
2706{
2707 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
2708 struct scsi_sense_hdr sshdr;
2709 struct scsi_device *sdp = sdkp->device;
2710 int res;
2711
2712 if (start)
2713 cmd[4] |= 1; /* START */
2714
2715 if (sdp->start_stop_pwr_cond)
2716 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
2717
2718 if (!scsi_device_online(sdp))
2719 return -ENODEV;
2720
2721 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
2722 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2723 if (res) {
2724 sd_printk(KERN_WARNING, sdkp, "START_STOP FAILED\n");
2725 sd_print_result(sdkp, res);
2726 if (driver_byte(res) & DRIVER_SENSE)
2727 sd_print_sense_hdr(sdkp, &sshdr);
2728 }
2729
2730 return res;
2731}
2732
2733/*
2734 * Send a SYNCHRONIZE CACHE instruction down to the device through
2735 * the normal SCSI command structure. Wait for the command to
2736 * complete.
2737 */
2738static void sd_shutdown(struct device *dev)
2739{
2740 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2741
2742 if (!sdkp)
2743 return; /* this can happen */
2744
2745 if (sdkp->WCE) {
2746 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2747 sd_sync_cache(sdkp);
2748 }
2749
2750 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
2751 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2752 sd_start_stop_device(sdkp, 0);
2753 }
2754
2755 scsi_disk_put(sdkp);
2756}
2757
2758static int sd_suspend(struct device *dev, pm_message_t mesg)
2759{
2760 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2761 int ret = 0;
2762
2763 if (!sdkp)
2764 return 0; /* this can happen */
2765
2766 if (sdkp->WCE) {
2767 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2768 ret = sd_sync_cache(sdkp);
2769 if (ret)
2770 goto done;
2771 }
2772
2773 if ((mesg.event & PM_EVENT_SLEEP) && sdkp->device->manage_start_stop) {
2774 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2775 ret = sd_start_stop_device(sdkp, 0);
2776 }
2777
2778done:
2779 scsi_disk_put(sdkp);
2780 return ret;
2781}
2782
2783static int sd_resume(struct device *dev)
2784{
2785 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2786 int ret = 0;
2787
2788 if (!sdkp->device->manage_start_stop)
2789 goto done;
2790
2791 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
2792 ret = sd_start_stop_device(sdkp, 1);
2793
2794done:
2795 scsi_disk_put(sdkp);
2796 return ret;
2797}
2798
2799/**
2800 * init_sd - entry point for this driver (both when built in or when
2801 * a module).
2802 *
2803 * Note: this function registers this driver with the scsi mid-level.
2804 **/
2805static int __init init_sd(void)
2806{
2807 int majors = 0, i, err;
2808
2809 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
2810
2811 for (i = 0; i < SD_MAJORS; i++)
2812 if (register_blkdev(sd_major(i), "sd") == 0)
2813 majors++;
2814
2815 if (!majors)
2816 return -ENODEV;
2817
2818 err = class_register(&sd_disk_class);
2819 if (err)
2820 goto err_out;
2821
2822 err = scsi_register_driver(&sd_template.gendrv);
2823 if (err)
2824 goto err_out_class;
2825
2826 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
2827 0, 0, NULL);
2828 if (!sd_cdb_cache) {
2829 printk(KERN_ERR "sd: can't init extended cdb cache\n");
2830 goto err_out_class;
2831 }
2832
2833 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
2834 if (!sd_cdb_pool) {
2835 printk(KERN_ERR "sd: can't init extended cdb pool\n");
2836 goto err_out_cache;
2837 }
2838
2839 return 0;
2840
2841err_out_cache:
2842 kmem_cache_destroy(sd_cdb_cache);
2843
2844err_out_class:
2845 class_unregister(&sd_disk_class);
2846err_out:
2847 for (i = 0; i < SD_MAJORS; i++)
2848 unregister_blkdev(sd_major(i), "sd");
2849 return err;
2850}
2851
2852/**
2853 * exit_sd - exit point for this driver (when it is a module).
2854 *
2855 * Note: this function unregisters this driver from the scsi mid-level.
2856 **/
2857static void __exit exit_sd(void)
2858{
2859 int i;
2860
2861 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
2862
2863 mempool_destroy(sd_cdb_pool);
2864 kmem_cache_destroy(sd_cdb_cache);
2865
2866 scsi_unregister_driver(&sd_template.gendrv);
2867 class_unregister(&sd_disk_class);
2868
2869 for (i = 0; i < SD_MAJORS; i++)
2870 unregister_blkdev(sd_major(i), "sd");
2871}
2872
2873module_init(init_sd);
2874module_exit(exit_sd);
2875
2876static void sd_print_sense_hdr(struct scsi_disk *sdkp,
2877 struct scsi_sense_hdr *sshdr)
2878{
2879 sd_printk(KERN_INFO, sdkp, " ");
2880 scsi_show_sense_hdr(sshdr);
2881 sd_printk(KERN_INFO, sdkp, " ");
2882 scsi_show_extd_sense(sshdr->asc, sshdr->ascq);
2883}
2884
2885static void sd_print_result(struct scsi_disk *sdkp, int result)
2886{
2887 sd_printk(KERN_INFO, sdkp, " ");
2888 scsi_show_result(result);
2889}
2890
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * sd.c Copyright (C) 1992 Drew Eckhardt
4 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
5 *
6 * Linux scsi disk driver
7 * Initial versions: Drew Eckhardt
8 * Subsequent revisions: Eric Youngdale
9 * Modification history:
10 * - Drew Eckhardt <drew@colorado.edu> original
11 * - Eric Youngdale <eric@andante.org> add scatter-gather, multiple
12 * outstanding request, and other enhancements.
13 * Support loadable low-level scsi drivers.
14 * - Jirka Hanika <geo@ff.cuni.cz> support more scsi disks using
15 * eight major numbers.
16 * - Richard Gooch <rgooch@atnf.csiro.au> support devfs.
17 * - Torben Mathiasen <tmm@image.dk> Resource allocation fixes in
18 * sd_init and cleanups.
19 * - Alex Davis <letmein@erols.com> Fix problem where partition info
20 * not being read in sd_open. Fix problem where removable media
21 * could be ejected after sd_open.
22 * - Douglas Gilbert <dgilbert@interlog.com> cleanup for lk 2.5.x
23 * - Badari Pulavarty <pbadari@us.ibm.com>, Matthew Wilcox
24 * <willy@debian.org>, Kurt Garloff <garloff@suse.de>:
25 * Support 32k/1M disks.
26 *
27 * Logging policy (needs CONFIG_SCSI_LOGGING defined):
28 * - setting up transfer: SCSI_LOG_HLQUEUE levels 1 and 2
29 * - end of transfer (bh + scsi_lib): SCSI_LOG_HLCOMPLETE level 1
30 * - entering sd_ioctl: SCSI_LOG_IOCTL level 1
31 * - entering other commands: SCSI_LOG_HLQUEUE level 3
32 * Note: when the logging level is set by the user, it must be greater
33 * than the level indicated above to trigger output.
34 */
35
36#include <linux/module.h>
37#include <linux/fs.h>
38#include <linux/kernel.h>
39#include <linux/mm.h>
40#include <linux/bio.h>
41#include <linux/genhd.h>
42#include <linux/hdreg.h>
43#include <linux/errno.h>
44#include <linux/idr.h>
45#include <linux/interrupt.h>
46#include <linux/init.h>
47#include <linux/blkdev.h>
48#include <linux/blkpg.h>
49#include <linux/blk-pm.h>
50#include <linux/delay.h>
51#include <linux/mutex.h>
52#include <linux/string_helpers.h>
53#include <linux/async.h>
54#include <linux/slab.h>
55#include <linux/sed-opal.h>
56#include <linux/pm_runtime.h>
57#include <linux/pr.h>
58#include <linux/t10-pi.h>
59#include <linux/uaccess.h>
60#include <asm/unaligned.h>
61
62#include <scsi/scsi.h>
63#include <scsi/scsi_cmnd.h>
64#include <scsi/scsi_dbg.h>
65#include <scsi/scsi_device.h>
66#include <scsi/scsi_driver.h>
67#include <scsi/scsi_eh.h>
68#include <scsi/scsi_host.h>
69#include <scsi/scsi_ioctl.h>
70#include <scsi/scsicam.h>
71
72#include "sd.h"
73#include "scsi_priv.h"
74#include "scsi_logging.h"
75
76MODULE_AUTHOR("Eric Youngdale");
77MODULE_DESCRIPTION("SCSI disk (sd) driver");
78MODULE_LICENSE("GPL");
79
80MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
81MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
82MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
83MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
84MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
85MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
86MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
87MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
88MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
89MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
90MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
91MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
92MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
93MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
94MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
95MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
96MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
97MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
98MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
99MODULE_ALIAS_SCSI_DEVICE(TYPE_ZBC);
100
101#if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
102#define SD_MINORS 16
103#else
104#define SD_MINORS 0
105#endif
106
107static void sd_config_discard(struct scsi_disk *, unsigned int);
108static void sd_config_write_same(struct scsi_disk *);
109static int sd_revalidate_disk(struct gendisk *);
110static void sd_unlock_native_capacity(struct gendisk *disk);
111static int sd_probe(struct device *);
112static int sd_remove(struct device *);
113static void sd_shutdown(struct device *);
114static int sd_suspend_system(struct device *);
115static int sd_suspend_runtime(struct device *);
116static int sd_resume(struct device *);
117static void sd_rescan(struct device *);
118static blk_status_t sd_init_command(struct scsi_cmnd *SCpnt);
119static void sd_uninit_command(struct scsi_cmnd *SCpnt);
120static int sd_done(struct scsi_cmnd *);
121static void sd_eh_reset(struct scsi_cmnd *);
122static int sd_eh_action(struct scsi_cmnd *, int);
123static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
124static void scsi_disk_release(struct device *cdev);
125
126static DEFINE_IDA(sd_index_ida);
127
128/* This semaphore is used to mediate the 0->1 reference get in the
129 * face of object destruction (i.e. we can't allow a get on an
130 * object after last put) */
131static DEFINE_MUTEX(sd_ref_mutex);
132
133static struct kmem_cache *sd_cdb_cache;
134static mempool_t *sd_cdb_pool;
135static mempool_t *sd_page_pool;
136
137static const char *sd_cache_types[] = {
138 "write through", "none", "write back",
139 "write back, no read (daft)"
140};
141
142static void sd_set_flush_flag(struct scsi_disk *sdkp)
143{
144 bool wc = false, fua = false;
145
146 if (sdkp->WCE) {
147 wc = true;
148 if (sdkp->DPOFUA)
149 fua = true;
150 }
151
152 blk_queue_write_cache(sdkp->disk->queue, wc, fua);
153}
154
155static ssize_t
156cache_type_store(struct device *dev, struct device_attribute *attr,
157 const char *buf, size_t count)
158{
159 int ct, rcd, wce, sp;
160 struct scsi_disk *sdkp = to_scsi_disk(dev);
161 struct scsi_device *sdp = sdkp->device;
162 char buffer[64];
163 char *buffer_data;
164 struct scsi_mode_data data;
165 struct scsi_sense_hdr sshdr;
166 static const char temp[] = "temporary ";
167 int len;
168
169 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
170 /* no cache control on RBC devices; theoretically they
171 * can do it, but there's probably so many exceptions
172 * it's not worth the risk */
173 return -EINVAL;
174
175 if (strncmp(buf, temp, sizeof(temp) - 1) == 0) {
176 buf += sizeof(temp) - 1;
177 sdkp->cache_override = 1;
178 } else {
179 sdkp->cache_override = 0;
180 }
181
182 ct = sysfs_match_string(sd_cache_types, buf);
183 if (ct < 0)
184 return -EINVAL;
185
186 rcd = ct & 0x01 ? 1 : 0;
187 wce = (ct & 0x02) && !sdkp->write_prot ? 1 : 0;
188
189 if (sdkp->cache_override) {
190 sdkp->WCE = wce;
191 sdkp->RCD = rcd;
192 sd_set_flush_flag(sdkp);
193 return count;
194 }
195
196 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
197 SD_MAX_RETRIES, &data, NULL))
198 return -EINVAL;
199 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
200 data.block_descriptor_length);
201 buffer_data = buffer + data.header_length +
202 data.block_descriptor_length;
203 buffer_data[2] &= ~0x05;
204 buffer_data[2] |= wce << 2 | rcd;
205 sp = buffer_data[0] & 0x80 ? 1 : 0;
206 buffer_data[0] &= ~0x80;
207
208 /*
209 * Ensure WP, DPOFUA, and RESERVED fields are cleared in
210 * received mode parameter buffer before doing MODE SELECT.
211 */
212 data.device_specific = 0;
213
214 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
215 SD_MAX_RETRIES, &data, &sshdr)) {
216 if (scsi_sense_valid(&sshdr))
217 sd_print_sense_hdr(sdkp, &sshdr);
218 return -EINVAL;
219 }
220 revalidate_disk(sdkp->disk);
221 return count;
222}
223
224static ssize_t
225manage_start_stop_show(struct device *dev, struct device_attribute *attr,
226 char *buf)
227{
228 struct scsi_disk *sdkp = to_scsi_disk(dev);
229 struct scsi_device *sdp = sdkp->device;
230
231 return sprintf(buf, "%u\n", sdp->manage_start_stop);
232}
233
234static ssize_t
235manage_start_stop_store(struct device *dev, struct device_attribute *attr,
236 const char *buf, size_t count)
237{
238 struct scsi_disk *sdkp = to_scsi_disk(dev);
239 struct scsi_device *sdp = sdkp->device;
240 bool v;
241
242 if (!capable(CAP_SYS_ADMIN))
243 return -EACCES;
244
245 if (kstrtobool(buf, &v))
246 return -EINVAL;
247
248 sdp->manage_start_stop = v;
249
250 return count;
251}
252static DEVICE_ATTR_RW(manage_start_stop);
253
254static ssize_t
255allow_restart_show(struct device *dev, struct device_attribute *attr, char *buf)
256{
257 struct scsi_disk *sdkp = to_scsi_disk(dev);
258
259 return sprintf(buf, "%u\n", sdkp->device->allow_restart);
260}
261
262static ssize_t
263allow_restart_store(struct device *dev, struct device_attribute *attr,
264 const char *buf, size_t count)
265{
266 bool v;
267 struct scsi_disk *sdkp = to_scsi_disk(dev);
268 struct scsi_device *sdp = sdkp->device;
269
270 if (!capable(CAP_SYS_ADMIN))
271 return -EACCES;
272
273 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
274 return -EINVAL;
275
276 if (kstrtobool(buf, &v))
277 return -EINVAL;
278
279 sdp->allow_restart = v;
280
281 return count;
282}
283static DEVICE_ATTR_RW(allow_restart);
284
285static ssize_t
286cache_type_show(struct device *dev, struct device_attribute *attr, char *buf)
287{
288 struct scsi_disk *sdkp = to_scsi_disk(dev);
289 int ct = sdkp->RCD + 2*sdkp->WCE;
290
291 return sprintf(buf, "%s\n", sd_cache_types[ct]);
292}
293static DEVICE_ATTR_RW(cache_type);
294
295static ssize_t
296FUA_show(struct device *dev, struct device_attribute *attr, char *buf)
297{
298 struct scsi_disk *sdkp = to_scsi_disk(dev);
299
300 return sprintf(buf, "%u\n", sdkp->DPOFUA);
301}
302static DEVICE_ATTR_RO(FUA);
303
304static ssize_t
305protection_type_show(struct device *dev, struct device_attribute *attr,
306 char *buf)
307{
308 struct scsi_disk *sdkp = to_scsi_disk(dev);
309
310 return sprintf(buf, "%u\n", sdkp->protection_type);
311}
312
313static ssize_t
314protection_type_store(struct device *dev, struct device_attribute *attr,
315 const char *buf, size_t count)
316{
317 struct scsi_disk *sdkp = to_scsi_disk(dev);
318 unsigned int val;
319 int err;
320
321 if (!capable(CAP_SYS_ADMIN))
322 return -EACCES;
323
324 err = kstrtouint(buf, 10, &val);
325
326 if (err)
327 return err;
328
329 if (val <= T10_PI_TYPE3_PROTECTION)
330 sdkp->protection_type = val;
331
332 return count;
333}
334static DEVICE_ATTR_RW(protection_type);
335
336static ssize_t
337protection_mode_show(struct device *dev, struct device_attribute *attr,
338 char *buf)
339{
340 struct scsi_disk *sdkp = to_scsi_disk(dev);
341 struct scsi_device *sdp = sdkp->device;
342 unsigned int dif, dix;
343
344 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
345 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
346
347 if (!dix && scsi_host_dix_capable(sdp->host, T10_PI_TYPE0_PROTECTION)) {
348 dif = 0;
349 dix = 1;
350 }
351
352 if (!dif && !dix)
353 return sprintf(buf, "none\n");
354
355 return sprintf(buf, "%s%u\n", dix ? "dix" : "dif", dif);
356}
357static DEVICE_ATTR_RO(protection_mode);
358
359static ssize_t
360app_tag_own_show(struct device *dev, struct device_attribute *attr, char *buf)
361{
362 struct scsi_disk *sdkp = to_scsi_disk(dev);
363
364 return sprintf(buf, "%u\n", sdkp->ATO);
365}
366static DEVICE_ATTR_RO(app_tag_own);
367
368static ssize_t
369thin_provisioning_show(struct device *dev, struct device_attribute *attr,
370 char *buf)
371{
372 struct scsi_disk *sdkp = to_scsi_disk(dev);
373
374 return sprintf(buf, "%u\n", sdkp->lbpme);
375}
376static DEVICE_ATTR_RO(thin_provisioning);
377
378/* sysfs_match_string() requires dense arrays */
379static const char *lbp_mode[] = {
380 [SD_LBP_FULL] = "full",
381 [SD_LBP_UNMAP] = "unmap",
382 [SD_LBP_WS16] = "writesame_16",
383 [SD_LBP_WS10] = "writesame_10",
384 [SD_LBP_ZERO] = "writesame_zero",
385 [SD_LBP_DISABLE] = "disabled",
386};
387
388static ssize_t
389provisioning_mode_show(struct device *dev, struct device_attribute *attr,
390 char *buf)
391{
392 struct scsi_disk *sdkp = to_scsi_disk(dev);
393
394 return sprintf(buf, "%s\n", lbp_mode[sdkp->provisioning_mode]);
395}
396
397static ssize_t
398provisioning_mode_store(struct device *dev, struct device_attribute *attr,
399 const char *buf, size_t count)
400{
401 struct scsi_disk *sdkp = to_scsi_disk(dev);
402 struct scsi_device *sdp = sdkp->device;
403 int mode;
404
405 if (!capable(CAP_SYS_ADMIN))
406 return -EACCES;
407
408 if (sd_is_zoned(sdkp)) {
409 sd_config_discard(sdkp, SD_LBP_DISABLE);
410 return count;
411 }
412
413 if (sdp->type != TYPE_DISK)
414 return -EINVAL;
415
416 mode = sysfs_match_string(lbp_mode, buf);
417 if (mode < 0)
418 return -EINVAL;
419
420 sd_config_discard(sdkp, mode);
421
422 return count;
423}
424static DEVICE_ATTR_RW(provisioning_mode);
425
426/* sysfs_match_string() requires dense arrays */
427static const char *zeroing_mode[] = {
428 [SD_ZERO_WRITE] = "write",
429 [SD_ZERO_WS] = "writesame",
430 [SD_ZERO_WS16_UNMAP] = "writesame_16_unmap",
431 [SD_ZERO_WS10_UNMAP] = "writesame_10_unmap",
432};
433
434static ssize_t
435zeroing_mode_show(struct device *dev, struct device_attribute *attr,
436 char *buf)
437{
438 struct scsi_disk *sdkp = to_scsi_disk(dev);
439
440 return sprintf(buf, "%s\n", zeroing_mode[sdkp->zeroing_mode]);
441}
442
443static ssize_t
444zeroing_mode_store(struct device *dev, struct device_attribute *attr,
445 const char *buf, size_t count)
446{
447 struct scsi_disk *sdkp = to_scsi_disk(dev);
448 int mode;
449
450 if (!capable(CAP_SYS_ADMIN))
451 return -EACCES;
452
453 mode = sysfs_match_string(zeroing_mode, buf);
454 if (mode < 0)
455 return -EINVAL;
456
457 sdkp->zeroing_mode = mode;
458
459 return count;
460}
461static DEVICE_ATTR_RW(zeroing_mode);
462
463static ssize_t
464max_medium_access_timeouts_show(struct device *dev,
465 struct device_attribute *attr, char *buf)
466{
467 struct scsi_disk *sdkp = to_scsi_disk(dev);
468
469 return sprintf(buf, "%u\n", sdkp->max_medium_access_timeouts);
470}
471
472static ssize_t
473max_medium_access_timeouts_store(struct device *dev,
474 struct device_attribute *attr, const char *buf,
475 size_t count)
476{
477 struct scsi_disk *sdkp = to_scsi_disk(dev);
478 int err;
479
480 if (!capable(CAP_SYS_ADMIN))
481 return -EACCES;
482
483 err = kstrtouint(buf, 10, &sdkp->max_medium_access_timeouts);
484
485 return err ? err : count;
486}
487static DEVICE_ATTR_RW(max_medium_access_timeouts);
488
489static ssize_t
490max_write_same_blocks_show(struct device *dev, struct device_attribute *attr,
491 char *buf)
492{
493 struct scsi_disk *sdkp = to_scsi_disk(dev);
494
495 return sprintf(buf, "%u\n", sdkp->max_ws_blocks);
496}
497
498static ssize_t
499max_write_same_blocks_store(struct device *dev, struct device_attribute *attr,
500 const char *buf, size_t count)
501{
502 struct scsi_disk *sdkp = to_scsi_disk(dev);
503 struct scsi_device *sdp = sdkp->device;
504 unsigned long max;
505 int err;
506
507 if (!capable(CAP_SYS_ADMIN))
508 return -EACCES;
509
510 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
511 return -EINVAL;
512
513 err = kstrtoul(buf, 10, &max);
514
515 if (err)
516 return err;
517
518 if (max == 0)
519 sdp->no_write_same = 1;
520 else if (max <= SD_MAX_WS16_BLOCKS) {
521 sdp->no_write_same = 0;
522 sdkp->max_ws_blocks = max;
523 }
524
525 sd_config_write_same(sdkp);
526
527 return count;
528}
529static DEVICE_ATTR_RW(max_write_same_blocks);
530
531static ssize_t
532zoned_cap_show(struct device *dev, struct device_attribute *attr, char *buf)
533{
534 struct scsi_disk *sdkp = to_scsi_disk(dev);
535
536 if (sdkp->device->type == TYPE_ZBC)
537 return sprintf(buf, "host-managed\n");
538 if (sdkp->zoned == 1)
539 return sprintf(buf, "host-aware\n");
540 if (sdkp->zoned == 2)
541 return sprintf(buf, "drive-managed\n");
542 return sprintf(buf, "none\n");
543}
544static DEVICE_ATTR_RO(zoned_cap);
545
546static struct attribute *sd_disk_attrs[] = {
547 &dev_attr_cache_type.attr,
548 &dev_attr_FUA.attr,
549 &dev_attr_allow_restart.attr,
550 &dev_attr_manage_start_stop.attr,
551 &dev_attr_protection_type.attr,
552 &dev_attr_protection_mode.attr,
553 &dev_attr_app_tag_own.attr,
554 &dev_attr_thin_provisioning.attr,
555 &dev_attr_provisioning_mode.attr,
556 &dev_attr_zeroing_mode.attr,
557 &dev_attr_max_write_same_blocks.attr,
558 &dev_attr_max_medium_access_timeouts.attr,
559 &dev_attr_zoned_cap.attr,
560 NULL,
561};
562ATTRIBUTE_GROUPS(sd_disk);
563
564static struct class sd_disk_class = {
565 .name = "scsi_disk",
566 .owner = THIS_MODULE,
567 .dev_release = scsi_disk_release,
568 .dev_groups = sd_disk_groups,
569};
570
571static const struct dev_pm_ops sd_pm_ops = {
572 .suspend = sd_suspend_system,
573 .resume = sd_resume,
574 .poweroff = sd_suspend_system,
575 .restore = sd_resume,
576 .runtime_suspend = sd_suspend_runtime,
577 .runtime_resume = sd_resume,
578};
579
580static struct scsi_driver sd_template = {
581 .gendrv = {
582 .name = "sd",
583 .owner = THIS_MODULE,
584 .probe = sd_probe,
585 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
586 .remove = sd_remove,
587 .shutdown = sd_shutdown,
588 .pm = &sd_pm_ops,
589 },
590 .rescan = sd_rescan,
591 .init_command = sd_init_command,
592 .uninit_command = sd_uninit_command,
593 .done = sd_done,
594 .eh_action = sd_eh_action,
595 .eh_reset = sd_eh_reset,
596};
597
598/*
599 * Dummy kobj_map->probe function.
600 * The default ->probe function will call modprobe, which is
601 * pointless as this module is already loaded.
602 */
603static struct kobject *sd_default_probe(dev_t devt, int *partno, void *data)
604{
605 return NULL;
606}
607
608/*
609 * Device no to disk mapping:
610 *
611 * major disc2 disc p1
612 * |............|.............|....|....| <- dev_t
613 * 31 20 19 8 7 4 3 0
614 *
615 * Inside a major, we have 16k disks, however mapped non-
616 * contiguously. The first 16 disks are for major0, the next
617 * ones with major1, ... Disk 256 is for major0 again, disk 272
618 * for major1, ...
619 * As we stay compatible with our numbering scheme, we can reuse
620 * the well-know SCSI majors 8, 65--71, 136--143.
621 */
622static int sd_major(int major_idx)
623{
624 switch (major_idx) {
625 case 0:
626 return SCSI_DISK0_MAJOR;
627 case 1 ... 7:
628 return SCSI_DISK1_MAJOR + major_idx - 1;
629 case 8 ... 15:
630 return SCSI_DISK8_MAJOR + major_idx - 8;
631 default:
632 BUG();
633 return 0; /* shut up gcc */
634 }
635}
636
637static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
638{
639 struct scsi_disk *sdkp = NULL;
640
641 mutex_lock(&sd_ref_mutex);
642
643 if (disk->private_data) {
644 sdkp = scsi_disk(disk);
645 if (scsi_device_get(sdkp->device) == 0)
646 get_device(&sdkp->dev);
647 else
648 sdkp = NULL;
649 }
650 mutex_unlock(&sd_ref_mutex);
651 return sdkp;
652}
653
654static void scsi_disk_put(struct scsi_disk *sdkp)
655{
656 struct scsi_device *sdev = sdkp->device;
657
658 mutex_lock(&sd_ref_mutex);
659 put_device(&sdkp->dev);
660 scsi_device_put(sdev);
661 mutex_unlock(&sd_ref_mutex);
662}
663
664#ifdef CONFIG_BLK_SED_OPAL
665static int sd_sec_submit(void *data, u16 spsp, u8 secp, void *buffer,
666 size_t len, bool send)
667{
668 struct scsi_device *sdev = data;
669 u8 cdb[12] = { 0, };
670 int ret;
671
672 cdb[0] = send ? SECURITY_PROTOCOL_OUT : SECURITY_PROTOCOL_IN;
673 cdb[1] = secp;
674 put_unaligned_be16(spsp, &cdb[2]);
675 put_unaligned_be32(len, &cdb[6]);
676
677 ret = scsi_execute_req(sdev, cdb,
678 send ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
679 buffer, len, NULL, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
680 return ret <= 0 ? ret : -EIO;
681}
682#endif /* CONFIG_BLK_SED_OPAL */
683
684/*
685 * Look up the DIX operation based on whether the command is read or
686 * write and whether dix and dif are enabled.
687 */
688static unsigned int sd_prot_op(bool write, bool dix, bool dif)
689{
690 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
691 static const unsigned int ops[] = { /* wrt dix dif */
692 SCSI_PROT_NORMAL, /* 0 0 0 */
693 SCSI_PROT_READ_STRIP, /* 0 0 1 */
694 SCSI_PROT_READ_INSERT, /* 0 1 0 */
695 SCSI_PROT_READ_PASS, /* 0 1 1 */
696 SCSI_PROT_NORMAL, /* 1 0 0 */
697 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
698 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
699 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
700 };
701
702 return ops[write << 2 | dix << 1 | dif];
703}
704
705/*
706 * Returns a mask of the protection flags that are valid for a given DIX
707 * operation.
708 */
709static unsigned int sd_prot_flag_mask(unsigned int prot_op)
710{
711 static const unsigned int flag_mask[] = {
712 [SCSI_PROT_NORMAL] = 0,
713
714 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
715 SCSI_PROT_GUARD_CHECK |
716 SCSI_PROT_REF_CHECK |
717 SCSI_PROT_REF_INCREMENT,
718
719 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
720 SCSI_PROT_IP_CHECKSUM,
721
722 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
723 SCSI_PROT_GUARD_CHECK |
724 SCSI_PROT_REF_CHECK |
725 SCSI_PROT_REF_INCREMENT |
726 SCSI_PROT_IP_CHECKSUM,
727
728 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
729 SCSI_PROT_REF_INCREMENT,
730
731 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
732 SCSI_PROT_REF_CHECK |
733 SCSI_PROT_REF_INCREMENT |
734 SCSI_PROT_IP_CHECKSUM,
735
736 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
737 SCSI_PROT_GUARD_CHECK |
738 SCSI_PROT_REF_CHECK |
739 SCSI_PROT_REF_INCREMENT |
740 SCSI_PROT_IP_CHECKSUM,
741 };
742
743 return flag_mask[prot_op];
744}
745
746static unsigned char sd_setup_protect_cmnd(struct scsi_cmnd *scmd,
747 unsigned int dix, unsigned int dif)
748{
749 struct bio *bio = scmd->request->bio;
750 unsigned int prot_op = sd_prot_op(rq_data_dir(scmd->request), dix, dif);
751 unsigned int protect = 0;
752
753 if (dix) { /* DIX Type 0, 1, 2, 3 */
754 if (bio_integrity_flagged(bio, BIP_IP_CHECKSUM))
755 scmd->prot_flags |= SCSI_PROT_IP_CHECKSUM;
756
757 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
758 scmd->prot_flags |= SCSI_PROT_GUARD_CHECK;
759 }
760
761 if (dif != T10_PI_TYPE3_PROTECTION) { /* DIX/DIF Type 0, 1, 2 */
762 scmd->prot_flags |= SCSI_PROT_REF_INCREMENT;
763
764 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
765 scmd->prot_flags |= SCSI_PROT_REF_CHECK;
766 }
767
768 if (dif) { /* DIX/DIF Type 1, 2, 3 */
769 scmd->prot_flags |= SCSI_PROT_TRANSFER_PI;
770
771 if (bio_integrity_flagged(bio, BIP_DISK_NOCHECK))
772 protect = 3 << 5; /* Disable target PI checking */
773 else
774 protect = 1 << 5; /* Enable target PI checking */
775 }
776
777 scsi_set_prot_op(scmd, prot_op);
778 scsi_set_prot_type(scmd, dif);
779 scmd->prot_flags &= sd_prot_flag_mask(prot_op);
780
781 return protect;
782}
783
784static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
785{
786 struct request_queue *q = sdkp->disk->queue;
787 unsigned int logical_block_size = sdkp->device->sector_size;
788 unsigned int max_blocks = 0;
789
790 q->limits.discard_alignment =
791 sdkp->unmap_alignment * logical_block_size;
792 q->limits.discard_granularity =
793 max(sdkp->physical_block_size,
794 sdkp->unmap_granularity * logical_block_size);
795 sdkp->provisioning_mode = mode;
796
797 switch (mode) {
798
799 case SD_LBP_FULL:
800 case SD_LBP_DISABLE:
801 blk_queue_max_discard_sectors(q, 0);
802 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
803 return;
804
805 case SD_LBP_UNMAP:
806 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
807 (u32)SD_MAX_WS16_BLOCKS);
808 break;
809
810 case SD_LBP_WS16:
811 if (sdkp->device->unmap_limit_for_ws)
812 max_blocks = sdkp->max_unmap_blocks;
813 else
814 max_blocks = sdkp->max_ws_blocks;
815
816 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS16_BLOCKS);
817 break;
818
819 case SD_LBP_WS10:
820 if (sdkp->device->unmap_limit_for_ws)
821 max_blocks = sdkp->max_unmap_blocks;
822 else
823 max_blocks = sdkp->max_ws_blocks;
824
825 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS10_BLOCKS);
826 break;
827
828 case SD_LBP_ZERO:
829 max_blocks = min_not_zero(sdkp->max_ws_blocks,
830 (u32)SD_MAX_WS10_BLOCKS);
831 break;
832 }
833
834 blk_queue_max_discard_sectors(q, max_blocks * (logical_block_size >> 9));
835 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
836}
837
838static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
839{
840 struct scsi_device *sdp = cmd->device;
841 struct request *rq = cmd->request;
842 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
843 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
844 unsigned int data_len = 24;
845 char *buf;
846
847 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
848 if (!rq->special_vec.bv_page)
849 return BLK_STS_RESOURCE;
850 clear_highpage(rq->special_vec.bv_page);
851 rq->special_vec.bv_offset = 0;
852 rq->special_vec.bv_len = data_len;
853 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
854
855 cmd->cmd_len = 10;
856 cmd->cmnd[0] = UNMAP;
857 cmd->cmnd[8] = 24;
858
859 buf = page_address(rq->special_vec.bv_page);
860 put_unaligned_be16(6 + 16, &buf[0]);
861 put_unaligned_be16(16, &buf[2]);
862 put_unaligned_be64(lba, &buf[8]);
863 put_unaligned_be32(nr_blocks, &buf[16]);
864
865 cmd->allowed = SD_MAX_RETRIES;
866 cmd->transfersize = data_len;
867 rq->timeout = SD_TIMEOUT;
868
869 return scsi_init_io(cmd);
870}
871
872static blk_status_t sd_setup_write_same16_cmnd(struct scsi_cmnd *cmd,
873 bool unmap)
874{
875 struct scsi_device *sdp = cmd->device;
876 struct request *rq = cmd->request;
877 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
878 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
879 u32 data_len = sdp->sector_size;
880
881 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
882 if (!rq->special_vec.bv_page)
883 return BLK_STS_RESOURCE;
884 clear_highpage(rq->special_vec.bv_page);
885 rq->special_vec.bv_offset = 0;
886 rq->special_vec.bv_len = data_len;
887 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
888
889 cmd->cmd_len = 16;
890 cmd->cmnd[0] = WRITE_SAME_16;
891 if (unmap)
892 cmd->cmnd[1] = 0x8; /* UNMAP */
893 put_unaligned_be64(lba, &cmd->cmnd[2]);
894 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
895
896 cmd->allowed = SD_MAX_RETRIES;
897 cmd->transfersize = data_len;
898 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
899
900 return scsi_init_io(cmd);
901}
902
903static blk_status_t sd_setup_write_same10_cmnd(struct scsi_cmnd *cmd,
904 bool unmap)
905{
906 struct scsi_device *sdp = cmd->device;
907 struct request *rq = cmd->request;
908 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
909 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
910 u32 data_len = sdp->sector_size;
911
912 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
913 if (!rq->special_vec.bv_page)
914 return BLK_STS_RESOURCE;
915 clear_highpage(rq->special_vec.bv_page);
916 rq->special_vec.bv_offset = 0;
917 rq->special_vec.bv_len = data_len;
918 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
919
920 cmd->cmd_len = 10;
921 cmd->cmnd[0] = WRITE_SAME;
922 if (unmap)
923 cmd->cmnd[1] = 0x8; /* UNMAP */
924 put_unaligned_be32(lba, &cmd->cmnd[2]);
925 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
926
927 cmd->allowed = SD_MAX_RETRIES;
928 cmd->transfersize = data_len;
929 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
930
931 return scsi_init_io(cmd);
932}
933
934static blk_status_t sd_setup_write_zeroes_cmnd(struct scsi_cmnd *cmd)
935{
936 struct request *rq = cmd->request;
937 struct scsi_device *sdp = cmd->device;
938 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
939 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
940 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
941
942 if (!(rq->cmd_flags & REQ_NOUNMAP)) {
943 switch (sdkp->zeroing_mode) {
944 case SD_ZERO_WS16_UNMAP:
945 return sd_setup_write_same16_cmnd(cmd, true);
946 case SD_ZERO_WS10_UNMAP:
947 return sd_setup_write_same10_cmnd(cmd, true);
948 }
949 }
950
951 if (sdp->no_write_same)
952 return BLK_STS_TARGET;
953
954 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff)
955 return sd_setup_write_same16_cmnd(cmd, false);
956
957 return sd_setup_write_same10_cmnd(cmd, false);
958}
959
960static void sd_config_write_same(struct scsi_disk *sdkp)
961{
962 struct request_queue *q = sdkp->disk->queue;
963 unsigned int logical_block_size = sdkp->device->sector_size;
964
965 if (sdkp->device->no_write_same) {
966 sdkp->max_ws_blocks = 0;
967 goto out;
968 }
969
970 /* Some devices can not handle block counts above 0xffff despite
971 * supporting WRITE SAME(16). Consequently we default to 64k
972 * blocks per I/O unless the device explicitly advertises a
973 * bigger limit.
974 */
975 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
976 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
977 (u32)SD_MAX_WS16_BLOCKS);
978 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
979 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
980 (u32)SD_MAX_WS10_BLOCKS);
981 else {
982 sdkp->device->no_write_same = 1;
983 sdkp->max_ws_blocks = 0;
984 }
985
986 if (sdkp->lbprz && sdkp->lbpws)
987 sdkp->zeroing_mode = SD_ZERO_WS16_UNMAP;
988 else if (sdkp->lbprz && sdkp->lbpws10)
989 sdkp->zeroing_mode = SD_ZERO_WS10_UNMAP;
990 else if (sdkp->max_ws_blocks)
991 sdkp->zeroing_mode = SD_ZERO_WS;
992 else
993 sdkp->zeroing_mode = SD_ZERO_WRITE;
994
995 if (sdkp->max_ws_blocks &&
996 sdkp->physical_block_size > logical_block_size) {
997 /*
998 * Reporting a maximum number of blocks that is not aligned
999 * on the device physical size would cause a large write same
1000 * request to be split into physically unaligned chunks by
1001 * __blkdev_issue_write_zeroes() and __blkdev_issue_write_same()
1002 * even if the caller of these functions took care to align the
1003 * large request. So make sure the maximum reported is aligned
1004 * to the device physical block size. This is only an optional
1005 * optimization for regular disks, but this is mandatory to
1006 * avoid failure of large write same requests directed at
1007 * sequential write required zones of host-managed ZBC disks.
1008 */
1009 sdkp->max_ws_blocks =
1010 round_down(sdkp->max_ws_blocks,
1011 bytes_to_logical(sdkp->device,
1012 sdkp->physical_block_size));
1013 }
1014
1015out:
1016 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
1017 (logical_block_size >> 9));
1018 blk_queue_max_write_zeroes_sectors(q, sdkp->max_ws_blocks *
1019 (logical_block_size >> 9));
1020}
1021
1022/**
1023 * sd_setup_write_same_cmnd - write the same data to multiple blocks
1024 * @cmd: command to prepare
1025 *
1026 * Will set up either WRITE SAME(10) or WRITE SAME(16) depending on
1027 * the preference indicated by the target device.
1028 **/
1029static blk_status_t sd_setup_write_same_cmnd(struct scsi_cmnd *cmd)
1030{
1031 struct request *rq = cmd->request;
1032 struct scsi_device *sdp = cmd->device;
1033 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1034 struct bio *bio = rq->bio;
1035 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1036 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
1037 blk_status_t ret;
1038
1039 if (sdkp->device->no_write_same)
1040 return BLK_STS_TARGET;
1041
1042 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
1043
1044 rq->timeout = SD_WRITE_SAME_TIMEOUT;
1045
1046 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff) {
1047 cmd->cmd_len = 16;
1048 cmd->cmnd[0] = WRITE_SAME_16;
1049 put_unaligned_be64(lba, &cmd->cmnd[2]);
1050 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1051 } else {
1052 cmd->cmd_len = 10;
1053 cmd->cmnd[0] = WRITE_SAME;
1054 put_unaligned_be32(lba, &cmd->cmnd[2]);
1055 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1056 }
1057
1058 cmd->transfersize = sdp->sector_size;
1059 cmd->allowed = SD_MAX_RETRIES;
1060
1061 /*
1062 * For WRITE SAME the data transferred via the DATA OUT buffer is
1063 * different from the amount of data actually written to the target.
1064 *
1065 * We set up __data_len to the amount of data transferred via the
1066 * DATA OUT buffer so that blk_rq_map_sg sets up the proper S/G list
1067 * to transfer a single sector of data first, but then reset it to
1068 * the amount of data to be written right after so that the I/O path
1069 * knows how much to actually write.
1070 */
1071 rq->__data_len = sdp->sector_size;
1072 ret = scsi_init_io(cmd);
1073 rq->__data_len = blk_rq_bytes(rq);
1074
1075 return ret;
1076}
1077
1078static blk_status_t sd_setup_flush_cmnd(struct scsi_cmnd *cmd)
1079{
1080 struct request *rq = cmd->request;
1081
1082 /* flush requests don't perform I/O, zero the S/G table */
1083 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1084
1085 cmd->cmnd[0] = SYNCHRONIZE_CACHE;
1086 cmd->cmd_len = 10;
1087 cmd->transfersize = 0;
1088 cmd->allowed = SD_MAX_RETRIES;
1089
1090 rq->timeout = rq->q->rq_timeout * SD_FLUSH_TIMEOUT_MULTIPLIER;
1091 return BLK_STS_OK;
1092}
1093
1094static blk_status_t sd_setup_rw32_cmnd(struct scsi_cmnd *cmd, bool write,
1095 sector_t lba, unsigned int nr_blocks,
1096 unsigned char flags)
1097{
1098 cmd->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1099 if (unlikely(cmd->cmnd == NULL))
1100 return BLK_STS_RESOURCE;
1101
1102 cmd->cmd_len = SD_EXT_CDB_SIZE;
1103 memset(cmd->cmnd, 0, cmd->cmd_len);
1104
1105 cmd->cmnd[0] = VARIABLE_LENGTH_CMD;
1106 cmd->cmnd[7] = 0x18; /* Additional CDB len */
1107 cmd->cmnd[9] = write ? WRITE_32 : READ_32;
1108 cmd->cmnd[10] = flags;
1109 put_unaligned_be64(lba, &cmd->cmnd[12]);
1110 put_unaligned_be32(lba, &cmd->cmnd[20]); /* Expected Indirect LBA */
1111 put_unaligned_be32(nr_blocks, &cmd->cmnd[28]);
1112
1113 return BLK_STS_OK;
1114}
1115
1116static blk_status_t sd_setup_rw16_cmnd(struct scsi_cmnd *cmd, bool write,
1117 sector_t lba, unsigned int nr_blocks,
1118 unsigned char flags)
1119{
1120 cmd->cmd_len = 16;
1121 cmd->cmnd[0] = write ? WRITE_16 : READ_16;
1122 cmd->cmnd[1] = flags;
1123 cmd->cmnd[14] = 0;
1124 cmd->cmnd[15] = 0;
1125 put_unaligned_be64(lba, &cmd->cmnd[2]);
1126 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1127
1128 return BLK_STS_OK;
1129}
1130
1131static blk_status_t sd_setup_rw10_cmnd(struct scsi_cmnd *cmd, bool write,
1132 sector_t lba, unsigned int nr_blocks,
1133 unsigned char flags)
1134{
1135 cmd->cmd_len = 10;
1136 cmd->cmnd[0] = write ? WRITE_10 : READ_10;
1137 cmd->cmnd[1] = flags;
1138 cmd->cmnd[6] = 0;
1139 cmd->cmnd[9] = 0;
1140 put_unaligned_be32(lba, &cmd->cmnd[2]);
1141 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1142
1143 return BLK_STS_OK;
1144}
1145
1146static blk_status_t sd_setup_rw6_cmnd(struct scsi_cmnd *cmd, bool write,
1147 sector_t lba, unsigned int nr_blocks,
1148 unsigned char flags)
1149{
1150 /* Avoid that 0 blocks gets translated into 256 blocks. */
1151 if (WARN_ON_ONCE(nr_blocks == 0))
1152 return BLK_STS_IOERR;
1153
1154 if (unlikely(flags & 0x8)) {
1155 /*
1156 * This happens only if this drive failed 10byte rw
1157 * command with ILLEGAL_REQUEST during operation and
1158 * thus turned off use_10_for_rw.
1159 */
1160 scmd_printk(KERN_ERR, cmd, "FUA write on READ/WRITE(6) drive\n");
1161 return BLK_STS_IOERR;
1162 }
1163
1164 cmd->cmd_len = 6;
1165 cmd->cmnd[0] = write ? WRITE_6 : READ_6;
1166 cmd->cmnd[1] = (lba >> 16) & 0x1f;
1167 cmd->cmnd[2] = (lba >> 8) & 0xff;
1168 cmd->cmnd[3] = lba & 0xff;
1169 cmd->cmnd[4] = nr_blocks;
1170 cmd->cmnd[5] = 0;
1171
1172 return BLK_STS_OK;
1173}
1174
1175static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *cmd)
1176{
1177 struct request *rq = cmd->request;
1178 struct scsi_device *sdp = cmd->device;
1179 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1180 sector_t lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1181 sector_t threshold;
1182 unsigned int nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
1183 unsigned int mask = logical_to_sectors(sdp, 1) - 1;
1184 bool write = rq_data_dir(rq) == WRITE;
1185 unsigned char protect, fua;
1186 blk_status_t ret;
1187 unsigned int dif;
1188 bool dix;
1189
1190 ret = scsi_init_io(cmd);
1191 if (ret != BLK_STS_OK)
1192 return ret;
1193
1194 if (!scsi_device_online(sdp) || sdp->changed) {
1195 scmd_printk(KERN_ERR, cmd, "device offline or changed\n");
1196 return BLK_STS_IOERR;
1197 }
1198
1199 if (blk_rq_pos(rq) + blk_rq_sectors(rq) > get_capacity(rq->rq_disk)) {
1200 scmd_printk(KERN_ERR, cmd, "access beyond end of device\n");
1201 return BLK_STS_IOERR;
1202 }
1203
1204 if ((blk_rq_pos(rq) & mask) || (blk_rq_sectors(rq) & mask)) {
1205 scmd_printk(KERN_ERR, cmd, "request not aligned to the logical block size\n");
1206 return BLK_STS_IOERR;
1207 }
1208
1209 /*
1210 * Some SD card readers can't handle accesses which touch the
1211 * last one or two logical blocks. Split accesses as needed.
1212 */
1213 threshold = sdkp->capacity - SD_LAST_BUGGY_SECTORS;
1214
1215 if (unlikely(sdp->last_sector_bug && lba + nr_blocks > threshold)) {
1216 if (lba < threshold) {
1217 /* Access up to the threshold but not beyond */
1218 nr_blocks = threshold - lba;
1219 } else {
1220 /* Access only a single logical block */
1221 nr_blocks = 1;
1222 }
1223 }
1224
1225 if (req_op(rq) == REQ_OP_ZONE_APPEND) {
1226 ret = sd_zbc_prepare_zone_append(cmd, &lba, nr_blocks);
1227 if (ret)
1228 return ret;
1229 }
1230
1231 fua = rq->cmd_flags & REQ_FUA ? 0x8 : 0;
1232 dix = scsi_prot_sg_count(cmd);
1233 dif = scsi_host_dif_capable(cmd->device->host, sdkp->protection_type);
1234
1235 if (dif || dix)
1236 protect = sd_setup_protect_cmnd(cmd, dix, dif);
1237 else
1238 protect = 0;
1239
1240 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
1241 ret = sd_setup_rw32_cmnd(cmd, write, lba, nr_blocks,
1242 protect | fua);
1243 } else if (sdp->use_16_for_rw || (nr_blocks > 0xffff)) {
1244 ret = sd_setup_rw16_cmnd(cmd, write, lba, nr_blocks,
1245 protect | fua);
1246 } else if ((nr_blocks > 0xff) || (lba > 0x1fffff) ||
1247 sdp->use_10_for_rw || protect) {
1248 ret = sd_setup_rw10_cmnd(cmd, write, lba, nr_blocks,
1249 protect | fua);
1250 } else {
1251 ret = sd_setup_rw6_cmnd(cmd, write, lba, nr_blocks,
1252 protect | fua);
1253 }
1254
1255 if (unlikely(ret != BLK_STS_OK))
1256 return ret;
1257
1258 /*
1259 * We shouldn't disconnect in the middle of a sector, so with a dumb
1260 * host adapter, it's safe to assume that we can at least transfer
1261 * this many bytes between each connect / disconnect.
1262 */
1263 cmd->transfersize = sdp->sector_size;
1264 cmd->underflow = nr_blocks << 9;
1265 cmd->allowed = SD_MAX_RETRIES;
1266 cmd->sdb.length = nr_blocks * sdp->sector_size;
1267
1268 SCSI_LOG_HLQUEUE(1,
1269 scmd_printk(KERN_INFO, cmd,
1270 "%s: block=%llu, count=%d\n", __func__,
1271 (unsigned long long)blk_rq_pos(rq),
1272 blk_rq_sectors(rq)));
1273 SCSI_LOG_HLQUEUE(2,
1274 scmd_printk(KERN_INFO, cmd,
1275 "%s %d/%u 512 byte blocks.\n",
1276 write ? "writing" : "reading", nr_blocks,
1277 blk_rq_sectors(rq)));
1278
1279 /*
1280 * This indicates that the command is ready from our end to be
1281 * queued.
1282 */
1283 return BLK_STS_OK;
1284}
1285
1286static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
1287{
1288 struct request *rq = cmd->request;
1289
1290 switch (req_op(rq)) {
1291 case REQ_OP_DISCARD:
1292 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1293 case SD_LBP_UNMAP:
1294 return sd_setup_unmap_cmnd(cmd);
1295 case SD_LBP_WS16:
1296 return sd_setup_write_same16_cmnd(cmd, true);
1297 case SD_LBP_WS10:
1298 return sd_setup_write_same10_cmnd(cmd, true);
1299 case SD_LBP_ZERO:
1300 return sd_setup_write_same10_cmnd(cmd, false);
1301 default:
1302 return BLK_STS_TARGET;
1303 }
1304 case REQ_OP_WRITE_ZEROES:
1305 return sd_setup_write_zeroes_cmnd(cmd);
1306 case REQ_OP_WRITE_SAME:
1307 return sd_setup_write_same_cmnd(cmd);
1308 case REQ_OP_FLUSH:
1309 return sd_setup_flush_cmnd(cmd);
1310 case REQ_OP_READ:
1311 case REQ_OP_WRITE:
1312 case REQ_OP_ZONE_APPEND:
1313 return sd_setup_read_write_cmnd(cmd);
1314 case REQ_OP_ZONE_RESET:
1315 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_RESET_WRITE_POINTER,
1316 false);
1317 case REQ_OP_ZONE_RESET_ALL:
1318 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_RESET_WRITE_POINTER,
1319 true);
1320 case REQ_OP_ZONE_OPEN:
1321 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_OPEN_ZONE, false);
1322 case REQ_OP_ZONE_CLOSE:
1323 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_CLOSE_ZONE, false);
1324 case REQ_OP_ZONE_FINISH:
1325 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_FINISH_ZONE, false);
1326 default:
1327 WARN_ON_ONCE(1);
1328 return BLK_STS_NOTSUPP;
1329 }
1330}
1331
1332static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1333{
1334 struct request *rq = SCpnt->request;
1335 u8 *cmnd;
1336
1337 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1338 mempool_free(rq->special_vec.bv_page, sd_page_pool);
1339
1340 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
1341 cmnd = SCpnt->cmnd;
1342 SCpnt->cmnd = NULL;
1343 SCpnt->cmd_len = 0;
1344 mempool_free(cmnd, sd_cdb_pool);
1345 }
1346}
1347
1348/**
1349 * sd_open - open a scsi disk device
1350 * @bdev: Block device of the scsi disk to open
1351 * @mode: FMODE_* mask
1352 *
1353 * Returns 0 if successful. Returns a negated errno value in case
1354 * of error.
1355 *
1356 * Note: This can be called from a user context (e.g. fsck(1) )
1357 * or from within the kernel (e.g. as a result of a mount(1) ).
1358 * In the latter case @inode and @filp carry an abridged amount
1359 * of information as noted above.
1360 *
1361 * Locking: called with bdev->bd_mutex held.
1362 **/
1363static int sd_open(struct block_device *bdev, fmode_t mode)
1364{
1365 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
1366 struct scsi_device *sdev;
1367 int retval;
1368
1369 if (!sdkp)
1370 return -ENXIO;
1371
1372 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1373
1374 sdev = sdkp->device;
1375
1376 /*
1377 * If the device is in error recovery, wait until it is done.
1378 * If the device is offline, then disallow any access to it.
1379 */
1380 retval = -ENXIO;
1381 if (!scsi_block_when_processing_errors(sdev))
1382 goto error_out;
1383
1384 if (sdev->removable || sdkp->write_prot)
1385 check_disk_change(bdev);
1386
1387 /*
1388 * If the drive is empty, just let the open fail.
1389 */
1390 retval = -ENOMEDIUM;
1391 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
1392 goto error_out;
1393
1394 /*
1395 * If the device has the write protect tab set, have the open fail
1396 * if the user expects to be able to write to the thing.
1397 */
1398 retval = -EROFS;
1399 if (sdkp->write_prot && (mode & FMODE_WRITE))
1400 goto error_out;
1401
1402 /*
1403 * It is possible that the disk changing stuff resulted in
1404 * the device being taken offline. If this is the case,
1405 * report this to the user, and don't pretend that the
1406 * open actually succeeded.
1407 */
1408 retval = -ENXIO;
1409 if (!scsi_device_online(sdev))
1410 goto error_out;
1411
1412 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
1413 if (scsi_block_when_processing_errors(sdev))
1414 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1415 }
1416
1417 return 0;
1418
1419error_out:
1420 scsi_disk_put(sdkp);
1421 return retval;
1422}
1423
1424/**
1425 * sd_release - invoked when the (last) close(2) is called on this
1426 * scsi disk.
1427 * @disk: disk to release
1428 * @mode: FMODE_* mask
1429 *
1430 * Returns 0.
1431 *
1432 * Note: may block (uninterruptible) if error recovery is underway
1433 * on this disk.
1434 *
1435 * Locking: called with bdev->bd_mutex held.
1436 **/
1437static void sd_release(struct gendisk *disk, fmode_t mode)
1438{
1439 struct scsi_disk *sdkp = scsi_disk(disk);
1440 struct scsi_device *sdev = sdkp->device;
1441
1442 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1443
1444 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1445 if (scsi_block_when_processing_errors(sdev))
1446 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1447 }
1448
1449 scsi_disk_put(sdkp);
1450}
1451
1452static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1453{
1454 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1455 struct scsi_device *sdp = sdkp->device;
1456 struct Scsi_Host *host = sdp->host;
1457 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
1458 int diskinfo[4];
1459
1460 /* default to most commonly used values */
1461 diskinfo[0] = 0x40; /* 1 << 6 */
1462 diskinfo[1] = 0x20; /* 1 << 5 */
1463 diskinfo[2] = capacity >> 11;
1464
1465 /* override with calculated, extended default, or driver values */
1466 if (host->hostt->bios_param)
1467 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
1468 else
1469 scsicam_bios_param(bdev, capacity, diskinfo);
1470
1471 geo->heads = diskinfo[0];
1472 geo->sectors = diskinfo[1];
1473 geo->cylinders = diskinfo[2];
1474 return 0;
1475}
1476
1477/**
1478 * sd_ioctl - process an ioctl
1479 * @bdev: target block device
1480 * @mode: FMODE_* mask
1481 * @cmd: ioctl command number
1482 * @p: this is third argument given to ioctl(2) system call.
1483 * Often contains a pointer.
1484 *
1485 * Returns 0 if successful (some ioctls return positive numbers on
1486 * success as well). Returns a negated errno value in case of error.
1487 *
1488 * Note: most ioctls are forward onto the block subsystem or further
1489 * down in the scsi subsystem.
1490 **/
1491static int sd_ioctl_common(struct block_device *bdev, fmode_t mode,
1492 unsigned int cmd, void __user *p)
1493{
1494 struct gendisk *disk = bdev->bd_disk;
1495 struct scsi_disk *sdkp = scsi_disk(disk);
1496 struct scsi_device *sdp = sdkp->device;
1497 int error;
1498
1499 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1500 "cmd=0x%x\n", disk->disk_name, cmd));
1501
1502 error = scsi_verify_blk_ioctl(bdev, cmd);
1503 if (error < 0)
1504 return error;
1505
1506 /*
1507 * If we are in the middle of error recovery, don't let anyone
1508 * else try and use this device. Also, if error recovery fails, it
1509 * may try and take the device offline, in which case all further
1510 * access to the device is prohibited.
1511 */
1512 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1513 (mode & FMODE_NDELAY) != 0);
1514 if (error)
1515 goto out;
1516
1517 if (is_sed_ioctl(cmd))
1518 return sed_ioctl(sdkp->opal_dev, cmd, p);
1519
1520 /*
1521 * Send SCSI addressing ioctls directly to mid level, send other
1522 * ioctls to block level and then onto mid level if they can't be
1523 * resolved.
1524 */
1525 switch (cmd) {
1526 case SCSI_IOCTL_GET_IDLUN:
1527 case SCSI_IOCTL_GET_BUS_NUMBER:
1528 error = scsi_ioctl(sdp, cmd, p);
1529 break;
1530 default:
1531 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
1532 break;
1533 }
1534out:
1535 return error;
1536}
1537
1538static void set_media_not_present(struct scsi_disk *sdkp)
1539{
1540 if (sdkp->media_present)
1541 sdkp->device->changed = 1;
1542
1543 if (sdkp->device->removable) {
1544 sdkp->media_present = 0;
1545 sdkp->capacity = 0;
1546 }
1547}
1548
1549static int media_not_present(struct scsi_disk *sdkp,
1550 struct scsi_sense_hdr *sshdr)
1551{
1552 if (!scsi_sense_valid(sshdr))
1553 return 0;
1554
1555 /* not invoked for commands that could return deferred errors */
1556 switch (sshdr->sense_key) {
1557 case UNIT_ATTENTION:
1558 case NOT_READY:
1559 /* medium not present */
1560 if (sshdr->asc == 0x3A) {
1561 set_media_not_present(sdkp);
1562 return 1;
1563 }
1564 }
1565 return 0;
1566}
1567
1568/**
1569 * sd_check_events - check media events
1570 * @disk: kernel device descriptor
1571 * @clearing: disk events currently being cleared
1572 *
1573 * Returns mask of DISK_EVENT_*.
1574 *
1575 * Note: this function is invoked from the block subsystem.
1576 **/
1577static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1578{
1579 struct scsi_disk *sdkp = scsi_disk_get(disk);
1580 struct scsi_device *sdp;
1581 int retval;
1582
1583 if (!sdkp)
1584 return 0;
1585
1586 sdp = sdkp->device;
1587 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1588
1589 /*
1590 * If the device is offline, don't send any commands - just pretend as
1591 * if the command failed. If the device ever comes back online, we
1592 * can deal with it then. It is only because of unrecoverable errors
1593 * that we would ever take a device offline in the first place.
1594 */
1595 if (!scsi_device_online(sdp)) {
1596 set_media_not_present(sdkp);
1597 goto out;
1598 }
1599
1600 /*
1601 * Using TEST_UNIT_READY enables differentiation between drive with
1602 * no cartridge loaded - NOT READY, drive with changed cartridge -
1603 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1604 *
1605 * Drives that auto spin down. eg iomega jaz 1G, will be started
1606 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1607 * sd_revalidate() is called.
1608 */
1609 if (scsi_block_when_processing_errors(sdp)) {
1610 struct scsi_sense_hdr sshdr = { 0, };
1611
1612 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
1613 &sshdr);
1614
1615 /* failed to execute TUR, assume media not present */
1616 if (host_byte(retval)) {
1617 set_media_not_present(sdkp);
1618 goto out;
1619 }
1620
1621 if (media_not_present(sdkp, &sshdr))
1622 goto out;
1623 }
1624
1625 /*
1626 * For removable scsi disk we have to recognise the presence
1627 * of a disk in the drive.
1628 */
1629 if (!sdkp->media_present)
1630 sdp->changed = 1;
1631 sdkp->media_present = 1;
1632out:
1633 /*
1634 * sdp->changed is set under the following conditions:
1635 *
1636 * Medium present state has changed in either direction.
1637 * Device has indicated UNIT_ATTENTION.
1638 */
1639 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1640 sdp->changed = 0;
1641 scsi_disk_put(sdkp);
1642 return retval;
1643}
1644
1645static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
1646{
1647 int retries, res;
1648 struct scsi_device *sdp = sdkp->device;
1649 const int timeout = sdp->request_queue->rq_timeout
1650 * SD_FLUSH_TIMEOUT_MULTIPLIER;
1651 struct scsi_sense_hdr my_sshdr;
1652
1653 if (!scsi_device_online(sdp))
1654 return -ENODEV;
1655
1656 /* caller might not be interested in sense, but we need it */
1657 if (!sshdr)
1658 sshdr = &my_sshdr;
1659
1660 for (retries = 3; retries > 0; --retries) {
1661 unsigned char cmd[10] = { 0 };
1662
1663 cmd[0] = SYNCHRONIZE_CACHE;
1664 /*
1665 * Leave the rest of the command zero to indicate
1666 * flush everything.
1667 */
1668 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
1669 timeout, SD_MAX_RETRIES, 0, RQF_PM, NULL);
1670 if (res == 0)
1671 break;
1672 }
1673
1674 if (res) {
1675 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
1676
1677 if (driver_byte(res) == DRIVER_SENSE)
1678 sd_print_sense_hdr(sdkp, sshdr);
1679
1680 /* we need to evaluate the error return */
1681 if (scsi_sense_valid(sshdr) &&
1682 (sshdr->asc == 0x3a || /* medium not present */
1683 sshdr->asc == 0x20 || /* invalid command */
1684 (sshdr->asc == 0x74 && sshdr->ascq == 0x71))) /* drive is password locked */
1685 /* this is no error here */
1686 return 0;
1687
1688 switch (host_byte(res)) {
1689 /* ignore errors due to racing a disconnection */
1690 case DID_BAD_TARGET:
1691 case DID_NO_CONNECT:
1692 return 0;
1693 /* signal the upper layer it might try again */
1694 case DID_BUS_BUSY:
1695 case DID_IMM_RETRY:
1696 case DID_REQUEUE:
1697 case DID_SOFT_ERROR:
1698 return -EBUSY;
1699 default:
1700 return -EIO;
1701 }
1702 }
1703 return 0;
1704}
1705
1706static void sd_rescan(struct device *dev)
1707{
1708 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1709
1710 revalidate_disk(sdkp->disk);
1711}
1712
1713static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1714 unsigned int cmd, unsigned long arg)
1715{
1716 void __user *p = (void __user *)arg;
1717 int ret;
1718
1719 ret = sd_ioctl_common(bdev, mode, cmd, p);
1720 if (ret != -ENOTTY)
1721 return ret;
1722
1723 return scsi_ioctl(scsi_disk(bdev->bd_disk)->device, cmd, p);
1724}
1725
1726#ifdef CONFIG_COMPAT
1727static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1728 unsigned int cmd, unsigned long arg)
1729{
1730 void __user *p = compat_ptr(arg);
1731 int ret;
1732
1733 ret = sd_ioctl_common(bdev, mode, cmd, p);
1734 if (ret != -ENOTTY)
1735 return ret;
1736
1737 return scsi_compat_ioctl(scsi_disk(bdev->bd_disk)->device, cmd, p);
1738}
1739#endif
1740
1741static char sd_pr_type(enum pr_type type)
1742{
1743 switch (type) {
1744 case PR_WRITE_EXCLUSIVE:
1745 return 0x01;
1746 case PR_EXCLUSIVE_ACCESS:
1747 return 0x03;
1748 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1749 return 0x05;
1750 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1751 return 0x06;
1752 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1753 return 0x07;
1754 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1755 return 0x08;
1756 default:
1757 return 0;
1758 }
1759};
1760
1761static int sd_pr_command(struct block_device *bdev, u8 sa,
1762 u64 key, u64 sa_key, u8 type, u8 flags)
1763{
1764 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1765 struct scsi_sense_hdr sshdr;
1766 int result;
1767 u8 cmd[16] = { 0, };
1768 u8 data[24] = { 0, };
1769
1770 cmd[0] = PERSISTENT_RESERVE_OUT;
1771 cmd[1] = sa;
1772 cmd[2] = type;
1773 put_unaligned_be32(sizeof(data), &cmd[5]);
1774
1775 put_unaligned_be64(key, &data[0]);
1776 put_unaligned_be64(sa_key, &data[8]);
1777 data[20] = flags;
1778
1779 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1780 &sshdr, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1781
1782 if (driver_byte(result) == DRIVER_SENSE &&
1783 scsi_sense_valid(&sshdr)) {
1784 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1785 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1786 }
1787
1788 return result;
1789}
1790
1791static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1792 u32 flags)
1793{
1794 if (flags & ~PR_FL_IGNORE_KEY)
1795 return -EOPNOTSUPP;
1796 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1797 old_key, new_key, 0,
1798 (1 << 0) /* APTPL */);
1799}
1800
1801static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1802 u32 flags)
1803{
1804 if (flags)
1805 return -EOPNOTSUPP;
1806 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1807}
1808
1809static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1810{
1811 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1812}
1813
1814static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1815 enum pr_type type, bool abort)
1816{
1817 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1818 sd_pr_type(type), 0);
1819}
1820
1821static int sd_pr_clear(struct block_device *bdev, u64 key)
1822{
1823 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1824}
1825
1826static const struct pr_ops sd_pr_ops = {
1827 .pr_register = sd_pr_register,
1828 .pr_reserve = sd_pr_reserve,
1829 .pr_release = sd_pr_release,
1830 .pr_preempt = sd_pr_preempt,
1831 .pr_clear = sd_pr_clear,
1832};
1833
1834static const struct block_device_operations sd_fops = {
1835 .owner = THIS_MODULE,
1836 .open = sd_open,
1837 .release = sd_release,
1838 .ioctl = sd_ioctl,
1839 .getgeo = sd_getgeo,
1840#ifdef CONFIG_COMPAT
1841 .compat_ioctl = sd_compat_ioctl,
1842#endif
1843 .check_events = sd_check_events,
1844 .revalidate_disk = sd_revalidate_disk,
1845 .unlock_native_capacity = sd_unlock_native_capacity,
1846 .report_zones = sd_zbc_report_zones,
1847 .pr_ops = &sd_pr_ops,
1848};
1849
1850/**
1851 * sd_eh_reset - reset error handling callback
1852 * @scmd: sd-issued command that has failed
1853 *
1854 * This function is called by the SCSI midlayer before starting
1855 * SCSI EH. When counting medium access failures we have to be
1856 * careful to register it only only once per device and SCSI EH run;
1857 * there might be several timed out commands which will cause the
1858 * 'max_medium_access_timeouts' counter to trigger after the first
1859 * SCSI EH run already and set the device to offline.
1860 * So this function resets the internal counter before starting SCSI EH.
1861 **/
1862static void sd_eh_reset(struct scsi_cmnd *scmd)
1863{
1864 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1865
1866 /* New SCSI EH run, reset gate variable */
1867 sdkp->ignore_medium_access_errors = false;
1868}
1869
1870/**
1871 * sd_eh_action - error handling callback
1872 * @scmd: sd-issued command that has failed
1873 * @eh_disp: The recovery disposition suggested by the midlayer
1874 *
1875 * This function is called by the SCSI midlayer upon completion of an
1876 * error test command (currently TEST UNIT READY). The result of sending
1877 * the eh command is passed in eh_disp. We're looking for devices that
1878 * fail medium access commands but are OK with non access commands like
1879 * test unit ready (so wrongly see the device as having a successful
1880 * recovery)
1881 **/
1882static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
1883{
1884 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1885 struct scsi_device *sdev = scmd->device;
1886
1887 if (!scsi_device_online(sdev) ||
1888 !scsi_medium_access_command(scmd) ||
1889 host_byte(scmd->result) != DID_TIME_OUT ||
1890 eh_disp != SUCCESS)
1891 return eh_disp;
1892
1893 /*
1894 * The device has timed out executing a medium access command.
1895 * However, the TEST UNIT READY command sent during error
1896 * handling completed successfully. Either the device is in the
1897 * process of recovering or has it suffered an internal failure
1898 * that prevents access to the storage medium.
1899 */
1900 if (!sdkp->ignore_medium_access_errors) {
1901 sdkp->medium_access_timed_out++;
1902 sdkp->ignore_medium_access_errors = true;
1903 }
1904
1905 /*
1906 * If the device keeps failing read/write commands but TEST UNIT
1907 * READY always completes successfully we assume that medium
1908 * access is no longer possible and take the device offline.
1909 */
1910 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1911 scmd_printk(KERN_ERR, scmd,
1912 "Medium access timeout failure. Offlining disk!\n");
1913 mutex_lock(&sdev->state_mutex);
1914 scsi_device_set_state(sdev, SDEV_OFFLINE);
1915 mutex_unlock(&sdev->state_mutex);
1916
1917 return SUCCESS;
1918 }
1919
1920 return eh_disp;
1921}
1922
1923static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1924{
1925 struct request *req = scmd->request;
1926 struct scsi_device *sdev = scmd->device;
1927 unsigned int transferred, good_bytes;
1928 u64 start_lba, end_lba, bad_lba;
1929
1930 /*
1931 * Some commands have a payload smaller than the device logical
1932 * block size (e.g. INQUIRY on a 4K disk).
1933 */
1934 if (scsi_bufflen(scmd) <= sdev->sector_size)
1935 return 0;
1936
1937 /* Check if we have a 'bad_lba' information */
1938 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
1939 SCSI_SENSE_BUFFERSIZE,
1940 &bad_lba))
1941 return 0;
1942
1943 /*
1944 * If the bad lba was reported incorrectly, we have no idea where
1945 * the error is.
1946 */
1947 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
1948 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
1949 if (bad_lba < start_lba || bad_lba >= end_lba)
1950 return 0;
1951
1952 /*
1953 * resid is optional but mostly filled in. When it's unused,
1954 * its value is zero, so we assume the whole buffer transferred
1955 */
1956 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1957
1958 /* This computation should always be done in terms of the
1959 * resolution of the device's medium.
1960 */
1961 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
1962
1963 return min(good_bytes, transferred);
1964}
1965
1966/**
1967 * sd_done - bottom half handler: called when the lower level
1968 * driver has completed (successfully or otherwise) a scsi command.
1969 * @SCpnt: mid-level's per command structure.
1970 *
1971 * Note: potentially run from within an ISR. Must not block.
1972 **/
1973static int sd_done(struct scsi_cmnd *SCpnt)
1974{
1975 int result = SCpnt->result;
1976 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1977 unsigned int sector_size = SCpnt->device->sector_size;
1978 unsigned int resid;
1979 struct scsi_sense_hdr sshdr;
1980 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
1981 struct request *req = SCpnt->request;
1982 int sense_valid = 0;
1983 int sense_deferred = 0;
1984
1985 switch (req_op(req)) {
1986 case REQ_OP_DISCARD:
1987 case REQ_OP_WRITE_ZEROES:
1988 case REQ_OP_WRITE_SAME:
1989 case REQ_OP_ZONE_RESET:
1990 case REQ_OP_ZONE_RESET_ALL:
1991 case REQ_OP_ZONE_OPEN:
1992 case REQ_OP_ZONE_CLOSE:
1993 case REQ_OP_ZONE_FINISH:
1994 if (!result) {
1995 good_bytes = blk_rq_bytes(req);
1996 scsi_set_resid(SCpnt, 0);
1997 } else {
1998 good_bytes = 0;
1999 scsi_set_resid(SCpnt, blk_rq_bytes(req));
2000 }
2001 break;
2002 default:
2003 /*
2004 * In case of bogus fw or device, we could end up having
2005 * an unaligned partial completion. Check this here and force
2006 * alignment.
2007 */
2008 resid = scsi_get_resid(SCpnt);
2009 if (resid & (sector_size - 1)) {
2010 sd_printk(KERN_INFO, sdkp,
2011 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
2012 resid, sector_size);
2013 scsi_print_command(SCpnt);
2014 resid = min(scsi_bufflen(SCpnt),
2015 round_up(resid, sector_size));
2016 scsi_set_resid(SCpnt, resid);
2017 }
2018 }
2019
2020 if (result) {
2021 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
2022 if (sense_valid)
2023 sense_deferred = scsi_sense_is_deferred(&sshdr);
2024 }
2025 sdkp->medium_access_timed_out = 0;
2026
2027 if (driver_byte(result) != DRIVER_SENSE &&
2028 (!sense_valid || sense_deferred))
2029 goto out;
2030
2031 switch (sshdr.sense_key) {
2032 case HARDWARE_ERROR:
2033 case MEDIUM_ERROR:
2034 good_bytes = sd_completed_bytes(SCpnt);
2035 break;
2036 case RECOVERED_ERROR:
2037 good_bytes = scsi_bufflen(SCpnt);
2038 break;
2039 case NO_SENSE:
2040 /* This indicates a false check condition, so ignore it. An
2041 * unknown amount of data was transferred so treat it as an
2042 * error.
2043 */
2044 SCpnt->result = 0;
2045 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2046 break;
2047 case ABORTED_COMMAND:
2048 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
2049 good_bytes = sd_completed_bytes(SCpnt);
2050 break;
2051 case ILLEGAL_REQUEST:
2052 switch (sshdr.asc) {
2053 case 0x10: /* DIX: Host detected corruption */
2054 good_bytes = sd_completed_bytes(SCpnt);
2055 break;
2056 case 0x20: /* INVALID COMMAND OPCODE */
2057 case 0x24: /* INVALID FIELD IN CDB */
2058 switch (SCpnt->cmnd[0]) {
2059 case UNMAP:
2060 sd_config_discard(sdkp, SD_LBP_DISABLE);
2061 break;
2062 case WRITE_SAME_16:
2063 case WRITE_SAME:
2064 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
2065 sd_config_discard(sdkp, SD_LBP_DISABLE);
2066 } else {
2067 sdkp->device->no_write_same = 1;
2068 sd_config_write_same(sdkp);
2069 req->rq_flags |= RQF_QUIET;
2070 }
2071 break;
2072 }
2073 }
2074 break;
2075 default:
2076 break;
2077 }
2078
2079 out:
2080 if (sd_is_zoned(sdkp))
2081 good_bytes = sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2082
2083 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2084 "sd_done: completed %d of %d bytes\n",
2085 good_bytes, scsi_bufflen(SCpnt)));
2086
2087 return good_bytes;
2088}
2089
2090/*
2091 * spinup disk - called only in sd_revalidate_disk()
2092 */
2093static void
2094sd_spinup_disk(struct scsi_disk *sdkp)
2095{
2096 unsigned char cmd[10];
2097 unsigned long spintime_expire = 0;
2098 int retries, spintime;
2099 unsigned int the_result;
2100 struct scsi_sense_hdr sshdr;
2101 int sense_valid = 0;
2102
2103 spintime = 0;
2104
2105 /* Spin up drives, as required. Only do this at boot time */
2106 /* Spinup needs to be done for module loads too. */
2107 do {
2108 retries = 0;
2109
2110 do {
2111 cmd[0] = TEST_UNIT_READY;
2112 memset((void *) &cmd[1], 0, 9);
2113
2114 the_result = scsi_execute_req(sdkp->device, cmd,
2115 DMA_NONE, NULL, 0,
2116 &sshdr, SD_TIMEOUT,
2117 SD_MAX_RETRIES, NULL);
2118
2119 /*
2120 * If the drive has indicated to us that it
2121 * doesn't have any media in it, don't bother
2122 * with any more polling.
2123 */
2124 if (media_not_present(sdkp, &sshdr))
2125 return;
2126
2127 if (the_result)
2128 sense_valid = scsi_sense_valid(&sshdr);
2129 retries++;
2130 } while (retries < 3 &&
2131 (!scsi_status_is_good(the_result) ||
2132 ((driver_byte(the_result) == DRIVER_SENSE) &&
2133 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2134
2135 if (driver_byte(the_result) != DRIVER_SENSE) {
2136 /* no sense, TUR either succeeded or failed
2137 * with a status error */
2138 if(!spintime && !scsi_status_is_good(the_result)) {
2139 sd_print_result(sdkp, "Test Unit Ready failed",
2140 the_result);
2141 }
2142 break;
2143 }
2144
2145 /*
2146 * The device does not want the automatic start to be issued.
2147 */
2148 if (sdkp->device->no_start_on_add)
2149 break;
2150
2151 if (sense_valid && sshdr.sense_key == NOT_READY) {
2152 if (sshdr.asc == 4 && sshdr.ascq == 3)
2153 break; /* manual intervention required */
2154 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2155 break; /* standby */
2156 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2157 break; /* unavailable */
2158 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2159 break; /* sanitize in progress */
2160 /*
2161 * Issue command to spin up drive when not ready
2162 */
2163 if (!spintime) {
2164 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
2165 cmd[0] = START_STOP;
2166 cmd[1] = 1; /* Return immediately */
2167 memset((void *) &cmd[2], 0, 8);
2168 cmd[4] = 1; /* Start spin cycle */
2169 if (sdkp->device->start_stop_pwr_cond)
2170 cmd[4] |= 1 << 4;
2171 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2172 NULL, 0, &sshdr,
2173 SD_TIMEOUT, SD_MAX_RETRIES,
2174 NULL);
2175 spintime_expire = jiffies + 100 * HZ;
2176 spintime = 1;
2177 }
2178 /* Wait 1 second for next try */
2179 msleep(1000);
2180 printk(KERN_CONT ".");
2181
2182 /*
2183 * Wait for USB flash devices with slow firmware.
2184 * Yes, this sense key/ASC combination shouldn't
2185 * occur here. It's characteristic of these devices.
2186 */
2187 } else if (sense_valid &&
2188 sshdr.sense_key == UNIT_ATTENTION &&
2189 sshdr.asc == 0x28) {
2190 if (!spintime) {
2191 spintime_expire = jiffies + 5 * HZ;
2192 spintime = 1;
2193 }
2194 /* Wait 1 second for next try */
2195 msleep(1000);
2196 } else {
2197 /* we don't understand the sense code, so it's
2198 * probably pointless to loop */
2199 if(!spintime) {
2200 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2201 sd_print_sense_hdr(sdkp, &sshdr);
2202 }
2203 break;
2204 }
2205
2206 } while (spintime && time_before_eq(jiffies, spintime_expire));
2207
2208 if (spintime) {
2209 if (scsi_status_is_good(the_result))
2210 printk(KERN_CONT "ready\n");
2211 else
2212 printk(KERN_CONT "not responding...\n");
2213 }
2214}
2215
2216/*
2217 * Determine whether disk supports Data Integrity Field.
2218 */
2219static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
2220{
2221 struct scsi_device *sdp = sdkp->device;
2222 u8 type;
2223 int ret = 0;
2224
2225 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0) {
2226 sdkp->protection_type = 0;
2227 return ret;
2228 }
2229
2230 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2231
2232 if (type > T10_PI_TYPE3_PROTECTION)
2233 ret = -ENODEV;
2234 else if (scsi_host_dif_capable(sdp->host, type))
2235 ret = 1;
2236
2237 if (sdkp->first_scan || type != sdkp->protection_type)
2238 switch (ret) {
2239 case -ENODEV:
2240 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2241 " protection type %u. Disabling disk!\n",
2242 type);
2243 break;
2244 case 1:
2245 sd_printk(KERN_NOTICE, sdkp,
2246 "Enabling DIF Type %u protection\n", type);
2247 break;
2248 case 0:
2249 sd_printk(KERN_NOTICE, sdkp,
2250 "Disabling DIF Type %u protection\n", type);
2251 break;
2252 }
2253
2254 sdkp->protection_type = type;
2255
2256 return ret;
2257}
2258
2259static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2260 struct scsi_sense_hdr *sshdr, int sense_valid,
2261 int the_result)
2262{
2263 if (driver_byte(the_result) == DRIVER_SENSE)
2264 sd_print_sense_hdr(sdkp, sshdr);
2265 else
2266 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2267
2268 /*
2269 * Set dirty bit for removable devices if not ready -
2270 * sometimes drives will not report this properly.
2271 */
2272 if (sdp->removable &&
2273 sense_valid && sshdr->sense_key == NOT_READY)
2274 set_media_not_present(sdkp);
2275
2276 /*
2277 * We used to set media_present to 0 here to indicate no media
2278 * in the drive, but some drives fail read capacity even with
2279 * media present, so we can't do that.
2280 */
2281 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2282}
2283
2284#define RC16_LEN 32
2285#if RC16_LEN > SD_BUF_SIZE
2286#error RC16_LEN must not be more than SD_BUF_SIZE
2287#endif
2288
2289#define READ_CAPACITY_RETRIES_ON_RESET 10
2290
2291static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2292 unsigned char *buffer)
2293{
2294 unsigned char cmd[16];
2295 struct scsi_sense_hdr sshdr;
2296 int sense_valid = 0;
2297 int the_result;
2298 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2299 unsigned int alignment;
2300 unsigned long long lba;
2301 unsigned sector_size;
2302
2303 if (sdp->no_read_capacity_16)
2304 return -EINVAL;
2305
2306 do {
2307 memset(cmd, 0, 16);
2308 cmd[0] = SERVICE_ACTION_IN_16;
2309 cmd[1] = SAI_READ_CAPACITY_16;
2310 cmd[13] = RC16_LEN;
2311 memset(buffer, 0, RC16_LEN);
2312
2313 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2314 buffer, RC16_LEN, &sshdr,
2315 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2316
2317 if (media_not_present(sdkp, &sshdr))
2318 return -ENODEV;
2319
2320 if (the_result) {
2321 sense_valid = scsi_sense_valid(&sshdr);
2322 if (sense_valid &&
2323 sshdr.sense_key == ILLEGAL_REQUEST &&
2324 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2325 sshdr.ascq == 0x00)
2326 /* Invalid Command Operation Code or
2327 * Invalid Field in CDB, just retry
2328 * silently with RC10 */
2329 return -EINVAL;
2330 if (sense_valid &&
2331 sshdr.sense_key == UNIT_ATTENTION &&
2332 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2333 /* Device reset might occur several times,
2334 * give it one more chance */
2335 if (--reset_retries > 0)
2336 continue;
2337 }
2338 retries--;
2339
2340 } while (the_result && retries);
2341
2342 if (the_result) {
2343 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
2344 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2345 return -EINVAL;
2346 }
2347
2348 sector_size = get_unaligned_be32(&buffer[8]);
2349 lba = get_unaligned_be64(&buffer[0]);
2350
2351 if (sd_read_protection_type(sdkp, buffer) < 0) {
2352 sdkp->capacity = 0;
2353 return -ENODEV;
2354 }
2355
2356 /* Logical blocks per physical block exponent */
2357 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
2358
2359 /* RC basis */
2360 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2361
2362 /* Lowest aligned logical block */
2363 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2364 blk_queue_alignment_offset(sdp->request_queue, alignment);
2365 if (alignment && sdkp->first_scan)
2366 sd_printk(KERN_NOTICE, sdkp,
2367 "physical block alignment offset: %u\n", alignment);
2368
2369 if (buffer[14] & 0x80) { /* LBPME */
2370 sdkp->lbpme = 1;
2371
2372 if (buffer[14] & 0x40) /* LBPRZ */
2373 sdkp->lbprz = 1;
2374
2375 sd_config_discard(sdkp, SD_LBP_WS16);
2376 }
2377
2378 sdkp->capacity = lba + 1;
2379 return sector_size;
2380}
2381
2382static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2383 unsigned char *buffer)
2384{
2385 unsigned char cmd[16];
2386 struct scsi_sense_hdr sshdr;
2387 int sense_valid = 0;
2388 int the_result;
2389 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2390 sector_t lba;
2391 unsigned sector_size;
2392
2393 do {
2394 cmd[0] = READ_CAPACITY;
2395 memset(&cmd[1], 0, 9);
2396 memset(buffer, 0, 8);
2397
2398 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2399 buffer, 8, &sshdr,
2400 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2401
2402 if (media_not_present(sdkp, &sshdr))
2403 return -ENODEV;
2404
2405 if (the_result) {
2406 sense_valid = scsi_sense_valid(&sshdr);
2407 if (sense_valid &&
2408 sshdr.sense_key == UNIT_ATTENTION &&
2409 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2410 /* Device reset might occur several times,
2411 * give it one more chance */
2412 if (--reset_retries > 0)
2413 continue;
2414 }
2415 retries--;
2416
2417 } while (the_result && retries);
2418
2419 if (the_result) {
2420 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
2421 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2422 return -EINVAL;
2423 }
2424
2425 sector_size = get_unaligned_be32(&buffer[4]);
2426 lba = get_unaligned_be32(&buffer[0]);
2427
2428 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2429 /* Some buggy (usb cardreader) devices return an lba of
2430 0xffffffff when the want to report a size of 0 (with
2431 which they really mean no media is present) */
2432 sdkp->capacity = 0;
2433 sdkp->physical_block_size = sector_size;
2434 return sector_size;
2435 }
2436
2437 sdkp->capacity = lba + 1;
2438 sdkp->physical_block_size = sector_size;
2439 return sector_size;
2440}
2441
2442static int sd_try_rc16_first(struct scsi_device *sdp)
2443{
2444 if (sdp->host->max_cmd_len < 16)
2445 return 0;
2446 if (sdp->try_rc_10_first)
2447 return 0;
2448 if (sdp->scsi_level > SCSI_SPC_2)
2449 return 1;
2450 if (scsi_device_protection(sdp))
2451 return 1;
2452 return 0;
2453}
2454
2455/*
2456 * read disk capacity
2457 */
2458static void
2459sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2460{
2461 int sector_size;
2462 struct scsi_device *sdp = sdkp->device;
2463
2464 if (sd_try_rc16_first(sdp)) {
2465 sector_size = read_capacity_16(sdkp, sdp, buffer);
2466 if (sector_size == -EOVERFLOW)
2467 goto got_data;
2468 if (sector_size == -ENODEV)
2469 return;
2470 if (sector_size < 0)
2471 sector_size = read_capacity_10(sdkp, sdp, buffer);
2472 if (sector_size < 0)
2473 return;
2474 } else {
2475 sector_size = read_capacity_10(sdkp, sdp, buffer);
2476 if (sector_size == -EOVERFLOW)
2477 goto got_data;
2478 if (sector_size < 0)
2479 return;
2480 if ((sizeof(sdkp->capacity) > 4) &&
2481 (sdkp->capacity > 0xffffffffULL)) {
2482 int old_sector_size = sector_size;
2483 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2484 "Trying to use READ CAPACITY(16).\n");
2485 sector_size = read_capacity_16(sdkp, sdp, buffer);
2486 if (sector_size < 0) {
2487 sd_printk(KERN_NOTICE, sdkp,
2488 "Using 0xffffffff as device size\n");
2489 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2490 sector_size = old_sector_size;
2491 goto got_data;
2492 }
2493 /* Remember that READ CAPACITY(16) succeeded */
2494 sdp->try_rc_10_first = 0;
2495 }
2496 }
2497
2498 /* Some devices are known to return the total number of blocks,
2499 * not the highest block number. Some devices have versions
2500 * which do this and others which do not. Some devices we might
2501 * suspect of doing this but we don't know for certain.
2502 *
2503 * If we know the reported capacity is wrong, decrement it. If
2504 * we can only guess, then assume the number of blocks is even
2505 * (usually true but not always) and err on the side of lowering
2506 * the capacity.
2507 */
2508 if (sdp->fix_capacity ||
2509 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2510 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2511 "from its reported value: %llu\n",
2512 (unsigned long long) sdkp->capacity);
2513 --sdkp->capacity;
2514 }
2515
2516got_data:
2517 if (sector_size == 0) {
2518 sector_size = 512;
2519 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2520 "assuming 512.\n");
2521 }
2522
2523 if (sector_size != 512 &&
2524 sector_size != 1024 &&
2525 sector_size != 2048 &&
2526 sector_size != 4096) {
2527 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2528 sector_size);
2529 /*
2530 * The user might want to re-format the drive with
2531 * a supported sectorsize. Once this happens, it
2532 * would be relatively trivial to set the thing up.
2533 * For this reason, we leave the thing in the table.
2534 */
2535 sdkp->capacity = 0;
2536 /*
2537 * set a bogus sector size so the normal read/write
2538 * logic in the block layer will eventually refuse any
2539 * request on this device without tripping over power
2540 * of two sector size assumptions
2541 */
2542 sector_size = 512;
2543 }
2544 blk_queue_logical_block_size(sdp->request_queue, sector_size);
2545 blk_queue_physical_block_size(sdp->request_queue,
2546 sdkp->physical_block_size);
2547 sdkp->device->sector_size = sector_size;
2548
2549 if (sdkp->capacity > 0xffffffff)
2550 sdp->use_16_for_rw = 1;
2551
2552}
2553
2554/*
2555 * Print disk capacity
2556 */
2557static void
2558sd_print_capacity(struct scsi_disk *sdkp,
2559 sector_t old_capacity)
2560{
2561 int sector_size = sdkp->device->sector_size;
2562 char cap_str_2[10], cap_str_10[10];
2563
2564 if (!sdkp->first_scan && old_capacity == sdkp->capacity)
2565 return;
2566
2567 string_get_size(sdkp->capacity, sector_size,
2568 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2569 string_get_size(sdkp->capacity, sector_size,
2570 STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));
2571
2572 sd_printk(KERN_NOTICE, sdkp,
2573 "%llu %d-byte logical blocks: (%s/%s)\n",
2574 (unsigned long long)sdkp->capacity,
2575 sector_size, cap_str_10, cap_str_2);
2576
2577 if (sdkp->physical_block_size != sector_size)
2578 sd_printk(KERN_NOTICE, sdkp,
2579 "%u-byte physical blocks\n",
2580 sdkp->physical_block_size);
2581}
2582
2583/* called with buffer of length 512 */
2584static inline int
2585sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2586 unsigned char *buffer, int len, struct scsi_mode_data *data,
2587 struct scsi_sense_hdr *sshdr)
2588{
2589 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
2590 SD_TIMEOUT, SD_MAX_RETRIES, data,
2591 sshdr);
2592}
2593
2594/*
2595 * read write protect setting, if possible - called only in sd_revalidate_disk()
2596 * called with buffer of length SD_BUF_SIZE
2597 */
2598static void
2599sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
2600{
2601 int res;
2602 struct scsi_device *sdp = sdkp->device;
2603 struct scsi_mode_data data;
2604 int old_wp = sdkp->write_prot;
2605
2606 set_disk_ro(sdkp->disk, 0);
2607 if (sdp->skip_ms_page_3f) {
2608 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
2609 return;
2610 }
2611
2612 if (sdp->use_192_bytes_for_3f) {
2613 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
2614 } else {
2615 /*
2616 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2617 * We have to start carefully: some devices hang if we ask
2618 * for more than is available.
2619 */
2620 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
2621
2622 /*
2623 * Second attempt: ask for page 0 When only page 0 is
2624 * implemented, a request for page 3F may return Sense Key
2625 * 5: Illegal Request, Sense Code 24: Invalid field in
2626 * CDB.
2627 */
2628 if (!scsi_status_is_good(res))
2629 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
2630
2631 /*
2632 * Third attempt: ask 255 bytes, as we did earlier.
2633 */
2634 if (!scsi_status_is_good(res))
2635 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2636 &data, NULL);
2637 }
2638
2639 if (!scsi_status_is_good(res)) {
2640 sd_first_printk(KERN_WARNING, sdkp,
2641 "Test WP failed, assume Write Enabled\n");
2642 } else {
2643 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
2644 set_disk_ro(sdkp->disk, sdkp->write_prot);
2645 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2646 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2647 sdkp->write_prot ? "on" : "off");
2648 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
2649 }
2650 }
2651}
2652
2653/*
2654 * sd_read_cache_type - called only from sd_revalidate_disk()
2655 * called with buffer of length SD_BUF_SIZE
2656 */
2657static void
2658sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
2659{
2660 int len = 0, res;
2661 struct scsi_device *sdp = sdkp->device;
2662
2663 int dbd;
2664 int modepage;
2665 int first_len;
2666 struct scsi_mode_data data;
2667 struct scsi_sense_hdr sshdr;
2668 int old_wce = sdkp->WCE;
2669 int old_rcd = sdkp->RCD;
2670 int old_dpofua = sdkp->DPOFUA;
2671
2672
2673 if (sdkp->cache_override)
2674 return;
2675
2676 first_len = 4;
2677 if (sdp->skip_ms_page_8) {
2678 if (sdp->type == TYPE_RBC)
2679 goto defaults;
2680 else {
2681 if (sdp->skip_ms_page_3f)
2682 goto defaults;
2683 modepage = 0x3F;
2684 if (sdp->use_192_bytes_for_3f)
2685 first_len = 192;
2686 dbd = 0;
2687 }
2688 } else if (sdp->type == TYPE_RBC) {
2689 modepage = 6;
2690 dbd = 8;
2691 } else {
2692 modepage = 8;
2693 dbd = 0;
2694 }
2695
2696 /* cautiously ask */
2697 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2698 &data, &sshdr);
2699
2700 if (!scsi_status_is_good(res))
2701 goto bad_sense;
2702
2703 if (!data.header_length) {
2704 modepage = 6;
2705 first_len = 0;
2706 sd_first_printk(KERN_ERR, sdkp,
2707 "Missing header in MODE_SENSE response\n");
2708 }
2709
2710 /* that went OK, now ask for the proper length */
2711 len = data.length;
2712
2713 /*
2714 * We're only interested in the first three bytes, actually.
2715 * But the data cache page is defined for the first 20.
2716 */
2717 if (len < 3)
2718 goto bad_sense;
2719 else if (len > SD_BUF_SIZE) {
2720 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
2721 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2722 len = SD_BUF_SIZE;
2723 }
2724 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2725 len = 192;
2726
2727 /* Get the data */
2728 if (len > first_len)
2729 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2730 &data, &sshdr);
2731
2732 if (scsi_status_is_good(res)) {
2733 int offset = data.header_length + data.block_descriptor_length;
2734
2735 while (offset < len) {
2736 u8 page_code = buffer[offset] & 0x3F;
2737 u8 spf = buffer[offset] & 0x40;
2738
2739 if (page_code == 8 || page_code == 6) {
2740 /* We're interested only in the first 3 bytes.
2741 */
2742 if (len - offset <= 2) {
2743 sd_first_printk(KERN_ERR, sdkp,
2744 "Incomplete mode parameter "
2745 "data\n");
2746 goto defaults;
2747 } else {
2748 modepage = page_code;
2749 goto Page_found;
2750 }
2751 } else {
2752 /* Go to the next page */
2753 if (spf && len - offset > 3)
2754 offset += 4 + (buffer[offset+2] << 8) +
2755 buffer[offset+3];
2756 else if (!spf && len - offset > 1)
2757 offset += 2 + buffer[offset+1];
2758 else {
2759 sd_first_printk(KERN_ERR, sdkp,
2760 "Incomplete mode "
2761 "parameter data\n");
2762 goto defaults;
2763 }
2764 }
2765 }
2766
2767 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
2768 goto defaults;
2769
2770 Page_found:
2771 if (modepage == 8) {
2772 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2773 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2774 } else {
2775 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2776 sdkp->RCD = 0;
2777 }
2778
2779 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
2780 if (sdp->broken_fua) {
2781 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2782 sdkp->DPOFUA = 0;
2783 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2784 !sdkp->device->use_16_for_rw) {
2785 sd_first_printk(KERN_NOTICE, sdkp,
2786 "Uses READ/WRITE(6), disabling FUA\n");
2787 sdkp->DPOFUA = 0;
2788 }
2789
2790 /* No cache flush allowed for write protected devices */
2791 if (sdkp->WCE && sdkp->write_prot)
2792 sdkp->WCE = 0;
2793
2794 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2795 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2796 sd_printk(KERN_NOTICE, sdkp,
2797 "Write cache: %s, read cache: %s, %s\n",
2798 sdkp->WCE ? "enabled" : "disabled",
2799 sdkp->RCD ? "disabled" : "enabled",
2800 sdkp->DPOFUA ? "supports DPO and FUA"
2801 : "doesn't support DPO or FUA");
2802
2803 return;
2804 }
2805
2806bad_sense:
2807 if (scsi_sense_valid(&sshdr) &&
2808 sshdr.sense_key == ILLEGAL_REQUEST &&
2809 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
2810 /* Invalid field in CDB */
2811 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
2812 else
2813 sd_first_printk(KERN_ERR, sdkp,
2814 "Asking for cache data failed\n");
2815
2816defaults:
2817 if (sdp->wce_default_on) {
2818 sd_first_printk(KERN_NOTICE, sdkp,
2819 "Assuming drive cache: write back\n");
2820 sdkp->WCE = 1;
2821 } else {
2822 sd_first_printk(KERN_ERR, sdkp,
2823 "Assuming drive cache: write through\n");
2824 sdkp->WCE = 0;
2825 }
2826 sdkp->RCD = 0;
2827 sdkp->DPOFUA = 0;
2828}
2829
2830/*
2831 * The ATO bit indicates whether the DIF application tag is available
2832 * for use by the operating system.
2833 */
2834static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
2835{
2836 int res, offset;
2837 struct scsi_device *sdp = sdkp->device;
2838 struct scsi_mode_data data;
2839 struct scsi_sense_hdr sshdr;
2840
2841 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
2842 return;
2843
2844 if (sdkp->protection_type == 0)
2845 return;
2846
2847 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2848 SD_MAX_RETRIES, &data, &sshdr);
2849
2850 if (!scsi_status_is_good(res) || !data.header_length ||
2851 data.length < 6) {
2852 sd_first_printk(KERN_WARNING, sdkp,
2853 "getting Control mode page failed, assume no ATO\n");
2854
2855 if (scsi_sense_valid(&sshdr))
2856 sd_print_sense_hdr(sdkp, &sshdr);
2857
2858 return;
2859 }
2860
2861 offset = data.header_length + data.block_descriptor_length;
2862
2863 if ((buffer[offset] & 0x3f) != 0x0a) {
2864 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
2865 return;
2866 }
2867
2868 if ((buffer[offset + 5] & 0x80) == 0)
2869 return;
2870
2871 sdkp->ATO = 1;
2872
2873 return;
2874}
2875
2876/**
2877 * sd_read_block_limits - Query disk device for preferred I/O sizes.
2878 * @sdkp: disk to query
2879 */
2880static void sd_read_block_limits(struct scsi_disk *sdkp)
2881{
2882 unsigned int sector_sz = sdkp->device->sector_size;
2883 const int vpd_len = 64;
2884 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
2885
2886 if (!buffer ||
2887 /* Block Limits VPD */
2888 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2889 goto out;
2890
2891 blk_queue_io_min(sdkp->disk->queue,
2892 get_unaligned_be16(&buffer[6]) * sector_sz);
2893
2894 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2895 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
2896
2897 if (buffer[3] == 0x3c) {
2898 unsigned int lba_count, desc_count;
2899
2900 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
2901
2902 if (!sdkp->lbpme)
2903 goto out;
2904
2905 lba_count = get_unaligned_be32(&buffer[20]);
2906 desc_count = get_unaligned_be32(&buffer[24]);
2907
2908 if (lba_count && desc_count)
2909 sdkp->max_unmap_blocks = lba_count;
2910
2911 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
2912
2913 if (buffer[32] & 0x80)
2914 sdkp->unmap_alignment =
2915 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
2916
2917 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2918
2919 if (sdkp->max_unmap_blocks)
2920 sd_config_discard(sdkp, SD_LBP_UNMAP);
2921 else
2922 sd_config_discard(sdkp, SD_LBP_WS16);
2923
2924 } else { /* LBP VPD page tells us what to use */
2925 if (sdkp->lbpu && sdkp->max_unmap_blocks)
2926 sd_config_discard(sdkp, SD_LBP_UNMAP);
2927 else if (sdkp->lbpws)
2928 sd_config_discard(sdkp, SD_LBP_WS16);
2929 else if (sdkp->lbpws10)
2930 sd_config_discard(sdkp, SD_LBP_WS10);
2931 else
2932 sd_config_discard(sdkp, SD_LBP_DISABLE);
2933 }
2934 }
2935
2936 out:
2937 kfree(buffer);
2938}
2939
2940/**
2941 * sd_read_block_characteristics - Query block dev. characteristics
2942 * @sdkp: disk to query
2943 */
2944static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2945{
2946 struct request_queue *q = sdkp->disk->queue;
2947 unsigned char *buffer;
2948 u16 rot;
2949 const int vpd_len = 64;
2950
2951 buffer = kmalloc(vpd_len, GFP_KERNEL);
2952
2953 if (!buffer ||
2954 /* Block Device Characteristics VPD */
2955 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2956 goto out;
2957
2958 rot = get_unaligned_be16(&buffer[4]);
2959
2960 if (rot == 1) {
2961 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
2962 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
2963 }
2964
2965 if (sdkp->device->type == TYPE_ZBC) {
2966 /* Host-managed */
2967 blk_queue_set_zoned(sdkp->disk, BLK_ZONED_HM);
2968 } else {
2969 sdkp->zoned = (buffer[8] >> 4) & 3;
2970 if (sdkp->zoned == 1) {
2971 /* Host-aware */
2972 blk_queue_set_zoned(sdkp->disk, BLK_ZONED_HA);
2973 } else {
2974 /* Regular disk or drive managed disk */
2975 blk_queue_set_zoned(sdkp->disk, BLK_ZONED_NONE);
2976 }
2977 }
2978
2979 if (!sdkp->first_scan)
2980 goto out;
2981
2982 if (blk_queue_is_zoned(q)) {
2983 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
2984 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
2985 } else {
2986 if (sdkp->zoned == 1)
2987 sd_printk(KERN_NOTICE, sdkp,
2988 "Host-aware SMR disk used as regular disk\n");
2989 else if (sdkp->zoned == 2)
2990 sd_printk(KERN_NOTICE, sdkp,
2991 "Drive-managed SMR disk\n");
2992 }
2993
2994 out:
2995 kfree(buffer);
2996}
2997
2998/**
2999 * sd_read_block_provisioning - Query provisioning VPD page
3000 * @sdkp: disk to query
3001 */
3002static void sd_read_block_provisioning(struct scsi_disk *sdkp)
3003{
3004 unsigned char *buffer;
3005 const int vpd_len = 8;
3006
3007 if (sdkp->lbpme == 0)
3008 return;
3009
3010 buffer = kmalloc(vpd_len, GFP_KERNEL);
3011
3012 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
3013 goto out;
3014
3015 sdkp->lbpvpd = 1;
3016 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
3017 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
3018 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
3019
3020 out:
3021 kfree(buffer);
3022}
3023
3024static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
3025{
3026 struct scsi_device *sdev = sdkp->device;
3027
3028 if (sdev->host->no_write_same) {
3029 sdev->no_write_same = 1;
3030
3031 return;
3032 }
3033
3034 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
3035 /* too large values might cause issues with arcmsr */
3036 int vpd_buf_len = 64;
3037
3038 sdev->no_report_opcodes = 1;
3039
3040 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3041 * CODES is unsupported and the device has an ATA
3042 * Information VPD page (SAT).
3043 */
3044 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
3045 sdev->no_write_same = 1;
3046 }
3047
3048 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
3049 sdkp->ws16 = 1;
3050
3051 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3052 sdkp->ws10 = 1;
3053}
3054
3055static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3056{
3057 struct scsi_device *sdev = sdkp->device;
3058
3059 if (!sdev->security_supported)
3060 return;
3061
3062 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3063 SECURITY_PROTOCOL_IN) == 1 &&
3064 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3065 SECURITY_PROTOCOL_OUT) == 1)
3066 sdkp->security = 1;
3067}
3068
3069/*
3070 * Determine the device's preferred I/O size for reads and writes
3071 * unless the reported value is unreasonably small, large, not a
3072 * multiple of the physical block size, or simply garbage.
3073 */
3074static bool sd_validate_opt_xfer_size(struct scsi_disk *sdkp,
3075 unsigned int dev_max)
3076{
3077 struct scsi_device *sdp = sdkp->device;
3078 unsigned int opt_xfer_bytes =
3079 logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3080
3081 if (sdkp->opt_xfer_blocks == 0)
3082 return false;
3083
3084 if (sdkp->opt_xfer_blocks > dev_max) {
3085 sd_first_printk(KERN_WARNING, sdkp,
3086 "Optimal transfer size %u logical blocks " \
3087 "> dev_max (%u logical blocks)\n",
3088 sdkp->opt_xfer_blocks, dev_max);
3089 return false;
3090 }
3091
3092 if (sdkp->opt_xfer_blocks > SD_DEF_XFER_BLOCKS) {
3093 sd_first_printk(KERN_WARNING, sdkp,
3094 "Optimal transfer size %u logical blocks " \
3095 "> sd driver limit (%u logical blocks)\n",
3096 sdkp->opt_xfer_blocks, SD_DEF_XFER_BLOCKS);
3097 return false;
3098 }
3099
3100 if (opt_xfer_bytes < PAGE_SIZE) {
3101 sd_first_printk(KERN_WARNING, sdkp,
3102 "Optimal transfer size %u bytes < " \
3103 "PAGE_SIZE (%u bytes)\n",
3104 opt_xfer_bytes, (unsigned int)PAGE_SIZE);
3105 return false;
3106 }
3107
3108 if (opt_xfer_bytes & (sdkp->physical_block_size - 1)) {
3109 sd_first_printk(KERN_WARNING, sdkp,
3110 "Optimal transfer size %u bytes not a " \
3111 "multiple of physical block size (%u bytes)\n",
3112 opt_xfer_bytes, sdkp->physical_block_size);
3113 return false;
3114 }
3115
3116 sd_first_printk(KERN_INFO, sdkp, "Optimal transfer size %u bytes\n",
3117 opt_xfer_bytes);
3118 return true;
3119}
3120
3121/**
3122 * sd_revalidate_disk - called the first time a new disk is seen,
3123 * performs disk spin up, read_capacity, etc.
3124 * @disk: struct gendisk we care about
3125 **/
3126static int sd_revalidate_disk(struct gendisk *disk)
3127{
3128 struct scsi_disk *sdkp = scsi_disk(disk);
3129 struct scsi_device *sdp = sdkp->device;
3130 struct request_queue *q = sdkp->disk->queue;
3131 sector_t old_capacity = sdkp->capacity;
3132 unsigned char *buffer;
3133 unsigned int dev_max, rw_max;
3134
3135 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3136 "sd_revalidate_disk\n"));
3137
3138 /*
3139 * If the device is offline, don't try and read capacity or any
3140 * of the other niceties.
3141 */
3142 if (!scsi_device_online(sdp))
3143 goto out;
3144
3145 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
3146 if (!buffer) {
3147 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3148 "allocation failure.\n");
3149 goto out;
3150 }
3151
3152 sd_spinup_disk(sdkp);
3153
3154 /*
3155 * Without media there is no reason to ask; moreover, some devices
3156 * react badly if we do.
3157 */
3158 if (sdkp->media_present) {
3159 sd_read_capacity(sdkp, buffer);
3160
3161 /*
3162 * set the default to rotational. All non-rotational devices
3163 * support the block characteristics VPD page, which will
3164 * cause this to be updated correctly and any device which
3165 * doesn't support it should be treated as rotational.
3166 */
3167 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
3168 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
3169
3170 if (scsi_device_supports_vpd(sdp)) {
3171 sd_read_block_provisioning(sdkp);
3172 sd_read_block_limits(sdkp);
3173 sd_read_block_characteristics(sdkp);
3174 sd_zbc_read_zones(sdkp, buffer);
3175 }
3176
3177 sd_print_capacity(sdkp, old_capacity);
3178
3179 sd_read_write_protect_flag(sdkp, buffer);
3180 sd_read_cache_type(sdkp, buffer);
3181 sd_read_app_tag_own(sdkp, buffer);
3182 sd_read_write_same(sdkp, buffer);
3183 sd_read_security(sdkp, buffer);
3184 }
3185
3186 /*
3187 * We now have all cache related info, determine how we deal
3188 * with flush requests.
3189 */
3190 sd_set_flush_flag(sdkp);
3191
3192 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3193 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
3194
3195 /* Some devices report a maximum block count for READ/WRITE requests. */
3196 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3197 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3198
3199 if (sd_validate_opt_xfer_size(sdkp, dev_max)) {
3200 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3201 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3202 } else {
3203 q->limits.io_opt = 0;
3204 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3205 (sector_t)BLK_DEF_MAX_SECTORS);
3206 }
3207
3208 /* Do not exceed controller limit */
3209 rw_max = min(rw_max, queue_max_hw_sectors(q));
3210
3211 /*
3212 * Only update max_sectors if previously unset or if the current value
3213 * exceeds the capabilities of the hardware.
3214 */
3215 if (sdkp->first_scan ||
3216 q->limits.max_sectors > q->limits.max_dev_sectors ||
3217 q->limits.max_sectors > q->limits.max_hw_sectors)
3218 q->limits.max_sectors = rw_max;
3219
3220 sdkp->first_scan = 0;
3221
3222 set_capacity_revalidate_and_notify(disk,
3223 logical_to_sectors(sdp, sdkp->capacity), false);
3224 sd_config_write_same(sdkp);
3225 kfree(buffer);
3226
3227 /*
3228 * For a zoned drive, revalidating the zones can be done only once
3229 * the gendisk capacity is set. So if this fails, set back the gendisk
3230 * capacity to 0.
3231 */
3232 if (sd_zbc_revalidate_zones(sdkp))
3233 set_capacity_revalidate_and_notify(disk, 0, false);
3234
3235 out:
3236 return 0;
3237}
3238
3239/**
3240 * sd_unlock_native_capacity - unlock native capacity
3241 * @disk: struct gendisk to set capacity for
3242 *
3243 * Block layer calls this function if it detects that partitions
3244 * on @disk reach beyond the end of the device. If the SCSI host
3245 * implements ->unlock_native_capacity() method, it's invoked to
3246 * give it a chance to adjust the device capacity.
3247 *
3248 * CONTEXT:
3249 * Defined by block layer. Might sleep.
3250 */
3251static void sd_unlock_native_capacity(struct gendisk *disk)
3252{
3253 struct scsi_device *sdev = scsi_disk(disk)->device;
3254
3255 if (sdev->host->hostt->unlock_native_capacity)
3256 sdev->host->hostt->unlock_native_capacity(sdev);
3257}
3258
3259/**
3260 * sd_format_disk_name - format disk name
3261 * @prefix: name prefix - ie. "sd" for SCSI disks
3262 * @index: index of the disk to format name for
3263 * @buf: output buffer
3264 * @buflen: length of the output buffer
3265 *
3266 * SCSI disk names starts at sda. The 26th device is sdz and the
3267 * 27th is sdaa. The last one for two lettered suffix is sdzz
3268 * which is followed by sdaaa.
3269 *
3270 * This is basically 26 base counting with one extra 'nil' entry
3271 * at the beginning from the second digit on and can be
3272 * determined using similar method as 26 base conversion with the
3273 * index shifted -1 after each digit is computed.
3274 *
3275 * CONTEXT:
3276 * Don't care.
3277 *
3278 * RETURNS:
3279 * 0 on success, -errno on failure.
3280 */
3281static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3282{
3283 const int base = 'z' - 'a' + 1;
3284 char *begin = buf + strlen(prefix);
3285 char *end = buf + buflen;
3286 char *p;
3287 int unit;
3288
3289 p = end - 1;
3290 *p = '\0';
3291 unit = base;
3292 do {
3293 if (p == begin)
3294 return -EINVAL;
3295 *--p = 'a' + (index % unit);
3296 index = (index / unit) - 1;
3297 } while (index >= 0);
3298
3299 memmove(begin, p, end - p);
3300 memcpy(buf, prefix, strlen(prefix));
3301
3302 return 0;
3303}
3304
3305/**
3306 * sd_probe - called during driver initialization and whenever a
3307 * new scsi device is attached to the system. It is called once
3308 * for each scsi device (not just disks) present.
3309 * @dev: pointer to device object
3310 *
3311 * Returns 0 if successful (or not interested in this scsi device
3312 * (e.g. scanner)); 1 when there is an error.
3313 *
3314 * Note: this function is invoked from the scsi mid-level.
3315 * This function sets up the mapping between a given
3316 * <host,channel,id,lun> (found in sdp) and new device name
3317 * (e.g. /dev/sda). More precisely it is the block device major
3318 * and minor number that is chosen here.
3319 *
3320 * Assume sd_probe is not re-entrant (for time being)
3321 * Also think about sd_probe() and sd_remove() running coincidentally.
3322 **/
3323static int sd_probe(struct device *dev)
3324{
3325 struct scsi_device *sdp = to_scsi_device(dev);
3326 struct scsi_disk *sdkp;
3327 struct gendisk *gd;
3328 int index;
3329 int error;
3330
3331 scsi_autopm_get_device(sdp);
3332 error = -ENODEV;
3333 if (sdp->type != TYPE_DISK &&
3334 sdp->type != TYPE_ZBC &&
3335 sdp->type != TYPE_MOD &&
3336 sdp->type != TYPE_RBC)
3337 goto out;
3338
3339#ifndef CONFIG_BLK_DEV_ZONED
3340 if (sdp->type == TYPE_ZBC)
3341 goto out;
3342#endif
3343 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
3344 "sd_probe\n"));
3345
3346 error = -ENOMEM;
3347 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
3348 if (!sdkp)
3349 goto out;
3350
3351 gd = alloc_disk(SD_MINORS);
3352 if (!gd)
3353 goto out_free;
3354
3355 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3356 if (index < 0) {
3357 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
3358 goto out_put;
3359 }
3360
3361 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
3362 if (error) {
3363 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
3364 goto out_free_index;
3365 }
3366
3367 sdkp->device = sdp;
3368 sdkp->driver = &sd_template;
3369 sdkp->disk = gd;
3370 sdkp->index = index;
3371 atomic_set(&sdkp->openers, 0);
3372 atomic_set(&sdkp->device->ioerr_cnt, 0);
3373
3374 if (!sdp->request_queue->rq_timeout) {
3375 if (sdp->type != TYPE_MOD)
3376 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3377 else
3378 blk_queue_rq_timeout(sdp->request_queue,
3379 SD_MOD_TIMEOUT);
3380 }
3381
3382 device_initialize(&sdkp->dev);
3383 sdkp->dev.parent = dev;
3384 sdkp->dev.class = &sd_disk_class;
3385 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
3386
3387 error = device_add(&sdkp->dev);
3388 if (error)
3389 goto out_free_index;
3390
3391 get_device(dev);
3392 dev_set_drvdata(dev, sdkp);
3393
3394 gd->major = sd_major((index & 0xf0) >> 4);
3395 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
3396
3397 gd->fops = &sd_fops;
3398 gd->private_data = &sdkp->driver;
3399 gd->queue = sdkp->device->request_queue;
3400
3401 /* defaults, until the device tells us otherwise */
3402 sdp->sector_size = 512;
3403 sdkp->capacity = 0;
3404 sdkp->media_present = 1;
3405 sdkp->write_prot = 0;
3406 sdkp->cache_override = 0;
3407 sdkp->WCE = 0;
3408 sdkp->RCD = 0;
3409 sdkp->ATO = 0;
3410 sdkp->first_scan = 1;
3411 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
3412
3413 sd_revalidate_disk(gd);
3414
3415 gd->flags = GENHD_FL_EXT_DEVT;
3416 if (sdp->removable) {
3417 gd->flags |= GENHD_FL_REMOVABLE;
3418 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3419 gd->event_flags = DISK_EVENT_FLAG_POLL | DISK_EVENT_FLAG_UEVENT;
3420 }
3421
3422 blk_pm_runtime_init(sdp->request_queue, dev);
3423 if (sdp->rpm_autosuspend) {
3424 pm_runtime_set_autosuspend_delay(dev,
3425 sdp->host->hostt->rpm_autosuspend_delay);
3426 }
3427 device_add_disk(dev, gd, NULL);
3428 if (sdkp->capacity)
3429 sd_dif_config_host(sdkp);
3430
3431 sd_revalidate_disk(gd);
3432
3433 if (sdkp->security) {
3434 sdkp->opal_dev = init_opal_dev(sdp, &sd_sec_submit);
3435 if (sdkp->opal_dev)
3436 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3437 }
3438
3439 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3440 sdp->removable ? "removable " : "");
3441 scsi_autopm_put_device(sdp);
3442
3443 return 0;
3444
3445 out_free_index:
3446 ida_free(&sd_index_ida, index);
3447 out_put:
3448 put_disk(gd);
3449 out_free:
3450 sd_zbc_release_disk(sdkp);
3451 kfree(sdkp);
3452 out:
3453 scsi_autopm_put_device(sdp);
3454 return error;
3455}
3456
3457/**
3458 * sd_remove - called whenever a scsi disk (previously recognized by
3459 * sd_probe) is detached from the system. It is called (potentially
3460 * multiple times) during sd module unload.
3461 * @dev: pointer to device object
3462 *
3463 * Note: this function is invoked from the scsi mid-level.
3464 * This function potentially frees up a device name (e.g. /dev/sdc)
3465 * that could be re-used by a subsequent sd_probe().
3466 * This function is not called when the built-in sd driver is "exit-ed".
3467 **/
3468static int sd_remove(struct device *dev)
3469{
3470 struct scsi_disk *sdkp;
3471 dev_t devt;
3472
3473 sdkp = dev_get_drvdata(dev);
3474 devt = disk_devt(sdkp->disk);
3475 scsi_autopm_get_device(sdkp->device);
3476
3477 async_synchronize_full_domain(&scsi_sd_pm_domain);
3478 device_del(&sdkp->dev);
3479 del_gendisk(sdkp->disk);
3480 sd_shutdown(dev);
3481
3482 free_opal_dev(sdkp->opal_dev);
3483
3484 blk_register_region(devt, SD_MINORS, NULL,
3485 sd_default_probe, NULL, NULL);
3486
3487 mutex_lock(&sd_ref_mutex);
3488 dev_set_drvdata(dev, NULL);
3489 put_device(&sdkp->dev);
3490 mutex_unlock(&sd_ref_mutex);
3491
3492 return 0;
3493}
3494
3495/**
3496 * scsi_disk_release - Called to free the scsi_disk structure
3497 * @dev: pointer to embedded class device
3498 *
3499 * sd_ref_mutex must be held entering this routine. Because it is
3500 * called on last put, you should always use the scsi_disk_get()
3501 * scsi_disk_put() helpers which manipulate the semaphore directly
3502 * and never do a direct put_device.
3503 **/
3504static void scsi_disk_release(struct device *dev)
3505{
3506 struct scsi_disk *sdkp = to_scsi_disk(dev);
3507 struct gendisk *disk = sdkp->disk;
3508 struct request_queue *q = disk->queue;
3509
3510 ida_free(&sd_index_ida, sdkp->index);
3511
3512 /*
3513 * Wait until all requests that are in progress have completed.
3514 * This is necessary to avoid that e.g. scsi_end_request() crashes
3515 * due to clearing the disk->private_data pointer. Wait from inside
3516 * scsi_disk_release() instead of from sd_release() to avoid that
3517 * freezing and unfreezing the request queue affects user space I/O
3518 * in case multiple processes open a /dev/sd... node concurrently.
3519 */
3520 blk_mq_freeze_queue(q);
3521 blk_mq_unfreeze_queue(q);
3522
3523 disk->private_data = NULL;
3524 put_disk(disk);
3525 put_device(&sdkp->device->sdev_gendev);
3526
3527 sd_zbc_release_disk(sdkp);
3528
3529 kfree(sdkp);
3530}
3531
3532static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
3533{
3534 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3535 struct scsi_sense_hdr sshdr;
3536 struct scsi_device *sdp = sdkp->device;
3537 int res;
3538
3539 if (start)
3540 cmd[4] |= 1; /* START */
3541
3542 if (sdp->start_stop_pwr_cond)
3543 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3544
3545 if (!scsi_device_online(sdp))
3546 return -ENODEV;
3547
3548 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3549 SD_TIMEOUT, SD_MAX_RETRIES, 0, RQF_PM, NULL);
3550 if (res) {
3551 sd_print_result(sdkp, "Start/Stop Unit failed", res);
3552 if (driver_byte(res) == DRIVER_SENSE)
3553 sd_print_sense_hdr(sdkp, &sshdr);
3554 if (scsi_sense_valid(&sshdr) &&
3555 /* 0x3a is medium not present */
3556 sshdr.asc == 0x3a)
3557 res = 0;
3558 }
3559
3560 /* SCSI error codes must not go to the generic layer */
3561 if (res)
3562 return -EIO;
3563
3564 return 0;
3565}
3566
3567/*
3568 * Send a SYNCHRONIZE CACHE instruction down to the device through
3569 * the normal SCSI command structure. Wait for the command to
3570 * complete.
3571 */
3572static void sd_shutdown(struct device *dev)
3573{
3574 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3575
3576 if (!sdkp)
3577 return; /* this can happen */
3578
3579 if (pm_runtime_suspended(dev))
3580 return;
3581
3582 if (sdkp->WCE && sdkp->media_present) {
3583 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3584 sd_sync_cache(sdkp, NULL);
3585 }
3586
3587 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3588 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3589 sd_start_stop_device(sdkp, 0);
3590 }
3591}
3592
3593static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
3594{
3595 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3596 struct scsi_sense_hdr sshdr;
3597 int ret = 0;
3598
3599 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3600 return 0;
3601
3602 if (sdkp->WCE && sdkp->media_present) {
3603 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3604 ret = sd_sync_cache(sdkp, &sshdr);
3605
3606 if (ret) {
3607 /* ignore OFFLINE device */
3608 if (ret == -ENODEV)
3609 return 0;
3610
3611 if (!scsi_sense_valid(&sshdr) ||
3612 sshdr.sense_key != ILLEGAL_REQUEST)
3613 return ret;
3614
3615 /*
3616 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3617 * doesn't support sync. There's not much to do and
3618 * suspend shouldn't fail.
3619 */
3620 ret = 0;
3621 }
3622 }
3623
3624 if (sdkp->device->manage_start_stop) {
3625 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3626 /* an error is not worth aborting a system sleep */
3627 ret = sd_start_stop_device(sdkp, 0);
3628 if (ignore_stop_errors)
3629 ret = 0;
3630 }
3631
3632 return ret;
3633}
3634
3635static int sd_suspend_system(struct device *dev)
3636{
3637 return sd_suspend_common(dev, true);
3638}
3639
3640static int sd_suspend_runtime(struct device *dev)
3641{
3642 return sd_suspend_common(dev, false);
3643}
3644
3645static int sd_resume(struct device *dev)
3646{
3647 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3648 int ret;
3649
3650 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3651 return 0;
3652
3653 if (!sdkp->device->manage_start_stop)
3654 return 0;
3655
3656 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
3657 ret = sd_start_stop_device(sdkp, 1);
3658 if (!ret)
3659 opal_unlock_from_suspend(sdkp->opal_dev);
3660 return ret;
3661}
3662
3663/**
3664 * init_sd - entry point for this driver (both when built in or when
3665 * a module).
3666 *
3667 * Note: this function registers this driver with the scsi mid-level.
3668 **/
3669static int __init init_sd(void)
3670{
3671 int majors = 0, i, err;
3672
3673 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3674
3675 for (i = 0; i < SD_MAJORS; i++) {
3676 if (register_blkdev(sd_major(i), "sd") != 0)
3677 continue;
3678 majors++;
3679 blk_register_region(sd_major(i), SD_MINORS, NULL,
3680 sd_default_probe, NULL, NULL);
3681 }
3682
3683 if (!majors)
3684 return -ENODEV;
3685
3686 err = class_register(&sd_disk_class);
3687 if (err)
3688 goto err_out;
3689
3690 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3691 0, 0, NULL);
3692 if (!sd_cdb_cache) {
3693 printk(KERN_ERR "sd: can't init extended cdb cache\n");
3694 err = -ENOMEM;
3695 goto err_out_class;
3696 }
3697
3698 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3699 if (!sd_cdb_pool) {
3700 printk(KERN_ERR "sd: can't init extended cdb pool\n");
3701 err = -ENOMEM;
3702 goto err_out_cache;
3703 }
3704
3705 sd_page_pool = mempool_create_page_pool(SD_MEMPOOL_SIZE, 0);
3706 if (!sd_page_pool) {
3707 printk(KERN_ERR "sd: can't init discard page pool\n");
3708 err = -ENOMEM;
3709 goto err_out_ppool;
3710 }
3711
3712 err = scsi_register_driver(&sd_template.gendrv);
3713 if (err)
3714 goto err_out_driver;
3715
3716 return 0;
3717
3718err_out_driver:
3719 mempool_destroy(sd_page_pool);
3720
3721err_out_ppool:
3722 mempool_destroy(sd_cdb_pool);
3723
3724err_out_cache:
3725 kmem_cache_destroy(sd_cdb_cache);
3726
3727err_out_class:
3728 class_unregister(&sd_disk_class);
3729err_out:
3730 for (i = 0; i < SD_MAJORS; i++)
3731 unregister_blkdev(sd_major(i), "sd");
3732 return err;
3733}
3734
3735/**
3736 * exit_sd - exit point for this driver (when it is a module).
3737 *
3738 * Note: this function unregisters this driver from the scsi mid-level.
3739 **/
3740static void __exit exit_sd(void)
3741{
3742 int i;
3743
3744 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3745
3746 scsi_unregister_driver(&sd_template.gendrv);
3747 mempool_destroy(sd_cdb_pool);
3748 mempool_destroy(sd_page_pool);
3749 kmem_cache_destroy(sd_cdb_cache);
3750
3751 class_unregister(&sd_disk_class);
3752
3753 for (i = 0; i < SD_MAJORS; i++) {
3754 blk_unregister_region(sd_major(i), SD_MINORS);
3755 unregister_blkdev(sd_major(i), "sd");
3756 }
3757}
3758
3759module_init(init_sd);
3760module_exit(exit_sd);
3761
3762void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
3763{
3764 scsi_print_sense_hdr(sdkp->device,
3765 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
3766}
3767
3768void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result)
3769{
3770 const char *hb_string = scsi_hostbyte_string(result);
3771 const char *db_string = scsi_driverbyte_string(result);
3772
3773 if (hb_string || db_string)
3774 sd_printk(KERN_INFO, sdkp,
3775 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3776 hb_string ? hb_string : "invalid",
3777 db_string ? db_string : "invalid");
3778 else
3779 sd_printk(KERN_INFO, sdkp,
3780 "%s: Result: hostbyte=0x%02x driverbyte=0x%02x\n",
3781 msg, host_byte(result), driver_byte(result));
3782}