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