blob: c25bd9a34e02f4fa2b106694d0e93a8fa28b1e3b [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 */
21#include <linux/ctype.h>
22#include <linux/init.h>
23#include <linux/module.h>
24#include <linux/workqueue.h>
James Bottomley949bf792005-05-01 18:58:15 -050025#include <linux/blkdev.h>
Jes Sorensend158d262006-01-13 16:05:44 -080026#include <linux/mutex.h>
Randy Dunlap9f9a73b2008-04-23 09:56:14 -070027#include <linux/sysfs.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
James Bottomleya9e0edb2009-06-17 19:05:05 +000049/* Our blacklist flags */
50enum {
51 SPI_BLIST_NOIUS = 0x1,
52};
53
54/* blacklist table, modelled on scsi_devinfo.c */
55static struct {
56 char *vendor;
57 char *model;
58 unsigned flags;
59} spi_static_device_list[] __initdata = {
60 {"HP", "Ultrium 3-SCSI", SPI_BLIST_NOIUS },
61 {"IBM", "ULTRIUM-TD3", SPI_BLIST_NOIUS },
62 {NULL, NULL, 0}
63};
64
Linus Torvalds1da177e2005-04-16 15:20:36 -070065/* Private data accessors (keep these out of the header file) */
James Bottomleydfdc58b2006-09-20 12:00:18 -040066#define spi_dv_in_progress(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_in_progress)
Jes Sorensend158d262006-01-13 16:05:44 -080067#define spi_dv_mutex(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_mutex)
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69struct spi_internal {
70 struct scsi_transport_template t;
71 struct spi_function_template *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072};
73
74#define to_spi_internal(tmpl) container_of(tmpl, struct spi_internal, t)
75
76static const int ppr_to_ps[] = {
77 /* The PPR values 0-6 are reserved, fill them in when
78 * the committee defines them */
79 -1, /* 0x00 */
80 -1, /* 0x01 */
81 -1, /* 0x02 */
82 -1, /* 0x03 */
83 -1, /* 0x04 */
84 -1, /* 0x05 */
85 -1, /* 0x06 */
86 3125, /* 0x07 */
87 6250, /* 0x08 */
88 12500, /* 0x09 */
89 25000, /* 0x0a */
90 30300, /* 0x0b */
91 50000, /* 0x0c */
92};
93/* The PPR values at which you calculate the period in ns by multiplying
94 * by 4 */
95#define SPI_STATIC_PPR 0x0c
96
97static int sprint_frac(char *dest, int value, int denom)
98{
99 int frac = value % denom;
100 int result = sprintf(dest, "%d", value / denom);
101
102 if (frac == 0)
103 return result;
104 dest[result++] = '.';
105
106 do {
107 denom /= 10;
108 sprintf(dest + result, "%d", frac / denom);
109 result++;
110 frac %= denom;
111 } while (frac);
112
113 dest[result++] = '\0';
114 return result;
115}
116
James Bottomley33aa6872005-08-28 11:31:14 -0500117static int spi_execute(struct scsi_device *sdev, const void *cmd,
118 enum dma_data_direction dir,
119 void *buffer, unsigned bufflen,
120 struct scsi_sense_hdr *sshdr)
James Bottomley949bf792005-05-01 18:58:15 -0500121{
James Bottomley33aa6872005-08-28 11:31:14 -0500122 int i, result;
123 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
James Bottomley949bf792005-05-01 18:58:15 -0500124
125 for(i = 0; i < DV_RETRIES; i++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500126 result = scsi_execute(sdev, cmd, dir, buffer, bufflen,
127 sense, DV_TIMEOUT, /* retries */ 1,
Mike Christie6000a362008-08-19 18:45:30 -0500128 REQ_FAILFAST_DEV |
129 REQ_FAILFAST_TRANSPORT |
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900130 REQ_FAILFAST_DRIVER,
131 NULL);
FUJITA Tomonori4d3fef92008-12-05 15:37:52 +0900132 if (driver_byte(result) & DRIVER_SENSE) {
James Bottomley33aa6872005-08-28 11:31:14 -0500133 struct scsi_sense_hdr sshdr_tmp;
134 if (!sshdr)
135 sshdr = &sshdr_tmp;
James Bottomley949bf792005-05-01 18:58:15 -0500136
James Bottomley4ed381e2006-12-11 09:47:06 -0600137 if (scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE,
James Bottomley33aa6872005-08-28 11:31:14 -0500138 sshdr)
139 && sshdr->sense_key == UNIT_ATTENTION)
James Bottomley949bf792005-05-01 18:58:15 -0500140 continue;
141 }
142 break;
143 }
James Bottomley33aa6872005-08-28 11:31:14 -0500144 return result;
James Bottomley949bf792005-05-01 18:58:15 -0500145}
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147static struct {
148 enum spi_signal_type value;
149 char *name;
150} signal_types[] = {
151 { SPI_SIGNAL_UNKNOWN, "unknown" },
152 { SPI_SIGNAL_SE, "SE" },
153 { SPI_SIGNAL_LVD, "LVD" },
154 { SPI_SIGNAL_HVD, "HVD" },
155};
156
157static inline const char *spi_signal_to_string(enum spi_signal_type type)
158{
159 int i;
160
Tobias Klauser6391a112006-06-08 22:23:48 -0700161 for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 if (type == signal_types[i].value)
163 return signal_types[i].name;
164 }
165 return NULL;
166}
167static inline enum spi_signal_type spi_signal_to_value(const char *name)
168{
169 int i, len;
170
Tobias Klauser6391a112006-06-08 22:23:48 -0700171 for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 len = strlen(signal_types[i].name);
173 if (strncmp(name, signal_types[i].name, len) == 0 &&
174 (name[len] == '\n' || name[len] == '\0'))
175 return signal_types[i].value;
176 }
177 return SPI_SIGNAL_UNKNOWN;
178}
179
James Bottomleyd0a7e572005-08-14 17:09:01 -0500180static int spi_host_setup(struct transport_container *tc, struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100181 struct device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182{
183 struct Scsi_Host *shost = dev_to_shost(dev);
184
185 spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;
186
187 return 0;
188}
189
James Bottomley9b161a42008-01-05 10:18:27 -0600190static int spi_host_configure(struct transport_container *tc,
191 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100192 struct device *cdev);
James Bottomley9b161a42008-01-05 10:18:27 -0600193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194static DECLARE_TRANSPORT_CLASS(spi_host_class,
195 "spi_host",
196 spi_host_setup,
197 NULL,
James Bottomley9b161a42008-01-05 10:18:27 -0600198 spi_host_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200static int spi_host_match(struct attribute_container *cont,
201 struct device *dev)
202{
203 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205 if (!scsi_is_host_device(dev))
206 return 0;
207
208 shost = dev_to_shost(dev);
209 if (!shost->transportt || shost->transportt->host_attrs.ac.class
210 != &spi_host_class.class)
211 return 0;
212
James Bottomley9b161a42008-01-05 10:18:27 -0600213 return &shost->transportt->host_attrs.ac == cont;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214}
215
James Bottomley9b161a42008-01-05 10:18:27 -0600216static int spi_target_configure(struct transport_container *tc,
217 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100218 struct device *cdev);
James Bottomley9b161a42008-01-05 10:18:27 -0600219
James Bottomleyd0a7e572005-08-14 17:09:01 -0500220static int spi_device_configure(struct transport_container *tc,
221 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100222 struct device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
224 struct scsi_device *sdev = to_scsi_device(dev);
225 struct scsi_target *starget = sdev->sdev_target;
James Bottomleya9e0edb2009-06-17 19:05:05 +0000226 unsigned bflags = scsi_get_device_flags_keyed(sdev, &sdev->inquiry[8],
227 &sdev->inquiry[16],
228 SCSI_DEVINFO_SPI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230 /* Populate the target capability fields with the values
231 * gleaned from the device inquiry */
232
233 spi_support_sync(starget) = scsi_device_sync(sdev);
234 spi_support_wide(starget) = scsi_device_wide(sdev);
235 spi_support_dt(starget) = scsi_device_dt(sdev);
236 spi_support_dt_only(starget) = scsi_device_dt_only(sdev);
237 spi_support_ius(starget) = scsi_device_ius(sdev);
James Bottomleya9e0edb2009-06-17 19:05:05 +0000238 if (bflags & SPI_BLIST_NOIUS) {
239 dev_info(dev, "Information Units disabled by blacklist\n");
240 spi_support_ius(starget) = 0;
241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 spi_support_qas(starget) = scsi_device_qas(sdev);
243
244 return 0;
245}
246
James Bottomleyd0a7e572005-08-14 17:09:01 -0500247static int spi_setup_transport_attrs(struct transport_container *tc,
248 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100249 struct device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250{
251 struct scsi_target *starget = to_scsi_target(dev);
252
253 spi_period(starget) = -1; /* illegal value */
James Bottomley 62a86122005-05-06 18:05:20 -0500254 spi_min_period(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 spi_offset(starget) = 0; /* async */
James Bottomley 62a86122005-05-06 18:05:20 -0500256 spi_max_offset(starget) = 255;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 spi_width(starget) = 0; /* narrow */
James Bottomley 62a86122005-05-06 18:05:20 -0500258 spi_max_width(starget) = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 spi_iu(starget) = 0; /* no IU */
James Bottomleyea443192009-06-13 12:19:05 -0500260 spi_max_iu(starget) = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 spi_dt(starget) = 0; /* ST */
262 spi_qas(starget) = 0;
James Bottomleyea443192009-06-13 12:19:05 -0500263 spi_max_qas(starget) = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 spi_wr_flow(starget) = 0;
265 spi_rd_strm(starget) = 0;
266 spi_rti(starget) = 0;
267 spi_pcomp_en(starget) = 0;
James Bottomleyd872ebe2005-08-03 15:43:52 -0500268 spi_hold_mcs(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 spi_dv_pending(starget) = 0;
James Bottomleydfdc58b2006-09-20 12:00:18 -0400270 spi_dv_in_progress(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 spi_initial_dv(starget) = 0;
Jes Sorensend158d262006-01-13 16:05:44 -0800272 mutex_init(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
274 return 0;
275}
276
James Bottomley 62a86122005-05-06 18:05:20 -0500277#define spi_transport_show_simple(field, format_string) \
278 \
279static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100280show_spi_transport_##field(struct device *dev, \
281 struct device_attribute *attr, char *buf) \
James Bottomley 62a86122005-05-06 18:05:20 -0500282{ \
Tony Jonesee959b02008-02-22 00:13:36 +0100283 struct scsi_target *starget = transport_class_to_starget(dev); \
James Bottomley 62a86122005-05-06 18:05:20 -0500284 struct spi_transport_attrs *tp; \
285 \
286 tp = (struct spi_transport_attrs *)&starget->starget_data; \
287 return snprintf(buf, 20, format_string, tp->field); \
288}
289
290#define spi_transport_store_simple(field, format_string) \
291 \
292static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100293store_spi_transport_##field(struct device *dev, \
294 struct device_attribute *attr, \
295 const char *buf, size_t count) \
James Bottomley 62a86122005-05-06 18:05:20 -0500296{ \
297 int val; \
Tony Jonesee959b02008-02-22 00:13:36 +0100298 struct scsi_target *starget = transport_class_to_starget(dev); \
James Bottomley 62a86122005-05-06 18:05:20 -0500299 struct spi_transport_attrs *tp; \
300 \
301 tp = (struct spi_transport_attrs *)&starget->starget_data; \
302 val = simple_strtoul(buf, NULL, 0); \
303 tp->field = val; \
304 return count; \
305}
306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307#define spi_transport_show_function(field, format_string) \
308 \
309static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100310show_spi_transport_##field(struct device *dev, \
311 struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{ \
Tony Jonesee959b02008-02-22 00:13:36 +0100313 struct scsi_target *starget = transport_class_to_starget(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
315 struct spi_transport_attrs *tp; \
316 struct spi_internal *i = to_spi_internal(shost->transportt); \
317 tp = (struct spi_transport_attrs *)&starget->starget_data; \
318 if (i->f->get_##field) \
319 i->f->get_##field(starget); \
320 return snprintf(buf, 20, format_string, tp->field); \
321}
322
323#define spi_transport_store_function(field, format_string) \
324static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100325store_spi_transport_##field(struct device *dev, \
326 struct device_attribute *attr, \
327 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{ \
329 int val; \
Tony Jonesee959b02008-02-22 00:13:36 +0100330 struct scsi_target *starget = transport_class_to_starget(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
332 struct spi_internal *i = to_spi_internal(shost->transportt); \
333 \
James Bottomley9b161a42008-01-05 10:18:27 -0600334 if (!i->f->set_##field) \
335 return -EINVAL; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 val = simple_strtoul(buf, NULL, 0); \
James Bottomley9b161a42008-01-05 10:18:27 -0600337 i->f->set_##field(starget, val); \
James Bottomley 62a86122005-05-06 18:05:20 -0500338 return count; \
339}
340
341#define spi_transport_store_max(field, format_string) \
342static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100343store_spi_transport_##field(struct device *dev, \
344 struct device_attribute *attr, \
345 const char *buf, size_t count) \
James Bottomley 62a86122005-05-06 18:05:20 -0500346{ \
347 int val; \
Tony Jonesee959b02008-02-22 00:13:36 +0100348 struct scsi_target *starget = transport_class_to_starget(dev); \
James Bottomley 62a86122005-05-06 18:05:20 -0500349 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
350 struct spi_internal *i = to_spi_internal(shost->transportt); \
351 struct spi_transport_attrs *tp \
352 = (struct spi_transport_attrs *)&starget->starget_data; \
353 \
James Bottomley9b161a42008-01-05 10:18:27 -0600354 if (i->f->set_##field) \
355 return -EINVAL; \
James Bottomley 62a86122005-05-06 18:05:20 -0500356 val = simple_strtoul(buf, NULL, 0); \
357 if (val > tp->max_##field) \
358 val = tp->max_##field; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 i->f->set_##field(starget, val); \
360 return count; \
361}
362
363#define spi_transport_rd_attr(field, format_string) \
364 spi_transport_show_function(field, format_string) \
365 spi_transport_store_function(field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100366static DEVICE_ATTR(field, S_IRUGO, \
367 show_spi_transport_##field, \
368 store_spi_transport_##field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
James Bottomley 62a86122005-05-06 18:05:20 -0500370#define spi_transport_simple_attr(field, format_string) \
371 spi_transport_show_simple(field, format_string) \
372 spi_transport_store_simple(field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100373static DEVICE_ATTR(field, S_IRUGO, \
374 show_spi_transport_##field, \
375 store_spi_transport_##field);
James Bottomley 62a86122005-05-06 18:05:20 -0500376
377#define spi_transport_max_attr(field, format_string) \
378 spi_transport_show_function(field, format_string) \
379 spi_transport_store_max(field, format_string) \
380 spi_transport_simple_attr(max_##field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100381static DEVICE_ATTR(field, S_IRUGO, \
382 show_spi_transport_##field, \
383 store_spi_transport_##field);
James Bottomley 62a86122005-05-06 18:05:20 -0500384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385/* The Parallel SCSI Tranport Attributes: */
James Bottomley 62a86122005-05-06 18:05:20 -0500386spi_transport_max_attr(offset, "%d\n");
387spi_transport_max_attr(width, "%d\n");
James Bottomleyea443192009-06-13 12:19:05 -0500388spi_transport_max_attr(iu, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389spi_transport_rd_attr(dt, "%d\n");
James Bottomleyea443192009-06-13 12:19:05 -0500390spi_transport_max_attr(qas, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391spi_transport_rd_attr(wr_flow, "%d\n");
392spi_transport_rd_attr(rd_strm, "%d\n");
393spi_transport_rd_attr(rti, "%d\n");
394spi_transport_rd_attr(pcomp_en, "%d\n");
James Bottomleyd872ebe2005-08-03 15:43:52 -0500395spi_transport_rd_attr(hold_mcs, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
James Bottomleye8bac9e2008-07-29 12:52:20 -0500397/* we only care about the first child device that's a real SCSI device
398 * so we return 1 to terminate the iteration when we find it */
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800399static int child_iter(struct device *dev, void *data)
400{
James Bottomleye8bac9e2008-07-29 12:52:20 -0500401 if (!scsi_is_sdev_device(dev))
402 return 0;
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800403
James Bottomleye8bac9e2008-07-29 12:52:20 -0500404 spi_dv_device(to_scsi_device(dev));
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800405 return 1;
406}
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100409store_spi_revalidate(struct device *dev, struct device_attribute *attr,
410 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411{
Tony Jonesee959b02008-02-22 00:13:36 +0100412 struct scsi_target *starget = transport_class_to_starget(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800414 device_for_each_child(&starget->dev, NULL, child_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 return count;
416}
Tony Jonesee959b02008-02-22 00:13:36 +0100417static DEVICE_ATTR(revalidate, S_IWUSR, NULL, store_spi_revalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419/* Translate the period into ns according to the current spec
420 * for SDTR/PPR messages */
Matthew Wilcoxef725822005-12-15 16:22:01 -0500421static int period_to_str(char *buf, int period)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 int len, picosec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
James Bottomley 62a86122005-05-06 18:05:20 -0500425 if (period < 0 || period > 0xff) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 picosec = -1;
James Bottomley 62a86122005-05-06 18:05:20 -0500427 } else if (period <= SPI_STATIC_PPR) {
428 picosec = ppr_to_ps[period];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 } else {
James Bottomley 62a86122005-05-06 18:05:20 -0500430 picosec = period * 4000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 }
432
433 if (picosec == -1) {
434 len = sprintf(buf, "reserved");
435 } else {
436 len = sprint_frac(buf, picosec, 1000);
437 }
438
Matthew Wilcoxef725822005-12-15 16:22:01 -0500439 return len;
440}
441
442static ssize_t
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700443show_spi_transport_period_helper(char *buf, int period)
Matthew Wilcoxef725822005-12-15 16:22:01 -0500444{
445 int len = period_to_str(buf, period);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 buf[len++] = '\n';
447 buf[len] = '\0';
448 return len;
449}
450
451static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100452store_spi_transport_period_helper(struct device *dev, const char *buf,
James Bottomley 62a86122005-05-06 18:05:20 -0500453 size_t count, int *periodp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 int j, picosec, period = -1;
456 char *endp;
457
458 picosec = simple_strtoul(buf, &endp, 10) * 1000;
459 if (*endp == '.') {
460 int mult = 100;
461 do {
462 endp++;
463 if (!isdigit(*endp))
464 break;
465 picosec += (*endp - '0') * mult;
466 mult /= 10;
467 } while (mult > 0);
468 }
469
470 for (j = 0; j <= SPI_STATIC_PPR; j++) {
471 if (ppr_to_ps[j] < picosec)
472 continue;
473 period = j;
474 break;
475 }
476
477 if (period == -1)
478 period = picosec / 4000;
479
480 if (period > 0xff)
481 period = 0xff;
482
James Bottomley 62a86122005-05-06 18:05:20 -0500483 *periodp = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
485 return count;
486}
487
James Bottomley 62a86122005-05-06 18:05:20 -0500488static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100489show_spi_transport_period(struct device *dev,
490 struct device_attribute *attr, char *buf)
James Bottomley 62a86122005-05-06 18:05:20 -0500491{
Tony Jonesee959b02008-02-22 00:13:36 +0100492 struct scsi_target *starget = transport_class_to_starget(dev);
James Bottomley 62a86122005-05-06 18:05:20 -0500493 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
494 struct spi_internal *i = to_spi_internal(shost->transportt);
495 struct spi_transport_attrs *tp =
496 (struct spi_transport_attrs *)&starget->starget_data;
497
498 if (i->f->get_period)
499 i->f->get_period(starget);
500
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700501 return show_spi_transport_period_helper(buf, tp->period);
James Bottomley 62a86122005-05-06 18:05:20 -0500502}
503
504static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100505store_spi_transport_period(struct device *cdev, struct device_attribute *attr,
506 const char *buf, size_t count)
James Bottomley 62a86122005-05-06 18:05:20 -0500507{
508 struct scsi_target *starget = transport_class_to_starget(cdev);
509 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
510 struct spi_internal *i = to_spi_internal(shost->transportt);
511 struct spi_transport_attrs *tp =
512 (struct spi_transport_attrs *)&starget->starget_data;
513 int period, retval;
514
James Bottomley9b161a42008-01-05 10:18:27 -0600515 if (!i->f->set_period)
516 return -EINVAL;
517
James Bottomley 62a86122005-05-06 18:05:20 -0500518 retval = store_spi_transport_period_helper(cdev, buf, count, &period);
519
520 if (period < tp->min_period)
521 period = tp->min_period;
522
523 i->f->set_period(starget, period);
524
525 return retval;
526}
527
Tony Jonesee959b02008-02-22 00:13:36 +0100528static DEVICE_ATTR(period, S_IRUGO,
529 show_spi_transport_period,
530 store_spi_transport_period);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
James Bottomley 62a86122005-05-06 18:05:20 -0500532static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100533show_spi_transport_min_period(struct device *cdev,
534 struct device_attribute *attr, char *buf)
James Bottomley 62a86122005-05-06 18:05:20 -0500535{
536 struct scsi_target *starget = transport_class_to_starget(cdev);
James Bottomley9b161a42008-01-05 10:18:27 -0600537 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
538 struct spi_internal *i = to_spi_internal(shost->transportt);
James Bottomley 62a86122005-05-06 18:05:20 -0500539 struct spi_transport_attrs *tp =
540 (struct spi_transport_attrs *)&starget->starget_data;
541
James Bottomley9b161a42008-01-05 10:18:27 -0600542 if (!i->f->set_period)
543 return -EINVAL;
544
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700545 return show_spi_transport_period_helper(buf, tp->min_period);
James Bottomley 62a86122005-05-06 18:05:20 -0500546}
547
548static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100549store_spi_transport_min_period(struct device *cdev,
550 struct device_attribute *attr,
551 const char *buf, size_t count)
James Bottomley 62a86122005-05-06 18:05:20 -0500552{
553 struct scsi_target *starget = transport_class_to_starget(cdev);
554 struct spi_transport_attrs *tp =
555 (struct spi_transport_attrs *)&starget->starget_data;
556
557 return store_spi_transport_period_helper(cdev, buf, count,
558 &tp->min_period);
559}
560
561
Tony Jonesee959b02008-02-22 00:13:36 +0100562static DEVICE_ATTR(min_period, S_IRUGO,
563 show_spi_transport_min_period,
564 store_spi_transport_min_period);
James Bottomley 62a86122005-05-06 18:05:20 -0500565
566
Tony Jonesee959b02008-02-22 00:13:36 +0100567static ssize_t show_spi_host_signalling(struct device *cdev,
568 struct device_attribute *attr,
569 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
571 struct Scsi_Host *shost = transport_class_to_shost(cdev);
572 struct spi_internal *i = to_spi_internal(shost->transportt);
573
574 if (i->f->get_signalling)
575 i->f->get_signalling(shost);
576
577 return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
578}
Tony Jonesee959b02008-02-22 00:13:36 +0100579static ssize_t store_spi_host_signalling(struct device *dev,
580 struct device_attribute *attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 const char *buf, size_t count)
582{
Tony Jonesee959b02008-02-22 00:13:36 +0100583 struct Scsi_Host *shost = transport_class_to_shost(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 struct spi_internal *i = to_spi_internal(shost->transportt);
585 enum spi_signal_type type = spi_signal_to_value(buf);
586
James Bottomley9b161a42008-01-05 10:18:27 -0600587 if (!i->f->set_signalling)
588 return -EINVAL;
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 if (type != SPI_SIGNAL_UNKNOWN)
591 i->f->set_signalling(shost, type);
592
593 return count;
594}
Tony Jonesee959b02008-02-22 00:13:36 +0100595static DEVICE_ATTR(signalling, S_IRUGO,
596 show_spi_host_signalling,
597 store_spi_host_signalling);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
599#define DV_SET(x, y) \
600 if(i->f->set_##x) \
601 i->f->set_##x(sdev->sdev_target, y)
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603enum spi_compare_returns {
604 SPI_COMPARE_SUCCESS,
605 SPI_COMPARE_FAILURE,
606 SPI_COMPARE_SKIP_TEST,
607};
608
609
610/* This is for read/write Domain Validation: If the device supports
611 * an echo buffer, we do read/write tests to it */
612static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500613spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 u8 *ptr, const int retries)
615{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 int len = ptr - buffer;
James Bottomley33aa6872005-08-28 11:31:14 -0500617 int j, k, r, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 unsigned int pattern = 0x0000ffff;
James Bottomley33aa6872005-08-28 11:31:14 -0500619 struct scsi_sense_hdr sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
621 const char spi_write_buffer[] = {
622 WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
623 };
624 const char spi_read_buffer[] = {
625 READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
626 };
627
628 /* set up the pattern buffer. Doesn't matter if we spill
629 * slightly beyond since that's where the read buffer is */
630 for (j = 0; j < len; ) {
631
632 /* fill the buffer with counting (test a) */
633 for ( ; j < min(len, 32); j++)
634 buffer[j] = j;
635 k = j;
636 /* fill the buffer with alternating words of 0x0 and
637 * 0xffff (test b) */
638 for ( ; j < min(len, k + 32); j += 2) {
639 u16 *word = (u16 *)&buffer[j];
640
641 *word = (j & 0x02) ? 0x0000 : 0xffff;
642 }
643 k = j;
644 /* fill with crosstalk (alternating 0x5555 0xaaa)
645 * (test c) */
646 for ( ; j < min(len, k + 32); j += 2) {
647 u16 *word = (u16 *)&buffer[j];
648
649 *word = (j & 0x02) ? 0x5555 : 0xaaaa;
650 }
651 k = j;
652 /* fill with shifting bits (test d) */
653 for ( ; j < min(len, k + 32); j += 4) {
654 u32 *word = (unsigned int *)&buffer[j];
655 u32 roll = (pattern & 0x80000000) ? 1 : 0;
656
657 *word = pattern;
658 pattern = (pattern << 1) | roll;
659 }
660 /* don't bother with random data (test e) */
661 }
662
663 for (r = 0; r < retries; r++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500664 result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
665 buffer, len, &sshdr);
666 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668 scsi_device_set_state(sdev, SDEV_QUIESCE);
James Bottomley33aa6872005-08-28 11:31:14 -0500669 if (scsi_sense_valid(&sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 && sshdr.sense_key == ILLEGAL_REQUEST
671 /* INVALID FIELD IN CDB */
672 && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
673 /* This would mean that the drive lied
674 * to us about supporting an echo
675 * buffer (unfortunately some Western
676 * Digital drives do precisely this)
677 */
678 return SPI_COMPARE_SKIP_TEST;
679
680
James Bottomley9ccfc752005-10-02 11:45:08 -0500681 sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return SPI_COMPARE_FAILURE;
683 }
684
685 memset(ptr, 0, len);
James Bottomley33aa6872005-08-28 11:31:14 -0500686 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
687 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 scsi_device_set_state(sdev, SDEV_QUIESCE);
689
690 if (memcmp(buffer, ptr, len) != 0)
691 return SPI_COMPARE_FAILURE;
692 }
693 return SPI_COMPARE_SUCCESS;
694}
695
696/* This is for the simplest form of Domain Validation: a read test
697 * on the inquiry data from the device */
698static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500699spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 u8 *ptr, const int retries)
701{
James Bottomley33aa6872005-08-28 11:31:14 -0500702 int r, result;
703 const int len = sdev->inquiry_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 const char spi_inquiry[] = {
705 INQUIRY, 0, 0, 0, len, 0
706 };
707
708 for (r = 0; r < retries; r++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 memset(ptr, 0, len);
710
James Bottomley33aa6872005-08-28 11:31:14 -0500711 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
712 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
James Bottomley33aa6872005-08-28 11:31:14 -0500714 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 scsi_device_set_state(sdev, SDEV_QUIESCE);
716 return SPI_COMPARE_FAILURE;
717 }
718
719 /* If we don't have the inquiry data already, the
720 * first read gets it */
721 if (ptr == buffer) {
722 ptr += len;
723 --r;
724 continue;
725 }
726
727 if (memcmp(buffer, ptr, len) != 0)
728 /* failure */
729 return SPI_COMPARE_FAILURE;
730 }
731 return SPI_COMPARE_SUCCESS;
732}
733
734static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500735spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500737 (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
James Bottomley33aa6872005-08-28 11:31:14 -0500739 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500740 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 int period = 0, prevperiod = 0;
742 enum spi_compare_returns retval;
743
744
745 for (;;) {
746 int newperiod;
James Bottomley33aa6872005-08-28 11:31:14 -0500747 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 if (retval == SPI_COMPARE_SUCCESS
750 || retval == SPI_COMPARE_SKIP_TEST)
751 break;
752
753 /* OK, retrain, fallback */
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500754 if (i->f->get_iu)
755 i->f->get_iu(starget);
756 if (i->f->get_qas)
757 i->f->get_qas(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 if (i->f->get_period)
759 i->f->get_period(sdev->sdev_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500761 /* Here's the fallback sequence; first try turning off
762 * IU, then QAS (if we can control them), then finally
763 * fall down the periods */
764 if (i->f->set_iu && spi_iu(starget)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500765 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Information Units\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500766 DV_SET(iu, 0);
767 } else if (i->f->set_qas && spi_qas(starget)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500768 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500769 DV_SET(qas, 0);
770 } else {
771 newperiod = spi_period(starget);
772 period = newperiod > period ? newperiod : period;
773 if (period < 0x0d)
774 period++;
775 else
776 period += period >> 1;
777
778 if (unlikely(period > 0xff || period == prevperiod)) {
779 /* Total failure; set to async and return */
James Bottomley9ccfc752005-10-02 11:45:08 -0500780 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500781 DV_SET(offset, 0);
782 return SPI_COMPARE_FAILURE;
783 }
James Bottomley9ccfc752005-10-02 11:45:08 -0500784 starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500785 DV_SET(period, period);
786 prevperiod = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 }
789 return retval;
790}
791
792static int
James Bottomley33aa6872005-08-28 11:31:14 -0500793spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
James Bottomley33aa6872005-08-28 11:31:14 -0500795 int l, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
797 /* first off do a test unit ready. This can error out
798 * because of reservations or some other reason. If it
799 * fails, the device won't let us write to the echo buffer
800 * so just return failure */
801
802 const char spi_test_unit_ready[] = {
803 TEST_UNIT_READY, 0, 0, 0, 0, 0
804 };
805
806 const char spi_read_buffer_descriptor[] = {
807 READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
808 };
809
810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 /* We send a set of three TURs to clear any outstanding
812 * unit attention conditions if they exist (Otherwise the
813 * buffer tests won't be happy). If the TUR still fails
814 * (reservation conflict, device not ready, etc) just
815 * skip the write tests */
816 for (l = 0; ; l++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500817 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE,
818 NULL, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
James Bottomley33aa6872005-08-28 11:31:14 -0500820 if(result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 if(l >= 3)
822 return 0;
823 } else {
824 /* TUR succeeded */
825 break;
826 }
827 }
828
James Bottomley33aa6872005-08-28 11:31:14 -0500829 result = spi_execute(sdev, spi_read_buffer_descriptor,
830 DMA_FROM_DEVICE, buffer, 4, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
James Bottomley33aa6872005-08-28 11:31:14 -0500832 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 /* Device has no echo buffer */
834 return 0;
835
836 return buffer[3] + ((buffer[2] & 0x1f) << 8);
837}
838
839static void
James Bottomley33aa6872005-08-28 11:31:14 -0500840spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
James Bottomley33aa6872005-08-28 11:31:14 -0500842 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley 62a86122005-05-06 18:05:20 -0500843 struct scsi_target *starget = sdev->sdev_target;
James Bottomley60eef252006-06-10 10:51:23 -0500844 struct Scsi_Host *shost = sdev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 int len = sdev->inquiry_len;
James Bottomley23028272007-09-22 08:40:09 -0500846 int min_period = spi_min_period(starget);
847 int max_width = spi_max_width(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 /* first set us up for narrow async */
849 DV_SET(offset, 0);
850 DV_SET(width, 0);
James Bottomley23028272007-09-22 08:40:09 -0500851
James Bottomley33aa6872005-08-28 11:31:14 -0500852 if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500854 starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 /* FIXME: should probably offline the device here? */
856 return;
857 }
858
James Bottomley9872b812009-06-17 15:03:41 -0400859 if (!spi_support_wide(starget)) {
James Bottomley23028272007-09-22 08:40:09 -0500860 spi_max_width(starget) = 0;
861 max_width = 0;
862 }
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 /* test width */
James Bottomley23028272007-09-22 08:40:09 -0500865 if (i->f->set_width && max_width) {
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500866 i->f->set_width(starget, 1);
James Bottomley 62a86122005-05-06 18:05:20 -0500867
James Bottomley33aa6872005-08-28 11:31:14 -0500868 if (spi_dv_device_compare_inquiry(sdev, buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 buffer + len,
870 DV_LOOPS)
871 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500872 starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500873 i->f->set_width(starget, 0);
James Bottomley23028272007-09-22 08:40:09 -0500874 /* Make sure we don't force wide back on by asking
875 * for a transfer period that requires it */
876 max_width = 0;
877 if (min_period < 10)
878 min_period = 10;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 }
880 }
881
882 if (!i->f->set_period)
883 return;
884
885 /* device can't handle synchronous */
James Bottomley9872b812009-06-17 15:03:41 -0400886 if (!spi_support_sync(starget) && !spi_support_dt(starget))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 return;
888
James Bottomley349cd7c2005-11-28 15:41:58 -0600889 /* len == -1 is the signal that we need to ascertain the
890 * presence of an echo buffer before trying to use it. len ==
891 * 0 means we don't have an echo buffer */
892 len = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
894 retry:
895
896 /* now set up to the maximum */
James Bottomley 62a86122005-05-06 18:05:20 -0500897 DV_SET(offset, spi_max_offset(starget));
James Bottomley23028272007-09-22 08:40:09 -0500898 DV_SET(period, min_period);
899
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500900 /* try QAS requests; this should be harmless to set if the
901 * target supports it */
James Bottomley9872b812009-06-17 15:03:41 -0400902 if (spi_support_qas(starget) && spi_max_qas(starget)) {
James Bottomleyeb1dd682005-07-02 12:22:01 -0400903 DV_SET(qas, 1);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400904 } else {
905 DV_SET(qas, 0);
906 }
907
James Bottomley9872b812009-06-17 15:03:41 -0400908 if (spi_support_ius(starget) && spi_max_iu(starget) &&
909 min_period < 9) {
James Bottomleydfdc58b2006-09-20 12:00:18 -0400910 /* This u320 (or u640). Set IU transfers */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400911 DV_SET(iu, 1);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400912 /* Then set the optional parameters */
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500913 DV_SET(rd_strm, 1);
914 DV_SET(wr_flow, 1);
915 DV_SET(rti, 1);
James Bottomley23028272007-09-22 08:40:09 -0500916 if (min_period == 8)
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500917 DV_SET(pcomp_en, 1);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400918 } else {
919 DV_SET(iu, 0);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500920 }
James Bottomleydfdc58b2006-09-20 12:00:18 -0400921
James Bottomley60eef252006-06-10 10:51:23 -0500922 /* now that we've done all this, actually check the bus
923 * signal type (if known). Some devices are stupid on
924 * a SE bus and still claim they can try LVD only settings */
925 if (i->f->get_signalling)
926 i->f->get_signalling(shost);
927 if (spi_signalling(shost) == SPI_SIGNAL_SE ||
James Bottomleydfdc58b2006-09-20 12:00:18 -0400928 spi_signalling(shost) == SPI_SIGNAL_HVD ||
James Bottomley9872b812009-06-17 15:03:41 -0400929 !spi_support_dt(starget)) {
James Bottomley60eef252006-06-10 10:51:23 -0500930 DV_SET(dt, 0);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400931 } else {
932 DV_SET(dt, 1);
933 }
James Bottomley23028272007-09-22 08:40:09 -0500934 /* set width last because it will pull all the other
935 * parameters down to required values */
936 DV_SET(width, max_width);
937
James Bottomley349cd7c2005-11-28 15:41:58 -0600938 /* Do the read only INQUIRY tests */
939 spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
940 spi_dv_device_compare_inquiry);
941 /* See if we actually managed to negotiate and sustain DT */
942 if (i->f->get_dt)
943 i->f->get_dt(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
James Bottomley349cd7c2005-11-28 15:41:58 -0600945 /* see if the device has an echo buffer. If it does we can do
946 * the SPI pattern write tests. Because of some broken
947 * devices, we *only* try this on a device that has actually
948 * negotiated DT */
949
950 if (len == -1 && spi_dt(starget))
951 len = spi_dv_device_get_echo_buffer(sdev, buffer);
952
953 if (len <= 0) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500954 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 return;
956 }
957
958 if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500959 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 -0700960 len = SPI_MAX_ECHO_BUFFER_SIZE;
961 }
962
James Bottomley33aa6872005-08-28 11:31:14 -0500963 if (spi_dv_retrain(sdev, buffer, buffer + len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 spi_dv_device_echo_buffer)
965 == SPI_COMPARE_SKIP_TEST) {
966 /* OK, the stupid drive can't do a write echo buffer
967 * test after all, fall back to the read tests */
968 len = 0;
969 goto retry;
970 }
971}
972
973
974/** spi_dv_device - Do Domain Validation on the device
975 * @sdev: scsi device to validate
976 *
977 * Performs the domain validation on the given device in the
978 * current execution thread. Since DV operations may sleep,
979 * the current thread must have user context. Also no SCSI
980 * related locks that would deadlock I/O issued by the DV may
981 * be held.
982 */
983void
984spi_dv_device(struct scsi_device *sdev)
985{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 struct scsi_target *starget = sdev->sdev_target;
987 u8 *buffer;
988 const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 if (unlikely(scsi_device_get(sdev)))
James Bottomley33aa6872005-08-28 11:31:14 -0500991 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
James Bottomleydfdc58b2006-09-20 12:00:18 -0400993 if (unlikely(spi_dv_in_progress(starget)))
994 return;
995 spi_dv_in_progress(starget) = 1;
996
Jes Sorensen24669f752006-01-16 10:31:18 -0500997 buffer = kzalloc(len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
999 if (unlikely(!buffer))
1000 goto out_put;
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 /* We need to verify that the actual device will quiesce; the
1003 * later target quiesce is just a nice to have */
1004 if (unlikely(scsi_device_quiesce(sdev)))
1005 goto out_free;
1006
1007 scsi_target_quiesce(starget);
1008
1009 spi_dv_pending(starget) = 1;
Jes Sorensend158d262006-01-13 16:05:44 -08001010 mutex_lock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
James Bottomley9ccfc752005-10-02 11:45:08 -05001012 starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
James Bottomley33aa6872005-08-28 11:31:14 -05001014 spi_dv_device_internal(sdev, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
James Bottomley9ccfc752005-10-02 11:45:08 -05001016 starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
Jes Sorensend158d262006-01-13 16:05:44 -08001018 mutex_unlock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 spi_dv_pending(starget) = 0;
1020
1021 scsi_target_resume(starget);
1022
1023 spi_initial_dv(starget) = 1;
1024
1025 out_free:
1026 kfree(buffer);
1027 out_put:
James Bottomleydfdc58b2006-09-20 12:00:18 -04001028 spi_dv_in_progress(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030}
1031EXPORT_SYMBOL(spi_dv_device);
1032
1033struct work_queue_wrapper {
1034 struct work_struct work;
1035 struct scsi_device *sdev;
1036};
1037
1038static void
David Howellsc4028952006-11-22 14:57:56 +00001039spi_dv_device_work_wrapper(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040{
David Howellsc4028952006-11-22 14:57:56 +00001041 struct work_queue_wrapper *wqw =
1042 container_of(work, struct work_queue_wrapper, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 struct scsi_device *sdev = wqw->sdev;
1044
1045 kfree(wqw);
1046 spi_dv_device(sdev);
1047 spi_dv_pending(sdev->sdev_target) = 0;
1048 scsi_device_put(sdev);
1049}
1050
1051
1052/**
1053 * spi_schedule_dv_device - schedule domain validation to occur on the device
1054 * @sdev: The device to validate
1055 *
1056 * Identical to spi_dv_device() above, except that the DV will be
1057 * scheduled to occur in a workqueue later. All memory allocations
1058 * are atomic, so may be called from any context including those holding
1059 * SCSI locks.
1060 */
1061void
1062spi_schedule_dv_device(struct scsi_device *sdev)
1063{
1064 struct work_queue_wrapper *wqw =
1065 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
1066
1067 if (unlikely(!wqw))
1068 return;
1069
1070 if (unlikely(spi_dv_pending(sdev->sdev_target))) {
1071 kfree(wqw);
1072 return;
1073 }
1074 /* Set pending early (dv_device doesn't check it, only sets it) */
1075 spi_dv_pending(sdev->sdev_target) = 1;
1076 if (unlikely(scsi_device_get(sdev))) {
1077 kfree(wqw);
1078 spi_dv_pending(sdev->sdev_target) = 0;
1079 return;
1080 }
1081
David Howellsc4028952006-11-22 14:57:56 +00001082 INIT_WORK(&wqw->work, spi_dv_device_work_wrapper);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 wqw->sdev = sdev;
1084
1085 schedule_work(&wqw->work);
1086}
1087EXPORT_SYMBOL(spi_schedule_dv_device);
1088
1089/**
1090 * spi_display_xfer_agreement - Print the current target transfer agreement
1091 * @starget: The target for which to display the agreement
1092 *
1093 * Each SPI port is required to maintain a transfer agreement for each
1094 * other port on the bus. This function prints a one-line summary of
1095 * the current agreement; more detailed information is available in sysfs.
1096 */
1097void spi_display_xfer_agreement(struct scsi_target *starget)
1098{
1099 struct spi_transport_attrs *tp;
1100 tp = (struct spi_transport_attrs *)&starget->starget_data;
1101
1102 if (tp->offset > 0 && tp->period > 0) {
1103 unsigned int picosec, kb100;
1104 char *scsi = "FAST-?";
1105 char tmp[8];
1106
1107 if (tp->period <= SPI_STATIC_PPR) {
1108 picosec = ppr_to_ps[tp->period];
1109 switch (tp->period) {
1110 case 7: scsi = "FAST-320"; break;
1111 case 8: scsi = "FAST-160"; break;
1112 case 9: scsi = "FAST-80"; break;
1113 case 10:
1114 case 11: scsi = "FAST-40"; break;
1115 case 12: scsi = "FAST-20"; break;
1116 }
1117 } else {
1118 picosec = tp->period * 4000;
1119 if (tp->period < 25)
1120 scsi = "FAST-20";
1121 else if (tp->period < 50)
1122 scsi = "FAST-10";
1123 else
1124 scsi = "FAST-5";
1125 }
1126
1127 kb100 = (10000000 + picosec / 2) / picosec;
1128 if (tp->width)
1129 kb100 *= 2;
1130 sprint_frac(tmp, picosec, 1000);
1131
1132 dev_info(&starget->dev,
James Bottomleyd872ebe2005-08-03 15:43:52 -05001133 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1134 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1135 tp->dt ? "DT" : "ST",
1136 tp->iu ? " IU" : "",
1137 tp->qas ? " QAS" : "",
1138 tp->rd_strm ? " RDSTRM" : "",
1139 tp->rti ? " RTI" : "",
1140 tp->wr_flow ? " WRFLOW" : "",
1141 tp->pcomp_en ? " PCOMP" : "",
1142 tp->hold_mcs ? " HMCS" : "",
1143 tmp, tp->offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 } else {
Matthew Wilcox493ff4e2005-11-17 11:13:43 -07001145 dev_info(&starget->dev, "%sasynchronous\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 tp->width ? "wide " : "");
1147 }
1148}
1149EXPORT_SYMBOL(spi_display_xfer_agreement);
1150
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001151int spi_populate_width_msg(unsigned char *msg, int width)
1152{
1153 msg[0] = EXTENDED_MESSAGE;
1154 msg[1] = 2;
1155 msg[2] = EXTENDED_WDTR;
1156 msg[3] = width;
1157 return 4;
1158}
James Bottomley38e14f82006-02-17 14:58:47 -08001159EXPORT_SYMBOL_GPL(spi_populate_width_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001160
1161int spi_populate_sync_msg(unsigned char *msg, int period, int offset)
1162{
1163 msg[0] = EXTENDED_MESSAGE;
1164 msg[1] = 3;
1165 msg[2] = EXTENDED_SDTR;
1166 msg[3] = period;
1167 msg[4] = offset;
1168 return 5;
1169}
James Bottomley38e14f82006-02-17 14:58:47 -08001170EXPORT_SYMBOL_GPL(spi_populate_sync_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001171
1172int spi_populate_ppr_msg(unsigned char *msg, int period, int offset,
1173 int width, int options)
1174{
1175 msg[0] = EXTENDED_MESSAGE;
1176 msg[1] = 6;
1177 msg[2] = EXTENDED_PPR;
1178 msg[3] = period;
1179 msg[4] = 0;
1180 msg[5] = offset;
1181 msg[6] = width;
1182 msg[7] = options;
1183 return 8;
1184}
James Bottomley38e14f82006-02-17 14:58:47 -08001185EXPORT_SYMBOL_GPL(spi_populate_ppr_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001186
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001187#ifdef CONFIG_SCSI_CONSTANTS
1188static const char * const one_byte_msgs[] = {
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001189/* 0x00 */ "Task Complete", NULL /* Extended Message */, "Save Pointers",
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001190/* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001191/* 0x06 */ "Abort Task Set", "Message Reject", "Nop", "Message Parity Error",
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001192/* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001193/* 0x0c */ "Target Reset", "Abort Task", "Clear Task Set",
1194/* 0x0f */ "Initiate Recovery", "Release Recovery",
1195/* 0x11 */ "Terminate Process", "Continue Task", "Target Transfer Disable",
1196/* 0x14 */ NULL, NULL, "Clear ACA", "LUN Reset"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001197};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001198
1199static const char * const two_byte_msgs[] = {
Matthew Wilcox47972152005-12-15 16:22:01 -05001200/* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001201/* 0x23 */ "Ignore Wide Residue", "ACA"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001202};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001203
1204static const char * const extended_msgs[] = {
1205/* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
Matthew Wilcoxef725822005-12-15 16:22:01 -05001206/* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001207/* 0x04 */ "Parallel Protocol Request", "Modify Bidirectional Data Pointer"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001208};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001209
Adrian Bunkbdd70f22006-01-05 23:39:18 +01001210static void print_nego(const unsigned char *msg, int per, int off, int width)
Matthew Wilcoxef725822005-12-15 16:22:01 -05001211{
1212 if (per) {
1213 char buf[20];
1214 period_to_str(buf, msg[per]);
1215 printk("period = %s ns ", buf);
1216 }
1217
1218 if (off)
1219 printk("offset = %d ", msg[off]);
1220 if (width)
1221 printk("width = %d ", 8 << msg[width]);
1222}
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001223
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001224static void print_ptr(const unsigned char *msg, int msb, const char *desc)
1225{
1226 int ptr = (msg[msb] << 24) | (msg[msb+1] << 16) | (msg[msb+2] << 8) |
1227 msg[msb+3];
1228 printk("%s = %d ", desc, ptr);
1229}
1230
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001231int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001232{
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001233 int len = 1, i;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001234 if (msg[0] == EXTENDED_MESSAGE) {
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001235 len = 2 + msg[1];
1236 if (len == 2)
1237 len += 256;
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001238 if (msg[2] < ARRAY_SIZE(extended_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001239 printk ("%s ", extended_msgs[msg[2]]);
1240 else
1241 printk ("Extended Message, reserved code (0x%02x) ",
1242 (int) msg[2]);
1243 switch (msg[2]) {
1244 case EXTENDED_MODIFY_DATA_POINTER:
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001245 print_ptr(msg, 3, "pointer");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001246 break;
1247 case EXTENDED_SDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001248 print_nego(msg, 3, 4, 0);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001249 break;
1250 case EXTENDED_WDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001251 print_nego(msg, 0, 0, 3);
1252 break;
1253 case EXTENDED_PPR:
1254 print_nego(msg, 3, 5, 6);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001255 break;
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001256 case EXTENDED_MODIFY_BIDI_DATA_PTR:
1257 print_ptr(msg, 3, "out");
1258 print_ptr(msg, 7, "in");
1259 break;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001260 default:
1261 for (i = 2; i < len; ++i)
1262 printk("%02x ", msg[i]);
1263 }
1264 /* Identify */
1265 } else if (msg[0] & 0x80) {
1266 printk("Identify disconnect %sallowed %s %d ",
1267 (msg[0] & 0x40) ? "" : "not ",
1268 (msg[0] & 0x20) ? "target routine" : "lun",
1269 msg[0] & 0x7);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001270 /* Normal One byte */
1271 } else if (msg[0] < 0x1f) {
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001272 if (msg[0] < ARRAY_SIZE(one_byte_msgs) && one_byte_msgs[msg[0]])
Matthew Wilcoxe24d8732006-02-07 08:05:26 -07001273 printk("%s ", one_byte_msgs[msg[0]]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001274 else
1275 printk("reserved (%02x) ", msg[0]);
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001276 } else if (msg[0] == 0x55) {
1277 printk("QAS Request ");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001278 /* Two byte */
1279 } else if (msg[0] <= 0x2f) {
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001280 if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001281 printk("%s %02x ", two_byte_msgs[msg[0] - 0x20],
1282 msg[1]);
1283 else
1284 printk("reserved two byte (%02x %02x) ",
1285 msg[0], msg[1]);
1286 len = 2;
1287 } else
Matthew Wilcoxe24d8732006-02-07 08:05:26 -07001288 printk("reserved ");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001289 return len;
1290}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001291EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001292
1293#else /* ifndef CONFIG_SCSI_CONSTANTS */
1294
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001295int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001296{
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001297 int len = 1, i;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001298
1299 if (msg[0] == EXTENDED_MESSAGE) {
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001300 len = 2 + msg[1];
1301 if (len == 2)
1302 len += 256;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001303 for (i = 0; i < len; ++i)
1304 printk("%02x ", msg[i]);
1305 /* Identify */
1306 } else if (msg[0] & 0x80) {
1307 printk("%02x ", msg[0]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001308 /* Normal One byte */
James Bottomley597705a2006-03-12 09:54:19 -06001309 } else if ((msg[0] < 0x1f) || (msg[0] == 0x55)) {
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001310 printk("%02x ", msg[0]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001311 /* Two byte */
1312 } else if (msg[0] <= 0x2f) {
1313 printk("%02x %02x", msg[0], msg[1]);
1314 len = 2;
1315 } else
1316 printk("%02x ", msg[0]);
1317 return len;
1318}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001319EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001320#endif /* ! CONFIG_SCSI_CONSTANTS */
1321
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322static int spi_device_match(struct attribute_container *cont,
1323 struct device *dev)
1324{
1325 struct scsi_device *sdev;
1326 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001327 struct spi_internal *i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
1329 if (!scsi_is_sdev_device(dev))
1330 return 0;
1331
1332 sdev = to_scsi_device(dev);
1333 shost = sdev->host;
1334 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1335 != &spi_host_class.class)
1336 return 0;
1337 /* Note: this class has no device attributes, so it has
1338 * no per-HBA allocation and thus we don't need to distinguish
1339 * the attribute containers for the device */
James Bottomley10c1b882005-08-14 14:34:06 -05001340 i = to_spi_internal(shost->transportt);
1341 if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1342 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 return 1;
1344}
1345
1346static int spi_target_match(struct attribute_container *cont,
1347 struct device *dev)
1348{
1349 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001350 struct scsi_target *starget;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 struct spi_internal *i;
1352
1353 if (!scsi_is_target_device(dev))
1354 return 0;
1355
1356 shost = dev_to_shost(dev->parent);
1357 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1358 != &spi_host_class.class)
1359 return 0;
1360
1361 i = to_spi_internal(shost->transportt);
James Bottomley10c1b882005-08-14 14:34:06 -05001362 starget = to_scsi_target(dev);
1363
1364 if (i->f->deny_binding && i->f->deny_binding(starget))
1365 return 0;
1366
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 return &i->t.target_attrs.ac == cont;
1368}
1369
1370static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1371 "spi_transport",
1372 spi_setup_transport_attrs,
1373 NULL,
James Bottomley9b161a42008-01-05 10:18:27 -06001374 spi_target_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
1376static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1377 spi_device_match,
1378 spi_device_configure);
1379
James Bottomley9b161a42008-01-05 10:18:27 -06001380static struct attribute *host_attributes[] = {
Tony Jonesee959b02008-02-22 00:13:36 +01001381 &dev_attr_signalling.attr,
James Bottomley9b161a42008-01-05 10:18:27 -06001382 NULL
1383};
1384
1385static struct attribute_group host_attribute_group = {
1386 .attrs = host_attributes,
1387};
1388
1389static int spi_host_configure(struct transport_container *tc,
1390 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +01001391 struct device *cdev)
James Bottomley9b161a42008-01-05 10:18:27 -06001392{
1393 struct kobject *kobj = &cdev->kobj;
1394 struct Scsi_Host *shost = transport_class_to_shost(cdev);
1395 struct spi_internal *si = to_spi_internal(shost->transportt);
Tony Jonesee959b02008-02-22 00:13:36 +01001396 struct attribute *attr = &dev_attr_signalling.attr;
James Bottomley9b161a42008-01-05 10:18:27 -06001397 int rc = 0;
1398
1399 if (si->f->set_signalling)
1400 rc = sysfs_chmod_file(kobj, attr, attr->mode | S_IWUSR);
1401
1402 return rc;
1403}
1404
1405/* returns true if we should be showing the variable. Also
1406 * overloads the return by setting 1<<1 if the attribute should
1407 * be writeable */
1408#define TARGET_ATTRIBUTE_HELPER(name) \
James Bottomley352f6bb2008-03-20 20:57:02 -05001409 (si->f->show_##name ? S_IRUGO : 0) | \
1410 (si->f->set_##name ? S_IWUSR : 0)
James Bottomley9b161a42008-01-05 10:18:27 -06001411
James Bottomley352f6bb2008-03-20 20:57:02 -05001412static mode_t target_attribute_is_visible(struct kobject *kobj,
1413 struct attribute *attr, int i)
James Bottomley9b161a42008-01-05 10:18:27 -06001414{
Tony Jonesee959b02008-02-22 00:13:36 +01001415 struct device *cdev = container_of(kobj, struct device, kobj);
James Bottomley9b161a42008-01-05 10:18:27 -06001416 struct scsi_target *starget = transport_class_to_starget(cdev);
1417 struct Scsi_Host *shost = transport_class_to_shost(cdev);
1418 struct spi_internal *si = to_spi_internal(shost->transportt);
1419
Tony Jonesee959b02008-02-22 00:13:36 +01001420 if (attr == &dev_attr_period.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001421 spi_support_sync(starget))
1422 return TARGET_ATTRIBUTE_HELPER(period);
Tony Jonesee959b02008-02-22 00:13:36 +01001423 else if (attr == &dev_attr_min_period.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001424 spi_support_sync(starget))
1425 return TARGET_ATTRIBUTE_HELPER(period);
Tony Jonesee959b02008-02-22 00:13:36 +01001426 else if (attr == &dev_attr_offset.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001427 spi_support_sync(starget))
1428 return TARGET_ATTRIBUTE_HELPER(offset);
Tony Jonesee959b02008-02-22 00:13:36 +01001429 else if (attr == &dev_attr_max_offset.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001430 spi_support_sync(starget))
1431 return TARGET_ATTRIBUTE_HELPER(offset);
Tony Jonesee959b02008-02-22 00:13:36 +01001432 else if (attr == &dev_attr_width.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001433 spi_support_wide(starget))
1434 return TARGET_ATTRIBUTE_HELPER(width);
Tony Jonesee959b02008-02-22 00:13:36 +01001435 else if (attr == &dev_attr_max_width.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001436 spi_support_wide(starget))
1437 return TARGET_ATTRIBUTE_HELPER(width);
Tony Jonesee959b02008-02-22 00:13:36 +01001438 else if (attr == &dev_attr_iu.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001439 spi_support_ius(starget))
1440 return TARGET_ATTRIBUTE_HELPER(iu);
James Bottomleyea443192009-06-13 12:19:05 -05001441 else if (attr == &dev_attr_max_iu.attr &&
1442 spi_support_ius(starget))
1443 return TARGET_ATTRIBUTE_HELPER(iu);
Tony Jonesee959b02008-02-22 00:13:36 +01001444 else if (attr == &dev_attr_dt.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001445 spi_support_dt(starget))
1446 return TARGET_ATTRIBUTE_HELPER(dt);
Tony Jonesee959b02008-02-22 00:13:36 +01001447 else if (attr == &dev_attr_qas.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001448 spi_support_qas(starget))
1449 return TARGET_ATTRIBUTE_HELPER(qas);
James Bottomleyea443192009-06-13 12:19:05 -05001450 else if (attr == &dev_attr_max_qas.attr &&
1451 spi_support_qas(starget))
1452 return TARGET_ATTRIBUTE_HELPER(qas);
Tony Jonesee959b02008-02-22 00:13:36 +01001453 else if (attr == &dev_attr_wr_flow.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001454 spi_support_ius(starget))
1455 return TARGET_ATTRIBUTE_HELPER(wr_flow);
Tony Jonesee959b02008-02-22 00:13:36 +01001456 else if (attr == &dev_attr_rd_strm.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001457 spi_support_ius(starget))
1458 return TARGET_ATTRIBUTE_HELPER(rd_strm);
Tony Jonesee959b02008-02-22 00:13:36 +01001459 else if (attr == &dev_attr_rti.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001460 spi_support_ius(starget))
1461 return TARGET_ATTRIBUTE_HELPER(rti);
Tony Jonesee959b02008-02-22 00:13:36 +01001462 else if (attr == &dev_attr_pcomp_en.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001463 spi_support_ius(starget))
1464 return TARGET_ATTRIBUTE_HELPER(pcomp_en);
Tony Jonesee959b02008-02-22 00:13:36 +01001465 else if (attr == &dev_attr_hold_mcs.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001466 spi_support_ius(starget))
1467 return TARGET_ATTRIBUTE_HELPER(hold_mcs);
Tony Jonesee959b02008-02-22 00:13:36 +01001468 else if (attr == &dev_attr_revalidate.attr)
James Bottomley352f6bb2008-03-20 20:57:02 -05001469 return S_IWUSR;
James Bottomley9b161a42008-01-05 10:18:27 -06001470
1471 return 0;
1472}
1473
1474static struct attribute *target_attributes[] = {
Tony Jonesee959b02008-02-22 00:13:36 +01001475 &dev_attr_period.attr,
1476 &dev_attr_min_period.attr,
1477 &dev_attr_offset.attr,
1478 &dev_attr_max_offset.attr,
1479 &dev_attr_width.attr,
1480 &dev_attr_max_width.attr,
1481 &dev_attr_iu.attr,
James Bottomleyea443192009-06-13 12:19:05 -05001482 &dev_attr_max_iu.attr,
Tony Jonesee959b02008-02-22 00:13:36 +01001483 &dev_attr_dt.attr,
1484 &dev_attr_qas.attr,
James Bottomleyea443192009-06-13 12:19:05 -05001485 &dev_attr_max_qas.attr,
Tony Jonesee959b02008-02-22 00:13:36 +01001486 &dev_attr_wr_flow.attr,
1487 &dev_attr_rd_strm.attr,
1488 &dev_attr_rti.attr,
1489 &dev_attr_pcomp_en.attr,
1490 &dev_attr_hold_mcs.attr,
1491 &dev_attr_revalidate.attr,
James Bottomley9b161a42008-01-05 10:18:27 -06001492 NULL
1493};
1494
1495static struct attribute_group target_attribute_group = {
1496 .attrs = target_attributes,
1497 .is_visible = target_attribute_is_visible,
1498};
1499
1500static int spi_target_configure(struct transport_container *tc,
1501 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +01001502 struct device *cdev)
James Bottomley9b161a42008-01-05 10:18:27 -06001503{
1504 struct kobject *kobj = &cdev->kobj;
James Bottomley9b161a42008-01-05 10:18:27 -06001505
James Bottomley352f6bb2008-03-20 20:57:02 -05001506 /* force an update based on parameters read from the device */
1507 sysfs_update_group(kobj, &target_attribute_group);
James Bottomley9b161a42008-01-05 10:18:27 -06001508
1509 return 0;
1510}
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512struct scsi_transport_template *
1513spi_attach_transport(struct spi_function_template *ft)
1514{
Jes Sorensen24669f752006-01-16 10:31:18 -05001515 struct spi_internal *i = kzalloc(sizeof(struct spi_internal),
1516 GFP_KERNEL);
1517
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 if (unlikely(!i))
1519 return NULL;
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 i->t.target_attrs.ac.class = &spi_transport_class.class;
James Bottomley9b161a42008-01-05 10:18:27 -06001522 i->t.target_attrs.ac.grp = &target_attribute_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 i->t.target_attrs.ac.match = spi_target_match;
1524 transport_container_register(&i->t.target_attrs);
1525 i->t.target_size = sizeof(struct spi_transport_attrs);
1526 i->t.host_attrs.ac.class = &spi_host_class.class;
James Bottomley9b161a42008-01-05 10:18:27 -06001527 i->t.host_attrs.ac.grp = &host_attribute_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 i->t.host_attrs.ac.match = spi_host_match;
1529 transport_container_register(&i->t.host_attrs);
1530 i->t.host_size = sizeof(struct spi_host_attrs);
1531 i->f = ft;
1532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 return &i->t;
1534}
1535EXPORT_SYMBOL(spi_attach_transport);
1536
1537void spi_release_transport(struct scsi_transport_template *t)
1538{
1539 struct spi_internal *i = to_spi_internal(t);
1540
1541 transport_container_unregister(&i->t.target_attrs);
1542 transport_container_unregister(&i->t.host_attrs);
1543
1544 kfree(i);
1545}
1546EXPORT_SYMBOL(spi_release_transport);
1547
1548static __init int spi_transport_init(void)
1549{
James Bottomleya9e0edb2009-06-17 19:05:05 +00001550 int error = scsi_dev_info_add_list(SCSI_DEVINFO_SPI,
1551 "SCSI Parallel Transport Class");
1552 if (!error) {
1553 int i;
1554
1555 for (i = 0; spi_static_device_list[i].vendor; i++)
1556 scsi_dev_info_list_add_keyed(1, /* compatible */
1557 spi_static_device_list[i].vendor,
1558 spi_static_device_list[i].model,
1559 NULL,
1560 spi_static_device_list[i].flags,
1561 SCSI_DEVINFO_SPI);
1562 }
1563
1564 error = transport_class_register(&spi_transport_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 if (error)
1566 return error;
1567 error = anon_transport_class_register(&spi_device_class);
1568 return transport_class_register(&spi_host_class);
1569}
1570
1571static void __exit spi_transport_exit(void)
1572{
1573 transport_class_unregister(&spi_transport_class);
1574 anon_transport_class_unregister(&spi_device_class);
1575 transport_class_unregister(&spi_host_class);
James Bottomleya9e0edb2009-06-17 19:05:05 +00001576 scsi_dev_info_remove_list(SCSI_DEVINFO_SPI);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577}
1578
1579MODULE_AUTHOR("Martin Hicks");
1580MODULE_DESCRIPTION("SPI Transport Attributes");
1581MODULE_LICENSE("GPL");
1582
1583module_init(spi_transport_init);
1584module_exit(spi_transport_exit);