fw-sbp2.c 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406
  1. /*
  2. * SBP2 driver (SCSI over IEEE1394)
  3. *
  4. * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net>
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software Foundation,
  18. * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19. */
  20. /*
  21. * The basic structure of this driver is based on the old storage driver,
  22. * drivers/ieee1394/sbp2.c, originally written by
  23. * James Goodwin <jamesg@filanet.com>
  24. * with later contributions and ongoing maintenance from
  25. * Ben Collins <bcollins@debian.org>,
  26. * Stefan Richter <stefanr@s5r6.in-berlin.de>
  27. * and many others.
  28. */
  29. #include <linux/kernel.h>
  30. #include <linux/module.h>
  31. #include <linux/moduleparam.h>
  32. #include <linux/mod_devicetable.h>
  33. #include <linux/device.h>
  34. #include <linux/scatterlist.h>
  35. #include <linux/dma-mapping.h>
  36. #include <linux/blkdev.h>
  37. #include <linux/string.h>
  38. #include <linux/stringify.h>
  39. #include <linux/timer.h>
  40. #include <linux/workqueue.h>
  41. #include <asm/system.h>
  42. #include <scsi/scsi.h>
  43. #include <scsi/scsi_cmnd.h>
  44. #include <scsi/scsi_device.h>
  45. #include <scsi/scsi_host.h>
  46. #include "fw-transaction.h"
  47. #include "fw-topology.h"
  48. #include "fw-device.h"
  49. /*
  50. * So far only bridges from Oxford Semiconductor are known to support
  51. * concurrent logins. Depending on firmware, four or two concurrent logins
  52. * are possible on OXFW911 and newer Oxsemi bridges.
  53. *
  54. * Concurrent logins are useful together with cluster filesystems.
  55. */
  56. static int sbp2_param_exclusive_login = 1;
  57. module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
  58. MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
  59. "(default = Y, use N for concurrent initiators)");
  60. /*
  61. * Flags for firmware oddities
  62. *
  63. * - 128kB max transfer
  64. * Limit transfer size. Necessary for some old bridges.
  65. *
  66. * - 36 byte inquiry
  67. * When scsi_mod probes the device, let the inquiry command look like that
  68. * from MS Windows.
  69. *
  70. * - skip mode page 8
  71. * Suppress sending of mode_sense for mode page 8 if the device pretends to
  72. * support the SCSI Primary Block commands instead of Reduced Block Commands.
  73. *
  74. * - fix capacity
  75. * Tell sd_mod to correct the last sector number reported by read_capacity.
  76. * Avoids access beyond actual disk limits on devices with an off-by-one bug.
  77. * Don't use this with devices which don't have this bug.
  78. *
  79. * - override internal blacklist
  80. * Instead of adding to the built-in blacklist, use only the workarounds
  81. * specified in the module load parameter.
  82. * Useful if a blacklist entry interfered with a non-broken device.
  83. */
  84. #define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
  85. #define SBP2_WORKAROUND_INQUIRY_36 0x2
  86. #define SBP2_WORKAROUND_MODE_SENSE_8 0x4
  87. #define SBP2_WORKAROUND_FIX_CAPACITY 0x8
  88. #define SBP2_WORKAROUND_OVERRIDE 0x100
  89. static int sbp2_param_workarounds;
  90. module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
  91. MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
  92. ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
  93. ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
  94. ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
  95. ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
  96. ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
  97. ", or a combination)");
  98. /* I don't know why the SCSI stack doesn't define something like this... */
  99. typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
  100. static const char sbp2_driver_name[] = "sbp2";
  101. /*
  102. * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
  103. * and one struct scsi_device per sbp2_logical_unit.
  104. */
  105. struct sbp2_logical_unit {
  106. struct sbp2_target *tgt;
  107. struct list_head link;
  108. struct scsi_device *sdev;
  109. struct fw_address_handler address_handler;
  110. struct list_head orb_list;
  111. u64 command_block_agent_address;
  112. u16 lun;
  113. int login_id;
  114. /*
  115. * The generation is updated once we've logged in or reconnected
  116. * to the logical unit. Thus, I/O to the device will automatically
  117. * fail and get retried if it happens in a window where the device
  118. * is not ready, e.g. after a bus reset but before we reconnect.
  119. */
  120. int generation;
  121. int retries;
  122. struct delayed_work work;
  123. };
  124. /*
  125. * We create one struct sbp2_target per IEEE 1212 Unit Directory
  126. * and one struct Scsi_Host per sbp2_target.
  127. */
  128. struct sbp2_target {
  129. struct kref kref;
  130. struct fw_unit *unit;
  131. struct list_head lu_list;
  132. u64 management_agent_address;
  133. int directory_id;
  134. int node_id;
  135. int address_high;
  136. unsigned int workarounds;
  137. unsigned int mgt_orb_timeout;
  138. };
  139. /*
  140. * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
  141. * provided in the config rom. Most devices do provide a value, which
  142. * we'll use for login management orbs, but with some sane limits.
  143. */
  144. #define SBP2_MIN_LOGIN_ORB_TIMEOUT 5000U /* Timeout in ms */
  145. #define SBP2_MAX_LOGIN_ORB_TIMEOUT 40000U /* Timeout in ms */
  146. #define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
  147. #define SBP2_ORB_NULL 0x80000000
  148. #define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
  149. #define SBP2_DIRECTION_TO_MEDIA 0x0
  150. #define SBP2_DIRECTION_FROM_MEDIA 0x1
  151. /* Unit directory keys */
  152. #define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
  153. #define SBP2_CSR_FIRMWARE_REVISION 0x3c
  154. #define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
  155. #define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
  156. /* Management orb opcodes */
  157. #define SBP2_LOGIN_REQUEST 0x0
  158. #define SBP2_QUERY_LOGINS_REQUEST 0x1
  159. #define SBP2_RECONNECT_REQUEST 0x3
  160. #define SBP2_SET_PASSWORD_REQUEST 0x4
  161. #define SBP2_LOGOUT_REQUEST 0x7
  162. #define SBP2_ABORT_TASK_REQUEST 0xb
  163. #define SBP2_ABORT_TASK_SET 0xc
  164. #define SBP2_LOGICAL_UNIT_RESET 0xe
  165. #define SBP2_TARGET_RESET_REQUEST 0xf
  166. /* Offsets for command block agent registers */
  167. #define SBP2_AGENT_STATE 0x00
  168. #define SBP2_AGENT_RESET 0x04
  169. #define SBP2_ORB_POINTER 0x08
  170. #define SBP2_DOORBELL 0x10
  171. #define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
  172. /* Status write response codes */
  173. #define SBP2_STATUS_REQUEST_COMPLETE 0x0
  174. #define SBP2_STATUS_TRANSPORT_FAILURE 0x1
  175. #define SBP2_STATUS_ILLEGAL_REQUEST 0x2
  176. #define SBP2_STATUS_VENDOR_DEPENDENT 0x3
  177. #define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
  178. #define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
  179. #define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
  180. #define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
  181. #define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
  182. #define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
  183. #define STATUS_GET_ORB_LOW(v) ((v).orb_low)
  184. #define STATUS_GET_DATA(v) ((v).data)
  185. struct sbp2_status {
  186. u32 status;
  187. u32 orb_low;
  188. u8 data[24];
  189. };
  190. struct sbp2_pointer {
  191. u32 high;
  192. u32 low;
  193. };
  194. struct sbp2_orb {
  195. struct fw_transaction t;
  196. struct kref kref;
  197. dma_addr_t request_bus;
  198. int rcode;
  199. struct sbp2_pointer pointer;
  200. void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
  201. struct list_head link;
  202. };
  203. #define MANAGEMENT_ORB_LUN(v) ((v))
  204. #define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
  205. #define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
  206. #define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
  207. #define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
  208. #define MANAGEMENT_ORB_NOTIFY ((1) << 31)
  209. #define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
  210. #define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
  211. struct sbp2_management_orb {
  212. struct sbp2_orb base;
  213. struct {
  214. struct sbp2_pointer password;
  215. struct sbp2_pointer response;
  216. u32 misc;
  217. u32 length;
  218. struct sbp2_pointer status_fifo;
  219. } request;
  220. __be32 response[4];
  221. dma_addr_t response_bus;
  222. struct completion done;
  223. struct sbp2_status status;
  224. };
  225. #define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
  226. #define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
  227. struct sbp2_login_response {
  228. u32 misc;
  229. struct sbp2_pointer command_block_agent;
  230. u32 reconnect_hold;
  231. };
  232. #define COMMAND_ORB_DATA_SIZE(v) ((v))
  233. #define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
  234. #define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
  235. #define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
  236. #define COMMAND_ORB_SPEED(v) ((v) << 24)
  237. #define COMMAND_ORB_DIRECTION(v) ((v) << 27)
  238. #define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
  239. #define COMMAND_ORB_NOTIFY ((1) << 31)
  240. struct sbp2_command_orb {
  241. struct sbp2_orb base;
  242. struct {
  243. struct sbp2_pointer next;
  244. struct sbp2_pointer data_descriptor;
  245. u32 misc;
  246. u8 command_block[12];
  247. } request;
  248. struct scsi_cmnd *cmd;
  249. scsi_done_fn_t done;
  250. struct sbp2_logical_unit *lu;
  251. struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
  252. dma_addr_t page_table_bus;
  253. };
  254. /*
  255. * List of devices with known bugs.
  256. *
  257. * The firmware_revision field, masked with 0xffff00, is the best
  258. * indicator for the type of bridge chip of a device. It yields a few
  259. * false positives but this did not break correctly behaving devices
  260. * so far. We use ~0 as a wildcard, since the 24 bit values we get
  261. * from the config rom can never match that.
  262. */
  263. static const struct {
  264. u32 firmware_revision;
  265. u32 model;
  266. unsigned int workarounds;
  267. } sbp2_workarounds_table[] = {
  268. /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
  269. .firmware_revision = 0x002800,
  270. .model = 0x001010,
  271. .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
  272. SBP2_WORKAROUND_MODE_SENSE_8,
  273. },
  274. /* Initio bridges, actually only needed for some older ones */ {
  275. .firmware_revision = 0x000200,
  276. .model = ~0,
  277. .workarounds = SBP2_WORKAROUND_INQUIRY_36,
  278. },
  279. /* Symbios bridge */ {
  280. .firmware_revision = 0xa0b800,
  281. .model = ~0,
  282. .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
  283. },
  284. /*
  285. * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
  286. * these iPods do not feature the read_capacity bug according
  287. * to one report. Read_capacity behaviour as well as model_id
  288. * could change due to Apple-supplied firmware updates though.
  289. */
  290. /* iPod 4th generation. */ {
  291. .firmware_revision = 0x0a2700,
  292. .model = 0x000021,
  293. .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
  294. },
  295. /* iPod mini */ {
  296. .firmware_revision = 0x0a2700,
  297. .model = 0x000023,
  298. .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
  299. },
  300. /* iPod Photo */ {
  301. .firmware_revision = 0x0a2700,
  302. .model = 0x00007e,
  303. .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
  304. }
  305. };
  306. static void
  307. free_orb(struct kref *kref)
  308. {
  309. struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
  310. kfree(orb);
  311. }
  312. static void
  313. sbp2_status_write(struct fw_card *card, struct fw_request *request,
  314. int tcode, int destination, int source,
  315. int generation, int speed,
  316. unsigned long long offset,
  317. void *payload, size_t length, void *callback_data)
  318. {
  319. struct sbp2_logical_unit *lu = callback_data;
  320. struct sbp2_orb *orb;
  321. struct sbp2_status status;
  322. size_t header_size;
  323. unsigned long flags;
  324. if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
  325. length == 0 || length > sizeof(status)) {
  326. fw_send_response(card, request, RCODE_TYPE_ERROR);
  327. return;
  328. }
  329. header_size = min(length, 2 * sizeof(u32));
  330. fw_memcpy_from_be32(&status, payload, header_size);
  331. if (length > header_size)
  332. memcpy(status.data, payload + 8, length - header_size);
  333. if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
  334. fw_notify("non-orb related status write, not handled\n");
  335. fw_send_response(card, request, RCODE_COMPLETE);
  336. return;
  337. }
  338. /* Lookup the orb corresponding to this status write. */
  339. spin_lock_irqsave(&card->lock, flags);
  340. list_for_each_entry(orb, &lu->orb_list, link) {
  341. if (STATUS_GET_ORB_HIGH(status) == 0 &&
  342. STATUS_GET_ORB_LOW(status) == orb->request_bus) {
  343. orb->rcode = RCODE_COMPLETE;
  344. list_del(&orb->link);
  345. break;
  346. }
  347. }
  348. spin_unlock_irqrestore(&card->lock, flags);
  349. if (&orb->link != &lu->orb_list)
  350. orb->callback(orb, &status);
  351. else
  352. fw_error("status write for unknown orb\n");
  353. kref_put(&orb->kref, free_orb);
  354. fw_send_response(card, request, RCODE_COMPLETE);
  355. }
  356. static void
  357. complete_transaction(struct fw_card *card, int rcode,
  358. void *payload, size_t length, void *data)
  359. {
  360. struct sbp2_orb *orb = data;
  361. unsigned long flags;
  362. /*
  363. * This is a little tricky. We can get the status write for
  364. * the orb before we get this callback. The status write
  365. * handler above will assume the orb pointer transaction was
  366. * successful and set the rcode to RCODE_COMPLETE for the orb.
  367. * So this callback only sets the rcode if it hasn't already
  368. * been set and only does the cleanup if the transaction
  369. * failed and we didn't already get a status write.
  370. */
  371. spin_lock_irqsave(&card->lock, flags);
  372. if (orb->rcode == -1)
  373. orb->rcode = rcode;
  374. if (orb->rcode != RCODE_COMPLETE) {
  375. list_del(&orb->link);
  376. spin_unlock_irqrestore(&card->lock, flags);
  377. orb->callback(orb, NULL);
  378. } else {
  379. spin_unlock_irqrestore(&card->lock, flags);
  380. }
  381. kref_put(&orb->kref, free_orb);
  382. }
  383. static void
  384. sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
  385. int node_id, int generation, u64 offset)
  386. {
  387. struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
  388. unsigned long flags;
  389. orb->pointer.high = 0;
  390. orb->pointer.low = orb->request_bus;
  391. fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
  392. spin_lock_irqsave(&device->card->lock, flags);
  393. list_add_tail(&orb->link, &lu->orb_list);
  394. spin_unlock_irqrestore(&device->card->lock, flags);
  395. /* Take a ref for the orb list and for the transaction callback. */
  396. kref_get(&orb->kref);
  397. kref_get(&orb->kref);
  398. fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
  399. node_id, generation, device->max_speed, offset,
  400. &orb->pointer, sizeof(orb->pointer),
  401. complete_transaction, orb);
  402. }
  403. static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
  404. {
  405. struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
  406. struct sbp2_orb *orb, *next;
  407. struct list_head list;
  408. unsigned long flags;
  409. int retval = -ENOENT;
  410. INIT_LIST_HEAD(&list);
  411. spin_lock_irqsave(&device->card->lock, flags);
  412. list_splice_init(&lu->orb_list, &list);
  413. spin_unlock_irqrestore(&device->card->lock, flags);
  414. list_for_each_entry_safe(orb, next, &list, link) {
  415. retval = 0;
  416. if (fw_cancel_transaction(device->card, &orb->t) == 0)
  417. continue;
  418. orb->rcode = RCODE_CANCELLED;
  419. orb->callback(orb, NULL);
  420. }
  421. return retval;
  422. }
  423. static void
  424. complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
  425. {
  426. struct sbp2_management_orb *orb =
  427. container_of(base_orb, struct sbp2_management_orb, base);
  428. if (status)
  429. memcpy(&orb->status, status, sizeof(*status));
  430. complete(&orb->done);
  431. }
  432. static int
  433. sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
  434. int generation, int function, int lun_or_login_id,
  435. void *response)
  436. {
  437. struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
  438. struct sbp2_management_orb *orb;
  439. unsigned int timeout;
  440. int retval = -ENOMEM;
  441. orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
  442. if (orb == NULL)
  443. return -ENOMEM;
  444. kref_init(&orb->base.kref);
  445. orb->response_bus =
  446. dma_map_single(device->card->device, &orb->response,
  447. sizeof(orb->response), DMA_FROM_DEVICE);
  448. if (dma_mapping_error(orb->response_bus))
  449. goto fail_mapping_response;
  450. orb->request.response.high = 0;
  451. orb->request.response.low = orb->response_bus;
  452. orb->request.misc =
  453. MANAGEMENT_ORB_NOTIFY |
  454. MANAGEMENT_ORB_FUNCTION(function) |
  455. MANAGEMENT_ORB_LUN(lun_or_login_id);
  456. orb->request.length =
  457. MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
  458. orb->request.status_fifo.high = lu->address_handler.offset >> 32;
  459. orb->request.status_fifo.low = lu->address_handler.offset;
  460. if (function == SBP2_LOGIN_REQUEST) {
  461. /* Ask for 2^2 == 4 seconds reconnect grace period */
  462. orb->request.misc |=
  463. MANAGEMENT_ORB_RECONNECT(2) |
  464. MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login);
  465. timeout = lu->tgt->mgt_orb_timeout;
  466. } else {
  467. timeout = SBP2_ORB_TIMEOUT;
  468. }
  469. fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
  470. init_completion(&orb->done);
  471. orb->base.callback = complete_management_orb;
  472. orb->base.request_bus =
  473. dma_map_single(device->card->device, &orb->request,
  474. sizeof(orb->request), DMA_TO_DEVICE);
  475. if (dma_mapping_error(orb->base.request_bus))
  476. goto fail_mapping_request;
  477. sbp2_send_orb(&orb->base, lu, node_id, generation,
  478. lu->tgt->management_agent_address);
  479. wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
  480. retval = -EIO;
  481. if (sbp2_cancel_orbs(lu) == 0) {
  482. fw_error("orb reply timed out, rcode=0x%02x\n",
  483. orb->base.rcode);
  484. goto out;
  485. }
  486. if (orb->base.rcode != RCODE_COMPLETE) {
  487. fw_error("management write failed, rcode 0x%02x\n",
  488. orb->base.rcode);
  489. goto out;
  490. }
  491. if (STATUS_GET_RESPONSE(orb->status) != 0 ||
  492. STATUS_GET_SBP_STATUS(orb->status) != 0) {
  493. fw_error("error status: %d:%d\n",
  494. STATUS_GET_RESPONSE(orb->status),
  495. STATUS_GET_SBP_STATUS(orb->status));
  496. goto out;
  497. }
  498. retval = 0;
  499. out:
  500. dma_unmap_single(device->card->device, orb->base.request_bus,
  501. sizeof(orb->request), DMA_TO_DEVICE);
  502. fail_mapping_request:
  503. dma_unmap_single(device->card->device, orb->response_bus,
  504. sizeof(orb->response), DMA_FROM_DEVICE);
  505. fail_mapping_response:
  506. if (response)
  507. fw_memcpy_from_be32(response,
  508. orb->response, sizeof(orb->response));
  509. kref_put(&orb->base.kref, free_orb);
  510. return retval;
  511. }
  512. static void
  513. complete_agent_reset_write(struct fw_card *card, int rcode,
  514. void *payload, size_t length, void *data)
  515. {
  516. struct fw_transaction *t = data;
  517. kfree(t);
  518. }
  519. static int sbp2_agent_reset(struct sbp2_logical_unit *lu)
  520. {
  521. struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
  522. struct fw_transaction *t;
  523. static u32 zero;
  524. t = kzalloc(sizeof(*t), GFP_ATOMIC);
  525. if (t == NULL)
  526. return -ENOMEM;
  527. fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
  528. lu->tgt->node_id, lu->generation, device->max_speed,
  529. lu->command_block_agent_address + SBP2_AGENT_RESET,
  530. &zero, sizeof(zero), complete_agent_reset_write, t);
  531. return 0;
  532. }
  533. static void sbp2_release_target(struct kref *kref)
  534. {
  535. struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
  536. struct sbp2_logical_unit *lu, *next;
  537. struct Scsi_Host *shost =
  538. container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
  539. struct fw_device *device = fw_device(tgt->unit->device.parent);
  540. list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
  541. if (lu->sdev)
  542. scsi_remove_device(lu->sdev);
  543. if (!fw_device_is_shutdown(device))
  544. sbp2_send_management_orb(lu, tgt->node_id,
  545. lu->generation, SBP2_LOGOUT_REQUEST,
  546. lu->login_id, NULL);
  547. fw_core_remove_address_handler(&lu->address_handler);
  548. list_del(&lu->link);
  549. kfree(lu);
  550. }
  551. scsi_remove_host(shost);
  552. fw_notify("released %s\n", tgt->unit->device.bus_id);
  553. put_device(&tgt->unit->device);
  554. scsi_host_put(shost);
  555. }
  556. static struct workqueue_struct *sbp2_wq;
  557. /*
  558. * Always get the target's kref when scheduling work on one its units.
  559. * Each workqueue job is responsible to call sbp2_target_put() upon return.
  560. */
  561. static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
  562. {
  563. if (queue_delayed_work(sbp2_wq, &lu->work, delay))
  564. kref_get(&lu->tgt->kref);
  565. }
  566. static void sbp2_target_put(struct sbp2_target *tgt)
  567. {
  568. kref_put(&tgt->kref, sbp2_release_target);
  569. }
  570. static void sbp2_reconnect(struct work_struct *work);
  571. static void sbp2_login(struct work_struct *work)
  572. {
  573. struct sbp2_logical_unit *lu =
  574. container_of(work, struct sbp2_logical_unit, work.work);
  575. struct Scsi_Host *shost =
  576. container_of((void *)lu->tgt, struct Scsi_Host, hostdata[0]);
  577. struct scsi_device *sdev;
  578. struct scsi_lun eight_bytes_lun;
  579. struct fw_unit *unit = lu->tgt->unit;
  580. struct fw_device *device = fw_device(unit->device.parent);
  581. struct sbp2_login_response response;
  582. int generation, node_id, local_node_id;
  583. generation = device->generation;
  584. smp_rmb(); /* node_id must not be older than generation */
  585. node_id = device->node_id;
  586. local_node_id = device->card->node_id;
  587. if (sbp2_send_management_orb(lu, node_id, generation,
  588. SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
  589. if (lu->retries++ < 5)
  590. sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
  591. else
  592. fw_error("failed to login to %s LUN %04x\n",
  593. unit->device.bus_id, lu->lun);
  594. goto out;
  595. }
  596. lu->generation = generation;
  597. lu->tgt->node_id = node_id;
  598. lu->tgt->address_high = local_node_id << 16;
  599. /* Get command block agent offset and login id. */
  600. lu->command_block_agent_address =
  601. ((u64) (response.command_block_agent.high & 0xffff) << 32) |
  602. response.command_block_agent.low;
  603. lu->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
  604. fw_notify("logged in to %s LUN %04x (%d retries)\n",
  605. unit->device.bus_id, lu->lun, lu->retries);
  606. #if 0
  607. /* FIXME: The linux1394 sbp2 does this last step. */
  608. sbp2_set_busy_timeout(scsi_id);
  609. #endif
  610. PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
  611. sbp2_agent_reset(lu);
  612. memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
  613. eight_bytes_lun.scsi_lun[0] = (lu->lun >> 8) & 0xff;
  614. eight_bytes_lun.scsi_lun[1] = lu->lun & 0xff;
  615. sdev = __scsi_add_device(shost, 0, 0,
  616. scsilun_to_int(&eight_bytes_lun), lu);
  617. if (IS_ERR(sdev)) {
  618. smp_rmb(); /* generation may have changed */
  619. generation = device->generation;
  620. smp_rmb(); /* node_id must not be older than generation */
  621. sbp2_send_management_orb(lu, device->node_id, generation,
  622. SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
  623. /*
  624. * Set this back to sbp2_login so we fall back and
  625. * retry login on bus reset.
  626. */
  627. PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
  628. } else {
  629. lu->sdev = sdev;
  630. scsi_device_put(sdev);
  631. }
  632. out:
  633. sbp2_target_put(lu->tgt);
  634. }
  635. static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
  636. {
  637. struct sbp2_logical_unit *lu;
  638. lu = kmalloc(sizeof(*lu), GFP_KERNEL);
  639. if (!lu)
  640. return -ENOMEM;
  641. lu->address_handler.length = 0x100;
  642. lu->address_handler.address_callback = sbp2_status_write;
  643. lu->address_handler.callback_data = lu;
  644. if (fw_core_add_address_handler(&lu->address_handler,
  645. &fw_high_memory_region) < 0) {
  646. kfree(lu);
  647. return -ENOMEM;
  648. }
  649. lu->tgt = tgt;
  650. lu->sdev = NULL;
  651. lu->lun = lun_entry & 0xffff;
  652. lu->retries = 0;
  653. INIT_LIST_HEAD(&lu->orb_list);
  654. INIT_DELAYED_WORK(&lu->work, sbp2_login);
  655. list_add_tail(&lu->link, &tgt->lu_list);
  656. return 0;
  657. }
  658. static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
  659. {
  660. struct fw_csr_iterator ci;
  661. int key, value;
  662. fw_csr_iterator_init(&ci, directory);
  663. while (fw_csr_iterator_next(&ci, &key, &value))
  664. if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
  665. sbp2_add_logical_unit(tgt, value) < 0)
  666. return -ENOMEM;
  667. return 0;
  668. }
  669. static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
  670. u32 *model, u32 *firmware_revision)
  671. {
  672. struct fw_csr_iterator ci;
  673. int key, value;
  674. unsigned int timeout;
  675. fw_csr_iterator_init(&ci, directory);
  676. while (fw_csr_iterator_next(&ci, &key, &value)) {
  677. switch (key) {
  678. case CSR_DEPENDENT_INFO | CSR_OFFSET:
  679. tgt->management_agent_address =
  680. CSR_REGISTER_BASE + 4 * value;
  681. break;
  682. case CSR_DIRECTORY_ID:
  683. tgt->directory_id = value;
  684. break;
  685. case CSR_MODEL:
  686. *model = value;
  687. break;
  688. case SBP2_CSR_FIRMWARE_REVISION:
  689. *firmware_revision = value;
  690. break;
  691. case SBP2_CSR_UNIT_CHARACTERISTICS:
  692. /* the timeout value is stored in 500ms units */
  693. timeout = ((unsigned int) value >> 8 & 0xff) * 500;
  694. timeout = max(timeout, SBP2_MIN_LOGIN_ORB_TIMEOUT);
  695. tgt->mgt_orb_timeout =
  696. min(timeout, SBP2_MAX_LOGIN_ORB_TIMEOUT);
  697. if (timeout > tgt->mgt_orb_timeout)
  698. fw_notify("%s: config rom contains %ds "
  699. "management ORB timeout, limiting "
  700. "to %ds\n", tgt->unit->device.bus_id,
  701. timeout / 1000,
  702. tgt->mgt_orb_timeout / 1000);
  703. break;
  704. case SBP2_CSR_LOGICAL_UNIT_NUMBER:
  705. if (sbp2_add_logical_unit(tgt, value) < 0)
  706. return -ENOMEM;
  707. break;
  708. case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
  709. if (sbp2_scan_logical_unit_dir(tgt, ci.p + value) < 0)
  710. return -ENOMEM;
  711. break;
  712. }
  713. }
  714. return 0;
  715. }
  716. static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
  717. u32 firmware_revision)
  718. {
  719. int i;
  720. unsigned int w = sbp2_param_workarounds;
  721. if (w)
  722. fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
  723. "if you need the workarounds parameter for %s\n",
  724. tgt->unit->device.bus_id);
  725. if (w & SBP2_WORKAROUND_OVERRIDE)
  726. goto out;
  727. for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
  728. if (sbp2_workarounds_table[i].firmware_revision !=
  729. (firmware_revision & 0xffffff00))
  730. continue;
  731. if (sbp2_workarounds_table[i].model != model &&
  732. sbp2_workarounds_table[i].model != ~0)
  733. continue;
  734. w |= sbp2_workarounds_table[i].workarounds;
  735. break;
  736. }
  737. out:
  738. if (w)
  739. fw_notify("Workarounds for %s: 0x%x "
  740. "(firmware_revision 0x%06x, model_id 0x%06x)\n",
  741. tgt->unit->device.bus_id,
  742. w, firmware_revision, model);
  743. tgt->workarounds = w;
  744. }
  745. static struct scsi_host_template scsi_driver_template;
  746. static int sbp2_probe(struct device *dev)
  747. {
  748. struct fw_unit *unit = fw_unit(dev);
  749. struct fw_device *device = fw_device(unit->device.parent);
  750. struct sbp2_target *tgt;
  751. struct sbp2_logical_unit *lu;
  752. struct Scsi_Host *shost;
  753. u32 model, firmware_revision;
  754. shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
  755. if (shost == NULL)
  756. return -ENOMEM;
  757. tgt = (struct sbp2_target *)shost->hostdata;
  758. unit->device.driver_data = tgt;
  759. tgt->unit = unit;
  760. kref_init(&tgt->kref);
  761. INIT_LIST_HEAD(&tgt->lu_list);
  762. if (fw_device_enable_phys_dma(device) < 0)
  763. goto fail_shost_put;
  764. if (scsi_add_host(shost, &unit->device) < 0)
  765. goto fail_shost_put;
  766. /* Initialize to values that won't match anything in our table. */
  767. firmware_revision = 0xff000000;
  768. model = 0xff000000;
  769. /* implicit directory ID */
  770. tgt->directory_id = ((unit->directory - device->config_rom) * 4
  771. + CSR_CONFIG_ROM) & 0xffffff;
  772. if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
  773. &firmware_revision) < 0)
  774. goto fail_tgt_put;
  775. sbp2_init_workarounds(tgt, model, firmware_revision);
  776. get_device(&unit->device);
  777. /* Do the login in a workqueue so we can easily reschedule retries. */
  778. list_for_each_entry(lu, &tgt->lu_list, link)
  779. sbp2_queue_work(lu, 0);
  780. return 0;
  781. fail_tgt_put:
  782. sbp2_target_put(tgt);
  783. return -ENOMEM;
  784. fail_shost_put:
  785. scsi_host_put(shost);
  786. return -ENOMEM;
  787. }
  788. static int sbp2_remove(struct device *dev)
  789. {
  790. struct fw_unit *unit = fw_unit(dev);
  791. struct sbp2_target *tgt = unit->device.driver_data;
  792. sbp2_target_put(tgt);
  793. return 0;
  794. }
  795. static void sbp2_reconnect(struct work_struct *work)
  796. {
  797. struct sbp2_logical_unit *lu =
  798. container_of(work, struct sbp2_logical_unit, work.work);
  799. struct fw_unit *unit = lu->tgt->unit;
  800. struct fw_device *device = fw_device(unit->device.parent);
  801. int generation, node_id, local_node_id;
  802. generation = device->generation;
  803. smp_rmb(); /* node_id must not be older than generation */
  804. node_id = device->node_id;
  805. local_node_id = device->card->node_id;
  806. if (sbp2_send_management_orb(lu, node_id, generation,
  807. SBP2_RECONNECT_REQUEST,
  808. lu->login_id, NULL) < 0) {
  809. if (lu->retries++ >= 5) {
  810. fw_error("failed to reconnect to %s\n",
  811. unit->device.bus_id);
  812. /* Fall back and try to log in again. */
  813. lu->retries = 0;
  814. PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
  815. }
  816. sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
  817. goto out;
  818. }
  819. lu->generation = generation;
  820. lu->tgt->node_id = node_id;
  821. lu->tgt->address_high = local_node_id << 16;
  822. fw_notify("reconnected to %s LUN %04x (%d retries)\n",
  823. unit->device.bus_id, lu->lun, lu->retries);
  824. sbp2_agent_reset(lu);
  825. sbp2_cancel_orbs(lu);
  826. out:
  827. sbp2_target_put(lu->tgt);
  828. }
  829. static void sbp2_update(struct fw_unit *unit)
  830. {
  831. struct sbp2_target *tgt = unit->device.driver_data;
  832. struct sbp2_logical_unit *lu;
  833. fw_device_enable_phys_dma(fw_device(unit->device.parent));
  834. /*
  835. * Fw-core serializes sbp2_update() against sbp2_remove().
  836. * Iteration over tgt->lu_list is therefore safe here.
  837. */
  838. list_for_each_entry(lu, &tgt->lu_list, link) {
  839. lu->retries = 0;
  840. sbp2_queue_work(lu, 0);
  841. }
  842. }
  843. #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
  844. #define SBP2_SW_VERSION_ENTRY 0x00010483
  845. static const struct fw_device_id sbp2_id_table[] = {
  846. {
  847. .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
  848. .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
  849. .version = SBP2_SW_VERSION_ENTRY,
  850. },
  851. { }
  852. };
  853. static struct fw_driver sbp2_driver = {
  854. .driver = {
  855. .owner = THIS_MODULE,
  856. .name = sbp2_driver_name,
  857. .bus = &fw_bus_type,
  858. .probe = sbp2_probe,
  859. .remove = sbp2_remove,
  860. },
  861. .update = sbp2_update,
  862. .id_table = sbp2_id_table,
  863. };
  864. static unsigned int
  865. sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
  866. {
  867. int sam_status;
  868. sense_data[0] = 0x70;
  869. sense_data[1] = 0x0;
  870. sense_data[2] = sbp2_status[1];
  871. sense_data[3] = sbp2_status[4];
  872. sense_data[4] = sbp2_status[5];
  873. sense_data[5] = sbp2_status[6];
  874. sense_data[6] = sbp2_status[7];
  875. sense_data[7] = 10;
  876. sense_data[8] = sbp2_status[8];
  877. sense_data[9] = sbp2_status[9];
  878. sense_data[10] = sbp2_status[10];
  879. sense_data[11] = sbp2_status[11];
  880. sense_data[12] = sbp2_status[2];
  881. sense_data[13] = sbp2_status[3];
  882. sense_data[14] = sbp2_status[12];
  883. sense_data[15] = sbp2_status[13];
  884. sam_status = sbp2_status[0] & 0x3f;
  885. switch (sam_status) {
  886. case SAM_STAT_GOOD:
  887. case SAM_STAT_CHECK_CONDITION:
  888. case SAM_STAT_CONDITION_MET:
  889. case SAM_STAT_BUSY:
  890. case SAM_STAT_RESERVATION_CONFLICT:
  891. case SAM_STAT_COMMAND_TERMINATED:
  892. return DID_OK << 16 | sam_status;
  893. default:
  894. return DID_ERROR << 16;
  895. }
  896. }
  897. static void
  898. complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
  899. {
  900. struct sbp2_command_orb *orb =
  901. container_of(base_orb, struct sbp2_command_orb, base);
  902. struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
  903. int result;
  904. if (status != NULL) {
  905. if (STATUS_GET_DEAD(*status))
  906. sbp2_agent_reset(orb->lu);
  907. switch (STATUS_GET_RESPONSE(*status)) {
  908. case SBP2_STATUS_REQUEST_COMPLETE:
  909. result = DID_OK << 16;
  910. break;
  911. case SBP2_STATUS_TRANSPORT_FAILURE:
  912. result = DID_BUS_BUSY << 16;
  913. break;
  914. case SBP2_STATUS_ILLEGAL_REQUEST:
  915. case SBP2_STATUS_VENDOR_DEPENDENT:
  916. default:
  917. result = DID_ERROR << 16;
  918. break;
  919. }
  920. if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
  921. result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
  922. orb->cmd->sense_buffer);
  923. } else {
  924. /*
  925. * If the orb completes with status == NULL, something
  926. * went wrong, typically a bus reset happened mid-orb
  927. * or when sending the write (less likely).
  928. */
  929. result = DID_BUS_BUSY << 16;
  930. }
  931. dma_unmap_single(device->card->device, orb->base.request_bus,
  932. sizeof(orb->request), DMA_TO_DEVICE);
  933. if (scsi_sg_count(orb->cmd) > 0)
  934. dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
  935. scsi_sg_count(orb->cmd),
  936. orb->cmd->sc_data_direction);
  937. if (orb->page_table_bus != 0)
  938. dma_unmap_single(device->card->device, orb->page_table_bus,
  939. sizeof(orb->page_table), DMA_TO_DEVICE);
  940. orb->cmd->result = result;
  941. orb->done(orb->cmd);
  942. }
  943. static int
  944. sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
  945. struct sbp2_logical_unit *lu)
  946. {
  947. struct scatterlist *sg;
  948. int sg_len, l, i, j, count;
  949. dma_addr_t sg_addr;
  950. sg = scsi_sglist(orb->cmd);
  951. count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
  952. orb->cmd->sc_data_direction);
  953. if (count == 0)
  954. goto fail;
  955. /*
  956. * Handle the special case where there is only one element in
  957. * the scatter list by converting it to an immediate block
  958. * request. This is also a workaround for broken devices such
  959. * as the second generation iPod which doesn't support page
  960. * tables.
  961. */
  962. if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
  963. orb->request.data_descriptor.high = lu->tgt->address_high;
  964. orb->request.data_descriptor.low = sg_dma_address(sg);
  965. orb->request.misc |= COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
  966. return 0;
  967. }
  968. /*
  969. * Convert the scatterlist to an sbp2 page table. If any
  970. * scatterlist entries are too big for sbp2, we split them as we
  971. * go. Even if we ask the block I/O layer to not give us sg
  972. * elements larger than 65535 bytes, some IOMMUs may merge sg elements
  973. * during DMA mapping, and Linux currently doesn't prevent this.
  974. */
  975. for (i = 0, j = 0; i < count; i++, sg = sg_next(sg)) {
  976. sg_len = sg_dma_len(sg);
  977. sg_addr = sg_dma_address(sg);
  978. while (sg_len) {
  979. /* FIXME: This won't get us out of the pinch. */
  980. if (unlikely(j >= ARRAY_SIZE(orb->page_table))) {
  981. fw_error("page table overflow\n");
  982. goto fail_page_table;
  983. }
  984. l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
  985. orb->page_table[j].low = sg_addr;
  986. orb->page_table[j].high = (l << 16);
  987. sg_addr += l;
  988. sg_len -= l;
  989. j++;
  990. }
  991. }
  992. fw_memcpy_to_be32(orb->page_table, orb->page_table,
  993. sizeof(orb->page_table[0]) * j);
  994. orb->page_table_bus =
  995. dma_map_single(device->card->device, orb->page_table,
  996. sizeof(orb->page_table), DMA_TO_DEVICE);
  997. if (dma_mapping_error(orb->page_table_bus))
  998. goto fail_page_table;
  999. /*
  1000. * The data_descriptor pointer is the one case where we need
  1001. * to fill in the node ID part of the address. All other
  1002. * pointers assume that the data referenced reside on the
  1003. * initiator (i.e. us), but data_descriptor can refer to data
  1004. * on other nodes so we need to put our ID in descriptor.high.
  1005. */
  1006. orb->request.data_descriptor.high = lu->tgt->address_high;
  1007. orb->request.data_descriptor.low = orb->page_table_bus;
  1008. orb->request.misc |=
  1009. COMMAND_ORB_PAGE_TABLE_PRESENT |
  1010. COMMAND_ORB_DATA_SIZE(j);
  1011. return 0;
  1012. fail_page_table:
  1013. dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
  1014. orb->cmd->sc_data_direction);
  1015. fail:
  1016. return -ENOMEM;
  1017. }
  1018. /* SCSI stack integration */
  1019. static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
  1020. {
  1021. struct sbp2_logical_unit *lu = cmd->device->hostdata;
  1022. struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
  1023. struct sbp2_command_orb *orb;
  1024. unsigned int max_payload;
  1025. int retval = SCSI_MLQUEUE_HOST_BUSY;
  1026. /*
  1027. * Bidirectional commands are not yet implemented, and unknown
  1028. * transfer direction not handled.
  1029. */
  1030. if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
  1031. fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
  1032. cmd->result = DID_ERROR << 16;
  1033. done(cmd);
  1034. return 0;
  1035. }
  1036. orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
  1037. if (orb == NULL) {
  1038. fw_notify("failed to alloc orb\n");
  1039. return SCSI_MLQUEUE_HOST_BUSY;
  1040. }
  1041. /* Initialize rcode to something not RCODE_COMPLETE. */
  1042. orb->base.rcode = -1;
  1043. kref_init(&orb->base.kref);
  1044. orb->lu = lu;
  1045. orb->done = done;
  1046. orb->cmd = cmd;
  1047. orb->request.next.high = SBP2_ORB_NULL;
  1048. orb->request.next.low = 0x0;
  1049. /*
  1050. * At speed 100 we can do 512 bytes per packet, at speed 200,
  1051. * 1024 bytes per packet etc. The SBP-2 max_payload field
  1052. * specifies the max payload size as 2 ^ (max_payload + 2), so
  1053. * if we set this to max_speed + 7, we get the right value.
  1054. */
  1055. max_payload = min(device->max_speed + 7,
  1056. device->card->max_receive - 1);
  1057. orb->request.misc =
  1058. COMMAND_ORB_MAX_PAYLOAD(max_payload) |
  1059. COMMAND_ORB_SPEED(device->max_speed) |
  1060. COMMAND_ORB_NOTIFY;
  1061. if (cmd->sc_data_direction == DMA_FROM_DEVICE)
  1062. orb->request.misc |=
  1063. COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
  1064. else if (cmd->sc_data_direction == DMA_TO_DEVICE)
  1065. orb->request.misc |=
  1066. COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
  1067. if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
  1068. goto out;
  1069. fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
  1070. memset(orb->request.command_block,
  1071. 0, sizeof(orb->request.command_block));
  1072. memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
  1073. orb->base.callback = complete_command_orb;
  1074. orb->base.request_bus =
  1075. dma_map_single(device->card->device, &orb->request,
  1076. sizeof(orb->request), DMA_TO_DEVICE);
  1077. if (dma_mapping_error(orb->base.request_bus))
  1078. goto out;
  1079. sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, lu->generation,
  1080. lu->command_block_agent_address + SBP2_ORB_POINTER);
  1081. retval = 0;
  1082. out:
  1083. kref_put(&orb->base.kref, free_orb);
  1084. return retval;
  1085. }
  1086. static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
  1087. {
  1088. struct sbp2_logical_unit *lu = sdev->hostdata;
  1089. sdev->allow_restart = 1;
  1090. /*
  1091. * Update the dma alignment (minimum alignment requirements for
  1092. * start and end of DMA transfers) to be a sector
  1093. */
  1094. blk_queue_update_dma_alignment(sdev->request_queue, 511);
  1095. if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
  1096. sdev->inquiry_len = 36;
  1097. return 0;
  1098. }
  1099. static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
  1100. {
  1101. struct sbp2_logical_unit *lu = sdev->hostdata;
  1102. sdev->use_10_for_rw = 1;
  1103. if (sdev->type == TYPE_ROM)
  1104. sdev->use_10_for_ms = 1;
  1105. if (sdev->type == TYPE_DISK &&
  1106. lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
  1107. sdev->skip_ms_page_8 = 1;
  1108. if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
  1109. sdev->fix_capacity = 1;
  1110. if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
  1111. blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
  1112. return 0;
  1113. }
  1114. /*
  1115. * Called by scsi stack when something has really gone wrong. Usually
  1116. * called when a command has timed-out for some reason.
  1117. */
  1118. static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
  1119. {
  1120. struct sbp2_logical_unit *lu = cmd->device->hostdata;
  1121. fw_notify("sbp2_scsi_abort\n");
  1122. sbp2_agent_reset(lu);
  1123. sbp2_cancel_orbs(lu);
  1124. return SUCCESS;
  1125. }
  1126. /*
  1127. * Format of /sys/bus/scsi/devices/.../ieee1394_id:
  1128. * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
  1129. *
  1130. * This is the concatenation of target port identifier and logical unit
  1131. * identifier as per SAM-2...SAM-4 annex A.
  1132. */
  1133. static ssize_t
  1134. sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
  1135. char *buf)
  1136. {
  1137. struct scsi_device *sdev = to_scsi_device(dev);
  1138. struct sbp2_logical_unit *lu;
  1139. struct fw_device *device;
  1140. if (!sdev)
  1141. return 0;
  1142. lu = sdev->hostdata;
  1143. device = fw_device(lu->tgt->unit->device.parent);
  1144. return sprintf(buf, "%08x%08x:%06x:%04x\n",
  1145. device->config_rom[3], device->config_rom[4],
  1146. lu->tgt->directory_id, lu->lun);
  1147. }
  1148. static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
  1149. static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
  1150. &dev_attr_ieee1394_id,
  1151. NULL
  1152. };
  1153. static struct scsi_host_template scsi_driver_template = {
  1154. .module = THIS_MODULE,
  1155. .name = "SBP-2 IEEE-1394",
  1156. .proc_name = sbp2_driver_name,
  1157. .queuecommand = sbp2_scsi_queuecommand,
  1158. .slave_alloc = sbp2_scsi_slave_alloc,
  1159. .slave_configure = sbp2_scsi_slave_configure,
  1160. .eh_abort_handler = sbp2_scsi_abort,
  1161. .this_id = -1,
  1162. .sg_tablesize = SG_ALL,
  1163. .use_clustering = ENABLE_CLUSTERING,
  1164. .cmd_per_lun = 1,
  1165. .can_queue = 1,
  1166. .sdev_attrs = sbp2_scsi_sysfs_attrs,
  1167. };
  1168. MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
  1169. MODULE_DESCRIPTION("SCSI over IEEE1394");
  1170. MODULE_LICENSE("GPL");
  1171. MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
  1172. /* Provide a module alias so root-on-sbp2 initrds don't break. */
  1173. #ifndef CONFIG_IEEE1394_SBP2_MODULE
  1174. MODULE_ALIAS("sbp2");
  1175. #endif
  1176. static int __init sbp2_init(void)
  1177. {
  1178. sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
  1179. if (!sbp2_wq)
  1180. return -ENOMEM;
  1181. return driver_register(&sbp2_driver.driver);
  1182. }
  1183. static void __exit sbp2_cleanup(void)
  1184. {
  1185. driver_unregister(&sbp2_driver.driver);
  1186. destroy_workqueue(sbp2_wq);
  1187. }
  1188. module_init(sbp2_init);
  1189. module_exit(sbp2_cleanup);