blob: 00cfb40b5efa43b100810e41fa098bed04518ce8 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/* Private data accessors (keep these out of the header file) */
James Bottomleydfdc58b2006-09-20 12:00:18 -040050#define spi_dv_in_progress(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_in_progress)
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
58#define to_spi_internal(tmpl) container_of(tmpl, struct spi_internal, t)
59
60static const int ppr_to_ps[] = {
61 /* The PPR values 0-6 are reserved, fill them in when
62 * the committee defines them */
63 -1, /* 0x00 */
64 -1, /* 0x01 */
65 -1, /* 0x02 */
66 -1, /* 0x03 */
67 -1, /* 0x04 */
68 -1, /* 0x05 */
69 -1, /* 0x06 */
70 3125, /* 0x07 */
71 6250, /* 0x08 */
72 12500, /* 0x09 */
73 25000, /* 0x0a */
74 30300, /* 0x0b */
75 50000, /* 0x0c */
76};
77/* The PPR values at which you calculate the period in ns by multiplying
78 * by 4 */
79#define SPI_STATIC_PPR 0x0c
80
81static int sprint_frac(char *dest, int value, int denom)
82{
83 int frac = value % denom;
84 int result = sprintf(dest, "%d", value / denom);
85
86 if (frac == 0)
87 return result;
88 dest[result++] = '.';
89
90 do {
91 denom /= 10;
92 sprintf(dest + result, "%d", frac / denom);
93 result++;
94 frac %= denom;
95 } while (frac);
96
97 dest[result++] = '\0';
98 return result;
99}
100
James Bottomley33aa6872005-08-28 11:31:14 -0500101static int spi_execute(struct scsi_device *sdev, const void *cmd,
102 enum dma_data_direction dir,
103 void *buffer, unsigned bufflen,
104 struct scsi_sense_hdr *sshdr)
James Bottomley949bf792005-05-01 18:58:15 -0500105{
James Bottomley33aa6872005-08-28 11:31:14 -0500106 int i, result;
107 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
James Bottomley949bf792005-05-01 18:58:15 -0500108
109 for(i = 0; i < DV_RETRIES; i++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500110 result = scsi_execute(sdev, cmd, dir, buffer, bufflen,
111 sense, DV_TIMEOUT, /* retries */ 1,
Mike Christie6000a362008-08-19 18:45:30 -0500112 REQ_FAILFAST_DEV |
113 REQ_FAILFAST_TRANSPORT |
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900114 REQ_FAILFAST_DRIVER,
115 NULL);
FUJITA Tomonori4d3fef92008-12-05 15:37:52 +0900116 if (driver_byte(result) & DRIVER_SENSE) {
James Bottomley33aa6872005-08-28 11:31:14 -0500117 struct scsi_sense_hdr sshdr_tmp;
118 if (!sshdr)
119 sshdr = &sshdr_tmp;
James Bottomley949bf792005-05-01 18:58:15 -0500120
James Bottomley4ed381e2006-12-11 09:47:06 -0600121 if (scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE,
James Bottomley33aa6872005-08-28 11:31:14 -0500122 sshdr)
123 && sshdr->sense_key == UNIT_ATTENTION)
James Bottomley949bf792005-05-01 18:58:15 -0500124 continue;
125 }
126 break;
127 }
James Bottomley33aa6872005-08-28 11:31:14 -0500128 return result;
James Bottomley949bf792005-05-01 18:58:15 -0500129}
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131static struct {
132 enum spi_signal_type value;
133 char *name;
134} signal_types[] = {
135 { SPI_SIGNAL_UNKNOWN, "unknown" },
136 { SPI_SIGNAL_SE, "SE" },
137 { SPI_SIGNAL_LVD, "LVD" },
138 { SPI_SIGNAL_HVD, "HVD" },
139};
140
141static inline const char *spi_signal_to_string(enum spi_signal_type type)
142{
143 int i;
144
Tobias Klauser6391a112006-06-08 22:23:48 -0700145 for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 if (type == signal_types[i].value)
147 return signal_types[i].name;
148 }
149 return NULL;
150}
151static inline enum spi_signal_type spi_signal_to_value(const char *name)
152{
153 int i, len;
154
Tobias Klauser6391a112006-06-08 22:23:48 -0700155 for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 len = strlen(signal_types[i].name);
157 if (strncmp(name, signal_types[i].name, len) == 0 &&
158 (name[len] == '\n' || name[len] == '\0'))
159 return signal_types[i].value;
160 }
161 return SPI_SIGNAL_UNKNOWN;
162}
163
James Bottomleyd0a7e572005-08-14 17:09:01 -0500164static int spi_host_setup(struct transport_container *tc, struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100165 struct device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
167 struct Scsi_Host *shost = dev_to_shost(dev);
168
169 spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;
170
171 return 0;
172}
173
James Bottomley9b161a42008-01-05 10:18:27 -0600174static int spi_host_configure(struct transport_container *tc,
175 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100176 struct device *cdev);
James Bottomley9b161a42008-01-05 10:18:27 -0600177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178static DECLARE_TRANSPORT_CLASS(spi_host_class,
179 "spi_host",
180 spi_host_setup,
181 NULL,
James Bottomley9b161a42008-01-05 10:18:27 -0600182 spi_host_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184static int spi_host_match(struct attribute_container *cont,
185 struct device *dev)
186{
187 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189 if (!scsi_is_host_device(dev))
190 return 0;
191
192 shost = dev_to_shost(dev);
193 if (!shost->transportt || shost->transportt->host_attrs.ac.class
194 != &spi_host_class.class)
195 return 0;
196
James Bottomley9b161a42008-01-05 10:18:27 -0600197 return &shost->transportt->host_attrs.ac == cont;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198}
199
James Bottomley9b161a42008-01-05 10:18:27 -0600200static int spi_target_configure(struct transport_container *tc,
201 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100202 struct device *cdev);
James Bottomley9b161a42008-01-05 10:18:27 -0600203
James Bottomleyd0a7e572005-08-14 17:09:01 -0500204static int spi_device_configure(struct transport_container *tc,
205 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100206 struct device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
208 struct scsi_device *sdev = to_scsi_device(dev);
209 struct scsi_target *starget = sdev->sdev_target;
210
211 /* Populate the target capability fields with the values
212 * gleaned from the device inquiry */
213
214 spi_support_sync(starget) = scsi_device_sync(sdev);
215 spi_support_wide(starget) = scsi_device_wide(sdev);
216 spi_support_dt(starget) = scsi_device_dt(sdev);
217 spi_support_dt_only(starget) = scsi_device_dt_only(sdev);
218 spi_support_ius(starget) = scsi_device_ius(sdev);
219 spi_support_qas(starget) = scsi_device_qas(sdev);
220
221 return 0;
222}
223
James Bottomleyd0a7e572005-08-14 17:09:01 -0500224static int spi_setup_transport_attrs(struct transport_container *tc,
225 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +0100226 struct device *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
228 struct scsi_target *starget = to_scsi_target(dev);
229
230 spi_period(starget) = -1; /* illegal value */
James Bottomley 62a86122005-05-06 18:05:20 -0500231 spi_min_period(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 spi_offset(starget) = 0; /* async */
James Bottomley 62a86122005-05-06 18:05:20 -0500233 spi_max_offset(starget) = 255;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 spi_width(starget) = 0; /* narrow */
James Bottomley 62a86122005-05-06 18:05:20 -0500235 spi_max_width(starget) = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 spi_iu(starget) = 0; /* no IU */
James Bottomleyea443192009-06-13 12:19:05 -0500237 spi_max_iu(starget) = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 spi_dt(starget) = 0; /* ST */
239 spi_qas(starget) = 0;
James Bottomleyea443192009-06-13 12:19:05 -0500240 spi_max_qas(starget) = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 spi_wr_flow(starget) = 0;
242 spi_rd_strm(starget) = 0;
243 spi_rti(starget) = 0;
244 spi_pcomp_en(starget) = 0;
James Bottomleyd872ebe2005-08-03 15:43:52 -0500245 spi_hold_mcs(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 spi_dv_pending(starget) = 0;
James Bottomleydfdc58b2006-09-20 12:00:18 -0400247 spi_dv_in_progress(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 spi_initial_dv(starget) = 0;
Jes Sorensend158d262006-01-13 16:05:44 -0800249 mutex_init(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251 return 0;
252}
253
James Bottomley 62a86122005-05-06 18:05:20 -0500254#define spi_transport_show_simple(field, format_string) \
255 \
256static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100257show_spi_transport_##field(struct device *dev, \
258 struct device_attribute *attr, char *buf) \
James Bottomley 62a86122005-05-06 18:05:20 -0500259{ \
Tony Jonesee959b02008-02-22 00:13:36 +0100260 struct scsi_target *starget = transport_class_to_starget(dev); \
James Bottomley 62a86122005-05-06 18:05:20 -0500261 struct spi_transport_attrs *tp; \
262 \
263 tp = (struct spi_transport_attrs *)&starget->starget_data; \
264 return snprintf(buf, 20, format_string, tp->field); \
265}
266
267#define spi_transport_store_simple(field, format_string) \
268 \
269static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100270store_spi_transport_##field(struct device *dev, \
271 struct device_attribute *attr, \
272 const char *buf, size_t count) \
James Bottomley 62a86122005-05-06 18:05:20 -0500273{ \
274 int val; \
Tony Jonesee959b02008-02-22 00:13:36 +0100275 struct scsi_target *starget = transport_class_to_starget(dev); \
James Bottomley 62a86122005-05-06 18:05:20 -0500276 struct spi_transport_attrs *tp; \
277 \
278 tp = (struct spi_transport_attrs *)&starget->starget_data; \
279 val = simple_strtoul(buf, NULL, 0); \
280 tp->field = val; \
281 return count; \
282}
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284#define spi_transport_show_function(field, format_string) \
285 \
286static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100287show_spi_transport_##field(struct device *dev, \
288 struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{ \
Tony Jonesee959b02008-02-22 00:13:36 +0100290 struct scsi_target *starget = transport_class_to_starget(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
292 struct spi_transport_attrs *tp; \
293 struct spi_internal *i = to_spi_internal(shost->transportt); \
294 tp = (struct spi_transport_attrs *)&starget->starget_data; \
295 if (i->f->get_##field) \
296 i->f->get_##field(starget); \
297 return snprintf(buf, 20, format_string, tp->field); \
298}
299
300#define spi_transport_store_function(field, format_string) \
301static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100302store_spi_transport_##field(struct device *dev, \
303 struct device_attribute *attr, \
304 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{ \
306 int val; \
Tony Jonesee959b02008-02-22 00:13:36 +0100307 struct scsi_target *starget = transport_class_to_starget(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
309 struct spi_internal *i = to_spi_internal(shost->transportt); \
310 \
James Bottomley9b161a42008-01-05 10:18:27 -0600311 if (!i->f->set_##field) \
312 return -EINVAL; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 val = simple_strtoul(buf, NULL, 0); \
James Bottomley9b161a42008-01-05 10:18:27 -0600314 i->f->set_##field(starget, val); \
James Bottomley 62a86122005-05-06 18:05:20 -0500315 return count; \
316}
317
318#define spi_transport_store_max(field, format_string) \
319static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100320store_spi_transport_##field(struct device *dev, \
321 struct device_attribute *attr, \
322 const char *buf, size_t count) \
James Bottomley 62a86122005-05-06 18:05:20 -0500323{ \
324 int val; \
Tony Jonesee959b02008-02-22 00:13:36 +0100325 struct scsi_target *starget = transport_class_to_starget(dev); \
James Bottomley 62a86122005-05-06 18:05:20 -0500326 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
327 struct spi_internal *i = to_spi_internal(shost->transportt); \
328 struct spi_transport_attrs *tp \
329 = (struct spi_transport_attrs *)&starget->starget_data; \
330 \
James Bottomley9b161a42008-01-05 10:18:27 -0600331 if (i->f->set_##field) \
332 return -EINVAL; \
James Bottomley 62a86122005-05-06 18:05:20 -0500333 val = simple_strtoul(buf, NULL, 0); \
334 if (val > tp->max_##field) \
335 val = tp->max_##field; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 i->f->set_##field(starget, val); \
337 return count; \
338}
339
340#define spi_transport_rd_attr(field, format_string) \
341 spi_transport_show_function(field, format_string) \
342 spi_transport_store_function(field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100343static DEVICE_ATTR(field, S_IRUGO, \
344 show_spi_transport_##field, \
345 store_spi_transport_##field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
James Bottomley 62a86122005-05-06 18:05:20 -0500347#define spi_transport_simple_attr(field, format_string) \
348 spi_transport_show_simple(field, format_string) \
349 spi_transport_store_simple(field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100350static DEVICE_ATTR(field, S_IRUGO, \
351 show_spi_transport_##field, \
352 store_spi_transport_##field);
James Bottomley 62a86122005-05-06 18:05:20 -0500353
354#define spi_transport_max_attr(field, format_string) \
355 spi_transport_show_function(field, format_string) \
356 spi_transport_store_max(field, format_string) \
357 spi_transport_simple_attr(max_##field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100358static DEVICE_ATTR(field, S_IRUGO, \
359 show_spi_transport_##field, \
360 store_spi_transport_##field);
James Bottomley 62a86122005-05-06 18:05:20 -0500361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362/* The Parallel SCSI Tranport Attributes: */
James Bottomley 62a86122005-05-06 18:05:20 -0500363spi_transport_max_attr(offset, "%d\n");
364spi_transport_max_attr(width, "%d\n");
James Bottomleyea443192009-06-13 12:19:05 -0500365spi_transport_max_attr(iu, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366spi_transport_rd_attr(dt, "%d\n");
James Bottomleyea443192009-06-13 12:19:05 -0500367spi_transport_max_attr(qas, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368spi_transport_rd_attr(wr_flow, "%d\n");
369spi_transport_rd_attr(rd_strm, "%d\n");
370spi_transport_rd_attr(rti, "%d\n");
371spi_transport_rd_attr(pcomp_en, "%d\n");
James Bottomleyd872ebe2005-08-03 15:43:52 -0500372spi_transport_rd_attr(hold_mcs, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
James Bottomleye8bac9e2008-07-29 12:52:20 -0500374/* we only care about the first child device that's a real SCSI device
375 * so we return 1 to terminate the iteration when we find it */
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800376static int child_iter(struct device *dev, void *data)
377{
James Bottomleye8bac9e2008-07-29 12:52:20 -0500378 if (!scsi_is_sdev_device(dev))
379 return 0;
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800380
James Bottomleye8bac9e2008-07-29 12:52:20 -0500381 spi_dv_device(to_scsi_device(dev));
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800382 return 1;
383}
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100386store_spi_revalidate(struct device *dev, struct device_attribute *attr,
387 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388{
Tony Jonesee959b02008-02-22 00:13:36 +0100389 struct scsi_target *starget = transport_class_to_starget(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
gregkh@suse.de9a881f12005-03-25 15:52:00 -0800391 device_for_each_child(&starget->dev, NULL, child_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 return count;
393}
Tony Jonesee959b02008-02-22 00:13:36 +0100394static DEVICE_ATTR(revalidate, S_IWUSR, NULL, store_spi_revalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
396/* Translate the period into ns according to the current spec
397 * for SDTR/PPR messages */
Matthew Wilcoxef725822005-12-15 16:22:01 -0500398static int period_to_str(char *buf, int period)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 int len, picosec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
James Bottomley 62a86122005-05-06 18:05:20 -0500402 if (period < 0 || period > 0xff) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 picosec = -1;
James Bottomley 62a86122005-05-06 18:05:20 -0500404 } else if (period <= SPI_STATIC_PPR) {
405 picosec = ppr_to_ps[period];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 } else {
James Bottomley 62a86122005-05-06 18:05:20 -0500407 picosec = period * 4000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 }
409
410 if (picosec == -1) {
411 len = sprintf(buf, "reserved");
412 } else {
413 len = sprint_frac(buf, picosec, 1000);
414 }
415
Matthew Wilcoxef725822005-12-15 16:22:01 -0500416 return len;
417}
418
419static ssize_t
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700420show_spi_transport_period_helper(char *buf, int period)
Matthew Wilcoxef725822005-12-15 16:22:01 -0500421{
422 int len = period_to_str(buf, period);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 buf[len++] = '\n';
424 buf[len] = '\0';
425 return len;
426}
427
428static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100429store_spi_transport_period_helper(struct device *dev, const char *buf,
James Bottomley 62a86122005-05-06 18:05:20 -0500430 size_t count, int *periodp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 int j, picosec, period = -1;
433 char *endp;
434
435 picosec = simple_strtoul(buf, &endp, 10) * 1000;
436 if (*endp == '.') {
437 int mult = 100;
438 do {
439 endp++;
440 if (!isdigit(*endp))
441 break;
442 picosec += (*endp - '0') * mult;
443 mult /= 10;
444 } while (mult > 0);
445 }
446
447 for (j = 0; j <= SPI_STATIC_PPR; j++) {
448 if (ppr_to_ps[j] < picosec)
449 continue;
450 period = j;
451 break;
452 }
453
454 if (period == -1)
455 period = picosec / 4000;
456
457 if (period > 0xff)
458 period = 0xff;
459
James Bottomley 62a86122005-05-06 18:05:20 -0500460 *periodp = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
462 return count;
463}
464
James Bottomley 62a86122005-05-06 18:05:20 -0500465static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100466show_spi_transport_period(struct device *dev,
467 struct device_attribute *attr, char *buf)
James Bottomley 62a86122005-05-06 18:05:20 -0500468{
Tony Jonesee959b02008-02-22 00:13:36 +0100469 struct scsi_target *starget = transport_class_to_starget(dev);
James Bottomley 62a86122005-05-06 18:05:20 -0500470 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
471 struct spi_internal *i = to_spi_internal(shost->transportt);
472 struct spi_transport_attrs *tp =
473 (struct spi_transport_attrs *)&starget->starget_data;
474
475 if (i->f->get_period)
476 i->f->get_period(starget);
477
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700478 return show_spi_transport_period_helper(buf, tp->period);
James Bottomley 62a86122005-05-06 18:05:20 -0500479}
480
481static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100482store_spi_transport_period(struct device *cdev, struct device_attribute *attr,
483 const char *buf, size_t count)
James Bottomley 62a86122005-05-06 18:05:20 -0500484{
485 struct scsi_target *starget = transport_class_to_starget(cdev);
486 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
487 struct spi_internal *i = to_spi_internal(shost->transportt);
488 struct spi_transport_attrs *tp =
489 (struct spi_transport_attrs *)&starget->starget_data;
490 int period, retval;
491
James Bottomley9b161a42008-01-05 10:18:27 -0600492 if (!i->f->set_period)
493 return -EINVAL;
494
James Bottomley 62a86122005-05-06 18:05:20 -0500495 retval = store_spi_transport_period_helper(cdev, buf, count, &period);
496
497 if (period < tp->min_period)
498 period = tp->min_period;
499
500 i->f->set_period(starget, period);
501
502 return retval;
503}
504
Tony Jonesee959b02008-02-22 00:13:36 +0100505static DEVICE_ATTR(period, S_IRUGO,
506 show_spi_transport_period,
507 store_spi_transport_period);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
James Bottomley 62a86122005-05-06 18:05:20 -0500509static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100510show_spi_transport_min_period(struct device *cdev,
511 struct device_attribute *attr, char *buf)
James Bottomley 62a86122005-05-06 18:05:20 -0500512{
513 struct scsi_target *starget = transport_class_to_starget(cdev);
James Bottomley9b161a42008-01-05 10:18:27 -0600514 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
515 struct spi_internal *i = to_spi_internal(shost->transportt);
James Bottomley 62a86122005-05-06 18:05:20 -0500516 struct spi_transport_attrs *tp =
517 (struct spi_transport_attrs *)&starget->starget_data;
518
James Bottomley9b161a42008-01-05 10:18:27 -0600519 if (!i->f->set_period)
520 return -EINVAL;
521
Matthew Wilcoxea697e42006-02-07 08:01:02 -0700522 return show_spi_transport_period_helper(buf, tp->min_period);
James Bottomley 62a86122005-05-06 18:05:20 -0500523}
524
525static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100526store_spi_transport_min_period(struct device *cdev,
527 struct device_attribute *attr,
528 const char *buf, size_t count)
James Bottomley 62a86122005-05-06 18:05:20 -0500529{
530 struct scsi_target *starget = transport_class_to_starget(cdev);
531 struct spi_transport_attrs *tp =
532 (struct spi_transport_attrs *)&starget->starget_data;
533
534 return store_spi_transport_period_helper(cdev, buf, count,
535 &tp->min_period);
536}
537
538
Tony Jonesee959b02008-02-22 00:13:36 +0100539static DEVICE_ATTR(min_period, S_IRUGO,
540 show_spi_transport_min_period,
541 store_spi_transport_min_period);
James Bottomley 62a86122005-05-06 18:05:20 -0500542
543
Tony Jonesee959b02008-02-22 00:13:36 +0100544static ssize_t show_spi_host_signalling(struct device *cdev,
545 struct device_attribute *attr,
546 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547{
548 struct Scsi_Host *shost = transport_class_to_shost(cdev);
549 struct spi_internal *i = to_spi_internal(shost->transportt);
550
551 if (i->f->get_signalling)
552 i->f->get_signalling(shost);
553
554 return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
555}
Tony Jonesee959b02008-02-22 00:13:36 +0100556static ssize_t store_spi_host_signalling(struct device *dev,
557 struct device_attribute *attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 const char *buf, size_t count)
559{
Tony Jonesee959b02008-02-22 00:13:36 +0100560 struct Scsi_Host *shost = transport_class_to_shost(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 struct spi_internal *i = to_spi_internal(shost->transportt);
562 enum spi_signal_type type = spi_signal_to_value(buf);
563
James Bottomley9b161a42008-01-05 10:18:27 -0600564 if (!i->f->set_signalling)
565 return -EINVAL;
566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 if (type != SPI_SIGNAL_UNKNOWN)
568 i->f->set_signalling(shost, type);
569
570 return count;
571}
Tony Jonesee959b02008-02-22 00:13:36 +0100572static DEVICE_ATTR(signalling, S_IRUGO,
573 show_spi_host_signalling,
574 store_spi_host_signalling);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576#define DV_SET(x, y) \
577 if(i->f->set_##x) \
578 i->f->set_##x(sdev->sdev_target, y)
579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580enum spi_compare_returns {
581 SPI_COMPARE_SUCCESS,
582 SPI_COMPARE_FAILURE,
583 SPI_COMPARE_SKIP_TEST,
584};
585
586
587/* This is for read/write Domain Validation: If the device supports
588 * an echo buffer, we do read/write tests to it */
589static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500590spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 u8 *ptr, const int retries)
592{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 int len = ptr - buffer;
James Bottomley33aa6872005-08-28 11:31:14 -0500594 int j, k, r, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 unsigned int pattern = 0x0000ffff;
James Bottomley33aa6872005-08-28 11:31:14 -0500596 struct scsi_sense_hdr sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
598 const char spi_write_buffer[] = {
599 WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
600 };
601 const char spi_read_buffer[] = {
602 READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
603 };
604
605 /* set up the pattern buffer. Doesn't matter if we spill
606 * slightly beyond since that's where the read buffer is */
607 for (j = 0; j < len; ) {
608
609 /* fill the buffer with counting (test a) */
610 for ( ; j < min(len, 32); j++)
611 buffer[j] = j;
612 k = j;
613 /* fill the buffer with alternating words of 0x0 and
614 * 0xffff (test b) */
615 for ( ; j < min(len, k + 32); j += 2) {
616 u16 *word = (u16 *)&buffer[j];
617
618 *word = (j & 0x02) ? 0x0000 : 0xffff;
619 }
620 k = j;
621 /* fill with crosstalk (alternating 0x5555 0xaaa)
622 * (test c) */
623 for ( ; j < min(len, k + 32); j += 2) {
624 u16 *word = (u16 *)&buffer[j];
625
626 *word = (j & 0x02) ? 0x5555 : 0xaaaa;
627 }
628 k = j;
629 /* fill with shifting bits (test d) */
630 for ( ; j < min(len, k + 32); j += 4) {
631 u32 *word = (unsigned int *)&buffer[j];
632 u32 roll = (pattern & 0x80000000) ? 1 : 0;
633
634 *word = pattern;
635 pattern = (pattern << 1) | roll;
636 }
637 /* don't bother with random data (test e) */
638 }
639
640 for (r = 0; r < retries; r++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500641 result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
642 buffer, len, &sshdr);
643 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
645 scsi_device_set_state(sdev, SDEV_QUIESCE);
James Bottomley33aa6872005-08-28 11:31:14 -0500646 if (scsi_sense_valid(&sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 && sshdr.sense_key == ILLEGAL_REQUEST
648 /* INVALID FIELD IN CDB */
649 && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
650 /* This would mean that the drive lied
651 * to us about supporting an echo
652 * buffer (unfortunately some Western
653 * Digital drives do precisely this)
654 */
655 return SPI_COMPARE_SKIP_TEST;
656
657
James Bottomley9ccfc752005-10-02 11:45:08 -0500658 sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 return SPI_COMPARE_FAILURE;
660 }
661
662 memset(ptr, 0, len);
James Bottomley33aa6872005-08-28 11:31:14 -0500663 spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
664 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 scsi_device_set_state(sdev, SDEV_QUIESCE);
666
667 if (memcmp(buffer, ptr, len) != 0)
668 return SPI_COMPARE_FAILURE;
669 }
670 return SPI_COMPARE_SUCCESS;
671}
672
673/* This is for the simplest form of Domain Validation: a read test
674 * on the inquiry data from the device */
675static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500676spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 u8 *ptr, const int retries)
678{
James Bottomley33aa6872005-08-28 11:31:14 -0500679 int r, result;
680 const int len = sdev->inquiry_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 const char spi_inquiry[] = {
682 INQUIRY, 0, 0, 0, len, 0
683 };
684
685 for (r = 0; r < retries; r++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 memset(ptr, 0, len);
687
James Bottomley33aa6872005-08-28 11:31:14 -0500688 result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
689 ptr, len, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
James Bottomley33aa6872005-08-28 11:31:14 -0500691 if(result || !scsi_device_online(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 scsi_device_set_state(sdev, SDEV_QUIESCE);
693 return SPI_COMPARE_FAILURE;
694 }
695
696 /* If we don't have the inquiry data already, the
697 * first read gets it */
698 if (ptr == buffer) {
699 ptr += len;
700 --r;
701 continue;
702 }
703
704 if (memcmp(buffer, ptr, len) != 0)
705 /* failure */
706 return SPI_COMPARE_FAILURE;
707 }
708 return SPI_COMPARE_SUCCESS;
709}
710
711static enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500712spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 enum spi_compare_returns
James Bottomley33aa6872005-08-28 11:31:14 -0500714 (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
James Bottomley33aa6872005-08-28 11:31:14 -0500716 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500717 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 int period = 0, prevperiod = 0;
719 enum spi_compare_returns retval;
720
721
722 for (;;) {
723 int newperiod;
James Bottomley33aa6872005-08-28 11:31:14 -0500724 retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
726 if (retval == SPI_COMPARE_SUCCESS
727 || retval == SPI_COMPARE_SKIP_TEST)
728 break;
729
730 /* OK, retrain, fallback */
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500731 if (i->f->get_iu)
732 i->f->get_iu(starget);
733 if (i->f->get_qas)
734 i->f->get_qas(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 if (i->f->get_period)
736 i->f->get_period(sdev->sdev_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500738 /* Here's the fallback sequence; first try turning off
739 * IU, then QAS (if we can control them), then finally
740 * fall down the periods */
741 if (i->f->set_iu && spi_iu(starget)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500742 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Information Units\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500743 DV_SET(iu, 0);
744 } else if (i->f->set_qas && spi_qas(starget)) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500745 starget_printk(KERN_ERR, starget, "Domain Validation Disabing Quick Arbitration and Selection\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500746 DV_SET(qas, 0);
747 } else {
748 newperiod = spi_period(starget);
749 period = newperiod > period ? newperiod : period;
750 if (period < 0x0d)
751 period++;
752 else
753 period += period >> 1;
754
755 if (unlikely(period > 0xff || period == prevperiod)) {
756 /* Total failure; set to async and return */
James Bottomley9ccfc752005-10-02 11:45:08 -0500757 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500758 DV_SET(offset, 0);
759 return SPI_COMPARE_FAILURE;
760 }
James Bottomley9ccfc752005-10-02 11:45:08 -0500761 starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500762 DV_SET(period, period);
763 prevperiod = period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 }
766 return retval;
767}
768
769static int
James Bottomley33aa6872005-08-28 11:31:14 -0500770spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
James Bottomley33aa6872005-08-28 11:31:14 -0500772 int l, result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
774 /* first off do a test unit ready. This can error out
775 * because of reservations or some other reason. If it
776 * fails, the device won't let us write to the echo buffer
777 * so just return failure */
778
779 const char spi_test_unit_ready[] = {
780 TEST_UNIT_READY, 0, 0, 0, 0, 0
781 };
782
783 const char spi_read_buffer_descriptor[] = {
784 READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
785 };
786
787
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 /* We send a set of three TURs to clear any outstanding
789 * unit attention conditions if they exist (Otherwise the
790 * buffer tests won't be happy). If the TUR still fails
791 * (reservation conflict, device not ready, etc) just
792 * skip the write tests */
793 for (l = 0; ; l++) {
James Bottomley33aa6872005-08-28 11:31:14 -0500794 result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE,
795 NULL, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
James Bottomley33aa6872005-08-28 11:31:14 -0500797 if(result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 if(l >= 3)
799 return 0;
800 } else {
801 /* TUR succeeded */
802 break;
803 }
804 }
805
James Bottomley33aa6872005-08-28 11:31:14 -0500806 result = spi_execute(sdev, spi_read_buffer_descriptor,
807 DMA_FROM_DEVICE, buffer, 4, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
James Bottomley33aa6872005-08-28 11:31:14 -0500809 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 /* Device has no echo buffer */
811 return 0;
812
813 return buffer[3] + ((buffer[2] & 0x1f) << 8);
814}
815
816static void
James Bottomley33aa6872005-08-28 11:31:14 -0500817spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818{
James Bottomley33aa6872005-08-28 11:31:14 -0500819 struct spi_internal *i = to_spi_internal(sdev->host->transportt);
James Bottomley 62a86122005-05-06 18:05:20 -0500820 struct scsi_target *starget = sdev->sdev_target;
James Bottomley60eef252006-06-10 10:51:23 -0500821 struct Scsi_Host *shost = sdev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 int len = sdev->inquiry_len;
James Bottomley23028272007-09-22 08:40:09 -0500823 int min_period = spi_min_period(starget);
824 int max_width = spi_max_width(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 /* first set us up for narrow async */
826 DV_SET(offset, 0);
827 DV_SET(width, 0);
James Bottomley23028272007-09-22 08:40:09 -0500828
James Bottomley33aa6872005-08-28 11:31:14 -0500829 if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500831 starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 /* FIXME: should probably offline the device here? */
833 return;
834 }
835
James Bottomley9872b812009-06-17 15:03:41 -0400836 if (!spi_support_wide(starget)) {
James Bottomley23028272007-09-22 08:40:09 -0500837 spi_max_width(starget) = 0;
838 max_width = 0;
839 }
840
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 /* test width */
James Bottomley23028272007-09-22 08:40:09 -0500842 if (i->f->set_width && max_width) {
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500843 i->f->set_width(starget, 1);
James Bottomley 62a86122005-05-06 18:05:20 -0500844
James Bottomley33aa6872005-08-28 11:31:14 -0500845 if (spi_dv_device_compare_inquiry(sdev, buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 buffer + len,
847 DV_LOOPS)
848 != SPI_COMPARE_SUCCESS) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500849 starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500850 i->f->set_width(starget, 0);
James Bottomley23028272007-09-22 08:40:09 -0500851 /* Make sure we don't force wide back on by asking
852 * for a transfer period that requires it */
853 max_width = 0;
854 if (min_period < 10)
855 min_period = 10;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 }
857 }
858
859 if (!i->f->set_period)
860 return;
861
862 /* device can't handle synchronous */
James Bottomley9872b812009-06-17 15:03:41 -0400863 if (!spi_support_sync(starget) && !spi_support_dt(starget))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 return;
865
James Bottomley349cd7c2005-11-28 15:41:58 -0600866 /* len == -1 is the signal that we need to ascertain the
867 * presence of an echo buffer before trying to use it. len ==
868 * 0 means we don't have an echo buffer */
869 len = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
871 retry:
872
873 /* now set up to the maximum */
James Bottomley 62a86122005-05-06 18:05:20 -0500874 DV_SET(offset, spi_max_offset(starget));
James Bottomley23028272007-09-22 08:40:09 -0500875 DV_SET(period, min_period);
876
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500877 /* try QAS requests; this should be harmless to set if the
878 * target supports it */
James Bottomley9872b812009-06-17 15:03:41 -0400879 if (spi_support_qas(starget) && spi_max_qas(starget)) {
James Bottomleyeb1dd682005-07-02 12:22:01 -0400880 DV_SET(qas, 1);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400881 } else {
882 DV_SET(qas, 0);
883 }
884
James Bottomley9872b812009-06-17 15:03:41 -0400885 if (spi_support_ius(starget) && spi_max_iu(starget) &&
886 min_period < 9) {
James Bottomleydfdc58b2006-09-20 12:00:18 -0400887 /* This u320 (or u640). Set IU transfers */
James Bottomleyeb1dd682005-07-02 12:22:01 -0400888 DV_SET(iu, 1);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400889 /* Then set the optional parameters */
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500890 DV_SET(rd_strm, 1);
891 DV_SET(wr_flow, 1);
892 DV_SET(rti, 1);
James Bottomley23028272007-09-22 08:40:09 -0500893 if (min_period == 8)
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500894 DV_SET(pcomp_en, 1);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400895 } else {
896 DV_SET(iu, 0);
James Bottomley9a8bc9b2005-05-31 18:35:39 -0500897 }
James Bottomleydfdc58b2006-09-20 12:00:18 -0400898
James Bottomley60eef252006-06-10 10:51:23 -0500899 /* now that we've done all this, actually check the bus
900 * signal type (if known). Some devices are stupid on
901 * a SE bus and still claim they can try LVD only settings */
902 if (i->f->get_signalling)
903 i->f->get_signalling(shost);
904 if (spi_signalling(shost) == SPI_SIGNAL_SE ||
James Bottomleydfdc58b2006-09-20 12:00:18 -0400905 spi_signalling(shost) == SPI_SIGNAL_HVD ||
James Bottomley9872b812009-06-17 15:03:41 -0400906 !spi_support_dt(starget)) {
James Bottomley60eef252006-06-10 10:51:23 -0500907 DV_SET(dt, 0);
James Bottomleydfdc58b2006-09-20 12:00:18 -0400908 } else {
909 DV_SET(dt, 1);
910 }
James Bottomley23028272007-09-22 08:40:09 -0500911 /* set width last because it will pull all the other
912 * parameters down to required values */
913 DV_SET(width, max_width);
914
James Bottomley349cd7c2005-11-28 15:41:58 -0600915 /* Do the read only INQUIRY tests */
916 spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
917 spi_dv_device_compare_inquiry);
918 /* See if we actually managed to negotiate and sustain DT */
919 if (i->f->get_dt)
920 i->f->get_dt(starget);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
James Bottomley349cd7c2005-11-28 15:41:58 -0600922 /* see if the device has an echo buffer. If it does we can do
923 * the SPI pattern write tests. Because of some broken
924 * devices, we *only* try this on a device that has actually
925 * negotiated DT */
926
927 if (len == -1 && spi_dt(starget))
928 len = spi_dv_device_get_echo_buffer(sdev, buffer);
929
930 if (len <= 0) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500931 starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 return;
933 }
934
935 if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
James Bottomley9ccfc752005-10-02 11:45:08 -0500936 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 -0700937 len = SPI_MAX_ECHO_BUFFER_SIZE;
938 }
939
James Bottomley33aa6872005-08-28 11:31:14 -0500940 if (spi_dv_retrain(sdev, buffer, buffer + len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 spi_dv_device_echo_buffer)
942 == SPI_COMPARE_SKIP_TEST) {
943 /* OK, the stupid drive can't do a write echo buffer
944 * test after all, fall back to the read tests */
945 len = 0;
946 goto retry;
947 }
948}
949
950
951/** spi_dv_device - Do Domain Validation on the device
952 * @sdev: scsi device to validate
953 *
954 * Performs the domain validation on the given device in the
955 * current execution thread. Since DV operations may sleep,
956 * the current thread must have user context. Also no SCSI
957 * related locks that would deadlock I/O issued by the DV may
958 * be held.
959 */
960void
961spi_dv_device(struct scsi_device *sdev)
962{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 struct scsi_target *starget = sdev->sdev_target;
964 u8 *buffer;
965 const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 if (unlikely(scsi_device_get(sdev)))
James Bottomley33aa6872005-08-28 11:31:14 -0500968 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
James Bottomleydfdc58b2006-09-20 12:00:18 -0400970 if (unlikely(spi_dv_in_progress(starget)))
971 return;
972 spi_dv_in_progress(starget) = 1;
973
Jes Sorensen24669f752006-01-16 10:31:18 -0500974 buffer = kzalloc(len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
976 if (unlikely(!buffer))
977 goto out_put;
978
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 /* We need to verify that the actual device will quiesce; the
980 * later target quiesce is just a nice to have */
981 if (unlikely(scsi_device_quiesce(sdev)))
982 goto out_free;
983
984 scsi_target_quiesce(starget);
985
986 spi_dv_pending(starget) = 1;
Jes Sorensend158d262006-01-13 16:05:44 -0800987 mutex_lock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
James Bottomley9ccfc752005-10-02 11:45:08 -0500989 starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
James Bottomley33aa6872005-08-28 11:31:14 -0500991 spi_dv_device_internal(sdev, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
James Bottomley9ccfc752005-10-02 11:45:08 -0500993 starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
Jes Sorensend158d262006-01-13 16:05:44 -0800995 mutex_unlock(&spi_dv_mutex(starget));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 spi_dv_pending(starget) = 0;
997
998 scsi_target_resume(starget);
999
1000 spi_initial_dv(starget) = 1;
1001
1002 out_free:
1003 kfree(buffer);
1004 out_put:
James Bottomleydfdc58b2006-09-20 12:00:18 -04001005 spi_dv_in_progress(starget) = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007}
1008EXPORT_SYMBOL(spi_dv_device);
1009
1010struct work_queue_wrapper {
1011 struct work_struct work;
1012 struct scsi_device *sdev;
1013};
1014
1015static void
David Howellsc4028952006-11-22 14:57:56 +00001016spi_dv_device_work_wrapper(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017{
David Howellsc4028952006-11-22 14:57:56 +00001018 struct work_queue_wrapper *wqw =
1019 container_of(work, struct work_queue_wrapper, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 struct scsi_device *sdev = wqw->sdev;
1021
1022 kfree(wqw);
1023 spi_dv_device(sdev);
1024 spi_dv_pending(sdev->sdev_target) = 0;
1025 scsi_device_put(sdev);
1026}
1027
1028
1029/**
1030 * spi_schedule_dv_device - schedule domain validation to occur on the device
1031 * @sdev: The device to validate
1032 *
1033 * Identical to spi_dv_device() above, except that the DV will be
1034 * scheduled to occur in a workqueue later. All memory allocations
1035 * are atomic, so may be called from any context including those holding
1036 * SCSI locks.
1037 */
1038void
1039spi_schedule_dv_device(struct scsi_device *sdev)
1040{
1041 struct work_queue_wrapper *wqw =
1042 kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
1043
1044 if (unlikely(!wqw))
1045 return;
1046
1047 if (unlikely(spi_dv_pending(sdev->sdev_target))) {
1048 kfree(wqw);
1049 return;
1050 }
1051 /* Set pending early (dv_device doesn't check it, only sets it) */
1052 spi_dv_pending(sdev->sdev_target) = 1;
1053 if (unlikely(scsi_device_get(sdev))) {
1054 kfree(wqw);
1055 spi_dv_pending(sdev->sdev_target) = 0;
1056 return;
1057 }
1058
David Howellsc4028952006-11-22 14:57:56 +00001059 INIT_WORK(&wqw->work, spi_dv_device_work_wrapper);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 wqw->sdev = sdev;
1061
1062 schedule_work(&wqw->work);
1063}
1064EXPORT_SYMBOL(spi_schedule_dv_device);
1065
1066/**
1067 * spi_display_xfer_agreement - Print the current target transfer agreement
1068 * @starget: The target for which to display the agreement
1069 *
1070 * Each SPI port is required to maintain a transfer agreement for each
1071 * other port on the bus. This function prints a one-line summary of
1072 * the current agreement; more detailed information is available in sysfs.
1073 */
1074void spi_display_xfer_agreement(struct scsi_target *starget)
1075{
1076 struct spi_transport_attrs *tp;
1077 tp = (struct spi_transport_attrs *)&starget->starget_data;
1078
1079 if (tp->offset > 0 && tp->period > 0) {
1080 unsigned int picosec, kb100;
1081 char *scsi = "FAST-?";
1082 char tmp[8];
1083
1084 if (tp->period <= SPI_STATIC_PPR) {
1085 picosec = ppr_to_ps[tp->period];
1086 switch (tp->period) {
1087 case 7: scsi = "FAST-320"; break;
1088 case 8: scsi = "FAST-160"; break;
1089 case 9: scsi = "FAST-80"; break;
1090 case 10:
1091 case 11: scsi = "FAST-40"; break;
1092 case 12: scsi = "FAST-20"; break;
1093 }
1094 } else {
1095 picosec = tp->period * 4000;
1096 if (tp->period < 25)
1097 scsi = "FAST-20";
1098 else if (tp->period < 50)
1099 scsi = "FAST-10";
1100 else
1101 scsi = "FAST-5";
1102 }
1103
1104 kb100 = (10000000 + picosec / 2) / picosec;
1105 if (tp->width)
1106 kb100 *= 2;
1107 sprint_frac(tmp, picosec, 1000);
1108
1109 dev_info(&starget->dev,
James Bottomleyd872ebe2005-08-03 15:43:52 -05001110 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1111 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1112 tp->dt ? "DT" : "ST",
1113 tp->iu ? " IU" : "",
1114 tp->qas ? " QAS" : "",
1115 tp->rd_strm ? " RDSTRM" : "",
1116 tp->rti ? " RTI" : "",
1117 tp->wr_flow ? " WRFLOW" : "",
1118 tp->pcomp_en ? " PCOMP" : "",
1119 tp->hold_mcs ? " HMCS" : "",
1120 tmp, tp->offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 } else {
Matthew Wilcox493ff4e2005-11-17 11:13:43 -07001122 dev_info(&starget->dev, "%sasynchronous\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 tp->width ? "wide " : "");
1124 }
1125}
1126EXPORT_SYMBOL(spi_display_xfer_agreement);
1127
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001128int spi_populate_width_msg(unsigned char *msg, int width)
1129{
1130 msg[0] = EXTENDED_MESSAGE;
1131 msg[1] = 2;
1132 msg[2] = EXTENDED_WDTR;
1133 msg[3] = width;
1134 return 4;
1135}
James Bottomley38e14f82006-02-17 14:58:47 -08001136EXPORT_SYMBOL_GPL(spi_populate_width_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001137
1138int spi_populate_sync_msg(unsigned char *msg, int period, int offset)
1139{
1140 msg[0] = EXTENDED_MESSAGE;
1141 msg[1] = 3;
1142 msg[2] = EXTENDED_SDTR;
1143 msg[3] = period;
1144 msg[4] = offset;
1145 return 5;
1146}
James Bottomley38e14f82006-02-17 14:58:47 -08001147EXPORT_SYMBOL_GPL(spi_populate_sync_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001148
1149int spi_populate_ppr_msg(unsigned char *msg, int period, int offset,
1150 int width, int options)
1151{
1152 msg[0] = EXTENDED_MESSAGE;
1153 msg[1] = 6;
1154 msg[2] = EXTENDED_PPR;
1155 msg[3] = period;
1156 msg[4] = 0;
1157 msg[5] = offset;
1158 msg[6] = width;
1159 msg[7] = options;
1160 return 8;
1161}
James Bottomley38e14f82006-02-17 14:58:47 -08001162EXPORT_SYMBOL_GPL(spi_populate_ppr_msg);
Matthew Wilcox6ea3c0b2006-02-07 07:54:46 -07001163
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001164#ifdef CONFIG_SCSI_CONSTANTS
1165static const char * const one_byte_msgs[] = {
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001166/* 0x00 */ "Task Complete", NULL /* Extended Message */, "Save Pointers",
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001167/* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001168/* 0x06 */ "Abort Task Set", "Message Reject", "Nop", "Message Parity Error",
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001169/* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001170/* 0x0c */ "Target Reset", "Abort Task", "Clear Task Set",
1171/* 0x0f */ "Initiate Recovery", "Release Recovery",
1172/* 0x11 */ "Terminate Process", "Continue Task", "Target Transfer Disable",
1173/* 0x14 */ NULL, NULL, "Clear ACA", "LUN Reset"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001174};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001175
1176static const char * const two_byte_msgs[] = {
Matthew Wilcox47972152005-12-15 16:22:01 -05001177/* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001178/* 0x23 */ "Ignore Wide Residue", "ACA"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001179};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001180
1181static const char * const extended_msgs[] = {
1182/* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
Matthew Wilcoxef725822005-12-15 16:22:01 -05001183/* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001184/* 0x04 */ "Parallel Protocol Request", "Modify Bidirectional Data Pointer"
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001185};
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001186
Adrian Bunkbdd70f22006-01-05 23:39:18 +01001187static void print_nego(const unsigned char *msg, int per, int off, int width)
Matthew Wilcoxef725822005-12-15 16:22:01 -05001188{
1189 if (per) {
1190 char buf[20];
1191 period_to_str(buf, msg[per]);
1192 printk("period = %s ns ", buf);
1193 }
1194
1195 if (off)
1196 printk("offset = %d ", msg[off]);
1197 if (width)
1198 printk("width = %d ", 8 << msg[width]);
1199}
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001200
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001201static void print_ptr(const unsigned char *msg, int msb, const char *desc)
1202{
1203 int ptr = (msg[msb] << 24) | (msg[msb+1] << 16) | (msg[msb+2] << 8) |
1204 msg[msb+3];
1205 printk("%s = %d ", desc, ptr);
1206}
1207
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001208int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001209{
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001210 int len = 1, i;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001211 if (msg[0] == EXTENDED_MESSAGE) {
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001212 len = 2 + msg[1];
1213 if (len == 2)
1214 len += 256;
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001215 if (msg[2] < ARRAY_SIZE(extended_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001216 printk ("%s ", extended_msgs[msg[2]]);
1217 else
1218 printk ("Extended Message, reserved code (0x%02x) ",
1219 (int) msg[2]);
1220 switch (msg[2]) {
1221 case EXTENDED_MODIFY_DATA_POINTER:
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001222 print_ptr(msg, 3, "pointer");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001223 break;
1224 case EXTENDED_SDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001225 print_nego(msg, 3, 4, 0);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001226 break;
1227 case EXTENDED_WDTR:
Matthew Wilcoxef725822005-12-15 16:22:01 -05001228 print_nego(msg, 0, 0, 3);
1229 break;
1230 case EXTENDED_PPR:
1231 print_nego(msg, 3, 5, 6);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001232 break;
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001233 case EXTENDED_MODIFY_BIDI_DATA_PTR:
1234 print_ptr(msg, 3, "out");
1235 print_ptr(msg, 7, "in");
1236 break;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001237 default:
1238 for (i = 2; i < len; ++i)
1239 printk("%02x ", msg[i]);
1240 }
1241 /* Identify */
1242 } else if (msg[0] & 0x80) {
1243 printk("Identify disconnect %sallowed %s %d ",
1244 (msg[0] & 0x40) ? "" : "not ",
1245 (msg[0] & 0x20) ? "target routine" : "lun",
1246 msg[0] & 0x7);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001247 /* Normal One byte */
1248 } else if (msg[0] < 0x1f) {
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001249 if (msg[0] < ARRAY_SIZE(one_byte_msgs) && one_byte_msgs[msg[0]])
Matthew Wilcoxe24d8732006-02-07 08:05:26 -07001250 printk("%s ", one_byte_msgs[msg[0]]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001251 else
1252 printk("reserved (%02x) ", msg[0]);
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001253 } else if (msg[0] == 0x55) {
1254 printk("QAS Request ");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001255 /* Two byte */
1256 } else if (msg[0] <= 0x2f) {
Matthew Wilcoxb32aaff2005-12-15 16:22:01 -05001257 if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001258 printk("%s %02x ", two_byte_msgs[msg[0] - 0x20],
1259 msg[1]);
1260 else
1261 printk("reserved two byte (%02x %02x) ",
1262 msg[0], msg[1]);
1263 len = 2;
1264 } else
Matthew Wilcoxe24d8732006-02-07 08:05:26 -07001265 printk("reserved ");
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001266 return len;
1267}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001268EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001269
1270#else /* ifndef CONFIG_SCSI_CONSTANTS */
1271
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001272int spi_print_msg(const unsigned char *msg)
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001273{
Matthew Wilcox72df0eb2006-03-10 07:18:22 -07001274 int len = 1, i;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001275
1276 if (msg[0] == EXTENDED_MESSAGE) {
Matthew Wilcoxfc253072006-02-18 20:52:31 -07001277 len = 2 + msg[1];
1278 if (len == 2)
1279 len += 256;
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001280 for (i = 0; i < len; ++i)
1281 printk("%02x ", msg[i]);
1282 /* Identify */
1283 } else if (msg[0] & 0x80) {
1284 printk("%02x ", msg[0]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001285 /* Normal One byte */
James Bottomley597705a2006-03-12 09:54:19 -06001286 } else if ((msg[0] < 0x1f) || (msg[0] == 0x55)) {
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001287 printk("%02x ", msg[0]);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001288 /* Two byte */
1289 } else if (msg[0] <= 0x2f) {
1290 printk("%02x %02x", msg[0], msg[1]);
1291 len = 2;
1292 } else
1293 printk("%02x ", msg[0]);
1294 return len;
1295}
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001296EXPORT_SYMBOL(spi_print_msg);
Matthew Wilcox410ca5c2005-12-15 16:22:01 -05001297#endif /* ! CONFIG_SCSI_CONSTANTS */
1298
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299static int spi_device_match(struct attribute_container *cont,
1300 struct device *dev)
1301{
1302 struct scsi_device *sdev;
1303 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001304 struct spi_internal *i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305
1306 if (!scsi_is_sdev_device(dev))
1307 return 0;
1308
1309 sdev = to_scsi_device(dev);
1310 shost = sdev->host;
1311 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1312 != &spi_host_class.class)
1313 return 0;
1314 /* Note: this class has no device attributes, so it has
1315 * no per-HBA allocation and thus we don't need to distinguish
1316 * the attribute containers for the device */
James Bottomley10c1b882005-08-14 14:34:06 -05001317 i = to_spi_internal(shost->transportt);
1318 if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1319 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 return 1;
1321}
1322
1323static int spi_target_match(struct attribute_container *cont,
1324 struct device *dev)
1325{
1326 struct Scsi_Host *shost;
James Bottomley10c1b882005-08-14 14:34:06 -05001327 struct scsi_target *starget;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 struct spi_internal *i;
1329
1330 if (!scsi_is_target_device(dev))
1331 return 0;
1332
1333 shost = dev_to_shost(dev->parent);
1334 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1335 != &spi_host_class.class)
1336 return 0;
1337
1338 i = to_spi_internal(shost->transportt);
James Bottomley10c1b882005-08-14 14:34:06 -05001339 starget = to_scsi_target(dev);
1340
1341 if (i->f->deny_binding && i->f->deny_binding(starget))
1342 return 0;
1343
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 return &i->t.target_attrs.ac == cont;
1345}
1346
1347static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1348 "spi_transport",
1349 spi_setup_transport_attrs,
1350 NULL,
James Bottomley9b161a42008-01-05 10:18:27 -06001351 spi_target_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352
1353static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1354 spi_device_match,
1355 spi_device_configure);
1356
James Bottomley9b161a42008-01-05 10:18:27 -06001357static struct attribute *host_attributes[] = {
Tony Jonesee959b02008-02-22 00:13:36 +01001358 &dev_attr_signalling.attr,
James Bottomley9b161a42008-01-05 10:18:27 -06001359 NULL
1360};
1361
1362static struct attribute_group host_attribute_group = {
1363 .attrs = host_attributes,
1364};
1365
1366static int spi_host_configure(struct transport_container *tc,
1367 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +01001368 struct device *cdev)
James Bottomley9b161a42008-01-05 10:18:27 -06001369{
1370 struct kobject *kobj = &cdev->kobj;
1371 struct Scsi_Host *shost = transport_class_to_shost(cdev);
1372 struct spi_internal *si = to_spi_internal(shost->transportt);
Tony Jonesee959b02008-02-22 00:13:36 +01001373 struct attribute *attr = &dev_attr_signalling.attr;
James Bottomley9b161a42008-01-05 10:18:27 -06001374 int rc = 0;
1375
1376 if (si->f->set_signalling)
1377 rc = sysfs_chmod_file(kobj, attr, attr->mode | S_IWUSR);
1378
1379 return rc;
1380}
1381
1382/* returns true if we should be showing the variable. Also
1383 * overloads the return by setting 1<<1 if the attribute should
1384 * be writeable */
1385#define TARGET_ATTRIBUTE_HELPER(name) \
James Bottomley352f6bb2008-03-20 20:57:02 -05001386 (si->f->show_##name ? S_IRUGO : 0) | \
1387 (si->f->set_##name ? S_IWUSR : 0)
James Bottomley9b161a42008-01-05 10:18:27 -06001388
James Bottomley352f6bb2008-03-20 20:57:02 -05001389static mode_t target_attribute_is_visible(struct kobject *kobj,
1390 struct attribute *attr, int i)
James Bottomley9b161a42008-01-05 10:18:27 -06001391{
Tony Jonesee959b02008-02-22 00:13:36 +01001392 struct device *cdev = container_of(kobj, struct device, kobj);
James Bottomley9b161a42008-01-05 10:18:27 -06001393 struct scsi_target *starget = transport_class_to_starget(cdev);
1394 struct Scsi_Host *shost = transport_class_to_shost(cdev);
1395 struct spi_internal *si = to_spi_internal(shost->transportt);
1396
Tony Jonesee959b02008-02-22 00:13:36 +01001397 if (attr == &dev_attr_period.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001398 spi_support_sync(starget))
1399 return TARGET_ATTRIBUTE_HELPER(period);
Tony Jonesee959b02008-02-22 00:13:36 +01001400 else if (attr == &dev_attr_min_period.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001401 spi_support_sync(starget))
1402 return TARGET_ATTRIBUTE_HELPER(period);
Tony Jonesee959b02008-02-22 00:13:36 +01001403 else if (attr == &dev_attr_offset.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001404 spi_support_sync(starget))
1405 return TARGET_ATTRIBUTE_HELPER(offset);
Tony Jonesee959b02008-02-22 00:13:36 +01001406 else if (attr == &dev_attr_max_offset.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001407 spi_support_sync(starget))
1408 return TARGET_ATTRIBUTE_HELPER(offset);
Tony Jonesee959b02008-02-22 00:13:36 +01001409 else if (attr == &dev_attr_width.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001410 spi_support_wide(starget))
1411 return TARGET_ATTRIBUTE_HELPER(width);
Tony Jonesee959b02008-02-22 00:13:36 +01001412 else if (attr == &dev_attr_max_width.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001413 spi_support_wide(starget))
1414 return TARGET_ATTRIBUTE_HELPER(width);
Tony Jonesee959b02008-02-22 00:13:36 +01001415 else if (attr == &dev_attr_iu.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001416 spi_support_ius(starget))
1417 return TARGET_ATTRIBUTE_HELPER(iu);
James Bottomleyea443192009-06-13 12:19:05 -05001418 else if (attr == &dev_attr_max_iu.attr &&
1419 spi_support_ius(starget))
1420 return TARGET_ATTRIBUTE_HELPER(iu);
Tony Jonesee959b02008-02-22 00:13:36 +01001421 else if (attr == &dev_attr_dt.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001422 spi_support_dt(starget))
1423 return TARGET_ATTRIBUTE_HELPER(dt);
Tony Jonesee959b02008-02-22 00:13:36 +01001424 else if (attr == &dev_attr_qas.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001425 spi_support_qas(starget))
1426 return TARGET_ATTRIBUTE_HELPER(qas);
James Bottomleyea443192009-06-13 12:19:05 -05001427 else if (attr == &dev_attr_max_qas.attr &&
1428 spi_support_qas(starget))
1429 return TARGET_ATTRIBUTE_HELPER(qas);
Tony Jonesee959b02008-02-22 00:13:36 +01001430 else if (attr == &dev_attr_wr_flow.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001431 spi_support_ius(starget))
1432 return TARGET_ATTRIBUTE_HELPER(wr_flow);
Tony Jonesee959b02008-02-22 00:13:36 +01001433 else if (attr == &dev_attr_rd_strm.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001434 spi_support_ius(starget))
1435 return TARGET_ATTRIBUTE_HELPER(rd_strm);
Tony Jonesee959b02008-02-22 00:13:36 +01001436 else if (attr == &dev_attr_rti.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001437 spi_support_ius(starget))
1438 return TARGET_ATTRIBUTE_HELPER(rti);
Tony Jonesee959b02008-02-22 00:13:36 +01001439 else if (attr == &dev_attr_pcomp_en.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001440 spi_support_ius(starget))
1441 return TARGET_ATTRIBUTE_HELPER(pcomp_en);
Tony Jonesee959b02008-02-22 00:13:36 +01001442 else if (attr == &dev_attr_hold_mcs.attr &&
James Bottomley9b161a42008-01-05 10:18:27 -06001443 spi_support_ius(starget))
1444 return TARGET_ATTRIBUTE_HELPER(hold_mcs);
Tony Jonesee959b02008-02-22 00:13:36 +01001445 else if (attr == &dev_attr_revalidate.attr)
James Bottomley352f6bb2008-03-20 20:57:02 -05001446 return S_IWUSR;
James Bottomley9b161a42008-01-05 10:18:27 -06001447
1448 return 0;
1449}
1450
1451static struct attribute *target_attributes[] = {
Tony Jonesee959b02008-02-22 00:13:36 +01001452 &dev_attr_period.attr,
1453 &dev_attr_min_period.attr,
1454 &dev_attr_offset.attr,
1455 &dev_attr_max_offset.attr,
1456 &dev_attr_width.attr,
1457 &dev_attr_max_width.attr,
1458 &dev_attr_iu.attr,
James Bottomleyea443192009-06-13 12:19:05 -05001459 &dev_attr_max_iu.attr,
Tony Jonesee959b02008-02-22 00:13:36 +01001460 &dev_attr_dt.attr,
1461 &dev_attr_qas.attr,
James Bottomleyea443192009-06-13 12:19:05 -05001462 &dev_attr_max_qas.attr,
Tony Jonesee959b02008-02-22 00:13:36 +01001463 &dev_attr_wr_flow.attr,
1464 &dev_attr_rd_strm.attr,
1465 &dev_attr_rti.attr,
1466 &dev_attr_pcomp_en.attr,
1467 &dev_attr_hold_mcs.attr,
1468 &dev_attr_revalidate.attr,
James Bottomley9b161a42008-01-05 10:18:27 -06001469 NULL
1470};
1471
1472static struct attribute_group target_attribute_group = {
1473 .attrs = target_attributes,
1474 .is_visible = target_attribute_is_visible,
1475};
1476
1477static int spi_target_configure(struct transport_container *tc,
1478 struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +01001479 struct device *cdev)
James Bottomley9b161a42008-01-05 10:18:27 -06001480{
1481 struct kobject *kobj = &cdev->kobj;
James Bottomley9b161a42008-01-05 10:18:27 -06001482
James Bottomley352f6bb2008-03-20 20:57:02 -05001483 /* force an update based on parameters read from the device */
1484 sysfs_update_group(kobj, &target_attribute_group);
James Bottomley9b161a42008-01-05 10:18:27 -06001485
1486 return 0;
1487}
1488
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489struct scsi_transport_template *
1490spi_attach_transport(struct spi_function_template *ft)
1491{
Jes Sorensen24669f752006-01-16 10:31:18 -05001492 struct spi_internal *i = kzalloc(sizeof(struct spi_internal),
1493 GFP_KERNEL);
1494
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 if (unlikely(!i))
1496 return NULL;
1497
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 i->t.target_attrs.ac.class = &spi_transport_class.class;
James Bottomley9b161a42008-01-05 10:18:27 -06001499 i->t.target_attrs.ac.grp = &target_attribute_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 i->t.target_attrs.ac.match = spi_target_match;
1501 transport_container_register(&i->t.target_attrs);
1502 i->t.target_size = sizeof(struct spi_transport_attrs);
1503 i->t.host_attrs.ac.class = &spi_host_class.class;
James Bottomley9b161a42008-01-05 10:18:27 -06001504 i->t.host_attrs.ac.grp = &host_attribute_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 i->t.host_attrs.ac.match = spi_host_match;
1506 transport_container_register(&i->t.host_attrs);
1507 i->t.host_size = sizeof(struct spi_host_attrs);
1508 i->f = ft;
1509
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 return &i->t;
1511}
1512EXPORT_SYMBOL(spi_attach_transport);
1513
1514void spi_release_transport(struct scsi_transport_template *t)
1515{
1516 struct spi_internal *i = to_spi_internal(t);
1517
1518 transport_container_unregister(&i->t.target_attrs);
1519 transport_container_unregister(&i->t.host_attrs);
1520
1521 kfree(i);
1522}
1523EXPORT_SYMBOL(spi_release_transport);
1524
1525static __init int spi_transport_init(void)
1526{
1527 int error = transport_class_register(&spi_transport_class);
1528 if (error)
1529 return error;
1530 error = anon_transport_class_register(&spi_device_class);
1531 return transport_class_register(&spi_host_class);
1532}
1533
1534static void __exit spi_transport_exit(void)
1535{
1536 transport_class_unregister(&spi_transport_class);
1537 anon_transport_class_unregister(&spi_device_class);
1538 transport_class_unregister(&spi_host_class);
1539}
1540
1541MODULE_AUTHOR("Martin Hicks");
1542MODULE_DESCRIPTION("SPI Transport Attributes");
1543MODULE_LICENSE("GPL");
1544
1545module_init(spi_transport_init);
1546module_exit(spi_transport_exit);