ses.c 21 KB

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