r852.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086
  1. /*
  2. * Copyright © 2009 - Maxim Levitsky
  3. * driver for Ricoh xD readers
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License version 2 as
  7. * published by the Free Software Foundation.
  8. */
  9. #include <linux/kernel.h>
  10. #include <linux/module.h>
  11. #include <linux/jiffies.h>
  12. #include <linux/workqueue.h>
  13. #include <linux/interrupt.h>
  14. #include <linux/pci.h>
  15. #include <linux/pci_ids.h>
  16. #include <linux/delay.h>
  17. #include <linux/slab.h>
  18. #include <asm/byteorder.h>
  19. #include <linux/sched.h>
  20. #include "sm_common.h"
  21. #include "r852.h"
  22. static bool r852_enable_dma = 1;
  23. module_param(r852_enable_dma, bool, S_IRUGO);
  24. MODULE_PARM_DESC(r852_enable_dma, "Enable usage of the DMA (default)");
  25. static int debug;
  26. module_param(debug, int, S_IRUGO | S_IWUSR);
  27. MODULE_PARM_DESC(debug, "Debug level (0-2)");
  28. /* read register */
  29. static inline uint8_t r852_read_reg(struct r852_device *dev, int address)
  30. {
  31. uint8_t reg = readb(dev->mmio + address);
  32. return reg;
  33. }
  34. /* write register */
  35. static inline void r852_write_reg(struct r852_device *dev,
  36. int address, uint8_t value)
  37. {
  38. writeb(value, dev->mmio + address);
  39. mmiowb();
  40. }
  41. /* read dword sized register */
  42. static inline uint32_t r852_read_reg_dword(struct r852_device *dev, int address)
  43. {
  44. uint32_t reg = le32_to_cpu(readl(dev->mmio + address));
  45. return reg;
  46. }
  47. /* write dword sized register */
  48. static inline void r852_write_reg_dword(struct r852_device *dev,
  49. int address, uint32_t value)
  50. {
  51. writel(cpu_to_le32(value), dev->mmio + address);
  52. mmiowb();
  53. }
  54. /* returns pointer to our private structure */
  55. static inline struct r852_device *r852_get_dev(struct mtd_info *mtd)
  56. {
  57. struct nand_chip *chip = mtd->priv;
  58. return chip->priv;
  59. }
  60. /* check if controller supports dma */
  61. static void r852_dma_test(struct r852_device *dev)
  62. {
  63. dev->dma_usable = (r852_read_reg(dev, R852_DMA_CAP) &
  64. (R852_DMA1 | R852_DMA2)) == (R852_DMA1 | R852_DMA2);
  65. if (!dev->dma_usable)
  66. message("Non dma capable device detected, dma disabled");
  67. if (!r852_enable_dma) {
  68. message("disabling dma on user request");
  69. dev->dma_usable = 0;
  70. }
  71. }
  72. /*
  73. * Enable dma. Enables ether first or second stage of the DMA,
  74. * Expects dev->dma_dir and dev->dma_state be set
  75. */
  76. static void r852_dma_enable(struct r852_device *dev)
  77. {
  78. uint8_t dma_reg, dma_irq_reg;
  79. /* Set up dma settings */
  80. dma_reg = r852_read_reg_dword(dev, R852_DMA_SETTINGS);
  81. dma_reg &= ~(R852_DMA_READ | R852_DMA_INTERNAL | R852_DMA_MEMORY);
  82. if (dev->dma_dir)
  83. dma_reg |= R852_DMA_READ;
  84. if (dev->dma_state == DMA_INTERNAL) {
  85. dma_reg |= R852_DMA_INTERNAL;
  86. /* Precaution to make sure HW doesn't write */
  87. /* to random kernel memory */
  88. r852_write_reg_dword(dev, R852_DMA_ADDR,
  89. cpu_to_le32(dev->phys_bounce_buffer));
  90. } else {
  91. dma_reg |= R852_DMA_MEMORY;
  92. r852_write_reg_dword(dev, R852_DMA_ADDR,
  93. cpu_to_le32(dev->phys_dma_addr));
  94. }
  95. /* Precaution: make sure write reached the device */
  96. r852_read_reg_dword(dev, R852_DMA_ADDR);
  97. r852_write_reg_dword(dev, R852_DMA_SETTINGS, dma_reg);
  98. /* Set dma irq */
  99. dma_irq_reg = r852_read_reg_dword(dev, R852_DMA_IRQ_ENABLE);
  100. r852_write_reg_dword(dev, R852_DMA_IRQ_ENABLE,
  101. dma_irq_reg |
  102. R852_DMA_IRQ_INTERNAL |
  103. R852_DMA_IRQ_ERROR |
  104. R852_DMA_IRQ_MEMORY);
  105. }
  106. /*
  107. * Disable dma, called from the interrupt handler, which specifies
  108. * success of the operation via 'error' argument
  109. */
  110. static void r852_dma_done(struct r852_device *dev, int error)
  111. {
  112. WARN_ON(dev->dma_stage == 0);
  113. r852_write_reg_dword(dev, R852_DMA_IRQ_STA,
  114. r852_read_reg_dword(dev, R852_DMA_IRQ_STA));
  115. r852_write_reg_dword(dev, R852_DMA_SETTINGS, 0);
  116. r852_write_reg_dword(dev, R852_DMA_IRQ_ENABLE, 0);
  117. /* Precaution to make sure HW doesn't write to random kernel memory */
  118. r852_write_reg_dword(dev, R852_DMA_ADDR,
  119. cpu_to_le32(dev->phys_bounce_buffer));
  120. r852_read_reg_dword(dev, R852_DMA_ADDR);
  121. dev->dma_error = error;
  122. dev->dma_stage = 0;
  123. if (dev->phys_dma_addr && dev->phys_dma_addr != dev->phys_bounce_buffer)
  124. pci_unmap_single(dev->pci_dev, dev->phys_dma_addr, R852_DMA_LEN,
  125. dev->dma_dir ? PCI_DMA_FROMDEVICE : PCI_DMA_TODEVICE);
  126. }
  127. /*
  128. * Wait, till dma is done, which includes both phases of it
  129. */
  130. static int r852_dma_wait(struct r852_device *dev)
  131. {
  132. long timeout = wait_for_completion_timeout(&dev->dma_done,
  133. msecs_to_jiffies(1000));
  134. if (!timeout) {
  135. dbg("timeout waiting for DMA interrupt");
  136. return -ETIMEDOUT;
  137. }
  138. return 0;
  139. }
  140. /*
  141. * Read/Write one page using dma. Only pages can be read (512 bytes)
  142. */
  143. static void r852_do_dma(struct r852_device *dev, uint8_t *buf, int do_read)
  144. {
  145. int bounce = 0;
  146. unsigned long flags;
  147. int error;
  148. dev->dma_error = 0;
  149. /* Set dma direction */
  150. dev->dma_dir = do_read;
  151. dev->dma_stage = 1;
  152. INIT_COMPLETION(dev->dma_done);
  153. dbg_verbose("doing dma %s ", do_read ? "read" : "write");
  154. /* Set initial dma state: for reading first fill on board buffer,
  155. from device, for writes first fill the buffer from memory*/
  156. dev->dma_state = do_read ? DMA_INTERNAL : DMA_MEMORY;
  157. /* if incoming buffer is not page aligned, we should do bounce */
  158. if ((unsigned long)buf & (R852_DMA_LEN-1))
  159. bounce = 1;
  160. if (!bounce) {
  161. dev->phys_dma_addr = pci_map_single(dev->pci_dev, (void *)buf,
  162. R852_DMA_LEN,
  163. (do_read ? PCI_DMA_FROMDEVICE : PCI_DMA_TODEVICE));
  164. if (pci_dma_mapping_error(dev->pci_dev, dev->phys_dma_addr))
  165. bounce = 1;
  166. }
  167. if (bounce) {
  168. dbg_verbose("dma: using bounce buffer");
  169. dev->phys_dma_addr = dev->phys_bounce_buffer;
  170. if (!do_read)
  171. memcpy(dev->bounce_buffer, buf, R852_DMA_LEN);
  172. }
  173. /* Enable DMA */
  174. spin_lock_irqsave(&dev->irqlock, flags);
  175. r852_dma_enable(dev);
  176. spin_unlock_irqrestore(&dev->irqlock, flags);
  177. /* Wait till complete */
  178. error = r852_dma_wait(dev);
  179. if (error) {
  180. r852_dma_done(dev, error);
  181. return;
  182. }
  183. if (do_read && bounce)
  184. memcpy((void *)buf, dev->bounce_buffer, R852_DMA_LEN);
  185. }
  186. /*
  187. * Program data lines of the nand chip to send data to it
  188. */
  189. void r852_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
  190. {
  191. struct r852_device *dev = r852_get_dev(mtd);
  192. uint32_t reg;
  193. /* Don't allow any access to hardware if we suspect card removal */
  194. if (dev->card_unstable)
  195. return;
  196. /* Special case for whole sector read */
  197. if (len == R852_DMA_LEN && dev->dma_usable) {
  198. r852_do_dma(dev, (uint8_t *)buf, 0);
  199. return;
  200. }
  201. /* write DWORD chinks - faster */
  202. while (len) {
  203. reg = buf[0] | buf[1] << 8 | buf[2] << 16 | buf[3] << 24;
  204. r852_write_reg_dword(dev, R852_DATALINE, reg);
  205. buf += 4;
  206. len -= 4;
  207. }
  208. /* write rest */
  209. while (len)
  210. r852_write_reg(dev, R852_DATALINE, *buf++);
  211. }
  212. /*
  213. * Read data lines of the nand chip to retrieve data
  214. */
  215. void r852_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
  216. {
  217. struct r852_device *dev = r852_get_dev(mtd);
  218. uint32_t reg;
  219. if (dev->card_unstable) {
  220. /* since we can't signal error here, at least, return
  221. predictable buffer */
  222. memset(buf, 0, len);
  223. return;
  224. }
  225. /* special case for whole sector read */
  226. if (len == R852_DMA_LEN && dev->dma_usable) {
  227. r852_do_dma(dev, buf, 1);
  228. return;
  229. }
  230. /* read in dword sized chunks */
  231. while (len >= 4) {
  232. reg = r852_read_reg_dword(dev, R852_DATALINE);
  233. *buf++ = reg & 0xFF;
  234. *buf++ = (reg >> 8) & 0xFF;
  235. *buf++ = (reg >> 16) & 0xFF;
  236. *buf++ = (reg >> 24) & 0xFF;
  237. len -= 4;
  238. }
  239. /* read the reset by bytes */
  240. while (len--)
  241. *buf++ = r852_read_reg(dev, R852_DATALINE);
  242. }
  243. /*
  244. * Read one byte from nand chip
  245. */
  246. static uint8_t r852_read_byte(struct mtd_info *mtd)
  247. {
  248. struct r852_device *dev = r852_get_dev(mtd);
  249. /* Same problem as in r852_read_buf.... */
  250. if (dev->card_unstable)
  251. return 0;
  252. return r852_read_reg(dev, R852_DATALINE);
  253. }
  254. /*
  255. * Control several chip lines & send commands
  256. */
  257. void r852_cmdctl(struct mtd_info *mtd, int dat, unsigned int ctrl)
  258. {
  259. struct r852_device *dev = r852_get_dev(mtd);
  260. if (dev->card_unstable)
  261. return;
  262. if (ctrl & NAND_CTRL_CHANGE) {
  263. dev->ctlreg &= ~(R852_CTL_DATA | R852_CTL_COMMAND |
  264. R852_CTL_ON | R852_CTL_CARDENABLE);
  265. if (ctrl & NAND_ALE)
  266. dev->ctlreg |= R852_CTL_DATA;
  267. if (ctrl & NAND_CLE)
  268. dev->ctlreg |= R852_CTL_COMMAND;
  269. if (ctrl & NAND_NCE)
  270. dev->ctlreg |= (R852_CTL_CARDENABLE | R852_CTL_ON);
  271. else
  272. dev->ctlreg &= ~R852_CTL_WRITE;
  273. /* when write is stareted, enable write access */
  274. if (dat == NAND_CMD_ERASE1)
  275. dev->ctlreg |= R852_CTL_WRITE;
  276. r852_write_reg(dev, R852_CTL, dev->ctlreg);
  277. }
  278. /* HACK: NAND_CMD_SEQIN is called without NAND_CTRL_CHANGE, but we need
  279. to set write mode */
  280. if (dat == NAND_CMD_SEQIN && (dev->ctlreg & R852_CTL_COMMAND)) {
  281. dev->ctlreg |= R852_CTL_WRITE;
  282. r852_write_reg(dev, R852_CTL, dev->ctlreg);
  283. }
  284. if (dat != NAND_CMD_NONE)
  285. r852_write_reg(dev, R852_DATALINE, dat);
  286. }
  287. /*
  288. * Wait till card is ready.
  289. * based on nand_wait, but returns errors on DMA error
  290. */
  291. int r852_wait(struct mtd_info *mtd, struct nand_chip *chip)
  292. {
  293. struct r852_device *dev = chip->priv;
  294. unsigned long timeout;
  295. int status;
  296. timeout = jiffies + (chip->state == FL_ERASING ?
  297. msecs_to_jiffies(400) : msecs_to_jiffies(20));
  298. while (time_before(jiffies, timeout))
  299. if (chip->dev_ready(mtd))
  300. break;
  301. chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
  302. status = (int)chip->read_byte(mtd);
  303. /* Unfortunelly, no way to send detailed error status... */
  304. if (dev->dma_error) {
  305. status |= NAND_STATUS_FAIL;
  306. dev->dma_error = 0;
  307. }
  308. return status;
  309. }
  310. /*
  311. * Check if card is ready
  312. */
  313. int r852_ready(struct mtd_info *mtd)
  314. {
  315. struct r852_device *dev = r852_get_dev(mtd);
  316. return !(r852_read_reg(dev, R852_CARD_STA) & R852_CARD_STA_BUSY);
  317. }
  318. /*
  319. * Set ECC engine mode
  320. */
  321. void r852_ecc_hwctl(struct mtd_info *mtd, int mode)
  322. {
  323. struct r852_device *dev = r852_get_dev(mtd);
  324. if (dev->card_unstable)
  325. return;
  326. switch (mode) {
  327. case NAND_ECC_READ:
  328. case NAND_ECC_WRITE:
  329. /* enable ecc generation/check*/
  330. dev->ctlreg |= R852_CTL_ECC_ENABLE;
  331. /* flush ecc buffer */
  332. r852_write_reg(dev, R852_CTL,
  333. dev->ctlreg | R852_CTL_ECC_ACCESS);
  334. r852_read_reg_dword(dev, R852_DATALINE);
  335. r852_write_reg(dev, R852_CTL, dev->ctlreg);
  336. return;
  337. case NAND_ECC_READSYN:
  338. /* disable ecc generation */
  339. dev->ctlreg &= ~R852_CTL_ECC_ENABLE;
  340. r852_write_reg(dev, R852_CTL, dev->ctlreg);
  341. }
  342. }
  343. /*
  344. * Calculate ECC, only used for writes
  345. */
  346. int r852_ecc_calculate(struct mtd_info *mtd, const uint8_t *dat,
  347. uint8_t *ecc_code)
  348. {
  349. struct r852_device *dev = r852_get_dev(mtd);
  350. struct sm_oob *oob = (struct sm_oob *)ecc_code;
  351. uint32_t ecc1, ecc2;
  352. if (dev->card_unstable)
  353. return 0;
  354. dev->ctlreg &= ~R852_CTL_ECC_ENABLE;
  355. r852_write_reg(dev, R852_CTL, dev->ctlreg | R852_CTL_ECC_ACCESS);
  356. ecc1 = r852_read_reg_dword(dev, R852_DATALINE);
  357. ecc2 = r852_read_reg_dword(dev, R852_DATALINE);
  358. oob->ecc1[0] = (ecc1) & 0xFF;
  359. oob->ecc1[1] = (ecc1 >> 8) & 0xFF;
  360. oob->ecc1[2] = (ecc1 >> 16) & 0xFF;
  361. oob->ecc2[0] = (ecc2) & 0xFF;
  362. oob->ecc2[1] = (ecc2 >> 8) & 0xFF;
  363. oob->ecc2[2] = (ecc2 >> 16) & 0xFF;
  364. r852_write_reg(dev, R852_CTL, dev->ctlreg);
  365. return 0;
  366. }
  367. /*
  368. * Correct the data using ECC, hw did almost everything for us
  369. */
  370. int r852_ecc_correct(struct mtd_info *mtd, uint8_t *dat,
  371. uint8_t *read_ecc, uint8_t *calc_ecc)
  372. {
  373. uint16_t ecc_reg;
  374. uint8_t ecc_status, err_byte;
  375. int i, error = 0;
  376. struct r852_device *dev = r852_get_dev(mtd);
  377. if (dev->card_unstable)
  378. return 0;
  379. if (dev->dma_error) {
  380. dev->dma_error = 0;
  381. return -1;
  382. }
  383. r852_write_reg(dev, R852_CTL, dev->ctlreg | R852_CTL_ECC_ACCESS);
  384. ecc_reg = r852_read_reg_dword(dev, R852_DATALINE);
  385. r852_write_reg(dev, R852_CTL, dev->ctlreg);
  386. for (i = 0 ; i <= 1 ; i++) {
  387. ecc_status = (ecc_reg >> 8) & 0xFF;
  388. /* ecc uncorrectable error */
  389. if (ecc_status & R852_ECC_FAIL) {
  390. dbg("ecc: unrecoverable error, in half %d", i);
  391. error = -1;
  392. goto exit;
  393. }
  394. /* correctable error */
  395. if (ecc_status & R852_ECC_CORRECTABLE) {
  396. err_byte = ecc_reg & 0xFF;
  397. dbg("ecc: recoverable error, "
  398. "in half %d, byte %d, bit %d", i,
  399. err_byte, ecc_status & R852_ECC_ERR_BIT_MSK);
  400. dat[err_byte] ^=
  401. 1 << (ecc_status & R852_ECC_ERR_BIT_MSK);
  402. error++;
  403. }
  404. dat += 256;
  405. ecc_reg >>= 16;
  406. }
  407. exit:
  408. return error;
  409. }
  410. /*
  411. * This is copy of nand_read_oob_std
  412. * nand_read_oob_syndrome assumes we can send column address - we can't
  413. */
  414. static int r852_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
  415. int page)
  416. {
  417. chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
  418. chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
  419. return 0;
  420. }
  421. /*
  422. * Start the nand engine
  423. */
  424. void r852_engine_enable(struct r852_device *dev)
  425. {
  426. if (r852_read_reg_dword(dev, R852_HW) & R852_HW_UNKNOWN) {
  427. r852_write_reg(dev, R852_CTL, R852_CTL_RESET | R852_CTL_ON);
  428. r852_write_reg_dword(dev, R852_HW, R852_HW_ENABLED);
  429. } else {
  430. r852_write_reg_dword(dev, R852_HW, R852_HW_ENABLED);
  431. r852_write_reg(dev, R852_CTL, R852_CTL_RESET | R852_CTL_ON);
  432. }
  433. msleep(300);
  434. r852_write_reg(dev, R852_CTL, 0);
  435. }
  436. /*
  437. * Stop the nand engine
  438. */
  439. void r852_engine_disable(struct r852_device *dev)
  440. {
  441. r852_write_reg_dword(dev, R852_HW, 0);
  442. r852_write_reg(dev, R852_CTL, R852_CTL_RESET);
  443. }
  444. /*
  445. * Test if card is present
  446. */
  447. void r852_card_update_present(struct r852_device *dev)
  448. {
  449. unsigned long flags;
  450. uint8_t reg;
  451. spin_lock_irqsave(&dev->irqlock, flags);
  452. reg = r852_read_reg(dev, R852_CARD_STA);
  453. dev->card_detected = !!(reg & R852_CARD_STA_PRESENT);
  454. spin_unlock_irqrestore(&dev->irqlock, flags);
  455. }
  456. /*
  457. * Update card detection IRQ state according to current card state
  458. * which is read in r852_card_update_present
  459. */
  460. void r852_update_card_detect(struct r852_device *dev)
  461. {
  462. int card_detect_reg = r852_read_reg(dev, R852_CARD_IRQ_ENABLE);
  463. dev->card_unstable = 0;
  464. card_detect_reg &= ~(R852_CARD_IRQ_REMOVE | R852_CARD_IRQ_INSERT);
  465. card_detect_reg |= R852_CARD_IRQ_GENABLE;
  466. card_detect_reg |= dev->card_detected ?
  467. R852_CARD_IRQ_REMOVE : R852_CARD_IRQ_INSERT;
  468. r852_write_reg(dev, R852_CARD_IRQ_ENABLE, card_detect_reg);
  469. }
  470. ssize_t r852_media_type_show(struct device *sys_dev,
  471. struct device_attribute *attr, char *buf)
  472. {
  473. struct mtd_info *mtd = container_of(sys_dev, struct mtd_info, dev);
  474. struct r852_device *dev = r852_get_dev(mtd);
  475. char *data = dev->sm ? "smartmedia" : "xd";
  476. strcpy(buf, data);
  477. return strlen(data);
  478. }
  479. DEVICE_ATTR(media_type, S_IRUGO, r852_media_type_show, NULL);
  480. /* Detect properties of card in slot */
  481. void r852_update_media_status(struct r852_device *dev)
  482. {
  483. uint8_t reg;
  484. unsigned long flags;
  485. int readonly;
  486. spin_lock_irqsave(&dev->irqlock, flags);
  487. if (!dev->card_detected) {
  488. message("card removed");
  489. spin_unlock_irqrestore(&dev->irqlock, flags);
  490. return ;
  491. }
  492. readonly = r852_read_reg(dev, R852_CARD_STA) & R852_CARD_STA_RO;
  493. reg = r852_read_reg(dev, R852_DMA_CAP);
  494. dev->sm = (reg & (R852_DMA1 | R852_DMA2)) && (reg & R852_SMBIT);
  495. message("detected %s %s card in slot",
  496. dev->sm ? "SmartMedia" : "xD",
  497. readonly ? "readonly" : "writeable");
  498. dev->readonly = readonly;
  499. spin_unlock_irqrestore(&dev->irqlock, flags);
  500. }
  501. /*
  502. * Register the nand device
  503. * Called when the card is detected
  504. */
  505. int r852_register_nand_device(struct r852_device *dev)
  506. {
  507. dev->mtd = kzalloc(sizeof(struct mtd_info), GFP_KERNEL);
  508. if (!dev->mtd)
  509. goto error1;
  510. WARN_ON(dev->card_registred);
  511. dev->mtd->owner = THIS_MODULE;
  512. dev->mtd->priv = dev->chip;
  513. dev->mtd->dev.parent = &dev->pci_dev->dev;
  514. if (dev->readonly)
  515. dev->chip->options |= NAND_ROM;
  516. r852_engine_enable(dev);
  517. if (sm_register_device(dev->mtd, dev->sm))
  518. goto error2;
  519. if (device_create_file(&dev->mtd->dev, &dev_attr_media_type))
  520. message("can't create media type sysfs attribute");
  521. dev->card_registred = 1;
  522. return 0;
  523. error2:
  524. kfree(dev->mtd);
  525. error1:
  526. /* Force card redetect */
  527. dev->card_detected = 0;
  528. return -1;
  529. }
  530. /*
  531. * Unregister the card
  532. */
  533. void r852_unregister_nand_device(struct r852_device *dev)
  534. {
  535. if (!dev->card_registred)
  536. return;
  537. device_remove_file(&dev->mtd->dev, &dev_attr_media_type);
  538. nand_release(dev->mtd);
  539. r852_engine_disable(dev);
  540. dev->card_registred = 0;
  541. kfree(dev->mtd);
  542. dev->mtd = NULL;
  543. }
  544. /* Card state updater */
  545. void r852_card_detect_work(struct work_struct *work)
  546. {
  547. struct r852_device *dev =
  548. container_of(work, struct r852_device, card_detect_work.work);
  549. r852_card_update_present(dev);
  550. r852_update_card_detect(dev);
  551. dev->card_unstable = 0;
  552. /* False alarm */
  553. if (dev->card_detected == dev->card_registred)
  554. goto exit;
  555. /* Read media properties */
  556. r852_update_media_status(dev);
  557. /* Register the card */
  558. if (dev->card_detected)
  559. r852_register_nand_device(dev);
  560. else
  561. r852_unregister_nand_device(dev);
  562. exit:
  563. r852_update_card_detect(dev);
  564. }
  565. /* Ack + disable IRQ generation */
  566. static void r852_disable_irqs(struct r852_device *dev)
  567. {
  568. uint8_t reg;
  569. reg = r852_read_reg(dev, R852_CARD_IRQ_ENABLE);
  570. r852_write_reg(dev, R852_CARD_IRQ_ENABLE, reg & ~R852_CARD_IRQ_MASK);
  571. reg = r852_read_reg_dword(dev, R852_DMA_IRQ_ENABLE);
  572. r852_write_reg_dword(dev, R852_DMA_IRQ_ENABLE,
  573. reg & ~R852_DMA_IRQ_MASK);
  574. r852_write_reg(dev, R852_CARD_IRQ_STA, R852_CARD_IRQ_MASK);
  575. r852_write_reg_dword(dev, R852_DMA_IRQ_STA, R852_DMA_IRQ_MASK);
  576. }
  577. /* Interrupt handler */
  578. static irqreturn_t r852_irq(int irq, void *data)
  579. {
  580. struct r852_device *dev = (struct r852_device *)data;
  581. uint8_t card_status, dma_status;
  582. unsigned long flags;
  583. irqreturn_t ret = IRQ_NONE;
  584. spin_lock_irqsave(&dev->irqlock, flags);
  585. /* handle card detection interrupts first */
  586. card_status = r852_read_reg(dev, R852_CARD_IRQ_STA);
  587. r852_write_reg(dev, R852_CARD_IRQ_STA, card_status);
  588. if (card_status & (R852_CARD_IRQ_INSERT|R852_CARD_IRQ_REMOVE)) {
  589. ret = IRQ_HANDLED;
  590. dev->card_detected = !!(card_status & R852_CARD_IRQ_INSERT);
  591. /* we shouldn't receive any interrupts if we wait for card
  592. to settle */
  593. WARN_ON(dev->card_unstable);
  594. /* disable irqs while card is unstable */
  595. /* this will timeout DMA if active, but better that garbage */
  596. r852_disable_irqs(dev);
  597. if (dev->card_unstable)
  598. goto out;
  599. /* let, card state to settle a bit, and then do the work */
  600. dev->card_unstable = 1;
  601. queue_delayed_work(dev->card_workqueue,
  602. &dev->card_detect_work, msecs_to_jiffies(100));
  603. goto out;
  604. }
  605. /* Handle dma interrupts */
  606. dma_status = r852_read_reg_dword(dev, R852_DMA_IRQ_STA);
  607. r852_write_reg_dword(dev, R852_DMA_IRQ_STA, dma_status);
  608. if (dma_status & R852_DMA_IRQ_MASK) {
  609. ret = IRQ_HANDLED;
  610. if (dma_status & R852_DMA_IRQ_ERROR) {
  611. dbg("received dma error IRQ");
  612. r852_dma_done(dev, -EIO);
  613. complete(&dev->dma_done);
  614. goto out;
  615. }
  616. /* received DMA interrupt out of nowhere? */
  617. WARN_ON_ONCE(dev->dma_stage == 0);
  618. if (dev->dma_stage == 0)
  619. goto out;
  620. /* done device access */
  621. if (dev->dma_state == DMA_INTERNAL &&
  622. (dma_status & R852_DMA_IRQ_INTERNAL)) {
  623. dev->dma_state = DMA_MEMORY;
  624. dev->dma_stage++;
  625. }
  626. /* done memory DMA */
  627. if (dev->dma_state == DMA_MEMORY &&
  628. (dma_status & R852_DMA_IRQ_MEMORY)) {
  629. dev->dma_state = DMA_INTERNAL;
  630. dev->dma_stage++;
  631. }
  632. /* Enable 2nd half of dma dance */
  633. if (dev->dma_stage == 2)
  634. r852_dma_enable(dev);
  635. /* Operation done */
  636. if (dev->dma_stage == 3) {
  637. r852_dma_done(dev, 0);
  638. complete(&dev->dma_done);
  639. }
  640. goto out;
  641. }
  642. /* Handle unknown interrupts */
  643. if (dma_status)
  644. dbg("bad dma IRQ status = %x", dma_status);
  645. if (card_status & ~R852_CARD_STA_CD)
  646. dbg("strange card status = %x", card_status);
  647. out:
  648. spin_unlock_irqrestore(&dev->irqlock, flags);
  649. return ret;
  650. }
  651. int r852_probe(struct pci_dev *pci_dev, const struct pci_device_id *id)
  652. {
  653. int error;
  654. struct nand_chip *chip;
  655. struct r852_device *dev;
  656. /* pci initialization */
  657. error = pci_enable_device(pci_dev);
  658. if (error)
  659. goto error1;
  660. pci_set_master(pci_dev);
  661. error = pci_set_dma_mask(pci_dev, DMA_BIT_MASK(32));
  662. if (error)
  663. goto error2;
  664. error = pci_request_regions(pci_dev, DRV_NAME);
  665. if (error)
  666. goto error3;
  667. error = -ENOMEM;
  668. /* init nand chip, but register it only on card insert */
  669. chip = kzalloc(sizeof(struct nand_chip), GFP_KERNEL);
  670. if (!chip)
  671. goto error4;
  672. /* commands */
  673. chip->cmd_ctrl = r852_cmdctl;
  674. chip->waitfunc = r852_wait;
  675. chip->dev_ready = r852_ready;
  676. /* I/O */
  677. chip->read_byte = r852_read_byte;
  678. chip->read_buf = r852_read_buf;
  679. chip->write_buf = r852_write_buf;
  680. /* ecc */
  681. chip->ecc.mode = NAND_ECC_HW_SYNDROME;
  682. chip->ecc.size = R852_DMA_LEN;
  683. chip->ecc.bytes = SM_OOB_SIZE;
  684. chip->ecc.strength = 2;
  685. chip->ecc.hwctl = r852_ecc_hwctl;
  686. chip->ecc.calculate = r852_ecc_calculate;
  687. chip->ecc.correct = r852_ecc_correct;
  688. /* TODO: hack */
  689. chip->ecc.read_oob = r852_read_oob;
  690. /* init our device structure */
  691. dev = kzalloc(sizeof(struct r852_device), GFP_KERNEL);
  692. if (!dev)
  693. goto error5;
  694. chip->priv = dev;
  695. dev->chip = chip;
  696. dev->pci_dev = pci_dev;
  697. pci_set_drvdata(pci_dev, dev);
  698. dev->bounce_buffer = pci_alloc_consistent(pci_dev, R852_DMA_LEN,
  699. &dev->phys_bounce_buffer);
  700. if (!dev->bounce_buffer)
  701. goto error6;
  702. error = -ENODEV;
  703. dev->mmio = pci_ioremap_bar(pci_dev, 0);
  704. if (!dev->mmio)
  705. goto error7;
  706. error = -ENOMEM;
  707. dev->tmp_buffer = kzalloc(SM_SECTOR_SIZE, GFP_KERNEL);
  708. if (!dev->tmp_buffer)
  709. goto error8;
  710. init_completion(&dev->dma_done);
  711. dev->card_workqueue = create_freezable_workqueue(DRV_NAME);
  712. if (!dev->card_workqueue)
  713. goto error9;
  714. INIT_DELAYED_WORK(&dev->card_detect_work, r852_card_detect_work);
  715. /* shutdown everything - precation */
  716. r852_engine_disable(dev);
  717. r852_disable_irqs(dev);
  718. r852_dma_test(dev);
  719. dev->irq = pci_dev->irq;
  720. spin_lock_init(&dev->irqlock);
  721. dev->card_detected = 0;
  722. r852_card_update_present(dev);
  723. /*register irq handler*/
  724. error = -ENODEV;
  725. if (request_irq(pci_dev->irq, &r852_irq, IRQF_SHARED,
  726. DRV_NAME, dev))
  727. goto error10;
  728. /* kick initial present test */
  729. queue_delayed_work(dev->card_workqueue,
  730. &dev->card_detect_work, 0);
  731. printk(KERN_NOTICE DRV_NAME ": driver loaded successfully\n");
  732. return 0;
  733. error10:
  734. destroy_workqueue(dev->card_workqueue);
  735. error9:
  736. kfree(dev->tmp_buffer);
  737. error8:
  738. pci_iounmap(pci_dev, dev->mmio);
  739. error7:
  740. pci_free_consistent(pci_dev, R852_DMA_LEN,
  741. dev->bounce_buffer, dev->phys_bounce_buffer);
  742. error6:
  743. kfree(dev);
  744. error5:
  745. kfree(chip);
  746. error4:
  747. pci_release_regions(pci_dev);
  748. error3:
  749. error2:
  750. pci_disable_device(pci_dev);
  751. error1:
  752. return error;
  753. }
  754. void r852_remove(struct pci_dev *pci_dev)
  755. {
  756. struct r852_device *dev = pci_get_drvdata(pci_dev);
  757. /* Stop detect workqueue -
  758. we are going to unregister the device anyway*/
  759. cancel_delayed_work_sync(&dev->card_detect_work);
  760. destroy_workqueue(dev->card_workqueue);
  761. /* Unregister the device, this might make more IO */
  762. r852_unregister_nand_device(dev);
  763. /* Stop interrupts */
  764. r852_disable_irqs(dev);
  765. synchronize_irq(dev->irq);
  766. free_irq(dev->irq, dev);
  767. /* Cleanup */
  768. kfree(dev->tmp_buffer);
  769. pci_iounmap(pci_dev, dev->mmio);
  770. pci_free_consistent(pci_dev, R852_DMA_LEN,
  771. dev->bounce_buffer, dev->phys_bounce_buffer);
  772. kfree(dev->chip);
  773. kfree(dev);
  774. /* Shutdown the PCI device */
  775. pci_release_regions(pci_dev);
  776. pci_disable_device(pci_dev);
  777. }
  778. void r852_shutdown(struct pci_dev *pci_dev)
  779. {
  780. struct r852_device *dev = pci_get_drvdata(pci_dev);
  781. cancel_delayed_work_sync(&dev->card_detect_work);
  782. r852_disable_irqs(dev);
  783. synchronize_irq(dev->irq);
  784. pci_disable_device(pci_dev);
  785. }
  786. #ifdef CONFIG_PM
  787. static int r852_suspend(struct device *device)
  788. {
  789. struct r852_device *dev = pci_get_drvdata(to_pci_dev(device));
  790. if (dev->ctlreg & R852_CTL_CARDENABLE)
  791. return -EBUSY;
  792. /* First make sure the detect work is gone */
  793. cancel_delayed_work_sync(&dev->card_detect_work);
  794. /* Turn off the interrupts and stop the device */
  795. r852_disable_irqs(dev);
  796. r852_engine_disable(dev);
  797. /* If card was pulled off just during the suspend, which is very
  798. unlikely, we will remove it on resume, it too late now
  799. anyway... */
  800. dev->card_unstable = 0;
  801. return 0;
  802. }
  803. static int r852_resume(struct device *device)
  804. {
  805. struct r852_device *dev = pci_get_drvdata(to_pci_dev(device));
  806. r852_disable_irqs(dev);
  807. r852_card_update_present(dev);
  808. r852_engine_disable(dev);
  809. /* If card status changed, just do the work */
  810. if (dev->card_detected != dev->card_registred) {
  811. dbg("card was %s during low power state",
  812. dev->card_detected ? "added" : "removed");
  813. queue_delayed_work(dev->card_workqueue,
  814. &dev->card_detect_work, msecs_to_jiffies(1000));
  815. return 0;
  816. }
  817. /* Otherwise, initialize the card */
  818. if (dev->card_registred) {
  819. r852_engine_enable(dev);
  820. dev->chip->select_chip(dev->mtd, 0);
  821. dev->chip->cmdfunc(dev->mtd, NAND_CMD_RESET, -1, -1);
  822. dev->chip->select_chip(dev->mtd, -1);
  823. }
  824. /* Program card detection IRQ */
  825. r852_update_card_detect(dev);
  826. return 0;
  827. }
  828. #else
  829. #define r852_suspend NULL
  830. #define r852_resume NULL
  831. #endif
  832. static const struct pci_device_id r852_pci_id_tbl[] = {
  833. { PCI_VDEVICE(RICOH, 0x0852), },
  834. { },
  835. };
  836. MODULE_DEVICE_TABLE(pci, r852_pci_id_tbl);
  837. static SIMPLE_DEV_PM_OPS(r852_pm_ops, r852_suspend, r852_resume);
  838. static struct pci_driver r852_pci_driver = {
  839. .name = DRV_NAME,
  840. .id_table = r852_pci_id_tbl,
  841. .probe = r852_probe,
  842. .remove = r852_remove,
  843. .shutdown = r852_shutdown,
  844. .driver.pm = &r852_pm_ops,
  845. };
  846. module_pci_driver(r852_pci_driver);
  847. MODULE_LICENSE("GPL");
  848. MODULE_AUTHOR("Maxim Levitsky <maximlevitsky@gmail.com>");
  849. MODULE_DESCRIPTION("Ricoh 85xx xD/smartmedia card reader driver");