ses.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * SCSI Enclosure Services
  4 *
  5 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
  6 */
  7
  8#include <linux/slab.h>
  9#include <linux/module.h>
 10#include <linux/kernel.h>
 11#include <linux/enclosure.h>
 12#include <linux/unaligned.h>
 13
 14#include <scsi/scsi.h>
 15#include <scsi/scsi_cmnd.h>
 16#include <scsi/scsi_dbg.h>
 17#include <scsi/scsi_device.h>
 18#include <scsi/scsi_driver.h>
 19#include <scsi/scsi_host.h>
 20
 21#include <scsi/scsi_transport_sas.h>
 22
 23struct ses_device {
 24	unsigned char *page1;
 25	unsigned char *page1_types;
 26	unsigned char *page2;
 27	unsigned char *page10;
 28	short page1_len;
 29	short page1_num_types;
 30	short page2_len;
 31	short page10_len;
 32};
 33
 34struct ses_component {
 35	u64 addr;
 36};
 37
 38static bool ses_page2_supported(struct enclosure_device *edev)
 39{
 40	struct ses_device *ses_dev = edev->scratch;
 41
 42	return (ses_dev->page2 != NULL);
 43}
 44
 45static int ses_probe(struct device *dev)
 46{
 47	struct scsi_device *sdev = to_scsi_device(dev);
 48	int err = -ENODEV;
 49
 50	if (sdev->type != TYPE_ENCLOSURE)
 51		goto out;
 52
 53	err = 0;
 54	sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
 55
 56 out:
 57	return err;
 58}
 59
 60#define SES_TIMEOUT (30 * HZ)
 61#define SES_RETRIES 3
 62
 63static void init_device_slot_control(unsigned char *dest_desc,
 64				     struct enclosure_component *ecomp,
 65				     unsigned char *status)
 66{
 67	memcpy(dest_desc, status, 4);
 68	dest_desc[0] = 0;
 69	/* only clear byte 1 for ENCLOSURE_COMPONENT_DEVICE */
 70	if (ecomp->type == ENCLOSURE_COMPONENT_DEVICE)
 71		dest_desc[1] = 0;
 72	dest_desc[2] &= 0xde;
 73	dest_desc[3] &= 0x3c;
 74}
 75
 76
 77static int ses_recv_diag(struct scsi_device *sdev, int page_code,
 78			 void *buf, int bufflen)
 79{
 80	int ret;
 81	unsigned char cmd[] = {
 82		RECEIVE_DIAGNOSTIC,
 83		1,		/* Set PCV bit */
 84		page_code,
 85		bufflen >> 8,
 86		bufflen & 0xff,
 87		0
 88	};
 89	unsigned char recv_page_code;
 90	struct scsi_failure failure_defs[] = {
 91		{
 92			.sense = UNIT_ATTENTION,
 93			.asc = 0x29,
 94			.ascq = SCMD_FAILURE_ASCQ_ANY,
 95			.allowed = SES_RETRIES,
 96			.result = SAM_STAT_CHECK_CONDITION,
 97		},
 98		{
 99			.sense = NOT_READY,
100			.asc = SCMD_FAILURE_ASC_ANY,
101			.ascq = SCMD_FAILURE_ASCQ_ANY,
102			.allowed = SES_RETRIES,
103			.result = SAM_STAT_CHECK_CONDITION,
104		},
105		{}
106	};
107	struct scsi_failures failures = {
108		.failure_definitions = failure_defs,
109	};
110	const struct scsi_exec_args exec_args = {
111		.failures = &failures,
112	};
113
114	ret = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_IN, buf, bufflen,
115			       SES_TIMEOUT, 1, &exec_args);
116	if (unlikely(ret))
117		return ret;
118
119	recv_page_code = ((unsigned char *)buf)[0];
120
121	if (likely(recv_page_code == page_code))
122		return ret;
123
124	/* successful diagnostic but wrong page code.  This happens to some
125	 * USB devices, just print a message and pretend there was an error */
126
127	sdev_printk(KERN_ERR, sdev,
128		    "Wrong diagnostic page; asked for %d got %u\n",
129		    page_code, recv_page_code);
130
131	return -EINVAL;
132}
133
134static int ses_send_diag(struct scsi_device *sdev, int page_code,
135			 void *buf, int bufflen)
136{
137	int result;
138
139	unsigned char cmd[] = {
140		SEND_DIAGNOSTIC,
141		0x10,		/* Set PF bit */
142		0,
143		bufflen >> 8,
144		bufflen & 0xff,
145		0
146	};
147	struct scsi_failure failure_defs[] = {
148		{
149			.sense = UNIT_ATTENTION,
150			.asc = 0x29,
151			.ascq = SCMD_FAILURE_ASCQ_ANY,
152			.allowed = SES_RETRIES,
153			.result = SAM_STAT_CHECK_CONDITION,
154		},
155		{
156			.sense = NOT_READY,
157			.asc = SCMD_FAILURE_ASC_ANY,
158			.ascq = SCMD_FAILURE_ASCQ_ANY,
159			.allowed = SES_RETRIES,
160			.result = SAM_STAT_CHECK_CONDITION,
161		},
162		{}
163	};
164	struct scsi_failures failures = {
165		.failure_definitions = failure_defs,
166	};
167	const struct scsi_exec_args exec_args = {
168		.failures = &failures,
169	};
170
171	result = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_OUT, buf, bufflen,
172				  SES_TIMEOUT, 1, &exec_args);
173	if (result)
174		sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
175			    result);
176	return result;
177}
178
179static int ses_set_page2_descriptor(struct enclosure_device *edev,
180				      struct enclosure_component *ecomp,
181				      unsigned char *desc)
182{
183	int i, j, count = 0, descriptor = ecomp->number;
184	struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
185	struct ses_device *ses_dev = edev->scratch;
186	unsigned char *type_ptr = ses_dev->page1_types;
187	unsigned char *desc_ptr = ses_dev->page2 + 8;
188
189	/* Clear everything */
190	memset(desc_ptr, 0, ses_dev->page2_len - 8);
191	for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
192		for (j = 0; j < type_ptr[1]; j++) {
193			desc_ptr += 4;
194			if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
195			    type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
196				continue;
197			if (count++ == descriptor) {
198				memcpy(desc_ptr, desc, 4);
199				/* set select */
200				desc_ptr[0] |= 0x80;
201				/* clear reserved, just in case */
202				desc_ptr[0] &= 0xf0;
203			}
204		}
205	}
206
207	return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
208}
209
210static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
211				      struct enclosure_component *ecomp)
212{
213	int i, j, count = 0, descriptor = ecomp->number;
214	struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
215	struct ses_device *ses_dev = edev->scratch;
216	unsigned char *type_ptr = ses_dev->page1_types;
217	unsigned char *desc_ptr = ses_dev->page2 + 8;
218
219	if (ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len))
220		return NULL;
221
222	for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
223		for (j = 0; j < type_ptr[1]; j++) {
224			desc_ptr += 4;
225			if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
226			    type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
227				continue;
228			if (count++ == descriptor)
229				return desc_ptr;
230		}
231	}
232	return NULL;
233}
234
235/* For device slot and array device slot elements, byte 3 bit 6
236 * is "fault sensed" while byte 3 bit 5 is "fault reqstd". As this
237 * code stands these bits are shifted 4 positions right so in
238 * sysfs they will appear as bits 2 and 1 respectively. Strange. */
239static void ses_get_fault(struct enclosure_device *edev,
240			  struct enclosure_component *ecomp)
241{
242	unsigned char *desc;
243
244	if (!ses_page2_supported(edev)) {
245		ecomp->fault = 0;
246		return;
247	}
248	desc = ses_get_page2_descriptor(edev, ecomp);
249	if (desc)
250		ecomp->fault = (desc[3] & 0x60) >> 4;
251}
252
253static int ses_set_fault(struct enclosure_device *edev,
254			  struct enclosure_component *ecomp,
255			 enum enclosure_component_setting val)
256{
257	unsigned char desc[4];
258	unsigned char *desc_ptr;
259
260	if (!ses_page2_supported(edev))
261		return -EINVAL;
262
263	desc_ptr = ses_get_page2_descriptor(edev, ecomp);
264
265	if (!desc_ptr)
266		return -EIO;
267
268	init_device_slot_control(desc, ecomp, desc_ptr);
269
270	switch (val) {
271	case ENCLOSURE_SETTING_DISABLED:
272		desc[3] &= 0xdf;
273		break;
274	case ENCLOSURE_SETTING_ENABLED:
275		desc[3] |= 0x20;
276		break;
277	default:
278		/* SES doesn't do the SGPIO blink settings */
279		return -EINVAL;
280	}
281
282	return ses_set_page2_descriptor(edev, ecomp, desc);
283}
284
285static void ses_get_status(struct enclosure_device *edev,
286			   struct enclosure_component *ecomp)
287{
288	unsigned char *desc;
289
290	if (!ses_page2_supported(edev)) {
291		ecomp->status = 0;
292		return;
293	}
294	desc = ses_get_page2_descriptor(edev, ecomp);
295	if (desc)
296		ecomp->status = (desc[0] & 0x0f);
297}
298
299static void ses_get_locate(struct enclosure_device *edev,
300			   struct enclosure_component *ecomp)
301{
302	unsigned char *desc;
303
304	if (!ses_page2_supported(edev)) {
305		ecomp->locate = 0;
306		return;
307	}
308	desc = ses_get_page2_descriptor(edev, ecomp);
309	if (desc)
310		ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
311}
312
313static int ses_set_locate(struct enclosure_device *edev,
314			  struct enclosure_component *ecomp,
315			  enum enclosure_component_setting val)
316{
317	unsigned char desc[4];
318	unsigned char *desc_ptr;
319
320	if (!ses_page2_supported(edev))
321		return -EINVAL;
322
323	desc_ptr = ses_get_page2_descriptor(edev, ecomp);
324
325	if (!desc_ptr)
326		return -EIO;
327
328	init_device_slot_control(desc, ecomp, desc_ptr);
329
330	switch (val) {
331	case ENCLOSURE_SETTING_DISABLED:
332		desc[2] &= 0xfd;
333		break;
334	case ENCLOSURE_SETTING_ENABLED:
335		desc[2] |= 0x02;
336		break;
337	default:
338		/* SES doesn't do the SGPIO blink settings */
339		return -EINVAL;
340	}
341	return ses_set_page2_descriptor(edev, ecomp, desc);
342}
343
344static int ses_set_active(struct enclosure_device *edev,
345			  struct enclosure_component *ecomp,
346			  enum enclosure_component_setting val)
347{
348	unsigned char desc[4];
349	unsigned char *desc_ptr;
350
351	if (!ses_page2_supported(edev))
352		return -EINVAL;
353
354	desc_ptr = ses_get_page2_descriptor(edev, ecomp);
355
356	if (!desc_ptr)
357		return -EIO;
358
359	init_device_slot_control(desc, ecomp, desc_ptr);
360
361	switch (val) {
362	case ENCLOSURE_SETTING_DISABLED:
363		desc[2] &= 0x7f;
364		ecomp->active = 0;
365		break;
366	case ENCLOSURE_SETTING_ENABLED:
367		desc[2] |= 0x80;
368		ecomp->active = 1;
369		break;
370	default:
371		/* SES doesn't do the SGPIO blink settings */
372		return -EINVAL;
373	}
374	return ses_set_page2_descriptor(edev, ecomp, desc);
375}
376
377static int ses_show_id(struct enclosure_device *edev, char *buf)
378{
379	struct ses_device *ses_dev = edev->scratch;
380	unsigned long long id = get_unaligned_be64(ses_dev->page1+8+4);
381
382	return sprintf(buf, "%#llx\n", id);
383}
384
385static void ses_get_power_status(struct enclosure_device *edev,
386				 struct enclosure_component *ecomp)
387{
388	unsigned char *desc;
389
390	if (!ses_page2_supported(edev)) {
391		ecomp->power_status = 0;
392		return;
393	}
394
395	desc = ses_get_page2_descriptor(edev, ecomp);
396	if (desc)
397		ecomp->power_status = (desc[3] & 0x10) ? 0 : 1;
398}
399
400static int ses_set_power_status(struct enclosure_device *edev,
401				struct enclosure_component *ecomp,
402				int val)
403{
404	unsigned char desc[4];
405	unsigned char *desc_ptr;
406
407	if (!ses_page2_supported(edev))
408		return -EINVAL;
409
410	desc_ptr = ses_get_page2_descriptor(edev, ecomp);
411
412	if (!desc_ptr)
413		return -EIO;
414
415	init_device_slot_control(desc, ecomp, desc_ptr);
416
417	switch (val) {
418	/* power = 1 is device_off = 0 and vice versa */
419	case 0:
420		desc[3] |= 0x10;
421		break;
422	case 1:
423		desc[3] &= 0xef;
424		break;
425	default:
426		return -EINVAL;
427	}
428	ecomp->power_status = val;
429	return ses_set_page2_descriptor(edev, ecomp, desc);
430}
431
432static struct enclosure_component_callbacks ses_enclosure_callbacks = {
433	.get_fault		= ses_get_fault,
434	.set_fault		= ses_set_fault,
435	.get_status		= ses_get_status,
436	.get_locate		= ses_get_locate,
437	.set_locate		= ses_set_locate,
438	.get_power_status	= ses_get_power_status,
439	.set_power_status	= ses_set_power_status,
440	.set_active		= ses_set_active,
441	.show_id		= ses_show_id,
442};
443
444struct ses_host_edev {
445	struct Scsi_Host *shost;
446	struct enclosure_device *edev;
447};
448
449#if 0
450int ses_match_host(struct enclosure_device *edev, void *data)
451{
452	struct ses_host_edev *sed = data;
453	struct scsi_device *sdev;
454
455	if (!scsi_is_sdev_device(edev->edev.parent))
456		return 0;
457
458	sdev = to_scsi_device(edev->edev.parent);
459
460	if (sdev->host != sed->shost)
461		return 0;
462
463	sed->edev = edev;
464	return 1;
465}
466#endif  /*  0  */
467
468static int ses_process_descriptor(struct enclosure_component *ecomp,
469				   unsigned char *desc, int max_desc_len)
470{
471	int eip = desc[0] & 0x10;
472	int invalid = desc[0] & 0x80;
473	enum scsi_protocol proto = desc[0] & 0x0f;
474	u64 addr = 0;
475	int slot = -1;
476	struct ses_component *scomp = ecomp->scratch;
477	unsigned char *d;
478
479	if (invalid)
480		return 0;
481
482	switch (proto) {
483	case SCSI_PROTOCOL_FCP:
484		if (eip) {
485			if (max_desc_len <= 7)
486				return 1;
487			d = desc + 4;
488			slot = d[3];
489		}
490		break;
491	case SCSI_PROTOCOL_SAS:
492
493		if (eip) {
494			if (max_desc_len <= 27)
495				return 1;
496			d = desc + 4;
497			slot = d[3];
498			d = desc + 8;
499		} else {
500			if (max_desc_len <= 23)
501				return 1;
502			d = desc + 4;
503		}
504
505
506		/* only take the phy0 addr */
507		addr = (u64)d[12] << 56 |
508			(u64)d[13] << 48 |
509			(u64)d[14] << 40 |
510			(u64)d[15] << 32 |
511			(u64)d[16] << 24 |
512			(u64)d[17] << 16 |
513			(u64)d[18] << 8 |
514			(u64)d[19];
515		break;
516	default:
517		/* FIXME: Need to add more protocols than just SAS */
518		break;
519	}
520	ecomp->slot = slot;
521	scomp->addr = addr;
522
523	return 0;
524}
525
526struct efd {
527	u64 addr;
528	struct device *dev;
529};
530
531static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
532				      struct efd *efd)
533{
534	int i;
535	struct ses_component *scomp;
536
537	for (i = 0; i < edev->components; i++) {
538		scomp = edev->component[i].scratch;
539		if (scomp->addr != efd->addr)
540			continue;
541
542		if (enclosure_add_device(edev, i, efd->dev) == 0)
543			kobject_uevent(&efd->dev->kobj, KOBJ_CHANGE);
544		return 1;
545	}
546	return 0;
547}
548
549#define INIT_ALLOC_SIZE 32
550
551static void ses_enclosure_data_process(struct enclosure_device *edev,
552				       struct scsi_device *sdev,
553				       int create)
554{
555	u32 result;
556	unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
557	int i, j, page7_len, len, components;
558	struct ses_device *ses_dev = edev->scratch;
559	int types = ses_dev->page1_num_types;
560	unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
561
562	if (!hdr_buf)
563		goto simple_populate;
564
565	/* re-read page 10 */
566	if (ses_dev->page10)
567		ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
568	/* Page 7 for the descriptors is optional */
569	result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
570	if (result)
571		goto simple_populate;
572
573	page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
574	/* add 1 for trailing '\0' we'll use */
575	buf = kzalloc(len + 1, GFP_KERNEL);
576	if (!buf)
577		goto simple_populate;
578	result = ses_recv_diag(sdev, 7, buf, len);
579	if (result) {
580 simple_populate:
581		kfree(buf);
582		buf = NULL;
583		desc_ptr = NULL;
584		len = 0;
585		page7_len = 0;
586	} else {
587		desc_ptr = buf + 8;
588		len = (desc_ptr[2] << 8) + desc_ptr[3];
589		/* skip past overall descriptor */
590		desc_ptr += len + 4;
591	}
592	if (ses_dev->page10 && ses_dev->page10_len > 9)
593		addl_desc_ptr = ses_dev->page10 + 8;
594	type_ptr = ses_dev->page1_types;
595	components = 0;
596	for (i = 0; i < types; i++, type_ptr += 4) {
597		for (j = 0; j < type_ptr[1]; j++) {
598			char *name = NULL;
599			struct enclosure_component *ecomp;
600			int max_desc_len;
601
602			if (desc_ptr) {
603				if (desc_ptr + 3 >= buf + page7_len) {
604					desc_ptr = NULL;
605				} else {
606					len = (desc_ptr[2] << 8) + desc_ptr[3];
607					desc_ptr += 4;
608					if (desc_ptr + len > buf + page7_len)
609						desc_ptr = NULL;
610					else {
611						/* Add trailing zero - pushes into
612						 * reserved space */
613						desc_ptr[len] = '\0';
614						name = desc_ptr;
615					}
616				}
617			}
618			if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
619			    type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
620
621				if (create)
622					ecomp =	enclosure_component_alloc(
623						edev,
624						components++,
625						type_ptr[0],
626						name);
627				else if (components < edev->components)
628					ecomp = &edev->component[components++];
629				else
630					ecomp = ERR_PTR(-EINVAL);
631
632				if (!IS_ERR(ecomp)) {
633					if (addl_desc_ptr) {
634						max_desc_len = ses_dev->page10_len -
635						    (addl_desc_ptr - ses_dev->page10);
636						if (ses_process_descriptor(ecomp,
637						    addl_desc_ptr,
638						    max_desc_len))
639							addl_desc_ptr = NULL;
640					}
641					if (create)
642						enclosure_component_register(
643							ecomp);
644				}
645			}
646			if (desc_ptr)
647				desc_ptr += len;
648
649			if (addl_desc_ptr &&
650			    /* only find additional descriptions for specific devices */
651			    (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
652			     type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE ||
653			     type_ptr[0] == ENCLOSURE_COMPONENT_SAS_EXPANDER ||
654			     /* these elements are optional */
655			     type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_TARGET_PORT ||
656			     type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT ||
657			     type_ptr[0] == ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS)) {
658				addl_desc_ptr += addl_desc_ptr[1] + 2;
659				if (addl_desc_ptr + 1 >= ses_dev->page10 + ses_dev->page10_len)
660					addl_desc_ptr = NULL;
661			}
662		}
663	}
664	kfree(buf);
665	kfree(hdr_buf);
666}
667
668static void ses_match_to_enclosure(struct enclosure_device *edev,
669				   struct scsi_device *sdev,
670				   int refresh)
671{
672	struct scsi_device *edev_sdev = to_scsi_device(edev->edev.parent);
673	struct efd efd = {
674		.addr = 0,
675	};
676
677	if (refresh)
678		ses_enclosure_data_process(edev, edev_sdev, 0);
679
680	if (scsi_is_sas_rphy(sdev->sdev_target->dev.parent))
681		efd.addr = sas_get_address(sdev);
682
683	if (efd.addr) {
684		efd.dev = &sdev->sdev_gendev;
685
686		ses_enclosure_find_by_addr(edev, &efd);
687	}
688}
689
690static int ses_intf_add(struct device *cdev)
691{
692	struct scsi_device *sdev = to_scsi_device(cdev->parent);
693	struct scsi_device *tmp_sdev;
694	unsigned char *buf = NULL, *hdr_buf, *type_ptr, page;
695	struct ses_device *ses_dev;
696	u32 result;
697	int i, types, len, components = 0;
698	int err = -ENOMEM;
699	int num_enclosures;
700	struct enclosure_device *edev;
701	struct ses_component *scomp = NULL;
702
703	if (!scsi_device_enclosure(sdev)) {
704		/* not an enclosure, but might be in one */
705		struct enclosure_device *prev = NULL;
706
707		while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
708			ses_match_to_enclosure(edev, sdev, 1);
709			prev = edev;
710		}
711		return -ENODEV;
712	}
713
714	/* TYPE_ENCLOSURE prints a message in probe */
715	if (sdev->type != TYPE_ENCLOSURE)
716		sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
717
718	ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
719	hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
720	if (!hdr_buf || !ses_dev)
721		goto err_init_free;
722
723	page = 1;
724	result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
725	if (result)
726		goto recv_failed;
727
728	len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
729	buf = kzalloc(len, GFP_KERNEL);
730	if (!buf)
731		goto err_free;
732
733	result = ses_recv_diag(sdev, page, buf, len);
734	if (result)
735		goto recv_failed;
736
737	types = 0;
738
739	/* we always have one main enclosure and the rest are referred
740	 * to as secondary subenclosures */
741	num_enclosures = buf[1] + 1;
742
743	/* begin at the enclosure descriptor */
744	type_ptr = buf + 8;
745	/* skip all the enclosure descriptors */
746	for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
747		types += type_ptr[2];
748		type_ptr += type_ptr[3] + 4;
749	}
750
751	ses_dev->page1_types = type_ptr;
752	ses_dev->page1_num_types = types;
753
754	for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
755		if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
756		    type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
757			components += type_ptr[1];
758	}
759
760	ses_dev->page1 = buf;
761	ses_dev->page1_len = len;
762	buf = NULL;
763
764	page = 2;
765	result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
766	if (result)
767		goto page2_not_supported;
768
769	len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
770	buf = kzalloc(len, GFP_KERNEL);
771	if (!buf)
772		goto err_free;
773
774	/* make sure getting page 2 actually works */
775	result = ses_recv_diag(sdev, 2, buf, len);
776	if (result)
777		goto recv_failed;
778	ses_dev->page2 = buf;
779	ses_dev->page2_len = len;
780	buf = NULL;
781
782	/* The additional information page --- allows us
783	 * to match up the devices */
784	page = 10;
785	result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
786	if (!result) {
787
788		len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
789		buf = kzalloc(len, GFP_KERNEL);
790		if (!buf)
791			goto err_free;
792
793		result = ses_recv_diag(sdev, page, buf, len);
794		if (result)
795			goto recv_failed;
796		ses_dev->page10 = buf;
797		ses_dev->page10_len = len;
798		buf = NULL;
799	}
800page2_not_supported:
801	if (components > 0) {
802		scomp = kcalloc(components, sizeof(struct ses_component), GFP_KERNEL);
803		if (!scomp)
804			goto err_free;
805	}
806
807	edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
808				  components, &ses_enclosure_callbacks);
809	if (IS_ERR(edev)) {
810		err = PTR_ERR(edev);
811		goto err_free;
812	}
813
814	kfree(hdr_buf);
815
816	edev->scratch = ses_dev;
817	for (i = 0; i < components; i++)
818		edev->component[i].scratch = scomp + i;
819
820	ses_enclosure_data_process(edev, sdev, 1);
821
822	/* see if there are any devices matching before
823	 * we found the enclosure */
824	shost_for_each_device(tmp_sdev, sdev->host) {
825		if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
826			continue;
827		ses_match_to_enclosure(edev, tmp_sdev, 0);
828	}
829
830	return 0;
831
832 recv_failed:
833	sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
834		    page);
835	err = -ENODEV;
836 err_free:
837	kfree(buf);
838	kfree(scomp);
839	kfree(ses_dev->page10);
840	kfree(ses_dev->page2);
841	kfree(ses_dev->page1);
842 err_init_free:
843	kfree(ses_dev);
844	kfree(hdr_buf);
845	sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
846	return err;
847}
848
849static int ses_remove(struct device *dev)
850{
851	return 0;
852}
853
854static void ses_intf_remove_component(struct scsi_device *sdev)
855{
856	struct enclosure_device *edev, *prev = NULL;
857
858	while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
859		prev = edev;
860		if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
861			break;
862	}
863	if (edev)
864		put_device(&edev->edev);
865}
866
867static void ses_intf_remove_enclosure(struct scsi_device *sdev)
868{
869	struct enclosure_device *edev;
870	struct ses_device *ses_dev;
871
872	/*  exact match to this enclosure */
873	edev = enclosure_find(&sdev->sdev_gendev, NULL);
874	if (!edev)
875		return;
876
877	ses_dev = edev->scratch;
878	edev->scratch = NULL;
879
880	kfree(ses_dev->page10);
881	kfree(ses_dev->page1);
882	kfree(ses_dev->page2);
883	kfree(ses_dev);
884
885	if (edev->components)
886		kfree(edev->component[0].scratch);
887
888	put_device(&edev->edev);
889	enclosure_unregister(edev);
890}
891
892static void ses_intf_remove(struct device *cdev)
893{
894	struct scsi_device *sdev = to_scsi_device(cdev->parent);
895
896	if (!scsi_device_enclosure(sdev))
897		ses_intf_remove_component(sdev);
898	else
899		ses_intf_remove_enclosure(sdev);
900}
901
902static struct class_interface ses_interface = {
903	.add_dev	= ses_intf_add,
904	.remove_dev	= ses_intf_remove,
905};
906
907static struct scsi_driver ses_template = {
908	.gendrv = {
909		.name		= "ses",
910		.probe		= ses_probe,
911		.remove		= ses_remove,
912	},
913};
914
915static int __init ses_init(void)
916{
917	int err;
918
919	err = scsi_register_interface(&ses_interface);
920	if (err)
921		return err;
922
923	err = scsi_register_driver(&ses_template.gendrv);
924	if (err)
925		goto out_unreg;
926
927	return 0;
928
929 out_unreg:
930	scsi_unregister_interface(&ses_interface);
931	return err;
932}
933
934static void __exit ses_exit(void)
935{
936	scsi_unregister_driver(&ses_template.gendrv);
937	scsi_unregister_interface(&ses_interface);
938}
939
940module_init(ses_init);
941module_exit(ses_exit);
942
943MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
944
945MODULE_AUTHOR("James Bottomley");
946MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
947MODULE_LICENSE("GPL v2");