2 * Driver for SWIM (Sander Woz Integrated Machine) floppy controller
4 * Copyright (C) 2004,2008 Laurent Vivier <Laurent@lvivier.info>
6 * based on Alastair Bridgewater SWIM analysis, 2001
7 * based on SWIM3 driver (c) Paul Mackerras, 1996
8 * based on netBSD IWM driver (c) 1997, 1998 Hauke Fath.
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version
13 * 2 of the License, or (at your option) any later version.
15 * 2004-08-21 (lv) - Initial implementation
16 * 2008-10-30 (lv) - Port to 2.6
19 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/blkdev.h>
23 #include <linux/hdreg.h>
24 #include <linux/kernel.h>
25 #include <linux/delay.h>
26 #include <linux/platform_device.h>
28 #include <asm/macintosh.h>
29 #include <asm/mac_via.h>
31 #define CARDNAME "swim"
33 struct sector_header {
40 } __attribute__((packed));
42 #define DRIVER_VERSION "Version 0.2 (2008-10-30)"
44 #define REG(x) unsigned char x, x ## _pad[0x200 - 1];
64 } __attribute__((packed));
66 #define swim_write(base, reg, v) out_8(&(base)->write_##reg, (v))
67 #define swim_read(base, reg) in_8(&(base)->read_##reg)
88 } __attribute__((packed));
90 #define iwm_write(base, reg, v) out_8(&(base)->reg, (v))
91 #define iwm_read(base, reg) in_8(&(base)->reg)
93 /* bits in phase register */
95 #define SEEK_POSITIVE 0x070
96 #define SEEK_NEGATIVE 0x074
98 #define MOTOR_ON 0x072
99 #define MOTOR_OFF 0x076
108 #define CA_MASK 0x077
110 /* Select values for swim_select and swim_readbit */
112 #define READ_DATA_0 0x074
113 #define TWOMEG_DRIVE 0x075
114 #define SINGLE_SIDED 0x076
115 #define DRIVE_PRESENT 0x077
116 #define DISK_IN 0x170
117 #define WRITE_PROT 0x171
118 #define TRACK_ZERO 0x172
120 #define READ_DATA_1 0x174
121 #define MFM_MODE 0x175
122 #define SEEK_COMPLETE 0x176
123 #define ONEMEG_MEDIA 0x177
125 /* Bits in handshake register */
127 #define MARK_BYTE 0x01
128 #define CRC_ZERO 0x02
133 #define DAT2BYTE 0x40
134 #define DAT1BYTE 0x80
136 /* bits in setup register */
138 #define S_INV_WDATA 0x01
139 #define S_3_5_SELECT 0x02
141 #define S_FCLK_DIV2 0x08
142 #define S_ERROR_CORR 0x10
143 #define S_IBM_DRIVE 0x20
144 #define S_GCR_WRITE 0x40
145 #define S_TIMEOUT 0x80
147 /* bits in mode register */
153 #define WRITE_MODE 0x10
157 /*----------------------------------------------------------------------------*/
159 enum drive_location {
160 INTERNAL_DRIVE = 0x02,
161 EXTERNAL_DRIVE = 0x04,
169 struct floppy_state {
171 /* physical properties */
173 enum drive_location location; /* internal or external drive */
174 int head_number; /* single- or double-sided drive */
180 enum media_type type;
187 /* in-use information */
192 struct gendisk *disk;
194 /* parent controller */
196 struct swim_priv *swd;
209 #define FD_MAX_UNIT 2
212 struct swim __iomem *base;
214 struct request_queue *queue;
216 struct floppy_state unit[FD_MAX_UNIT];
219 extern int swim_read_sector_header(struct swim __iomem *base,
220 struct sector_header *header);
221 extern int swim_read_sector_data(struct swim __iomem *base,
222 unsigned char *data);
224 static inline void set_swim_mode(struct swim __iomem *base, int enable)
226 struct iwm __iomem *iwm_base;
230 swim_write(base, mode0, 0xf8);
234 iwm_base = (struct iwm __iomem *)base;
235 local_irq_save(flags);
237 iwm_read(iwm_base, q7L);
238 iwm_read(iwm_base, mtrOff);
239 iwm_read(iwm_base, q6H);
241 iwm_write(iwm_base, q7H, 0x57);
242 iwm_write(iwm_base, q7H, 0x17);
243 iwm_write(iwm_base, q7H, 0x57);
244 iwm_write(iwm_base, q7H, 0x57);
246 local_irq_restore(flags);
249 static inline int get_swim_mode(struct swim __iomem *base)
253 local_irq_save(flags);
255 swim_write(base, phase, 0xf5);
256 if (swim_read(base, phase) != 0xf5)
258 swim_write(base, phase, 0xf6);
259 if (swim_read(base, phase) != 0xf6)
261 swim_write(base, phase, 0xf7);
262 if (swim_read(base, phase) != 0xf7)
264 local_irq_restore(flags);
267 local_irq_restore(flags);
271 static inline void swim_select(struct swim __iomem *base, int sel)
273 swim_write(base, phase, RELAX);
275 via1_set_head(sel & 0x100);
277 swim_write(base, phase, sel & CA_MASK);
280 static inline void swim_action(struct swim __iomem *base, int action)
284 local_irq_save(flags);
286 swim_select(base, action);
288 swim_write(base, phase, (LSTRB<<4) | LSTRB);
290 swim_write(base, phase, (LSTRB<<4) | ((~LSTRB) & 0x0F));
293 local_irq_restore(flags);
296 static inline int swim_readbit(struct swim __iomem *base, int bit)
300 swim_select(base, bit);
304 stat = swim_read(base, handshake);
306 return (stat & SENSE) == 0;
309 static inline void swim_drive(struct swim __iomem *base,
310 enum drive_location location)
312 if (location == INTERNAL_DRIVE) {
313 swim_write(base, mode0, EXTERNAL_DRIVE); /* clear drive 1 bit */
314 swim_write(base, mode1, INTERNAL_DRIVE); /* set drive 0 bit */
315 } else if (location == EXTERNAL_DRIVE) {
316 swim_write(base, mode0, INTERNAL_DRIVE); /* clear drive 0 bit */
317 swim_write(base, mode1, EXTERNAL_DRIVE); /* set drive 1 bit */
321 static inline void swim_motor(struct swim __iomem *base,
322 enum motor_action action)
327 swim_action(base, MOTOR_ON);
329 for (i = 0; i < 2*HZ; i++) {
330 swim_select(base, RELAX);
331 if (swim_readbit(base, MOTOR_ON))
333 current->state = TASK_INTERRUPTIBLE;
336 } else if (action == OFF) {
337 swim_action(base, MOTOR_OFF);
338 swim_select(base, RELAX);
342 static inline void swim_eject(struct swim __iomem *base)
346 swim_action(base, EJECT);
348 for (i = 0; i < 2*HZ; i++) {
349 swim_select(base, RELAX);
350 if (!swim_readbit(base, DISK_IN))
352 current->state = TASK_INTERRUPTIBLE;
355 swim_select(base, RELAX);
358 static inline void swim_head(struct swim __iomem *base, enum head head)
360 /* wait drive is ready */
362 if (head == UPPER_HEAD)
363 swim_select(base, READ_DATA_1);
364 else if (head == LOWER_HEAD)
365 swim_select(base, READ_DATA_0);
368 static inline int swim_step(struct swim __iomem *base)
372 swim_action(base, STEP);
374 for (wait = 0; wait < HZ; wait++) {
376 current->state = TASK_INTERRUPTIBLE;
379 swim_select(base, RELAX);
380 if (!swim_readbit(base, STEP))
386 static inline int swim_track00(struct swim __iomem *base)
390 swim_action(base, SEEK_NEGATIVE);
392 for (try = 0; try < 100; try++) {
394 swim_select(base, RELAX);
395 if (swim_readbit(base, TRACK_ZERO))
402 if (swim_readbit(base, TRACK_ZERO))
408 static inline int swim_seek(struct swim __iomem *base, int step)
414 swim_action(base, SEEK_NEGATIVE);
417 swim_action(base, SEEK_POSITIVE);
419 for ( ; step > 0; step--) {
427 static inline int swim_track(struct floppy_state *fs, int track)
429 struct swim __iomem *base = fs->swd->base;
432 ret = swim_seek(base, track - fs->track);
444 static int floppy_eject(struct floppy_state *fs)
446 struct swim __iomem *base = fs->swd->base;
448 swim_drive(base, fs->location);
449 swim_motor(base, OFF);
458 static inline int swim_read_sector(struct floppy_state *fs,
460 int sector, unsigned char *buffer)
462 struct swim __iomem *base = fs->swd->base;
464 struct sector_header header;
468 swim_track(fs, track);
470 swim_write(base, mode1, MOTON);
471 swim_head(base, side);
472 swim_write(base, mode0, side);
474 local_irq_save(flags);
475 for (i = 0; i < 36; i++) {
476 ret = swim_read_sector_header(base, &header);
477 if (!ret && (header.sector == sector)) {
480 ret = swim_read_sector_data(base, buffer);
484 local_irq_restore(flags);
486 swim_write(base, mode0, MOTON);
488 if ((header.side != side) || (header.track != track) ||
489 (header.sector != sector))
495 static int floppy_read_sectors(struct floppy_state *fs,
496 int req_sector, int sectors_nb,
497 unsigned char *buffer)
499 struct swim __iomem *base = fs->swd->base;
501 int side, track, sector;
505 swim_drive(base, fs->location);
506 for (i = req_sector; i < req_sector + sectors_nb; i++) {
508 track = i / fs->secpercyl;
509 x = i % fs->secpercyl;
510 side = x / fs->secpertrack;
511 sector = x % fs->secpertrack + 1;
515 ret = swim_read_sector(fs, side, track, sector,
519 } while (ret != 512);
527 static void redo_fd_request(struct request_queue *q)
530 struct floppy_state *fs;
532 req = blk_fetch_request(q);
536 fs = req->rq_disk->private_data;
537 if (blk_rq_pos(req) >= fs->total_secs)
541 if (rq_data_dir(req) == WRITE && fs->write_protected)
544 switch (rq_data_dir(req)) {
546 /* NOT IMPLEMENTED */
549 err = floppy_read_sectors(fs, blk_rq_pos(req),
550 blk_rq_cur_sectors(req),
555 if (!__blk_end_request_cur(req, err))
556 req = blk_fetch_request(q);
560 static void do_fd_request(struct request_queue *q)
565 static struct floppy_struct floppy_type[4] = {
566 { 0, 0, 0, 0, 0, 0x00, 0x00, 0x00, 0x00, NULL }, /* no testing */
567 { 720, 9, 1, 80, 0, 0x2A, 0x02, 0xDF, 0x50, NULL }, /* 360KB SS 3.5"*/
568 { 1440, 9, 2, 80, 0, 0x2A, 0x02, 0xDF, 0x50, NULL }, /* 720KB 3.5" */
569 { 2880, 18, 2, 80, 0, 0x1B, 0x00, 0xCF, 0x6C, NULL }, /* 1.44MB 3.5" */
572 static int get_floppy_geometry(struct floppy_state *fs, int type,
573 struct floppy_struct **g)
575 if (type >= ARRAY_SIZE(floppy_type))
579 *g = &floppy_type[type];
580 else if (fs->type == HD_MEDIA) /* High-Density media */
581 *g = &floppy_type[3];
582 else if (fs->head_number == 2) /* double-sided */
583 *g = &floppy_type[2];
585 *g = &floppy_type[1];
590 static void setup_medium(struct floppy_state *fs)
592 struct swim __iomem *base = fs->swd->base;
594 if (swim_readbit(base, DISK_IN)) {
595 struct floppy_struct *g;
597 fs->write_protected = swim_readbit(base, WRITE_PROT);
598 fs->type = swim_readbit(base, ONEMEG_MEDIA);
600 if (swim_track00(base))
602 "SWIM: cannot move floppy head to track 0\n");
606 get_floppy_geometry(fs, 0, &g);
607 fs->total_secs = g->size;
608 fs->secpercyl = g->head * g->sect;
609 fs->secpertrack = g->sect;
616 static int floppy_open(struct block_device *bdev, fmode_t mode)
618 struct floppy_state *fs = bdev->bd_disk->private_data;
619 struct swim __iomem *base = fs->swd->base;
622 if (fs->ref_count == -1 || (fs->ref_count && mode & FMODE_EXCL))
625 if (mode & FMODE_EXCL)
630 swim_write(base, setup, S_IBM_DRIVE | S_FCLK_DIV2);
632 swim_drive(base, INTERNAL_DRIVE);
633 swim_motor(base, ON);
634 swim_action(base, SETMFM);
642 if (mode & FMODE_NDELAY)
645 if (mode & (FMODE_READ|FMODE_WRITE)) {
646 check_disk_change(bdev);
647 if ((mode & FMODE_WRITE) && fs->write_protected) {
654 if (fs->ref_count < 0)
656 else if (fs->ref_count > 0)
659 if (fs->ref_count == 0)
660 swim_motor(base, OFF);
664 static int floppy_release(struct gendisk *disk, fmode_t mode)
666 struct floppy_state *fs = disk->private_data;
667 struct swim __iomem *base = fs->swd->base;
669 if (fs->ref_count < 0)
671 else if (fs->ref_count > 0)
674 if (fs->ref_count == 0)
675 swim_motor(base, OFF);
680 static int floppy_ioctl(struct block_device *bdev, fmode_t mode,
681 unsigned int cmd, unsigned long param)
683 struct floppy_state *fs = bdev->bd_disk->private_data;
686 if ((cmd & 0x80) && !capable(CAP_SYS_ADMIN))
691 if (fs->ref_count != 1)
693 err = floppy_eject(fs);
697 if (copy_to_user((void __user *) param, (void *) &floppy_type,
698 sizeof(struct floppy_struct)))
703 printk(KERN_DEBUG "SWIM floppy_ioctl: unknown cmd %d\n",
710 static int floppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
712 struct floppy_state *fs = bdev->bd_disk->private_data;
713 struct floppy_struct *g;
716 ret = get_floppy_geometry(fs, 0, &g);
720 geo->heads = g->head;
721 geo->sectors = g->sect;
722 geo->cylinders = g->track;
727 static int floppy_check_change(struct gendisk *disk)
729 struct floppy_state *fs = disk->private_data;
734 static int floppy_revalidate(struct gendisk *disk)
736 struct floppy_state *fs = disk->private_data;
737 struct swim __iomem *base = fs->swd->base;
739 swim_drive(base, fs->location);
745 swim_motor(base, OFF);
752 static const struct block_device_operations floppy_fops = {
753 .owner = THIS_MODULE,
755 .release = floppy_release,
756 .locked_ioctl = floppy_ioctl,
757 .getgeo = floppy_getgeo,
758 .media_changed = floppy_check_change,
759 .revalidate_disk = floppy_revalidate,
762 static struct kobject *floppy_find(dev_t dev, int *part, void *data)
764 struct swim_priv *swd = data;
765 int drive = (*part & 3);
767 if (drive > swd->floppy_count)
771 return get_disk(swd->unit[drive].disk);
774 static int __devinit swim_add_floppy(struct swim_priv *swd,
775 enum drive_location location)
777 struct floppy_state *fs = &swd->unit[swd->floppy_count];
778 struct swim __iomem *base = swd->base;
780 fs->location = location;
782 swim_drive(base, location);
784 swim_motor(base, OFF);
786 if (swim_readbit(base, SINGLE_SIDED))
798 static int __devinit swim_floppy_init(struct swim_priv *swd)
802 struct swim __iomem *base = swd->base;
804 /* scan floppy drives */
806 swim_drive(base, INTERNAL_DRIVE);
807 if (swim_readbit(base, DRIVE_PRESENT))
808 swim_add_floppy(swd, INTERNAL_DRIVE);
809 swim_drive(base, EXTERNAL_DRIVE);
810 if (swim_readbit(base, DRIVE_PRESENT))
811 swim_add_floppy(swd, EXTERNAL_DRIVE);
813 /* register floppy drives */
815 err = register_blkdev(FLOPPY_MAJOR, "fd");
817 printk(KERN_ERR "Unable to get major %d for SWIM floppy\n",
822 for (drive = 0; drive < swd->floppy_count; drive++) {
823 swd->unit[drive].disk = alloc_disk(1);
824 if (swd->unit[drive].disk == NULL) {
828 swd->unit[drive].swd = swd;
831 swd->queue = blk_init_queue(do_fd_request, &swd->lock);
837 for (drive = 0; drive < swd->floppy_count; drive++) {
838 swd->unit[drive].disk->flags = GENHD_FL_REMOVABLE;
839 swd->unit[drive].disk->major = FLOPPY_MAJOR;
840 swd->unit[drive].disk->first_minor = drive;
841 sprintf(swd->unit[drive].disk->disk_name, "fd%d", drive);
842 swd->unit[drive].disk->fops = &floppy_fops;
843 swd->unit[drive].disk->private_data = &swd->unit[drive];
844 swd->unit[drive].disk->queue = swd->queue;
845 set_capacity(swd->unit[drive].disk, 2880);
846 add_disk(swd->unit[drive].disk);
849 blk_register_region(MKDEV(FLOPPY_MAJOR, 0), 256, THIS_MODULE,
850 floppy_find, NULL, swd);
855 unregister_blkdev(FLOPPY_MAJOR, "fd");
857 put_disk(swd->unit[drive].disk);
861 static int __devinit swim_probe(struct platform_device *dev)
863 struct resource *res;
864 struct swim __iomem *swim_base;
865 struct swim_priv *swd;
868 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
874 if (!request_mem_region(res->start, resource_size(res), CARDNAME)) {
879 swim_base = ioremap(res->start, resource_size(res));
887 set_swim_mode(swim_base, 1);
888 if (!get_swim_mode(swim_base)) {
889 printk(KERN_INFO "SWIM device not found !\n");
894 /* set platform driver data */
896 swd = kzalloc(sizeof(struct swim_priv), GFP_KERNEL);
901 platform_set_drvdata(dev, swd);
903 swd->base = swim_base;
905 ret = swim_floppy_init(swd);
912 platform_set_drvdata(dev, NULL);
917 release_mem_region(res->start, resource_size(res));
922 static int __devexit swim_remove(struct platform_device *dev)
924 struct swim_priv *swd = platform_get_drvdata(dev);
926 struct resource *res;
928 blk_unregister_region(MKDEV(FLOPPY_MAJOR, 0), 256);
930 for (drive = 0; drive < swd->floppy_count; drive++) {
931 del_gendisk(swd->unit[drive].disk);
932 put_disk(swd->unit[drive].disk);
935 unregister_blkdev(FLOPPY_MAJOR, "fd");
937 blk_cleanup_queue(swd->queue);
941 for (drive = 0; drive < swd->floppy_count; drive++)
942 floppy_eject(&swd->unit[drive]);
946 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
948 release_mem_region(res->start, resource_size(res));
950 platform_set_drvdata(dev, NULL);
956 static struct platform_driver swim_driver = {
958 .remove = __devexit_p(swim_remove),
961 .owner = THIS_MODULE,
965 static int __init swim_init(void)
967 printk(KERN_INFO "SWIM floppy driver %s\n", DRIVER_VERSION);
969 return platform_driver_register(&swim_driver);
971 module_init(swim_init);
973 static void __exit swim_exit(void)
975 platform_driver_unregister(&swim_driver);
977 module_exit(swim_exit);
979 MODULE_DESCRIPTION("Driver for SWIM floppy controller");
980 MODULE_LICENSE("GPL");
981 MODULE_AUTHOR("Laurent Vivier <laurent@lvivier.info>");
982 MODULE_ALIAS_BLOCKDEV_MAJOR(FLOPPY_MAJOR);