vmw_pvscsi.c 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602
  1. /*
  2. * Linux driver for VMware's para-virtualized SCSI HBA.
  3. *
  4. * Copyright (C) 2008-2014, VMware, Inc. All Rights Reserved.
  5. *
  6. * This program is free software; you can redistribute it and/or modify it
  7. * under the terms of the GNU General Public License as published by the
  8. * Free Software Foundation; version 2 of the License and no later version.
  9. *
  10. * This program is distributed in the hope that it will be useful, but
  11. * WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  13. * NON INFRINGEMENT. See the GNU General Public License for more
  14. * 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
  18. * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19. *
  20. * Maintained by: Arvind Kumar <arvindkumar@vmware.com>
  21. *
  22. */
  23. #include <linux/kernel.h>
  24. #include <linux/module.h>
  25. #include <linux/interrupt.h>
  26. #include <linux/slab.h>
  27. #include <linux/workqueue.h>
  28. #include <linux/pci.h>
  29. #include <scsi/scsi.h>
  30. #include <scsi/scsi_host.h>
  31. #include <scsi/scsi_cmnd.h>
  32. #include <scsi/scsi_device.h>
  33. #include <scsi/scsi_tcq.h>
  34. #include "vmw_pvscsi.h"
  35. #define PVSCSI_LINUX_DRIVER_DESC "VMware PVSCSI driver"
  36. MODULE_DESCRIPTION(PVSCSI_LINUX_DRIVER_DESC);
  37. MODULE_AUTHOR("VMware, Inc.");
  38. MODULE_LICENSE("GPL");
  39. MODULE_VERSION(PVSCSI_DRIVER_VERSION_STRING);
  40. #define PVSCSI_DEFAULT_NUM_PAGES_PER_RING 8
  41. #define PVSCSI_DEFAULT_NUM_PAGES_MSG_RING 1
  42. #define PVSCSI_DEFAULT_QUEUE_DEPTH 254
  43. #define SGL_SIZE PAGE_SIZE
  44. struct pvscsi_sg_list {
  45. struct PVSCSISGElement sge[PVSCSI_MAX_NUM_SG_ENTRIES_PER_SEGMENT];
  46. };
  47. struct pvscsi_ctx {
  48. /*
  49. * The index of the context in cmd_map serves as the context ID for a
  50. * 1-to-1 mapping completions back to requests.
  51. */
  52. struct scsi_cmnd *cmd;
  53. struct pvscsi_sg_list *sgl;
  54. struct list_head list;
  55. dma_addr_t dataPA;
  56. dma_addr_t sensePA;
  57. dma_addr_t sglPA;
  58. struct completion *abort_cmp;
  59. };
  60. struct pvscsi_adapter {
  61. char *mmioBase;
  62. unsigned int irq;
  63. u8 rev;
  64. bool use_msi;
  65. bool use_msix;
  66. bool use_msg;
  67. bool use_req_threshold;
  68. spinlock_t hw_lock;
  69. struct workqueue_struct *workqueue;
  70. struct work_struct work;
  71. struct PVSCSIRingReqDesc *req_ring;
  72. unsigned req_pages;
  73. unsigned req_depth;
  74. dma_addr_t reqRingPA;
  75. struct PVSCSIRingCmpDesc *cmp_ring;
  76. unsigned cmp_pages;
  77. dma_addr_t cmpRingPA;
  78. struct PVSCSIRingMsgDesc *msg_ring;
  79. unsigned msg_pages;
  80. dma_addr_t msgRingPA;
  81. struct PVSCSIRingsState *rings_state;
  82. dma_addr_t ringStatePA;
  83. struct pci_dev *dev;
  84. struct Scsi_Host *host;
  85. struct list_head cmd_pool;
  86. struct pvscsi_ctx *cmd_map;
  87. };
  88. /* Command line parameters */
  89. static int pvscsi_ring_pages;
  90. static int pvscsi_msg_ring_pages = PVSCSI_DEFAULT_NUM_PAGES_MSG_RING;
  91. static int pvscsi_cmd_per_lun = PVSCSI_DEFAULT_QUEUE_DEPTH;
  92. static bool pvscsi_disable_msi;
  93. static bool pvscsi_disable_msix;
  94. static bool pvscsi_use_msg = true;
  95. static bool pvscsi_use_req_threshold = true;
  96. #define PVSCSI_RW (S_IRUSR | S_IWUSR)
  97. module_param_named(ring_pages, pvscsi_ring_pages, int, PVSCSI_RW);
  98. MODULE_PARM_DESC(ring_pages, "Number of pages per req/cmp ring - (default="
  99. __stringify(PVSCSI_DEFAULT_NUM_PAGES_PER_RING)
  100. "[up to 16 targets],"
  101. __stringify(PVSCSI_SETUP_RINGS_MAX_NUM_PAGES)
  102. "[for 16+ targets])");
  103. module_param_named(msg_ring_pages, pvscsi_msg_ring_pages, int, PVSCSI_RW);
  104. MODULE_PARM_DESC(msg_ring_pages, "Number of pages for the msg ring - (default="
  105. __stringify(PVSCSI_DEFAULT_NUM_PAGES_MSG_RING) ")");
  106. module_param_named(cmd_per_lun, pvscsi_cmd_per_lun, int, PVSCSI_RW);
  107. MODULE_PARM_DESC(cmd_per_lun, "Maximum commands per lun - (default="
  108. __stringify(PVSCSI_DEFAULT_QUEUE_DEPTH) ")");
  109. module_param_named(disable_msi, pvscsi_disable_msi, bool, PVSCSI_RW);
  110. MODULE_PARM_DESC(disable_msi, "Disable MSI use in driver - (default=0)");
  111. module_param_named(disable_msix, pvscsi_disable_msix, bool, PVSCSI_RW);
  112. MODULE_PARM_DESC(disable_msix, "Disable MSI-X use in driver - (default=0)");
  113. module_param_named(use_msg, pvscsi_use_msg, bool, PVSCSI_RW);
  114. MODULE_PARM_DESC(use_msg, "Use msg ring when available - (default=1)");
  115. module_param_named(use_req_threshold, pvscsi_use_req_threshold,
  116. bool, PVSCSI_RW);
  117. MODULE_PARM_DESC(use_req_threshold, "Use driver-based request coalescing if configured - (default=1)");
  118. static const struct pci_device_id pvscsi_pci_tbl[] = {
  119. { PCI_VDEVICE(VMWARE, PCI_DEVICE_ID_VMWARE_PVSCSI) },
  120. { 0 }
  121. };
  122. MODULE_DEVICE_TABLE(pci, pvscsi_pci_tbl);
  123. static struct device *
  124. pvscsi_dev(const struct pvscsi_adapter *adapter)
  125. {
  126. return &(adapter->dev->dev);
  127. }
  128. static struct pvscsi_ctx *
  129. pvscsi_find_context(const struct pvscsi_adapter *adapter, struct scsi_cmnd *cmd)
  130. {
  131. struct pvscsi_ctx *ctx, *end;
  132. end = &adapter->cmd_map[adapter->req_depth];
  133. for (ctx = adapter->cmd_map; ctx < end; ctx++)
  134. if (ctx->cmd == cmd)
  135. return ctx;
  136. return NULL;
  137. }
  138. static struct pvscsi_ctx *
  139. pvscsi_acquire_context(struct pvscsi_adapter *adapter, struct scsi_cmnd *cmd)
  140. {
  141. struct pvscsi_ctx *ctx;
  142. if (list_empty(&adapter->cmd_pool))
  143. return NULL;
  144. ctx = list_first_entry(&adapter->cmd_pool, struct pvscsi_ctx, list);
  145. ctx->cmd = cmd;
  146. list_del(&ctx->list);
  147. return ctx;
  148. }
  149. static void pvscsi_release_context(struct pvscsi_adapter *adapter,
  150. struct pvscsi_ctx *ctx)
  151. {
  152. ctx->cmd = NULL;
  153. ctx->abort_cmp = NULL;
  154. list_add(&ctx->list, &adapter->cmd_pool);
  155. }
  156. /*
  157. * Map a pvscsi_ctx struct to a context ID field value; we map to a simple
  158. * non-zero integer. ctx always points to an entry in cmd_map array, hence
  159. * the return value is always >=1.
  160. */
  161. static u64 pvscsi_map_context(const struct pvscsi_adapter *adapter,
  162. const struct pvscsi_ctx *ctx)
  163. {
  164. return ctx - adapter->cmd_map + 1;
  165. }
  166. static struct pvscsi_ctx *
  167. pvscsi_get_context(const struct pvscsi_adapter *adapter, u64 context)
  168. {
  169. return &adapter->cmd_map[context - 1];
  170. }
  171. static void pvscsi_reg_write(const struct pvscsi_adapter *adapter,
  172. u32 offset, u32 val)
  173. {
  174. writel(val, adapter->mmioBase + offset);
  175. }
  176. static u32 pvscsi_reg_read(const struct pvscsi_adapter *adapter, u32 offset)
  177. {
  178. return readl(adapter->mmioBase + offset);
  179. }
  180. static u32 pvscsi_read_intr_status(const struct pvscsi_adapter *adapter)
  181. {
  182. return pvscsi_reg_read(adapter, PVSCSI_REG_OFFSET_INTR_STATUS);
  183. }
  184. static void pvscsi_write_intr_status(const struct pvscsi_adapter *adapter,
  185. u32 val)
  186. {
  187. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_INTR_STATUS, val);
  188. }
  189. static void pvscsi_unmask_intr(const struct pvscsi_adapter *adapter)
  190. {
  191. u32 intr_bits;
  192. intr_bits = PVSCSI_INTR_CMPL_MASK;
  193. if (adapter->use_msg)
  194. intr_bits |= PVSCSI_INTR_MSG_MASK;
  195. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_INTR_MASK, intr_bits);
  196. }
  197. static void pvscsi_mask_intr(const struct pvscsi_adapter *adapter)
  198. {
  199. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_INTR_MASK, 0);
  200. }
  201. static void pvscsi_write_cmd_desc(const struct pvscsi_adapter *adapter,
  202. u32 cmd, const void *desc, size_t len)
  203. {
  204. const u32 *ptr = desc;
  205. size_t i;
  206. len /= sizeof(*ptr);
  207. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_COMMAND, cmd);
  208. for (i = 0; i < len; i++)
  209. pvscsi_reg_write(adapter,
  210. PVSCSI_REG_OFFSET_COMMAND_DATA, ptr[i]);
  211. }
  212. static void pvscsi_abort_cmd(const struct pvscsi_adapter *adapter,
  213. const struct pvscsi_ctx *ctx)
  214. {
  215. struct PVSCSICmdDescAbortCmd cmd = { 0 };
  216. cmd.target = ctx->cmd->device->id;
  217. cmd.context = pvscsi_map_context(adapter, ctx);
  218. pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_ABORT_CMD, &cmd, sizeof(cmd));
  219. }
  220. static void pvscsi_kick_rw_io(const struct pvscsi_adapter *adapter)
  221. {
  222. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_KICK_RW_IO, 0);
  223. }
  224. static void pvscsi_process_request_ring(const struct pvscsi_adapter *adapter)
  225. {
  226. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_KICK_NON_RW_IO, 0);
  227. }
  228. static int scsi_is_rw(unsigned char op)
  229. {
  230. return op == READ_6 || op == WRITE_6 ||
  231. op == READ_10 || op == WRITE_10 ||
  232. op == READ_12 || op == WRITE_12 ||
  233. op == READ_16 || op == WRITE_16;
  234. }
  235. static void pvscsi_kick_io(const struct pvscsi_adapter *adapter,
  236. unsigned char op)
  237. {
  238. if (scsi_is_rw(op)) {
  239. struct PVSCSIRingsState *s = adapter->rings_state;
  240. if (!adapter->use_req_threshold ||
  241. s->reqProdIdx - s->reqConsIdx >= s->reqCallThreshold)
  242. pvscsi_kick_rw_io(adapter);
  243. } else {
  244. pvscsi_process_request_ring(adapter);
  245. }
  246. }
  247. static void ll_adapter_reset(const struct pvscsi_adapter *adapter)
  248. {
  249. dev_dbg(pvscsi_dev(adapter), "Adapter Reset on %p\n", adapter);
  250. pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_ADAPTER_RESET, NULL, 0);
  251. }
  252. static void ll_bus_reset(const struct pvscsi_adapter *adapter)
  253. {
  254. dev_dbg(pvscsi_dev(adapter), "Resetting bus on %p\n", adapter);
  255. pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_RESET_BUS, NULL, 0);
  256. }
  257. static void ll_device_reset(const struct pvscsi_adapter *adapter, u32 target)
  258. {
  259. struct PVSCSICmdDescResetDevice cmd = { 0 };
  260. dev_dbg(pvscsi_dev(adapter), "Resetting device: target=%u\n", target);
  261. cmd.target = target;
  262. pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_RESET_DEVICE,
  263. &cmd, sizeof(cmd));
  264. }
  265. static void pvscsi_create_sg(struct pvscsi_ctx *ctx,
  266. struct scatterlist *sg, unsigned count)
  267. {
  268. unsigned i;
  269. struct PVSCSISGElement *sge;
  270. BUG_ON(count > PVSCSI_MAX_NUM_SG_ENTRIES_PER_SEGMENT);
  271. sge = &ctx->sgl->sge[0];
  272. for (i = 0; i < count; i++, sg++) {
  273. sge[i].addr = sg_dma_address(sg);
  274. sge[i].length = sg_dma_len(sg);
  275. sge[i].flags = 0;
  276. }
  277. }
  278. /*
  279. * Map all data buffers for a command into PCI space and
  280. * setup the scatter/gather list if needed.
  281. */
  282. static void pvscsi_map_buffers(struct pvscsi_adapter *adapter,
  283. struct pvscsi_ctx *ctx, struct scsi_cmnd *cmd,
  284. struct PVSCSIRingReqDesc *e)
  285. {
  286. unsigned count;
  287. unsigned bufflen = scsi_bufflen(cmd);
  288. struct scatterlist *sg;
  289. e->dataLen = bufflen;
  290. e->dataAddr = 0;
  291. if (bufflen == 0)
  292. return;
  293. sg = scsi_sglist(cmd);
  294. count = scsi_sg_count(cmd);
  295. if (count != 0) {
  296. int segs = scsi_dma_map(cmd);
  297. if (segs > 1) {
  298. pvscsi_create_sg(ctx, sg, segs);
  299. e->flags |= PVSCSI_FLAG_CMD_WITH_SG_LIST;
  300. ctx->sglPA = pci_map_single(adapter->dev, ctx->sgl,
  301. SGL_SIZE, PCI_DMA_TODEVICE);
  302. e->dataAddr = ctx->sglPA;
  303. } else
  304. e->dataAddr = sg_dma_address(sg);
  305. } else {
  306. /*
  307. * In case there is no S/G list, scsi_sglist points
  308. * directly to the buffer.
  309. */
  310. ctx->dataPA = pci_map_single(adapter->dev, sg, bufflen,
  311. cmd->sc_data_direction);
  312. e->dataAddr = ctx->dataPA;
  313. }
  314. }
  315. static void pvscsi_unmap_buffers(const struct pvscsi_adapter *adapter,
  316. struct pvscsi_ctx *ctx)
  317. {
  318. struct scsi_cmnd *cmd;
  319. unsigned bufflen;
  320. cmd = ctx->cmd;
  321. bufflen = scsi_bufflen(cmd);
  322. if (bufflen != 0) {
  323. unsigned count = scsi_sg_count(cmd);
  324. if (count != 0) {
  325. scsi_dma_unmap(cmd);
  326. if (ctx->sglPA) {
  327. pci_unmap_single(adapter->dev, ctx->sglPA,
  328. SGL_SIZE, PCI_DMA_TODEVICE);
  329. ctx->sglPA = 0;
  330. }
  331. } else
  332. pci_unmap_single(adapter->dev, ctx->dataPA, bufflen,
  333. cmd->sc_data_direction);
  334. }
  335. if (cmd->sense_buffer)
  336. pci_unmap_single(adapter->dev, ctx->sensePA,
  337. SCSI_SENSE_BUFFERSIZE, PCI_DMA_FROMDEVICE);
  338. }
  339. static int pvscsi_allocate_rings(struct pvscsi_adapter *adapter)
  340. {
  341. adapter->rings_state = pci_alloc_consistent(adapter->dev, PAGE_SIZE,
  342. &adapter->ringStatePA);
  343. if (!adapter->rings_state)
  344. return -ENOMEM;
  345. adapter->req_pages = min(PVSCSI_MAX_NUM_PAGES_REQ_RING,
  346. pvscsi_ring_pages);
  347. adapter->req_depth = adapter->req_pages
  348. * PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
  349. adapter->req_ring = pci_alloc_consistent(adapter->dev,
  350. adapter->req_pages * PAGE_SIZE,
  351. &adapter->reqRingPA);
  352. if (!adapter->req_ring)
  353. return -ENOMEM;
  354. adapter->cmp_pages = min(PVSCSI_MAX_NUM_PAGES_CMP_RING,
  355. pvscsi_ring_pages);
  356. adapter->cmp_ring = pci_alloc_consistent(adapter->dev,
  357. adapter->cmp_pages * PAGE_SIZE,
  358. &adapter->cmpRingPA);
  359. if (!adapter->cmp_ring)
  360. return -ENOMEM;
  361. BUG_ON(!IS_ALIGNED(adapter->ringStatePA, PAGE_SIZE));
  362. BUG_ON(!IS_ALIGNED(adapter->reqRingPA, PAGE_SIZE));
  363. BUG_ON(!IS_ALIGNED(adapter->cmpRingPA, PAGE_SIZE));
  364. if (!adapter->use_msg)
  365. return 0;
  366. adapter->msg_pages = min(PVSCSI_MAX_NUM_PAGES_MSG_RING,
  367. pvscsi_msg_ring_pages);
  368. adapter->msg_ring = pci_alloc_consistent(adapter->dev,
  369. adapter->msg_pages * PAGE_SIZE,
  370. &adapter->msgRingPA);
  371. if (!adapter->msg_ring)
  372. return -ENOMEM;
  373. BUG_ON(!IS_ALIGNED(adapter->msgRingPA, PAGE_SIZE));
  374. return 0;
  375. }
  376. static void pvscsi_setup_all_rings(const struct pvscsi_adapter *adapter)
  377. {
  378. struct PVSCSICmdDescSetupRings cmd = { 0 };
  379. dma_addr_t base;
  380. unsigned i;
  381. cmd.ringsStatePPN = adapter->ringStatePA >> PAGE_SHIFT;
  382. cmd.reqRingNumPages = adapter->req_pages;
  383. cmd.cmpRingNumPages = adapter->cmp_pages;
  384. base = adapter->reqRingPA;
  385. for (i = 0; i < adapter->req_pages; i++) {
  386. cmd.reqRingPPNs[i] = base >> PAGE_SHIFT;
  387. base += PAGE_SIZE;
  388. }
  389. base = adapter->cmpRingPA;
  390. for (i = 0; i < adapter->cmp_pages; i++) {
  391. cmd.cmpRingPPNs[i] = base >> PAGE_SHIFT;
  392. base += PAGE_SIZE;
  393. }
  394. memset(adapter->rings_state, 0, PAGE_SIZE);
  395. memset(adapter->req_ring, 0, adapter->req_pages * PAGE_SIZE);
  396. memset(adapter->cmp_ring, 0, adapter->cmp_pages * PAGE_SIZE);
  397. pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_SETUP_RINGS,
  398. &cmd, sizeof(cmd));
  399. if (adapter->use_msg) {
  400. struct PVSCSICmdDescSetupMsgRing cmd_msg = { 0 };
  401. cmd_msg.numPages = adapter->msg_pages;
  402. base = adapter->msgRingPA;
  403. for (i = 0; i < adapter->msg_pages; i++) {
  404. cmd_msg.ringPPNs[i] = base >> PAGE_SHIFT;
  405. base += PAGE_SIZE;
  406. }
  407. memset(adapter->msg_ring, 0, adapter->msg_pages * PAGE_SIZE);
  408. pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_SETUP_MSG_RING,
  409. &cmd_msg, sizeof(cmd_msg));
  410. }
  411. }
  412. static int pvscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
  413. {
  414. if (!sdev->tagged_supported)
  415. qdepth = 1;
  416. return scsi_change_queue_depth(sdev, qdepth);
  417. }
  418. /*
  419. * Pull a completion descriptor off and pass the completion back
  420. * to the SCSI mid layer.
  421. */
  422. static void pvscsi_complete_request(struct pvscsi_adapter *adapter,
  423. const struct PVSCSIRingCmpDesc *e)
  424. {
  425. struct pvscsi_ctx *ctx;
  426. struct scsi_cmnd *cmd;
  427. struct completion *abort_cmp;
  428. u32 btstat = e->hostStatus;
  429. u32 sdstat = e->scsiStatus;
  430. ctx = pvscsi_get_context(adapter, e->context);
  431. cmd = ctx->cmd;
  432. abort_cmp = ctx->abort_cmp;
  433. pvscsi_unmap_buffers(adapter, ctx);
  434. pvscsi_release_context(adapter, ctx);
  435. if (abort_cmp) {
  436. /*
  437. * The command was requested to be aborted. Just signal that
  438. * the request completed and swallow the actual cmd completion
  439. * here. The abort handler will post a completion for this
  440. * command indicating that it got successfully aborted.
  441. */
  442. complete(abort_cmp);
  443. return;
  444. }
  445. cmd->result = 0;
  446. if (sdstat != SAM_STAT_GOOD &&
  447. (btstat == BTSTAT_SUCCESS ||
  448. btstat == BTSTAT_LINKED_COMMAND_COMPLETED ||
  449. btstat == BTSTAT_LINKED_COMMAND_COMPLETED_WITH_FLAG)) {
  450. if (sdstat == SAM_STAT_COMMAND_TERMINATED) {
  451. cmd->result = (DID_RESET << 16);
  452. } else {
  453. cmd->result = (DID_OK << 16) | sdstat;
  454. if (sdstat == SAM_STAT_CHECK_CONDITION &&
  455. cmd->sense_buffer)
  456. cmd->result |= (DRIVER_SENSE << 24);
  457. }
  458. } else
  459. switch (btstat) {
  460. case BTSTAT_SUCCESS:
  461. case BTSTAT_LINKED_COMMAND_COMPLETED:
  462. case BTSTAT_LINKED_COMMAND_COMPLETED_WITH_FLAG:
  463. /* If everything went fine, let's move on.. */
  464. cmd->result = (DID_OK << 16);
  465. break;
  466. case BTSTAT_DATARUN:
  467. case BTSTAT_DATA_UNDERRUN:
  468. /* Report residual data in underruns */
  469. scsi_set_resid(cmd, scsi_bufflen(cmd) - e->dataLen);
  470. cmd->result = (DID_ERROR << 16);
  471. break;
  472. case BTSTAT_SELTIMEO:
  473. /* Our emulation returns this for non-connected devs */
  474. cmd->result = (DID_BAD_TARGET << 16);
  475. break;
  476. case BTSTAT_LUNMISMATCH:
  477. case BTSTAT_TAGREJECT:
  478. case BTSTAT_BADMSG:
  479. cmd->result = (DRIVER_INVALID << 24);
  480. /* fall through */
  481. case BTSTAT_HAHARDWARE:
  482. case BTSTAT_INVPHASE:
  483. case BTSTAT_HATIMEOUT:
  484. case BTSTAT_NORESPONSE:
  485. case BTSTAT_DISCONNECT:
  486. case BTSTAT_HASOFTWARE:
  487. case BTSTAT_BUSFREE:
  488. case BTSTAT_SENSFAILED:
  489. cmd->result |= (DID_ERROR << 16);
  490. break;
  491. case BTSTAT_SENTRST:
  492. case BTSTAT_RECVRST:
  493. case BTSTAT_BUSRESET:
  494. cmd->result = (DID_RESET << 16);
  495. break;
  496. case BTSTAT_ABORTQUEUE:
  497. cmd->result = (DID_ABORT << 16);
  498. break;
  499. case BTSTAT_SCSIPARITY:
  500. cmd->result = (DID_PARITY << 16);
  501. break;
  502. default:
  503. cmd->result = (DID_ERROR << 16);
  504. scmd_printk(KERN_DEBUG, cmd,
  505. "Unknown completion status: 0x%x\n",
  506. btstat);
  507. }
  508. dev_dbg(&cmd->device->sdev_gendev,
  509. "cmd=%p %x ctx=%p result=0x%x status=0x%x,%x\n",
  510. cmd, cmd->cmnd[0], ctx, cmd->result, btstat, sdstat);
  511. cmd->scsi_done(cmd);
  512. }
  513. /*
  514. * barrier usage : Since the PVSCSI device is emulated, there could be cases
  515. * where we may want to serialize some accesses between the driver and the
  516. * emulation layer. We use compiler barriers instead of the more expensive
  517. * memory barriers because PVSCSI is only supported on X86 which has strong
  518. * memory access ordering.
  519. */
  520. static void pvscsi_process_completion_ring(struct pvscsi_adapter *adapter)
  521. {
  522. struct PVSCSIRingsState *s = adapter->rings_state;
  523. struct PVSCSIRingCmpDesc *ring = adapter->cmp_ring;
  524. u32 cmp_entries = s->cmpNumEntriesLog2;
  525. while (s->cmpConsIdx != s->cmpProdIdx) {
  526. struct PVSCSIRingCmpDesc *e = ring + (s->cmpConsIdx &
  527. MASK(cmp_entries));
  528. /*
  529. * This barrier() ensures that *e is not dereferenced while
  530. * the device emulation still writes data into the slot.
  531. * Since the device emulation advances s->cmpProdIdx only after
  532. * updating the slot we want to check it first.
  533. */
  534. barrier();
  535. pvscsi_complete_request(adapter, e);
  536. /*
  537. * This barrier() ensures that compiler doesn't reorder write
  538. * to s->cmpConsIdx before the read of (*e) inside
  539. * pvscsi_complete_request. Otherwise, device emulation may
  540. * overwrite *e before we had a chance to read it.
  541. */
  542. barrier();
  543. s->cmpConsIdx++;
  544. }
  545. }
  546. /*
  547. * Translate a Linux SCSI request into a request ring entry.
  548. */
  549. static int pvscsi_queue_ring(struct pvscsi_adapter *adapter,
  550. struct pvscsi_ctx *ctx, struct scsi_cmnd *cmd)
  551. {
  552. struct PVSCSIRingsState *s;
  553. struct PVSCSIRingReqDesc *e;
  554. struct scsi_device *sdev;
  555. u32 req_entries;
  556. s = adapter->rings_state;
  557. sdev = cmd->device;
  558. req_entries = s->reqNumEntriesLog2;
  559. /*
  560. * If this condition holds, we might have room on the request ring, but
  561. * we might not have room on the completion ring for the response.
  562. * However, we have already ruled out this possibility - we would not
  563. * have successfully allocated a context if it were true, since we only
  564. * have one context per request entry. Check for it anyway, since it
  565. * would be a serious bug.
  566. */
  567. if (s->reqProdIdx - s->cmpConsIdx >= 1 << req_entries) {
  568. scmd_printk(KERN_ERR, cmd, "vmw_pvscsi: "
  569. "ring full: reqProdIdx=%d cmpConsIdx=%d\n",
  570. s->reqProdIdx, s->cmpConsIdx);
  571. return -1;
  572. }
  573. e = adapter->req_ring + (s->reqProdIdx & MASK(req_entries));
  574. e->bus = sdev->channel;
  575. e->target = sdev->id;
  576. memset(e->lun, 0, sizeof(e->lun));
  577. e->lun[1] = sdev->lun;
  578. if (cmd->sense_buffer) {
  579. ctx->sensePA = pci_map_single(adapter->dev, cmd->sense_buffer,
  580. SCSI_SENSE_BUFFERSIZE,
  581. PCI_DMA_FROMDEVICE);
  582. e->senseAddr = ctx->sensePA;
  583. e->senseLen = SCSI_SENSE_BUFFERSIZE;
  584. } else {
  585. e->senseLen = 0;
  586. e->senseAddr = 0;
  587. }
  588. e->cdbLen = cmd->cmd_len;
  589. e->vcpuHint = smp_processor_id();
  590. memcpy(e->cdb, cmd->cmnd, e->cdbLen);
  591. e->tag = SIMPLE_QUEUE_TAG;
  592. if (cmd->sc_data_direction == DMA_FROM_DEVICE)
  593. e->flags = PVSCSI_FLAG_CMD_DIR_TOHOST;
  594. else if (cmd->sc_data_direction == DMA_TO_DEVICE)
  595. e->flags = PVSCSI_FLAG_CMD_DIR_TODEVICE;
  596. else if (cmd->sc_data_direction == DMA_NONE)
  597. e->flags = PVSCSI_FLAG_CMD_DIR_NONE;
  598. else
  599. e->flags = 0;
  600. pvscsi_map_buffers(adapter, ctx, cmd, e);
  601. e->context = pvscsi_map_context(adapter, ctx);
  602. barrier();
  603. s->reqProdIdx++;
  604. return 0;
  605. }
  606. static int pvscsi_queue_lck(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
  607. {
  608. struct Scsi_Host *host = cmd->device->host;
  609. struct pvscsi_adapter *adapter = shost_priv(host);
  610. struct pvscsi_ctx *ctx;
  611. unsigned long flags;
  612. spin_lock_irqsave(&adapter->hw_lock, flags);
  613. ctx = pvscsi_acquire_context(adapter, cmd);
  614. if (!ctx || pvscsi_queue_ring(adapter, ctx, cmd) != 0) {
  615. if (ctx)
  616. pvscsi_release_context(adapter, ctx);
  617. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  618. return SCSI_MLQUEUE_HOST_BUSY;
  619. }
  620. cmd->scsi_done = done;
  621. dev_dbg(&cmd->device->sdev_gendev,
  622. "queued cmd %p, ctx %p, op=%x\n", cmd, ctx, cmd->cmnd[0]);
  623. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  624. pvscsi_kick_io(adapter, cmd->cmnd[0]);
  625. return 0;
  626. }
  627. static DEF_SCSI_QCMD(pvscsi_queue)
  628. static int pvscsi_abort(struct scsi_cmnd *cmd)
  629. {
  630. struct pvscsi_adapter *adapter = shost_priv(cmd->device->host);
  631. struct pvscsi_ctx *ctx;
  632. unsigned long flags;
  633. int result = SUCCESS;
  634. DECLARE_COMPLETION_ONSTACK(abort_cmp);
  635. scmd_printk(KERN_DEBUG, cmd, "task abort on host %u, %p\n",
  636. adapter->host->host_no, cmd);
  637. spin_lock_irqsave(&adapter->hw_lock, flags);
  638. /*
  639. * Poll the completion ring first - we might be trying to abort
  640. * a command that is waiting to be dispatched in the completion ring.
  641. */
  642. pvscsi_process_completion_ring(adapter);
  643. /*
  644. * If there is no context for the command, it either already succeeded
  645. * or else was never properly issued. Not our problem.
  646. */
  647. ctx = pvscsi_find_context(adapter, cmd);
  648. if (!ctx) {
  649. scmd_printk(KERN_DEBUG, cmd, "Failed to abort cmd %p\n", cmd);
  650. goto out;
  651. }
  652. /*
  653. * Mark that the command has been requested to be aborted and issue
  654. * the abort.
  655. */
  656. ctx->abort_cmp = &abort_cmp;
  657. pvscsi_abort_cmd(adapter, ctx);
  658. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  659. /* Wait for 2 secs for the completion. */
  660. wait_for_completion_timeout(&abort_cmp, msecs_to_jiffies(2000));
  661. spin_lock_irqsave(&adapter->hw_lock, flags);
  662. if (!completion_done(&abort_cmp)) {
  663. /*
  664. * Failed to abort the command, unmark the fact that it
  665. * was requested to be aborted.
  666. */
  667. ctx->abort_cmp = NULL;
  668. result = FAILED;
  669. scmd_printk(KERN_DEBUG, cmd,
  670. "Failed to get completion for aborted cmd %p\n",
  671. cmd);
  672. goto out;
  673. }
  674. /*
  675. * Successfully aborted the command.
  676. */
  677. cmd->result = (DID_ABORT << 16);
  678. cmd->scsi_done(cmd);
  679. out:
  680. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  681. return result;
  682. }
  683. /*
  684. * Abort all outstanding requests. This is only safe to use if the completion
  685. * ring will never be walked again or the device has been reset, because it
  686. * destroys the 1-1 mapping between context field passed to emulation and our
  687. * request structure.
  688. */
  689. static void pvscsi_reset_all(struct pvscsi_adapter *adapter)
  690. {
  691. unsigned i;
  692. for (i = 0; i < adapter->req_depth; i++) {
  693. struct pvscsi_ctx *ctx = &adapter->cmd_map[i];
  694. struct scsi_cmnd *cmd = ctx->cmd;
  695. if (cmd) {
  696. scmd_printk(KERN_ERR, cmd,
  697. "Forced reset on cmd %p\n", cmd);
  698. pvscsi_unmap_buffers(adapter, ctx);
  699. pvscsi_release_context(adapter, ctx);
  700. cmd->result = (DID_RESET << 16);
  701. cmd->scsi_done(cmd);
  702. }
  703. }
  704. }
  705. static int pvscsi_host_reset(struct scsi_cmnd *cmd)
  706. {
  707. struct Scsi_Host *host = cmd->device->host;
  708. struct pvscsi_adapter *adapter = shost_priv(host);
  709. unsigned long flags;
  710. bool use_msg;
  711. scmd_printk(KERN_INFO, cmd, "SCSI Host reset\n");
  712. spin_lock_irqsave(&adapter->hw_lock, flags);
  713. use_msg = adapter->use_msg;
  714. if (use_msg) {
  715. adapter->use_msg = 0;
  716. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  717. /*
  718. * Now that we know that the ISR won't add more work on the
  719. * workqueue we can safely flush any outstanding work.
  720. */
  721. flush_workqueue(adapter->workqueue);
  722. spin_lock_irqsave(&adapter->hw_lock, flags);
  723. }
  724. /*
  725. * We're going to tear down the entire ring structure and set it back
  726. * up, so stalling new requests until all completions are flushed and
  727. * the rings are back in place.
  728. */
  729. pvscsi_process_request_ring(adapter);
  730. ll_adapter_reset(adapter);
  731. /*
  732. * Now process any completions. Note we do this AFTER adapter reset,
  733. * which is strange, but stops races where completions get posted
  734. * between processing the ring and issuing the reset. The backend will
  735. * not touch the ring memory after reset, so the immediately pre-reset
  736. * completion ring state is still valid.
  737. */
  738. pvscsi_process_completion_ring(adapter);
  739. pvscsi_reset_all(adapter);
  740. adapter->use_msg = use_msg;
  741. pvscsi_setup_all_rings(adapter);
  742. pvscsi_unmask_intr(adapter);
  743. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  744. return SUCCESS;
  745. }
  746. static int pvscsi_bus_reset(struct scsi_cmnd *cmd)
  747. {
  748. struct Scsi_Host *host = cmd->device->host;
  749. struct pvscsi_adapter *adapter = shost_priv(host);
  750. unsigned long flags;
  751. scmd_printk(KERN_INFO, cmd, "SCSI Bus reset\n");
  752. /*
  753. * We don't want to queue new requests for this bus after
  754. * flushing all pending requests to emulation, since new
  755. * requests could then sneak in during this bus reset phase,
  756. * so take the lock now.
  757. */
  758. spin_lock_irqsave(&adapter->hw_lock, flags);
  759. pvscsi_process_request_ring(adapter);
  760. ll_bus_reset(adapter);
  761. pvscsi_process_completion_ring(adapter);
  762. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  763. return SUCCESS;
  764. }
  765. static int pvscsi_device_reset(struct scsi_cmnd *cmd)
  766. {
  767. struct Scsi_Host *host = cmd->device->host;
  768. struct pvscsi_adapter *adapter = shost_priv(host);
  769. unsigned long flags;
  770. scmd_printk(KERN_INFO, cmd, "SCSI device reset on scsi%u:%u\n",
  771. host->host_no, cmd->device->id);
  772. /*
  773. * We don't want to queue new requests for this device after flushing
  774. * all pending requests to emulation, since new requests could then
  775. * sneak in during this device reset phase, so take the lock now.
  776. */
  777. spin_lock_irqsave(&adapter->hw_lock, flags);
  778. pvscsi_process_request_ring(adapter);
  779. ll_device_reset(adapter, cmd->device->id);
  780. pvscsi_process_completion_ring(adapter);
  781. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  782. return SUCCESS;
  783. }
  784. static struct scsi_host_template pvscsi_template;
  785. static const char *pvscsi_info(struct Scsi_Host *host)
  786. {
  787. struct pvscsi_adapter *adapter = shost_priv(host);
  788. static char buf[256];
  789. sprintf(buf, "VMware PVSCSI storage adapter rev %d, req/cmp/msg rings: "
  790. "%u/%u/%u pages, cmd_per_lun=%u", adapter->rev,
  791. adapter->req_pages, adapter->cmp_pages, adapter->msg_pages,
  792. pvscsi_template.cmd_per_lun);
  793. return buf;
  794. }
  795. static struct scsi_host_template pvscsi_template = {
  796. .module = THIS_MODULE,
  797. .name = "VMware PVSCSI Host Adapter",
  798. .proc_name = "vmw_pvscsi",
  799. .info = pvscsi_info,
  800. .queuecommand = pvscsi_queue,
  801. .this_id = -1,
  802. .sg_tablesize = PVSCSI_MAX_NUM_SG_ENTRIES_PER_SEGMENT,
  803. .dma_boundary = UINT_MAX,
  804. .max_sectors = 0xffff,
  805. .use_clustering = ENABLE_CLUSTERING,
  806. .change_queue_depth = pvscsi_change_queue_depth,
  807. .eh_abort_handler = pvscsi_abort,
  808. .eh_device_reset_handler = pvscsi_device_reset,
  809. .eh_bus_reset_handler = pvscsi_bus_reset,
  810. .eh_host_reset_handler = pvscsi_host_reset,
  811. };
  812. static void pvscsi_process_msg(const struct pvscsi_adapter *adapter,
  813. const struct PVSCSIRingMsgDesc *e)
  814. {
  815. struct PVSCSIRingsState *s = adapter->rings_state;
  816. struct Scsi_Host *host = adapter->host;
  817. struct scsi_device *sdev;
  818. printk(KERN_INFO "vmw_pvscsi: msg type: 0x%x - MSG RING: %u/%u (%u) \n",
  819. e->type, s->msgProdIdx, s->msgConsIdx, s->msgNumEntriesLog2);
  820. BUILD_BUG_ON(PVSCSI_MSG_LAST != 2);
  821. if (e->type == PVSCSI_MSG_DEV_ADDED) {
  822. struct PVSCSIMsgDescDevStatusChanged *desc;
  823. desc = (struct PVSCSIMsgDescDevStatusChanged *)e;
  824. printk(KERN_INFO
  825. "vmw_pvscsi: msg: device added at scsi%u:%u:%u\n",
  826. desc->bus, desc->target, desc->lun[1]);
  827. if (!scsi_host_get(host))
  828. return;
  829. sdev = scsi_device_lookup(host, desc->bus, desc->target,
  830. desc->lun[1]);
  831. if (sdev) {
  832. printk(KERN_INFO "vmw_pvscsi: device already exists\n");
  833. scsi_device_put(sdev);
  834. } else
  835. scsi_add_device(adapter->host, desc->bus,
  836. desc->target, desc->lun[1]);
  837. scsi_host_put(host);
  838. } else if (e->type == PVSCSI_MSG_DEV_REMOVED) {
  839. struct PVSCSIMsgDescDevStatusChanged *desc;
  840. desc = (struct PVSCSIMsgDescDevStatusChanged *)e;
  841. printk(KERN_INFO
  842. "vmw_pvscsi: msg: device removed at scsi%u:%u:%u\n",
  843. desc->bus, desc->target, desc->lun[1]);
  844. if (!scsi_host_get(host))
  845. return;
  846. sdev = scsi_device_lookup(host, desc->bus, desc->target,
  847. desc->lun[1]);
  848. if (sdev) {
  849. scsi_remove_device(sdev);
  850. scsi_device_put(sdev);
  851. } else
  852. printk(KERN_INFO
  853. "vmw_pvscsi: failed to lookup scsi%u:%u:%u\n",
  854. desc->bus, desc->target, desc->lun[1]);
  855. scsi_host_put(host);
  856. }
  857. }
  858. static int pvscsi_msg_pending(const struct pvscsi_adapter *adapter)
  859. {
  860. struct PVSCSIRingsState *s = adapter->rings_state;
  861. return s->msgProdIdx != s->msgConsIdx;
  862. }
  863. static void pvscsi_process_msg_ring(const struct pvscsi_adapter *adapter)
  864. {
  865. struct PVSCSIRingsState *s = adapter->rings_state;
  866. struct PVSCSIRingMsgDesc *ring = adapter->msg_ring;
  867. u32 msg_entries = s->msgNumEntriesLog2;
  868. while (pvscsi_msg_pending(adapter)) {
  869. struct PVSCSIRingMsgDesc *e = ring + (s->msgConsIdx &
  870. MASK(msg_entries));
  871. barrier();
  872. pvscsi_process_msg(adapter, e);
  873. barrier();
  874. s->msgConsIdx++;
  875. }
  876. }
  877. static void pvscsi_msg_workqueue_handler(struct work_struct *data)
  878. {
  879. struct pvscsi_adapter *adapter;
  880. adapter = container_of(data, struct pvscsi_adapter, work);
  881. pvscsi_process_msg_ring(adapter);
  882. }
  883. static int pvscsi_setup_msg_workqueue(struct pvscsi_adapter *adapter)
  884. {
  885. char name[32];
  886. if (!pvscsi_use_msg)
  887. return 0;
  888. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_COMMAND,
  889. PVSCSI_CMD_SETUP_MSG_RING);
  890. if (pvscsi_reg_read(adapter, PVSCSI_REG_OFFSET_COMMAND_STATUS) == -1)
  891. return 0;
  892. snprintf(name, sizeof(name),
  893. "vmw_pvscsi_wq_%u", adapter->host->host_no);
  894. adapter->workqueue = create_singlethread_workqueue(name);
  895. if (!adapter->workqueue) {
  896. printk(KERN_ERR "vmw_pvscsi: failed to create work queue\n");
  897. return 0;
  898. }
  899. INIT_WORK(&adapter->work, pvscsi_msg_workqueue_handler);
  900. return 1;
  901. }
  902. static bool pvscsi_setup_req_threshold(struct pvscsi_adapter *adapter,
  903. bool enable)
  904. {
  905. u32 val;
  906. if (!pvscsi_use_req_threshold)
  907. return false;
  908. pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_COMMAND,
  909. PVSCSI_CMD_SETUP_REQCALLTHRESHOLD);
  910. val = pvscsi_reg_read(adapter, PVSCSI_REG_OFFSET_COMMAND_STATUS);
  911. if (val == -1) {
  912. printk(KERN_INFO "vmw_pvscsi: device does not support req_threshold\n");
  913. return false;
  914. } else {
  915. struct PVSCSICmdDescSetupReqCall cmd_msg = { 0 };
  916. cmd_msg.enable = enable;
  917. printk(KERN_INFO
  918. "vmw_pvscsi: %sabling reqCallThreshold\n",
  919. enable ? "en" : "dis");
  920. pvscsi_write_cmd_desc(adapter,
  921. PVSCSI_CMD_SETUP_REQCALLTHRESHOLD,
  922. &cmd_msg, sizeof(cmd_msg));
  923. return pvscsi_reg_read(adapter,
  924. PVSCSI_REG_OFFSET_COMMAND_STATUS) != 0;
  925. }
  926. }
  927. static irqreturn_t pvscsi_isr(int irq, void *devp)
  928. {
  929. struct pvscsi_adapter *adapter = devp;
  930. int handled;
  931. if (adapter->use_msi || adapter->use_msix)
  932. handled = true;
  933. else {
  934. u32 val = pvscsi_read_intr_status(adapter);
  935. handled = (val & PVSCSI_INTR_ALL_SUPPORTED) != 0;
  936. if (handled)
  937. pvscsi_write_intr_status(devp, val);
  938. }
  939. if (handled) {
  940. unsigned long flags;
  941. spin_lock_irqsave(&adapter->hw_lock, flags);
  942. pvscsi_process_completion_ring(adapter);
  943. if (adapter->use_msg && pvscsi_msg_pending(adapter))
  944. queue_work(adapter->workqueue, &adapter->work);
  945. spin_unlock_irqrestore(&adapter->hw_lock, flags);
  946. }
  947. return IRQ_RETVAL(handled);
  948. }
  949. static void pvscsi_free_sgls(const struct pvscsi_adapter *adapter)
  950. {
  951. struct pvscsi_ctx *ctx = adapter->cmd_map;
  952. unsigned i;
  953. for (i = 0; i < adapter->req_depth; ++i, ++ctx)
  954. free_pages((unsigned long)ctx->sgl, get_order(SGL_SIZE));
  955. }
  956. static int pvscsi_setup_msix(const struct pvscsi_adapter *adapter,
  957. unsigned int *irq)
  958. {
  959. struct msix_entry entry = { 0, PVSCSI_VECTOR_COMPLETION };
  960. int ret;
  961. ret = pci_enable_msix_exact(adapter->dev, &entry, 1);
  962. if (ret)
  963. return ret;
  964. *irq = entry.vector;
  965. return 0;
  966. }
  967. static void pvscsi_shutdown_intr(struct pvscsi_adapter *adapter)
  968. {
  969. if (adapter->irq) {
  970. free_irq(adapter->irq, adapter);
  971. adapter->irq = 0;
  972. }
  973. if (adapter->use_msi) {
  974. pci_disable_msi(adapter->dev);
  975. adapter->use_msi = 0;
  976. } else if (adapter->use_msix) {
  977. pci_disable_msix(adapter->dev);
  978. adapter->use_msix = 0;
  979. }
  980. }
  981. static void pvscsi_release_resources(struct pvscsi_adapter *adapter)
  982. {
  983. if (adapter->workqueue)
  984. destroy_workqueue(adapter->workqueue);
  985. if (adapter->mmioBase)
  986. pci_iounmap(adapter->dev, adapter->mmioBase);
  987. pci_release_regions(adapter->dev);
  988. if (adapter->cmd_map) {
  989. pvscsi_free_sgls(adapter);
  990. kfree(adapter->cmd_map);
  991. }
  992. if (adapter->rings_state)
  993. pci_free_consistent(adapter->dev, PAGE_SIZE,
  994. adapter->rings_state, adapter->ringStatePA);
  995. if (adapter->req_ring)
  996. pci_free_consistent(adapter->dev,
  997. adapter->req_pages * PAGE_SIZE,
  998. adapter->req_ring, adapter->reqRingPA);
  999. if (adapter->cmp_ring)
  1000. pci_free_consistent(adapter->dev,
  1001. adapter->cmp_pages * PAGE_SIZE,
  1002. adapter->cmp_ring, adapter->cmpRingPA);
  1003. if (adapter->msg_ring)
  1004. pci_free_consistent(adapter->dev,
  1005. adapter->msg_pages * PAGE_SIZE,
  1006. adapter->msg_ring, adapter->msgRingPA);
  1007. }
  1008. /*
  1009. * Allocate scatter gather lists.
  1010. *
  1011. * These are statically allocated. Trying to be clever was not worth it.
  1012. *
  1013. * Dynamic allocation can fail, and we can't go deep into the memory
  1014. * allocator, since we're a SCSI driver, and trying too hard to allocate
  1015. * memory might generate disk I/O. We also don't want to fail disk I/O
  1016. * in that case because we can't get an allocation - the I/O could be
  1017. * trying to swap out data to free memory. Since that is pathological,
  1018. * just use a statically allocated scatter list.
  1019. *
  1020. */
  1021. static int pvscsi_allocate_sg(struct pvscsi_adapter *adapter)
  1022. {
  1023. struct pvscsi_ctx *ctx;
  1024. int i;
  1025. ctx = adapter->cmd_map;
  1026. BUILD_BUG_ON(sizeof(struct pvscsi_sg_list) > SGL_SIZE);
  1027. for (i = 0; i < adapter->req_depth; ++i, ++ctx) {
  1028. ctx->sgl = (void *)__get_free_pages(GFP_KERNEL,
  1029. get_order(SGL_SIZE));
  1030. ctx->sglPA = 0;
  1031. BUG_ON(!IS_ALIGNED(((unsigned long)ctx->sgl), PAGE_SIZE));
  1032. if (!ctx->sgl) {
  1033. for (; i >= 0; --i, --ctx) {
  1034. free_pages((unsigned long)ctx->sgl,
  1035. get_order(SGL_SIZE));
  1036. ctx->sgl = NULL;
  1037. }
  1038. return -ENOMEM;
  1039. }
  1040. }
  1041. return 0;
  1042. }
  1043. /*
  1044. * Query the device, fetch the config info and return the
  1045. * maximum number of targets on the adapter. In case of
  1046. * failure due to any reason return default i.e. 16.
  1047. */
  1048. static u32 pvscsi_get_max_targets(struct pvscsi_adapter *adapter)
  1049. {
  1050. struct PVSCSICmdDescConfigCmd cmd;
  1051. struct PVSCSIConfigPageHeader *header;
  1052. struct device *dev;
  1053. dma_addr_t configPagePA;
  1054. void *config_page;
  1055. u32 numPhys = 16;
  1056. dev = pvscsi_dev(adapter);
  1057. config_page = pci_alloc_consistent(adapter->dev, PAGE_SIZE,
  1058. &configPagePA);
  1059. if (!config_page) {
  1060. dev_warn(dev, "vmw_pvscsi: failed to allocate memory for config page\n");
  1061. goto exit;
  1062. }
  1063. BUG_ON(configPagePA & ~PAGE_MASK);
  1064. /* Fetch config info from the device. */
  1065. cmd.configPageAddress = ((u64)PVSCSI_CONFIG_CONTROLLER_ADDRESS) << 32;
  1066. cmd.configPageNum = PVSCSI_CONFIG_PAGE_CONTROLLER;
  1067. cmd.cmpAddr = configPagePA;
  1068. cmd._pad = 0;
  1069. /*
  1070. * Mark the completion page header with error values. If the device
  1071. * completes the command successfully, it sets the status values to
  1072. * indicate success.
  1073. */
  1074. header = config_page;
  1075. memset(header, 0, sizeof *header);
  1076. header->hostStatus = BTSTAT_INVPARAM;
  1077. header->scsiStatus = SDSTAT_CHECK;
  1078. pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_CONFIG, &cmd, sizeof cmd);
  1079. if (header->hostStatus == BTSTAT_SUCCESS &&
  1080. header->scsiStatus == SDSTAT_GOOD) {
  1081. struct PVSCSIConfigPageController *config;
  1082. config = config_page;
  1083. numPhys = config->numPhys;
  1084. } else
  1085. dev_warn(dev, "vmw_pvscsi: PVSCSI_CMD_CONFIG failed. hostStatus = 0x%x, scsiStatus = 0x%x\n",
  1086. header->hostStatus, header->scsiStatus);
  1087. pci_free_consistent(adapter->dev, PAGE_SIZE, config_page, configPagePA);
  1088. exit:
  1089. return numPhys;
  1090. }
  1091. static int pvscsi_probe(struct pci_dev *pdev, const struct pci_device_id *id)
  1092. {
  1093. struct pvscsi_adapter *adapter;
  1094. struct pvscsi_adapter adapter_temp;
  1095. struct Scsi_Host *host = NULL;
  1096. unsigned int i;
  1097. unsigned long flags = 0;
  1098. int error;
  1099. u32 max_id;
  1100. error = -ENODEV;
  1101. if (pci_enable_device(pdev))
  1102. return error;
  1103. if (pci_set_dma_mask(pdev, DMA_BIT_MASK(64)) == 0 &&
  1104. pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64)) == 0) {
  1105. printk(KERN_INFO "vmw_pvscsi: using 64bit dma\n");
  1106. } else if (pci_set_dma_mask(pdev, DMA_BIT_MASK(32)) == 0 &&
  1107. pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32)) == 0) {
  1108. printk(KERN_INFO "vmw_pvscsi: using 32bit dma\n");
  1109. } else {
  1110. printk(KERN_ERR "vmw_pvscsi: failed to set DMA mask\n");
  1111. goto out_disable_device;
  1112. }
  1113. /*
  1114. * Let's use a temp pvscsi_adapter struct until we find the number of
  1115. * targets on the adapter, after that we will switch to the real
  1116. * allocated struct.
  1117. */
  1118. adapter = &adapter_temp;
  1119. memset(adapter, 0, sizeof(*adapter));
  1120. adapter->dev = pdev;
  1121. adapter->rev = pdev->revision;
  1122. if (pci_request_regions(pdev, "vmw_pvscsi")) {
  1123. printk(KERN_ERR "vmw_pvscsi: pci memory selection failed\n");
  1124. goto out_disable_device;
  1125. }
  1126. for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
  1127. if ((pci_resource_flags(pdev, i) & PCI_BASE_ADDRESS_SPACE_IO))
  1128. continue;
  1129. if (pci_resource_len(pdev, i) < PVSCSI_MEM_SPACE_SIZE)
  1130. continue;
  1131. break;
  1132. }
  1133. if (i == DEVICE_COUNT_RESOURCE) {
  1134. printk(KERN_ERR
  1135. "vmw_pvscsi: adapter has no suitable MMIO region\n");
  1136. goto out_release_resources_and_disable;
  1137. }
  1138. adapter->mmioBase = pci_iomap(pdev, i, PVSCSI_MEM_SPACE_SIZE);
  1139. if (!adapter->mmioBase) {
  1140. printk(KERN_ERR
  1141. "vmw_pvscsi: can't iomap for BAR %d memsize %lu\n",
  1142. i, PVSCSI_MEM_SPACE_SIZE);
  1143. goto out_release_resources_and_disable;
  1144. }
  1145. pci_set_master(pdev);
  1146. /*
  1147. * Ask the device for max number of targets before deciding the
  1148. * default pvscsi_ring_pages value.
  1149. */
  1150. max_id = pvscsi_get_max_targets(adapter);
  1151. printk(KERN_INFO "vmw_pvscsi: max_id: %u\n", max_id);
  1152. if (pvscsi_ring_pages == 0)
  1153. /*
  1154. * Set the right default value. Up to 16 it is 8, above it is
  1155. * max.
  1156. */
  1157. pvscsi_ring_pages = (max_id > 16) ?
  1158. PVSCSI_SETUP_RINGS_MAX_NUM_PAGES :
  1159. PVSCSI_DEFAULT_NUM_PAGES_PER_RING;
  1160. printk(KERN_INFO
  1161. "vmw_pvscsi: setting ring_pages to %d\n",
  1162. pvscsi_ring_pages);
  1163. pvscsi_template.can_queue =
  1164. min(PVSCSI_MAX_NUM_PAGES_REQ_RING, pvscsi_ring_pages) *
  1165. PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
  1166. pvscsi_template.cmd_per_lun =
  1167. min(pvscsi_template.can_queue, pvscsi_cmd_per_lun);
  1168. host = scsi_host_alloc(&pvscsi_template, sizeof(struct pvscsi_adapter));
  1169. if (!host) {
  1170. printk(KERN_ERR "vmw_pvscsi: failed to allocate host\n");
  1171. goto out_release_resources_and_disable;
  1172. }
  1173. /*
  1174. * Let's use the real pvscsi_adapter struct here onwards.
  1175. */
  1176. adapter = shost_priv(host);
  1177. memset(adapter, 0, sizeof(*adapter));
  1178. adapter->dev = pdev;
  1179. adapter->host = host;
  1180. /*
  1181. * Copy back what we already have to the allocated adapter struct.
  1182. */
  1183. adapter->rev = adapter_temp.rev;
  1184. adapter->mmioBase = adapter_temp.mmioBase;
  1185. spin_lock_init(&adapter->hw_lock);
  1186. host->max_channel = 0;
  1187. host->max_lun = 1;
  1188. host->max_cmd_len = 16;
  1189. host->max_id = max_id;
  1190. pci_set_drvdata(pdev, host);
  1191. ll_adapter_reset(adapter);
  1192. adapter->use_msg = pvscsi_setup_msg_workqueue(adapter);
  1193. error = pvscsi_allocate_rings(adapter);
  1194. if (error) {
  1195. printk(KERN_ERR "vmw_pvscsi: unable to allocate ring memory\n");
  1196. goto out_release_resources;
  1197. }
  1198. /*
  1199. * From this point on we should reset the adapter if anything goes
  1200. * wrong.
  1201. */
  1202. pvscsi_setup_all_rings(adapter);
  1203. adapter->cmd_map = kcalloc(adapter->req_depth,
  1204. sizeof(struct pvscsi_ctx), GFP_KERNEL);
  1205. if (!adapter->cmd_map) {
  1206. printk(KERN_ERR "vmw_pvscsi: failed to allocate memory.\n");
  1207. error = -ENOMEM;
  1208. goto out_reset_adapter;
  1209. }
  1210. INIT_LIST_HEAD(&adapter->cmd_pool);
  1211. for (i = 0; i < adapter->req_depth; i++) {
  1212. struct pvscsi_ctx *ctx = adapter->cmd_map + i;
  1213. list_add(&ctx->list, &adapter->cmd_pool);
  1214. }
  1215. error = pvscsi_allocate_sg(adapter);
  1216. if (error) {
  1217. printk(KERN_ERR "vmw_pvscsi: unable to allocate s/g table\n");
  1218. goto out_reset_adapter;
  1219. }
  1220. if (!pvscsi_disable_msix &&
  1221. pvscsi_setup_msix(adapter, &adapter->irq) == 0) {
  1222. printk(KERN_INFO "vmw_pvscsi: using MSI-X\n");
  1223. adapter->use_msix = 1;
  1224. } else if (!pvscsi_disable_msi && pci_enable_msi(pdev) == 0) {
  1225. printk(KERN_INFO "vmw_pvscsi: using MSI\n");
  1226. adapter->use_msi = 1;
  1227. adapter->irq = pdev->irq;
  1228. } else {
  1229. printk(KERN_INFO "vmw_pvscsi: using INTx\n");
  1230. adapter->irq = pdev->irq;
  1231. flags = IRQF_SHARED;
  1232. }
  1233. adapter->use_req_threshold = pvscsi_setup_req_threshold(adapter, true);
  1234. printk(KERN_DEBUG "vmw_pvscsi: driver-based request coalescing %sabled\n",
  1235. adapter->use_req_threshold ? "en" : "dis");
  1236. error = request_irq(adapter->irq, pvscsi_isr, flags,
  1237. "vmw_pvscsi", adapter);
  1238. if (error) {
  1239. printk(KERN_ERR
  1240. "vmw_pvscsi: unable to request IRQ: %d\n", error);
  1241. adapter->irq = 0;
  1242. goto out_reset_adapter;
  1243. }
  1244. error = scsi_add_host(host, &pdev->dev);
  1245. if (error) {
  1246. printk(KERN_ERR
  1247. "vmw_pvscsi: scsi_add_host failed: %d\n", error);
  1248. goto out_reset_adapter;
  1249. }
  1250. dev_info(&pdev->dev, "VMware PVSCSI rev %d host #%u\n",
  1251. adapter->rev, host->host_no);
  1252. pvscsi_unmask_intr(adapter);
  1253. scsi_scan_host(host);
  1254. return 0;
  1255. out_reset_adapter:
  1256. ll_adapter_reset(adapter);
  1257. out_release_resources:
  1258. pvscsi_shutdown_intr(adapter);
  1259. pvscsi_release_resources(adapter);
  1260. scsi_host_put(host);
  1261. out_disable_device:
  1262. pci_disable_device(pdev);
  1263. return error;
  1264. out_release_resources_and_disable:
  1265. pvscsi_shutdown_intr(adapter);
  1266. pvscsi_release_resources(adapter);
  1267. goto out_disable_device;
  1268. }
  1269. static void __pvscsi_shutdown(struct pvscsi_adapter *adapter)
  1270. {
  1271. pvscsi_mask_intr(adapter);
  1272. if (adapter->workqueue)
  1273. flush_workqueue(adapter->workqueue);
  1274. pvscsi_shutdown_intr(adapter);
  1275. pvscsi_process_request_ring(adapter);
  1276. pvscsi_process_completion_ring(adapter);
  1277. ll_adapter_reset(adapter);
  1278. }
  1279. static void pvscsi_shutdown(struct pci_dev *dev)
  1280. {
  1281. struct Scsi_Host *host = pci_get_drvdata(dev);
  1282. struct pvscsi_adapter *adapter = shost_priv(host);
  1283. __pvscsi_shutdown(adapter);
  1284. }
  1285. static void pvscsi_remove(struct pci_dev *pdev)
  1286. {
  1287. struct Scsi_Host *host = pci_get_drvdata(pdev);
  1288. struct pvscsi_adapter *adapter = shost_priv(host);
  1289. scsi_remove_host(host);
  1290. __pvscsi_shutdown(adapter);
  1291. pvscsi_release_resources(adapter);
  1292. scsi_host_put(host);
  1293. pci_disable_device(pdev);
  1294. }
  1295. static struct pci_driver pvscsi_pci_driver = {
  1296. .name = "vmw_pvscsi",
  1297. .id_table = pvscsi_pci_tbl,
  1298. .probe = pvscsi_probe,
  1299. .remove = pvscsi_remove,
  1300. .shutdown = pvscsi_shutdown,
  1301. };
  1302. static int __init pvscsi_init(void)
  1303. {
  1304. pr_info("%s - version %s\n",
  1305. PVSCSI_LINUX_DRIVER_DESC, PVSCSI_DRIVER_VERSION_STRING);
  1306. return pci_register_driver(&pvscsi_pci_driver);
  1307. }
  1308. static void __exit pvscsi_exit(void)
  1309. {
  1310. pci_unregister_driver(&pvscsi_pci_driver);
  1311. }
  1312. module_init(pvscsi_init);
  1313. module_exit(pvscsi_exit);