Merge branch 'fixes-jgarzik' of git://git.kernel.org/pub/scm/linux/kernel/git/linvill...
[linux-2.6] / drivers / scsi / scsi_transport_spi.c
1 /* 
2  *  Parallel SCSI (SPI) transport specific attributes exported to sysfs.
3  *
4  *  Copyright (c) 2003 Silicon Graphics, Inc.  All rights reserved.
5  *  Copyright (c) 2004, 2005 James Bottomley <James.Bottomley@SteelEye.com>
6  *
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.
11  *
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.
16  *
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
20  */
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>
35
36 #define SPI_NUM_ATTRS 14        /* increase this if you add attributes */
37 #define SPI_OTHER_ATTRS 1       /* Increase this if you add "always
38                                  * on" attributes */
39 #define SPI_HOST_ATTRS  1
40
41 #define SPI_MAX_ECHO_BUFFER_SIZE        4096
42
43 #define DV_LOOPS        3
44 #define DV_TIMEOUT      (10*HZ)
45 #define DV_RETRIES      3       /* should only need at most 
46                                  * two cc/ua clears */
47
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)
51
52 struct spi_internal {
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];
62 };
63
64 #define to_spi_internal(tmpl)   container_of(tmpl, struct spi_internal, t)
65
66 static const int ppr_to_ps[] = {
67         /* The PPR values 0-6 are reserved, fill them in when
68          * the committee defines them */
69         -1,                     /* 0x00 */
70         -1,                     /* 0x01 */
71         -1,                     /* 0x02 */
72         -1,                     /* 0x03 */
73         -1,                     /* 0x04 */
74         -1,                     /* 0x05 */
75         -1,                     /* 0x06 */
76          3125,                  /* 0x07 */
77          6250,                  /* 0x08 */
78         12500,                  /* 0x09 */
79         25000,                  /* 0x0a */
80         30300,                  /* 0x0b */
81         50000,                  /* 0x0c */
82 };
83 /* The PPR values at which you calculate the period in ns by multiplying
84  * by 4 */
85 #define SPI_STATIC_PPR  0x0c
86
87 static int sprint_frac(char *dest, int value, int denom)
88 {
89         int frac = value % denom;
90         int result = sprintf(dest, "%d", value / denom);
91
92         if (frac == 0)
93                 return result;
94         dest[result++] = '.';
95
96         do {
97                 denom /= 10;
98                 sprintf(dest + result, "%d", frac / denom);
99                 result++;
100                 frac %= denom;
101         } while (frac);
102
103         dest[result++] = '\0';
104         return result;
105 }
106
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)
111 {
112         int i, result;
113         unsigned char sense[SCSI_SENSE_BUFFERSIZE];
114
115         for(i = 0; i < DV_RETRIES; i++) {
116                 result = scsi_execute(sdev, cmd, dir, buffer, bufflen,
117                                       sense, DV_TIMEOUT, /* retries */ 1,
118                                       REQ_FAILFAST);
119                 if (result & DRIVER_SENSE) {
120                         struct scsi_sense_hdr sshdr_tmp;
121                         if (!sshdr)
122                                 sshdr = &sshdr_tmp;
123
124                         if (scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE,
125                                                  sshdr)
126                             && sshdr->sense_key == UNIT_ATTENTION)
127                                 continue;
128                 }
129                 break;
130         }
131         return result;
132 }
133
134 static struct {
135         enum spi_signal_type    value;
136         char                    *name;
137 } signal_types[] = {
138         { SPI_SIGNAL_UNKNOWN, "unknown" },
139         { SPI_SIGNAL_SE, "SE" },
140         { SPI_SIGNAL_LVD, "LVD" },
141         { SPI_SIGNAL_HVD, "HVD" },
142 };
143
144 static inline const char *spi_signal_to_string(enum spi_signal_type type)
145 {
146         int i;
147
148         for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
149                 if (type == signal_types[i].value)
150                         return signal_types[i].name;
151         }
152         return NULL;
153 }
154 static inline enum spi_signal_type spi_signal_to_value(const char *name)
155 {
156         int i, len;
157
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;
163         }
164         return SPI_SIGNAL_UNKNOWN;
165 }
166
167 static int spi_host_setup(struct transport_container *tc, struct device *dev,
168                           struct class_device *cdev)
169 {
170         struct Scsi_Host *shost = dev_to_shost(dev);
171
172         spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;
173
174         return 0;
175 }
176
177 static DECLARE_TRANSPORT_CLASS(spi_host_class,
178                                "spi_host",
179                                spi_host_setup,
180                                NULL,
181                                NULL);
182
183 static int spi_host_match(struct attribute_container *cont,
184                           struct device *dev)
185 {
186         struct Scsi_Host *shost;
187         struct spi_internal *i;
188
189         if (!scsi_is_host_device(dev))
190                 return 0;
191
192         shost = dev_to_shost(dev);
193         if (!shost->transportt  || shost->transportt->host_attrs.ac.class
194             != &spi_host_class.class)
195                 return 0;
196
197         i = to_spi_internal(shost->transportt);
198         
199         return &i->t.host_attrs.ac == cont;
200 }
201
202 static int spi_device_configure(struct transport_container *tc,
203                                 struct device *dev,
204                                 struct class_device *cdev)
205 {
206         struct scsi_device *sdev = to_scsi_device(dev);
207         struct scsi_target *starget = sdev->sdev_target;
208
209         /* Populate the target capability fields with the values
210          * gleaned from the device inquiry */
211
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);
218
219         return 0;
220 }
221
222 static int spi_setup_transport_attrs(struct transport_container *tc,
223                                      struct device *dev,
224                                      struct class_device *cdev)
225 {
226         struct scsi_target *starget = to_scsi_target(dev);
227
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));
246
247         return 0;
248 }
249
250 #define spi_transport_show_simple(field, format_string)                 \
251                                                                         \
252 static ssize_t                                                          \
253 show_spi_transport_##field(struct class_device *cdev, char *buf)        \
254 {                                                                       \
255         struct scsi_target *starget = transport_class_to_starget(cdev); \
256         struct spi_transport_attrs *tp;                                 \
257                                                                         \
258         tp = (struct spi_transport_attrs *)&starget->starget_data;      \
259         return snprintf(buf, 20, format_string, tp->field);             \
260 }
261
262 #define spi_transport_store_simple(field, format_string)                \
263                                                                         \
264 static ssize_t                                                          \
265 store_spi_transport_##field(struct class_device *cdev, const char *buf, \
266                             size_t count)                               \
267 {                                                                       \
268         int val;                                                        \
269         struct scsi_target *starget = transport_class_to_starget(cdev); \
270         struct spi_transport_attrs *tp;                                 \
271                                                                         \
272         tp = (struct spi_transport_attrs *)&starget->starget_data;      \
273         val = simple_strtoul(buf, NULL, 0);                             \
274         tp->field = val;                                                \
275         return count;                                                   \
276 }
277
278 #define spi_transport_show_function(field, format_string)               \
279                                                                         \
280 static ssize_t                                                          \
281 show_spi_transport_##field(struct class_device *cdev, char *buf)        \
282 {                                                                       \
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);             \
291 }
292
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)                               \
297 {                                                                       \
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);    \
302                                                                         \
303         val = simple_strtoul(buf, NULL, 0);                             \
304         i->f->set_##field(starget, val);                        \
305         return count;                                                   \
306 }
307
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)                               \
312 {                                                                       \
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; \
319                                                                         \
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;                                                   \
325 }
326
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);
333
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);
340
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);
348
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");
360
361 /* we only care about the first child device so we return 1 */
362 static int child_iter(struct device *dev, void *data)
363 {
364         struct scsi_device *sdev = to_scsi_device(dev);
365
366         spi_dv_device(sdev);
367         return 1;
368 }
369
370 static ssize_t
371 store_spi_revalidate(struct class_device *cdev, const char *buf, size_t count)
372 {
373         struct scsi_target *starget = transport_class_to_starget(cdev);
374
375         device_for_each_child(&starget->dev, NULL, child_iter);
376         return count;
377 }
378 static CLASS_DEVICE_ATTR(revalidate, S_IWUSR, NULL, store_spi_revalidate);
379
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)
383 {
384         int len, picosec;
385
386         if (period < 0 || period > 0xff) {
387                 picosec = -1;
388         } else if (period <= SPI_STATIC_PPR) {
389                 picosec = ppr_to_ps[period];
390         } else {
391                 picosec = period * 4000;
392         }
393
394         if (picosec == -1) {
395                 len = sprintf(buf, "reserved");
396         } else {
397                 len = sprint_frac(buf, picosec, 1000);
398         }
399
400         return len;
401 }
402
403 static ssize_t
404 show_spi_transport_period_helper(char *buf, int period)
405 {
406         int len = period_to_str(buf, period);
407         buf[len++] = '\n';
408         buf[len] = '\0';
409         return len;
410 }
411
412 static ssize_t
413 store_spi_transport_period_helper(struct class_device *cdev, const char *buf,
414                                   size_t count, int *periodp)
415 {
416         int j, picosec, period = -1;
417         char *endp;
418
419         picosec = simple_strtoul(buf, &endp, 10) * 1000;
420         if (*endp == '.') {
421                 int mult = 100;
422                 do {
423                         endp++;
424                         if (!isdigit(*endp))
425                                 break;
426                         picosec += (*endp - '0') * mult;
427                         mult /= 10;
428                 } while (mult > 0);
429         }
430
431         for (j = 0; j <= SPI_STATIC_PPR; j++) {
432                 if (ppr_to_ps[j] < picosec)
433                         continue;
434                 period = j;
435                 break;
436         }
437
438         if (period == -1)
439                 period = picosec / 4000;
440
441         if (period > 0xff)
442                 period = 0xff;
443
444         *periodp = period;
445
446         return count;
447 }
448
449 static ssize_t
450 show_spi_transport_period(struct class_device *cdev, char *buf)
451 {
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;
457
458         if (i->f->get_period)
459                 i->f->get_period(starget);
460
461         return show_spi_transport_period_helper(buf, tp->period);
462 }
463
464 static ssize_t
465 store_spi_transport_period(struct class_device *cdev, const char *buf,
466                             size_t count)
467 {
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;
473         int period, retval;
474
475         retval = store_spi_transport_period_helper(cdev, buf, count, &period);
476
477         if (period < tp->min_period)
478                 period = tp->min_period;
479
480         i->f->set_period(starget, period);
481
482         return retval;
483 }
484
485 static CLASS_DEVICE_ATTR(period, S_IRUGO | S_IWUSR, 
486                          show_spi_transport_period,
487                          store_spi_transport_period);
488
489 static ssize_t
490 show_spi_transport_min_period(struct class_device *cdev, char *buf)
491 {
492         struct scsi_target *starget = transport_class_to_starget(cdev);
493         struct spi_transport_attrs *tp =
494                 (struct spi_transport_attrs *)&starget->starget_data;
495
496         return show_spi_transport_period_helper(buf, tp->min_period);
497 }
498
499 static ssize_t
500 store_spi_transport_min_period(struct class_device *cdev, const char *buf,
501                             size_t count)
502 {
503         struct scsi_target *starget = transport_class_to_starget(cdev);
504         struct spi_transport_attrs *tp =
505                 (struct spi_transport_attrs *)&starget->starget_data;
506
507         return store_spi_transport_period_helper(cdev, buf, count,
508                                                  &tp->min_period);
509 }
510
511
512 static CLASS_DEVICE_ATTR(min_period, S_IRUGO | S_IWUSR, 
513                          show_spi_transport_min_period,
514                          store_spi_transport_min_period);
515
516
517 static ssize_t show_spi_host_signalling(struct class_device *cdev, char *buf)
518 {
519         struct Scsi_Host *shost = transport_class_to_shost(cdev);
520         struct spi_internal *i = to_spi_internal(shost->transportt);
521
522         if (i->f->get_signalling)
523                 i->f->get_signalling(shost);
524
525         return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
526 }
527 static ssize_t store_spi_host_signalling(struct class_device *cdev,
528                                          const char *buf, size_t count)
529 {
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);
533
534         if (type != SPI_SIGNAL_UNKNOWN)
535                 i->f->set_signalling(shost, type);
536
537         return count;
538 }
539 static CLASS_DEVICE_ATTR(signalling, S_IRUGO | S_IWUSR,
540                          show_spi_host_signalling,
541                          store_spi_host_signalling);
542
543 #define DV_SET(x, y)                    \
544         if(i->f->set_##x)               \
545                 i->f->set_##x(sdev->sdev_target, y)
546
547 enum spi_compare_returns {
548         SPI_COMPARE_SUCCESS,
549         SPI_COMPARE_FAILURE,
550         SPI_COMPARE_SKIP_TEST,
551 };
552
553
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)
559 {
560         int len = ptr - buffer;
561         int j, k, r, result;
562         unsigned int pattern = 0x0000ffff;
563         struct scsi_sense_hdr sshdr;
564
565         const char spi_write_buffer[] = {
566                 WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
567         };
568         const char spi_read_buffer[] = {
569                 READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
570         };
571
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; ) {
575
576                 /* fill the buffer with counting (test a) */
577                 for ( ; j < min(len, 32); j++)
578                         buffer[j] = j;
579                 k = j;
580                 /* fill the buffer with alternating words of 0x0 and
581                  * 0xffff (test b) */
582                 for ( ; j < min(len, k + 32); j += 2) {
583                         u16 *word = (u16 *)&buffer[j];
584                         
585                         *word = (j & 0x02) ? 0x0000 : 0xffff;
586                 }
587                 k = j;
588                 /* fill with crosstalk (alternating 0x5555 0xaaa)
589                  * (test c) */
590                 for ( ; j < min(len, k + 32); j += 2) {
591                         u16 *word = (u16 *)&buffer[j];
592
593                         *word = (j & 0x02) ? 0x5555 : 0xaaaa;
594                 }
595                 k = j;
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;
600                         
601                         *word = pattern;
602                         pattern = (pattern << 1) | roll;
603                 }
604                 /* don't bother with random data (test e) */
605         }
606
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)) {
611
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)
621                                  */
622                                 return SPI_COMPARE_SKIP_TEST;
623
624
625                         sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
626                         return SPI_COMPARE_FAILURE;
627                 }
628
629                 memset(ptr, 0, len);
630                 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
631                             ptr, len, NULL);
632                 scsi_device_set_state(sdev, SDEV_QUIESCE);
633
634                 if (memcmp(buffer, ptr, len) != 0)
635                         return SPI_COMPARE_FAILURE;
636         }
637         return SPI_COMPARE_SUCCESS;
638 }
639
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)
645 {
646         int r, result;
647         const int len = sdev->inquiry_len;
648         const char spi_inquiry[] = {
649                 INQUIRY, 0, 0, 0, len, 0
650         };
651
652         for (r = 0; r < retries; r++) {
653                 memset(ptr, 0, len);
654
655                 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
656                                      ptr, len, NULL);
657                 
658                 if(result || !scsi_device_online(sdev)) {
659                         scsi_device_set_state(sdev, SDEV_QUIESCE);
660                         return SPI_COMPARE_FAILURE;
661                 }
662
663                 /* If we don't have the inquiry data already, the
664                  * first read gets it */
665                 if (ptr == buffer) {
666                         ptr += len;
667                         --r;
668                         continue;
669                 }
670
671                 if (memcmp(buffer, ptr, len) != 0)
672                         /* failure */
673                         return SPI_COMPARE_FAILURE;
674         }
675         return SPI_COMPARE_SUCCESS;
676 }
677
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))
682 {
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;
687
688
689         for (;;) {
690                 int newperiod;
691                 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
692
693                 if (retval == SPI_COMPARE_SUCCESS
694                     || retval == SPI_COMPARE_SKIP_TEST)
695                         break;
696
697                 /* OK, retrain, fallback */
698                 if (i->f->get_iu)
699                         i->f->get_iu(starget);
700                 if (i->f->get_qas)
701                         i->f->get_qas(starget);
702                 if (i->f->get_period)
703                         i->f->get_period(sdev->sdev_target);
704
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");
710                         DV_SET(iu, 0);
711                 } else if (i->f->set_qas && spi_qas(starget)) {
712                         starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
713                         DV_SET(qas, 0);
714                 } else {
715                         newperiod = spi_period(starget);
716                         period = newperiod > period ? newperiod : period;
717                         if (period < 0x0d)
718                                 period++;
719                         else
720                                 period += period >> 1;
721
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");
725                                 DV_SET(offset, 0);
726                                 return SPI_COMPARE_FAILURE;
727                         }
728                         starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
729                         DV_SET(period, period);
730                         prevperiod = period;
731                 }
732         }
733         return retval;
734 }
735
736 static int
737 spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
738 {
739         int l, result;
740
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 */
745         
746         const char spi_test_unit_ready[] = {
747                 TEST_UNIT_READY, 0, 0, 0, 0, 0
748         };
749
750         const char spi_read_buffer_descriptor[] = {
751                 READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
752         };
753
754         
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 */
760         for (l = 0; ; l++) {
761                 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE, 
762                                      NULL, 0, NULL);
763
764                 if(result) {
765                         if(l >= 3)
766                                 return 0;
767                 } else {
768                         /* TUR succeeded */
769                         break;
770                 }
771         }
772
773         result = spi_execute(sdev, spi_read_buffer_descriptor, 
774                              DMA_FROM_DEVICE, buffer, 4, NULL);
775
776         if (result)
777                 /* Device has no echo buffer */
778                 return 0;
779
780         return buffer[3] + ((buffer[2] & 0x1f) << 8);
781 }
782
783 static void
784 spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
785 {
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         int min_period = spi_min_period(starget);
791         int max_width = spi_max_width(starget);
792         /* first set us up for narrow async */
793         DV_SET(offset, 0);
794         DV_SET(width, 0);
795
796         if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
797             != SPI_COMPARE_SUCCESS) {
798                 starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
799                 /* FIXME: should probably offline the device here? */
800                 return;
801         }
802
803         if (!scsi_device_wide(sdev)) {
804                 spi_max_width(starget) = 0;
805                 max_width = 0;
806         }
807
808         /* test width */
809         if (i->f->set_width && max_width) {
810                 i->f->set_width(starget, 1);
811
812                 if (spi_dv_device_compare_inquiry(sdev, buffer,
813                                                    buffer + len,
814                                                    DV_LOOPS)
815                     != SPI_COMPARE_SUCCESS) {
816                         starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
817                         i->f->set_width(starget, 0);
818                         /* Make sure we don't force wide back on by asking
819                          * for a transfer period that requires it */
820                         max_width = 0;
821                         if (min_period < 10)
822                                 min_period = 10;
823                 }
824         }
825
826         if (!i->f->set_period)
827                 return;
828
829         /* device can't handle synchronous */
830         if (!scsi_device_sync(sdev) && !scsi_device_dt(sdev))
831                 return;
832
833         /* len == -1 is the signal that we need to ascertain the
834          * presence of an echo buffer before trying to use it.  len ==
835          * 0 means we don't have an echo buffer */
836         len = -1;
837
838  retry:
839
840         /* now set up to the maximum */
841         DV_SET(offset, spi_max_offset(starget));
842         DV_SET(period, min_period);
843
844         /* try QAS requests; this should be harmless to set if the
845          * target supports it */
846         if (scsi_device_qas(sdev)) {
847                 DV_SET(qas, 1);
848         } else {
849                 DV_SET(qas, 0);
850         }
851
852         if (scsi_device_ius(sdev) && min_period < 9) {
853                 /* This u320 (or u640). Set IU transfers */
854                 DV_SET(iu, 1);
855                 /* Then set the optional parameters */
856                 DV_SET(rd_strm, 1);
857                 DV_SET(wr_flow, 1);
858                 DV_SET(rti, 1);
859                 if (min_period == 8)
860                         DV_SET(pcomp_en, 1);
861         } else {
862                 DV_SET(iu, 0);
863         }
864
865         /* now that we've done all this, actually check the bus
866          * signal type (if known).  Some devices are stupid on
867          * a SE bus and still claim they can try LVD only settings */
868         if (i->f->get_signalling)
869                 i->f->get_signalling(shost);
870         if (spi_signalling(shost) == SPI_SIGNAL_SE ||
871             spi_signalling(shost) == SPI_SIGNAL_HVD ||
872             !scsi_device_dt(sdev)) {
873                 DV_SET(dt, 0);
874         } else {
875                 DV_SET(dt, 1);
876         }
877         /* set width last because it will pull all the other
878          * parameters down to required values */
879         DV_SET(width, max_width);
880
881         /* Do the read only INQUIRY tests */
882         spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
883                        spi_dv_device_compare_inquiry);
884         /* See if we actually managed to negotiate and sustain DT */
885         if (i->f->get_dt)
886                 i->f->get_dt(starget);
887
888         /* see if the device has an echo buffer.  If it does we can do
889          * the SPI pattern write tests.  Because of some broken
890          * devices, we *only* try this on a device that has actually
891          * negotiated DT */
892
893         if (len == -1 && spi_dt(starget))
894                 len = spi_dv_device_get_echo_buffer(sdev, buffer);
895
896         if (len <= 0) {
897                 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
898                 return;
899         }
900
901         if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
902                 starget_printk(KERN_WARNING, starget, "Echo buffer size %d is too big, trimming to %d\n", len, SPI_MAX_ECHO_BUFFER_SIZE);
903                 len = SPI_MAX_ECHO_BUFFER_SIZE;
904         }
905
906         if (spi_dv_retrain(sdev, buffer, buffer + len,
907                            spi_dv_device_echo_buffer)
908             == SPI_COMPARE_SKIP_TEST) {
909                 /* OK, the stupid drive can't do a write echo buffer
910                  * test after all, fall back to the read tests */
911                 len = 0;
912                 goto retry;
913         }
914 }
915
916
917 /**     spi_dv_device - Do Domain Validation on the device
918  *      @sdev:          scsi device to validate
919  *
920  *      Performs the domain validation on the given device in the
921  *      current execution thread.  Since DV operations may sleep,
922  *      the current thread must have user context.  Also no SCSI
923  *      related locks that would deadlock I/O issued by the DV may
924  *      be held.
925  */
926 void
927 spi_dv_device(struct scsi_device *sdev)
928 {
929         struct scsi_target *starget = sdev->sdev_target;
930         u8 *buffer;
931         const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
932
933         if (unlikely(scsi_device_get(sdev)))
934                 return;
935
936         if (unlikely(spi_dv_in_progress(starget)))
937                 return;
938         spi_dv_in_progress(starget) = 1;
939
940         buffer = kzalloc(len, GFP_KERNEL);
941
942         if (unlikely(!buffer))
943                 goto out_put;
944
945         /* We need to verify that the actual device will quiesce; the
946          * later target quiesce is just a nice to have */
947         if (unlikely(scsi_device_quiesce(sdev)))
948                 goto out_free;
949
950         scsi_target_quiesce(starget);
951
952         spi_dv_pending(starget) = 1;
953         mutex_lock(&spi_dv_mutex(starget));
954
955         starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
956
957         spi_dv_device_internal(sdev, buffer);
958
959         starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
960
961         mutex_unlock(&spi_dv_mutex(starget));
962         spi_dv_pending(starget) = 0;
963
964         scsi_target_resume(starget);
965
966         spi_initial_dv(starget) = 1;
967
968  out_free:
969         kfree(buffer);
970  out_put:
971         spi_dv_in_progress(starget) = 0;
972         scsi_device_put(sdev);
973 }
974 EXPORT_SYMBOL(spi_dv_device);
975
976 struct work_queue_wrapper {
977         struct work_struct      work;
978         struct scsi_device      *sdev;
979 };
980
981 static void
982 spi_dv_device_work_wrapper(struct work_struct *work)
983 {
984         struct work_queue_wrapper *wqw =
985                 container_of(work, struct work_queue_wrapper, work);
986         struct scsi_device *sdev = wqw->sdev;
987
988         kfree(wqw);
989         spi_dv_device(sdev);
990         spi_dv_pending(sdev->sdev_target) = 0;
991         scsi_device_put(sdev);
992 }
993
994
995 /**
996  *      spi_schedule_dv_device - schedule domain validation to occur on the device
997  *      @sdev:  The device to validate
998  *
999  *      Identical to spi_dv_device() above, except that the DV will be
1000  *      scheduled to occur in a workqueue later.  All memory allocations
1001  *      are atomic, so may be called from any context including those holding
1002  *      SCSI locks.
1003  */
1004 void
1005 spi_schedule_dv_device(struct scsi_device *sdev)
1006 {
1007         struct work_queue_wrapper *wqw =
1008                 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
1009
1010         if (unlikely(!wqw))
1011                 return;
1012
1013         if (unlikely(spi_dv_pending(sdev->sdev_target))) {
1014                 kfree(wqw);
1015                 return;
1016         }
1017         /* Set pending early (dv_device doesn't check it, only sets it) */
1018         spi_dv_pending(sdev->sdev_target) = 1;
1019         if (unlikely(scsi_device_get(sdev))) {
1020                 kfree(wqw);
1021                 spi_dv_pending(sdev->sdev_target) = 0;
1022                 return;
1023         }
1024
1025         INIT_WORK(&wqw->work, spi_dv_device_work_wrapper);
1026         wqw->sdev = sdev;
1027
1028         schedule_work(&wqw->work);
1029 }
1030 EXPORT_SYMBOL(spi_schedule_dv_device);
1031
1032 /**
1033  * spi_display_xfer_agreement - Print the current target transfer agreement
1034  * @starget: The target for which to display the agreement
1035  *
1036  * Each SPI port is required to maintain a transfer agreement for each
1037  * other port on the bus.  This function prints a one-line summary of
1038  * the current agreement; more detailed information is available in sysfs.
1039  */
1040 void spi_display_xfer_agreement(struct scsi_target *starget)
1041 {
1042         struct spi_transport_attrs *tp;
1043         tp = (struct spi_transport_attrs *)&starget->starget_data;
1044
1045         if (tp->offset > 0 && tp->period > 0) {
1046                 unsigned int picosec, kb100;
1047                 char *scsi = "FAST-?";
1048                 char tmp[8];
1049
1050                 if (tp->period <= SPI_STATIC_PPR) {
1051                         picosec = ppr_to_ps[tp->period];
1052                         switch (tp->period) {
1053                                 case  7: scsi = "FAST-320"; break;
1054                                 case  8: scsi = "FAST-160"; break;
1055                                 case  9: scsi = "FAST-80"; break;
1056                                 case 10:
1057                                 case 11: scsi = "FAST-40"; break;
1058                                 case 12: scsi = "FAST-20"; break;
1059                         }
1060                 } else {
1061                         picosec = tp->period * 4000;
1062                         if (tp->period < 25)
1063                                 scsi = "FAST-20";
1064                         else if (tp->period < 50)
1065                                 scsi = "FAST-10";
1066                         else
1067                                 scsi = "FAST-5";
1068                 }
1069
1070                 kb100 = (10000000 + picosec / 2) / picosec;
1071                 if (tp->width)
1072                         kb100 *= 2;
1073                 sprint_frac(tmp, picosec, 1000);
1074
1075                 dev_info(&starget->dev,
1076                          "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1077                          scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1078                          tp->dt ? "DT" : "ST",
1079                          tp->iu ? " IU" : "",
1080                          tp->qas  ? " QAS" : "",
1081                          tp->rd_strm ? " RDSTRM" : "",
1082                          tp->rti ? " RTI" : "",
1083                          tp->wr_flow ? " WRFLOW" : "",
1084                          tp->pcomp_en ? " PCOMP" : "",
1085                          tp->hold_mcs ? " HMCS" : "",
1086                          tmp, tp->offset);
1087         } else {
1088                 dev_info(&starget->dev, "%sasynchronous\n",
1089                                 tp->width ? "wide " : "");
1090         }
1091 }
1092 EXPORT_SYMBOL(spi_display_xfer_agreement);
1093
1094 int spi_populate_width_msg(unsigned char *msg, int width)
1095 {
1096         msg[0] = EXTENDED_MESSAGE;
1097         msg[1] = 2;
1098         msg[2] = EXTENDED_WDTR;
1099         msg[3] = width;
1100         return 4;
1101 }
1102 EXPORT_SYMBOL_GPL(spi_populate_width_msg);
1103
1104 int spi_populate_sync_msg(unsigned char *msg, int period, int offset)
1105 {
1106         msg[0] = EXTENDED_MESSAGE;
1107         msg[1] = 3;
1108         msg[2] = EXTENDED_SDTR;
1109         msg[3] = period;
1110         msg[4] = offset;
1111         return 5;
1112 }
1113 EXPORT_SYMBOL_GPL(spi_populate_sync_msg);
1114
1115 int spi_populate_ppr_msg(unsigned char *msg, int period, int offset,
1116                 int width, int options)
1117 {
1118         msg[0] = EXTENDED_MESSAGE;
1119         msg[1] = 6;
1120         msg[2] = EXTENDED_PPR;
1121         msg[3] = period;
1122         msg[4] = 0;
1123         msg[5] = offset;
1124         msg[6] = width;
1125         msg[7] = options;
1126         return 8;
1127 }
1128 EXPORT_SYMBOL_GPL(spi_populate_ppr_msg);
1129
1130 #ifdef CONFIG_SCSI_CONSTANTS
1131 static const char * const one_byte_msgs[] = {
1132 /* 0x00 */ "Task Complete", NULL /* Extended Message */, "Save Pointers",
1133 /* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error", 
1134 /* 0x06 */ "Abort Task Set", "Message Reject", "Nop", "Message Parity Error",
1135 /* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
1136 /* 0x0c */ "Target Reset", "Abort Task", "Clear Task Set", 
1137 /* 0x0f */ "Initiate Recovery", "Release Recovery",
1138 /* 0x11 */ "Terminate Process", "Continue Task", "Target Transfer Disable",
1139 /* 0x14 */ NULL, NULL, "Clear ACA", "LUN Reset"
1140 };
1141
1142 static const char * const two_byte_msgs[] = {
1143 /* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
1144 /* 0x23 */ "Ignore Wide Residue", "ACA"
1145 };
1146
1147 static const char * const extended_msgs[] = {
1148 /* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
1149 /* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
1150 /* 0x04 */ "Parallel Protocol Request", "Modify Bidirectional Data Pointer"
1151 };
1152
1153 static void print_nego(const unsigned char *msg, int per, int off, int width)
1154 {
1155         if (per) {
1156                 char buf[20];
1157                 period_to_str(buf, msg[per]);
1158                 printk("period = %s ns ", buf);
1159         }
1160
1161         if (off)
1162                 printk("offset = %d ", msg[off]);
1163         if (width)
1164                 printk("width = %d ", 8 << msg[width]);
1165 }
1166
1167 static void print_ptr(const unsigned char *msg, int msb, const char *desc)
1168 {
1169         int ptr = (msg[msb] << 24) | (msg[msb+1] << 16) | (msg[msb+2] << 8) |
1170                         msg[msb+3];
1171         printk("%s = %d ", desc, ptr);
1172 }
1173
1174 int spi_print_msg(const unsigned char *msg)
1175 {
1176         int len = 1, i;
1177         if (msg[0] == EXTENDED_MESSAGE) {
1178                 len = 2 + msg[1];
1179                 if (len == 2)
1180                         len += 256;
1181                 if (msg[2] < ARRAY_SIZE(extended_msgs))
1182                         printk ("%s ", extended_msgs[msg[2]]); 
1183                 else 
1184                         printk ("Extended Message, reserved code (0x%02x) ",
1185                                 (int) msg[2]);
1186                 switch (msg[2]) {
1187                 case EXTENDED_MODIFY_DATA_POINTER:
1188                         print_ptr(msg, 3, "pointer");
1189                         break;
1190                 case EXTENDED_SDTR:
1191                         print_nego(msg, 3, 4, 0);
1192                         break;
1193                 case EXTENDED_WDTR:
1194                         print_nego(msg, 0, 0, 3);
1195                         break;
1196                 case EXTENDED_PPR:
1197                         print_nego(msg, 3, 5, 6);
1198                         break;
1199                 case EXTENDED_MODIFY_BIDI_DATA_PTR:
1200                         print_ptr(msg, 3, "out");
1201                         print_ptr(msg, 7, "in");
1202                         break;
1203                 default:
1204                 for (i = 2; i < len; ++i) 
1205                         printk("%02x ", msg[i]);
1206                 }
1207         /* Identify */
1208         } else if (msg[0] & 0x80) {
1209                 printk("Identify disconnect %sallowed %s %d ",
1210                         (msg[0] & 0x40) ? "" : "not ",
1211                         (msg[0] & 0x20) ? "target routine" : "lun",
1212                         msg[0] & 0x7);
1213         /* Normal One byte */
1214         } else if (msg[0] < 0x1f) {
1215                 if (msg[0] < ARRAY_SIZE(one_byte_msgs) && one_byte_msgs[msg[0]])
1216                         printk("%s ", one_byte_msgs[msg[0]]);
1217                 else
1218                         printk("reserved (%02x) ", msg[0]);
1219         } else if (msg[0] == 0x55) {
1220                 printk("QAS Request ");
1221         /* Two byte */
1222         } else if (msg[0] <= 0x2f) {
1223                 if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
1224                         printk("%s %02x ", two_byte_msgs[msg[0] - 0x20], 
1225                                 msg[1]);
1226                 else 
1227                         printk("reserved two byte (%02x %02x) ", 
1228                                 msg[0], msg[1]);
1229                 len = 2;
1230         } else 
1231                 printk("reserved ");
1232         return len;
1233 }
1234 EXPORT_SYMBOL(spi_print_msg);
1235
1236 #else  /* ifndef CONFIG_SCSI_CONSTANTS */
1237
1238 int spi_print_msg(const unsigned char *msg)
1239 {
1240         int len = 1, i;
1241
1242         if (msg[0] == EXTENDED_MESSAGE) {
1243                 len = 2 + msg[1];
1244                 if (len == 2)
1245                         len += 256;
1246                 for (i = 0; i < len; ++i)
1247                         printk("%02x ", msg[i]);
1248         /* Identify */
1249         } else if (msg[0] & 0x80) {
1250                 printk("%02x ", msg[0]);
1251         /* Normal One byte */
1252         } else if ((msg[0] < 0x1f) || (msg[0] == 0x55)) {
1253                 printk("%02x ", msg[0]);
1254         /* Two byte */
1255         } else if (msg[0] <= 0x2f) {
1256                 printk("%02x %02x", msg[0], msg[1]);
1257                 len = 2;
1258         } else 
1259                 printk("%02x ", msg[0]);
1260         return len;
1261 }
1262 EXPORT_SYMBOL(spi_print_msg);
1263 #endif /* ! CONFIG_SCSI_CONSTANTS */
1264
1265 #define SETUP_ATTRIBUTE(field)                                          \
1266         i->private_attrs[count] = class_device_attr_##field;            \
1267         if (!i->f->set_##field) {                                       \
1268                 i->private_attrs[count].attr.mode = S_IRUGO;            \
1269                 i->private_attrs[count].store = NULL;                   \
1270         }                                                               \
1271         i->attrs[count] = &i->private_attrs[count];                     \
1272         if (i->f->show_##field)                                         \
1273                 count++
1274
1275 #define SETUP_RELATED_ATTRIBUTE(field, rel_field)                       \
1276         i->private_attrs[count] = class_device_attr_##field;            \
1277         if (!i->f->set_##rel_field) {                                   \
1278                 i->private_attrs[count].attr.mode = S_IRUGO;            \
1279                 i->private_attrs[count].store = NULL;                   \
1280         }                                                               \
1281         i->attrs[count] = &i->private_attrs[count];                     \
1282         if (i->f->show_##rel_field)                                     \
1283                 count++
1284
1285 #define SETUP_HOST_ATTRIBUTE(field)                                     \
1286         i->private_host_attrs[count] = class_device_attr_##field;       \
1287         if (!i->f->set_##field) {                                       \
1288                 i->private_host_attrs[count].attr.mode = S_IRUGO;       \
1289                 i->private_host_attrs[count].store = NULL;              \
1290         }                                                               \
1291         i->host_attrs[count] = &i->private_host_attrs[count];           \
1292         count++
1293
1294 static int spi_device_match(struct attribute_container *cont,
1295                             struct device *dev)
1296 {
1297         struct scsi_device *sdev;
1298         struct Scsi_Host *shost;
1299         struct spi_internal *i;
1300
1301         if (!scsi_is_sdev_device(dev))
1302                 return 0;
1303
1304         sdev = to_scsi_device(dev);
1305         shost = sdev->host;
1306         if (!shost->transportt  || shost->transportt->host_attrs.ac.class
1307             != &spi_host_class.class)
1308                 return 0;
1309         /* Note: this class has no device attributes, so it has
1310          * no per-HBA allocation and thus we don't need to distinguish
1311          * the attribute containers for the device */
1312         i = to_spi_internal(shost->transportt);
1313         if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1314                 return 0;
1315         return 1;
1316 }
1317
1318 static int spi_target_match(struct attribute_container *cont,
1319                             struct device *dev)
1320 {
1321         struct Scsi_Host *shost;
1322         struct scsi_target *starget;
1323         struct spi_internal *i;
1324
1325         if (!scsi_is_target_device(dev))
1326                 return 0;
1327
1328         shost = dev_to_shost(dev->parent);
1329         if (!shost->transportt  || shost->transportt->host_attrs.ac.class
1330             != &spi_host_class.class)
1331                 return 0;
1332
1333         i = to_spi_internal(shost->transportt);
1334         starget = to_scsi_target(dev);
1335
1336         if (i->f->deny_binding && i->f->deny_binding(starget))
1337                 return 0;
1338
1339         return &i->t.target_attrs.ac == cont;
1340 }
1341
1342 static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1343                                "spi_transport",
1344                                spi_setup_transport_attrs,
1345                                NULL,
1346                                NULL);
1347
1348 static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1349                                     spi_device_match,
1350                                     spi_device_configure);
1351
1352 struct scsi_transport_template *
1353 spi_attach_transport(struct spi_function_template *ft)
1354 {
1355         int count = 0;
1356         struct spi_internal *i = kzalloc(sizeof(struct spi_internal),
1357                                          GFP_KERNEL);
1358
1359         if (unlikely(!i))
1360                 return NULL;
1361
1362         i->t.target_attrs.ac.class = &spi_transport_class.class;
1363         i->t.target_attrs.ac.attrs = &i->attrs[0];
1364         i->t.target_attrs.ac.match = spi_target_match;
1365         transport_container_register(&i->t.target_attrs);
1366         i->t.target_size = sizeof(struct spi_transport_attrs);
1367         i->t.host_attrs.ac.class = &spi_host_class.class;
1368         i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1369         i->t.host_attrs.ac.match = spi_host_match;
1370         transport_container_register(&i->t.host_attrs);
1371         i->t.host_size = sizeof(struct spi_host_attrs);
1372         i->f = ft;
1373
1374         SETUP_ATTRIBUTE(period);
1375         SETUP_RELATED_ATTRIBUTE(min_period, period);
1376         SETUP_ATTRIBUTE(offset);
1377         SETUP_RELATED_ATTRIBUTE(max_offset, offset);
1378         SETUP_ATTRIBUTE(width);
1379         SETUP_RELATED_ATTRIBUTE(max_width, width);
1380         SETUP_ATTRIBUTE(iu);
1381         SETUP_ATTRIBUTE(dt);
1382         SETUP_ATTRIBUTE(qas);
1383         SETUP_ATTRIBUTE(wr_flow);
1384         SETUP_ATTRIBUTE(rd_strm);
1385         SETUP_ATTRIBUTE(rti);
1386         SETUP_ATTRIBUTE(pcomp_en);
1387         SETUP_ATTRIBUTE(hold_mcs);
1388
1389         /* if you add an attribute but forget to increase SPI_NUM_ATTRS
1390          * this bug will trigger */
1391         BUG_ON(count > SPI_NUM_ATTRS);
1392
1393         i->attrs[count++] = &class_device_attr_revalidate;
1394
1395         i->attrs[count] = NULL;
1396
1397         count = 0;
1398         SETUP_HOST_ATTRIBUTE(signalling);
1399
1400         BUG_ON(count > SPI_HOST_ATTRS);
1401
1402         i->host_attrs[count] = NULL;
1403
1404         return &i->t;
1405 }
1406 EXPORT_SYMBOL(spi_attach_transport);
1407
1408 void spi_release_transport(struct scsi_transport_template *t)
1409 {
1410         struct spi_internal *i = to_spi_internal(t);
1411
1412         transport_container_unregister(&i->t.target_attrs);
1413         transport_container_unregister(&i->t.host_attrs);
1414
1415         kfree(i);
1416 }
1417 EXPORT_SYMBOL(spi_release_transport);
1418
1419 static __init int spi_transport_init(void)
1420 {
1421         int error = transport_class_register(&spi_transport_class);
1422         if (error)
1423                 return error;
1424         error = anon_transport_class_register(&spi_device_class);
1425         return transport_class_register(&spi_host_class);
1426 }
1427
1428 static void __exit spi_transport_exit(void)
1429 {
1430         transport_class_unregister(&spi_transport_class);
1431         anon_transport_class_unregister(&spi_device_class);
1432         transport_class_unregister(&spi_host_class);
1433 }
1434
1435 MODULE_AUTHOR("Martin Hicks");
1436 MODULE_DESCRIPTION("SPI Transport Attributes");
1437 MODULE_LICENSE("GPL");
1438
1439 module_init(spi_transport_init);
1440 module_exit(spi_transport_exit);