2 * Parallel SCSI (SPI) transport specific attributes exported to sysfs.
4 * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved.
5 * Copyright (c) 2004, 2005 James Bottomley <James.Bottomley@SteelEye.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/ctype.h>
22 #include <linux/init.h>
23 #include <linux/module.h>
24 #include <linux/workqueue.h>
25 #include <linux/blkdev.h>
26 #include <linux/mutex.h>
27 #include <scsi/scsi.h>
28 #include "scsi_priv.h"
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_host.h>
31 #include <scsi/scsi_cmnd.h>
32 #include <scsi/scsi_eh.h>
33 #include <scsi/scsi_transport.h>
34 #include <scsi/scsi_transport_spi.h>
36 #define SPI_NUM_ATTRS 14 /* increase this if you add attributes */
37 #define SPI_OTHER_ATTRS 1 /* Increase this if you add "always
39 #define SPI_HOST_ATTRS 1
41 #define SPI_MAX_ECHO_BUFFER_SIZE 4096
44 #define DV_TIMEOUT (10*HZ)
45 #define DV_RETRIES 3 /* should only need at most
48 /* Private data accessors (keep these out of the header file) */
49 #define spi_dv_in_progress(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_in_progress)
50 #define spi_dv_mutex(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_mutex)
53 struct scsi_transport_template t;
54 struct spi_function_template *f;
55 /* The actual attributes */
56 struct class_device_attribute private_attrs[SPI_NUM_ATTRS];
57 /* The array of null terminated pointers to attributes
58 * needed by scsi_sysfs.c */
59 struct class_device_attribute *attrs[SPI_NUM_ATTRS + SPI_OTHER_ATTRS + 1];
60 struct class_device_attribute private_host_attrs[SPI_HOST_ATTRS];
61 struct class_device_attribute *host_attrs[SPI_HOST_ATTRS + 1];
64 #define to_spi_internal(tmpl) container_of(tmpl, struct spi_internal, t)
66 static const int ppr_to_ps[] = {
67 /* The PPR values 0-6 are reserved, fill them in when
68 * the committee defines them */
83 /* The PPR values at which you calculate the period in ns by multiplying
85 #define SPI_STATIC_PPR 0x0c
87 static int sprint_frac(char *dest, int value, int denom)
89 int frac = value % denom;
90 int result = sprintf(dest, "%d", value / denom);
98 sprintf(dest + result, "%d", frac / denom);
103 dest[result++] = '\0';
107 static int spi_execute(struct scsi_device *sdev, const void *cmd,
108 enum dma_data_direction dir,
109 void *buffer, unsigned bufflen,
110 struct scsi_sense_hdr *sshdr)
113 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
115 for(i = 0; i < DV_RETRIES; i++) {
116 result = scsi_execute(sdev, cmd, dir, buffer, bufflen,
117 sense, DV_TIMEOUT, /* retries */ 1,
119 if (result & DRIVER_SENSE) {
120 struct scsi_sense_hdr sshdr_tmp;
124 if (scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE,
126 && sshdr->sense_key == UNIT_ATTENTION)
135 enum spi_signal_type value;
138 { SPI_SIGNAL_UNKNOWN, "unknown" },
139 { SPI_SIGNAL_SE, "SE" },
140 { SPI_SIGNAL_LVD, "LVD" },
141 { SPI_SIGNAL_HVD, "HVD" },
144 static inline const char *spi_signal_to_string(enum spi_signal_type type)
148 for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
149 if (type == signal_types[i].value)
150 return signal_types[i].name;
154 static inline enum spi_signal_type spi_signal_to_value(const char *name)
158 for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
159 len = strlen(signal_types[i].name);
160 if (strncmp(name, signal_types[i].name, len) == 0 &&
161 (name[len] == '\n' || name[len] == '\0'))
162 return signal_types[i].value;
164 return SPI_SIGNAL_UNKNOWN;
167 static int spi_host_setup(struct transport_container *tc, struct device *dev,
168 struct class_device *cdev)
170 struct Scsi_Host *shost = dev_to_shost(dev);
172 spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;
177 static DECLARE_TRANSPORT_CLASS(spi_host_class,
183 static int spi_host_match(struct attribute_container *cont,
186 struct Scsi_Host *shost;
187 struct spi_internal *i;
189 if (!scsi_is_host_device(dev))
192 shost = dev_to_shost(dev);
193 if (!shost->transportt || shost->transportt->host_attrs.ac.class
194 != &spi_host_class.class)
197 i = to_spi_internal(shost->transportt);
199 return &i->t.host_attrs.ac == cont;
202 static int spi_device_configure(struct transport_container *tc,
204 struct class_device *cdev)
206 struct scsi_device *sdev = to_scsi_device(dev);
207 struct scsi_target *starget = sdev->sdev_target;
209 /* Populate the target capability fields with the values
210 * gleaned from the device inquiry */
212 spi_support_sync(starget) = scsi_device_sync(sdev);
213 spi_support_wide(starget) = scsi_device_wide(sdev);
214 spi_support_dt(starget) = scsi_device_dt(sdev);
215 spi_support_dt_only(starget) = scsi_device_dt_only(sdev);
216 spi_support_ius(starget) = scsi_device_ius(sdev);
217 spi_support_qas(starget) = scsi_device_qas(sdev);
222 static int spi_setup_transport_attrs(struct transport_container *tc,
224 struct class_device *cdev)
226 struct scsi_target *starget = to_scsi_target(dev);
228 spi_period(starget) = -1; /* illegal value */
229 spi_min_period(starget) = 0;
230 spi_offset(starget) = 0; /* async */
231 spi_max_offset(starget) = 255;
232 spi_width(starget) = 0; /* narrow */
233 spi_max_width(starget) = 1;
234 spi_iu(starget) = 0; /* no IU */
235 spi_dt(starget) = 0; /* ST */
236 spi_qas(starget) = 0;
237 spi_wr_flow(starget) = 0;
238 spi_rd_strm(starget) = 0;
239 spi_rti(starget) = 0;
240 spi_pcomp_en(starget) = 0;
241 spi_hold_mcs(starget) = 0;
242 spi_dv_pending(starget) = 0;
243 spi_dv_in_progress(starget) = 0;
244 spi_initial_dv(starget) = 0;
245 mutex_init(&spi_dv_mutex(starget));
250 #define spi_transport_show_simple(field, format_string) \
253 show_spi_transport_##field(struct class_device *cdev, char *buf) \
255 struct scsi_target *starget = transport_class_to_starget(cdev); \
256 struct spi_transport_attrs *tp; \
258 tp = (struct spi_transport_attrs *)&starget->starget_data; \
259 return snprintf(buf, 20, format_string, tp->field); \
262 #define spi_transport_store_simple(field, format_string) \
265 store_spi_transport_##field(struct class_device *cdev, const char *buf, \
269 struct scsi_target *starget = transport_class_to_starget(cdev); \
270 struct spi_transport_attrs *tp; \
272 tp = (struct spi_transport_attrs *)&starget->starget_data; \
273 val = simple_strtoul(buf, NULL, 0); \
278 #define spi_transport_show_function(field, format_string) \
281 show_spi_transport_##field(struct class_device *cdev, char *buf) \
283 struct scsi_target *starget = transport_class_to_starget(cdev); \
284 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
285 struct spi_transport_attrs *tp; \
286 struct spi_internal *i = to_spi_internal(shost->transportt); \
287 tp = (struct spi_transport_attrs *)&starget->starget_data; \
288 if (i->f->get_##field) \
289 i->f->get_##field(starget); \
290 return snprintf(buf, 20, format_string, tp->field); \
293 #define spi_transport_store_function(field, format_string) \
295 store_spi_transport_##field(struct class_device *cdev, const char *buf, \
299 struct scsi_target *starget = transport_class_to_starget(cdev); \
300 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
301 struct spi_internal *i = to_spi_internal(shost->transportt); \
303 val = simple_strtoul(buf, NULL, 0); \
304 i->f->set_##field(starget, val); \
308 #define spi_transport_store_max(field, format_string) \
310 store_spi_transport_##field(struct class_device *cdev, const char *buf, \
314 struct scsi_target *starget = transport_class_to_starget(cdev); \
315 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
316 struct spi_internal *i = to_spi_internal(shost->transportt); \
317 struct spi_transport_attrs *tp \
318 = (struct spi_transport_attrs *)&starget->starget_data; \
320 val = simple_strtoul(buf, NULL, 0); \
321 if (val > tp->max_##field) \
322 val = tp->max_##field; \
323 i->f->set_##field(starget, val); \
327 #define spi_transport_rd_attr(field, format_string) \
328 spi_transport_show_function(field, format_string) \
329 spi_transport_store_function(field, format_string) \
330 static CLASS_DEVICE_ATTR(field, S_IRUGO | S_IWUSR, \
331 show_spi_transport_##field, \
332 store_spi_transport_##field);
334 #define spi_transport_simple_attr(field, format_string) \
335 spi_transport_show_simple(field, format_string) \
336 spi_transport_store_simple(field, format_string) \
337 static CLASS_DEVICE_ATTR(field, S_IRUGO | S_IWUSR, \
338 show_spi_transport_##field, \
339 store_spi_transport_##field);
341 #define spi_transport_max_attr(field, format_string) \
342 spi_transport_show_function(field, format_string) \
343 spi_transport_store_max(field, format_string) \
344 spi_transport_simple_attr(max_##field, format_string) \
345 static CLASS_DEVICE_ATTR(field, S_IRUGO | S_IWUSR, \
346 show_spi_transport_##field, \
347 store_spi_transport_##field);
349 /* The Parallel SCSI Tranport Attributes: */
350 spi_transport_max_attr(offset, "%d\n");
351 spi_transport_max_attr(width, "%d\n");
352 spi_transport_rd_attr(iu, "%d\n");
353 spi_transport_rd_attr(dt, "%d\n");
354 spi_transport_rd_attr(qas, "%d\n");
355 spi_transport_rd_attr(wr_flow, "%d\n");
356 spi_transport_rd_attr(rd_strm, "%d\n");
357 spi_transport_rd_attr(rti, "%d\n");
358 spi_transport_rd_attr(pcomp_en, "%d\n");
359 spi_transport_rd_attr(hold_mcs, "%d\n");
361 /* we only care about the first child device so we return 1 */
362 static int child_iter(struct device *dev, void *data)
364 struct scsi_device *sdev = to_scsi_device(dev);
371 store_spi_revalidate(struct class_device *cdev, const char *buf, size_t count)
373 struct scsi_target *starget = transport_class_to_starget(cdev);
375 device_for_each_child(&starget->dev, NULL, child_iter);
378 static CLASS_DEVICE_ATTR(revalidate, S_IWUSR, NULL, store_spi_revalidate);
380 /* Translate the period into ns according to the current spec
381 * for SDTR/PPR messages */
382 static int period_to_str(char *buf, int period)
386 if (period < 0 || period > 0xff) {
388 } else if (period <= SPI_STATIC_PPR) {
389 picosec = ppr_to_ps[period];
391 picosec = period * 4000;
395 len = sprintf(buf, "reserved");
397 len = sprint_frac(buf, picosec, 1000);
404 show_spi_transport_period_helper(char *buf, int period)
406 int len = period_to_str(buf, period);
413 store_spi_transport_period_helper(struct class_device *cdev, const char *buf,
414 size_t count, int *periodp)
416 int j, picosec, period = -1;
419 picosec = simple_strtoul(buf, &endp, 10) * 1000;
426 picosec += (*endp - '0') * mult;
431 for (j = 0; j <= SPI_STATIC_PPR; j++) {
432 if (ppr_to_ps[j] < picosec)
439 period = picosec / 4000;
450 show_spi_transport_period(struct class_device *cdev, char *buf)
452 struct scsi_target *starget = transport_class_to_starget(cdev);
453 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
454 struct spi_internal *i = to_spi_internal(shost->transportt);
455 struct spi_transport_attrs *tp =
456 (struct spi_transport_attrs *)&starget->starget_data;
458 if (i->f->get_period)
459 i->f->get_period(starget);
461 return show_spi_transport_period_helper(buf, tp->period);
465 store_spi_transport_period(struct class_device *cdev, const char *buf,
468 struct scsi_target *starget = transport_class_to_starget(cdev);
469 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
470 struct spi_internal *i = to_spi_internal(shost->transportt);
471 struct spi_transport_attrs *tp =
472 (struct spi_transport_attrs *)&starget->starget_data;
475 retval = store_spi_transport_period_helper(cdev, buf, count, &period);
477 if (period < tp->min_period)
478 period = tp->min_period;
480 i->f->set_period(starget, period);
485 static CLASS_DEVICE_ATTR(period, S_IRUGO | S_IWUSR,
486 show_spi_transport_period,
487 store_spi_transport_period);
490 show_spi_transport_min_period(struct class_device *cdev, char *buf)
492 struct scsi_target *starget = transport_class_to_starget(cdev);
493 struct spi_transport_attrs *tp =
494 (struct spi_transport_attrs *)&starget->starget_data;
496 return show_spi_transport_period_helper(buf, tp->min_period);
500 store_spi_transport_min_period(struct class_device *cdev, const char *buf,
503 struct scsi_target *starget = transport_class_to_starget(cdev);
504 struct spi_transport_attrs *tp =
505 (struct spi_transport_attrs *)&starget->starget_data;
507 return store_spi_transport_period_helper(cdev, buf, count,
512 static CLASS_DEVICE_ATTR(min_period, S_IRUGO | S_IWUSR,
513 show_spi_transport_min_period,
514 store_spi_transport_min_period);
517 static ssize_t show_spi_host_signalling(struct class_device *cdev, char *buf)
519 struct Scsi_Host *shost = transport_class_to_shost(cdev);
520 struct spi_internal *i = to_spi_internal(shost->transportt);
522 if (i->f->get_signalling)
523 i->f->get_signalling(shost);
525 return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
527 static ssize_t store_spi_host_signalling(struct class_device *cdev,
528 const char *buf, size_t count)
530 struct Scsi_Host *shost = transport_class_to_shost(cdev);
531 struct spi_internal *i = to_spi_internal(shost->transportt);
532 enum spi_signal_type type = spi_signal_to_value(buf);
534 if (type != SPI_SIGNAL_UNKNOWN)
535 i->f->set_signalling(shost, type);
539 static CLASS_DEVICE_ATTR(signalling, S_IRUGO | S_IWUSR,
540 show_spi_host_signalling,
541 store_spi_host_signalling);
543 #define DV_SET(x, y) \
545 i->f->set_##x(sdev->sdev_target, y)
547 enum spi_compare_returns {
550 SPI_COMPARE_SKIP_TEST,
554 /* This is for read/write Domain Validation: If the device supports
555 * an echo buffer, we do read/write tests to it */
556 static enum spi_compare_returns
557 spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
558 u8 *ptr, const int retries)
560 int len = ptr - buffer;
562 unsigned int pattern = 0x0000ffff;
563 struct scsi_sense_hdr sshdr;
565 const char spi_write_buffer[] = {
566 WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
568 const char spi_read_buffer[] = {
569 READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
572 /* set up the pattern buffer. Doesn't matter if we spill
573 * slightly beyond since that's where the read buffer is */
574 for (j = 0; j < len; ) {
576 /* fill the buffer with counting (test a) */
577 for ( ; j < min(len, 32); j++)
580 /* fill the buffer with alternating words of 0x0 and
582 for ( ; j < min(len, k + 32); j += 2) {
583 u16 *word = (u16 *)&buffer[j];
585 *word = (j & 0x02) ? 0x0000 : 0xffff;
588 /* fill with crosstalk (alternating 0x5555 0xaaa)
590 for ( ; j < min(len, k + 32); j += 2) {
591 u16 *word = (u16 *)&buffer[j];
593 *word = (j & 0x02) ? 0x5555 : 0xaaaa;
596 /* fill with shifting bits (test d) */
597 for ( ; j < min(len, k + 32); j += 4) {
598 u32 *word = (unsigned int *)&buffer[j];
599 u32 roll = (pattern & 0x80000000) ? 1 : 0;
602 pattern = (pattern << 1) | roll;
604 /* don't bother with random data (test e) */
607 for (r = 0; r < retries; r++) {
608 result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
609 buffer, len, &sshdr);
610 if(result || !scsi_device_online(sdev)) {
612 scsi_device_set_state(sdev, SDEV_QUIESCE);
613 if (scsi_sense_valid(&sshdr)
614 && sshdr.sense_key == ILLEGAL_REQUEST
615 /* INVALID FIELD IN CDB */
616 && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
617 /* This would mean that the drive lied
618 * to us about supporting an echo
619 * buffer (unfortunately some Western
620 * Digital drives do precisely this)
622 return SPI_COMPARE_SKIP_TEST;
625 sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
626 return SPI_COMPARE_FAILURE;
630 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
632 scsi_device_set_state(sdev, SDEV_QUIESCE);
634 if (memcmp(buffer, ptr, len) != 0)
635 return SPI_COMPARE_FAILURE;
637 return SPI_COMPARE_SUCCESS;
640 /* This is for the simplest form of Domain Validation: a read test
641 * on the inquiry data from the device */
642 static enum spi_compare_returns
643 spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
644 u8 *ptr, const int retries)
647 const int len = sdev->inquiry_len;
648 const char spi_inquiry[] = {
649 INQUIRY, 0, 0, 0, len, 0
652 for (r = 0; r < retries; r++) {
655 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
658 if(result || !scsi_device_online(sdev)) {
659 scsi_device_set_state(sdev, SDEV_QUIESCE);
660 return SPI_COMPARE_FAILURE;
663 /* If we don't have the inquiry data already, the
664 * first read gets it */
671 if (memcmp(buffer, ptr, len) != 0)
673 return SPI_COMPARE_FAILURE;
675 return SPI_COMPARE_SUCCESS;
678 static enum spi_compare_returns
679 spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
680 enum spi_compare_returns
681 (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
683 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
684 struct scsi_target *starget = sdev->sdev_target;
685 int period = 0, prevperiod = 0;
686 enum spi_compare_returns retval;
691 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
693 if (retval == SPI_COMPARE_SUCCESS
694 || retval == SPI_COMPARE_SKIP_TEST)
697 /* OK, retrain, fallback */
699 i->f->get_iu(starget);
701 i->f->get_qas(starget);
702 if (i->f->get_period)
703 i->f->get_period(sdev->sdev_target);
705 /* Here's the fallback sequence; first try turning off
706 * IU, then QAS (if we can control them), then finally
707 * fall down the periods */
708 if (i->f->set_iu && spi_iu(starget)) {
709 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Information Units\n");
711 } else if (i->f->set_qas && spi_qas(starget)) {
712 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
715 newperiod = spi_period(starget);
716 period = newperiod > period ? newperiod : period;
720 period += period >> 1;
722 if (unlikely(period > 0xff || period == prevperiod)) {
723 /* Total failure; set to async and return */
724 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
726 return SPI_COMPARE_FAILURE;
728 starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
729 DV_SET(period, period);
737 spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
741 /* first off do a test unit ready. This can error out
742 * because of reservations or some other reason. If it
743 * fails, the device won't let us write to the echo buffer
744 * so just return failure */
746 const char spi_test_unit_ready[] = {
747 TEST_UNIT_READY, 0, 0, 0, 0, 0
750 const char spi_read_buffer_descriptor[] = {
751 READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
755 /* We send a set of three TURs to clear any outstanding
756 * unit attention conditions if they exist (Otherwise the
757 * buffer tests won't be happy). If the TUR still fails
758 * (reservation conflict, device not ready, etc) just
759 * skip the write tests */
761 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE,
773 result = spi_execute(sdev, spi_read_buffer_descriptor,
774 DMA_FROM_DEVICE, buffer, 4, NULL);
777 /* Device has no echo buffer */
780 return buffer[3] + ((buffer[2] & 0x1f) << 8);
784 spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
786 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
787 struct scsi_target *starget = sdev->sdev_target;
788 struct Scsi_Host *shost = sdev->host;
789 int len = sdev->inquiry_len;
790 /* first set us up for narrow async */
794 if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
795 != SPI_COMPARE_SUCCESS) {
796 starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
797 /* FIXME: should probably offline the device here? */
802 if (i->f->set_width && spi_max_width(starget) &&
803 scsi_device_wide(sdev)) {
804 i->f->set_width(starget, 1);
806 if (spi_dv_device_compare_inquiry(sdev, buffer,
809 != SPI_COMPARE_SUCCESS) {
810 starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
811 i->f->set_width(starget, 0);
815 if (!i->f->set_period)
818 /* device can't handle synchronous */
819 if (!scsi_device_sync(sdev) && !scsi_device_dt(sdev))
822 /* len == -1 is the signal that we need to ascertain the
823 * presence of an echo buffer before trying to use it. len ==
824 * 0 means we don't have an echo buffer */
829 /* now set up to the maximum */
830 DV_SET(offset, spi_max_offset(starget));
831 DV_SET(period, spi_min_period(starget));
832 /* try QAS requests; this should be harmless to set if the
833 * target supports it */
834 if (scsi_device_qas(sdev)) {
840 if (scsi_device_ius(sdev) && spi_min_period(starget) < 9) {
841 /* This u320 (or u640). Set IU transfers */
843 /* Then set the optional parameters */
847 if (spi_min_period(starget) == 8)
853 /* now that we've done all this, actually check the bus
854 * signal type (if known). Some devices are stupid on
855 * a SE bus and still claim they can try LVD only settings */
856 if (i->f->get_signalling)
857 i->f->get_signalling(shost);
858 if (spi_signalling(shost) == SPI_SIGNAL_SE ||
859 spi_signalling(shost) == SPI_SIGNAL_HVD ||
860 !scsi_device_dt(sdev)) {
865 /* Do the read only INQUIRY tests */
866 spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
867 spi_dv_device_compare_inquiry);
868 /* See if we actually managed to negotiate and sustain DT */
870 i->f->get_dt(starget);
872 /* see if the device has an echo buffer. If it does we can do
873 * the SPI pattern write tests. Because of some broken
874 * devices, we *only* try this on a device that has actually
877 if (len == -1 && spi_dt(starget))
878 len = spi_dv_device_get_echo_buffer(sdev, buffer);
881 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
885 if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
886 starget_printk(KERN_WARNING, starget, "Echo buffer size %d is too big, trimming to %d\n", len, SPI_MAX_ECHO_BUFFER_SIZE);
887 len = SPI_MAX_ECHO_BUFFER_SIZE;
890 if (spi_dv_retrain(sdev, buffer, buffer + len,
891 spi_dv_device_echo_buffer)
892 == SPI_COMPARE_SKIP_TEST) {
893 /* OK, the stupid drive can't do a write echo buffer
894 * test after all, fall back to the read tests */
901 /** spi_dv_device - Do Domain Validation on the device
902 * @sdev: scsi device to validate
904 * Performs the domain validation on the given device in the
905 * current execution thread. Since DV operations may sleep,
906 * the current thread must have user context. Also no SCSI
907 * related locks that would deadlock I/O issued by the DV may
911 spi_dv_device(struct scsi_device *sdev)
913 struct scsi_target *starget = sdev->sdev_target;
915 const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
917 if (unlikely(scsi_device_get(sdev)))
920 if (unlikely(spi_dv_in_progress(starget)))
922 spi_dv_in_progress(starget) = 1;
924 buffer = kzalloc(len, GFP_KERNEL);
926 if (unlikely(!buffer))
929 /* We need to verify that the actual device will quiesce; the
930 * later target quiesce is just a nice to have */
931 if (unlikely(scsi_device_quiesce(sdev)))
934 scsi_target_quiesce(starget);
936 spi_dv_pending(starget) = 1;
937 mutex_lock(&spi_dv_mutex(starget));
939 starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
941 spi_dv_device_internal(sdev, buffer);
943 starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
945 mutex_unlock(&spi_dv_mutex(starget));
946 spi_dv_pending(starget) = 0;
948 scsi_target_resume(starget);
950 spi_initial_dv(starget) = 1;
955 spi_dv_in_progress(starget) = 0;
956 scsi_device_put(sdev);
958 EXPORT_SYMBOL(spi_dv_device);
960 struct work_queue_wrapper {
961 struct work_struct work;
962 struct scsi_device *sdev;
966 spi_dv_device_work_wrapper(struct work_struct *work)
968 struct work_queue_wrapper *wqw =
969 container_of(work, struct work_queue_wrapper, work);
970 struct scsi_device *sdev = wqw->sdev;
974 spi_dv_pending(sdev->sdev_target) = 0;
975 scsi_device_put(sdev);
980 * spi_schedule_dv_device - schedule domain validation to occur on the device
981 * @sdev: The device to validate
983 * Identical to spi_dv_device() above, except that the DV will be
984 * scheduled to occur in a workqueue later. All memory allocations
985 * are atomic, so may be called from any context including those holding
989 spi_schedule_dv_device(struct scsi_device *sdev)
991 struct work_queue_wrapper *wqw =
992 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
997 if (unlikely(spi_dv_pending(sdev->sdev_target))) {
1001 /* Set pending early (dv_device doesn't check it, only sets it) */
1002 spi_dv_pending(sdev->sdev_target) = 1;
1003 if (unlikely(scsi_device_get(sdev))) {
1005 spi_dv_pending(sdev->sdev_target) = 0;
1009 INIT_WORK(&wqw->work, spi_dv_device_work_wrapper);
1012 schedule_work(&wqw->work);
1014 EXPORT_SYMBOL(spi_schedule_dv_device);
1017 * spi_display_xfer_agreement - Print the current target transfer agreement
1018 * @starget: The target for which to display the agreement
1020 * Each SPI port is required to maintain a transfer agreement for each
1021 * other port on the bus. This function prints a one-line summary of
1022 * the current agreement; more detailed information is available in sysfs.
1024 void spi_display_xfer_agreement(struct scsi_target *starget)
1026 struct spi_transport_attrs *tp;
1027 tp = (struct spi_transport_attrs *)&starget->starget_data;
1029 if (tp->offset > 0 && tp->period > 0) {
1030 unsigned int picosec, kb100;
1031 char *scsi = "FAST-?";
1034 if (tp->period <= SPI_STATIC_PPR) {
1035 picosec = ppr_to_ps[tp->period];
1036 switch (tp->period) {
1037 case 7: scsi = "FAST-320"; break;
1038 case 8: scsi = "FAST-160"; break;
1039 case 9: scsi = "FAST-80"; break;
1041 case 11: scsi = "FAST-40"; break;
1042 case 12: scsi = "FAST-20"; break;
1045 picosec = tp->period * 4000;
1046 if (tp->period < 25)
1048 else if (tp->period < 50)
1054 kb100 = (10000000 + picosec / 2) / picosec;
1057 sprint_frac(tmp, picosec, 1000);
1059 dev_info(&starget->dev,
1060 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1061 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1062 tp->dt ? "DT" : "ST",
1063 tp->iu ? " IU" : "",
1064 tp->qas ? " QAS" : "",
1065 tp->rd_strm ? " RDSTRM" : "",
1066 tp->rti ? " RTI" : "",
1067 tp->wr_flow ? " WRFLOW" : "",
1068 tp->pcomp_en ? " PCOMP" : "",
1069 tp->hold_mcs ? " HMCS" : "",
1072 dev_info(&starget->dev, "%sasynchronous\n",
1073 tp->width ? "wide " : "");
1076 EXPORT_SYMBOL(spi_display_xfer_agreement);
1078 int spi_populate_width_msg(unsigned char *msg, int width)
1080 msg[0] = EXTENDED_MESSAGE;
1082 msg[2] = EXTENDED_WDTR;
1086 EXPORT_SYMBOL_GPL(spi_populate_width_msg);
1088 int spi_populate_sync_msg(unsigned char *msg, int period, int offset)
1090 msg[0] = EXTENDED_MESSAGE;
1092 msg[2] = EXTENDED_SDTR;
1097 EXPORT_SYMBOL_GPL(spi_populate_sync_msg);
1099 int spi_populate_ppr_msg(unsigned char *msg, int period, int offset,
1100 int width, int options)
1102 msg[0] = EXTENDED_MESSAGE;
1104 msg[2] = EXTENDED_PPR;
1112 EXPORT_SYMBOL_GPL(spi_populate_ppr_msg);
1114 #ifdef CONFIG_SCSI_CONSTANTS
1115 static const char * const one_byte_msgs[] = {
1116 /* 0x00 */ "Task Complete", NULL /* Extended Message */, "Save Pointers",
1117 /* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error",
1118 /* 0x06 */ "Abort Task Set", "Message Reject", "Nop", "Message Parity Error",
1119 /* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
1120 /* 0x0c */ "Target Reset", "Abort Task", "Clear Task Set",
1121 /* 0x0f */ "Initiate Recovery", "Release Recovery",
1122 /* 0x11 */ "Terminate Process", "Continue Task", "Target Transfer Disable",
1123 /* 0x14 */ NULL, NULL, "Clear ACA", "LUN Reset"
1126 static const char * const two_byte_msgs[] = {
1127 /* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
1128 /* 0x23 */ "Ignore Wide Residue", "ACA"
1131 static const char * const extended_msgs[] = {
1132 /* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
1133 /* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
1134 /* 0x04 */ "Parallel Protocol Request", "Modify Bidirectional Data Pointer"
1137 static void print_nego(const unsigned char *msg, int per, int off, int width)
1141 period_to_str(buf, msg[per]);
1142 printk("period = %s ns ", buf);
1146 printk("offset = %d ", msg[off]);
1148 printk("width = %d ", 8 << msg[width]);
1151 static void print_ptr(const unsigned char *msg, int msb, const char *desc)
1153 int ptr = (msg[msb] << 24) | (msg[msb+1] << 16) | (msg[msb+2] << 8) |
1155 printk("%s = %d ", desc, ptr);
1158 int spi_print_msg(const unsigned char *msg)
1161 if (msg[0] == EXTENDED_MESSAGE) {
1165 if (msg[2] < ARRAY_SIZE(extended_msgs))
1166 printk ("%s ", extended_msgs[msg[2]]);
1168 printk ("Extended Message, reserved code (0x%02x) ",
1171 case EXTENDED_MODIFY_DATA_POINTER:
1172 print_ptr(msg, 3, "pointer");
1175 print_nego(msg, 3, 4, 0);
1178 print_nego(msg, 0, 0, 3);
1181 print_nego(msg, 3, 5, 6);
1183 case EXTENDED_MODIFY_BIDI_DATA_PTR:
1184 print_ptr(msg, 3, "out");
1185 print_ptr(msg, 7, "in");
1188 for (i = 2; i < len; ++i)
1189 printk("%02x ", msg[i]);
1192 } else if (msg[0] & 0x80) {
1193 printk("Identify disconnect %sallowed %s %d ",
1194 (msg[0] & 0x40) ? "" : "not ",
1195 (msg[0] & 0x20) ? "target routine" : "lun",
1197 /* Normal One byte */
1198 } else if (msg[0] < 0x1f) {
1199 if (msg[0] < ARRAY_SIZE(one_byte_msgs) && one_byte_msgs[msg[0]])
1200 printk("%s ", one_byte_msgs[msg[0]]);
1202 printk("reserved (%02x) ", msg[0]);
1203 } else if (msg[0] == 0x55) {
1204 printk("QAS Request ");
1206 } else if (msg[0] <= 0x2f) {
1207 if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
1208 printk("%s %02x ", two_byte_msgs[msg[0] - 0x20],
1211 printk("reserved two byte (%02x %02x) ",
1215 printk("reserved ");
1218 EXPORT_SYMBOL(spi_print_msg);
1220 #else /* ifndef CONFIG_SCSI_CONSTANTS */
1222 int spi_print_msg(const unsigned char *msg)
1226 if (msg[0] == EXTENDED_MESSAGE) {
1230 for (i = 0; i < len; ++i)
1231 printk("%02x ", msg[i]);
1233 } else if (msg[0] & 0x80) {
1234 printk("%02x ", msg[0]);
1235 /* Normal One byte */
1236 } else if ((msg[0] < 0x1f) || (msg[0] == 0x55)) {
1237 printk("%02x ", msg[0]);
1239 } else if (msg[0] <= 0x2f) {
1240 printk("%02x %02x", msg[0], msg[1]);
1243 printk("%02x ", msg[0]);
1246 EXPORT_SYMBOL(spi_print_msg);
1247 #endif /* ! CONFIG_SCSI_CONSTANTS */
1249 #define SETUP_ATTRIBUTE(field) \
1250 i->private_attrs[count] = class_device_attr_##field; \
1251 if (!i->f->set_##field) { \
1252 i->private_attrs[count].attr.mode = S_IRUGO; \
1253 i->private_attrs[count].store = NULL; \
1255 i->attrs[count] = &i->private_attrs[count]; \
1256 if (i->f->show_##field) \
1259 #define SETUP_RELATED_ATTRIBUTE(field, rel_field) \
1260 i->private_attrs[count] = class_device_attr_##field; \
1261 if (!i->f->set_##rel_field) { \
1262 i->private_attrs[count].attr.mode = S_IRUGO; \
1263 i->private_attrs[count].store = NULL; \
1265 i->attrs[count] = &i->private_attrs[count]; \
1266 if (i->f->show_##rel_field) \
1269 #define SETUP_HOST_ATTRIBUTE(field) \
1270 i->private_host_attrs[count] = class_device_attr_##field; \
1271 if (!i->f->set_##field) { \
1272 i->private_host_attrs[count].attr.mode = S_IRUGO; \
1273 i->private_host_attrs[count].store = NULL; \
1275 i->host_attrs[count] = &i->private_host_attrs[count]; \
1278 static int spi_device_match(struct attribute_container *cont,
1281 struct scsi_device *sdev;
1282 struct Scsi_Host *shost;
1283 struct spi_internal *i;
1285 if (!scsi_is_sdev_device(dev))
1288 sdev = to_scsi_device(dev);
1290 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1291 != &spi_host_class.class)
1293 /* Note: this class has no device attributes, so it has
1294 * no per-HBA allocation and thus we don't need to distinguish
1295 * the attribute containers for the device */
1296 i = to_spi_internal(shost->transportt);
1297 if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1302 static int spi_target_match(struct attribute_container *cont,
1305 struct Scsi_Host *shost;
1306 struct scsi_target *starget;
1307 struct spi_internal *i;
1309 if (!scsi_is_target_device(dev))
1312 shost = dev_to_shost(dev->parent);
1313 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1314 != &spi_host_class.class)
1317 i = to_spi_internal(shost->transportt);
1318 starget = to_scsi_target(dev);
1320 if (i->f->deny_binding && i->f->deny_binding(starget))
1323 return &i->t.target_attrs.ac == cont;
1326 static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1328 spi_setup_transport_attrs,
1332 static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1334 spi_device_configure);
1336 struct scsi_transport_template *
1337 spi_attach_transport(struct spi_function_template *ft)
1340 struct spi_internal *i = kzalloc(sizeof(struct spi_internal),
1346 i->t.target_attrs.ac.class = &spi_transport_class.class;
1347 i->t.target_attrs.ac.attrs = &i->attrs[0];
1348 i->t.target_attrs.ac.match = spi_target_match;
1349 transport_container_register(&i->t.target_attrs);
1350 i->t.target_size = sizeof(struct spi_transport_attrs);
1351 i->t.host_attrs.ac.class = &spi_host_class.class;
1352 i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1353 i->t.host_attrs.ac.match = spi_host_match;
1354 transport_container_register(&i->t.host_attrs);
1355 i->t.host_size = sizeof(struct spi_host_attrs);
1358 SETUP_ATTRIBUTE(period);
1359 SETUP_RELATED_ATTRIBUTE(min_period, period);
1360 SETUP_ATTRIBUTE(offset);
1361 SETUP_RELATED_ATTRIBUTE(max_offset, offset);
1362 SETUP_ATTRIBUTE(width);
1363 SETUP_RELATED_ATTRIBUTE(max_width, width);
1364 SETUP_ATTRIBUTE(iu);
1365 SETUP_ATTRIBUTE(dt);
1366 SETUP_ATTRIBUTE(qas);
1367 SETUP_ATTRIBUTE(wr_flow);
1368 SETUP_ATTRIBUTE(rd_strm);
1369 SETUP_ATTRIBUTE(rti);
1370 SETUP_ATTRIBUTE(pcomp_en);
1371 SETUP_ATTRIBUTE(hold_mcs);
1373 /* if you add an attribute but forget to increase SPI_NUM_ATTRS
1374 * this bug will trigger */
1375 BUG_ON(count > SPI_NUM_ATTRS);
1377 i->attrs[count++] = &class_device_attr_revalidate;
1379 i->attrs[count] = NULL;
1382 SETUP_HOST_ATTRIBUTE(signalling);
1384 BUG_ON(count > SPI_HOST_ATTRS);
1386 i->host_attrs[count] = NULL;
1390 EXPORT_SYMBOL(spi_attach_transport);
1392 void spi_release_transport(struct scsi_transport_template *t)
1394 struct spi_internal *i = to_spi_internal(t);
1396 transport_container_unregister(&i->t.target_attrs);
1397 transport_container_unregister(&i->t.host_attrs);
1401 EXPORT_SYMBOL(spi_release_transport);
1403 static __init int spi_transport_init(void)
1405 int error = transport_class_register(&spi_transport_class);
1408 error = anon_transport_class_register(&spi_device_class);
1409 return transport_class_register(&spi_host_class);
1412 static void __exit spi_transport_exit(void)
1414 transport_class_unregister(&spi_transport_class);
1415 anon_transport_class_unregister(&spi_device_class);
1416 transport_class_unregister(&spi_host_class);
1419 MODULE_AUTHOR("Martin Hicks");
1420 MODULE_DESCRIPTION("SPI Transport Attributes");
1421 MODULE_LICENSE("GPL");
1423 module_init(spi_transport_init);
1424 module_exit(spi_transport_exit);