xref: /openbmc/linux/drivers/scsi/scsi_devinfo.c (revision 550987be)
1 // SPDX-License-Identifier: GPL-2.0
2 
3 #include <linux/blkdev.h>
4 #include <linux/init.h>
5 #include <linux/kernel.h>
6 #include <linux/module.h>
7 #include <linux/moduleparam.h>
8 #include <linux/proc_fs.h>
9 #include <linux/seq_file.h>
10 #include <linux/slab.h>
11 
12 #include <scsi/scsi_device.h>
13 #include <scsi/scsi_devinfo.h>
14 
15 #include "scsi_priv.h"
16 
17 
18 /*
19  * scsi_dev_info_list: structure to hold black/white listed devices.
20  */
21 struct scsi_dev_info_list {
22 	struct list_head dev_info_list;
23 	char vendor[8];
24 	char model[16];
25 	blist_flags_t flags;
26 	unsigned compatible; /* for use with scsi_static_device_list entries */
27 };
28 
29 struct scsi_dev_info_list_table {
30 	struct list_head node;	/* our node for being on the master list */
31 	struct list_head scsi_dev_info_list; /* head of dev info list */
32 	const char *name;	/* name of list for /proc (NULL for global) */
33 	int key;		/* unique numeric identifier */
34 };
35 
36 
37 static blist_flags_t scsi_default_dev_flags;
38 static LIST_HEAD(scsi_dev_info_list);
39 static char scsi_dev_flags[256];
40 
41 /*
42  * scsi_static_device_list: deprecated list of devices that require
43  * settings that differ from the default, includes black-listed (broken)
44  * devices. The entries here are added to the tail of scsi_dev_info_list
45  * via scsi_dev_info_list_init.
46  *
47  * Do not add to this list, use the command line or proc interface to add
48  * to the scsi_dev_info_list. This table will eventually go away.
49  */
50 static struct {
51 	char *vendor;
52 	char *model;
53 	char *revision;	/* revision known to be bad, unused */
54 	blist_flags_t flags;
55 } scsi_static_device_list[] __initdata = {
56 	/*
57 	 * The following devices are known not to tolerate a lun != 0 scan
58 	 * for one reason or another. Some will respond to all luns,
59 	 * others will lock up.
60 	 */
61 	{"Aashima", "IMAGERY 2400SP", "1.03", BLIST_NOLUN},	/* locks up */
62 	{"CHINON", "CD-ROM CDS-431", "H42", BLIST_NOLUN},	/* locks up */
63 	{"CHINON", "CD-ROM CDS-535", "Q14", BLIST_NOLUN},	/* locks up */
64 	{"DENON", "DRD-25X", "V", BLIST_NOLUN},			/* locks up */
65 	{"HITACHI", "DK312C", "CM81", BLIST_NOLUN},	/* responds to all lun */
66 	{"HITACHI", "DK314C", "CR21", BLIST_NOLUN},	/* responds to all lun */
67 	{"IBM", "2104-DU3", NULL, BLIST_NOLUN},		/* locks up */
68 	{"IBM", "2104-TU3", NULL, BLIST_NOLUN},		/* locks up */
69 	{"IMS", "CDD521/10", "2.06", BLIST_NOLUN},	/* locks up */
70 	{"MAXTOR", "XT-3280", "PR02", BLIST_NOLUN},	/* locks up */
71 	{"MAXTOR", "XT-4380S", "B3C", BLIST_NOLUN},	/* locks up */
72 	{"MAXTOR", "MXT-1240S", "I1.2", BLIST_NOLUN},	/* locks up */
73 	{"MAXTOR", "XT-4170S", "B5A", BLIST_NOLUN},	/* locks up */
74 	{"MAXTOR", "XT-8760S", "B7B", BLIST_NOLUN},	/* locks up */
75 	{"MEDIAVIS", "RENO CD-ROMX2A", "2.03", BLIST_NOLUN},	/* responds to all lun */
76 	{"MICROTEK", "ScanMakerIII", "2.30", BLIST_NOLUN},	/* responds to all lun */
77 	{"NEC", "CD-ROM DRIVE:841", "1.0", BLIST_NOLUN},/* locks up */
78 	{"PHILIPS", "PCA80SC", "V4-2", BLIST_NOLUN},	/* responds to all lun */
79 	{"RODIME", "RO3000S", "2.33", BLIST_NOLUN},	/* locks up */
80 	{"SUN", "SENA", NULL, BLIST_NOLUN},		/* responds to all luns */
81 	/*
82 	 * The following causes a failed REQUEST SENSE on lun 1 for
83 	 * aha152x controller, which causes SCSI code to reset bus.
84 	 */
85 	{"SANYO", "CRD-250S", "1.20", BLIST_NOLUN},
86 	/*
87 	 * The following causes a failed REQUEST SENSE on lun 1 for
88 	 * aha152x controller, which causes SCSI code to reset bus.
89 	 */
90 	{"SEAGATE", "ST157N", "\004|j", BLIST_NOLUN},
91 	{"SEAGATE", "ST296", "921", BLIST_NOLUN},	/* responds to all lun */
92 	{"SEAGATE", "ST1581", "6538", BLIST_NOLUN},	/* responds to all lun */
93 	{"SONY", "CD-ROM CDU-541", "4.3d", BLIST_NOLUN},
94 	{"SONY", "CD-ROM CDU-55S", "1.0i", BLIST_NOLUN},
95 	{"SONY", "CD-ROM CDU-561", "1.7x", BLIST_NOLUN},
96 	{"SONY", "CD-ROM CDU-8012", NULL, BLIST_NOLUN},
97 	{"SONY", "SDT-5000", "3.17", BLIST_SELECT_NO_ATN},
98 	{"TANDBERG", "TDC 3600", "U07", BLIST_NOLUN},	/* locks up */
99 	{"TEAC", "CD-R55S", "1.0H", BLIST_NOLUN},	/* locks up */
100 	/*
101 	 * The following causes a failed REQUEST SENSE on lun 1 for
102 	 * seagate controller, which causes SCSI code to reset bus.
103 	 */
104 	{"TEAC", "CD-ROM", "1.06", BLIST_NOLUN},
105 	{"TEAC", "MT-2ST/45S2-27", "RV M", BLIST_NOLUN},	/* responds to all lun */
106 	/*
107 	 * The following causes a failed REQUEST SENSE on lun 1 for
108 	 * seagate controller, which causes SCSI code to reset bus.
109 	 */
110 	{"HP", "C1750A", "3226", BLIST_NOLUN},		/* scanjet iic */
111 	{"HP", "C1790A", NULL, BLIST_NOLUN},		/* scanjet iip */
112 	{"HP", "C2500A", NULL, BLIST_NOLUN},		/* scanjet iicx */
113 	{"MEDIAVIS", "CDR-H93MV", "1.31", BLIST_NOLUN},	/* locks up */
114 	{"MICROTEK", "ScanMaker II", "5.61", BLIST_NOLUN},	/* responds to all lun */
115 	{"MITSUMI", "CD-R CR-2201CS", "6119", BLIST_NOLUN},	/* locks up */
116 	{"NEC", "D3856", "0009", BLIST_NOLUN},
117 	{"QUANTUM", "LPS525S", "3110", BLIST_NOLUN},	/* locks up */
118 	{"QUANTUM", "PD1225S", "3110", BLIST_NOLUN},	/* locks up */
119 	{"QUANTUM", "FIREBALL ST4.3S", "0F0C", BLIST_NOLUN},	/* locks up */
120 	{"RELISYS", "Scorpio", NULL, BLIST_NOLUN},	/* responds to all lun */
121 	{"SANKYO", "CP525", "6.64", BLIST_NOLUN},	/* causes failed REQ SENSE, extra reset */
122 	{"TEXEL", "CD-ROM", "1.06", BLIST_NOLUN | BLIST_BORKEN},
123 	{"transtec", "T5008", "0001", BLIST_NOREPORTLUN },
124 	{"YAMAHA", "CDR100", "1.00", BLIST_NOLUN},	/* locks up */
125 	{"YAMAHA", "CDR102", "1.00", BLIST_NOLUN},	/* locks up */
126 	{"YAMAHA", "CRW8424S", "1.0", BLIST_NOLUN},	/* locks up */
127 	{"YAMAHA", "CRW6416S", "1.0c", BLIST_NOLUN},	/* locks up */
128 	{"", "Scanner", "1.80", BLIST_NOLUN},	/* responds to all lun */
129 
130 	/*
131 	 * Other types of devices that have special flags.
132 	 * Note that all USB devices should have the BLIST_INQUIRY_36 flag.
133 	 */
134 	{"3PARdata", "VV", NULL, BLIST_REPORTLUN2},
135 	{"ADAPTEC", "AACRAID", NULL, BLIST_FORCELUN},
136 	{"ADAPTEC", "Adaptec 5400S", NULL, BLIST_FORCELUN},
137 	{"AIX", "VDASD", NULL, BLIST_TRY_VPD_PAGES},
138 	{"AFT PRO", "-IX CF", "0.0>", BLIST_FORCELUN},
139 	{"BELKIN", "USB 2 HS-CF", "1.95",  BLIST_FORCELUN | BLIST_INQUIRY_36},
140 	{"BROWNIE", "1200U3P", NULL, BLIST_NOREPORTLUN},
141 	{"BROWNIE", "1600U3P", NULL, BLIST_NOREPORTLUN},
142 	{"CANON", "IPUBJD", NULL, BLIST_SPARSELUN},
143 	{"CBOX3", "USB Storage-SMC", "300A", BLIST_FORCELUN | BLIST_INQUIRY_36},
144 	{"CMD", "CRA-7280", NULL, BLIST_SPARSELUN},	/* CMD RAID Controller */
145 	{"CNSI", "G7324", NULL, BLIST_SPARSELUN},	/* Chaparral G7324 RAID */
146 	{"CNSi", "G8324", NULL, BLIST_SPARSELUN},	/* Chaparral G8324 RAID */
147 	{"COMPAQ", "ARRAY CONTROLLER", NULL, BLIST_SPARSELUN | BLIST_LARGELUN |
148 		BLIST_MAX_512 | BLIST_REPORTLUN2},	/* Compaq RA4x00 */
149 	{"COMPAQ", "LOGICAL VOLUME", NULL, BLIST_FORCELUN | BLIST_MAX_512}, /* Compaq RA4x00 */
150 	{"COMPAQ", "CR3500", NULL, BLIST_FORCELUN},
151 	{"COMPAQ", "MSA1000", NULL, BLIST_SPARSELUN | BLIST_NOSTARTONADD},
152 	{"COMPAQ", "MSA1000 VOLUME", NULL, BLIST_SPARSELUN | BLIST_NOSTARTONADD},
153 	{"COMPAQ", "HSV110", NULL, BLIST_REPORTLUN2 | BLIST_NOSTARTONADD},
154 	{"DDN", "SAN DataDirector", "*", BLIST_SPARSELUN},
155 	{"DEC", "HSG80", NULL, BLIST_REPORTLUN2 | BLIST_NOSTARTONADD},
156 	{"DELL", "PV660F", NULL, BLIST_SPARSELUN},
157 	{"DELL", "PV660F   PSEUDO", NULL, BLIST_SPARSELUN},
158 	{"DELL", "PSEUDO DEVICE .", NULL, BLIST_SPARSELUN},	/* Dell PV 530F */
159 	{"DELL", "PV530F", NULL, BLIST_SPARSELUN},
160 	{"DELL", "PERCRAID", NULL, BLIST_FORCELUN},
161 	{"DGC", "RAID", NULL, BLIST_SPARSELUN},	/* EMC CLARiiON, storage on LUN 0 */
162 	{"DGC", "DISK", NULL, BLIST_SPARSELUN},	/* EMC CLARiiON, no storage on LUN 0 */
163 	{"EMC",  "Invista", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
164 	{"EMC", "SYMMETRIX", NULL, BLIST_SPARSELUN | BLIST_LARGELUN | BLIST_REPORTLUN2},
165 	{"EMULEX", "MD21/S2     ESDI", NULL, BLIST_SINGLELUN},
166 	{"easyRAID", "16P", NULL, BLIST_NOREPORTLUN},
167 	{"easyRAID", "X6P", NULL, BLIST_NOREPORTLUN},
168 	{"easyRAID", "F8", NULL, BLIST_NOREPORTLUN},
169 	{"FSC", "CentricStor", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
170 	{"Generic", "USB SD Reader", "1.00", BLIST_FORCELUN | BLIST_INQUIRY_36},
171 	{"Generic", "USB Storage-SMC", "0180", BLIST_FORCELUN | BLIST_INQUIRY_36},
172 	{"Generic", "USB Storage-SMC", "0207", BLIST_FORCELUN | BLIST_INQUIRY_36},
173 	{"HITACHI", "DF400", "*", BLIST_REPORTLUN2},
174 	{"HITACHI", "DF500", "*", BLIST_REPORTLUN2},
175 	{"HITACHI", "DISK-SUBSYSTEM", "*", BLIST_REPORTLUN2},
176 	{"HITACHI", "HUS1530", "*", BLIST_NO_DIF},
177 	{"HITACHI", "OPEN-", "*", BLIST_REPORTLUN2 | BLIST_TRY_VPD_PAGES},
178 	{"HITACHI", "OP-C-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
179 	{"HITACHI", "3380-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
180 	{"HITACHI", "3390-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
181 	{"HITACHI", "6586-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
182 	{"HITACHI", "6588-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
183 	{"HP", "A6189A", NULL, BLIST_SPARSELUN | BLIST_LARGELUN},	/* HP VA7400 */
184 	{"HP", "OPEN-", "*", BLIST_REPORTLUN2 | BLIST_TRY_VPD_PAGES}, /* HP XP Arrays */
185 	{"HP", "NetRAID-4M", NULL, BLIST_FORCELUN},
186 	{"HP", "HSV100", NULL, BLIST_REPORTLUN2 | BLIST_NOSTARTONADD},
187 	{"HP", "C1557A", NULL, BLIST_FORCELUN},
188 	{"HP", "C3323-300", "4269", BLIST_NOTQ},
189 	{"HP", "C5713A", NULL, BLIST_NOREPORTLUN},
190 	{"HP", "DF400", "*", BLIST_REPORTLUN2},
191 	{"HP", "DF500", "*", BLIST_REPORTLUN2},
192 	{"HP", "OP-C-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
193 	{"HP", "3380-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
194 	{"HP", "3390-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
195 	{"HP", "6586-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
196 	{"HP", "6588-", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
197 	{"IBM", "AuSaV1S2", NULL, BLIST_FORCELUN},
198 	{"IBM", "ProFibre 4000R", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
199 	{"IBM", "2105", NULL, BLIST_RETRY_HWERROR},
200 	{"iomega", "jaz 1GB", "J.86", BLIST_NOTQ | BLIST_NOLUN},
201 	{"IOMEGA", "ZIP", NULL, BLIST_NOTQ | BLIST_NOLUN},
202 	{"IOMEGA", "Io20S         *F", NULL, BLIST_KEY},
203 	{"INSITE", "Floptical   F*8I", NULL, BLIST_KEY},
204 	{"INSITE", "I325VM", NULL, BLIST_KEY},
205 	{"Intel", "Multi-Flex", NULL, BLIST_NO_RSOC},
206 	{"iRiver", "iFP Mass Driver", NULL, BLIST_NOT_LOCKABLE | BLIST_INQUIRY_36},
207 	{"LASOUND", "CDX7405", "3.10", BLIST_MAX5LUN | BLIST_SINGLELUN},
208 	{"Marvell", "Console", NULL, BLIST_SKIP_VPD_PAGES},
209 	{"Marvell", "91xx Config", "1.01", BLIST_SKIP_VPD_PAGES},
210 	{"MATSHITA", "PD-1", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
211 	{"MATSHITA", "DMC-LC5", NULL, BLIST_NOT_LOCKABLE | BLIST_INQUIRY_36},
212 	{"MATSHITA", "DMC-LC40", NULL, BLIST_NOT_LOCKABLE | BLIST_INQUIRY_36},
213 	{"Medion", "Flash XL  MMC/SD", "2.6D", BLIST_FORCELUN},
214 	{"MegaRAID", "LD", NULL, BLIST_FORCELUN},
215 	{"MICROP", "4110", NULL, BLIST_NOTQ},
216 	{"MSFT", "Virtual HD", NULL, BLIST_NO_RSOC},
217 	{"MYLEX", "DACARMRB", "*", BLIST_REPORTLUN2},
218 	{"nCipher", "Fastness Crypto", NULL, BLIST_FORCELUN},
219 	{"NAKAMICH", "MJ-4.8S", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
220 	{"NAKAMICH", "MJ-5.16S", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
221 	{"NEC", "PD-1 ODX654P", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
222 	{"NEC", "iStorage", NULL, BLIST_REPORTLUN2},
223 	{"NRC", "MBR-7", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
224 	{"NRC", "MBR-7.4", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
225 	{"PIONEER", "CD-ROM DRM-600", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
226 	{"PIONEER", "CD-ROM DRM-602X", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
227 	{"PIONEER", "CD-ROM DRM-604X", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
228 	{"PIONEER", "CD-ROM DRM-624X", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
229 	{"Promise", "VTrak E610f", NULL, BLIST_SPARSELUN | BLIST_NO_RSOC},
230 	{"Promise", "", NULL, BLIST_SPARSELUN},
231 	{"QEMU", "QEMU CD-ROM", NULL, BLIST_SKIP_VPD_PAGES},
232 	{"QNAP", "iSCSI Storage", NULL, BLIST_MAX_1024},
233 	{"SYNOLOGY", "iSCSI Storage", NULL, BLIST_MAX_1024},
234 	{"QUANTUM", "XP34301", "1071", BLIST_NOTQ},
235 	{"REGAL", "CDC-4X", NULL, BLIST_MAX5LUN | BLIST_SINGLELUN},
236 	{"SanDisk", "ImageMate CF-SD1", NULL, BLIST_FORCELUN},
237 	{"SEAGATE", "ST34555N", "0930", BLIST_NOTQ},	/* Chokes on tagged INQUIRY */
238 	{"SEAGATE", "ST3390N", "9546", BLIST_NOTQ},
239 	{"SEAGATE", "ST900MM0006", NULL, BLIST_SKIP_VPD_PAGES},
240 	{"SGI", "RAID3", "*", BLIST_SPARSELUN},
241 	{"SGI", "RAID5", "*", BLIST_SPARSELUN},
242 	{"SGI", "TP9100", "*", BLIST_REPORTLUN2},
243 	{"SGI", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
244 	{"IBM", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
245 	{"SUN", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
246 	{"DELL", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
247 	{"STK", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
248 	{"NETAPP", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
249 	{"LSI", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
250 	{"ENGENIO", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
251 	{"SMSC", "USB 2 HS-CF", NULL, BLIST_SPARSELUN | BLIST_INQUIRY_36},
252 	{"SONY", "CD-ROM CDU-8001", NULL, BLIST_BORKEN},
253 	{"SONY", "TSL", NULL, BLIST_FORCELUN},		/* DDS3 & DDS4 autoloaders */
254 	{"ST650211", "CF", NULL, BLIST_RETRY_HWERROR},
255 	{"SUN", "T300", "*", BLIST_SPARSELUN},
256 	{"SUN", "T4", "*", BLIST_SPARSELUN},
257 	{"Tornado-", "F4", "*", BLIST_NOREPORTLUN},
258 	{"TOSHIBA", "CDROM", NULL, BLIST_ISROM},
259 	{"TOSHIBA", "CD-ROM", NULL, BLIST_ISROM},
260 	{"Traxdata", "CDR4120", NULL, BLIST_NOLUN},	/* locks up */
261 	{"USB2.0", "SMARTMEDIA/XD", NULL, BLIST_FORCELUN | BLIST_INQUIRY_36},
262 	{"WangDAT", "Model 2600", "01.7", BLIST_SELECT_NO_ATN},
263 	{"WangDAT", "Model 3200", "02.2", BLIST_SELECT_NO_ATN},
264 	{"WangDAT", "Model 1300", "02.4", BLIST_SELECT_NO_ATN},
265 	{"WDC WD25", "00JB-00FUA0", NULL, BLIST_NOREPORTLUN},
266 	{"XYRATEX", "RS", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
267 	{"Zzyzx", "RocketStor 500S", NULL, BLIST_SPARSELUN},
268 	{"Zzyzx", "RocketStor 2000", NULL, BLIST_SPARSELUN},
269 	{ NULL, NULL, NULL, 0 },
270 };
271 
272 static struct scsi_dev_info_list_table *scsi_devinfo_lookup_by_key(int key)
273 {
274 	struct scsi_dev_info_list_table *devinfo_table;
275 	int found = 0;
276 
277 	list_for_each_entry(devinfo_table, &scsi_dev_info_list, node)
278 		if (devinfo_table->key == key) {
279 			found = 1;
280 			break;
281 		}
282 	if (!found)
283 		return ERR_PTR(-EINVAL);
284 
285 	return devinfo_table;
286 }
287 
288 /*
289  * scsi_strcpy_devinfo: called from scsi_dev_info_list_add to copy into
290  * devinfo vendor and model strings.
291  */
292 static void scsi_strcpy_devinfo(char *name, char *to, size_t to_length,
293 				char *from, int compatible)
294 {
295 	size_t from_length;
296 
297 	from_length = strlen(from);
298 	/* This zero-pads the destination */
299 	strncpy(to, from, to_length);
300 	if (from_length < to_length && !compatible) {
301 		/*
302 		 * space pad the string if it is short.
303 		 */
304 		memset(&to[from_length], ' ', to_length - from_length);
305 	}
306 	if (from_length > to_length)
307 		 printk(KERN_WARNING "%s: %s string '%s' is too long\n",
308 			__func__, name, from);
309 }
310 
311 /**
312  * scsi_dev_info_list_add - add one dev_info list entry.
313  * @compatible: if true, null terminate short strings.  Otherwise space pad.
314  * @vendor:	vendor string
315  * @model:	model (product) string
316  * @strflags:	integer string
317  * @flags:	if strflags NULL, use this flag value
318  *
319  * Description:
320  *	Create and add one dev_info entry for @vendor, @model, @strflags or
321  *	@flag. If @compatible, add to the tail of the list, do not space
322  *	pad, and set devinfo->compatible. The scsi_static_device_list entries
323  *	are added with @compatible 1 and @clfags NULL.
324  *
325  * Returns: 0 OK, -error on failure.
326  **/
327 static int scsi_dev_info_list_add(int compatible, char *vendor, char *model,
328 			    char *strflags, blist_flags_t flags)
329 {
330 	return scsi_dev_info_list_add_keyed(compatible, vendor, model,
331 					    strflags, flags,
332 					    SCSI_DEVINFO_GLOBAL);
333 }
334 
335 /**
336  * scsi_dev_info_list_add_keyed - add one dev_info list entry.
337  * @compatible: if true, null terminate short strings.  Otherwise space pad.
338  * @vendor:	vendor string
339  * @model:	model (product) string
340  * @strflags:	integer string
341  * @flags:	if strflags NULL, use this flag value
342  * @key:	specify list to use
343  *
344  * Description:
345  *	Create and add one dev_info entry for @vendor, @model,
346  *	@strflags or @flag in list specified by @key. If @compatible,
347  *	add to the tail of the list, do not space pad, and set
348  *	devinfo->compatible. The scsi_static_device_list entries are
349  *	added with @compatible 1 and @clfags NULL.
350  *
351  * Returns: 0 OK, -error on failure.
352  **/
353 int scsi_dev_info_list_add_keyed(int compatible, char *vendor, char *model,
354 				 char *strflags, blist_flags_t flags,
355 				 enum scsi_devinfo_key key)
356 {
357 	struct scsi_dev_info_list *devinfo;
358 	struct scsi_dev_info_list_table *devinfo_table =
359 		scsi_devinfo_lookup_by_key(key);
360 
361 	if (IS_ERR(devinfo_table))
362 		return PTR_ERR(devinfo_table);
363 
364 	devinfo = kmalloc(sizeof(*devinfo), GFP_KERNEL);
365 	if (!devinfo) {
366 		printk(KERN_ERR "%s: no memory\n", __func__);
367 		return -ENOMEM;
368 	}
369 
370 	scsi_strcpy_devinfo("vendor", devinfo->vendor, sizeof(devinfo->vendor),
371 			    vendor, compatible);
372 	scsi_strcpy_devinfo("model", devinfo->model, sizeof(devinfo->model),
373 			    model, compatible);
374 
375 	if (strflags)
376 		flags = (__force blist_flags_t)simple_strtoul(strflags, NULL, 0);
377 	devinfo->flags = flags;
378 	devinfo->compatible = compatible;
379 
380 	if (compatible)
381 		list_add_tail(&devinfo->dev_info_list,
382 			      &devinfo_table->scsi_dev_info_list);
383 	else
384 		list_add(&devinfo->dev_info_list,
385 			 &devinfo_table->scsi_dev_info_list);
386 
387 	return 0;
388 }
389 EXPORT_SYMBOL(scsi_dev_info_list_add_keyed);
390 
391 /**
392  * scsi_dev_info_list_find - find a matching dev_info list entry.
393  * @vendor:	full vendor string
394  * @model:	full model (product) string
395  * @key:	specify list to use
396  *
397  * Description:
398  *	Finds the first dev_info entry matching @vendor, @model
399  *	in list specified by @key.
400  *
401  * Returns: pointer to matching entry, or ERR_PTR on failure.
402  **/
403 static struct scsi_dev_info_list *scsi_dev_info_list_find(const char *vendor,
404 		const char *model, enum scsi_devinfo_key key)
405 {
406 	struct scsi_dev_info_list *devinfo;
407 	struct scsi_dev_info_list_table *devinfo_table =
408 		scsi_devinfo_lookup_by_key(key);
409 	size_t vmax, mmax, mlen;
410 	const char *vskip, *mskip;
411 
412 	if (IS_ERR(devinfo_table))
413 		return (struct scsi_dev_info_list *) devinfo_table;
414 
415 	/* Prepare for "compatible" matches */
416 
417 	/*
418 	 * XXX why skip leading spaces? If an odd INQUIRY
419 	 * value, that should have been part of the
420 	 * scsi_static_device_list[] entry, such as "  FOO"
421 	 * rather than "FOO". Since this code is already
422 	 * here, and we don't know what device it is
423 	 * trying to work with, leave it as-is.
424 	 */
425 	vmax = sizeof(devinfo->vendor);
426 	vskip = vendor;
427 	while (vmax > 0 && *vskip == ' ') {
428 		vmax--;
429 		vskip++;
430 	}
431 	/* Also skip trailing spaces */
432 	while (vmax > 0 && vskip[vmax - 1] == ' ')
433 		--vmax;
434 
435 	mmax = sizeof(devinfo->model);
436 	mskip = model;
437 	while (mmax > 0 && *mskip == ' ') {
438 		mmax--;
439 		mskip++;
440 	}
441 	while (mmax > 0 && mskip[mmax - 1] == ' ')
442 		--mmax;
443 
444 	list_for_each_entry(devinfo, &devinfo_table->scsi_dev_info_list,
445 			    dev_info_list) {
446 		if (devinfo->compatible) {
447 			/*
448 			 * vendor strings must be an exact match
449 			 */
450 			if (vmax != strnlen(devinfo->vendor,
451 					    sizeof(devinfo->vendor)) ||
452 			    memcmp(devinfo->vendor, vskip, vmax))
453 				continue;
454 
455 			/*
456 			 * @model specifies the full string, and
457 			 * must be larger or equal to devinfo->model
458 			 */
459 			mlen = strnlen(devinfo->model, sizeof(devinfo->model));
460 			if (mmax < mlen || memcmp(devinfo->model, mskip, mlen))
461 				continue;
462 			return devinfo;
463 		} else {
464 			if (!memcmp(devinfo->vendor, vendor,
465 				    sizeof(devinfo->vendor)) &&
466 			    !memcmp(devinfo->model, model,
467 				    sizeof(devinfo->model)))
468 				return devinfo;
469 		}
470 	}
471 
472 	return ERR_PTR(-ENOENT);
473 }
474 
475 /**
476  * scsi_dev_info_list_del_keyed - remove one dev_info list entry.
477  * @vendor:	vendor string
478  * @model:	model (product) string
479  * @key:	specify list to use
480  *
481  * Description:
482  *	Remove and destroy one dev_info entry for @vendor, @model
483  *	in list specified by @key.
484  *
485  * Returns: 0 OK, -error on failure.
486  **/
487 int scsi_dev_info_list_del_keyed(char *vendor, char *model,
488 				 enum scsi_devinfo_key key)
489 {
490 	struct scsi_dev_info_list *found;
491 
492 	found = scsi_dev_info_list_find(vendor, model, key);
493 	if (IS_ERR(found))
494 		return PTR_ERR(found);
495 
496 	list_del(&found->dev_info_list);
497 	kfree(found);
498 	return 0;
499 }
500 EXPORT_SYMBOL(scsi_dev_info_list_del_keyed);
501 
502 /**
503  * scsi_dev_info_list_add_str - parse dev_list and add to the scsi_dev_info_list.
504  * @dev_list:	string of device flags to add
505  *
506  * Description:
507  *	Parse dev_list, and add entries to the scsi_dev_info_list.
508  *	dev_list is of the form "vendor:product:flag,vendor:product:flag".
509  *	dev_list is modified via strsep. Can be called for command line
510  *	addition, for proc or mabye a sysfs interface.
511  *
512  * Returns: 0 if OK, -error on failure.
513  **/
514 static int scsi_dev_info_list_add_str(char *dev_list)
515 {
516 	char *vendor, *model, *strflags, *next;
517 	char *next_check;
518 	int res = 0;
519 
520 	next = dev_list;
521 	if (next && next[0] == '"') {
522 		/*
523 		 * Ignore both the leading and trailing quote.
524 		 */
525 		next++;
526 		next_check = ",\"";
527 	} else {
528 		next_check = ",";
529 	}
530 
531 	/*
532 	 * For the leading and trailing '"' case, the for loop comes
533 	 * through the last time with vendor[0] == '\0'.
534 	 */
535 	for (vendor = strsep(&next, ":"); vendor && (vendor[0] != '\0')
536 	     && (res == 0); vendor = strsep(&next, ":")) {
537 		strflags = NULL;
538 		model = strsep(&next, ":");
539 		if (model)
540 			strflags = strsep(&next, next_check);
541 		if (!model || !strflags) {
542 			printk(KERN_ERR "%s: bad dev info string '%s' '%s'"
543 			       " '%s'\n", __func__, vendor, model,
544 			       strflags);
545 			res = -EINVAL;
546 		} else
547 			res = scsi_dev_info_list_add(0 /* compatible */, vendor,
548 						     model, strflags, 0);
549 	}
550 	return res;
551 }
552 
553 /**
554  * get_device_flags - get device specific flags from the dynamic device list.
555  * @sdev:       &scsi_device to get flags for
556  * @vendor:	vendor name
557  * @model:	model name
558  *
559  * Description:
560  *     Search the global scsi_dev_info_list (specified by list zero)
561  *     for an entry matching @vendor and @model, if found, return the
562  *     matching flags value, else return the host or global default
563  *     settings.  Called during scan time.
564  **/
565 blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
566 				    const unsigned char *vendor,
567 				    const unsigned char *model)
568 {
569 	return scsi_get_device_flags_keyed(sdev, vendor, model,
570 					   SCSI_DEVINFO_GLOBAL);
571 }
572 
573 
574 /**
575  * scsi_get_device_flags_keyed - get device specific flags from the dynamic device list
576  * @sdev:       &scsi_device to get flags for
577  * @vendor:	vendor name
578  * @model:	model name
579  * @key:	list to look up
580  *
581  * Description:
582  *     Search the scsi_dev_info_list specified by @key for an entry
583  *     matching @vendor and @model, if found, return the matching
584  *     flags value, else return the host or global default settings.
585  *     Called during scan time.
586  **/
587 blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
588 				const unsigned char *vendor,
589 				const unsigned char *model,
590 				enum scsi_devinfo_key key)
591 {
592 	struct scsi_dev_info_list *devinfo;
593 
594 	devinfo = scsi_dev_info_list_find(vendor, model, key);
595 	if (!IS_ERR(devinfo))
596 		return devinfo->flags;
597 
598 	/* key or device not found: return nothing */
599 	if (key != SCSI_DEVINFO_GLOBAL)
600 		return 0;
601 
602 	/* except for the global list, where we have an exception */
603 	if (sdev->sdev_bflags)
604 		return sdev->sdev_bflags;
605 
606 	return scsi_default_dev_flags;
607 }
608 EXPORT_SYMBOL(scsi_get_device_flags_keyed);
609 
610 #ifdef CONFIG_SCSI_PROC_FS
611 struct double_list {
612 	struct list_head *top;
613 	struct list_head *bottom;
614 };
615 
616 static int devinfo_seq_show(struct seq_file *m, void *v)
617 {
618 	struct double_list *dl = v;
619 	struct scsi_dev_info_list_table *devinfo_table =
620 		list_entry(dl->top, struct scsi_dev_info_list_table, node);
621 	struct scsi_dev_info_list *devinfo =
622 		list_entry(dl->bottom, struct scsi_dev_info_list,
623 			   dev_info_list);
624 
625 	if (devinfo_table->scsi_dev_info_list.next == dl->bottom &&
626 	    devinfo_table->name)
627 		seq_printf(m, "[%s]:\n", devinfo_table->name);
628 
629 	seq_printf(m, "'%.8s' '%.16s' 0x%x\n",
630 		   devinfo->vendor, devinfo->model, devinfo->flags);
631 	return 0;
632 }
633 
634 static void *devinfo_seq_start(struct seq_file *m, loff_t *ppos)
635 {
636 	struct double_list *dl = kmalloc(sizeof(*dl), GFP_KERNEL);
637 	loff_t pos = *ppos;
638 
639 	if (!dl)
640 		return NULL;
641 
642 	list_for_each(dl->top, &scsi_dev_info_list) {
643 		struct scsi_dev_info_list_table *devinfo_table =
644 			list_entry(dl->top, struct scsi_dev_info_list_table,
645 				   node);
646 		list_for_each(dl->bottom, &devinfo_table->scsi_dev_info_list)
647 			if (pos-- == 0)
648 				return dl;
649 	}
650 
651 	kfree(dl);
652 	return NULL;
653 }
654 
655 static void *devinfo_seq_next(struct seq_file *m, void *v, loff_t *ppos)
656 {
657 	struct double_list *dl = v;
658 	struct scsi_dev_info_list_table *devinfo_table =
659 		list_entry(dl->top, struct scsi_dev_info_list_table, node);
660 
661 	++*ppos;
662 	dl->bottom = dl->bottom->next;
663 	while (&devinfo_table->scsi_dev_info_list == dl->bottom) {
664 		dl->top = dl->top->next;
665 		if (dl->top == &scsi_dev_info_list) {
666 			kfree(dl);
667 			return NULL;
668 		}
669 		devinfo_table = list_entry(dl->top,
670 					   struct scsi_dev_info_list_table,
671 					   node);
672 		dl->bottom = devinfo_table->scsi_dev_info_list.next;
673 	}
674 
675 	return dl;
676 }
677 
678 static void devinfo_seq_stop(struct seq_file *m, void *v)
679 {
680 	kfree(v);
681 }
682 
683 static const struct seq_operations scsi_devinfo_seq_ops = {
684 	.start	= devinfo_seq_start,
685 	.next	= devinfo_seq_next,
686 	.stop	= devinfo_seq_stop,
687 	.show	= devinfo_seq_show,
688 };
689 
690 static int proc_scsi_devinfo_open(struct inode *inode, struct file *file)
691 {
692 	return seq_open(file, &scsi_devinfo_seq_ops);
693 }
694 
695 /*
696  * proc_scsi_dev_info_write - allow additions to scsi_dev_info_list via /proc.
697  *
698  * Description: Adds a black/white list entry for vendor and model with an
699  * integer value of flag to the scsi device info list.
700  * To use, echo "vendor:model:flag" > /proc/scsi/device_info
701  */
702 static ssize_t proc_scsi_devinfo_write(struct file *file,
703 				       const char __user *buf,
704 				       size_t length, loff_t *ppos)
705 {
706 	char *buffer;
707 	ssize_t err = length;
708 
709 	if (!buf || length>PAGE_SIZE)
710 		return -EINVAL;
711 	if (!(buffer = (char *) __get_free_page(GFP_KERNEL)))
712 		return -ENOMEM;
713 	if (copy_from_user(buffer, buf, length)) {
714 		err =-EFAULT;
715 		goto out;
716 	}
717 
718 	if (length < PAGE_SIZE)
719 		buffer[length] = '\0';
720 	else if (buffer[PAGE_SIZE-1]) {
721 		err = -EINVAL;
722 		goto out;
723 	}
724 
725 	scsi_dev_info_list_add_str(buffer);
726 
727 out:
728 	free_page((unsigned long)buffer);
729 	return err;
730 }
731 
732 static const struct file_operations scsi_devinfo_proc_fops = {
733 	.owner		= THIS_MODULE,
734 	.open		= proc_scsi_devinfo_open,
735 	.read		= seq_read,
736 	.write		= proc_scsi_devinfo_write,
737 	.llseek		= seq_lseek,
738 	.release	= seq_release,
739 };
740 #endif /* CONFIG_SCSI_PROC_FS */
741 
742 module_param_string(dev_flags, scsi_dev_flags, sizeof(scsi_dev_flags), 0);
743 MODULE_PARM_DESC(dev_flags,
744 	 "Given scsi_dev_flags=vendor:model:flags[,v:m:f] add black/white"
745 	 " list entries for vendor and model with an integer value of flags"
746 	 " to the scsi device info list");
747 
748 module_param_named(default_dev_flags, scsi_default_dev_flags, int, S_IRUGO|S_IWUSR);
749 MODULE_PARM_DESC(default_dev_flags,
750 		 "scsi default device flag integer value");
751 
752 /**
753  * scsi_exit_devinfo - remove /proc/scsi/device_info & the scsi_dev_info_list
754  **/
755 void scsi_exit_devinfo(void)
756 {
757 #ifdef CONFIG_SCSI_PROC_FS
758 	remove_proc_entry("scsi/device_info", NULL);
759 #endif
760 
761 	scsi_dev_info_remove_list(SCSI_DEVINFO_GLOBAL);
762 }
763 
764 /**
765  * scsi_dev_info_add_list - add a new devinfo list
766  * @key:	key of the list to add
767  * @name:	Name of the list to add (for /proc/scsi/device_info)
768  *
769  * Adds the requested list, returns zero on success, -EEXIST if the
770  * key is already registered to a list, or other error on failure.
771  */
772 int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name)
773 {
774 	struct scsi_dev_info_list_table *devinfo_table =
775 		scsi_devinfo_lookup_by_key(key);
776 
777 	if (!IS_ERR(devinfo_table))
778 		/* list already exists */
779 		return -EEXIST;
780 
781 	devinfo_table = kmalloc(sizeof(*devinfo_table), GFP_KERNEL);
782 
783 	if (!devinfo_table)
784 		return -ENOMEM;
785 
786 	INIT_LIST_HEAD(&devinfo_table->node);
787 	INIT_LIST_HEAD(&devinfo_table->scsi_dev_info_list);
788 	devinfo_table->name = name;
789 	devinfo_table->key = key;
790 	list_add_tail(&devinfo_table->node, &scsi_dev_info_list);
791 
792 	return 0;
793 }
794 EXPORT_SYMBOL(scsi_dev_info_add_list);
795 
796 /**
797  * scsi_dev_info_remove_list - destroy an added devinfo list
798  * @key: key of the list to destroy
799  *
800  * Iterates over the entire list first, freeing all the values, then
801  * frees the list itself.  Returns 0 on success or -EINVAL if the key
802  * can't be found.
803  */
804 int scsi_dev_info_remove_list(enum scsi_devinfo_key key)
805 {
806 	struct list_head *lh, *lh_next;
807 	struct scsi_dev_info_list_table *devinfo_table =
808 		scsi_devinfo_lookup_by_key(key);
809 
810 	if (IS_ERR(devinfo_table))
811 		/* no such list */
812 		return -EINVAL;
813 
814 	/* remove from the master list */
815 	list_del(&devinfo_table->node);
816 
817 	list_for_each_safe(lh, lh_next, &devinfo_table->scsi_dev_info_list) {
818 		struct scsi_dev_info_list *devinfo;
819 
820 		devinfo = list_entry(lh, struct scsi_dev_info_list,
821 				     dev_info_list);
822 		kfree(devinfo);
823 	}
824 	kfree(devinfo_table);
825 
826 	return 0;
827 }
828 EXPORT_SYMBOL(scsi_dev_info_remove_list);
829 
830 /**
831  * scsi_init_devinfo - set up the dynamic device list.
832  *
833  * Description:
834  *	Add command line entries from scsi_dev_flags, then add
835  *	scsi_static_device_list entries to the scsi device info list.
836  */
837 int __init scsi_init_devinfo(void)
838 {
839 #ifdef CONFIG_SCSI_PROC_FS
840 	struct proc_dir_entry *p;
841 #endif
842 	int error, i;
843 
844 	error = scsi_dev_info_add_list(SCSI_DEVINFO_GLOBAL, NULL);
845 	if (error)
846 		return error;
847 
848 	error = scsi_dev_info_list_add_str(scsi_dev_flags);
849 	if (error)
850 		goto out;
851 
852 	for (i = 0; scsi_static_device_list[i].vendor; i++) {
853 		error = scsi_dev_info_list_add(1 /* compatibile */,
854 				scsi_static_device_list[i].vendor,
855 				scsi_static_device_list[i].model,
856 				NULL,
857 				scsi_static_device_list[i].flags);
858 		if (error)
859 			goto out;
860 	}
861 
862 #ifdef CONFIG_SCSI_PROC_FS
863 	p = proc_create("scsi/device_info", 0, NULL, &scsi_devinfo_proc_fops);
864 	if (!p) {
865 		error = -ENOMEM;
866 		goto out;
867 	}
868 #endif /* CONFIG_SCSI_PROC_FS */
869 
870  out:
871 	if (error)
872 		scsi_exit_devinfo();
873 	return error;
874 }
875