blob: 7ee95eb83ddaa52c5fe1aa50a52642b150293eba [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 */
Matthew Wilcox410ca5c2005-12-15 16:22:01 -050021#include <linux/config.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/ctype.h>
23#include <linux/init.h>
24#include <linux/module.h>
25#include <linux/workqueue.h>
James Bottomley949bf792005-05-01 18:58:15 -050026#include <linux/blkdev.h>
Jes Sorensend158d262006-01-13 16:05:44 -080027#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <scsi/scsi.h>
29#include "scsi_priv.h"
30#include <scsi/scsi_device.h>
31#include <scsi/scsi_host.h>
James Bottomley33aa6872005-08-28 11:31:14 -050032#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <scsi/scsi_eh.h>
34#include <scsi/scsi_transport.h>
35#include <scsi/scsi_transport_spi.h>
36
James Bottomleyd872ebe2005-08-03 15:43:52 -050037#define SPI_NUM_ATTRS 14 /* increase this if you add attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#define SPI_OTHER_ATTRS 1 /* Increase this if you add "always
39 * on" attributes */
40#define SPI_HOST_ATTRS 1
41
42#define SPI_MAX_ECHO_BUFFER_SIZE 4096
43
James Bottomley949bf792005-05-01 18:58:15 -050044#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 */
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/* 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)
Jes Sorensend158d262006-01-13 16:05:44 -080051#define spi_dv_mutex(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_mutex)
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53struct 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];
63};
64
65#define to_spi_internal(tmpl) container_of(tmpl, struct spi_internal, t)
66
67static 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 */
83};
84/* The PPR values at which you calculate the period in ns by multiplying
85 * by 4 */
86#define SPI_STATIC_PPR 0x0c
87
88static int sprint_frac(char *dest, int value, int denom)
89{
90 int frac = value % denom;
91 int result = sprintf(dest, "%d", value / denom);
92
93 if (frac == 0)
94 return result;
95 dest[result++] = '.';
96
97 do {
98 denom /= 10;
99 sprintf(dest + result, "%d", frac / denom);
100 result++;
101 frac %= denom;
102 } while (frac);
103
104 dest[result++] = '\0';
105 return result;
106}
107
James Bottomley33aa6872005-08-28 11:31:14 -0500108static 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)
James Bottomley949bf792005-05-01 18:58:15 -0500112{
James Bottomley33aa6872005-08-28 11:31:14 -0500113 int i, result;
114 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
James Bottomley949bf792005-05-01 18:58:15 -0500115
116 for(i = 0; i < DV_RETRIES; i++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500117 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;
James Bottomley949bf792005-05-01 18:58:15 -0500124
James Bottomley33aa6872005-08-28 11:31:14 -0500125 if (scsi_normalize_sense(sense, sizeof(*sense),
126 sshdr)
127 && sshdr->sense_key == UNIT_ATTENTION)
James Bottomley949bf792005-05-01 18:58:15 -0500128 continue;
129 }
130 break;
131 }
James Bottomley33aa6872005-08-28 11:31:14 -0500132 return result;
James Bottomley949bf792005-05-01 18:58:15 -0500133}
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135static 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" },
143};
144
145static inline const char *spi_signal_to_string(enum spi_signal_type type)
146{
147 int i;
148
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;
152 }
153 return NULL;
154}
155static inline enum spi_signal_type spi_signal_to_value(const char *name)
156{
157 int i, len;
158
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;
164 }
165 return SPI_SIGNAL_UNKNOWN;
166}
167
James Bottomleyd0a7e572005-08-14 17:09:01 -0500168static int spi_host_setup(struct transport_container *tc, struct device *dev,
169 struct class_device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
171 struct Scsi_Host *shost = dev_to_shost(dev);
172
173 spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;
174
175 return 0;
176}
177
178static DECLARE_TRANSPORT_CLASS(spi_host_class,
179 "spi_host",
180 spi_host_setup,
181 NULL,
182 NULL);
183
184static int spi_host_match(struct attribute_container *cont,
185 struct device *dev)
186{
187 struct Scsi_Host *shost;
188 struct spi_internal *i;
189
190 if (!scsi_is_host_device(dev))
191 return 0;
192
193 shost = dev_to_shost(dev);
194 if (!shost->transportt || shost->transportt->host_attrs.ac.class
195 != &spi_host_class.class)
196 return 0;
197
198 i = to_spi_internal(shost->transportt);
199
200 return &i->t.host_attrs.ac == cont;
201}
202
James Bottomleyd0a7e572005-08-14 17:09:01 -0500203static int spi_device_configure(struct transport_container *tc,
204 struct device *dev,
205 struct class_device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206{
207 struct scsi_device *sdev = to_scsi_device(dev);
208 struct scsi_target *starget = sdev->sdev_target;
209
210 /* Populate the target capability fields with the values
211 * gleaned from the device inquiry */
212
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);
219
220 return 0;
221}
222
James Bottomleyd0a7e572005-08-14 17:09:01 -0500223static int spi_setup_transport_attrs(struct transport_container *tc,
224 struct device *dev,
225 struct class_device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 struct scsi_target *starget = to_scsi_target(dev);
228
229 spi_period(starget) = -1; /* illegal value */
James Bottomley 62a86122005-05-06 18:05:20 -0500230 spi_min_period(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 spi_offset(starget) = 0; /* async */
James Bottomley 62a86122005-05-06 18:05:20 -0500232 spi_max_offset(starget) = 255;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 spi_width(starget) = 0; /* narrow */
James Bottomley 62a86122005-05-06 18:05:20 -0500234 spi_max_width(starget) = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 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;
James Bottomleyd872ebe2005-08-03 15:43:52 -0500242 spi_hold_mcs(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 spi_dv_pending(starget) = 0;
244 spi_initial_dv(starget) = 0;
Jes Sorensend158d262006-01-13 16:05:44 -0800245 mutex_init(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
247 return 0;
248}
249
James Bottomley 62a86122005-05-06 18:05:20 -0500250#define spi_transport_show_simple(field, format_string) \
251 \
252static ssize_t \
253show_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 \
264static ssize_t \
265store_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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278#define spi_transport_show_function(field, format_string) \
279 \
280static ssize_t \
281show_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) \
294static ssize_t \
295store_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); \
James Bottomley 62a86122005-05-06 18:05:20 -0500304 i->f->set_##field(starget, val); \
305 return count; \
306}
307
308#define spi_transport_store_max(field, format_string) \
309static ssize_t \
310store_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; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 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) \
330static CLASS_DEVICE_ATTR(field, S_IRUGO | S_IWUSR, \
331 show_spi_transport_##field, \
332 store_spi_transport_##field);
333
James Bottomley 62a86122005-05-06 18:05:20 -0500334#define spi_transport_simple_attr(field, format_string) \
335 spi_transport_show_simple(field, format_string) \
336 spi_transport_store_simple(field, format_string) \
337static 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) \
345static CLASS_DEVICE_ATTR(field, S_IRUGO | S_IWUSR, \
346 show_spi_transport_##field, \
347 store_spi_transport_##field);
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/* The Parallel SCSI Tranport Attributes: */
James Bottomley 62a86122005-05-06 18:05:20 -0500350spi_transport_max_attr(offset, "%d\n");
351spi_transport_max_attr(width, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352spi_transport_rd_attr(iu, "%d\n");
353spi_transport_rd_attr(dt, "%d\n");
354spi_transport_rd_attr(qas, "%d\n");
355spi_transport_rd_attr(wr_flow, "%d\n");
356spi_transport_rd_attr(rd_strm, "%d\n");
357spi_transport_rd_attr(rti, "%d\n");
358spi_transport_rd_attr(pcomp_en, "%d\n");
James Bottomleyd872ebe2005-08-03 15:43:52 -0500359spi_transport_rd_attr(hold_mcs, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800361/* we only care about the first child device so we return 1 */
362static 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370static ssize_t
371store_spi_revalidate(struct class_device *cdev, const char *buf, size_t count)
372{
373 struct scsi_target *starget = transport_class_to_starget(cdev);
374
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800375 device_for_each_child(&starget->dev, NULL, child_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 return count;
377}
378static 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 */
Matthew Wilcoxef725822005-12-15 16:22:01 -0500382static int period_to_str(char *buf, int period)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 int len, picosec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
James Bottomley 62a86122005-05-06 18:05:20 -0500386 if (period < 0 || period > 0xff) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 picosec = -1;
James Bottomley 62a86122005-05-06 18:05:20 -0500388 } else if (period <= SPI_STATIC_PPR) {
389 picosec = ppr_to_ps[period];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 } else {
James Bottomley 62a86122005-05-06 18:05:20 -0500391 picosec = period * 4000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 }
393
394 if (picosec == -1) {
395 len = sprintf(buf, "reserved");
396 } else {
397 len = sprint_frac(buf, picosec, 1000);
398 }
399
Matthew Wilcoxef725822005-12-15 16:22:01 -0500400 return len;
401}
402
403static ssize_t
404show_spi_transport_period_helper(struct class_device *cdev, char *buf,
405 int period)
406{
407 int len = period_to_str(buf, period);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 buf[len++] = '\n';
409 buf[len] = '\0';
410 return len;
411}
412
413static ssize_t
James Bottomley 62a86122005-05-06 18:05:20 -0500414store_spi_transport_period_helper(struct class_device *cdev, const char *buf,
415 size_t count, int *periodp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 int j, picosec, period = -1;
418 char *endp;
419
420 picosec = simple_strtoul(buf, &endp, 10) * 1000;
421 if (*endp == '.') {
422 int mult = 100;
423 do {
424 endp++;
425 if (!isdigit(*endp))
426 break;
427 picosec += (*endp - '0') * mult;
428 mult /= 10;
429 } while (mult > 0);
430 }
431
432 for (j = 0; j <= SPI_STATIC_PPR; j++) {
433 if (ppr_to_ps[j] < picosec)
434 continue;
435 period = j;
436 break;
437 }
438
439 if (period == -1)
440 period = picosec / 4000;
441
442 if (period > 0xff)
443 period = 0xff;
444
James Bottomley 62a86122005-05-06 18:05:20 -0500445 *periodp = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
447 return count;
448}
449
James Bottomley 62a86122005-05-06 18:05:20 -0500450static ssize_t
451show_spi_transport_period(struct class_device *cdev, char *buf)
452{
453 struct scsi_target *starget = transport_class_to_starget(cdev);
454 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
455 struct spi_internal *i = to_spi_internal(shost->transportt);
456 struct spi_transport_attrs *tp =
457 (struct spi_transport_attrs *)&starget->starget_data;
458
459 if (i->f->get_period)
460 i->f->get_period(starget);
461
462 return show_spi_transport_period_helper(cdev, buf, tp->period);
463}
464
465static ssize_t
466store_spi_transport_period(struct class_device *cdev, const char *buf,
467 size_t count)
468{
469 struct scsi_target *starget = transport_class_to_starget(cdev);
470 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
471 struct spi_internal *i = to_spi_internal(shost->transportt);
472 struct spi_transport_attrs *tp =
473 (struct spi_transport_attrs *)&starget->starget_data;
474 int period, retval;
475
476 retval = store_spi_transport_period_helper(cdev, buf, count, &period);
477
478 if (period < tp->min_period)
479 period = tp->min_period;
480
481 i->f->set_period(starget, period);
482
483 return retval;
484}
485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486static CLASS_DEVICE_ATTR(period, S_IRUGO | S_IWUSR,
487 show_spi_transport_period,
488 store_spi_transport_period);
489
James Bottomley 62a86122005-05-06 18:05:20 -0500490static ssize_t
491show_spi_transport_min_period(struct class_device *cdev, char *buf)
492{
493 struct scsi_target *starget = transport_class_to_starget(cdev);
494 struct spi_transport_attrs *tp =
495 (struct spi_transport_attrs *)&starget->starget_data;
496
497 return show_spi_transport_period_helper(cdev, buf, tp->min_period);
498}
499
500static ssize_t
501store_spi_transport_min_period(struct class_device *cdev, const char *buf,
502 size_t count)
503{
504 struct scsi_target *starget = transport_class_to_starget(cdev);
505 struct spi_transport_attrs *tp =
506 (struct spi_transport_attrs *)&starget->starget_data;
507
508 return store_spi_transport_period_helper(cdev, buf, count,
509 &tp->min_period);
510}
511
512
513static CLASS_DEVICE_ATTR(min_period, S_IRUGO | S_IWUSR,
514 show_spi_transport_min_period,
515 store_spi_transport_min_period);
516
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518static ssize_t show_spi_host_signalling(struct class_device *cdev, char *buf)
519{
520 struct Scsi_Host *shost = transport_class_to_shost(cdev);
521 struct spi_internal *i = to_spi_internal(shost->transportt);
522
523 if (i->f->get_signalling)
524 i->f->get_signalling(shost);
525
526 return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
527}
528static ssize_t store_spi_host_signalling(struct class_device *cdev,
529 const char *buf, size_t count)
530{
531 struct Scsi_Host *shost = transport_class_to_shost(cdev);
532 struct spi_internal *i = to_spi_internal(shost->transportt);
533 enum spi_signal_type type = spi_signal_to_value(buf);
534
535 if (type != SPI_SIGNAL_UNKNOWN)
536 i->f->set_signalling(shost, type);
537
538 return count;
539}
540static CLASS_DEVICE_ATTR(signalling, S_IRUGO | S_IWUSR,
541 show_spi_host_signalling,
542 store_spi_host_signalling);
543
544#define DV_SET(x, y) \
545 if(i->f->set_##x) \
546 i->f->set_##x(sdev->sdev_target, y)
547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548enum spi_compare_returns {
549 SPI_COMPARE_SUCCESS,
550 SPI_COMPARE_FAILURE,
551 SPI_COMPARE_SKIP_TEST,
552};
553
554
555/* This is for read/write Domain Validation: If the device supports
556 * an echo buffer, we do read/write tests to it */
557static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500558spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 u8 *ptr, const int retries)
560{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 int len = ptr - buffer;
James Bottomley33aa6872005-08-28 11:31:14 -0500562 int j, k, r, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 unsigned int pattern = 0x0000ffff;
James Bottomley33aa6872005-08-28 11:31:14 -0500564 struct scsi_sense_hdr sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566 const char spi_write_buffer[] = {
567 WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
568 };
569 const char spi_read_buffer[] = {
570 READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
571 };
572
573 /* set up the pattern buffer. Doesn't matter if we spill
574 * slightly beyond since that's where the read buffer is */
575 for (j = 0; j < len; ) {
576
577 /* fill the buffer with counting (test a) */
578 for ( ; j < min(len, 32); j++)
579 buffer[j] = j;
580 k = j;
581 /* fill the buffer with alternating words of 0x0 and
582 * 0xffff (test b) */
583 for ( ; j < min(len, k + 32); j += 2) {
584 u16 *word = (u16 *)&buffer[j];
585
586 *word = (j & 0x02) ? 0x0000 : 0xffff;
587 }
588 k = j;
589 /* fill with crosstalk (alternating 0x5555 0xaaa)
590 * (test c) */
591 for ( ; j < min(len, k + 32); j += 2) {
592 u16 *word = (u16 *)&buffer[j];
593
594 *word = (j & 0x02) ? 0x5555 : 0xaaaa;
595 }
596 k = j;
597 /* fill with shifting bits (test d) */
598 for ( ; j < min(len, k + 32); j += 4) {
599 u32 *word = (unsigned int *)&buffer[j];
600 u32 roll = (pattern & 0x80000000) ? 1 : 0;
601
602 *word = pattern;
603 pattern = (pattern << 1) | roll;
604 }
605 /* don't bother with random data (test e) */
606 }
607
608 for (r = 0; r < retries; r++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500609 result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
610 buffer, len, &sshdr);
611 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613 scsi_device_set_state(sdev, SDEV_QUIESCE);
James Bottomley33aa6872005-08-28 11:31:14 -0500614 if (scsi_sense_valid(&sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 && sshdr.sense_key == ILLEGAL_REQUEST
616 /* INVALID FIELD IN CDB */
617 && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
618 /* This would mean that the drive lied
619 * to us about supporting an echo
620 * buffer (unfortunately some Western
621 * Digital drives do precisely this)
622 */
623 return SPI_COMPARE_SKIP_TEST;
624
625
James Bottomley9ccfc752005-10-02 11:45:08 -0500626 sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 return SPI_COMPARE_FAILURE;
628 }
629
630 memset(ptr, 0, len);
James Bottomley33aa6872005-08-28 11:31:14 -0500631 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
632 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 scsi_device_set_state(sdev, SDEV_QUIESCE);
634
635 if (memcmp(buffer, ptr, len) != 0)
636 return SPI_COMPARE_FAILURE;
637 }
638 return SPI_COMPARE_SUCCESS;
639}
640
641/* This is for the simplest form of Domain Validation: a read test
642 * on the inquiry data from the device */
643static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500644spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 u8 *ptr, const int retries)
646{
James Bottomley33aa6872005-08-28 11:31:14 -0500647 int r, result;
648 const int len = sdev->inquiry_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 const char spi_inquiry[] = {
650 INQUIRY, 0, 0, 0, len, 0
651 };
652
653 for (r = 0; r < retries; r++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 memset(ptr, 0, len);
655
James Bottomley33aa6872005-08-28 11:31:14 -0500656 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
657 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
James Bottomley33aa6872005-08-28 11:31:14 -0500659 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 scsi_device_set_state(sdev, SDEV_QUIESCE);
661 return SPI_COMPARE_FAILURE;
662 }
663
664 /* If we don't have the inquiry data already, the
665 * first read gets it */
666 if (ptr == buffer) {
667 ptr += len;
668 --r;
669 continue;
670 }
671
672 if (memcmp(buffer, ptr, len) != 0)
673 /* failure */
674 return SPI_COMPARE_FAILURE;
675 }
676 return SPI_COMPARE_SUCCESS;
677}
678
679static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500680spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500682 (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
James Bottomley33aa6872005-08-28 11:31:14 -0500684 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500685 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 int period = 0, prevperiod = 0;
687 enum spi_compare_returns retval;
688
689
690 for (;;) {
691 int newperiod;
James Bottomley33aa6872005-08-28 11:31:14 -0500692 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
694 if (retval == SPI_COMPARE_SUCCESS
695 || retval == SPI_COMPARE_SKIP_TEST)
696 break;
697
698 /* OK, retrain, fallback */
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500699 if (i->f->get_iu)
700 i->f->get_iu(starget);
701 if (i->f->get_qas)
702 i->f->get_qas(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 if (i->f->get_period)
704 i->f->get_period(sdev->sdev_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500706 /* Here's the fallback sequence; first try turning off
707 * IU, then QAS (if we can control them), then finally
708 * fall down the periods */
709 if (i->f->set_iu && spi_iu(starget)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500710 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Information Units\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500711 DV_SET(iu, 0);
712 } else if (i->f->set_qas && spi_qas(starget)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500713 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500714 DV_SET(qas, 0);
715 } else {
716 newperiod = spi_period(starget);
717 period = newperiod > period ? newperiod : period;
718 if (period < 0x0d)
719 period++;
720 else
721 period += period >> 1;
722
723 if (unlikely(period > 0xff || period == prevperiod)) {
724 /* Total failure; set to async and return */
James Bottomley9ccfc752005-10-02 11:45:08 -0500725 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500726 DV_SET(offset, 0);
727 return SPI_COMPARE_FAILURE;
728 }
James Bottomley9ccfc752005-10-02 11:45:08 -0500729 starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500730 DV_SET(period, period);
731 prevperiod = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 }
734 return retval;
735}
736
737static int
James Bottomley33aa6872005-08-28 11:31:14 -0500738spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739{
James Bottomley33aa6872005-08-28 11:31:14 -0500740 int l, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
742 /* first off do a test unit ready. This can error out
743 * because of reservations or some other reason. If it
744 * fails, the device won't let us write to the echo buffer
745 * so just return failure */
746
747 const char spi_test_unit_ready[] = {
748 TEST_UNIT_READY, 0, 0, 0, 0, 0
749 };
750
751 const char spi_read_buffer_descriptor[] = {
752 READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
753 };
754
755
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 /* We send a set of three TURs to clear any outstanding
757 * unit attention conditions if they exist (Otherwise the
758 * buffer tests won't be happy). If the TUR still fails
759 * (reservation conflict, device not ready, etc) just
760 * skip the write tests */
761 for (l = 0; ; l++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500762 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE,
763 NULL, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
James Bottomley33aa6872005-08-28 11:31:14 -0500765 if(result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 if(l >= 3)
767 return 0;
768 } else {
769 /* TUR succeeded */
770 break;
771 }
772 }
773
James Bottomley33aa6872005-08-28 11:31:14 -0500774 result = spi_execute(sdev, spi_read_buffer_descriptor,
775 DMA_FROM_DEVICE, buffer, 4, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
James Bottomley33aa6872005-08-28 11:31:14 -0500777 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 /* Device has no echo buffer */
779 return 0;
780
781 return buffer[3] + ((buffer[2] & 0x1f) << 8);
782}
783
784static void
James Bottomley33aa6872005-08-28 11:31:14 -0500785spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
James Bottomley33aa6872005-08-28 11:31:14 -0500787 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley 62a86122005-05-06 18:05:20 -0500788 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 int len = sdev->inquiry_len;
790 /* first set us up for narrow async */
791 DV_SET(offset, 0);
792 DV_SET(width, 0);
793
James Bottomley33aa6872005-08-28 11:31:14 -0500794 if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500796 starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 /* FIXME: should probably offline the device here? */
798 return;
799 }
800
801 /* test width */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400802 if (i->f->set_width && spi_max_width(starget) &&
803 scsi_device_wide(sdev)) {
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500804 i->f->set_width(starget, 1);
James Bottomley 62a86122005-05-06 18:05:20 -0500805
James Bottomley33aa6872005-08-28 11:31:14 -0500806 if (spi_dv_device_compare_inquiry(sdev, buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 buffer + len,
808 DV_LOOPS)
809 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500810 starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500811 i->f->set_width(starget, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 }
813 }
814
815 if (!i->f->set_period)
816 return;
817
818 /* device can't handle synchronous */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400819 if (!scsi_device_sync(sdev) && !scsi_device_dt(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 return;
821
James Bottomley349cd7c2005-11-28 15:41:58 -0600822 /* len == -1 is the signal that we need to ascertain the
823 * presence of an echo buffer before trying to use it. len ==
824 * 0 means we don't have an echo buffer */
825 len = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827 retry:
828
829 /* now set up to the maximum */
James Bottomley 62a86122005-05-06 18:05:20 -0500830 DV_SET(offset, spi_max_offset(starget));
831 DV_SET(period, spi_min_period(starget));
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500832 /* try QAS requests; this should be harmless to set if the
833 * target supports it */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400834 if (scsi_device_qas(sdev))
835 DV_SET(qas, 1);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500836 /* Also try IU transfers */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400837 if (scsi_device_ius(sdev))
838 DV_SET(iu, 1);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500839 if (spi_min_period(starget) < 9) {
840 /* This u320 (or u640). Ignore the coupled parameters
841 * like DT and IU, but set the optional ones */
842 DV_SET(rd_strm, 1);
843 DV_SET(wr_flow, 1);
844 DV_SET(rti, 1);
845 if (spi_min_period(starget) == 8)
846 DV_SET(pcomp_en, 1);
847 }
James Bottomley349cd7c2005-11-28 15:41:58 -0600848 /* Do the read only INQUIRY tests */
849 spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
850 spi_dv_device_compare_inquiry);
851 /* See if we actually managed to negotiate and sustain DT */
852 if (i->f->get_dt)
853 i->f->get_dt(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
James Bottomley349cd7c2005-11-28 15:41:58 -0600855 /* see if the device has an echo buffer. If it does we can do
856 * the SPI pattern write tests. Because of some broken
857 * devices, we *only* try this on a device that has actually
858 * negotiated DT */
859
860 if (len == -1 && spi_dt(starget))
861 len = spi_dv_device_get_echo_buffer(sdev, buffer);
862
863 if (len <= 0) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500864 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 return;
866 }
867
868 if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500869 starget_printk(KERN_WARNING, starget, "Echo buffer size %d is too big, trimming to %d\n", len, SPI_MAX_ECHO_BUFFER_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 len = SPI_MAX_ECHO_BUFFER_SIZE;
871 }
872
James Bottomley33aa6872005-08-28 11:31:14 -0500873 if (spi_dv_retrain(sdev, buffer, buffer + len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 spi_dv_device_echo_buffer)
875 == SPI_COMPARE_SKIP_TEST) {
876 /* OK, the stupid drive can't do a write echo buffer
877 * test after all, fall back to the read tests */
878 len = 0;
879 goto retry;
880 }
881}
882
883
884/** spi_dv_device - Do Domain Validation on the device
885 * @sdev: scsi device to validate
886 *
887 * Performs the domain validation on the given device in the
888 * current execution thread. Since DV operations may sleep,
889 * the current thread must have user context. Also no SCSI
890 * related locks that would deadlock I/O issued by the DV may
891 * be held.
892 */
893void
894spi_dv_device(struct scsi_device *sdev)
895{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 struct scsi_target *starget = sdev->sdev_target;
897 u8 *buffer;
898 const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
899
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 if (unlikely(scsi_device_get(sdev)))
James Bottomley33aa6872005-08-28 11:31:14 -0500901 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
903 buffer = kmalloc(len, GFP_KERNEL);
904
905 if (unlikely(!buffer))
906 goto out_put;
907
908 memset(buffer, 0, len);
909
910 /* We need to verify that the actual device will quiesce; the
911 * later target quiesce is just a nice to have */
912 if (unlikely(scsi_device_quiesce(sdev)))
913 goto out_free;
914
915 scsi_target_quiesce(starget);
916
917 spi_dv_pending(starget) = 1;
Jes Sorensend158d262006-01-13 16:05:44 -0800918 mutex_lock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
James Bottomley9ccfc752005-10-02 11:45:08 -0500920 starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
James Bottomley33aa6872005-08-28 11:31:14 -0500922 spi_dv_device_internal(sdev, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
James Bottomley9ccfc752005-10-02 11:45:08 -0500924 starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Jes Sorensend158d262006-01-13 16:05:44 -0800926 mutex_unlock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 spi_dv_pending(starget) = 0;
928
929 scsi_target_resume(starget);
930
931 spi_initial_dv(starget) = 1;
932
933 out_free:
934 kfree(buffer);
935 out_put:
936 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937}
938EXPORT_SYMBOL(spi_dv_device);
939
940struct work_queue_wrapper {
941 struct work_struct work;
942 struct scsi_device *sdev;
943};
944
945static void
946spi_dv_device_work_wrapper(void *data)
947{
948 struct work_queue_wrapper *wqw = (struct work_queue_wrapper *)data;
949 struct scsi_device *sdev = wqw->sdev;
950
951 kfree(wqw);
952 spi_dv_device(sdev);
953 spi_dv_pending(sdev->sdev_target) = 0;
954 scsi_device_put(sdev);
955}
956
957
958/**
959 * spi_schedule_dv_device - schedule domain validation to occur on the device
960 * @sdev: The device to validate
961 *
962 * Identical to spi_dv_device() above, except that the DV will be
963 * scheduled to occur in a workqueue later. All memory allocations
964 * are atomic, so may be called from any context including those holding
965 * SCSI locks.
966 */
967void
968spi_schedule_dv_device(struct scsi_device *sdev)
969{
970 struct work_queue_wrapper *wqw =
971 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
972
973 if (unlikely(!wqw))
974 return;
975
976 if (unlikely(spi_dv_pending(sdev->sdev_target))) {
977 kfree(wqw);
978 return;
979 }
980 /* Set pending early (dv_device doesn't check it, only sets it) */
981 spi_dv_pending(sdev->sdev_target) = 1;
982 if (unlikely(scsi_device_get(sdev))) {
983 kfree(wqw);
984 spi_dv_pending(sdev->sdev_target) = 0;
985 return;
986 }
987
988 INIT_WORK(&wqw->work, spi_dv_device_work_wrapper, wqw);
989 wqw->sdev = sdev;
990
991 schedule_work(&wqw->work);
992}
993EXPORT_SYMBOL(spi_schedule_dv_device);
994
995/**
996 * spi_display_xfer_agreement - Print the current target transfer agreement
997 * @starget: The target for which to display the agreement
998 *
999 * Each SPI port is required to maintain a transfer agreement for each
1000 * other port on the bus. This function prints a one-line summary of
1001 * the current agreement; more detailed information is available in sysfs.
1002 */
1003void spi_display_xfer_agreement(struct scsi_target *starget)
1004{
1005 struct spi_transport_attrs *tp;
1006 tp = (struct spi_transport_attrs *)&starget->starget_data;
1007
1008 if (tp->offset > 0 && tp->period > 0) {
1009 unsigned int picosec, kb100;
1010 char *scsi = "FAST-?";
1011 char tmp[8];
1012
1013 if (tp->period <= SPI_STATIC_PPR) {
1014 picosec = ppr_to_ps[tp->period];
1015 switch (tp->period) {
1016 case 7: scsi = "FAST-320"; break;
1017 case 8: scsi = "FAST-160"; break;
1018 case 9: scsi = "FAST-80"; break;
1019 case 10:
1020 case 11: scsi = "FAST-40"; break;
1021 case 12: scsi = "FAST-20"; break;
1022 }
1023 } else {
1024 picosec = tp->period * 4000;
1025 if (tp->period < 25)
1026 scsi = "FAST-20";
1027 else if (tp->period < 50)
1028 scsi = "FAST-10";
1029 else
1030 scsi = "FAST-5";
1031 }
1032
1033 kb100 = (10000000 + picosec / 2) / picosec;
1034 if (tp->width)
1035 kb100 *= 2;
1036 sprint_frac(tmp, picosec, 1000);
1037
1038 dev_info(&starget->dev,
James Bottomleyd872ebe2005-08-03 15:43:52 -05001039 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1040 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1041 tp->dt ? "DT" : "ST",
1042 tp->iu ? " IU" : "",
1043 tp->qas ? " QAS" : "",
1044 tp->rd_strm ? " RDSTRM" : "",
1045 tp->rti ? " RTI" : "",
1046 tp->wr_flow ? " WRFLOW" : "",
1047 tp->pcomp_en ? " PCOMP" : "",
1048 tp->hold_mcs ? " HMCS" : "",
1049 tmp, tp->offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 } else {
Matthew Wilcox493ff4e2005-11-17 11:13:43 -07001051 dev_info(&starget->dev, "%sasynchronous\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 tp->width ? "wide " : "");
1053 }
1054}
1055EXPORT_SYMBOL(spi_display_xfer_agreement);
1056
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001057#ifdef CONFIG_SCSI_CONSTANTS
1058static const char * const one_byte_msgs[] = {
1059/* 0x00 */ "Command Complete", NULL, "Save Pointers",
1060/* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error",
1061/* 0x06 */ "Abort", "Message Reject", "Nop", "Message Parity Error",
1062/* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
1063/* 0x0c */ "Bus device reset", "Abort Tag", "Clear Queue",
1064/* 0x0f */ "Initiate Recovery", "Release Recovery"
1065};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001066
1067static const char * const two_byte_msgs[] = {
Matthew Wilcox47972152005-12-15 16:22:01 -05001068/* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001069/* 0x23 */ "Ignore Wide Residue"
1070};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001071
1072static const char * const extended_msgs[] = {
1073/* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
Matthew Wilcoxef725822005-12-15 16:22:01 -05001074/* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
1075/* 0x04 */ "Parallel Protocol Request"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001076};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001077
Adrian Bunkbdd70f22006-01-05 23:39:18 +01001078static void print_nego(const unsigned char *msg, int per, int off, int width)
Matthew Wilcoxef725822005-12-15 16:22:01 -05001079{
1080 if (per) {
1081 char buf[20];
1082 period_to_str(buf, msg[per]);
1083 printk("period = %s ns ", buf);
1084 }
1085
1086 if (off)
1087 printk("offset = %d ", msg[off]);
1088 if (width)
1089 printk("width = %d ", 8 << msg[width]);
1090}
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001091
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001092int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001093{
1094 int len = 0, i;
1095 if (msg[0] == EXTENDED_MESSAGE) {
1096 len = 3 + msg[1];
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001097 if (msg[2] < ARRAY_SIZE(extended_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001098 printk ("%s ", extended_msgs[msg[2]]);
1099 else
1100 printk ("Extended Message, reserved code (0x%02x) ",
1101 (int) msg[2]);
1102 switch (msg[2]) {
1103 case EXTENDED_MODIFY_DATA_POINTER:
1104 printk("pointer = %d", (int) (msg[3] << 24) |
1105 (msg[4] << 16) | (msg[5] << 8) | msg[6]);
1106 break;
1107 case EXTENDED_SDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001108 print_nego(msg, 3, 4, 0);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001109 break;
1110 case EXTENDED_WDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001111 print_nego(msg, 0, 0, 3);
1112 break;
1113 case EXTENDED_PPR:
1114 print_nego(msg, 3, 5, 6);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001115 break;
1116 default:
1117 for (i = 2; i < len; ++i)
1118 printk("%02x ", msg[i]);
1119 }
1120 /* Identify */
1121 } else if (msg[0] & 0x80) {
1122 printk("Identify disconnect %sallowed %s %d ",
1123 (msg[0] & 0x40) ? "" : "not ",
1124 (msg[0] & 0x20) ? "target routine" : "lun",
1125 msg[0] & 0x7);
1126 len = 1;
1127 /* Normal One byte */
1128 } else if (msg[0] < 0x1f) {
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001129 if (msg[0] < ARRAY_SIZE(one_byte_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001130 printk(one_byte_msgs[msg[0]]);
1131 else
1132 printk("reserved (%02x) ", msg[0]);
1133 len = 1;
1134 /* Two byte */
1135 } else if (msg[0] <= 0x2f) {
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001136 if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001137 printk("%s %02x ", two_byte_msgs[msg[0] - 0x20],
1138 msg[1]);
1139 else
1140 printk("reserved two byte (%02x %02x) ",
1141 msg[0], msg[1]);
1142 len = 2;
1143 } else
1144 printk("reserved");
1145 return len;
1146}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001147EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001148
1149#else /* ifndef CONFIG_SCSI_CONSTANTS */
1150
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001151int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001152{
1153 int len = 0, i;
1154
1155 if (msg[0] == EXTENDED_MESSAGE) {
1156 len = 3 + msg[1];
1157 for (i = 0; i < len; ++i)
1158 printk("%02x ", msg[i]);
1159 /* Identify */
1160 } else if (msg[0] & 0x80) {
1161 printk("%02x ", msg[0]);
1162 len = 1;
1163 /* Normal One byte */
1164 } else if (msg[0] < 0x1f) {
1165 printk("%02x ", msg[0]);
1166 len = 1;
1167 /* Two byte */
1168 } else if (msg[0] <= 0x2f) {
1169 printk("%02x %02x", msg[0], msg[1]);
1170 len = 2;
1171 } else
1172 printk("%02x ", msg[0]);
1173 return len;
1174}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001175EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001176#endif /* ! CONFIG_SCSI_CONSTANTS */
1177
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178#define SETUP_ATTRIBUTE(field) \
1179 i->private_attrs[count] = class_device_attr_##field; \
1180 if (!i->f->set_##field) { \
1181 i->private_attrs[count].attr.mode = S_IRUGO; \
1182 i->private_attrs[count].store = NULL; \
1183 } \
1184 i->attrs[count] = &i->private_attrs[count]; \
1185 if (i->f->show_##field) \
1186 count++
1187
James Bottomley 62a86122005-05-06 18:05:20 -05001188#define SETUP_RELATED_ATTRIBUTE(field, rel_field) \
1189 i->private_attrs[count] = class_device_attr_##field; \
1190 if (!i->f->set_##rel_field) { \
1191 i->private_attrs[count].attr.mode = S_IRUGO; \
1192 i->private_attrs[count].store = NULL; \
1193 } \
1194 i->attrs[count] = &i->private_attrs[count]; \
1195 if (i->f->show_##rel_field) \
1196 count++
1197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198#define SETUP_HOST_ATTRIBUTE(field) \
1199 i->private_host_attrs[count] = class_device_attr_##field; \
1200 if (!i->f->set_##field) { \
1201 i->private_host_attrs[count].attr.mode = S_IRUGO; \
1202 i->private_host_attrs[count].store = NULL; \
1203 } \
1204 i->host_attrs[count] = &i->private_host_attrs[count]; \
1205 count++
1206
1207static int spi_device_match(struct attribute_container *cont,
1208 struct device *dev)
1209{
1210 struct scsi_device *sdev;
1211 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001212 struct spi_internal *i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
1214 if (!scsi_is_sdev_device(dev))
1215 return 0;
1216
1217 sdev = to_scsi_device(dev);
1218 shost = sdev->host;
1219 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1220 != &spi_host_class.class)
1221 return 0;
1222 /* Note: this class has no device attributes, so it has
1223 * no per-HBA allocation and thus we don't need to distinguish
1224 * the attribute containers for the device */
James Bottomley10c1b882005-08-14 14:34:06 -05001225 i = to_spi_internal(shost->transportt);
1226 if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1227 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 return 1;
1229}
1230
1231static int spi_target_match(struct attribute_container *cont,
1232 struct device *dev)
1233{
1234 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001235 struct scsi_target *starget;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 struct spi_internal *i;
1237
1238 if (!scsi_is_target_device(dev))
1239 return 0;
1240
1241 shost = dev_to_shost(dev->parent);
1242 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1243 != &spi_host_class.class)
1244 return 0;
1245
1246 i = to_spi_internal(shost->transportt);
James Bottomley10c1b882005-08-14 14:34:06 -05001247 starget = to_scsi_target(dev);
1248
1249 if (i->f->deny_binding && i->f->deny_binding(starget))
1250 return 0;
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 return &i->t.target_attrs.ac == cont;
1253}
1254
1255static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1256 "spi_transport",
1257 spi_setup_transport_attrs,
1258 NULL,
1259 NULL);
1260
1261static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1262 spi_device_match,
1263 spi_device_configure);
1264
1265struct scsi_transport_template *
1266spi_attach_transport(struct spi_function_template *ft)
1267{
1268 struct spi_internal *i = kmalloc(sizeof(struct spi_internal),
1269 GFP_KERNEL);
1270 int count = 0;
1271 if (unlikely(!i))
1272 return NULL;
1273
1274 memset(i, 0, sizeof(struct spi_internal));
1275
1276
1277 i->t.target_attrs.ac.class = &spi_transport_class.class;
1278 i->t.target_attrs.ac.attrs = &i->attrs[0];
1279 i->t.target_attrs.ac.match = spi_target_match;
1280 transport_container_register(&i->t.target_attrs);
1281 i->t.target_size = sizeof(struct spi_transport_attrs);
1282 i->t.host_attrs.ac.class = &spi_host_class.class;
1283 i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1284 i->t.host_attrs.ac.match = spi_host_match;
1285 transport_container_register(&i->t.host_attrs);
1286 i->t.host_size = sizeof(struct spi_host_attrs);
1287 i->f = ft;
1288
1289 SETUP_ATTRIBUTE(period);
James Bottomley 62a86122005-05-06 18:05:20 -05001290 SETUP_RELATED_ATTRIBUTE(min_period, period);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 SETUP_ATTRIBUTE(offset);
James Bottomley 62a86122005-05-06 18:05:20 -05001292 SETUP_RELATED_ATTRIBUTE(max_offset, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 SETUP_ATTRIBUTE(width);
James Bottomley 62a86122005-05-06 18:05:20 -05001294 SETUP_RELATED_ATTRIBUTE(max_width, width);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 SETUP_ATTRIBUTE(iu);
1296 SETUP_ATTRIBUTE(dt);
1297 SETUP_ATTRIBUTE(qas);
1298 SETUP_ATTRIBUTE(wr_flow);
1299 SETUP_ATTRIBUTE(rd_strm);
1300 SETUP_ATTRIBUTE(rti);
1301 SETUP_ATTRIBUTE(pcomp_en);
James Bottomleyd872ebe2005-08-03 15:43:52 -05001302 SETUP_ATTRIBUTE(hold_mcs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
1304 /* if you add an attribute but forget to increase SPI_NUM_ATTRS
1305 * this bug will trigger */
1306 BUG_ON(count > SPI_NUM_ATTRS);
1307
1308 i->attrs[count++] = &class_device_attr_revalidate;
1309
1310 i->attrs[count] = NULL;
1311
1312 count = 0;
1313 SETUP_HOST_ATTRIBUTE(signalling);
1314
1315 BUG_ON(count > SPI_HOST_ATTRS);
1316
1317 i->host_attrs[count] = NULL;
1318
1319 return &i->t;
1320}
1321EXPORT_SYMBOL(spi_attach_transport);
1322
1323void spi_release_transport(struct scsi_transport_template *t)
1324{
1325 struct spi_internal *i = to_spi_internal(t);
1326
1327 transport_container_unregister(&i->t.target_attrs);
1328 transport_container_unregister(&i->t.host_attrs);
1329
1330 kfree(i);
1331}
1332EXPORT_SYMBOL(spi_release_transport);
1333
1334static __init int spi_transport_init(void)
1335{
1336 int error = transport_class_register(&spi_transport_class);
1337 if (error)
1338 return error;
1339 error = anon_transport_class_register(&spi_device_class);
1340 return transport_class_register(&spi_host_class);
1341}
1342
1343static void __exit spi_transport_exit(void)
1344{
1345 transport_class_unregister(&spi_transport_class);
1346 anon_transport_class_unregister(&spi_device_class);
1347 transport_class_unregister(&spi_host_class);
1348}
1349
1350MODULE_AUTHOR("Martin Hicks");
1351MODULE_DESCRIPTION("SPI Transport Attributes");
1352MODULE_LICENSE("GPL");
1353
1354module_init(spi_transport_init);
1355module_exit(spi_transport_exit);