xref: /openbmc/linux/drivers/scsi/scsi_devinfo.c (revision 2cf1c348)
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 |
165 	 BLIST_REPORTLUN2 | BLIST_RETRY_ITF},
166 	{"EMULEX", "MD21/S2     ESDI", NULL, BLIST_SINGLELUN},
167 	{"easyRAID", "16P", NULL, BLIST_NOREPORTLUN},
168 	{"easyRAID", "X6P", NULL, BLIST_NOREPORTLUN},
169 	{"easyRAID", "F8", NULL, BLIST_NOREPORTLUN},
170 	{"FSC", "CentricStor", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
171 	{"FUJITSU", "ETERNUS_DXM", "*", BLIST_RETRY_ASC_C1},
172 	{"Generic", "USB SD Reader", "1.00", BLIST_FORCELUN | BLIST_INQUIRY_36},
173 	{"Generic", "USB Storage-SMC", NULL, BLIST_FORCELUN | BLIST_INQUIRY_36}, /* FW: 0180 and 0207 */
174 	{"Generic", "Ultra HS-SD/MMC", "2.09", BLIST_IGN_MEDIA_CHANGE | BLIST_INQUIRY_36},
175 	{"HITACHI", "DF400", "*", BLIST_REPORTLUN2},
176 	{"HITACHI", "DF500", "*", BLIST_REPORTLUN2},
177 	{"HITACHI", "DISK-SUBSYSTEM", "*", BLIST_REPORTLUN2},
178 	{"HITACHI", "HUS1530", "*", BLIST_NO_DIF},
179 	{"HITACHI", "OPEN-", "*", BLIST_REPORTLUN2 | BLIST_TRY_VPD_PAGES},
180 	{"HP", "A6189A", NULL, BLIST_SPARSELUN | BLIST_LARGELUN},	/* HP VA7400 */
181 	{"HP", "OPEN-", "*", BLIST_REPORTLUN2 | BLIST_TRY_VPD_PAGES}, /* HP XP Arrays */
182 	{"HP", "NetRAID-4M", NULL, BLIST_FORCELUN},
183 	{"HP", "HSV100", NULL, BLIST_REPORTLUN2 | BLIST_NOSTARTONADD},
184 	{"HP", "C1557A", NULL, BLIST_FORCELUN},
185 	{"HP", "C3323-300", "4269", BLIST_NOTQ},
186 	{"HP", "C5713A", NULL, BLIST_NOREPORTLUN},
187 	{"HP", "DISK-SUBSYSTEM", "*", BLIST_REPORTLUN2},
188 	{"HPE", "OPEN-", "*", BLIST_REPORTLUN2 | BLIST_TRY_VPD_PAGES},
189 	{"IBM", "AuSaV1S2", NULL, BLIST_FORCELUN},
190 	{"IBM", "ProFibre 4000R", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
191 	{"IBM", "2105", NULL, BLIST_RETRY_HWERROR},
192 	{"iomega", "jaz 1GB", "J.86", BLIST_NOTQ | BLIST_NOLUN},
193 	{"IOMEGA", "ZIP", NULL, BLIST_NOTQ | BLIST_NOLUN},
194 	{"IOMEGA", "Io20S         *F", NULL, BLIST_KEY},
195 	{"INSITE", "Floptical   F*8I", NULL, BLIST_KEY},
196 	{"INSITE", "I325VM", NULL, BLIST_KEY},
197 	{"Intel", "Multi-Flex", NULL, BLIST_NO_RSOC},
198 	{"iRiver", "iFP Mass Driver", NULL, BLIST_NOT_LOCKABLE | BLIST_INQUIRY_36},
199 	{"LASOUND", "CDX7405", "3.10", BLIST_MAX5LUN | BLIST_SINGLELUN},
200 	{"Marvell", "Console", NULL, BLIST_SKIP_VPD_PAGES},
201 	{"Marvell", "91xx Config", "1.01", BLIST_SKIP_VPD_PAGES},
202 	{"MATSHITA", "PD-1", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
203 	{"MATSHITA", "DMC-LC5", NULL, BLIST_NOT_LOCKABLE | BLIST_INQUIRY_36},
204 	{"MATSHITA", "DMC-LC40", NULL, BLIST_NOT_LOCKABLE | BLIST_INQUIRY_36},
205 	{"Medion", "Flash XL  MMC/SD", "2.6D", BLIST_FORCELUN},
206 	{"MegaRAID", "LD", NULL, BLIST_FORCELUN},
207 	{"MICROP", "4110", NULL, BLIST_NOTQ},
208 	{"MSFT", "Virtual HD", NULL, BLIST_MAX_1024 | BLIST_NO_RSOC},
209 	{"MYLEX", "DACARMRB", "*", BLIST_REPORTLUN2},
210 	{"nCipher", "Fastness Crypto", NULL, BLIST_FORCELUN},
211 	{"NAKAMICH", "MJ-4.8S", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
212 	{"NAKAMICH", "MJ-5.16S", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
213 	{"NEC", "PD-1 ODX654P", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
214 	{"NEC", "iStorage", NULL, BLIST_REPORTLUN2},
215 	{"NRC", "MBR-7", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
216 	{"NRC", "MBR-7.4", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
217 	{"PIONEER", "CD-ROM DRM-600", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
218 	{"PIONEER", "CD-ROM DRM-602X", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
219 	{"PIONEER", "CD-ROM DRM-604X", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
220 	{"PIONEER", "CD-ROM DRM-624X", NULL, BLIST_FORCELUN | BLIST_SINGLELUN},
221 	{"Promise", "VTrak E610f", NULL, BLIST_SPARSELUN | BLIST_NO_RSOC},
222 	{"Promise", "", NULL, BLIST_SPARSELUN},
223 	{"QEMU", "QEMU CD-ROM", NULL, BLIST_SKIP_VPD_PAGES},
224 	{"QNAP", "iSCSI Storage", NULL, BLIST_MAX_1024},
225 	{"SYNOLOGY", "iSCSI Storage", NULL, BLIST_MAX_1024},
226 	{"QUANTUM", "XP34301", "1071", BLIST_NOTQ},
227 	{"REGAL", "CDC-4X", NULL, BLIST_MAX5LUN | BLIST_SINGLELUN},
228 	{"SanDisk", "ImageMate CF-SD1", NULL, BLIST_FORCELUN},
229 	{"SEAGATE", "ST34555N", "0930", BLIST_NOTQ},	/* Chokes on tagged INQUIRY */
230 	{"SEAGATE", "ST3390N", "9546", BLIST_NOTQ},
231 	{"SEAGATE", "ST900MM0006", NULL, BLIST_SKIP_VPD_PAGES},
232 	{"SGI", "RAID3", "*", BLIST_SPARSELUN},
233 	{"SGI", "RAID5", "*", BLIST_SPARSELUN},
234 	{"SGI", "TP9100", "*", BLIST_REPORTLUN2},
235 	{"SGI", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
236 	{"IBM", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
237 	{"SUN", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
238 	{"DELL", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
239 	{"STK", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
240 	{"NETAPP", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
241 	{"LSI", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
242 	{"ENGENIO", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
243 	{"LENOVO", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
244 	{"FUJITSU", "Universal Xport", "*", BLIST_NO_ULD_ATTACH},
245 	{"SanDisk", "Cruzer Blade", NULL, BLIST_TRY_VPD_PAGES |
246 		BLIST_INQUIRY_36},
247 	{"SMSC", "USB 2 HS-CF", NULL, BLIST_SPARSELUN | BLIST_INQUIRY_36},
248 	{"SONY", "CD-ROM CDU-8001", NULL, BLIST_BORKEN},
249 	{"SONY", "TSL", NULL, BLIST_FORCELUN},		/* DDS3 & DDS4 autoloaders */
250 	{"ST650211", "CF", NULL, BLIST_RETRY_HWERROR},
251 	{"SUN", "T300", "*", BLIST_SPARSELUN},
252 	{"SUN", "T4", "*", BLIST_SPARSELUN},
253 	{"Tornado-", "F4", "*", BLIST_NOREPORTLUN},
254 	{"TOSHIBA", "CDROM", NULL, BLIST_ISROM},
255 	{"TOSHIBA", "CD-ROM", NULL, BLIST_ISROM},
256 	{"Traxdata", "CDR4120", NULL, BLIST_NOLUN},	/* locks up */
257 	{"USB2.0", "SMARTMEDIA/XD", NULL, BLIST_FORCELUN | BLIST_INQUIRY_36},
258 	{"WangDAT", "Model 2600", "01.7", BLIST_SELECT_NO_ATN},
259 	{"WangDAT", "Model 3200", "02.2", BLIST_SELECT_NO_ATN},
260 	{"WangDAT", "Model 1300", "02.4", BLIST_SELECT_NO_ATN},
261 	{"WDC WD25", "00JB-00FUA0", NULL, BLIST_NOREPORTLUN},
262 	{"XYRATEX", "RS", "*", BLIST_SPARSELUN | BLIST_LARGELUN},
263 	{"Zzyzx", "RocketStor 500S", NULL, BLIST_SPARSELUN},
264 	{"Zzyzx", "RocketStor 2000", NULL, BLIST_SPARSELUN},
265 	{ NULL, NULL, NULL, 0 },
266 };
267 
268 static struct scsi_dev_info_list_table *scsi_devinfo_lookup_by_key(int key)
269 {
270 	struct scsi_dev_info_list_table *devinfo_table;
271 	int found = 0;
272 
273 	list_for_each_entry(devinfo_table, &scsi_dev_info_list, node)
274 		if (devinfo_table->key == key) {
275 			found = 1;
276 			break;
277 		}
278 	if (!found)
279 		return ERR_PTR(-EINVAL);
280 
281 	return devinfo_table;
282 }
283 
284 /*
285  * scsi_strcpy_devinfo: called from scsi_dev_info_list_add to copy into
286  * devinfo vendor and model strings.
287  */
288 static void scsi_strcpy_devinfo(char *name, char *to, size_t to_length,
289 				char *from, int compatible)
290 {
291 	size_t from_length;
292 
293 	from_length = strlen(from);
294 	/* This zero-pads the destination */
295 	strncpy(to, from, to_length);
296 	if (from_length < to_length && !compatible) {
297 		/*
298 		 * space pad the string if it is short.
299 		 */
300 		memset(&to[from_length], ' ', to_length - from_length);
301 	}
302 	if (from_length > to_length)
303 		 printk(KERN_WARNING "%s: %s string '%s' is too long\n",
304 			__func__, name, from);
305 }
306 
307 /**
308  * scsi_dev_info_list_add - add one dev_info list entry.
309  * @compatible: if true, null terminate short strings.  Otherwise space pad.
310  * @vendor:	vendor string
311  * @model:	model (product) string
312  * @strflags:	integer string
313  * @flags:	if strflags NULL, use this flag value
314  *
315  * Description:
316  *	Create and add one dev_info entry for @vendor, @model, @strflags or
317  *	@flag. If @compatible, add to the tail of the list, do not space
318  *	pad, and set devinfo->compatible. The scsi_static_device_list entries
319  *	are added with @compatible 1 and @clfags NULL.
320  *
321  * Returns: 0 OK, -error on failure.
322  **/
323 static int scsi_dev_info_list_add(int compatible, char *vendor, char *model,
324 			    char *strflags, blist_flags_t flags)
325 {
326 	return scsi_dev_info_list_add_keyed(compatible, vendor, model,
327 					    strflags, flags,
328 					    SCSI_DEVINFO_GLOBAL);
329 }
330 
331 /**
332  * scsi_dev_info_list_add_keyed - add one dev_info list entry.
333  * @compatible: if true, null terminate short strings.  Otherwise space pad.
334  * @vendor:	vendor string
335  * @model:	model (product) string
336  * @strflags:	integer string
337  * @flags:	if strflags NULL, use this flag value
338  * @key:	specify list to use
339  *
340  * Description:
341  *	Create and add one dev_info entry for @vendor, @model,
342  *	@strflags or @flag in list specified by @key. If @compatible,
343  *	add to the tail of the list, do not space pad, and set
344  *	devinfo->compatible. The scsi_static_device_list entries are
345  *	added with @compatible 1 and @clfags NULL.
346  *
347  * Returns: 0 OK, -error on failure.
348  **/
349 int scsi_dev_info_list_add_keyed(int compatible, char *vendor, char *model,
350 				 char *strflags, blist_flags_t flags,
351 				 enum scsi_devinfo_key key)
352 {
353 	struct scsi_dev_info_list *devinfo;
354 	struct scsi_dev_info_list_table *devinfo_table =
355 		scsi_devinfo_lookup_by_key(key);
356 
357 	if (IS_ERR(devinfo_table))
358 		return PTR_ERR(devinfo_table);
359 
360 	devinfo = kmalloc(sizeof(*devinfo), GFP_KERNEL);
361 	if (!devinfo) {
362 		printk(KERN_ERR "%s: no memory\n", __func__);
363 		return -ENOMEM;
364 	}
365 
366 	scsi_strcpy_devinfo("vendor", devinfo->vendor, sizeof(devinfo->vendor),
367 			    vendor, compatible);
368 	scsi_strcpy_devinfo("model", devinfo->model, sizeof(devinfo->model),
369 			    model, compatible);
370 
371 	if (strflags) {
372 		unsigned long long val;
373 		int ret = kstrtoull(strflags, 0, &val);
374 
375 		if (ret != 0) {
376 			kfree(devinfo);
377 			return ret;
378 		}
379 		flags = (__force blist_flags_t)val;
380 	}
381 	if (flags & __BLIST_UNUSED_MASK) {
382 		pr_err("scsi_devinfo (%s:%s): unsupported flags 0x%llx",
383 		       vendor, model, flags & __BLIST_UNUSED_MASK);
384 		kfree(devinfo);
385 		return -EINVAL;
386 	}
387 	devinfo->flags = flags;
388 	devinfo->compatible = compatible;
389 
390 	if (compatible)
391 		list_add_tail(&devinfo->dev_info_list,
392 			      &devinfo_table->scsi_dev_info_list);
393 	else
394 		list_add(&devinfo->dev_info_list,
395 			 &devinfo_table->scsi_dev_info_list);
396 
397 	return 0;
398 }
399 EXPORT_SYMBOL(scsi_dev_info_list_add_keyed);
400 
401 /**
402  * scsi_dev_info_list_find - find a matching dev_info list entry.
403  * @vendor:	full vendor string
404  * @model:	full model (product) string
405  * @key:	specify list to use
406  *
407  * Description:
408  *	Finds the first dev_info entry matching @vendor, @model
409  *	in list specified by @key.
410  *
411  * Returns: pointer to matching entry, or ERR_PTR on failure.
412  **/
413 static struct scsi_dev_info_list *scsi_dev_info_list_find(const char *vendor,
414 		const char *model, enum scsi_devinfo_key key)
415 {
416 	struct scsi_dev_info_list *devinfo;
417 	struct scsi_dev_info_list_table *devinfo_table =
418 		scsi_devinfo_lookup_by_key(key);
419 	size_t vmax, mmax, mlen;
420 	const char *vskip, *mskip;
421 
422 	if (IS_ERR(devinfo_table))
423 		return (struct scsi_dev_info_list *) devinfo_table;
424 
425 	/* Prepare for "compatible" matches */
426 
427 	/*
428 	 * XXX why skip leading spaces? If an odd INQUIRY
429 	 * value, that should have been part of the
430 	 * scsi_static_device_list[] entry, such as "  FOO"
431 	 * rather than "FOO". Since this code is already
432 	 * here, and we don't know what device it is
433 	 * trying to work with, leave it as-is.
434 	 */
435 	vmax = sizeof(devinfo->vendor);
436 	vskip = vendor;
437 	while (vmax > 0 && *vskip == ' ') {
438 		vmax--;
439 		vskip++;
440 	}
441 	/* Also skip trailing spaces */
442 	while (vmax > 0 && vskip[vmax - 1] == ' ')
443 		--vmax;
444 
445 	mmax = sizeof(devinfo->model);
446 	mskip = model;
447 	while (mmax > 0 && *mskip == ' ') {
448 		mmax--;
449 		mskip++;
450 	}
451 	while (mmax > 0 && mskip[mmax - 1] == ' ')
452 		--mmax;
453 
454 	list_for_each_entry(devinfo, &devinfo_table->scsi_dev_info_list,
455 			    dev_info_list) {
456 		if (devinfo->compatible) {
457 			/*
458 			 * vendor strings must be an exact match
459 			 */
460 			if (vmax != strnlen(devinfo->vendor,
461 					    sizeof(devinfo->vendor)) ||
462 			    memcmp(devinfo->vendor, vskip, vmax))
463 				continue;
464 
465 			/*
466 			 * @model specifies the full string, and
467 			 * must be larger or equal to devinfo->model
468 			 */
469 			mlen = strnlen(devinfo->model, sizeof(devinfo->model));
470 			if (mmax < mlen || memcmp(devinfo->model, mskip, mlen))
471 				continue;
472 			return devinfo;
473 		} else {
474 			if (!memcmp(devinfo->vendor, vendor,
475 				    sizeof(devinfo->vendor)) &&
476 			    !memcmp(devinfo->model, model,
477 				    sizeof(devinfo->model)))
478 				return devinfo;
479 		}
480 	}
481 
482 	return ERR_PTR(-ENOENT);
483 }
484 
485 /**
486  * scsi_dev_info_list_del_keyed - remove one dev_info list entry.
487  * @vendor:	vendor string
488  * @model:	model (product) string
489  * @key:	specify list to use
490  *
491  * Description:
492  *	Remove and destroy one dev_info entry for @vendor, @model
493  *	in list specified by @key.
494  *
495  * Returns: 0 OK, -error on failure.
496  **/
497 int scsi_dev_info_list_del_keyed(char *vendor, char *model,
498 				 enum scsi_devinfo_key key)
499 {
500 	struct scsi_dev_info_list *found;
501 
502 	found = scsi_dev_info_list_find(vendor, model, key);
503 	if (IS_ERR(found))
504 		return PTR_ERR(found);
505 
506 	list_del(&found->dev_info_list);
507 	kfree(found);
508 	return 0;
509 }
510 EXPORT_SYMBOL(scsi_dev_info_list_del_keyed);
511 
512 /**
513  * scsi_dev_info_list_add_str - parse dev_list and add to the scsi_dev_info_list.
514  * @dev_list:	string of device flags to add
515  *
516  * Description:
517  *	Parse dev_list, and add entries to the scsi_dev_info_list.
518  *	dev_list is of the form "vendor:product:flag,vendor:product:flag".
519  *	dev_list is modified via strsep. Can be called for command line
520  *	addition, for proc or mabye a sysfs interface.
521  *
522  * Returns: 0 if OK, -error on failure.
523  **/
524 static int scsi_dev_info_list_add_str(char *dev_list)
525 {
526 	char *vendor, *model, *strflags, *next;
527 	char *next_check;
528 	int res = 0;
529 
530 	next = dev_list;
531 	if (next && next[0] == '"') {
532 		/*
533 		 * Ignore both the leading and trailing quote.
534 		 */
535 		next++;
536 		next_check = ",\"";
537 	} else {
538 		next_check = ",";
539 	}
540 
541 	/*
542 	 * For the leading and trailing '"' case, the for loop comes
543 	 * through the last time with vendor[0] == '\0'.
544 	 */
545 	for (vendor = strsep(&next, ":"); vendor && (vendor[0] != '\0')
546 	     && (res == 0); vendor = strsep(&next, ":")) {
547 		strflags = NULL;
548 		model = strsep(&next, ":");
549 		if (model)
550 			strflags = strsep(&next, next_check);
551 		if (!model || !strflags) {
552 			printk(KERN_ERR "%s: bad dev info string '%s' '%s'"
553 			       " '%s'\n", __func__, vendor, model,
554 			       strflags);
555 			res = -EINVAL;
556 		} else
557 			res = scsi_dev_info_list_add(0 /* compatible */, vendor,
558 						     model, strflags, 0);
559 	}
560 	return res;
561 }
562 
563 /**
564  * scsi_get_device_flags - get device specific flags from the dynamic
565  *	device list.
566  * @sdev:       &scsi_device to get flags for
567  * @vendor:	vendor name
568  * @model:	model name
569  *
570  * Description:
571  *     Search the global scsi_dev_info_list (specified by list zero)
572  *     for an entry matching @vendor and @model, if found, return the
573  *     matching flags value, else return the host or global default
574  *     settings.  Called during scan time.
575  **/
576 blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
577 				    const unsigned char *vendor,
578 				    const unsigned char *model)
579 {
580 	return scsi_get_device_flags_keyed(sdev, vendor, model,
581 					   SCSI_DEVINFO_GLOBAL);
582 }
583 
584 
585 /**
586  * scsi_get_device_flags_keyed - get device specific flags from the dynamic device list
587  * @sdev:       &scsi_device to get flags for
588  * @vendor:	vendor name
589  * @model:	model name
590  * @key:	list to look up
591  *
592  * Description:
593  *     Search the scsi_dev_info_list specified by @key for an entry
594  *     matching @vendor and @model, if found, return the matching
595  *     flags value, else return the host or global default settings.
596  *     Called during scan time.
597  **/
598 blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
599 				const unsigned char *vendor,
600 				const unsigned char *model,
601 				enum scsi_devinfo_key key)
602 {
603 	struct scsi_dev_info_list *devinfo;
604 
605 	devinfo = scsi_dev_info_list_find(vendor, model, key);
606 	if (!IS_ERR(devinfo))
607 		return devinfo->flags;
608 
609 	/* key or device not found: return nothing */
610 	if (key != SCSI_DEVINFO_GLOBAL)
611 		return 0;
612 
613 	/* except for the global list, where we have an exception */
614 	if (sdev->sdev_bflags)
615 		return sdev->sdev_bflags;
616 
617 	return scsi_default_dev_flags;
618 }
619 EXPORT_SYMBOL(scsi_get_device_flags_keyed);
620 
621 #ifdef CONFIG_SCSI_PROC_FS
622 struct double_list {
623 	struct list_head *top;
624 	struct list_head *bottom;
625 };
626 
627 static int devinfo_seq_show(struct seq_file *m, void *v)
628 {
629 	struct double_list *dl = v;
630 	struct scsi_dev_info_list_table *devinfo_table =
631 		list_entry(dl->top, struct scsi_dev_info_list_table, node);
632 	struct scsi_dev_info_list *devinfo =
633 		list_entry(dl->bottom, struct scsi_dev_info_list,
634 			   dev_info_list);
635 
636 	if (devinfo_table->scsi_dev_info_list.next == dl->bottom &&
637 	    devinfo_table->name)
638 		seq_printf(m, "[%s]:\n", devinfo_table->name);
639 
640 	seq_printf(m, "'%.8s' '%.16s' 0x%llx\n",
641 		   devinfo->vendor, devinfo->model, devinfo->flags);
642 	return 0;
643 }
644 
645 static void *devinfo_seq_start(struct seq_file *m, loff_t *ppos)
646 {
647 	struct double_list *dl = kmalloc(sizeof(*dl), GFP_KERNEL);
648 	loff_t pos = *ppos;
649 
650 	if (!dl)
651 		return NULL;
652 
653 	list_for_each(dl->top, &scsi_dev_info_list) {
654 		struct scsi_dev_info_list_table *devinfo_table =
655 			list_entry(dl->top, struct scsi_dev_info_list_table,
656 				   node);
657 		list_for_each(dl->bottom, &devinfo_table->scsi_dev_info_list)
658 			if (pos-- == 0)
659 				return dl;
660 	}
661 
662 	kfree(dl);
663 	return NULL;
664 }
665 
666 static void *devinfo_seq_next(struct seq_file *m, void *v, loff_t *ppos)
667 {
668 	struct double_list *dl = v;
669 	struct scsi_dev_info_list_table *devinfo_table =
670 		list_entry(dl->top, struct scsi_dev_info_list_table, node);
671 
672 	++*ppos;
673 	dl->bottom = dl->bottom->next;
674 	while (&devinfo_table->scsi_dev_info_list == dl->bottom) {
675 		dl->top = dl->top->next;
676 		if (dl->top == &scsi_dev_info_list) {
677 			kfree(dl);
678 			return NULL;
679 		}
680 		devinfo_table = list_entry(dl->top,
681 					   struct scsi_dev_info_list_table,
682 					   node);
683 		dl->bottom = devinfo_table->scsi_dev_info_list.next;
684 	}
685 
686 	return dl;
687 }
688 
689 static void devinfo_seq_stop(struct seq_file *m, void *v)
690 {
691 	kfree(v);
692 }
693 
694 static const struct seq_operations scsi_devinfo_seq_ops = {
695 	.start	= devinfo_seq_start,
696 	.next	= devinfo_seq_next,
697 	.stop	= devinfo_seq_stop,
698 	.show	= devinfo_seq_show,
699 };
700 
701 static int proc_scsi_devinfo_open(struct inode *inode, struct file *file)
702 {
703 	return seq_open(file, &scsi_devinfo_seq_ops);
704 }
705 
706 /*
707  * proc_scsi_dev_info_write - allow additions to scsi_dev_info_list via /proc.
708  *
709  * Description: Adds a black/white list entry for vendor and model with an
710  * integer value of flag to the scsi device info list.
711  * To use, echo "vendor:model:flag" > /proc/scsi/device_info
712  */
713 static ssize_t proc_scsi_devinfo_write(struct file *file,
714 				       const char __user *buf,
715 				       size_t length, loff_t *ppos)
716 {
717 	char *buffer;
718 	ssize_t err = length;
719 
720 	if (!buf || length>PAGE_SIZE)
721 		return -EINVAL;
722 	if (!(buffer = (char *) __get_free_page(GFP_KERNEL)))
723 		return -ENOMEM;
724 	if (copy_from_user(buffer, buf, length)) {
725 		err =-EFAULT;
726 		goto out;
727 	}
728 
729 	if (length < PAGE_SIZE)
730 		buffer[length] = '\0';
731 	else if (buffer[PAGE_SIZE-1]) {
732 		err = -EINVAL;
733 		goto out;
734 	}
735 
736 	scsi_dev_info_list_add_str(buffer);
737 
738 out:
739 	free_page((unsigned long)buffer);
740 	return err;
741 }
742 
743 static const struct proc_ops scsi_devinfo_proc_ops = {
744 	.proc_open	= proc_scsi_devinfo_open,
745 	.proc_read	= seq_read,
746 	.proc_write	= proc_scsi_devinfo_write,
747 	.proc_lseek	= seq_lseek,
748 	.proc_release	= seq_release,
749 };
750 #endif /* CONFIG_SCSI_PROC_FS */
751 
752 module_param_string(dev_flags, scsi_dev_flags, sizeof(scsi_dev_flags), 0);
753 MODULE_PARM_DESC(dev_flags,
754 	 "Given scsi_dev_flags=vendor:model:flags[,v:m:f] add black/white"
755 	 " list entries for vendor and model with an integer value of flags"
756 	 " to the scsi device info list");
757 
758 module_param_named(default_dev_flags, scsi_default_dev_flags, ullong, 0644);
759 MODULE_PARM_DESC(default_dev_flags,
760 		 "scsi default device flag uint64_t value");
761 
762 /**
763  * scsi_exit_devinfo - remove /proc/scsi/device_info & the scsi_dev_info_list
764  **/
765 void scsi_exit_devinfo(void)
766 {
767 #ifdef CONFIG_SCSI_PROC_FS
768 	remove_proc_entry("scsi/device_info", NULL);
769 #endif
770 
771 	scsi_dev_info_remove_list(SCSI_DEVINFO_GLOBAL);
772 }
773 
774 /**
775  * scsi_dev_info_add_list - add a new devinfo list
776  * @key:	key of the list to add
777  * @name:	Name of the list to add (for /proc/scsi/device_info)
778  *
779  * Adds the requested list, returns zero on success, -EEXIST if the
780  * key is already registered to a list, or other error on failure.
781  */
782 int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name)
783 {
784 	struct scsi_dev_info_list_table *devinfo_table =
785 		scsi_devinfo_lookup_by_key(key);
786 
787 	if (!IS_ERR(devinfo_table))
788 		/* list already exists */
789 		return -EEXIST;
790 
791 	devinfo_table = kmalloc(sizeof(*devinfo_table), GFP_KERNEL);
792 
793 	if (!devinfo_table)
794 		return -ENOMEM;
795 
796 	INIT_LIST_HEAD(&devinfo_table->node);
797 	INIT_LIST_HEAD(&devinfo_table->scsi_dev_info_list);
798 	devinfo_table->name = name;
799 	devinfo_table->key = key;
800 	list_add_tail(&devinfo_table->node, &scsi_dev_info_list);
801 
802 	return 0;
803 }
804 EXPORT_SYMBOL(scsi_dev_info_add_list);
805 
806 /**
807  * scsi_dev_info_remove_list - destroy an added devinfo list
808  * @key: key of the list to destroy
809  *
810  * Iterates over the entire list first, freeing all the values, then
811  * frees the list itself.  Returns 0 on success or -EINVAL if the key
812  * can't be found.
813  */
814 int scsi_dev_info_remove_list(enum scsi_devinfo_key key)
815 {
816 	struct list_head *lh, *lh_next;
817 	struct scsi_dev_info_list_table *devinfo_table =
818 		scsi_devinfo_lookup_by_key(key);
819 
820 	if (IS_ERR(devinfo_table))
821 		/* no such list */
822 		return -EINVAL;
823 
824 	/* remove from the master list */
825 	list_del(&devinfo_table->node);
826 
827 	list_for_each_safe(lh, lh_next, &devinfo_table->scsi_dev_info_list) {
828 		struct scsi_dev_info_list *devinfo;
829 
830 		devinfo = list_entry(lh, struct scsi_dev_info_list,
831 				     dev_info_list);
832 		kfree(devinfo);
833 	}
834 	kfree(devinfo_table);
835 
836 	return 0;
837 }
838 EXPORT_SYMBOL(scsi_dev_info_remove_list);
839 
840 /**
841  * scsi_init_devinfo - set up the dynamic device list.
842  *
843  * Description:
844  *	Add command line entries from scsi_dev_flags, then add
845  *	scsi_static_device_list entries to the scsi device info list.
846  */
847 int __init scsi_init_devinfo(void)
848 {
849 #ifdef CONFIG_SCSI_PROC_FS
850 	struct proc_dir_entry *p;
851 #endif
852 	int error, i;
853 
854 	error = scsi_dev_info_add_list(SCSI_DEVINFO_GLOBAL, NULL);
855 	if (error)
856 		return error;
857 
858 	error = scsi_dev_info_list_add_str(scsi_dev_flags);
859 	if (error)
860 		goto out;
861 
862 	for (i = 0; scsi_static_device_list[i].vendor; i++) {
863 		error = scsi_dev_info_list_add(1 /* compatibile */,
864 				scsi_static_device_list[i].vendor,
865 				scsi_static_device_list[i].model,
866 				NULL,
867 				scsi_static_device_list[i].flags);
868 		if (error)
869 			goto out;
870 	}
871 
872 #ifdef CONFIG_SCSI_PROC_FS
873 	p = proc_create("scsi/device_info", 0, NULL, &scsi_devinfo_proc_ops);
874 	if (!p) {
875 		error = -ENOMEM;
876 		goto out;
877 	}
878 #endif /* CONFIG_SCSI_PROC_FS */
879 
880  out:
881 	if (error)
882 		scsi_exit_devinfo();
883 	return error;
884 }
885