blob: 780aaedcbce9f0cbad4db997292a2e6d69631d9e [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
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700404show_spi_transport_period_helper(char *buf, int period)
Matthew Wilcoxef725822005-12-15 16:22:01 -0500405{
406 int len = period_to_str(buf, period);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 buf[len++] = '\n';
408 buf[len] = '\0';
409 return len;
410}
411
412static ssize_t
James Bottomley 62a86122005-05-06 18:05:20 -0500413store_spi_transport_period_helper(struct class_device *cdev, const char *buf,
414 size_t count, int *periodp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 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
James Bottomley 62a86122005-05-06 18:05:20 -0500444 *periodp = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
446 return count;
447}
448
James Bottomley 62a86122005-05-06 18:05:20 -0500449static ssize_t
450show_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
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700461 return show_spi_transport_period_helper(buf, tp->period);
James Bottomley 62a86122005-05-06 18:05:20 -0500462}
463
464static ssize_t
465store_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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485static CLASS_DEVICE_ATTR(period, S_IRUGO | S_IWUSR,
486 show_spi_transport_period,
487 store_spi_transport_period);
488
James Bottomley 62a86122005-05-06 18:05:20 -0500489static ssize_t
490show_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
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700496 return show_spi_transport_period_helper(buf, tp->min_period);
James Bottomley 62a86122005-05-06 18:05:20 -0500497}
498
499static ssize_t
500store_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
512static CLASS_DEVICE_ATTR(min_period, S_IRUGO | S_IWUSR,
513 show_spi_transport_min_period,
514 store_spi_transport_min_period);
515
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517static 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}
527static 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}
539static 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547enum 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 */
556static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500557spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 u8 *ptr, const int retries)
559{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 int len = ptr - buffer;
James Bottomley33aa6872005-08-28 11:31:14 -0500561 int j, k, r, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 unsigned int pattern = 0x0000ffff;
James Bottomley33aa6872005-08-28 11:31:14 -0500563 struct scsi_sense_hdr sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
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++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500608 result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
609 buffer, len, &sshdr);
610 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612 scsi_device_set_state(sdev, SDEV_QUIESCE);
James Bottomley33aa6872005-08-28 11:31:14 -0500613 if (scsi_sense_valid(&sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 && 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
James Bottomley9ccfc752005-10-02 11:45:08 -0500625 sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 return SPI_COMPARE_FAILURE;
627 }
628
629 memset(ptr, 0, len);
James Bottomley33aa6872005-08-28 11:31:14 -0500630 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
631 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 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 */
642static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500643spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 u8 *ptr, const int retries)
645{
James Bottomley33aa6872005-08-28 11:31:14 -0500646 int r, result;
647 const int len = sdev->inquiry_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 const char spi_inquiry[] = {
649 INQUIRY, 0, 0, 0, len, 0
650 };
651
652 for (r = 0; r < retries; r++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 memset(ptr, 0, len);
654
James Bottomley33aa6872005-08-28 11:31:14 -0500655 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
656 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
James Bottomley33aa6872005-08-28 11:31:14 -0500658 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 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
678static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500679spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500681 (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
James Bottomley33aa6872005-08-28 11:31:14 -0500683 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500684 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 int period = 0, prevperiod = 0;
686 enum spi_compare_returns retval;
687
688
689 for (;;) {
690 int newperiod;
James Bottomley33aa6872005-08-28 11:31:14 -0500691 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
693 if (retval == SPI_COMPARE_SUCCESS
694 || retval == SPI_COMPARE_SKIP_TEST)
695 break;
696
697 /* OK, retrain, fallback */
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500698 if (i->f->get_iu)
699 i->f->get_iu(starget);
700 if (i->f->get_qas)
701 i->f->get_qas(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 if (i->f->get_period)
703 i->f->get_period(sdev->sdev_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500705 /* 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)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500709 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Information Units\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500710 DV_SET(iu, 0);
711 } else if (i->f->set_qas && spi_qas(starget)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500712 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500713 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 */
James Bottomley9ccfc752005-10-02 11:45:08 -0500724 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500725 DV_SET(offset, 0);
726 return SPI_COMPARE_FAILURE;
727 }
James Bottomley9ccfc752005-10-02 11:45:08 -0500728 starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500729 DV_SET(period, period);
730 prevperiod = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 }
733 return retval;
734}
735
736static int
James Bottomley33aa6872005-08-28 11:31:14 -0500737spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
James Bottomley33aa6872005-08-28 11:31:14 -0500739 int l, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 /* 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++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500761 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE,
762 NULL, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
James Bottomley33aa6872005-08-28 11:31:14 -0500764 if(result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 if(l >= 3)
766 return 0;
767 } else {
768 /* TUR succeeded */
769 break;
770 }
771 }
772
James Bottomley33aa6872005-08-28 11:31:14 -0500773 result = spi_execute(sdev, spi_read_buffer_descriptor,
774 DMA_FROM_DEVICE, buffer, 4, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
James Bottomley33aa6872005-08-28 11:31:14 -0500776 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 /* Device has no echo buffer */
778 return 0;
779
780 return buffer[3] + ((buffer[2] & 0x1f) << 8);
781}
782
783static void
James Bottomley33aa6872005-08-28 11:31:14 -0500784spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
James Bottomley33aa6872005-08-28 11:31:14 -0500786 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley 62a86122005-05-06 18:05:20 -0500787 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 int len = sdev->inquiry_len;
789 /* first set us up for narrow async */
790 DV_SET(offset, 0);
791 DV_SET(width, 0);
792
James Bottomley33aa6872005-08-28 11:31:14 -0500793 if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500795 starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 /* FIXME: should probably offline the device here? */
797 return;
798 }
799
800 /* test width */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400801 if (i->f->set_width && spi_max_width(starget) &&
802 scsi_device_wide(sdev)) {
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500803 i->f->set_width(starget, 1);
James Bottomley 62a86122005-05-06 18:05:20 -0500804
James Bottomley33aa6872005-08-28 11:31:14 -0500805 if (spi_dv_device_compare_inquiry(sdev, buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 buffer + len,
807 DV_LOOPS)
808 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500809 starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500810 i->f->set_width(starget, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 }
812 }
813
814 if (!i->f->set_period)
815 return;
816
817 /* device can't handle synchronous */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400818 if (!scsi_device_sync(sdev) && !scsi_device_dt(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 return;
820
James Bottomley349cd7c2005-11-28 15:41:58 -0600821 /* len == -1 is the signal that we need to ascertain the
822 * presence of an echo buffer before trying to use it. len ==
823 * 0 means we don't have an echo buffer */
824 len = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
826 retry:
827
828 /* now set up to the maximum */
James Bottomley 62a86122005-05-06 18:05:20 -0500829 DV_SET(offset, spi_max_offset(starget));
830 DV_SET(period, spi_min_period(starget));
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500831 /* try QAS requests; this should be harmless to set if the
832 * target supports it */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400833 if (scsi_device_qas(sdev))
834 DV_SET(qas, 1);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500835 /* Also try IU transfers */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400836 if (scsi_device_ius(sdev))
837 DV_SET(iu, 1);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500838 if (spi_min_period(starget) < 9) {
839 /* This u320 (or u640). Ignore the coupled parameters
840 * like DT and IU, but set the optional ones */
841 DV_SET(rd_strm, 1);
842 DV_SET(wr_flow, 1);
843 DV_SET(rti, 1);
844 if (spi_min_period(starget) == 8)
845 DV_SET(pcomp_en, 1);
846 }
James Bottomley349cd7c2005-11-28 15:41:58 -0600847 /* Do the read only INQUIRY tests */
848 spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
849 spi_dv_device_compare_inquiry);
850 /* See if we actually managed to negotiate and sustain DT */
851 if (i->f->get_dt)
852 i->f->get_dt(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
James Bottomley349cd7c2005-11-28 15:41:58 -0600854 /* see if the device has an echo buffer. If it does we can do
855 * the SPI pattern write tests. Because of some broken
856 * devices, we *only* try this on a device that has actually
857 * negotiated DT */
858
859 if (len == -1 && spi_dt(starget))
860 len = spi_dv_device_get_echo_buffer(sdev, buffer);
861
862 if (len <= 0) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500863 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 return;
865 }
866
867 if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500868 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 -0700869 len = SPI_MAX_ECHO_BUFFER_SIZE;
870 }
871
James Bottomley33aa6872005-08-28 11:31:14 -0500872 if (spi_dv_retrain(sdev, buffer, buffer + len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 spi_dv_device_echo_buffer)
874 == SPI_COMPARE_SKIP_TEST) {
875 /* OK, the stupid drive can't do a write echo buffer
876 * test after all, fall back to the read tests */
877 len = 0;
878 goto retry;
879 }
880}
881
882
883/** spi_dv_device - Do Domain Validation on the device
884 * @sdev: scsi device to validate
885 *
886 * Performs the domain validation on the given device in the
887 * current execution thread. Since DV operations may sleep,
888 * the current thread must have user context. Also no SCSI
889 * related locks that would deadlock I/O issued by the DV may
890 * be held.
891 */
892void
893spi_dv_device(struct scsi_device *sdev)
894{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 struct scsi_target *starget = sdev->sdev_target;
896 u8 *buffer;
897 const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
898
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 if (unlikely(scsi_device_get(sdev)))
James Bottomley33aa6872005-08-28 11:31:14 -0500900 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Jes Sorensen24669f752006-01-16 10:31:18 -0500902 buffer = kzalloc(len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904 if (unlikely(!buffer))
905 goto out_put;
906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 /* We need to verify that the actual device will quiesce; the
908 * later target quiesce is just a nice to have */
909 if (unlikely(scsi_device_quiesce(sdev)))
910 goto out_free;
911
912 scsi_target_quiesce(starget);
913
914 spi_dv_pending(starget) = 1;
Jes Sorensend158d262006-01-13 16:05:44 -0800915 mutex_lock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
James Bottomley9ccfc752005-10-02 11:45:08 -0500917 starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
James Bottomley33aa6872005-08-28 11:31:14 -0500919 spi_dv_device_internal(sdev, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920
James Bottomley9ccfc752005-10-02 11:45:08 -0500921 starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Jes Sorensend158d262006-01-13 16:05:44 -0800923 mutex_unlock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 spi_dv_pending(starget) = 0;
925
926 scsi_target_resume(starget);
927
928 spi_initial_dv(starget) = 1;
929
930 out_free:
931 kfree(buffer);
932 out_put:
933 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934}
935EXPORT_SYMBOL(spi_dv_device);
936
937struct work_queue_wrapper {
938 struct work_struct work;
939 struct scsi_device *sdev;
940};
941
942static void
943spi_dv_device_work_wrapper(void *data)
944{
945 struct work_queue_wrapper *wqw = (struct work_queue_wrapper *)data;
946 struct scsi_device *sdev = wqw->sdev;
947
948 kfree(wqw);
949 spi_dv_device(sdev);
950 spi_dv_pending(sdev->sdev_target) = 0;
951 scsi_device_put(sdev);
952}
953
954
955/**
956 * spi_schedule_dv_device - schedule domain validation to occur on the device
957 * @sdev: The device to validate
958 *
959 * Identical to spi_dv_device() above, except that the DV will be
960 * scheduled to occur in a workqueue later. All memory allocations
961 * are atomic, so may be called from any context including those holding
962 * SCSI locks.
963 */
964void
965spi_schedule_dv_device(struct scsi_device *sdev)
966{
967 struct work_queue_wrapper *wqw =
968 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
969
970 if (unlikely(!wqw))
971 return;
972
973 if (unlikely(spi_dv_pending(sdev->sdev_target))) {
974 kfree(wqw);
975 return;
976 }
977 /* Set pending early (dv_device doesn't check it, only sets it) */
978 spi_dv_pending(sdev->sdev_target) = 1;
979 if (unlikely(scsi_device_get(sdev))) {
980 kfree(wqw);
981 spi_dv_pending(sdev->sdev_target) = 0;
982 return;
983 }
984
985 INIT_WORK(&wqw->work, spi_dv_device_work_wrapper, wqw);
986 wqw->sdev = sdev;
987
988 schedule_work(&wqw->work);
989}
990EXPORT_SYMBOL(spi_schedule_dv_device);
991
992/**
993 * spi_display_xfer_agreement - Print the current target transfer agreement
994 * @starget: The target for which to display the agreement
995 *
996 * Each SPI port is required to maintain a transfer agreement for each
997 * other port on the bus. This function prints a one-line summary of
998 * the current agreement; more detailed information is available in sysfs.
999 */
1000void spi_display_xfer_agreement(struct scsi_target *starget)
1001{
1002 struct spi_transport_attrs *tp;
1003 tp = (struct spi_transport_attrs *)&starget->starget_data;
1004
1005 if (tp->offset > 0 && tp->period > 0) {
1006 unsigned int picosec, kb100;
1007 char *scsi = "FAST-?";
1008 char tmp[8];
1009
1010 if (tp->period <= SPI_STATIC_PPR) {
1011 picosec = ppr_to_ps[tp->period];
1012 switch (tp->period) {
1013 case 7: scsi = "FAST-320"; break;
1014 case 8: scsi = "FAST-160"; break;
1015 case 9: scsi = "FAST-80"; break;
1016 case 10:
1017 case 11: scsi = "FAST-40"; break;
1018 case 12: scsi = "FAST-20"; break;
1019 }
1020 } else {
1021 picosec = tp->period * 4000;
1022 if (tp->period < 25)
1023 scsi = "FAST-20";
1024 else if (tp->period < 50)
1025 scsi = "FAST-10";
1026 else
1027 scsi = "FAST-5";
1028 }
1029
1030 kb100 = (10000000 + picosec / 2) / picosec;
1031 if (tp->width)
1032 kb100 *= 2;
1033 sprint_frac(tmp, picosec, 1000);
1034
1035 dev_info(&starget->dev,
James Bottomleyd872ebe2005-08-03 15:43:52 -05001036 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1037 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1038 tp->dt ? "DT" : "ST",
1039 tp->iu ? " IU" : "",
1040 tp->qas ? " QAS" : "",
1041 tp->rd_strm ? " RDSTRM" : "",
1042 tp->rti ? " RTI" : "",
1043 tp->wr_flow ? " WRFLOW" : "",
1044 tp->pcomp_en ? " PCOMP" : "",
1045 tp->hold_mcs ? " HMCS" : "",
1046 tmp, tp->offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 } else {
Matthew Wilcox493ff4e2005-11-17 11:13:43 -07001048 dev_info(&starget->dev, "%sasynchronous\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 tp->width ? "wide " : "");
1050 }
1051}
1052EXPORT_SYMBOL(spi_display_xfer_agreement);
1053
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001054int spi_populate_width_msg(unsigned char *msg, int width)
1055{
1056 msg[0] = EXTENDED_MESSAGE;
1057 msg[1] = 2;
1058 msg[2] = EXTENDED_WDTR;
1059 msg[3] = width;
1060 return 4;
1061}
James Bottomley38e14f82006-02-17 14:58:47 -08001062EXPORT_SYMBOL_GPL(spi_populate_width_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001063
1064int spi_populate_sync_msg(unsigned char *msg, int period, int offset)
1065{
1066 msg[0] = EXTENDED_MESSAGE;
1067 msg[1] = 3;
1068 msg[2] = EXTENDED_SDTR;
1069 msg[3] = period;
1070 msg[4] = offset;
1071 return 5;
1072}
James Bottomley38e14f82006-02-17 14:58:47 -08001073EXPORT_SYMBOL_GPL(spi_populate_sync_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001074
1075int spi_populate_ppr_msg(unsigned char *msg, int period, int offset,
1076 int width, int options)
1077{
1078 msg[0] = EXTENDED_MESSAGE;
1079 msg[1] = 6;
1080 msg[2] = EXTENDED_PPR;
1081 msg[3] = period;
1082 msg[4] = 0;
1083 msg[5] = offset;
1084 msg[6] = width;
1085 msg[7] = options;
1086 return 8;
1087}
James Bottomley38e14f82006-02-17 14:58:47 -08001088EXPORT_SYMBOL_GPL(spi_populate_ppr_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001089
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001090#ifdef CONFIG_SCSI_CONSTANTS
1091static const char * const one_byte_msgs[] = {
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001092/* 0x00 */ "Task Complete", NULL /* Extended Message */, "Save Pointers",
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001093/* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001094/* 0x06 */ "Abort Task Set", "Message Reject", "Nop", "Message Parity Error",
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001095/* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001096/* 0x0c */ "Target Reset", "Abort Task", "Clear Task Set",
1097/* 0x0f */ "Initiate Recovery", "Release Recovery",
1098/* 0x11 */ "Terminate Process", "Continue Task", "Target Transfer Disable",
1099/* 0x14 */ NULL, NULL, "Clear ACA", "LUN Reset"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001100};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001101
1102static const char * const two_byte_msgs[] = {
Matthew Wilcox47972152005-12-15 16:22:01 -05001103/* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001104/* 0x23 */ "Ignore Wide Residue", "ACA"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001105};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001106
1107static const char * const extended_msgs[] = {
1108/* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
Matthew Wilcoxef725822005-12-15 16:22:01 -05001109/* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001110/* 0x04 */ "Parallel Protocol Request", "Modify Bidirectional Data Pointer"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001111};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001112
Adrian Bunkbdd70f22006-01-05 23:39:18 +01001113static void print_nego(const unsigned char *msg, int per, int off, int width)
Matthew Wilcoxef725822005-12-15 16:22:01 -05001114{
1115 if (per) {
1116 char buf[20];
1117 period_to_str(buf, msg[per]);
1118 printk("period = %s ns ", buf);
1119 }
1120
1121 if (off)
1122 printk("offset = %d ", msg[off]);
1123 if (width)
1124 printk("width = %d ", 8 << msg[width]);
1125}
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001126
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001127static void print_ptr(const unsigned char *msg, int msb, const char *desc)
1128{
1129 int ptr = (msg[msb] << 24) | (msg[msb+1] << 16) | (msg[msb+2] << 8) |
1130 msg[msb+3];
1131 printk("%s = %d ", desc, ptr);
1132}
1133
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001134int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001135{
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001136 int len = 1, i;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001137 if (msg[0] == EXTENDED_MESSAGE) {
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001138 len = 2 + msg[1];
1139 if (len == 2)
1140 len += 256;
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001141 if (msg[2] < ARRAY_SIZE(extended_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001142 printk ("%s ", extended_msgs[msg[2]]);
1143 else
1144 printk ("Extended Message, reserved code (0x%02x) ",
1145 (int) msg[2]);
1146 switch (msg[2]) {
1147 case EXTENDED_MODIFY_DATA_POINTER:
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001148 print_ptr(msg, 3, "pointer");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001149 break;
1150 case EXTENDED_SDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001151 print_nego(msg, 3, 4, 0);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001152 break;
1153 case EXTENDED_WDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001154 print_nego(msg, 0, 0, 3);
1155 break;
1156 case EXTENDED_PPR:
1157 print_nego(msg, 3, 5, 6);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001158 break;
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001159 case EXTENDED_MODIFY_BIDI_DATA_PTR:
1160 print_ptr(msg, 3, "out");
1161 print_ptr(msg, 7, "in");
1162 break;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001163 default:
1164 for (i = 2; i < len; ++i)
1165 printk("%02x ", msg[i]);
1166 }
1167 /* Identify */
1168 } else if (msg[0] & 0x80) {
1169 printk("Identify disconnect %sallowed %s %d ",
1170 (msg[0] & 0x40) ? "" : "not ",
1171 (msg[0] & 0x20) ? "target routine" : "lun",
1172 msg[0] & 0x7);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001173 /* Normal One byte */
1174 } else if (msg[0] < 0x1f) {
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001175 if (msg[0] < ARRAY_SIZE(one_byte_msgs) && one_byte_msgs[msg[0]])
Matthew Wilcoxe24d8732006-02-07 08:05:26 -07001176 printk("%s ", one_byte_msgs[msg[0]]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001177 else
1178 printk("reserved (%02x) ", msg[0]);
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001179 } else if (msg[0] == 0x55) {
1180 printk("QAS Request ");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001181 /* Two byte */
1182 } else if (msg[0] <= 0x2f) {
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001183 if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001184 printk("%s %02x ", two_byte_msgs[msg[0] - 0x20],
1185 msg[1]);
1186 else
1187 printk("reserved two byte (%02x %02x) ",
1188 msg[0], msg[1]);
1189 len = 2;
1190 } else
Matthew Wilcoxe24d8732006-02-07 08:05:26 -07001191 printk("reserved ");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001192 return len;
1193}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001194EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001195
1196#else /* ifndef CONFIG_SCSI_CONSTANTS */
1197
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001198int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001199{
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001200 int len = 1, i;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001201
1202 if (msg[0] == EXTENDED_MESSAGE) {
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001203 len = 2 + msg[1];
1204 if (len == 2)
1205 len += 256;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001206 for (i = 0; i < len; ++i)
1207 printk("%02x ", msg[i]);
1208 /* Identify */
1209 } else if (msg[0] & 0x80) {
1210 printk("%02x ", msg[0]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001211 /* Normal One byte */
James Bottomley597705a2006-03-12 09:54:19 -06001212 } else if ((msg[0] < 0x1f) || (msg[0] == 0x55)) {
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001213 printk("%02x ", msg[0]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001214 /* Two byte */
1215 } else if (msg[0] <= 0x2f) {
1216 printk("%02x %02x", msg[0], msg[1]);
1217 len = 2;
1218 } else
1219 printk("%02x ", msg[0]);
1220 return len;
1221}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001222EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001223#endif /* ! CONFIG_SCSI_CONSTANTS */
1224
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225#define SETUP_ATTRIBUTE(field) \
1226 i->private_attrs[count] = class_device_attr_##field; \
1227 if (!i->f->set_##field) { \
1228 i->private_attrs[count].attr.mode = S_IRUGO; \
1229 i->private_attrs[count].store = NULL; \
1230 } \
1231 i->attrs[count] = &i->private_attrs[count]; \
1232 if (i->f->show_##field) \
1233 count++
1234
James Bottomley 62a86122005-05-06 18:05:20 -05001235#define SETUP_RELATED_ATTRIBUTE(field, rel_field) \
1236 i->private_attrs[count] = class_device_attr_##field; \
1237 if (!i->f->set_##rel_field) { \
1238 i->private_attrs[count].attr.mode = S_IRUGO; \
1239 i->private_attrs[count].store = NULL; \
1240 } \
1241 i->attrs[count] = &i->private_attrs[count]; \
1242 if (i->f->show_##rel_field) \
1243 count++
1244
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245#define SETUP_HOST_ATTRIBUTE(field) \
1246 i->private_host_attrs[count] = class_device_attr_##field; \
1247 if (!i->f->set_##field) { \
1248 i->private_host_attrs[count].attr.mode = S_IRUGO; \
1249 i->private_host_attrs[count].store = NULL; \
1250 } \
1251 i->host_attrs[count] = &i->private_host_attrs[count]; \
1252 count++
1253
1254static int spi_device_match(struct attribute_container *cont,
1255 struct device *dev)
1256{
1257 struct scsi_device *sdev;
1258 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001259 struct spi_internal *i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
1261 if (!scsi_is_sdev_device(dev))
1262 return 0;
1263
1264 sdev = to_scsi_device(dev);
1265 shost = sdev->host;
1266 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1267 != &spi_host_class.class)
1268 return 0;
1269 /* Note: this class has no device attributes, so it has
1270 * no per-HBA allocation and thus we don't need to distinguish
1271 * the attribute containers for the device */
James Bottomley10c1b882005-08-14 14:34:06 -05001272 i = to_spi_internal(shost->transportt);
1273 if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1274 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 return 1;
1276}
1277
1278static int spi_target_match(struct attribute_container *cont,
1279 struct device *dev)
1280{
1281 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001282 struct scsi_target *starget;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 struct spi_internal *i;
1284
1285 if (!scsi_is_target_device(dev))
1286 return 0;
1287
1288 shost = dev_to_shost(dev->parent);
1289 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1290 != &spi_host_class.class)
1291 return 0;
1292
1293 i = to_spi_internal(shost->transportt);
James Bottomley10c1b882005-08-14 14:34:06 -05001294 starget = to_scsi_target(dev);
1295
1296 if (i->f->deny_binding && i->f->deny_binding(starget))
1297 return 0;
1298
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 return &i->t.target_attrs.ac == cont;
1300}
1301
1302static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1303 "spi_transport",
1304 spi_setup_transport_attrs,
1305 NULL,
1306 NULL);
1307
1308static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1309 spi_device_match,
1310 spi_device_configure);
1311
1312struct scsi_transport_template *
1313spi_attach_transport(struct spi_function_template *ft)
1314{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 int count = 0;
Jes Sorensen24669f752006-01-16 10:31:18 -05001316 struct spi_internal *i = kzalloc(sizeof(struct spi_internal),
1317 GFP_KERNEL);
1318
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 if (unlikely(!i))
1320 return NULL;
1321
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 i->t.target_attrs.ac.class = &spi_transport_class.class;
1323 i->t.target_attrs.ac.attrs = &i->attrs[0];
1324 i->t.target_attrs.ac.match = spi_target_match;
1325 transport_container_register(&i->t.target_attrs);
1326 i->t.target_size = sizeof(struct spi_transport_attrs);
1327 i->t.host_attrs.ac.class = &spi_host_class.class;
1328 i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1329 i->t.host_attrs.ac.match = spi_host_match;
1330 transport_container_register(&i->t.host_attrs);
1331 i->t.host_size = sizeof(struct spi_host_attrs);
1332 i->f = ft;
1333
1334 SETUP_ATTRIBUTE(period);
James Bottomley 62a86122005-05-06 18:05:20 -05001335 SETUP_RELATED_ATTRIBUTE(min_period, period);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 SETUP_ATTRIBUTE(offset);
James Bottomley 62a86122005-05-06 18:05:20 -05001337 SETUP_RELATED_ATTRIBUTE(max_offset, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 SETUP_ATTRIBUTE(width);
James Bottomley 62a86122005-05-06 18:05:20 -05001339 SETUP_RELATED_ATTRIBUTE(max_width, width);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 SETUP_ATTRIBUTE(iu);
1341 SETUP_ATTRIBUTE(dt);
1342 SETUP_ATTRIBUTE(qas);
1343 SETUP_ATTRIBUTE(wr_flow);
1344 SETUP_ATTRIBUTE(rd_strm);
1345 SETUP_ATTRIBUTE(rti);
1346 SETUP_ATTRIBUTE(pcomp_en);
James Bottomleyd872ebe2005-08-03 15:43:52 -05001347 SETUP_ATTRIBUTE(hold_mcs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348
1349 /* if you add an attribute but forget to increase SPI_NUM_ATTRS
1350 * this bug will trigger */
1351 BUG_ON(count > SPI_NUM_ATTRS);
1352
1353 i->attrs[count++] = &class_device_attr_revalidate;
1354
1355 i->attrs[count] = NULL;
1356
1357 count = 0;
1358 SETUP_HOST_ATTRIBUTE(signalling);
1359
1360 BUG_ON(count > SPI_HOST_ATTRS);
1361
1362 i->host_attrs[count] = NULL;
1363
1364 return &i->t;
1365}
1366EXPORT_SYMBOL(spi_attach_transport);
1367
1368void spi_release_transport(struct scsi_transport_template *t)
1369{
1370 struct spi_internal *i = to_spi_internal(t);
1371
1372 transport_container_unregister(&i->t.target_attrs);
1373 transport_container_unregister(&i->t.host_attrs);
1374
1375 kfree(i);
1376}
1377EXPORT_SYMBOL(spi_release_transport);
1378
1379static __init int spi_transport_init(void)
1380{
1381 int error = transport_class_register(&spi_transport_class);
1382 if (error)
1383 return error;
1384 error = anon_transport_class_register(&spi_device_class);
1385 return transport_class_register(&spi_host_class);
1386}
1387
1388static void __exit spi_transport_exit(void)
1389{
1390 transport_class_unregister(&spi_transport_class);
1391 anon_transport_class_unregister(&spi_device_class);
1392 transport_class_unregister(&spi_host_class);
1393}
1394
1395MODULE_AUTHOR("Martin Hicks");
1396MODULE_DESCRIPTION("SPI Transport Attributes");
1397MODULE_LICENSE("GPL");
1398
1399module_init(spi_transport_init);
1400module_exit(spi_transport_exit);