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/config.h>
22 #include <linux/ctype.h>
23 #include <linux/init.h>
24 #include <linux/module.h>
25 #include <linux/workqueue.h>
26 #include <linux/blkdev.h>
27 #include <linux/mutex.h>
28 #include <scsi/scsi.h>
29 #include "scsi_priv.h"
30 #include <scsi/scsi_device.h>
31 #include <scsi/scsi_host.h>
32 #include <scsi/scsi_cmnd.h>
33 #include <scsi/scsi_eh.h>
34 #include <scsi/scsi_transport.h>
35 #include <scsi/scsi_transport_spi.h>
37 #define SPI_NUM_ATTRS 14 /* increase this if you add attributes */
38 #define SPI_OTHER_ATTRS 1 /* Increase this if you add "always
40 #define SPI_HOST_ATTRS 1
42 #define SPI_MAX_ECHO_BUFFER_SIZE 4096
45 #define DV_TIMEOUT (10*HZ)
46 #define DV_RETRIES 3 /* should only need at most
49 /* Private data accessors (keep these out of the header file) */
50 #define spi_dv_pending(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_pending)
51 #define spi_dv_mutex(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_mutex)
54 struct scsi_transport_template t;
55 struct spi_function_template *f;
56 /* The actual attributes */
57 struct class_device_attribute private_attrs[SPI_NUM_ATTRS];
58 /* The array of null terminated pointers to attributes
59 * needed by scsi_sysfs.c */
60 struct class_device_attribute *attrs[SPI_NUM_ATTRS + SPI_OTHER_ATTRS + 1];
61 struct class_device_attribute private_host_attrs[SPI_HOST_ATTRS];
62 struct class_device_attribute *host_attrs[SPI_HOST_ATTRS + 1];
65 #define to_spi_internal(tmpl) container_of(tmpl, struct spi_internal, t)
67 static const int ppr_to_ps[] = {
68 /* The PPR values 0-6 are reserved, fill them in when
69 * the committee defines them */
84 /* The PPR values at which you calculate the period in ns by multiplying
86 #define SPI_STATIC_PPR 0x0c
88 static int sprint_frac(char *dest, int value, int denom)
90 int frac = value % denom;
91 int result = sprintf(dest, "%d", value / denom);
99 sprintf(dest + result, "%d", frac / denom);
104 dest[result++] = '\0';
108 static int spi_execute(struct scsi_device *sdev, const void *cmd,
109 enum dma_data_direction dir,
110 void *buffer, unsigned bufflen,
111 struct scsi_sense_hdr *sshdr)
114 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
116 for(i = 0; i < DV_RETRIES; i++) {
117 result = scsi_execute(sdev, cmd, dir, buffer, bufflen,
118 sense, DV_TIMEOUT, /* retries */ 1,
120 if (result & DRIVER_SENSE) {
121 struct scsi_sense_hdr sshdr_tmp;
125 if (scsi_normalize_sense(sense, sizeof(*sense),
127 && sshdr->sense_key == UNIT_ATTENTION)
136 enum spi_signal_type value;
139 { SPI_SIGNAL_UNKNOWN, "unknown" },
140 { SPI_SIGNAL_SE, "SE" },
141 { SPI_SIGNAL_LVD, "LVD" },
142 { SPI_SIGNAL_HVD, "HVD" },
145 static inline const char *spi_signal_to_string(enum spi_signal_type type)
149 for (i = 0; i < sizeof(signal_types)/sizeof(signal_types[0]); i++) {
150 if (type == signal_types[i].value)
151 return signal_types[i].name;
155 static inline enum spi_signal_type spi_signal_to_value(const char *name)
159 for (i = 0; i < sizeof(signal_types)/sizeof(signal_types[0]); i++) {
160 len = strlen(signal_types[i].name);
161 if (strncmp(name, signal_types[i].name, len) == 0 &&
162 (name[len] == '\n' || name[len] == '\0'))
163 return signal_types[i].value;
165 return SPI_SIGNAL_UNKNOWN;
168 static int spi_host_setup(struct transport_container *tc, struct device *dev,
169 struct class_device *cdev)
171 struct Scsi_Host *shost = dev_to_shost(dev);
173 spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;
178 static DECLARE_TRANSPORT_CLASS(spi_host_class,
184 static int spi_host_match(struct attribute_container *cont,
187 struct Scsi_Host *shost;
188 struct spi_internal *i;
190 if (!scsi_is_host_device(dev))
193 shost = dev_to_shost(dev);
194 if (!shost->transportt || shost->transportt->host_attrs.ac.class
195 != &spi_host_class.class)
198 i = to_spi_internal(shost->transportt);
200 return &i->t.host_attrs.ac == cont;
203 static int spi_device_configure(struct transport_container *tc,
205 struct class_device *cdev)
207 struct scsi_device *sdev = to_scsi_device(dev);
208 struct scsi_target *starget = sdev->sdev_target;
210 /* Populate the target capability fields with the values
211 * gleaned from the device inquiry */
213 spi_support_sync(starget) = scsi_device_sync(sdev);
214 spi_support_wide(starget) = scsi_device_wide(sdev);
215 spi_support_dt(starget) = scsi_device_dt(sdev);
216 spi_support_dt_only(starget) = scsi_device_dt_only(sdev);
217 spi_support_ius(starget) = scsi_device_ius(sdev);
218 spi_support_qas(starget) = scsi_device_qas(sdev);
223 static int spi_setup_transport_attrs(struct transport_container *tc,
225 struct class_device *cdev)
227 struct scsi_target *starget = to_scsi_target(dev);
229 spi_period(starget) = -1; /* illegal value */
230 spi_min_period(starget) = 0;
231 spi_offset(starget) = 0; /* async */
232 spi_max_offset(starget) = 255;
233 spi_width(starget) = 0; /* narrow */
234 spi_max_width(starget) = 1;
235 spi_iu(starget) = 0; /* no IU */
236 spi_dt(starget) = 0; /* ST */
237 spi_qas(starget) = 0;
238 spi_wr_flow(starget) = 0;
239 spi_rd_strm(starget) = 0;
240 spi_rti(starget) = 0;
241 spi_pcomp_en(starget) = 0;
242 spi_hold_mcs(starget) = 0;
243 spi_dv_pending(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(struct class_device *cdev, char *buf,
407 int len = period_to_str(buf, period);
414 store_spi_transport_period_helper(struct class_device *cdev, const char *buf,
415 size_t count, int *periodp)
417 int j, picosec, period = -1;
420 picosec = simple_strtoul(buf, &endp, 10) * 1000;
427 picosec += (*endp - '0') * mult;
432 for (j = 0; j <= SPI_STATIC_PPR; j++) {
433 if (ppr_to_ps[j] < picosec)
440 period = picosec / 4000;
451 show_spi_transport_period(struct class_device *cdev, char *buf)
453 struct scsi_target *starget = transport_class_to_starget(cdev);
454 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
455 struct spi_internal *i = to_spi_internal(shost->transportt);
456 struct spi_transport_attrs *tp =
457 (struct spi_transport_attrs *)&starget->starget_data;
459 if (i->f->get_period)
460 i->f->get_period(starget);
462 return show_spi_transport_period_helper(cdev, buf, tp->period);
466 store_spi_transport_period(struct class_device *cdev, const char *buf,
469 struct scsi_target *starget = transport_class_to_starget(cdev);
470 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
471 struct spi_internal *i = to_spi_internal(shost->transportt);
472 struct spi_transport_attrs *tp =
473 (struct spi_transport_attrs *)&starget->starget_data;
476 retval = store_spi_transport_period_helper(cdev, buf, count, &period);
478 if (period < tp->min_period)
479 period = tp->min_period;
481 i->f->set_period(starget, period);
486 static CLASS_DEVICE_ATTR(period, S_IRUGO | S_IWUSR,
487 show_spi_transport_period,
488 store_spi_transport_period);
491 show_spi_transport_min_period(struct class_device *cdev, char *buf)
493 struct scsi_target *starget = transport_class_to_starget(cdev);
494 struct spi_transport_attrs *tp =
495 (struct spi_transport_attrs *)&starget->starget_data;
497 return show_spi_transport_period_helper(cdev, buf, tp->min_period);
501 store_spi_transport_min_period(struct class_device *cdev, const char *buf,
504 struct scsi_target *starget = transport_class_to_starget(cdev);
505 struct spi_transport_attrs *tp =
506 (struct spi_transport_attrs *)&starget->starget_data;
508 return store_spi_transport_period_helper(cdev, buf, count,
513 static CLASS_DEVICE_ATTR(min_period, S_IRUGO | S_IWUSR,
514 show_spi_transport_min_period,
515 store_spi_transport_min_period);
518 static ssize_t show_spi_host_signalling(struct class_device *cdev, char *buf)
520 struct Scsi_Host *shost = transport_class_to_shost(cdev);
521 struct spi_internal *i = to_spi_internal(shost->transportt);
523 if (i->f->get_signalling)
524 i->f->get_signalling(shost);
526 return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
528 static ssize_t store_spi_host_signalling(struct class_device *cdev,
529 const char *buf, size_t count)
531 struct Scsi_Host *shost = transport_class_to_shost(cdev);
532 struct spi_internal *i = to_spi_internal(shost->transportt);
533 enum spi_signal_type type = spi_signal_to_value(buf);
535 if (type != SPI_SIGNAL_UNKNOWN)
536 i->f->set_signalling(shost, type);
540 static CLASS_DEVICE_ATTR(signalling, S_IRUGO | S_IWUSR,
541 show_spi_host_signalling,
542 store_spi_host_signalling);
544 #define DV_SET(x, y) \
546 i->f->set_##x(sdev->sdev_target, y)
548 enum spi_compare_returns {
551 SPI_COMPARE_SKIP_TEST,
555 /* This is for read/write Domain Validation: If the device supports
556 * an echo buffer, we do read/write tests to it */
557 static enum spi_compare_returns
558 spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
559 u8 *ptr, const int retries)
561 int len = ptr - buffer;
563 unsigned int pattern = 0x0000ffff;
564 struct scsi_sense_hdr sshdr;
566 const char spi_write_buffer[] = {
567 WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
569 const char spi_read_buffer[] = {
570 READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
573 /* set up the pattern buffer. Doesn't matter if we spill
574 * slightly beyond since that's where the read buffer is */
575 for (j = 0; j < len; ) {
577 /* fill the buffer with counting (test a) */
578 for ( ; j < min(len, 32); j++)
581 /* fill the buffer with alternating words of 0x0 and
583 for ( ; j < min(len, k + 32); j += 2) {
584 u16 *word = (u16 *)&buffer[j];
586 *word = (j & 0x02) ? 0x0000 : 0xffff;
589 /* fill with crosstalk (alternating 0x5555 0xaaa)
591 for ( ; j < min(len, k + 32); j += 2) {
592 u16 *word = (u16 *)&buffer[j];
594 *word = (j & 0x02) ? 0x5555 : 0xaaaa;
597 /* fill with shifting bits (test d) */
598 for ( ; j < min(len, k + 32); j += 4) {
599 u32 *word = (unsigned int *)&buffer[j];
600 u32 roll = (pattern & 0x80000000) ? 1 : 0;
603 pattern = (pattern << 1) | roll;
605 /* don't bother with random data (test e) */
608 for (r = 0; r < retries; r++) {
609 result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
610 buffer, len, &sshdr);
611 if(result || !scsi_device_online(sdev)) {
613 scsi_device_set_state(sdev, SDEV_QUIESCE);
614 if (scsi_sense_valid(&sshdr)
615 && sshdr.sense_key == ILLEGAL_REQUEST
616 /* INVALID FIELD IN CDB */
617 && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
618 /* This would mean that the drive lied
619 * to us about supporting an echo
620 * buffer (unfortunately some Western
621 * Digital drives do precisely this)
623 return SPI_COMPARE_SKIP_TEST;
626 sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
627 return SPI_COMPARE_FAILURE;
631 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
633 scsi_device_set_state(sdev, SDEV_QUIESCE);
635 if (memcmp(buffer, ptr, len) != 0)
636 return SPI_COMPARE_FAILURE;
638 return SPI_COMPARE_SUCCESS;
641 /* This is for the simplest form of Domain Validation: a read test
642 * on the inquiry data from the device */
643 static enum spi_compare_returns
644 spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
645 u8 *ptr, const int retries)
648 const int len = sdev->inquiry_len;
649 const char spi_inquiry[] = {
650 INQUIRY, 0, 0, 0, len, 0
653 for (r = 0; r < retries; r++) {
656 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
659 if(result || !scsi_device_online(sdev)) {
660 scsi_device_set_state(sdev, SDEV_QUIESCE);
661 return SPI_COMPARE_FAILURE;
664 /* If we don't have the inquiry data already, the
665 * first read gets it */
672 if (memcmp(buffer, ptr, len) != 0)
674 return SPI_COMPARE_FAILURE;
676 return SPI_COMPARE_SUCCESS;
679 static enum spi_compare_returns
680 spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
681 enum spi_compare_returns
682 (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
684 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
685 struct scsi_target *starget = sdev->sdev_target;
686 int period = 0, prevperiod = 0;
687 enum spi_compare_returns retval;
692 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
694 if (retval == SPI_COMPARE_SUCCESS
695 || retval == SPI_COMPARE_SKIP_TEST)
698 /* OK, retrain, fallback */
700 i->f->get_iu(starget);
702 i->f->get_qas(starget);
703 if (i->f->get_period)
704 i->f->get_period(sdev->sdev_target);
706 /* Here's the fallback sequence; first try turning off
707 * IU, then QAS (if we can control them), then finally
708 * fall down the periods */
709 if (i->f->set_iu && spi_iu(starget)) {
710 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Information Units\n");
712 } else if (i->f->set_qas && spi_qas(starget)) {
713 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
716 newperiod = spi_period(starget);
717 period = newperiod > period ? newperiod : period;
721 period += period >> 1;
723 if (unlikely(period > 0xff || period == prevperiod)) {
724 /* Total failure; set to async and return */
725 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
727 return SPI_COMPARE_FAILURE;
729 starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
730 DV_SET(period, period);
738 spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
742 /* first off do a test unit ready. This can error out
743 * because of reservations or some other reason. If it
744 * fails, the device won't let us write to the echo buffer
745 * so just return failure */
747 const char spi_test_unit_ready[] = {
748 TEST_UNIT_READY, 0, 0, 0, 0, 0
751 const char spi_read_buffer_descriptor[] = {
752 READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
756 /* We send a set of three TURs to clear any outstanding
757 * unit attention conditions if they exist (Otherwise the
758 * buffer tests won't be happy). If the TUR still fails
759 * (reservation conflict, device not ready, etc) just
760 * skip the write tests */
762 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE,
774 result = spi_execute(sdev, spi_read_buffer_descriptor,
775 DMA_FROM_DEVICE, buffer, 4, NULL);
778 /* Device has no echo buffer */
781 return buffer[3] + ((buffer[2] & 0x1f) << 8);
785 spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
787 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
788 struct scsi_target *starget = sdev->sdev_target;
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))
836 /* Also try IU transfers */
837 if (scsi_device_ius(sdev))
839 if (spi_min_period(starget) < 9) {
840 /* This u320 (or u640). Ignore the coupled parameters
841 * like DT and IU, but set the optional ones */
845 if (spi_min_period(starget) == 8)
848 /* Do the read only INQUIRY tests */
849 spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
850 spi_dv_device_compare_inquiry);
851 /* See if we actually managed to negotiate and sustain DT */
853 i->f->get_dt(starget);
855 /* see if the device has an echo buffer. If it does we can do
856 * the SPI pattern write tests. Because of some broken
857 * devices, we *only* try this on a device that has actually
860 if (len == -1 && spi_dt(starget))
861 len = spi_dv_device_get_echo_buffer(sdev, buffer);
864 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
868 if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
869 starget_printk(KERN_WARNING, starget, "Echo buffer size %d is too big, trimming to %d\n", len, SPI_MAX_ECHO_BUFFER_SIZE);
870 len = SPI_MAX_ECHO_BUFFER_SIZE;
873 if (spi_dv_retrain(sdev, buffer, buffer + len,
874 spi_dv_device_echo_buffer)
875 == SPI_COMPARE_SKIP_TEST) {
876 /* OK, the stupid drive can't do a write echo buffer
877 * test after all, fall back to the read tests */
884 /** spi_dv_device - Do Domain Validation on the device
885 * @sdev: scsi device to validate
887 * Performs the domain validation on the given device in the
888 * current execution thread. Since DV operations may sleep,
889 * the current thread must have user context. Also no SCSI
890 * related locks that would deadlock I/O issued by the DV may
894 spi_dv_device(struct scsi_device *sdev)
896 struct scsi_target *starget = sdev->sdev_target;
898 const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
900 if (unlikely(scsi_device_get(sdev)))
903 buffer = kmalloc(len, GFP_KERNEL);
905 if (unlikely(!buffer))
908 memset(buffer, 0, len);
910 /* We need to verify that the actual device will quiesce; the
911 * later target quiesce is just a nice to have */
912 if (unlikely(scsi_device_quiesce(sdev)))
915 scsi_target_quiesce(starget);
917 spi_dv_pending(starget) = 1;
918 mutex_lock(&spi_dv_mutex(starget));
920 starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
922 spi_dv_device_internal(sdev, buffer);
924 starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
926 mutex_unlock(&spi_dv_mutex(starget));
927 spi_dv_pending(starget) = 0;
929 scsi_target_resume(starget);
931 spi_initial_dv(starget) = 1;
936 scsi_device_put(sdev);
938 EXPORT_SYMBOL(spi_dv_device);
940 struct work_queue_wrapper {
941 struct work_struct work;
942 struct scsi_device *sdev;
946 spi_dv_device_work_wrapper(void *data)
948 struct work_queue_wrapper *wqw = (struct work_queue_wrapper *)data;
949 struct scsi_device *sdev = wqw->sdev;
953 spi_dv_pending(sdev->sdev_target) = 0;
954 scsi_device_put(sdev);
959 * spi_schedule_dv_device - schedule domain validation to occur on the device
960 * @sdev: The device to validate
962 * Identical to spi_dv_device() above, except that the DV will be
963 * scheduled to occur in a workqueue later. All memory allocations
964 * are atomic, so may be called from any context including those holding
968 spi_schedule_dv_device(struct scsi_device *sdev)
970 struct work_queue_wrapper *wqw =
971 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
976 if (unlikely(spi_dv_pending(sdev->sdev_target))) {
980 /* Set pending early (dv_device doesn't check it, only sets it) */
981 spi_dv_pending(sdev->sdev_target) = 1;
982 if (unlikely(scsi_device_get(sdev))) {
984 spi_dv_pending(sdev->sdev_target) = 0;
988 INIT_WORK(&wqw->work, spi_dv_device_work_wrapper, wqw);
991 schedule_work(&wqw->work);
993 EXPORT_SYMBOL(spi_schedule_dv_device);
996 * spi_display_xfer_agreement - Print the current target transfer agreement
997 * @starget: The target for which to display the agreement
999 * Each SPI port is required to maintain a transfer agreement for each
1000 * other port on the bus. This function prints a one-line summary of
1001 * the current agreement; more detailed information is available in sysfs.
1003 void spi_display_xfer_agreement(struct scsi_target *starget)
1005 struct spi_transport_attrs *tp;
1006 tp = (struct spi_transport_attrs *)&starget->starget_data;
1008 if (tp->offset > 0 && tp->period > 0) {
1009 unsigned int picosec, kb100;
1010 char *scsi = "FAST-?";
1013 if (tp->period <= SPI_STATIC_PPR) {
1014 picosec = ppr_to_ps[tp->period];
1015 switch (tp->period) {
1016 case 7: scsi = "FAST-320"; break;
1017 case 8: scsi = "FAST-160"; break;
1018 case 9: scsi = "FAST-80"; break;
1020 case 11: scsi = "FAST-40"; break;
1021 case 12: scsi = "FAST-20"; break;
1024 picosec = tp->period * 4000;
1025 if (tp->period < 25)
1027 else if (tp->period < 50)
1033 kb100 = (10000000 + picosec / 2) / picosec;
1036 sprint_frac(tmp, picosec, 1000);
1038 dev_info(&starget->dev,
1039 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1040 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1041 tp->dt ? "DT" : "ST",
1042 tp->iu ? " IU" : "",
1043 tp->qas ? " QAS" : "",
1044 tp->rd_strm ? " RDSTRM" : "",
1045 tp->rti ? " RTI" : "",
1046 tp->wr_flow ? " WRFLOW" : "",
1047 tp->pcomp_en ? " PCOMP" : "",
1048 tp->hold_mcs ? " HMCS" : "",
1051 dev_info(&starget->dev, "%sasynchronous\n",
1052 tp->width ? "wide " : "");
1055 EXPORT_SYMBOL(spi_display_xfer_agreement);
1057 #ifdef CONFIG_SCSI_CONSTANTS
1058 static const char * const one_byte_msgs[] = {
1059 /* 0x00 */ "Command Complete", NULL, "Save Pointers",
1060 /* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error",
1061 /* 0x06 */ "Abort", "Message Reject", "Nop", "Message Parity Error",
1062 /* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
1063 /* 0x0c */ "Bus device reset", "Abort Tag", "Clear Queue",
1064 /* 0x0f */ "Initiate Recovery", "Release Recovery"
1067 static const char * const two_byte_msgs[] = {
1068 /* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
1069 /* 0x23 */ "Ignore Wide Residue"
1072 static const char * const extended_msgs[] = {
1073 /* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
1074 /* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
1075 /* 0x04 */ "Parallel Protocol Request"
1078 static void print_nego(const unsigned char *msg, int per, int off, int width)
1082 period_to_str(buf, msg[per]);
1083 printk("period = %s ns ", buf);
1087 printk("offset = %d ", msg[off]);
1089 printk("width = %d ", 8 << msg[width]);
1092 int spi_print_msg(const unsigned char *msg)
1095 if (msg[0] == EXTENDED_MESSAGE) {
1097 if (msg[2] < ARRAY_SIZE(extended_msgs))
1098 printk ("%s ", extended_msgs[msg[2]]);
1100 printk ("Extended Message, reserved code (0x%02x) ",
1103 case EXTENDED_MODIFY_DATA_POINTER:
1104 printk("pointer = %d", (int) (msg[3] << 24) |
1105 (msg[4] << 16) | (msg[5] << 8) | msg[6]);
1108 print_nego(msg, 3, 4, 0);
1111 print_nego(msg, 0, 0, 3);
1114 print_nego(msg, 3, 5, 6);
1117 for (i = 2; i < len; ++i)
1118 printk("%02x ", msg[i]);
1121 } else if (msg[0] & 0x80) {
1122 printk("Identify disconnect %sallowed %s %d ",
1123 (msg[0] & 0x40) ? "" : "not ",
1124 (msg[0] & 0x20) ? "target routine" : "lun",
1127 /* Normal One byte */
1128 } else if (msg[0] < 0x1f) {
1129 if (msg[0] < ARRAY_SIZE(one_byte_msgs))
1130 printk(one_byte_msgs[msg[0]]);
1132 printk("reserved (%02x) ", msg[0]);
1135 } else if (msg[0] <= 0x2f) {
1136 if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
1137 printk("%s %02x ", two_byte_msgs[msg[0] - 0x20],
1140 printk("reserved two byte (%02x %02x) ",
1147 EXPORT_SYMBOL(spi_print_msg);
1149 #else /* ifndef CONFIG_SCSI_CONSTANTS */
1151 int spi_print_msg(const unsigned char *msg)
1155 if (msg[0] == EXTENDED_MESSAGE) {
1157 for (i = 0; i < len; ++i)
1158 printk("%02x ", msg[i]);
1160 } else if (msg[0] & 0x80) {
1161 printk("%02x ", msg[0]);
1163 /* Normal One byte */
1164 } else if (msg[0] < 0x1f) {
1165 printk("%02x ", msg[0]);
1168 } else if (msg[0] <= 0x2f) {
1169 printk("%02x %02x", msg[0], msg[1]);
1172 printk("%02x ", msg[0]);
1175 EXPORT_SYMBOL(spi_print_msg);
1176 #endif /* ! CONFIG_SCSI_CONSTANTS */
1178 #define SETUP_ATTRIBUTE(field) \
1179 i->private_attrs[count] = class_device_attr_##field; \
1180 if (!i->f->set_##field) { \
1181 i->private_attrs[count].attr.mode = S_IRUGO; \
1182 i->private_attrs[count].store = NULL; \
1184 i->attrs[count] = &i->private_attrs[count]; \
1185 if (i->f->show_##field) \
1188 #define SETUP_RELATED_ATTRIBUTE(field, rel_field) \
1189 i->private_attrs[count] = class_device_attr_##field; \
1190 if (!i->f->set_##rel_field) { \
1191 i->private_attrs[count].attr.mode = S_IRUGO; \
1192 i->private_attrs[count].store = NULL; \
1194 i->attrs[count] = &i->private_attrs[count]; \
1195 if (i->f->show_##rel_field) \
1198 #define SETUP_HOST_ATTRIBUTE(field) \
1199 i->private_host_attrs[count] = class_device_attr_##field; \
1200 if (!i->f->set_##field) { \
1201 i->private_host_attrs[count].attr.mode = S_IRUGO; \
1202 i->private_host_attrs[count].store = NULL; \
1204 i->host_attrs[count] = &i->private_host_attrs[count]; \
1207 static int spi_device_match(struct attribute_container *cont,
1210 struct scsi_device *sdev;
1211 struct Scsi_Host *shost;
1212 struct spi_internal *i;
1214 if (!scsi_is_sdev_device(dev))
1217 sdev = to_scsi_device(dev);
1219 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1220 != &spi_host_class.class)
1222 /* Note: this class has no device attributes, so it has
1223 * no per-HBA allocation and thus we don't need to distinguish
1224 * the attribute containers for the device */
1225 i = to_spi_internal(shost->transportt);
1226 if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1231 static int spi_target_match(struct attribute_container *cont,
1234 struct Scsi_Host *shost;
1235 struct scsi_target *starget;
1236 struct spi_internal *i;
1238 if (!scsi_is_target_device(dev))
1241 shost = dev_to_shost(dev->parent);
1242 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1243 != &spi_host_class.class)
1246 i = to_spi_internal(shost->transportt);
1247 starget = to_scsi_target(dev);
1249 if (i->f->deny_binding && i->f->deny_binding(starget))
1252 return &i->t.target_attrs.ac == cont;
1255 static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1257 spi_setup_transport_attrs,
1261 static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1263 spi_device_configure);
1265 struct scsi_transport_template *
1266 spi_attach_transport(struct spi_function_template *ft)
1268 struct spi_internal *i = kmalloc(sizeof(struct spi_internal),
1274 memset(i, 0, sizeof(struct spi_internal));
1277 i->t.target_attrs.ac.class = &spi_transport_class.class;
1278 i->t.target_attrs.ac.attrs = &i->attrs[0];
1279 i->t.target_attrs.ac.match = spi_target_match;
1280 transport_container_register(&i->t.target_attrs);
1281 i->t.target_size = sizeof(struct spi_transport_attrs);
1282 i->t.host_attrs.ac.class = &spi_host_class.class;
1283 i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1284 i->t.host_attrs.ac.match = spi_host_match;
1285 transport_container_register(&i->t.host_attrs);
1286 i->t.host_size = sizeof(struct spi_host_attrs);
1289 SETUP_ATTRIBUTE(period);
1290 SETUP_RELATED_ATTRIBUTE(min_period, period);
1291 SETUP_ATTRIBUTE(offset);
1292 SETUP_RELATED_ATTRIBUTE(max_offset, offset);
1293 SETUP_ATTRIBUTE(width);
1294 SETUP_RELATED_ATTRIBUTE(max_width, width);
1295 SETUP_ATTRIBUTE(iu);
1296 SETUP_ATTRIBUTE(dt);
1297 SETUP_ATTRIBUTE(qas);
1298 SETUP_ATTRIBUTE(wr_flow);
1299 SETUP_ATTRIBUTE(rd_strm);
1300 SETUP_ATTRIBUTE(rti);
1301 SETUP_ATTRIBUTE(pcomp_en);
1302 SETUP_ATTRIBUTE(hold_mcs);
1304 /* if you add an attribute but forget to increase SPI_NUM_ATTRS
1305 * this bug will trigger */
1306 BUG_ON(count > SPI_NUM_ATTRS);
1308 i->attrs[count++] = &class_device_attr_revalidate;
1310 i->attrs[count] = NULL;
1313 SETUP_HOST_ATTRIBUTE(signalling);
1315 BUG_ON(count > SPI_HOST_ATTRS);
1317 i->host_attrs[count] = NULL;
1321 EXPORT_SYMBOL(spi_attach_transport);
1323 void spi_release_transport(struct scsi_transport_template *t)
1325 struct spi_internal *i = to_spi_internal(t);
1327 transport_container_unregister(&i->t.target_attrs);
1328 transport_container_unregister(&i->t.host_attrs);
1332 EXPORT_SYMBOL(spi_release_transport);
1334 static __init int spi_transport_init(void)
1336 int error = transport_class_register(&spi_transport_class);
1339 error = anon_transport_class_register(&spi_device_class);
1340 return transport_class_register(&spi_host_class);
1343 static void __exit spi_transport_exit(void)
1345 transport_class_unregister(&spi_transport_class);
1346 anon_transport_class_unregister(&spi_device_class);
1347 transport_class_unregister(&spi_host_class);
1350 MODULE_AUTHOR("Martin Hicks");
1351 MODULE_DESCRIPTION("SPI Transport Attributes");
1352 MODULE_LICENSE("GPL");
1354 module_init(spi_transport_init);
1355 module_exit(spi_transport_exit);