c0cd0a03f698590083759952b33a84bb3bba2c66
[linux-2.6.git] / drivers / block / mg_disk.c
1 /*
2  *  drivers/block/mg_disk.c
3  *
4  *  Support for the mGine m[g]flash IO mode.
5  *  Based on legacy hd.c
6  *
7  * (c) 2008 mGine Co.,LTD
8  * (c) 2008 unsik Kim <donari75@gmail.com>
9  *
10  *  This program is free software; you can redistribute it and/or modify
11  *  it under the terms of the GNU General Public License version 2 as
12  *  published by the Free Software Foundation.
13  */
14
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/fs.h>
18 #include <linux/blkdev.h>
19 #include <linux/hdreg.h>
20 #include <linux/ata.h>
21 #include <linux/interrupt.h>
22 #include <linux/delay.h>
23 #include <linux/platform_device.h>
24 #include <linux/gpio.h>
25
26 #define MG_RES_SEC (CONFIG_MG_DISK_RES << 1)
27
28 /* name for block device */
29 #define MG_DISK_NAME "mgd"
30 /* name for platform device */
31 #define MG_DEV_NAME "mg_disk"
32
33 #define MG_DISK_MAJ 0
34 #define MG_DISK_MAX_PART 16
35 #define MG_SECTOR_SIZE 512
36 #define MG_MAX_SECTS 256
37
38 /* Register offsets */
39 #define MG_BUFF_OFFSET                  0x8000
40 #define MG_STORAGE_BUFFER_SIZE          0x200
41 #define MG_REG_OFFSET                   0xC000
42 #define MG_REG_FEATURE                  (MG_REG_OFFSET + 2)     /* write case */
43 #define MG_REG_ERROR                    (MG_REG_OFFSET + 2)     /* read case */
44 #define MG_REG_SECT_CNT                 (MG_REG_OFFSET + 4)
45 #define MG_REG_SECT_NUM                 (MG_REG_OFFSET + 6)
46 #define MG_REG_CYL_LOW                  (MG_REG_OFFSET + 8)
47 #define MG_REG_CYL_HIGH                 (MG_REG_OFFSET + 0xA)
48 #define MG_REG_DRV_HEAD                 (MG_REG_OFFSET + 0xC)
49 #define MG_REG_COMMAND                  (MG_REG_OFFSET + 0xE)   /* write case */
50 #define MG_REG_STATUS                   (MG_REG_OFFSET + 0xE)   /* read  case */
51 #define MG_REG_DRV_CTRL                 (MG_REG_OFFSET + 0x10)
52 #define MG_REG_BURST_CTRL               (MG_REG_OFFSET + 0x12)
53
54 /* handy status */
55 #define MG_STAT_READY   (ATA_DRDY | ATA_DSC)
56 #define MG_READY_OK(s)  (((s) & (MG_STAT_READY | (ATA_BUSY | ATA_DF | \
57                                  ATA_ERR))) == MG_STAT_READY)
58
59 /* error code for others */
60 #define MG_ERR_NONE             0
61 #define MG_ERR_TIMEOUT          0x100
62 #define MG_ERR_INIT_STAT        0x101
63 #define MG_ERR_TRANSLATION      0x102
64 #define MG_ERR_CTRL_RST         0x103
65 #define MG_ERR_INV_STAT         0x104
66 #define MG_ERR_RSTOUT           0x105
67
68 #define MG_MAX_ERRORS   6       /* Max read/write errors */
69
70 /* command */
71 #define MG_CMD_RD 0x20
72 #define MG_CMD_WR 0x30
73 #define MG_CMD_SLEEP 0x99
74 #define MG_CMD_WAKEUP 0xC3
75 #define MG_CMD_ID 0xEC
76 #define MG_CMD_WR_CONF 0x3C
77 #define MG_CMD_RD_CONF 0x40
78
79 /* operation mode */
80 #define MG_OP_CASCADE (1 << 0)
81 #define MG_OP_CASCADE_SYNC_RD (1 << 1)
82 #define MG_OP_CASCADE_SYNC_WR (1 << 2)
83 #define MG_OP_INTERLEAVE (1 << 3)
84
85 /* synchronous */
86 #define MG_BURST_LAT_4 (3 << 4)
87 #define MG_BURST_LAT_5 (4 << 4)
88 #define MG_BURST_LAT_6 (5 << 4)
89 #define MG_BURST_LAT_7 (6 << 4)
90 #define MG_BURST_LAT_8 (7 << 4)
91 #define MG_BURST_LEN_4 (1 << 1)
92 #define MG_BURST_LEN_8 (2 << 1)
93 #define MG_BURST_LEN_16 (3 << 1)
94 #define MG_BURST_LEN_32 (4 << 1)
95 #define MG_BURST_LEN_CONT (0 << 1)
96
97 /* timeout value (unit: ms) */
98 #define MG_TMAX_CONF_TO_CMD     1
99 #define MG_TMAX_WAIT_RD_DRQ     10
100 #define MG_TMAX_WAIT_WR_DRQ     500
101 #define MG_TMAX_RST_TO_BUSY     10
102 #define MG_TMAX_HDRST_TO_RDY    500
103 #define MG_TMAX_SWRST_TO_RDY    500
104 #define MG_TMAX_RSTOUT          3000
105
106 /* device attribution */
107 /* use mflash as boot device */
108 #define MG_BOOT_DEV             (1 << 0)
109 /* use mflash as storage device */
110 #define MG_STORAGE_DEV          (1 << 1)
111 /* same as MG_STORAGE_DEV, but bootloader already done reset sequence */
112 #define MG_STORAGE_DEV_SKIP_RST (1 << 2)
113
114 #define MG_DEV_MASK (MG_BOOT_DEV | MG_STORAGE_DEV | MG_STORAGE_DEV_SKIP_RST)
115
116 /* names of GPIO resource */
117 #define MG_RST_PIN      "mg_rst"
118 /* except MG_BOOT_DEV, reset-out pin should be assigned */
119 #define MG_RSTOUT_PIN   "mg_rstout"
120
121 /* private driver data */
122 struct mg_drv_data {
123         /* disk resource */
124         u32 use_polling;
125
126         /* device attribution */
127         u32 dev_attr;
128
129         /* internally used */
130         struct mg_host *host;
131 };
132
133 /* main structure for mflash driver */
134 struct mg_host {
135         struct device *dev;
136
137         struct request_queue *breq;
138         struct request *req;
139         spinlock_t lock;
140         struct gendisk *gd;
141
142         struct timer_list timer;
143         void (*mg_do_intr) (struct mg_host *);
144
145         u16 id[ATA_ID_WORDS];
146
147         u16 cyls;
148         u16 heads;
149         u16 sectors;
150         u32 n_sectors;
151         u32 nres_sectors;
152
153         void __iomem *dev_base;
154         unsigned int irq;
155         unsigned int rst;
156         unsigned int rstout;
157
158         u32 major;
159         u32 error;
160 };
161
162 /*
163  * Debugging macro and defines
164  */
165 #undef DO_MG_DEBUG
166 #ifdef DO_MG_DEBUG
167 #  define MG_DBG(fmt, args...) \
168         printk(KERN_DEBUG "%s:%d "fmt, __func__, __LINE__, ##args)
169 #else /* CONFIG_MG_DEBUG */
170 #  define MG_DBG(fmt, args...) do { } while (0)
171 #endif /* CONFIG_MG_DEBUG */
172
173 static void mg_request(struct request_queue *);
174
175 static bool mg_end_request(struct mg_host *host, int err, unsigned int nr_bytes)
176 {
177         if (__blk_end_request(host->req, err, nr_bytes))
178                 return true;
179
180         host->req = NULL;
181         return false;
182 }
183
184 static bool mg_end_request_cur(struct mg_host *host, int err)
185 {
186         return mg_end_request(host, err, blk_rq_cur_bytes(host->req));
187 }
188
189 static void mg_dump_status(const char *msg, unsigned int stat,
190                 struct mg_host *host)
191 {
192         char *name = MG_DISK_NAME;
193
194         if (host->req)
195                 name = host->req->rq_disk->disk_name;
196
197         printk(KERN_ERR "%s: %s: status=0x%02x { ", name, msg, stat & 0xff);
198         if (stat & ATA_BUSY)
199                 printk("Busy ");
200         if (stat & ATA_DRDY)
201                 printk("DriveReady ");
202         if (stat & ATA_DF)
203                 printk("WriteFault ");
204         if (stat & ATA_DSC)
205                 printk("SeekComplete ");
206         if (stat & ATA_DRQ)
207                 printk("DataRequest ");
208         if (stat & ATA_CORR)
209                 printk("CorrectedError ");
210         if (stat & ATA_ERR)
211                 printk("Error ");
212         printk("}\n");
213         if ((stat & ATA_ERR) == 0) {
214                 host->error = 0;
215         } else {
216                 host->error = inb((unsigned long)host->dev_base + MG_REG_ERROR);
217                 printk(KERN_ERR "%s: %s: error=0x%02x { ", name, msg,
218                                 host->error & 0xff);
219                 if (host->error & ATA_BBK)
220                         printk("BadSector ");
221                 if (host->error & ATA_UNC)
222                         printk("UncorrectableError ");
223                 if (host->error & ATA_IDNF)
224                         printk("SectorIdNotFound ");
225                 if (host->error & ATA_ABORTED)
226                         printk("DriveStatusError ");
227                 if (host->error & ATA_AMNF)
228                         printk("AddrMarkNotFound ");
229                 printk("}");
230                 if (host->error & (ATA_BBK | ATA_UNC | ATA_IDNF | ATA_AMNF)) {
231                         if (host->req)
232                                 printk(", sector=%u",
233                                        (unsigned int)blk_rq_pos(host->req));
234                 }
235                 printk("\n");
236         }
237 }
238
239 static unsigned int mg_wait(struct mg_host *host, u32 expect, u32 msec)
240 {
241         u8 status;
242         unsigned long expire, cur_jiffies;
243         struct mg_drv_data *prv_data = host->dev->platform_data;
244
245         host->error = MG_ERR_NONE;
246         expire = jiffies + msecs_to_jiffies(msec);
247
248         status = inb((unsigned long)host->dev_base + MG_REG_STATUS);
249
250         do {
251                 cur_jiffies = jiffies;
252                 if (status & ATA_BUSY) {
253                         if (expect == ATA_BUSY)
254                                 break;
255                 } else {
256                         /* Check the error condition! */
257                         if (status & ATA_ERR) {
258                                 mg_dump_status("mg_wait", status, host);
259                                 break;
260                         }
261
262                         if (expect == MG_STAT_READY)
263                                 if (MG_READY_OK(status))
264                                         break;
265
266                         if (expect == ATA_DRQ)
267                                 if (status & ATA_DRQ)
268                                         break;
269                 }
270                 if (!msec) {
271                         mg_dump_status("not ready", status, host);
272                         return MG_ERR_INV_STAT;
273                 }
274                 if (prv_data->use_polling)
275                         msleep(1);
276
277                 status = inb((unsigned long)host->dev_base + MG_REG_STATUS);
278         } while (time_before(cur_jiffies, expire));
279
280         if (time_after_eq(cur_jiffies, expire) && msec)
281                 host->error = MG_ERR_TIMEOUT;
282
283         return host->error;
284 }
285
286 static unsigned int mg_wait_rstout(u32 rstout, u32 msec)
287 {
288         unsigned long expire;
289
290         expire = jiffies + msecs_to_jiffies(msec);
291         while (time_before(jiffies, expire)) {
292                 if (gpio_get_value(rstout) == 1)
293                         return MG_ERR_NONE;
294                 msleep(10);
295         }
296
297         return MG_ERR_RSTOUT;
298 }
299
300 static void mg_unexpected_intr(struct mg_host *host)
301 {
302         u32 status = inb((unsigned long)host->dev_base + MG_REG_STATUS);
303
304         mg_dump_status("mg_unexpected_intr", status, host);
305 }
306
307 static irqreturn_t mg_irq(int irq, void *dev_id)
308 {
309         struct mg_host *host = dev_id;
310         void (*handler)(struct mg_host *) = host->mg_do_intr;
311
312         spin_lock(&host->lock);
313
314         host->mg_do_intr = NULL;
315         del_timer(&host->timer);
316         if (!handler)
317                 handler = mg_unexpected_intr;
318         handler(host);
319
320         spin_unlock(&host->lock);
321
322         return IRQ_HANDLED;
323 }
324
325 /* local copy of ata_id_string() */
326 static void mg_id_string(const u16 *id, unsigned char *s,
327                          unsigned int ofs, unsigned int len)
328 {
329         unsigned int c;
330
331         BUG_ON(len & 1);
332
333         while (len > 0) {
334                 c = id[ofs] >> 8;
335                 *s = c;
336                 s++;
337
338                 c = id[ofs] & 0xff;
339                 *s = c;
340                 s++;
341
342                 ofs++;
343                 len -= 2;
344         }
345 }
346
347 /* local copy of ata_id_c_string() */
348 static void mg_id_c_string(const u16 *id, unsigned char *s,
349                            unsigned int ofs, unsigned int len)
350 {
351         unsigned char *p;
352
353         mg_id_string(id, s, ofs, len - 1);
354
355         p = s + strnlen(s, len - 1);
356         while (p > s && p[-1] == ' ')
357                 p--;
358         *p = '\0';
359 }
360
361 static int mg_get_disk_id(struct mg_host *host)
362 {
363         u32 i;
364         s32 err;
365         const u16 *id = host->id;
366         struct mg_drv_data *prv_data = host->dev->platform_data;
367         char fwrev[ATA_ID_FW_REV_LEN + 1];
368         char model[ATA_ID_PROD_LEN + 1];
369         char serial[ATA_ID_SERNO_LEN + 1];
370
371         if (!prv_data->use_polling)
372                 outb(ATA_NIEN, (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
373
374         outb(MG_CMD_ID, (unsigned long)host->dev_base + MG_REG_COMMAND);
375         err = mg_wait(host, ATA_DRQ, MG_TMAX_WAIT_RD_DRQ);
376         if (err)
377                 return err;
378
379         for (i = 0; i < (MG_SECTOR_SIZE >> 1); i++)
380                 host->id[i] = le16_to_cpu(inw((unsigned long)host->dev_base +
381                                         MG_BUFF_OFFSET + i * 2));
382
383         outb(MG_CMD_RD_CONF, (unsigned long)host->dev_base + MG_REG_COMMAND);
384         err = mg_wait(host, MG_STAT_READY, MG_TMAX_CONF_TO_CMD);
385         if (err)
386                 return err;
387
388         if ((id[ATA_ID_FIELD_VALID] & 1) == 0)
389                 return MG_ERR_TRANSLATION;
390
391         host->n_sectors = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
392         host->cyls = id[ATA_ID_CYLS];
393         host->heads = id[ATA_ID_HEADS];
394         host->sectors = id[ATA_ID_SECTORS];
395
396         if (MG_RES_SEC && host->heads && host->sectors) {
397                 /* modify cyls, n_sectors */
398                 host->cyls = (host->n_sectors - MG_RES_SEC) /
399                         host->heads / host->sectors;
400                 host->nres_sectors = host->n_sectors - host->cyls *
401                         host->heads * host->sectors;
402                 host->n_sectors -= host->nres_sectors;
403         }
404
405         mg_id_c_string(id, fwrev, ATA_ID_FW_REV, sizeof(fwrev));
406         mg_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
407         mg_id_c_string(id, serial, ATA_ID_SERNO, sizeof(serial));
408         printk(KERN_INFO "mg_disk: model: %s\n", model);
409         printk(KERN_INFO "mg_disk: firm: %.8s\n", fwrev);
410         printk(KERN_INFO "mg_disk: serial: %s\n", serial);
411         printk(KERN_INFO "mg_disk: %d + reserved %d sectors\n",
412                         host->n_sectors, host->nres_sectors);
413
414         if (!prv_data->use_polling)
415                 outb(0, (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
416
417         return err;
418 }
419
420
421 static int mg_disk_init(struct mg_host *host)
422 {
423         struct mg_drv_data *prv_data = host->dev->platform_data;
424         s32 err;
425         u8 init_status;
426
427         /* hdd rst low */
428         gpio_set_value(host->rst, 0);
429         err = mg_wait(host, ATA_BUSY, MG_TMAX_RST_TO_BUSY);
430         if (err)
431                 return err;
432
433         /* hdd rst high */
434         gpio_set_value(host->rst, 1);
435         err = mg_wait(host, MG_STAT_READY, MG_TMAX_HDRST_TO_RDY);
436         if (err)
437                 return err;
438
439         /* soft reset on */
440         outb(ATA_SRST | (prv_data->use_polling ? ATA_NIEN : 0),
441                         (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
442         err = mg_wait(host, ATA_BUSY, MG_TMAX_RST_TO_BUSY);
443         if (err)
444                 return err;
445
446         /* soft reset off */
447         outb(prv_data->use_polling ? ATA_NIEN : 0,
448                         (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
449         err = mg_wait(host, MG_STAT_READY, MG_TMAX_SWRST_TO_RDY);
450         if (err)
451                 return err;
452
453         init_status = inb((unsigned long)host->dev_base + MG_REG_STATUS) & 0xf;
454
455         if (init_status == 0xf)
456                 return MG_ERR_INIT_STAT;
457
458         return err;
459 }
460
461 static void mg_bad_rw_intr(struct mg_host *host)
462 {
463         if (host->req)
464                 if (++host->req->errors >= MG_MAX_ERRORS ||
465                     host->error == MG_ERR_TIMEOUT)
466                         mg_end_request_cur(host, -EIO);
467 }
468
469 static unsigned int mg_out(struct mg_host *host,
470                 unsigned int sect_num,
471                 unsigned int sect_cnt,
472                 unsigned int cmd,
473                 void (*intr_addr)(struct mg_host *))
474 {
475         struct mg_drv_data *prv_data = host->dev->platform_data;
476
477         if (mg_wait(host, MG_STAT_READY, MG_TMAX_CONF_TO_CMD))
478                 return host->error;
479
480         if (!prv_data->use_polling) {
481                 host->mg_do_intr = intr_addr;
482                 mod_timer(&host->timer, jiffies + 3 * HZ);
483         }
484         if (MG_RES_SEC)
485                 sect_num += MG_RES_SEC;
486         outb((u8)sect_cnt, (unsigned long)host->dev_base + MG_REG_SECT_CNT);
487         outb((u8)sect_num, (unsigned long)host->dev_base + MG_REG_SECT_NUM);
488         outb((u8)(sect_num >> 8), (unsigned long)host->dev_base +
489                         MG_REG_CYL_LOW);
490         outb((u8)(sect_num >> 16), (unsigned long)host->dev_base +
491                         MG_REG_CYL_HIGH);
492         outb((u8)((sect_num >> 24) | ATA_LBA | ATA_DEVICE_OBS),
493                         (unsigned long)host->dev_base + MG_REG_DRV_HEAD);
494         outb(cmd, (unsigned long)host->dev_base + MG_REG_COMMAND);
495         return MG_ERR_NONE;
496 }
497
498 static void mg_read(struct request *req)
499 {
500         u32 j;
501         struct mg_host *host = req->rq_disk->private_data;
502
503         if (mg_out(host, blk_rq_pos(req), blk_rq_sectors(req),
504                    MG_CMD_RD, NULL) != MG_ERR_NONE)
505                 mg_bad_rw_intr(host);
506
507         MG_DBG("requested %d sects (from %ld), buffer=0x%p\n",
508                blk_rq_sectors(req), blk_rq_pos(req), req->buffer);
509
510         do {
511                 u16 *buff = (u16 *)req->buffer;
512
513                 if (mg_wait(host, ATA_DRQ,
514                             MG_TMAX_WAIT_RD_DRQ) != MG_ERR_NONE) {
515                         mg_bad_rw_intr(host);
516                         return;
517                 }
518                 for (j = 0; j < MG_SECTOR_SIZE >> 1; j++)
519                         *buff++ = inw((unsigned long)host->dev_base +
520                                       MG_BUFF_OFFSET + (j << 1));
521
522                 outb(MG_CMD_RD_CONF, (unsigned long)host->dev_base +
523                                 MG_REG_COMMAND);
524         } while (mg_end_request(host, 0, MG_SECTOR_SIZE));
525 }
526
527 static void mg_write(struct request *req)
528 {
529         u32 j;
530         struct mg_host *host = req->rq_disk->private_data;
531
532         if (mg_out(host, blk_rq_pos(req), blk_rq_sectors(req),
533                    MG_CMD_WR, NULL) != MG_ERR_NONE) {
534                 mg_bad_rw_intr(host);
535                 return;
536         }
537
538         MG_DBG("requested %d sects (from %ld), buffer=0x%p\n",
539                blk_rq_sectors(req), blk_rq_pos(req), req->buffer);
540
541         do {
542                 u16 *buff = (u16 *)req->buffer;
543
544         if (mg_wait(host, ATA_DRQ, MG_TMAX_WAIT_WR_DRQ) != MG_ERR_NONE) {
545                         mg_bad_rw_intr(host);
546                         return;
547                 }
548                 for (j = 0; j < MG_SECTOR_SIZE >> 1; j++)
549                         outw(*buff++, (unsigned long)host->dev_base +
550                                       MG_BUFF_OFFSET + (j << 1));
551
552                 outb(MG_CMD_WR_CONF, (unsigned long)host->dev_base +
553                                 MG_REG_COMMAND);
554         } while (mg_end_request(host, 0, MG_SECTOR_SIZE));
555 }
556
557 static void mg_read_intr(struct mg_host *host)
558 {
559         struct request *req = host->req;
560         u32 i;
561         u16 *buff;
562
563         /* check status */
564         do {
565                 i = inb((unsigned long)host->dev_base + MG_REG_STATUS);
566                 if (i & ATA_BUSY)
567                         break;
568                 if (!MG_READY_OK(i))
569                         break;
570                 if (i & ATA_DRQ)
571                         goto ok_to_read;
572         } while (0);
573         mg_dump_status("mg_read_intr", i, host);
574         mg_bad_rw_intr(host);
575         mg_request(host->breq);
576         return;
577
578 ok_to_read:
579         /* get current segment of request */
580         buff = (u16 *)req->buffer;
581
582         /* read 1 sector */
583         for (i = 0; i < MG_SECTOR_SIZE >> 1; i++)
584                 *buff++ = inw((unsigned long)host->dev_base + MG_BUFF_OFFSET +
585                               (i << 1));
586
587         MG_DBG("sector %ld, remaining=%ld, buffer=0x%p\n",
588                blk_rq_pos(req), blk_rq_sectors(req) - 1, req->buffer);
589
590         /* send read confirm */
591         outb(MG_CMD_RD_CONF, (unsigned long)host->dev_base + MG_REG_COMMAND);
592
593         if (mg_end_request(host, 0, MG_SECTOR_SIZE)) {
594                 /* set handler if read remains */
595                 host->mg_do_intr = mg_read_intr;
596                 mod_timer(&host->timer, jiffies + 3 * HZ);
597         } else /* goto next request */
598                 mg_request(host->breq);
599 }
600
601 static void mg_write_intr(struct mg_host *host)
602 {
603         struct request *req = host->req;
604         u32 i, j;
605         u16 *buff;
606         bool rem;
607
608         /* check status */
609         do {
610                 i = inb((unsigned long)host->dev_base + MG_REG_STATUS);
611                 if (i & ATA_BUSY)
612                         break;
613                 if (!MG_READY_OK(i))
614                         break;
615                 if ((blk_rq_sectors(req) <= 1) || (i & ATA_DRQ))
616                         goto ok_to_write;
617         } while (0);
618         mg_dump_status("mg_write_intr", i, host);
619         mg_bad_rw_intr(host);
620         mg_request(host->breq);
621         return;
622
623 ok_to_write:
624         if ((rem = mg_end_request(host, 0, MG_SECTOR_SIZE))) {
625                 /* write 1 sector and set handler if remains */
626                 buff = (u16 *)req->buffer;
627                 for (j = 0; j < MG_STORAGE_BUFFER_SIZE >> 1; j++) {
628                         outw(*buff, (unsigned long)host->dev_base +
629                                         MG_BUFF_OFFSET + (j << 1));
630                         buff++;
631                 }
632                 MG_DBG("sector %ld, remaining=%ld, buffer=0x%p\n",
633                        blk_rq_pos(req), blk_rq_sectors(req), req->buffer);
634                 host->mg_do_intr = mg_write_intr;
635                 mod_timer(&host->timer, jiffies + 3 * HZ);
636         }
637
638         /* send write confirm */
639         outb(MG_CMD_WR_CONF, (unsigned long)host->dev_base + MG_REG_COMMAND);
640
641         if (!rem)
642                 mg_request(host->breq);
643 }
644
645 void mg_times_out(unsigned long data)
646 {
647         struct mg_host *host = (struct mg_host *)data;
648         char *name;
649
650         spin_lock_irq(&host->lock);
651
652         if (!host->req)
653                 goto out_unlock;
654
655         host->mg_do_intr = NULL;
656
657         name = host->req->rq_disk->disk_name;
658         printk(KERN_DEBUG "%s: timeout\n", name);
659
660         host->error = MG_ERR_TIMEOUT;
661         mg_bad_rw_intr(host);
662
663 out_unlock:
664         mg_request(host->breq);
665         spin_unlock_irq(&host->lock);
666 }
667
668 static void mg_request_poll(struct request_queue *q)
669 {
670         struct mg_host *host = q->queuedata;
671
672         while (1) {
673                 if (!host->req) {
674                         host->req = blk_fetch_request(q);
675                         if (!host->req)
676                                 break;
677                 }
678
679                 if (unlikely(!blk_fs_request(host->req))) {
680                         mg_end_request_cur(host, -EIO);
681                         continue;
682                 }
683
684                 if (rq_data_dir(host->req) == READ)
685                         mg_read(host->req);
686                 else
687                         mg_write(host->req);
688         }
689 }
690
691 static unsigned int mg_issue_req(struct request *req,
692                 struct mg_host *host,
693                 unsigned int sect_num,
694                 unsigned int sect_cnt)
695 {
696         u16 *buff;
697         u32 i;
698
699         switch (rq_data_dir(req)) {
700         case READ:
701                 if (mg_out(host, sect_num, sect_cnt, MG_CMD_RD, &mg_read_intr)
702                                 != MG_ERR_NONE) {
703                         mg_bad_rw_intr(host);
704                         return host->error;
705                 }
706                 break;
707         case WRITE:
708                 /* TODO : handler */
709                 outb(ATA_NIEN, (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
710                 if (mg_out(host, sect_num, sect_cnt, MG_CMD_WR, &mg_write_intr)
711                                 != MG_ERR_NONE) {
712                         mg_bad_rw_intr(host);
713                         return host->error;
714                 }
715                 del_timer(&host->timer);
716                 mg_wait(host, ATA_DRQ, MG_TMAX_WAIT_WR_DRQ);
717                 outb(0, (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
718                 if (host->error) {
719                         mg_bad_rw_intr(host);
720                         return host->error;
721                 }
722                 buff = (u16 *)req->buffer;
723                 for (i = 0; i < MG_SECTOR_SIZE >> 1; i++) {
724                         outw(*buff, (unsigned long)host->dev_base +
725                                         MG_BUFF_OFFSET + (i << 1));
726                         buff++;
727                 }
728                 mod_timer(&host->timer, jiffies + 3 * HZ);
729                 outb(MG_CMD_WR_CONF, (unsigned long)host->dev_base +
730                                 MG_REG_COMMAND);
731                 break;
732         }
733         return MG_ERR_NONE;
734 }
735
736 /* This function also called from IRQ context */
737 static void mg_request(struct request_queue *q)
738 {
739         struct mg_host *host = q->queuedata;
740         struct request *req;
741         u32 sect_num, sect_cnt;
742
743         while (1) {
744                 if (!host->req) {
745                         host->req = blk_fetch_request(q);
746                         if (!host->req)
747                                 break;
748                 }
749                 req = host->req;
750
751                 /* check unwanted request call */
752                 if (host->mg_do_intr)
753                         return;
754
755                 del_timer(&host->timer);
756
757                 sect_num = blk_rq_pos(req);
758                 /* deal whole segments */
759                 sect_cnt = blk_rq_sectors(req);
760
761                 /* sanity check */
762                 if (sect_num >= get_capacity(req->rq_disk) ||
763                                 ((sect_num + sect_cnt) >
764                                  get_capacity(req->rq_disk))) {
765                         printk(KERN_WARNING
766                                         "%s: bad access: sector=%d, count=%d\n",
767                                         req->rq_disk->disk_name,
768                                         sect_num, sect_cnt);
769                         mg_end_request_cur(host, -EIO);
770                         continue;
771                 }
772
773                 if (unlikely(!blk_fs_request(req))) {
774                         mg_end_request_cur(host, -EIO);
775                         continue;
776                 }
777
778                 if (!mg_issue_req(req, host, sect_num, sect_cnt))
779                         return;
780         }
781 }
782
783 static int mg_getgeo(struct block_device *bdev, struct hd_geometry *geo)
784 {
785         struct mg_host *host = bdev->bd_disk->private_data;
786
787         geo->cylinders = (unsigned short)host->cyls;
788         geo->heads = (unsigned char)host->heads;
789         geo->sectors = (unsigned char)host->sectors;
790         return 0;
791 }
792
793 static struct block_device_operations mg_disk_ops = {
794         .getgeo = mg_getgeo
795 };
796
797 static int mg_suspend(struct platform_device *plat_dev, pm_message_t state)
798 {
799         struct mg_drv_data *prv_data = plat_dev->dev.platform_data;
800         struct mg_host *host = prv_data->host;
801
802         if (mg_wait(host, MG_STAT_READY, MG_TMAX_CONF_TO_CMD))
803                 return -EIO;
804
805         if (!prv_data->use_polling)
806                 outb(ATA_NIEN, (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
807
808         outb(MG_CMD_SLEEP, (unsigned long)host->dev_base + MG_REG_COMMAND);
809         /* wait until mflash deep sleep */
810         msleep(1);
811
812         if (mg_wait(host, MG_STAT_READY, MG_TMAX_CONF_TO_CMD)) {
813                 if (!prv_data->use_polling)
814                         outb(0, (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
815                 return -EIO;
816         }
817
818         return 0;
819 }
820
821 static int mg_resume(struct platform_device *plat_dev)
822 {
823         struct mg_drv_data *prv_data = plat_dev->dev.platform_data;
824         struct mg_host *host = prv_data->host;
825
826         if (mg_wait(host, MG_STAT_READY, MG_TMAX_CONF_TO_CMD))
827                 return -EIO;
828
829         outb(MG_CMD_WAKEUP, (unsigned long)host->dev_base + MG_REG_COMMAND);
830         /* wait until mflash wakeup */
831         msleep(1);
832
833         if (mg_wait(host, MG_STAT_READY, MG_TMAX_CONF_TO_CMD))
834                 return -EIO;
835
836         if (!prv_data->use_polling)
837                 outb(0, (unsigned long)host->dev_base + MG_REG_DRV_CTRL);
838
839         return 0;
840 }
841
842 static int mg_probe(struct platform_device *plat_dev)
843 {
844         struct mg_host *host;
845         struct resource *rsc;
846         struct mg_drv_data *prv_data = plat_dev->dev.platform_data;
847         int err = 0;
848
849         if (!prv_data) {
850                 printk(KERN_ERR "%s:%d fail (no driver_data)\n",
851                                 __func__, __LINE__);
852                 err = -EINVAL;
853                 goto probe_err;
854         }
855
856         /* alloc mg_host */
857         host = kzalloc(sizeof(struct mg_host), GFP_KERNEL);
858         if (!host) {
859                 printk(KERN_ERR "%s:%d fail (no memory for mg_host)\n",
860                                 __func__, __LINE__);
861                 err = -ENOMEM;
862                 goto probe_err;
863         }
864         host->major = MG_DISK_MAJ;
865
866         /* link each other */
867         prv_data->host = host;
868         host->dev = &plat_dev->dev;
869
870         /* io remap */
871         rsc = platform_get_resource(plat_dev, IORESOURCE_MEM, 0);
872         if (!rsc) {
873                 printk(KERN_ERR "%s:%d platform_get_resource fail\n",
874                                 __func__, __LINE__);
875                 err = -EINVAL;
876                 goto probe_err_2;
877         }
878         host->dev_base = ioremap(rsc->start , rsc->end + 1);
879         if (!host->dev_base) {
880                 printk(KERN_ERR "%s:%d ioremap fail\n",
881                                 __func__, __LINE__);
882                 err = -EIO;
883                 goto probe_err_2;
884         }
885         MG_DBG("dev_base = 0x%x\n", (u32)host->dev_base);
886
887         /* get reset pin */
888         rsc = platform_get_resource_byname(plat_dev, IORESOURCE_IO,
889                         MG_RST_PIN);
890         if (!rsc) {
891                 printk(KERN_ERR "%s:%d get reset pin fail\n",
892                                 __func__, __LINE__);
893                 err = -EIO;
894                 goto probe_err_3;
895         }
896         host->rst = rsc->start;
897
898         /* init rst pin */
899         err = gpio_request(host->rst, MG_RST_PIN);
900         if (err)
901                 goto probe_err_3;
902         gpio_direction_output(host->rst, 1);
903
904         /* reset out pin */
905         if (!(prv_data->dev_attr & MG_DEV_MASK))
906                 goto probe_err_3a;
907
908         if (prv_data->dev_attr != MG_BOOT_DEV) {
909                 rsc = platform_get_resource_byname(plat_dev, IORESOURCE_IO,
910                                 MG_RSTOUT_PIN);
911                 if (!rsc) {
912                         printk(KERN_ERR "%s:%d get reset-out pin fail\n",
913                                         __func__, __LINE__);
914                         err = -EIO;
915                         goto probe_err_3a;
916                 }
917                 host->rstout = rsc->start;
918                 err = gpio_request(host->rstout, MG_RSTOUT_PIN);
919                 if (err)
920                         goto probe_err_3a;
921                 gpio_direction_input(host->rstout);
922         }
923
924         /* disk reset */
925         if (prv_data->dev_attr == MG_STORAGE_DEV) {
926                 /* If POR seq. not yet finised, wait */
927                 err = mg_wait_rstout(host->rstout, MG_TMAX_RSTOUT);
928                 if (err)
929                         goto probe_err_3b;
930                 err = mg_disk_init(host);
931                 if (err) {
932                         printk(KERN_ERR "%s:%d fail (err code : %d)\n",
933                                         __func__, __LINE__, err);
934                         err = -EIO;
935                         goto probe_err_3b;
936                 }
937         }
938
939         /* get irq resource */
940         if (!prv_data->use_polling) {
941                 host->irq = platform_get_irq(plat_dev, 0);
942                 if (host->irq == -ENXIO) {
943                         err = host->irq;
944                         goto probe_err_3b;
945                 }
946                 err = request_irq(host->irq, mg_irq,
947                                 IRQF_DISABLED | IRQF_TRIGGER_RISING,
948                                 MG_DEV_NAME, host);
949                 if (err) {
950                         printk(KERN_ERR "%s:%d fail (request_irq err=%d)\n",
951                                         __func__, __LINE__, err);
952                         goto probe_err_3b;
953                 }
954
955         }
956
957         /* get disk id */
958         err = mg_get_disk_id(host);
959         if (err) {
960                 printk(KERN_ERR "%s:%d fail (err code : %d)\n",
961                                 __func__, __LINE__, err);
962                 err = -EIO;
963                 goto probe_err_4;
964         }
965
966         err = register_blkdev(host->major, MG_DISK_NAME);
967         if (err < 0) {
968                 printk(KERN_ERR "%s:%d register_blkdev fail (err code : %d)\n",
969                                 __func__, __LINE__, err);
970                 goto probe_err_4;
971         }
972         if (!host->major)
973                 host->major = err;
974
975         spin_lock_init(&host->lock);
976
977         if (prv_data->use_polling)
978                 host->breq = blk_init_queue(mg_request_poll, &host->lock);
979         else
980                 host->breq = blk_init_queue(mg_request, &host->lock);
981
982         if (!host->breq) {
983                 err = -ENOMEM;
984                 printk(KERN_ERR "%s:%d (blk_init_queue) fail\n",
985                                 __func__, __LINE__);
986                 goto probe_err_5;
987         }
988         host->breq->queuedata = host;
989
990         /* mflash is random device, thanx for the noop */
991         elevator_exit(host->breq->elevator);
992         err = elevator_init(host->breq, "noop");
993         if (err) {
994                 printk(KERN_ERR "%s:%d (elevator_init) fail\n",
995                                 __func__, __LINE__);
996                 goto probe_err_6;
997         }
998         blk_queue_max_sectors(host->breq, MG_MAX_SECTS);
999         blk_queue_hardsect_size(host->breq, MG_SECTOR_SIZE);
1000
1001         init_timer(&host->timer);
1002         host->timer.function = mg_times_out;
1003         host->timer.data = (unsigned long)host;
1004
1005         host->gd = alloc_disk(MG_DISK_MAX_PART);
1006         if (!host->gd) {
1007                 printk(KERN_ERR "%s:%d (alloc_disk) fail\n",
1008                                 __func__, __LINE__);
1009                 err = -ENOMEM;
1010                 goto probe_err_7;
1011         }
1012         host->gd->major = host->major;
1013         host->gd->first_minor = 0;
1014         host->gd->fops = &mg_disk_ops;
1015         host->gd->queue = host->breq;
1016         host->gd->private_data = host;
1017         sprintf(host->gd->disk_name, MG_DISK_NAME"a");
1018
1019         set_capacity(host->gd, host->n_sectors);
1020
1021         add_disk(host->gd);
1022
1023         return err;
1024
1025 probe_err_7:
1026         del_timer_sync(&host->timer);
1027 probe_err_6:
1028         blk_cleanup_queue(host->breq);
1029 probe_err_5:
1030         unregister_blkdev(MG_DISK_MAJ, MG_DISK_NAME);
1031 probe_err_4:
1032         if (!prv_data->use_polling)
1033                 free_irq(host->irq, host);
1034 probe_err_3b:
1035         gpio_free(host->rstout);
1036 probe_err_3a:
1037         gpio_free(host->rst);
1038 probe_err_3:
1039         iounmap(host->dev_base);
1040 probe_err_2:
1041         kfree(host);
1042 probe_err:
1043         return err;
1044 }
1045
1046 static int mg_remove(struct platform_device *plat_dev)
1047 {
1048         struct mg_drv_data *prv_data = plat_dev->dev.platform_data;
1049         struct mg_host *host = prv_data->host;
1050         int err = 0;
1051
1052         /* delete timer */
1053         del_timer_sync(&host->timer);
1054
1055         /* remove disk */
1056         if (host->gd) {
1057                 del_gendisk(host->gd);
1058                 put_disk(host->gd);
1059         }
1060         /* remove queue */
1061         if (host->breq)
1062                 blk_cleanup_queue(host->breq);
1063
1064         /* unregister blk device */
1065         unregister_blkdev(host->major, MG_DISK_NAME);
1066
1067         /* free irq */
1068         if (!prv_data->use_polling)
1069                 free_irq(host->irq, host);
1070
1071         /* free reset-out pin */
1072         if (prv_data->dev_attr != MG_BOOT_DEV)
1073                 gpio_free(host->rstout);
1074
1075         /* free rst pin */
1076         if (host->rst)
1077                 gpio_free(host->rst);
1078
1079         /* unmap io */
1080         if (host->dev_base)
1081                 iounmap(host->dev_base);
1082
1083         /* free mg_host */
1084         kfree(host);
1085
1086         return err;
1087 }
1088
1089 static struct platform_driver mg_disk_driver = {
1090         .probe = mg_probe,
1091         .remove = mg_remove,
1092         .suspend = mg_suspend,
1093         .resume = mg_resume,
1094         .driver = {
1095                 .name = MG_DEV_NAME,
1096                 .owner = THIS_MODULE,
1097         }
1098 };
1099
1100 /****************************************************************************
1101  *
1102  * Module stuff
1103  *
1104  ****************************************************************************/
1105
1106 static int __init mg_init(void)
1107 {
1108         printk(KERN_INFO "mGine mflash driver, (c) 2008 mGine Co.\n");
1109         return platform_driver_register(&mg_disk_driver);
1110 }
1111
1112 static void __exit mg_exit(void)
1113 {
1114         printk(KERN_INFO "mflash driver : bye bye\n");
1115         platform_driver_unregister(&mg_disk_driver);
1116 }
1117
1118 module_init(mg_init);
1119 module_exit(mg_exit);
1120
1121 MODULE_LICENSE("GPL");
1122 MODULE_AUTHOR("unsik Kim <donari75@gmail.com>");
1123 MODULE_DESCRIPTION("mGine m[g]flash device driver");