[SCSI] Move scsi_print_msg to SPI class
[linux-2.6.22.y-op.git] / drivers / scsi / scsi_transport_spi.c
blob00a73fc23fcc5fd43d45bae7fb6220191d23d999
1 /*
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 <asm/semaphore.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
39 * on" attributes */
40 #define SPI_HOST_ATTRS 1
42 #define SPI_MAX_ECHO_BUFFER_SIZE 4096
44 #define DV_LOOPS 3
45 #define DV_TIMEOUT (10*HZ)
46 #define DV_RETRIES 3 /* should only need at most
47 * two cc/ua clears */
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_sem(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_sem)
53 struct spi_internal {
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 */
70 -1, /* 0x00 */
71 -1, /* 0x01 */
72 -1, /* 0x02 */
73 -1, /* 0x03 */
74 -1, /* 0x04 */
75 -1, /* 0x05 */
76 -1, /* 0x06 */
77 3125, /* 0x07 */
78 6250, /* 0x08 */
79 12500, /* 0x09 */
80 25000, /* 0x0a */
81 30300, /* 0x0b */
82 50000, /* 0x0c */
84 /* The PPR values at which you calculate the period in ns by multiplying
85 * by 4 */
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);
93 if (frac == 0)
94 return result;
95 dest[result++] = '.';
97 do {
98 denom /= 10;
99 sprintf(dest + result, "%d", frac / denom);
100 result++;
101 frac %= denom;
102 } while (frac);
104 dest[result++] = '\0';
105 return result;
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)
113 int i, result;
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,
119 REQ_FAILFAST);
120 if (result & DRIVER_SENSE) {
121 struct scsi_sense_hdr sshdr_tmp;
122 if (!sshdr)
123 sshdr = &sshdr_tmp;
125 if (scsi_normalize_sense(sense, sizeof(*sense),
126 sshdr)
127 && sshdr->sense_key == UNIT_ATTENTION)
128 continue;
130 break;
132 return result;
135 static struct {
136 enum spi_signal_type value;
137 char *name;
138 } signal_types[] = {
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)
147 int i;
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;
153 return NULL;
155 static inline enum spi_signal_type spi_signal_to_value(const char *name)
157 int i, len;
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;
175 return 0;
178 static DECLARE_TRANSPORT_CLASS(spi_host_class,
179 "spi_host",
180 spi_host_setup,
181 NULL,
182 NULL);
184 static int spi_host_match(struct attribute_container *cont,
185 struct device *dev)
187 struct Scsi_Host *shost;
188 struct spi_internal *i;
190 if (!scsi_is_host_device(dev))
191 return 0;
193 shost = dev_to_shost(dev);
194 if (!shost->transportt || shost->transportt->host_attrs.ac.class
195 != &spi_host_class.class)
196 return 0;
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,
204 struct device *dev,
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);
220 return 0;
223 static int spi_setup_transport_attrs(struct transport_container *tc,
224 struct device *dev,
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 init_MUTEX(&spi_dv_sem(starget));
247 return 0;
250 #define spi_transport_show_simple(field, format_string) \
252 static ssize_t \
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) \
264 static ssize_t \
265 store_spi_transport_##field(struct class_device *cdev, const char *buf, \
266 size_t count) \
268 int val; \
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); \
274 tp->field = val; \
275 return count; \
278 #define spi_transport_show_function(field, format_string) \
280 static ssize_t \
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) \
294 static ssize_t \
295 store_spi_transport_##field(struct class_device *cdev, const char *buf, \
296 size_t count) \
298 int val; \
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); \
305 return count; \
308 #define spi_transport_store_max(field, format_string) \
309 static ssize_t \
310 store_spi_transport_##field(struct class_device *cdev, const char *buf, \
311 size_t count) \
313 int val; \
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); \
324 return count; \
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);
366 spi_dv_device(sdev);
367 return 1;
370 static ssize_t
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);
376 return count;
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 ssize_t
383 show_spi_transport_period_helper(struct class_device *cdev, char *buf,
384 int period)
386 int len, picosec;
388 if (period < 0 || period > 0xff) {
389 picosec = -1;
390 } else if (period <= SPI_STATIC_PPR) {
391 picosec = ppr_to_ps[period];
392 } else {
393 picosec = period * 4000;
396 if (picosec == -1) {
397 len = sprintf(buf, "reserved");
398 } else {
399 len = sprint_frac(buf, picosec, 1000);
402 buf[len++] = '\n';
403 buf[len] = '\0';
404 return len;
407 static ssize_t
408 store_spi_transport_period_helper(struct class_device *cdev, const char *buf,
409 size_t count, int *periodp)
411 int j, picosec, period = -1;
412 char *endp;
414 picosec = simple_strtoul(buf, &endp, 10) * 1000;
415 if (*endp == '.') {
416 int mult = 100;
417 do {
418 endp++;
419 if (!isdigit(*endp))
420 break;
421 picosec += (*endp - '0') * mult;
422 mult /= 10;
423 } while (mult > 0);
426 for (j = 0; j <= SPI_STATIC_PPR; j++) {
427 if (ppr_to_ps[j] < picosec)
428 continue;
429 period = j;
430 break;
433 if (period == -1)
434 period = picosec / 4000;
436 if (period > 0xff)
437 period = 0xff;
439 *periodp = period;
441 return count;
444 static ssize_t
445 show_spi_transport_period(struct class_device *cdev, char *buf)
447 struct scsi_target *starget = transport_class_to_starget(cdev);
448 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
449 struct spi_internal *i = to_spi_internal(shost->transportt);
450 struct spi_transport_attrs *tp =
451 (struct spi_transport_attrs *)&starget->starget_data;
453 if (i->f->get_period)
454 i->f->get_period(starget);
456 return show_spi_transport_period_helper(cdev, buf, tp->period);
459 static ssize_t
460 store_spi_transport_period(struct class_device *cdev, const char *buf,
461 size_t count)
463 struct scsi_target *starget = transport_class_to_starget(cdev);
464 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
465 struct spi_internal *i = to_spi_internal(shost->transportt);
466 struct spi_transport_attrs *tp =
467 (struct spi_transport_attrs *)&starget->starget_data;
468 int period, retval;
470 retval = store_spi_transport_period_helper(cdev, buf, count, &period);
472 if (period < tp->min_period)
473 period = tp->min_period;
475 i->f->set_period(starget, period);
477 return retval;
480 static CLASS_DEVICE_ATTR(period, S_IRUGO | S_IWUSR,
481 show_spi_transport_period,
482 store_spi_transport_period);
484 static ssize_t
485 show_spi_transport_min_period(struct class_device *cdev, char *buf)
487 struct scsi_target *starget = transport_class_to_starget(cdev);
488 struct spi_transport_attrs *tp =
489 (struct spi_transport_attrs *)&starget->starget_data;
491 return show_spi_transport_period_helper(cdev, buf, tp->min_period);
494 static ssize_t
495 store_spi_transport_min_period(struct class_device *cdev, const char *buf,
496 size_t count)
498 struct scsi_target *starget = transport_class_to_starget(cdev);
499 struct spi_transport_attrs *tp =
500 (struct spi_transport_attrs *)&starget->starget_data;
502 return store_spi_transport_period_helper(cdev, buf, count,
503 &tp->min_period);
507 static CLASS_DEVICE_ATTR(min_period, S_IRUGO | S_IWUSR,
508 show_spi_transport_min_period,
509 store_spi_transport_min_period);
512 static ssize_t show_spi_host_signalling(struct class_device *cdev, char *buf)
514 struct Scsi_Host *shost = transport_class_to_shost(cdev);
515 struct spi_internal *i = to_spi_internal(shost->transportt);
517 if (i->f->get_signalling)
518 i->f->get_signalling(shost);
520 return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
522 static ssize_t store_spi_host_signalling(struct class_device *cdev,
523 const char *buf, size_t count)
525 struct Scsi_Host *shost = transport_class_to_shost(cdev);
526 struct spi_internal *i = to_spi_internal(shost->transportt);
527 enum spi_signal_type type = spi_signal_to_value(buf);
529 if (type != SPI_SIGNAL_UNKNOWN)
530 i->f->set_signalling(shost, type);
532 return count;
534 static CLASS_DEVICE_ATTR(signalling, S_IRUGO | S_IWUSR,
535 show_spi_host_signalling,
536 store_spi_host_signalling);
538 #define DV_SET(x, y) \
539 if(i->f->set_##x) \
540 i->f->set_##x(sdev->sdev_target, y)
542 enum spi_compare_returns {
543 SPI_COMPARE_SUCCESS,
544 SPI_COMPARE_FAILURE,
545 SPI_COMPARE_SKIP_TEST,
549 /* This is for read/write Domain Validation: If the device supports
550 * an echo buffer, we do read/write tests to it */
551 static enum spi_compare_returns
552 spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
553 u8 *ptr, const int retries)
555 int len = ptr - buffer;
556 int j, k, r, result;
557 unsigned int pattern = 0x0000ffff;
558 struct scsi_sense_hdr sshdr;
560 const char spi_write_buffer[] = {
561 WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
563 const char spi_read_buffer[] = {
564 READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
567 /* set up the pattern buffer. Doesn't matter if we spill
568 * slightly beyond since that's where the read buffer is */
569 for (j = 0; j < len; ) {
571 /* fill the buffer with counting (test a) */
572 for ( ; j < min(len, 32); j++)
573 buffer[j] = j;
574 k = j;
575 /* fill the buffer with alternating words of 0x0 and
576 * 0xffff (test b) */
577 for ( ; j < min(len, k + 32); j += 2) {
578 u16 *word = (u16 *)&buffer[j];
580 *word = (j & 0x02) ? 0x0000 : 0xffff;
582 k = j;
583 /* fill with crosstalk (alternating 0x5555 0xaaa)
584 * (test c) */
585 for ( ; j < min(len, k + 32); j += 2) {
586 u16 *word = (u16 *)&buffer[j];
588 *word = (j & 0x02) ? 0x5555 : 0xaaaa;
590 k = j;
591 /* fill with shifting bits (test d) */
592 for ( ; j < min(len, k + 32); j += 4) {
593 u32 *word = (unsigned int *)&buffer[j];
594 u32 roll = (pattern & 0x80000000) ? 1 : 0;
596 *word = pattern;
597 pattern = (pattern << 1) | roll;
599 /* don't bother with random data (test e) */
602 for (r = 0; r < retries; r++) {
603 result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
604 buffer, len, &sshdr);
605 if(result || !scsi_device_online(sdev)) {
607 scsi_device_set_state(sdev, SDEV_QUIESCE);
608 if (scsi_sense_valid(&sshdr)
609 && sshdr.sense_key == ILLEGAL_REQUEST
610 /* INVALID FIELD IN CDB */
611 && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
612 /* This would mean that the drive lied
613 * to us about supporting an echo
614 * buffer (unfortunately some Western
615 * Digital drives do precisely this)
617 return SPI_COMPARE_SKIP_TEST;
620 sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
621 return SPI_COMPARE_FAILURE;
624 memset(ptr, 0, len);
625 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
626 ptr, len, NULL);
627 scsi_device_set_state(sdev, SDEV_QUIESCE);
629 if (memcmp(buffer, ptr, len) != 0)
630 return SPI_COMPARE_FAILURE;
632 return SPI_COMPARE_SUCCESS;
635 /* This is for the simplest form of Domain Validation: a read test
636 * on the inquiry data from the device */
637 static enum spi_compare_returns
638 spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
639 u8 *ptr, const int retries)
641 int r, result;
642 const int len = sdev->inquiry_len;
643 const char spi_inquiry[] = {
644 INQUIRY, 0, 0, 0, len, 0
647 for (r = 0; r < retries; r++) {
648 memset(ptr, 0, len);
650 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
651 ptr, len, NULL);
653 if(result || !scsi_device_online(sdev)) {
654 scsi_device_set_state(sdev, SDEV_QUIESCE);
655 return SPI_COMPARE_FAILURE;
658 /* If we don't have the inquiry data already, the
659 * first read gets it */
660 if (ptr == buffer) {
661 ptr += len;
662 --r;
663 continue;
666 if (memcmp(buffer, ptr, len) != 0)
667 /* failure */
668 return SPI_COMPARE_FAILURE;
670 return SPI_COMPARE_SUCCESS;
673 static enum spi_compare_returns
674 spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
675 enum spi_compare_returns
676 (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
678 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
679 struct scsi_target *starget = sdev->sdev_target;
680 int period = 0, prevperiod = 0;
681 enum spi_compare_returns retval;
684 for (;;) {
685 int newperiod;
686 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
688 if (retval == SPI_COMPARE_SUCCESS
689 || retval == SPI_COMPARE_SKIP_TEST)
690 break;
692 /* OK, retrain, fallback */
693 if (i->f->get_iu)
694 i->f->get_iu(starget);
695 if (i->f->get_qas)
696 i->f->get_qas(starget);
697 if (i->f->get_period)
698 i->f->get_period(sdev->sdev_target);
700 /* Here's the fallback sequence; first try turning off
701 * IU, then QAS (if we can control them), then finally
702 * fall down the periods */
703 if (i->f->set_iu && spi_iu(starget)) {
704 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Information Units\n");
705 DV_SET(iu, 0);
706 } else if (i->f->set_qas && spi_qas(starget)) {
707 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
708 DV_SET(qas, 0);
709 } else {
710 newperiod = spi_period(starget);
711 period = newperiod > period ? newperiod : period;
712 if (period < 0x0d)
713 period++;
714 else
715 period += period >> 1;
717 if (unlikely(period > 0xff || period == prevperiod)) {
718 /* Total failure; set to async and return */
719 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
720 DV_SET(offset, 0);
721 return SPI_COMPARE_FAILURE;
723 starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
724 DV_SET(period, period);
725 prevperiod = period;
728 return retval;
731 static int
732 spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
734 int l, result;
736 /* first off do a test unit ready. This can error out
737 * because of reservations or some other reason. If it
738 * fails, the device won't let us write to the echo buffer
739 * so just return failure */
741 const char spi_test_unit_ready[] = {
742 TEST_UNIT_READY, 0, 0, 0, 0, 0
745 const char spi_read_buffer_descriptor[] = {
746 READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
750 /* We send a set of three TURs to clear any outstanding
751 * unit attention conditions if they exist (Otherwise the
752 * buffer tests won't be happy). If the TUR still fails
753 * (reservation conflict, device not ready, etc) just
754 * skip the write tests */
755 for (l = 0; ; l++) {
756 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE,
757 NULL, 0, NULL);
759 if(result) {
760 if(l >= 3)
761 return 0;
762 } else {
763 /* TUR succeeded */
764 break;
768 result = spi_execute(sdev, spi_read_buffer_descriptor,
769 DMA_FROM_DEVICE, buffer, 4, NULL);
771 if (result)
772 /* Device has no echo buffer */
773 return 0;
775 return buffer[3] + ((buffer[2] & 0x1f) << 8);
778 static void
779 spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
781 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
782 struct scsi_target *starget = sdev->sdev_target;
783 int len = sdev->inquiry_len;
784 /* first set us up for narrow async */
785 DV_SET(offset, 0);
786 DV_SET(width, 0);
788 if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
789 != SPI_COMPARE_SUCCESS) {
790 starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
791 /* FIXME: should probably offline the device here? */
792 return;
795 /* test width */
796 if (i->f->set_width && spi_max_width(starget) &&
797 scsi_device_wide(sdev)) {
798 i->f->set_width(starget, 1);
800 if (spi_dv_device_compare_inquiry(sdev, buffer,
801 buffer + len,
802 DV_LOOPS)
803 != SPI_COMPARE_SUCCESS) {
804 starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
805 i->f->set_width(starget, 0);
809 if (!i->f->set_period)
810 return;
812 /* device can't handle synchronous */
813 if (!scsi_device_sync(sdev) && !scsi_device_dt(sdev))
814 return;
816 /* len == -1 is the signal that we need to ascertain the
817 * presence of an echo buffer before trying to use it. len ==
818 * 0 means we don't have an echo buffer */
819 len = -1;
821 retry:
823 /* now set up to the maximum */
824 DV_SET(offset, spi_max_offset(starget));
825 DV_SET(period, spi_min_period(starget));
826 /* try QAS requests; this should be harmless to set if the
827 * target supports it */
828 if (scsi_device_qas(sdev))
829 DV_SET(qas, 1);
830 /* Also try IU transfers */
831 if (scsi_device_ius(sdev))
832 DV_SET(iu, 1);
833 if (spi_min_period(starget) < 9) {
834 /* This u320 (or u640). Ignore the coupled parameters
835 * like DT and IU, but set the optional ones */
836 DV_SET(rd_strm, 1);
837 DV_SET(wr_flow, 1);
838 DV_SET(rti, 1);
839 if (spi_min_period(starget) == 8)
840 DV_SET(pcomp_en, 1);
842 /* Do the read only INQUIRY tests */
843 spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
844 spi_dv_device_compare_inquiry);
845 /* See if we actually managed to negotiate and sustain DT */
846 if (i->f->get_dt)
847 i->f->get_dt(starget);
849 /* see if the device has an echo buffer. If it does we can do
850 * the SPI pattern write tests. Because of some broken
851 * devices, we *only* try this on a device that has actually
852 * negotiated DT */
854 if (len == -1 && spi_dt(starget))
855 len = spi_dv_device_get_echo_buffer(sdev, buffer);
857 if (len <= 0) {
858 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
859 return;
862 if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
863 starget_printk(KERN_WARNING, starget, "Echo buffer size %d is too big, trimming to %d\n", len, SPI_MAX_ECHO_BUFFER_SIZE);
864 len = SPI_MAX_ECHO_BUFFER_SIZE;
867 if (spi_dv_retrain(sdev, buffer, buffer + len,
868 spi_dv_device_echo_buffer)
869 == SPI_COMPARE_SKIP_TEST) {
870 /* OK, the stupid drive can't do a write echo buffer
871 * test after all, fall back to the read tests */
872 len = 0;
873 goto retry;
878 /** spi_dv_device - Do Domain Validation on the device
879 * @sdev: scsi device to validate
881 * Performs the domain validation on the given device in the
882 * current execution thread. Since DV operations may sleep,
883 * the current thread must have user context. Also no SCSI
884 * related locks that would deadlock I/O issued by the DV may
885 * be held.
887 void
888 spi_dv_device(struct scsi_device *sdev)
890 struct scsi_target *starget = sdev->sdev_target;
891 u8 *buffer;
892 const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
894 if (unlikely(scsi_device_get(sdev)))
895 return;
897 buffer = kmalloc(len, GFP_KERNEL);
899 if (unlikely(!buffer))
900 goto out_put;
902 memset(buffer, 0, len);
904 /* We need to verify that the actual device will quiesce; the
905 * later target quiesce is just a nice to have */
906 if (unlikely(scsi_device_quiesce(sdev)))
907 goto out_free;
909 scsi_target_quiesce(starget);
911 spi_dv_pending(starget) = 1;
912 down(&spi_dv_sem(starget));
914 starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
916 spi_dv_device_internal(sdev, buffer);
918 starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
920 up(&spi_dv_sem(starget));
921 spi_dv_pending(starget) = 0;
923 scsi_target_resume(starget);
925 spi_initial_dv(starget) = 1;
927 out_free:
928 kfree(buffer);
929 out_put:
930 scsi_device_put(sdev);
932 EXPORT_SYMBOL(spi_dv_device);
934 struct work_queue_wrapper {
935 struct work_struct work;
936 struct scsi_device *sdev;
939 static void
940 spi_dv_device_work_wrapper(void *data)
942 struct work_queue_wrapper *wqw = (struct work_queue_wrapper *)data;
943 struct scsi_device *sdev = wqw->sdev;
945 kfree(wqw);
946 spi_dv_device(sdev);
947 spi_dv_pending(sdev->sdev_target) = 0;
948 scsi_device_put(sdev);
953 * spi_schedule_dv_device - schedule domain validation to occur on the device
954 * @sdev: The device to validate
956 * Identical to spi_dv_device() above, except that the DV will be
957 * scheduled to occur in a workqueue later. All memory allocations
958 * are atomic, so may be called from any context including those holding
959 * SCSI locks.
961 void
962 spi_schedule_dv_device(struct scsi_device *sdev)
964 struct work_queue_wrapper *wqw =
965 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
967 if (unlikely(!wqw))
968 return;
970 if (unlikely(spi_dv_pending(sdev->sdev_target))) {
971 kfree(wqw);
972 return;
974 /* Set pending early (dv_device doesn't check it, only sets it) */
975 spi_dv_pending(sdev->sdev_target) = 1;
976 if (unlikely(scsi_device_get(sdev))) {
977 kfree(wqw);
978 spi_dv_pending(sdev->sdev_target) = 0;
979 return;
982 INIT_WORK(&wqw->work, spi_dv_device_work_wrapper, wqw);
983 wqw->sdev = sdev;
985 schedule_work(&wqw->work);
987 EXPORT_SYMBOL(spi_schedule_dv_device);
990 * spi_display_xfer_agreement - Print the current target transfer agreement
991 * @starget: The target for which to display the agreement
993 * Each SPI port is required to maintain a transfer agreement for each
994 * other port on the bus. This function prints a one-line summary of
995 * the current agreement; more detailed information is available in sysfs.
997 void spi_display_xfer_agreement(struct scsi_target *starget)
999 struct spi_transport_attrs *tp;
1000 tp = (struct spi_transport_attrs *)&starget->starget_data;
1002 if (tp->offset > 0 && tp->period > 0) {
1003 unsigned int picosec, kb100;
1004 char *scsi = "FAST-?";
1005 char tmp[8];
1007 if (tp->period <= SPI_STATIC_PPR) {
1008 picosec = ppr_to_ps[tp->period];
1009 switch (tp->period) {
1010 case 7: scsi = "FAST-320"; break;
1011 case 8: scsi = "FAST-160"; break;
1012 case 9: scsi = "FAST-80"; break;
1013 case 10:
1014 case 11: scsi = "FAST-40"; break;
1015 case 12: scsi = "FAST-20"; break;
1017 } else {
1018 picosec = tp->period * 4000;
1019 if (tp->period < 25)
1020 scsi = "FAST-20";
1021 else if (tp->period < 50)
1022 scsi = "FAST-10";
1023 else
1024 scsi = "FAST-5";
1027 kb100 = (10000000 + picosec / 2) / picosec;
1028 if (tp->width)
1029 kb100 *= 2;
1030 sprint_frac(tmp, picosec, 1000);
1032 dev_info(&starget->dev,
1033 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1034 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1035 tp->dt ? "DT" : "ST",
1036 tp->iu ? " IU" : "",
1037 tp->qas ? " QAS" : "",
1038 tp->rd_strm ? " RDSTRM" : "",
1039 tp->rti ? " RTI" : "",
1040 tp->wr_flow ? " WRFLOW" : "",
1041 tp->pcomp_en ? " PCOMP" : "",
1042 tp->hold_mcs ? " HMCS" : "",
1043 tmp, tp->offset);
1044 } else {
1045 dev_info(&starget->dev, "%sasynchronous\n",
1046 tp->width ? "wide " : "");
1049 EXPORT_SYMBOL(spi_display_xfer_agreement);
1051 #ifdef CONFIG_SCSI_CONSTANTS
1052 static const char * const one_byte_msgs[] = {
1053 /* 0x00 */ "Command Complete", NULL, "Save Pointers",
1054 /* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error",
1055 /* 0x06 */ "Abort", "Message Reject", "Nop", "Message Parity Error",
1056 /* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
1057 /* 0x0c */ "Bus device reset", "Abort Tag", "Clear Queue",
1058 /* 0x0f */ "Initiate Recovery", "Release Recovery"
1060 #define NO_ONE_BYTE_MSGS (sizeof(one_byte_msgs) / sizeof (const char *))
1062 static const char * const two_byte_msgs[] = {
1063 /* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag"
1064 /* 0x23 */ "Ignore Wide Residue"
1066 #define NO_TWO_BYTE_MSGS (sizeof(two_byte_msgs) / sizeof (const char *))
1068 static const char * const extended_msgs[] = {
1069 /* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
1070 /* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request"
1072 #define NO_EXTENDED_MSGS (sizeof(two_byte_msgs) / sizeof (const char *))
1075 int scsi_print_msg (const unsigned char *msg)
1077 int len = 0, i;
1078 if (msg[0] == EXTENDED_MESSAGE) {
1079 len = 3 + msg[1];
1080 if (msg[2] < NO_EXTENDED_MSGS)
1081 printk ("%s ", extended_msgs[msg[2]]);
1082 else
1083 printk ("Extended Message, reserved code (0x%02x) ",
1084 (int) msg[2]);
1085 switch (msg[2]) {
1086 case EXTENDED_MODIFY_DATA_POINTER:
1087 printk("pointer = %d", (int) (msg[3] << 24) |
1088 (msg[4] << 16) | (msg[5] << 8) | msg[6]);
1089 break;
1090 case EXTENDED_SDTR:
1091 printk("period = %d ns, offset = %d",
1092 (int) msg[3] * 4, (int) msg[4]);
1093 break;
1094 case EXTENDED_WDTR:
1095 printk("width = 2^%d bytes", msg[3]);
1096 break;
1097 default:
1098 for (i = 2; i < len; ++i)
1099 printk("%02x ", msg[i]);
1101 /* Identify */
1102 } else if (msg[0] & 0x80) {
1103 printk("Identify disconnect %sallowed %s %d ",
1104 (msg[0] & 0x40) ? "" : "not ",
1105 (msg[0] & 0x20) ? "target routine" : "lun",
1106 msg[0] & 0x7);
1107 len = 1;
1108 /* Normal One byte */
1109 } else if (msg[0] < 0x1f) {
1110 if (msg[0] < NO_ONE_BYTE_MSGS)
1111 printk(one_byte_msgs[msg[0]]);
1112 else
1113 printk("reserved (%02x) ", msg[0]);
1114 len = 1;
1115 /* Two byte */
1116 } else if (msg[0] <= 0x2f) {
1117 if ((msg[0] - 0x20) < NO_TWO_BYTE_MSGS)
1118 printk("%s %02x ", two_byte_msgs[msg[0] - 0x20],
1119 msg[1]);
1120 else
1121 printk("reserved two byte (%02x %02x) ",
1122 msg[0], msg[1]);
1123 len = 2;
1124 } else
1125 printk("reserved");
1126 return len;
1128 EXPORT_SYMBOL(scsi_print_msg);
1130 #else /* ifndef CONFIG_SCSI_CONSTANTS */
1132 int scsi_print_msg (const unsigned char *msg)
1134 int len = 0, i;
1136 if (msg[0] == EXTENDED_MESSAGE) {
1137 len = 3 + msg[1];
1138 for (i = 0; i < len; ++i)
1139 printk("%02x ", msg[i]);
1140 /* Identify */
1141 } else if (msg[0] & 0x80) {
1142 printk("%02x ", msg[0]);
1143 len = 1;
1144 /* Normal One byte */
1145 } else if (msg[0] < 0x1f) {
1146 printk("%02x ", msg[0]);
1147 len = 1;
1148 /* Two byte */
1149 } else if (msg[0] <= 0x2f) {
1150 printk("%02x %02x", msg[0], msg[1]);
1151 len = 2;
1152 } else
1153 printk("%02x ", msg[0]);
1154 return len;
1156 EXPORT_SYMBOL(scsi_print_msg);
1157 #endif /* ! CONFIG_SCSI_CONSTANTS */
1159 #define SETUP_ATTRIBUTE(field) \
1160 i->private_attrs[count] = class_device_attr_##field; \
1161 if (!i->f->set_##field) { \
1162 i->private_attrs[count].attr.mode = S_IRUGO; \
1163 i->private_attrs[count].store = NULL; \
1165 i->attrs[count] = &i->private_attrs[count]; \
1166 if (i->f->show_##field) \
1167 count++
1169 #define SETUP_RELATED_ATTRIBUTE(field, rel_field) \
1170 i->private_attrs[count] = class_device_attr_##field; \
1171 if (!i->f->set_##rel_field) { \
1172 i->private_attrs[count].attr.mode = S_IRUGO; \
1173 i->private_attrs[count].store = NULL; \
1175 i->attrs[count] = &i->private_attrs[count]; \
1176 if (i->f->show_##rel_field) \
1177 count++
1179 #define SETUP_HOST_ATTRIBUTE(field) \
1180 i->private_host_attrs[count] = class_device_attr_##field; \
1181 if (!i->f->set_##field) { \
1182 i->private_host_attrs[count].attr.mode = S_IRUGO; \
1183 i->private_host_attrs[count].store = NULL; \
1185 i->host_attrs[count] = &i->private_host_attrs[count]; \
1186 count++
1188 static int spi_device_match(struct attribute_container *cont,
1189 struct device *dev)
1191 struct scsi_device *sdev;
1192 struct Scsi_Host *shost;
1193 struct spi_internal *i;
1195 if (!scsi_is_sdev_device(dev))
1196 return 0;
1198 sdev = to_scsi_device(dev);
1199 shost = sdev->host;
1200 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1201 != &spi_host_class.class)
1202 return 0;
1203 /* Note: this class has no device attributes, so it has
1204 * no per-HBA allocation and thus we don't need to distinguish
1205 * the attribute containers for the device */
1206 i = to_spi_internal(shost->transportt);
1207 if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1208 return 0;
1209 return 1;
1212 static int spi_target_match(struct attribute_container *cont,
1213 struct device *dev)
1215 struct Scsi_Host *shost;
1216 struct scsi_target *starget;
1217 struct spi_internal *i;
1219 if (!scsi_is_target_device(dev))
1220 return 0;
1222 shost = dev_to_shost(dev->parent);
1223 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1224 != &spi_host_class.class)
1225 return 0;
1227 i = to_spi_internal(shost->transportt);
1228 starget = to_scsi_target(dev);
1230 if (i->f->deny_binding && i->f->deny_binding(starget))
1231 return 0;
1233 return &i->t.target_attrs.ac == cont;
1236 static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1237 "spi_transport",
1238 spi_setup_transport_attrs,
1239 NULL,
1240 NULL);
1242 static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1243 spi_device_match,
1244 spi_device_configure);
1246 struct scsi_transport_template *
1247 spi_attach_transport(struct spi_function_template *ft)
1249 struct spi_internal *i = kmalloc(sizeof(struct spi_internal),
1250 GFP_KERNEL);
1251 int count = 0;
1252 if (unlikely(!i))
1253 return NULL;
1255 memset(i, 0, sizeof(struct spi_internal));
1258 i->t.target_attrs.ac.class = &spi_transport_class.class;
1259 i->t.target_attrs.ac.attrs = &i->attrs[0];
1260 i->t.target_attrs.ac.match = spi_target_match;
1261 transport_container_register(&i->t.target_attrs);
1262 i->t.target_size = sizeof(struct spi_transport_attrs);
1263 i->t.host_attrs.ac.class = &spi_host_class.class;
1264 i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1265 i->t.host_attrs.ac.match = spi_host_match;
1266 transport_container_register(&i->t.host_attrs);
1267 i->t.host_size = sizeof(struct spi_host_attrs);
1268 i->f = ft;
1270 SETUP_ATTRIBUTE(period);
1271 SETUP_RELATED_ATTRIBUTE(min_period, period);
1272 SETUP_ATTRIBUTE(offset);
1273 SETUP_RELATED_ATTRIBUTE(max_offset, offset);
1274 SETUP_ATTRIBUTE(width);
1275 SETUP_RELATED_ATTRIBUTE(max_width, width);
1276 SETUP_ATTRIBUTE(iu);
1277 SETUP_ATTRIBUTE(dt);
1278 SETUP_ATTRIBUTE(qas);
1279 SETUP_ATTRIBUTE(wr_flow);
1280 SETUP_ATTRIBUTE(rd_strm);
1281 SETUP_ATTRIBUTE(rti);
1282 SETUP_ATTRIBUTE(pcomp_en);
1283 SETUP_ATTRIBUTE(hold_mcs);
1285 /* if you add an attribute but forget to increase SPI_NUM_ATTRS
1286 * this bug will trigger */
1287 BUG_ON(count > SPI_NUM_ATTRS);
1289 i->attrs[count++] = &class_device_attr_revalidate;
1291 i->attrs[count] = NULL;
1293 count = 0;
1294 SETUP_HOST_ATTRIBUTE(signalling);
1296 BUG_ON(count > SPI_HOST_ATTRS);
1298 i->host_attrs[count] = NULL;
1300 return &i->t;
1302 EXPORT_SYMBOL(spi_attach_transport);
1304 void spi_release_transport(struct scsi_transport_template *t)
1306 struct spi_internal *i = to_spi_internal(t);
1308 transport_container_unregister(&i->t.target_attrs);
1309 transport_container_unregister(&i->t.host_attrs);
1311 kfree(i);
1313 EXPORT_SYMBOL(spi_release_transport);
1315 static __init int spi_transport_init(void)
1317 int error = transport_class_register(&spi_transport_class);
1318 if (error)
1319 return error;
1320 error = anon_transport_class_register(&spi_device_class);
1321 return transport_class_register(&spi_host_class);
1324 static void __exit spi_transport_exit(void)
1326 transport_class_unregister(&spi_transport_class);
1327 anon_transport_class_unregister(&spi_device_class);
1328 transport_class_unregister(&spi_host_class);
1331 MODULE_AUTHOR("Martin Hicks");
1332 MODULE_DESCRIPTION("SPI Transport Attributes");
1333 MODULE_LICENSE("GPL");
1335 module_init(spi_transport_init);
1336 module_exit(spi_transport_exit);