doc2000.c
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:32k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * Linux driver for Disk-On-Chip 2000 and Millennium
  3.  * (c) 1999 Machine Vision Holdings, Inc.
  4.  * (c) 1999, 2000 David Woodhouse <dwmw2@infradead.org>
  5.  *
  6.  * $Id: doc2000.c,v 1.46 2001/10/02 15:05:13 dwmw2 Exp $
  7.  */
  8. #include <linux/kernel.h>
  9. #include <linux/module.h>
  10. #include <asm/errno.h>
  11. #include <asm/io.h>
  12. #include <asm/uaccess.h>
  13. #include <linux/miscdevice.h>
  14. #include <linux/pci.h>
  15. #include <linux/delay.h>
  16. #include <linux/slab.h>
  17. #include <linux/sched.h>
  18. #include <linux/init.h>
  19. #include <linux/types.h>
  20. #include <linux/mtd/mtd.h>
  21. #include <linux/mtd/nand.h>
  22. #include <linux/mtd/nand_ids.h>
  23. #include <linux/mtd/doc2000.h>
  24. #define DOC_SUPPORT_2000
  25. #define DOC_SUPPORT_MILLENNIUM
  26. #ifdef DOC_SUPPORT_2000
  27. #define DoC_is_2000(doc) (doc->ChipID == DOC_ChipID_Doc2k)
  28. #else
  29. #define DoC_is_2000(doc) (0)
  30. #endif
  31. #ifdef DOC_SUPPORT_MILLENNIUM
  32. #define DoC_is_Millennium(doc) (doc->ChipID == DOC_ChipID_DocMil)
  33. #else
  34. #define DoC_is_Millennium(doc) (0)
  35. #endif
  36. /* #define ECC_DEBUG */
  37. /* I have no idea why some DoC chips can not use memcpy_from|to_io().
  38.  * This may be due to the different revisions of the ASIC controller built-in or
  39.  * simplily a QA/Bug issue. Who knows ?? If you have trouble, please uncomment
  40.  * this:
  41.  #undef USE_MEMCPY
  42. */
  43. static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
  44.     size_t *retlen, u_char *buf);
  45. static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
  46.      size_t *retlen, const u_char *buf);
  47. static int doc_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
  48. size_t *retlen, u_char *buf, u_char *eccbuf);
  49. static int doc_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,
  50.  size_t *retlen, const u_char *buf, u_char *eccbuf);
  51. static int doc_read_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
  52. size_t *retlen, u_char *buf);
  53. static int doc_write_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
  54.  size_t *retlen, const u_char *buf);
  55. static int doc_write_oob_nolock(struct mtd_info *mtd, loff_t ofs, size_t len,
  56.  size_t *retlen, const u_char *buf);
  57. static int doc_erase (struct mtd_info *mtd, struct erase_info *instr);
  58. static struct mtd_info *doc2klist = NULL;
  59. /* Perform the required delay cycles by reading from the appropriate register */
  60. static void DoC_Delay(struct DiskOnChip *doc, unsigned short cycles)
  61. {
  62. volatile char dummy;
  63. int i;
  64. for (i = 0; i < cycles; i++) {
  65. if (DoC_is_Millennium(doc))
  66. dummy = ReadDOC(doc->virtadr, NOP);
  67. else
  68. dummy = ReadDOC(doc->virtadr, DOCStatus);
  69. }
  70. }
  71. /* DOC_WaitReady: Wait for RDY line to be asserted by the flash chip */
  72. static int _DoC_WaitReady(struct DiskOnChip *doc)
  73. {
  74. unsigned long docptr = doc->virtadr;
  75. unsigned long timeo = jiffies + (HZ * 10);
  76. DEBUG(MTD_DEBUG_LEVEL3,
  77.       "_DoC_WaitReady called for out-of-line waitn");
  78. /* Out-of-line routine to wait for chip response */
  79. while (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B)) {
  80. if (time_after(jiffies, timeo)) {
  81. DEBUG(MTD_DEBUG_LEVEL2, "_DoC_WaitReady timed out.n");
  82. return -EIO;
  83. }
  84. if (current->need_resched) {
  85. set_current_state(TASK_UNINTERRUPTIBLE);
  86. schedule_timeout(1);
  87. }
  88. else
  89. udelay(1);
  90. }
  91. return 0;
  92. }
  93. static inline int DoC_WaitReady(struct DiskOnChip *doc)
  94. {
  95. unsigned long docptr = doc->virtadr;
  96. /* This is inline, to optimise the common case, where it's ready instantly */
  97. int ret = 0;
  98. /* 4 read form NOP register should be issued in prior to the read from CDSNControl
  99.    see Software Requirement 11.4 item 2. */
  100. DoC_Delay(doc, 4);
  101. if (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B))
  102. /* Call the out-of-line routine to wait */
  103. ret = _DoC_WaitReady(doc);
  104. /* issue 2 read from NOP register after reading from CDSNControl register
  105.    see Software Requirement 11.4 item 2. */
  106. DoC_Delay(doc, 2);
  107. return ret;
  108. }
  109. /* DoC_Command: Send a flash command to the flash chip through the CDSN Slow IO register to
  110.    bypass the internal pipeline. Each of 4 delay cycles (read from the NOP register) is
  111.    required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */
  112. static inline int DoC_Command(struct DiskOnChip *doc, unsigned char command,
  113.       unsigned char xtraflags)
  114. {
  115. unsigned long docptr = doc->virtadr;
  116. if (DoC_is_2000(doc))
  117. xtraflags |= CDSN_CTRL_FLASH_IO;
  118. /* Assert the CLE (Command Latch Enable) line to the flash chip */
  119. WriteDOC(xtraflags | CDSN_CTRL_CLE | CDSN_CTRL_CE, docptr, CDSNControl);
  120. DoC_Delay(doc, 4); /* Software requirement 11.4.3 for Millennium */
  121. if (DoC_is_Millennium(doc))
  122. WriteDOC(command, docptr, CDSNSlowIO);
  123. /* Send the command */
  124. WriteDOC_(command, docptr, doc->ioreg);
  125. /* Lower the CLE line */
  126. WriteDOC(xtraflags | CDSN_CTRL_CE, docptr, CDSNControl);
  127. DoC_Delay(doc, 4); /* Software requirement 11.4.3 for Millennium */
  128. /* Wait for the chip to respond - Software requirement 11.4.1 (extended for any command) */
  129. return DoC_WaitReady(doc);
  130. }
  131. /* DoC_Address: Set the current address for the flash chip through the CDSN Slow IO register to
  132.    bypass the internal pipeline. Each of 4 delay cycles (read from the NOP register) is
  133.    required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */
  134. static int DoC_Address(struct DiskOnChip *doc, int numbytes, unsigned long ofs,
  135.        unsigned char xtraflags1, unsigned char xtraflags2)
  136. {
  137. unsigned long docptr;
  138. int i;
  139. docptr = doc->virtadr;
  140. if (DoC_is_2000(doc))
  141. xtraflags1 |= CDSN_CTRL_FLASH_IO;
  142. /* Assert the ALE (Address Latch Enable) line to the flash chip */
  143. WriteDOC(xtraflags1 | CDSN_CTRL_ALE | CDSN_CTRL_CE, docptr, CDSNControl);
  144. DoC_Delay(doc, 4); /* Software requirement 11.4.3 for Millennium */
  145. /* Send the address */
  146. /* Devices with 256-byte page are addressed as:
  147.    Column (bits 0-7), Page (bits 8-15, 16-23, 24-31)
  148.    * there is no device on the market with page256
  149.    and more than 24 bits.
  150.    Devices with 512-byte page are addressed as:
  151.    Column (bits 0-7), Page (bits 9-16, 17-24, 25-31)
  152.    * 25-31 is sent only if the chip support it.
  153.    * bit 8 changes the read command to be sent
  154.    (NAND_CMD_READ0 or NAND_CMD_READ1).
  155.  */
  156. if (numbytes == ADDR_COLUMN || numbytes == ADDR_COLUMN_PAGE) {
  157. if (DoC_is_Millennium(doc))
  158. WriteDOC(ofs & 0xff, docptr, CDSNSlowIO);
  159. WriteDOC_(ofs & 0xff, docptr, doc->ioreg);
  160. }
  161. if (doc->page256) {
  162. ofs = ofs >> 8;
  163. } else {
  164. ofs = ofs >> 9;
  165. }
  166. if (numbytes == ADDR_PAGE || numbytes == ADDR_COLUMN_PAGE) {
  167. for (i = 0; i < doc->pageadrlen; i++, ofs = ofs >> 8) {
  168. if (DoC_is_Millennium(doc))
  169. WriteDOC(ofs & 0xff, docptr, CDSNSlowIO);
  170. WriteDOC_(ofs & 0xff, docptr, doc->ioreg);
  171. }
  172. }
  173. DoC_Delay(doc, 2); /* Needed for some slow flash chips. mf. */
  174. /* FIXME: The SlowIO's for millennium could be replaced by 
  175.    a single WritePipeTerm here. mf. */
  176. /* Lower the ALE line */
  177. WriteDOC(xtraflags1 | xtraflags2 | CDSN_CTRL_CE, docptr,
  178.  CDSNControl);
  179. DoC_Delay(doc, 4); /* Software requirement 11.4.3 for Millennium */
  180. /* Wait for the chip to respond - Software requirement 11.4.1 */
  181. return DoC_WaitReady(doc);
  182. }
  183. /* Read a buffer from DoC, taking care of Millennium odditys */
  184. static void DoC_ReadBuf(struct DiskOnChip *doc, u_char * buf, int len)
  185. {
  186. volatile int dummy;
  187. int modulus = 0xffff;
  188. unsigned long docptr;
  189. int i;
  190. docptr = doc->virtadr;
  191. if (len <= 0)
  192. return;
  193. if (DoC_is_Millennium(doc)) {
  194. /* Read the data via the internal pipeline through CDSN IO register,
  195.    see Pipelined Read Operations 11.3 */
  196. dummy = ReadDOC(docptr, ReadPipeInit);
  197. /* Millennium should use the LastDataRead register - Pipeline Reads */
  198. len--;
  199. /* This is needed for correctly ECC calculation */
  200. modulus = 0xff;
  201. }
  202. for (i = 0; i < len; i++)
  203. buf[i] = ReadDOC_(docptr, doc->ioreg + (i & modulus));
  204. if (DoC_is_Millennium(doc)) {
  205. buf[i] = ReadDOC(docptr, LastDataRead);
  206. }
  207. }
  208. /* Write a buffer to DoC, taking care of Millennium odditys */
  209. static void DoC_WriteBuf(struct DiskOnChip *doc, const u_char * buf, int len)
  210. {
  211. unsigned long docptr;
  212. int i;
  213. docptr = doc->virtadr;
  214. if (len <= 0)
  215. return;
  216. for (i = 0; i < len; i++)
  217. WriteDOC_(buf[i], docptr, doc->ioreg + i);
  218. if (DoC_is_Millennium(doc)) {
  219. WriteDOC(0x00, docptr, WritePipeTerm);
  220. }
  221. }
  222. /* DoC_SelectChip: Select a given flash chip within the current floor */
  223. static inline int DoC_SelectChip(struct DiskOnChip *doc, int chip)
  224. {
  225. unsigned long docptr = doc->virtadr;
  226. /* Software requirement 11.4.4 before writing DeviceSelect */
  227. /* Deassert the CE line to eliminate glitches on the FCE# outputs */
  228. WriteDOC(CDSN_CTRL_WP, docptr, CDSNControl);
  229. DoC_Delay(doc, 4); /* Software requirement 11.4.3 for Millennium */
  230. /* Select the individual flash chip requested */
  231. WriteDOC(chip, docptr, CDSNDeviceSelect);
  232. DoC_Delay(doc, 4);
  233. /* Reassert the CE line */
  234. WriteDOC(CDSN_CTRL_CE | CDSN_CTRL_FLASH_IO | CDSN_CTRL_WP, docptr,
  235.  CDSNControl);
  236. DoC_Delay(doc, 4); /* Software requirement 11.4.3 for Millennium */
  237. /* Wait for it to be ready */
  238. return DoC_WaitReady(doc);
  239. }
  240. /* DoC_SelectFloor: Select a given floor (bank of flash chips) */
  241. static inline int DoC_SelectFloor(struct DiskOnChip *doc, int floor)
  242. {
  243. unsigned long docptr = doc->virtadr;
  244. /* Select the floor (bank) of chips required */
  245. WriteDOC(floor, docptr, FloorSelect);
  246. /* Wait for the chip to be ready */
  247. return DoC_WaitReady(doc);
  248. }
  249. /* DoC_IdentChip: Identify a given NAND chip given {floor,chip} */
  250. static int DoC_IdentChip(struct DiskOnChip *doc, int floor, int chip)
  251. {
  252. int mfr, id, i;
  253. volatile char dummy;
  254. /* Page in the required floor/chip */
  255. DoC_SelectFloor(doc, floor);
  256. DoC_SelectChip(doc, chip);
  257. /* Reset the chip */
  258. if (DoC_Command(doc, NAND_CMD_RESET, CDSN_CTRL_WP)) {
  259. DEBUG(MTD_DEBUG_LEVEL2,
  260.       "DoC_Command (reset) for %d,%d returned truen",
  261.       floor, chip);
  262. return 0;
  263. }
  264. /* Read the NAND chip ID: 1. Send ReadID command */
  265. if (DoC_Command(doc, NAND_CMD_READID, CDSN_CTRL_WP)) {
  266. DEBUG(MTD_DEBUG_LEVEL2,
  267.       "DoC_Command (ReadID) for %d,%d returned truen",
  268.       floor, chip);
  269. return 0;
  270. }
  271. /* Read the NAND chip ID: 2. Send address byte zero */
  272. DoC_Address(doc, ADDR_COLUMN, 0, CDSN_CTRL_WP, 0);
  273. /* Read the manufacturer and device id codes from the device */
  274. /* CDSN Slow IO register see Software Requirement 11.4 item 5. */
  275. dummy = ReadDOC(doc->virtadr, CDSNSlowIO);
  276. DoC_Delay(doc, 2);
  277. mfr = ReadDOC_(doc->virtadr, doc->ioreg);
  278. /* CDSN Slow IO register see Software Requirement 11.4 item 5. */
  279. dummy = ReadDOC(doc->virtadr, CDSNSlowIO);
  280. DoC_Delay(doc, 2);
  281. id = ReadDOC_(doc->virtadr, doc->ioreg);
  282. /* No response - return failure */
  283. if (mfr == 0xff || mfr == 0)
  284. return 0;
  285. /* Check it's the same as the first chip we identified. 
  286.  * M-Systems say that any given DiskOnChip device should only
  287.  * contain _one_ type of flash part, although that's not a 
  288.  * hardware restriction. */
  289. if (doc->mfr) {
  290. if (doc->mfr == mfr && doc->id == id)
  291. return 1; /* This is another the same the first */
  292. else
  293. printk(KERN_WARNING
  294.        "Flash chip at floor %d, chip %d is different:n",
  295.        floor, chip);
  296. }
  297. /* Print and store the manufacturer and ID codes. */
  298. for (i = 0; nand_flash_ids[i].name != NULL; i++) {
  299. if (mfr == nand_flash_ids[i].manufacture_id &&
  300.     id == nand_flash_ids[i].model_id) {
  301. printk(KERN_INFO
  302.        "Flash chip found: Manufacturer ID: %2.2X, "
  303.        "Chip ID: %2.2X (%s)n", mfr, id,
  304.        nand_flash_ids[i].name);
  305. if (!doc->mfr) {
  306. doc->mfr = mfr;
  307. doc->id = id;
  308. doc->chipshift =
  309.     nand_flash_ids[i].chipshift;
  310. doc->page256 = nand_flash_ids[i].page256;
  311. doc->pageadrlen =
  312.     nand_flash_ids[i].pageadrlen;
  313. doc->erasesize =
  314.     nand_flash_ids[i].erasesize;
  315. return 1;
  316. }
  317. return 0;
  318. }
  319. }
  320. /* We haven't fully identified the chip. Print as much as we know. */
  321. printk(KERN_WARNING "Unknown flash chip found: %2.2X %2.2Xn",
  322.        id, mfr);
  323. printk(KERN_WARNING "Please report to dwmw2@infradead.orgn");
  324. return 0;
  325. }
  326. /* DoC_ScanChips: Find all NAND chips present in a DiskOnChip, and identify them */
  327. static void DoC_ScanChips(struct DiskOnChip *this)
  328. {
  329. int floor, chip;
  330. int numchips[MAX_FLOORS];
  331. int maxchips = MAX_CHIPS;
  332. int ret = 1;
  333. this->numchips = 0;
  334. this->mfr = 0;
  335. this->id = 0;
  336. if (DoC_is_Millennium(this))
  337. maxchips = MAX_CHIPS_MIL;
  338. /* For each floor, find the number of valid chips it contains */
  339. for (floor = 0; floor < MAX_FLOORS; floor++) {
  340. ret = 1;
  341. numchips[floor] = 0;
  342. for (chip = 0; chip < maxchips && ret != 0; chip++) {
  343. ret = DoC_IdentChip(this, floor, chip);
  344. if (ret) {
  345. numchips[floor]++;
  346. this->numchips++;
  347. }
  348. }
  349. }
  350. /* If there are none at all that we recognise, bail */
  351. if (!this->numchips) {
  352. printk(KERN_NOTICE "No flash chips recognised.n");
  353. return;
  354. }
  355. /* Allocate an array to hold the information for each chip */
  356. this->chips = kmalloc(sizeof(struct Nand) * this->numchips, GFP_KERNEL);
  357. if (!this->chips) {
  358. printk(KERN_NOTICE "No memory for allocating chip info structuresn");
  359. return;
  360. }
  361. ret = 0;
  362. /* Fill out the chip array with {floor, chipno} for each 
  363.  * detected chip in the device. */
  364. for (floor = 0; floor < MAX_FLOORS; floor++) {
  365. for (chip = 0; chip < numchips[floor]; chip++) {
  366. this->chips[ret].floor = floor;
  367. this->chips[ret].chip = chip;
  368. this->chips[ret].curadr = 0;
  369. this->chips[ret].curmode = 0x50;
  370. ret++;
  371. }
  372. }
  373. /* Calculate and print the total size of the device */
  374. this->totlen = this->numchips * (1 << this->chipshift);
  375. printk(KERN_INFO "%d flash chips found. Total DiskOnChip size: %ld MiBn",
  376.        this->numchips, this->totlen >> 20);
  377. }
  378. static int DoC2k_is_alias(struct DiskOnChip *doc1, struct DiskOnChip *doc2)
  379. {
  380. int tmp1, tmp2, retval;
  381. if (doc1->physadr == doc2->physadr)
  382. return 1;
  383. /* Use the alias resolution register which was set aside for this
  384.  * purpose. If it's value is the same on both chips, they might
  385.  * be the same chip, and we write to one and check for a change in
  386.  * the other. It's unclear if this register is usuable in the
  387.  * DoC 2000 (it's in the Millennium docs), but it seems to work. */
  388. tmp1 = ReadDOC(doc1->virtadr, AliasResolution);
  389. tmp2 = ReadDOC(doc2->virtadr, AliasResolution);
  390. if (tmp1 != tmp2)
  391. return 0;
  392. WriteDOC((tmp1 + 1) % 0xff, doc1->virtadr, AliasResolution);
  393. tmp2 = ReadDOC(doc2->virtadr, AliasResolution);
  394. if (tmp2 == (tmp1 + 1) % 0xff)
  395. retval = 1;
  396. else
  397. retval = 0;
  398. /* Restore register contents.  May not be necessary, but do it just to
  399.  * be safe. */
  400. WriteDOC(tmp1, doc1->virtadr, AliasResolution);
  401. return retval;
  402. }
  403. static const char im_name[] = "DoC2k_init";
  404. /* This routine is made available to other mtd code via
  405.  * inter_module_register.  It must only be accessed through
  406.  * inter_module_get which will bump the use count of this module.  The
  407.  * addresses passed back in mtd are valid as long as the use count of
  408.  * this module is non-zero, i.e. between inter_module_get and
  409.  * inter_module_put.  Keith Owens <kaos@ocs.com.au> 29 Oct 2000.
  410.  */
  411. static void DoC2k_init(struct mtd_info *mtd)
  412. {
  413. struct DiskOnChip *this = (struct DiskOnChip *) mtd->priv;
  414. struct DiskOnChip *old = NULL;
  415. /* We must avoid being called twice for the same device. */
  416. if (doc2klist)
  417. old = (struct DiskOnChip *) doc2klist->priv;
  418. while (old) {
  419. if (DoC2k_is_alias(old, this)) {
  420. printk(KERN_NOTICE
  421.        "Ignoring DiskOnChip 2000 at 0x%lX - already configuredn",
  422.        this->physadr);
  423. iounmap((void *) this->virtadr);
  424. kfree(mtd);
  425. return;
  426. }
  427. if (old->nextdoc)
  428. old = (struct DiskOnChip *) old->nextdoc->priv;
  429. else
  430. old = NULL;
  431. }
  432. switch (this->ChipID) {
  433. case DOC_ChipID_Doc2k:
  434. mtd->name = "DiskOnChip 2000";
  435. this->ioreg = DoC_2k_CDSN_IO;
  436. break;
  437. case DOC_ChipID_DocMil:
  438. mtd->name = "DiskOnChip Millennium";
  439. this->ioreg = DoC_Mil_CDSN_IO;
  440. break;
  441. }
  442. printk(KERN_NOTICE "%s found at address 0x%lXn", mtd->name,
  443.        this->physadr);
  444. mtd->type = MTD_NANDFLASH;
  445. mtd->flags = MTD_CAP_NANDFLASH;
  446. mtd->size = 0;
  447. mtd->erasesize = 0;
  448. mtd->oobblock = 512;
  449. mtd->oobsize = 16;
  450. mtd->module = THIS_MODULE;
  451. mtd->erase = doc_erase;
  452. mtd->point = NULL;
  453. mtd->unpoint = NULL;
  454. mtd->read = doc_read;
  455. mtd->write = doc_write;
  456. mtd->read_ecc = doc_read_ecc;
  457. mtd->write_ecc = doc_write_ecc;
  458. mtd->read_oob = doc_read_oob;
  459. mtd->write_oob = doc_write_oob;
  460. mtd->sync = NULL;
  461. this->totlen = 0;
  462. this->numchips = 0;
  463. this->curfloor = -1;
  464. this->curchip = -1;
  465. init_MUTEX(&this->lock);
  466. /* Ident all the chips present. */
  467. DoC_ScanChips(this);
  468. if (!this->totlen) {
  469. kfree(mtd);
  470. iounmap((void *) this->virtadr);
  471. } else {
  472. this->nextdoc = doc2klist;
  473. doc2klist = mtd;
  474. mtd->size = this->totlen;
  475. mtd->erasesize = this->erasesize;
  476. add_mtd_device(mtd);
  477. return;
  478. }
  479. }
  480. static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
  481.     size_t * retlen, u_char * buf)
  482. {
  483. /* Just a special case of doc_read_ecc */
  484. return doc_read_ecc(mtd, from, len, retlen, buf, NULL);
  485. }
  486. static int doc_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
  487. size_t * retlen, u_char * buf, u_char * eccbuf)
  488. {
  489. struct DiskOnChip *this = (struct DiskOnChip *) mtd->priv;
  490. unsigned long docptr;
  491. struct Nand *mychip;
  492. unsigned char syndrome[6];
  493. volatile char dummy;
  494. int i, len256 = 0, ret=0;
  495. docptr = this->virtadr;
  496. /* Don't allow read past end of device */
  497. if (from >= this->totlen)
  498. return -EINVAL;
  499. down(&this->lock);
  500. /* Don't allow a single read to cross a 512-byte block boundary */
  501. if (from + len > ((from | 0x1ff) + 1))
  502. len = ((from | 0x1ff) + 1) - from;
  503. /* The ECC will not be calculated correctly if less than 512 is read */
  504. if (len != 0x200 && eccbuf)
  505. printk(KERN_WARNING
  506.        "ECC needs a full sector read (adr: %lx size %lx)n",
  507.        (long) from, (long) len);
  508. /* printk("DoC_Read (adr: %lx size %lx)n", (long) from, (long) len); */
  509. /* Find the chip which is to be used and select it */
  510. mychip = &this->chips[from >> (this->chipshift)];
  511. if (this->curfloor != mychip->floor) {
  512. DoC_SelectFloor(this, mychip->floor);
  513. DoC_SelectChip(this, mychip->chip);
  514. } else if (this->curchip != mychip->chip) {
  515. DoC_SelectChip(this, mychip->chip);
  516. }
  517. this->curfloor = mychip->floor;
  518. this->curchip = mychip->chip;
  519. DoC_Command(this,
  520.     (!this->page256
  521.      && (from & 0x100)) ? NAND_CMD_READ1 : NAND_CMD_READ0,
  522.     CDSN_CTRL_WP);
  523. DoC_Address(this, ADDR_COLUMN_PAGE, from, CDSN_CTRL_WP,
  524.     CDSN_CTRL_ECC_IO);
  525. if (eccbuf) {
  526. /* Prime the ECC engine */
  527. WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
  528. WriteDOC(DOC_ECC_EN, docptr, ECCConf);
  529. } else {
  530. /* disable the ECC engine */
  531. WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
  532. WriteDOC(DOC_ECC_DIS, docptr, ECCConf);
  533. }
  534. /* treat crossing 256-byte sector for 2M x 8bits devices */
  535. if (this->page256 && from + len > (from | 0xff) + 1) {
  536. len256 = (from | 0xff) + 1 - from;
  537. DoC_ReadBuf(this, buf, len256);
  538. DoC_Command(this, NAND_CMD_READ0, CDSN_CTRL_WP);
  539. DoC_Address(this, ADDR_COLUMN_PAGE, from + len256,
  540.     CDSN_CTRL_WP, CDSN_CTRL_ECC_IO);
  541. }
  542. DoC_ReadBuf(this, &buf[len256], len - len256);
  543. /* Let the caller know we completed it */
  544. *retlen = len;
  545. if (eccbuf) {
  546. /* Read the ECC data through the DiskOnChip ECC logic */
  547. /* Note: this will work even with 2M x 8bit devices as   */
  548. /*       they have 8 bytes of OOB per 256 page. mf.      */
  549. DoC_ReadBuf(this, eccbuf, 6);
  550. /* Flush the pipeline */
  551. if (DoC_is_Millennium(this)) {
  552. dummy = ReadDOC(docptr, ECCConf);
  553. dummy = ReadDOC(docptr, ECCConf);
  554. i = ReadDOC(docptr, ECCConf);
  555. } else {
  556. dummy = ReadDOC(docptr, 2k_ECCStatus);
  557. dummy = ReadDOC(docptr, 2k_ECCStatus);
  558. i = ReadDOC(docptr, 2k_ECCStatus);
  559. }
  560. /* Check the ECC Status */
  561. if (i & 0x80) {
  562. int nb_errors;
  563. /* There was an ECC error */
  564. #ifdef ECC_DEBUG
  565. printk(KERN_ERR "DiskOnChip ECC Error: Read at %lxn", (long)from);
  566. #endif
  567. /* Read the ECC syndrom through the DiskOnChip ECC logic.
  568.    These syndrome will be all ZERO when there is no error */
  569. for (i = 0; i < 6; i++) {
  570. syndrome[i] =
  571.     ReadDOC(docptr, ECCSyndrome0 + i);
  572. }
  573.                         nb_errors = doc_decode_ecc(buf, syndrome);
  574. #ifdef ECC_DEBUG
  575. printk(KERN_ERR "Errors corrected: %xn", nb_errors);
  576. #endif
  577.                         if (nb_errors < 0) {
  578. /* We return error, but have actually done the read. Not that
  579.    this can be told to user-space, via sys_read(), but at least
  580.    MTD-aware stuff can know about it by checking *retlen */
  581. ret = -EIO;
  582.                         }
  583. }
  584. #ifdef PSYCHO_DEBUG
  585. printk(KERN_DEBUG "ECC DATA at %lxB: %2.2X %2.2X %2.2X %2.2X %2.2X %2.2Xn",
  586.      (long)from, eccbuf[0], eccbuf[1], eccbuf[2],
  587.      eccbuf[3], eccbuf[4], eccbuf[5]);
  588. #endif
  589. /* disable the ECC engine */
  590. WriteDOC(DOC_ECC_DIS, docptr , ECCConf);
  591. }
  592. /* according to 11.4.1, we need to wait for the busy line 
  593.          * drop if we read to the end of the page.  */
  594. if(0 == ((from + *retlen) & 0x1ff))
  595. {
  596.     DoC_WaitReady(this);
  597. }
  598. up(&this->lock);
  599. return ret;
  600. }
  601. static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
  602.      size_t * retlen, const u_char * buf)
  603. {
  604. char eccbuf[6];
  605. return doc_write_ecc(mtd, to, len, retlen, buf, eccbuf);
  606. }
  607. static int doc_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,
  608.  size_t * retlen, const u_char * buf,
  609.  u_char * eccbuf)
  610. {
  611. struct DiskOnChip *this = (struct DiskOnChip *) mtd->priv;
  612. int di; /* Yes, DI is a hangover from when I was disassembling the binary driver */
  613. unsigned long docptr;
  614. volatile char dummy;
  615. int len256 = 0;
  616. struct Nand *mychip;
  617. docptr = this->virtadr;
  618. /* Don't allow write past end of device */
  619. if (to >= this->totlen)
  620. return -EINVAL;
  621. down(&this->lock);
  622. /* Don't allow a single write to cross a 512-byte block boundary */
  623. if (to + len > ((to | 0x1ff) + 1))
  624. len = ((to | 0x1ff) + 1) - to;
  625. /* The ECC will not be calculated correctly if less than 512 is written */
  626. if (len != 0x200 && eccbuf)
  627. printk(KERN_WARNING
  628.        "ECC needs a full sector write (adr: %lx size %lx)n",
  629.        (long) to, (long) len);
  630. /* printk("DoC_Write (adr: %lx size %lx)n", (long) to, (long) len); */
  631. /* Find the chip which is to be used and select it */
  632. mychip = &this->chips[to >> (this->chipshift)];
  633. if (this->curfloor != mychip->floor) {
  634. DoC_SelectFloor(this, mychip->floor);
  635. DoC_SelectChip(this, mychip->chip);
  636. } else if (this->curchip != mychip->chip) {
  637. DoC_SelectChip(this, mychip->chip);
  638. }
  639. this->curfloor = mychip->floor;
  640. this->curchip = mychip->chip;
  641. /* Set device to main plane of flash */
  642. DoC_Command(this, NAND_CMD_RESET, CDSN_CTRL_WP);
  643. DoC_Command(this,
  644.     (!this->page256
  645.      && (to & 0x100)) ? NAND_CMD_READ1 : NAND_CMD_READ0,
  646.     CDSN_CTRL_WP);
  647. DoC_Command(this, NAND_CMD_SEQIN, 0);
  648. DoC_Address(this, ADDR_COLUMN_PAGE, to, 0, CDSN_CTRL_ECC_IO);
  649. if (eccbuf) {
  650. /* Prime the ECC engine */
  651. WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
  652. WriteDOC(DOC_ECC_EN | DOC_ECC_RW, docptr, ECCConf);
  653. } else {
  654. /* disable the ECC engine */
  655. WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
  656. WriteDOC(DOC_ECC_DIS, docptr, ECCConf);
  657. }
  658. /* treat crossing 256-byte sector for 2M x 8bits devices */
  659. if (this->page256 && to + len > (to | 0xff) + 1) {
  660. len256 = (to | 0xff) + 1 - to;
  661. DoC_WriteBuf(this, buf, len256);
  662. DoC_Command(this, NAND_CMD_PAGEPROG, 0);
  663. DoC_Command(this, NAND_CMD_STATUS, CDSN_CTRL_WP);
  664. /* There's an implicit DoC_WaitReady() in DoC_Command */
  665. dummy = ReadDOC(docptr, CDSNSlowIO);
  666. DoC_Delay(this, 2);
  667. if (ReadDOC_(docptr, this->ioreg) & 1) {
  668. printk(KERN_ERR "Error programming flashn");
  669. /* Error in programming */
  670. *retlen = 0;
  671. up(&this->lock);
  672. return -EIO;
  673. }
  674. DoC_Command(this, NAND_CMD_SEQIN, 0);
  675. DoC_Address(this, ADDR_COLUMN_PAGE, to + len256, 0,
  676.     CDSN_CTRL_ECC_IO);
  677. }
  678. DoC_WriteBuf(this, &buf[len256], len - len256);
  679. if (eccbuf) {
  680. WriteDOC(CDSN_CTRL_ECC_IO | CDSN_CTRL_CE, docptr,
  681.  CDSNControl);
  682. if (DoC_is_Millennium(this)) {
  683. WriteDOC(0, docptr, NOP);
  684. WriteDOC(0, docptr, NOP);
  685. WriteDOC(0, docptr, NOP);
  686. } else {
  687. WriteDOC_(0, docptr, this->ioreg);
  688. WriteDOC_(0, docptr, this->ioreg);
  689. WriteDOC_(0, docptr, this->ioreg);
  690. }
  691. /* Read the ECC data through the DiskOnChip ECC logic */
  692. for (di = 0; di < 6; di++) {
  693. eccbuf[di] = ReadDOC(docptr, ECCSyndrome0 + di);
  694. }
  695. /* Reset the ECC engine */
  696. WriteDOC(DOC_ECC_DIS, docptr, ECCConf);
  697. #ifdef PSYCHO_DEBUG
  698. printk
  699.     ("OOB data at %lx is %2.2X %2.2X %2.2X %2.2X %2.2X %2.2Xn",
  700.      (long) to, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
  701.      eccbuf[4], eccbuf[5]);
  702. #endif
  703. }
  704. DoC_Command(this, NAND_CMD_PAGEPROG, 0);
  705. DoC_Command(this, NAND_CMD_STATUS, CDSN_CTRL_WP);
  706. /* There's an implicit DoC_WaitReady() in DoC_Command */
  707. dummy = ReadDOC(docptr, CDSNSlowIO);
  708. DoC_Delay(this, 2);
  709. if (ReadDOC_(docptr, this->ioreg) & 1) {
  710. printk(KERN_ERR "Error programming flashn");
  711. /* Error in programming */
  712. *retlen = 0;
  713. up(&this->lock);
  714. return -EIO;
  715. }
  716. /* Let the caller know we completed it */
  717. *retlen = len;
  718. if (eccbuf) {
  719. unsigned char x[8];
  720. size_t dummy;
  721. int ret;
  722. /* Write the ECC data to flash */
  723. for (di=0; di<6; di++)
  724. x[di] = eccbuf[di];
  725. x[6]=0x55;
  726. x[7]=0x55;
  727. ret = doc_write_oob_nolock(mtd, to, 8, &dummy, x);
  728. up(&this->lock);
  729. return ret;
  730. }
  731. up(&this->lock);
  732. return 0;
  733. }
  734. static int doc_read_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
  735. size_t * retlen, u_char * buf)
  736. {
  737. struct DiskOnChip *this = (struct DiskOnChip *) mtd->priv;
  738. int len256 = 0, ret;
  739. unsigned long docptr;
  740. struct Nand *mychip;
  741. down(&this->lock);
  742. docptr = this->virtadr;
  743. mychip = &this->chips[ofs >> this->chipshift];
  744. if (this->curfloor != mychip->floor) {
  745. DoC_SelectFloor(this, mychip->floor);
  746. DoC_SelectChip(this, mychip->chip);
  747. } else if (this->curchip != mychip->chip) {
  748. DoC_SelectChip(this, mychip->chip);
  749. }
  750. this->curfloor = mychip->floor;
  751. this->curchip = mychip->chip;
  752. /* update address for 2M x 8bit devices. OOB starts on the second */
  753. /* page to maintain compatibility with doc_read_ecc. */
  754. if (this->page256) {
  755. if (!(ofs & 0x8))
  756. ofs += 0x100;
  757. else
  758. ofs -= 0x8;
  759. }
  760. DoC_Command(this, NAND_CMD_READOOB, CDSN_CTRL_WP);
  761. DoC_Address(this, ADDR_COLUMN_PAGE, ofs, CDSN_CTRL_WP, 0);
  762. /* treat crossing 8-byte OOB data for 2M x 8bit devices */
  763. /* Note: datasheet says it should automaticaly wrap to the */
  764. /*       next OOB block, but it didn't work here. mf.      */
  765. if (this->page256 && ofs + len > (ofs | 0x7) + 1) {
  766. len256 = (ofs | 0x7) + 1 - ofs;
  767. DoC_ReadBuf(this, buf, len256);
  768. DoC_Command(this, NAND_CMD_READOOB, CDSN_CTRL_WP);
  769. DoC_Address(this, ADDR_COLUMN_PAGE, ofs & (~0x1ff),
  770.     CDSN_CTRL_WP, 0);
  771. }
  772. DoC_ReadBuf(this, &buf[len256], len - len256);
  773. *retlen = len;
  774. /* Reading the full OOB data drops us off of the end of the page,
  775.          * causing the flash device to go into busy mode, so we need
  776.          * to wait until ready 11.4.1 and Toshiba TC58256FT docs */
  777. ret = DoC_WaitReady(this);
  778. up(&this->lock);
  779. return ret;
  780. }
  781. static int doc_write_oob_nolock(struct mtd_info *mtd, loff_t ofs, size_t len,
  782. size_t * retlen, const u_char * buf)
  783. {
  784. struct DiskOnChip *this = (struct DiskOnChip *) mtd->priv;
  785. int len256 = 0;
  786. unsigned long docptr = this->virtadr;
  787. struct Nand *mychip = &this->chips[ofs >> this->chipshift];
  788. volatile int dummy;
  789. //      printk("doc_write_oob(%lx, %d): %2.2X %2.2X %2.2X %2.2X ... %2.2X %2.2X .. %2.2X %2.2Xn",(long)ofs, len,
  790. //   buf[0], buf[1], buf[2], buf[3], buf[8], buf[9], buf[14],buf[15]);
  791. /* Find the chip which is to be used and select it */
  792. if (this->curfloor != mychip->floor) {
  793. DoC_SelectFloor(this, mychip->floor);
  794. DoC_SelectChip(this, mychip->chip);
  795. } else if (this->curchip != mychip->chip) {
  796. DoC_SelectChip(this, mychip->chip);
  797. }
  798. this->curfloor = mychip->floor;
  799. this->curchip = mychip->chip;
  800. /* disable the ECC engine */
  801. WriteDOC (DOC_ECC_RESET, docptr, ECCConf);
  802. WriteDOC (DOC_ECC_DIS, docptr, ECCConf);
  803. /* Reset the chip, see Software Requirement 11.4 item 1. */
  804. DoC_Command(this, NAND_CMD_RESET, CDSN_CTRL_WP);
  805. /* issue the Read2 command to set the pointer to the Spare Data Area. */
  806. DoC_Command(this, NAND_CMD_READOOB, CDSN_CTRL_WP);
  807. /* update address for 2M x 8bit devices. OOB starts on the second */
  808. /* page to maintain compatibility with doc_read_ecc. */
  809. if (this->page256) {
  810. if (!(ofs & 0x8))
  811. ofs += 0x100;
  812. else
  813. ofs -= 0x8;
  814. }
  815. /* issue the Serial Data In command to initial the Page Program process */
  816. DoC_Command(this, NAND_CMD_SEQIN, 0);
  817. DoC_Address(this, ADDR_COLUMN_PAGE, ofs, 0, 0);
  818. /* treat crossing 8-byte OOB data for 2M x 8bit devices */
  819. /* Note: datasheet says it should automaticaly wrap to the */
  820. /*       next OOB block, but it didn't work here. mf.      */
  821. if (this->page256 && ofs + len > (ofs | 0x7) + 1) {
  822. len256 = (ofs | 0x7) + 1 - ofs;
  823. DoC_WriteBuf(this, buf, len256);
  824. DoC_Command(this, NAND_CMD_PAGEPROG, 0);
  825. DoC_Command(this, NAND_CMD_STATUS, 0);
  826. /* DoC_WaitReady() is implicit in DoC_Command */
  827. dummy = ReadDOC(docptr, CDSNSlowIO);
  828. DoC_Delay(this, 2);
  829. if (ReadDOC_(docptr, this->ioreg) & 1) {
  830. printk(KERN_ERR "Error programming oob datan");
  831. /* There was an error */
  832. *retlen = 0;
  833. return -EIO;
  834. }
  835. DoC_Command(this, NAND_CMD_SEQIN, 0);
  836. DoC_Address(this, ADDR_COLUMN_PAGE, ofs & (~0x1ff), 0, 0);
  837. }
  838. DoC_WriteBuf(this, &buf[len256], len - len256);
  839. DoC_Command(this, NAND_CMD_PAGEPROG, 0);
  840. DoC_Command(this, NAND_CMD_STATUS, 0);
  841. /* DoC_WaitReady() is implicit in DoC_Command */
  842. dummy = ReadDOC(docptr, CDSNSlowIO);
  843. DoC_Delay(this, 2);
  844. if (ReadDOC_(docptr, this->ioreg) & 1) {
  845. printk(KERN_ERR "Error programming oob datan");
  846. /* There was an error */
  847. *retlen = 0;
  848. return -EIO;
  849. }
  850. *retlen = len;
  851. return 0;
  852. }
  853.  
  854. static int doc_write_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
  855.    size_t * retlen, const u_char * buf)
  856. {
  857.   struct DiskOnChip *this = (struct DiskOnChip *) mtd->priv;
  858.   int ret;
  859.   down(&this->lock);
  860.   ret = doc_write_oob_nolock(mtd, ofs, len, retlen, buf);
  861.   up(&this->lock);
  862.   return ret;
  863. }
  864. static int doc_erase(struct mtd_info *mtd, struct erase_info *instr)
  865. {
  866. struct DiskOnChip *this = (struct DiskOnChip *) mtd->priv;
  867. __u32 ofs = instr->addr;
  868. __u32 len = instr->len;
  869. volatile int dummy;
  870. unsigned long docptr;
  871. struct Nand *mychip;
  872.   down(&this->lock);
  873. if (ofs & (mtd->erasesize-1) || len & (mtd->erasesize-1)) {
  874. up(&this->lock);
  875. return -EINVAL;
  876. }
  877. instr->state = MTD_ERASING;
  878. docptr = this->virtadr;
  879. /* FIXME: Do this in the background. Use timers or schedule_task() */
  880. while(len) {
  881. mychip = &this->chips[ofs >> this->chipshift];
  882. if (this->curfloor != mychip->floor) {
  883. DoC_SelectFloor(this, mychip->floor);
  884. DoC_SelectChip(this, mychip->chip);
  885. } else if (this->curchip != mychip->chip) {
  886. DoC_SelectChip(this, mychip->chip);
  887. }
  888. this->curfloor = mychip->floor;
  889. this->curchip = mychip->chip;
  890. DoC_Command(this, NAND_CMD_ERASE1, 0);
  891. DoC_Address(this, ADDR_PAGE, ofs, 0, 0);
  892. DoC_Command(this, NAND_CMD_ERASE2, 0);
  893. DoC_Command(this, NAND_CMD_STATUS, CDSN_CTRL_WP);
  894. dummy = ReadDOC(docptr, CDSNSlowIO);
  895. DoC_Delay(this, 2);
  896. if (ReadDOC_(docptr, this->ioreg) & 1) {
  897. printk(KERN_ERR "Error erasing at 0x%xn", ofs);
  898. /* There was an error */
  899. instr->state = MTD_ERASE_FAILED;
  900. goto callback;
  901. }
  902. ofs += mtd->erasesize;
  903. len -= mtd->erasesize;
  904. }
  905. instr->state = MTD_ERASE_DONE;
  906.  callback:
  907. if (instr->callback)
  908. instr->callback(instr);
  909. up(&this->lock);
  910. return 0;
  911. }
  912. /****************************************************************************
  913.  *
  914.  * Module stuff
  915.  *
  916.  ****************************************************************************/
  917. int __init init_doc2000(void)
  918. {
  919.        inter_module_register(im_name, THIS_MODULE, &DoC2k_init);
  920.        return 0;
  921. }
  922. static void __exit cleanup_doc2000(void)
  923. {
  924. struct mtd_info *mtd;
  925. struct DiskOnChip *this;
  926. while ((mtd = doc2klist)) {
  927. this = (struct DiskOnChip *) mtd->priv;
  928. doc2klist = this->nextdoc;
  929. del_mtd_device(mtd);
  930. iounmap((void *) this->virtadr);
  931. kfree(this->chips);
  932. kfree(mtd);
  933. }
  934. inter_module_unregister(im_name);
  935. }
  936. module_exit(cleanup_doc2000);
  937. module_init(init_doc2000);
  938. MODULE_LICENSE("GPL");
  939. MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org> et al.");
  940. MODULE_DESCRIPTION("MTD driver for DiskOnChip 2000 and Millennium");