1 // 16bit code to access floppy drives.
3 // Copyright (C) 2008 Kevin O'Connor <kevin@koconnor.net>
4 // Copyright (C) 2002 MandrakeSoft S.A.
6 // This file may be distributed under the terms of the GNU GPLv3 license.
8 #include "types.h" // u8
9 #include "disk.h" // DISK_RET_SUCCESS
10 #include "config.h" // CONFIG_FLOPPY_SUPPORT
11 #include "biosvar.h" // struct bregs
12 #include "util.h" // irq_disable
13 #include "cmos.h" // inb_cmos
15 #define DEBUGF1(fmt, args...) bprintf(0, fmt , ##args)
16 #define DEBUGF(fmt, args...)
18 #define BX_FLOPPY_ON_CNT 37 /* 2 seconds */
20 // New diskette parameter table adding 3 parameters from IBM
21 // Since no provisions are made for multiple drive types, most
22 // values in this table are ignored. I set parameters for 1.44M
24 struct floppy_ext_dbt_s diskette_param_table2 VISIBLE16 = {
27 .specify2 = 0x02, // head load time 0000001, DMA used
28 .shutoff_ticks = 0x25,
31 .interblock_len = 0x1B,
38 .max_track = 79, // maximum track
39 .data_rate = 0, // data transfer rate
40 .drive_type = 4, // drive type in cmos
44 // Return codes vary greatly - AL not cleared consistenlty, BDA return
45 // status not set consistently, sometimes panics.
46 // Extra outb(0x000a, 0x02) in read?
47 // Does not disable interrupts on failure paths.
48 // numfloppies used before set in int_1308
49 // int_1305 verifies track but doesn't use it?
52 set_diskette_current_cyl(u8 drive, u8 cyl)
55 SET_BDA(floppy_track1, cyl);
57 SET_BDA(floppy_track0, cyl);
61 get_drive_type(u8 drive)
63 // check CMOS to see if drive exists
64 u8 drive_type = inb_cmos(CMOS_FLOPPY_DRIVE_TYPE);
73 floppy_media_known(u8 drive)
75 if (!(GET_BDA(floppy_recalibration_status) & (1<<drive)))
77 u8 v = GET_BDA(floppy_media_state[drive]);
78 if (!(v & FMS_MEDIA_DRIVE_ESTABLISHED))
84 floppy_reset_controller()
87 u8 val8 = inb(PORT_FD_DOR);
88 outb(val8 & ~0x04, PORT_FD_DOR);
89 outb(val8 | 0x04, PORT_FD_DOR);
91 // Wait for controller to come out of reset
92 while ((inb(PORT_FD_STATUS) & 0xc0) != 0x80)
97 floppy_prepare_controller(u8 drive)
99 CLEARBITS_BDA(floppy_recalibration_status, FRS_TIMEOUT);
101 // turn on motor of selected drive, DMA & int enabled, normal operation
102 u8 prev_reset = inb(PORT_FD_DOR) & 0x04;
108 outb(dor, PORT_FD_DOR);
110 // reset the disk motor timeout value of INT 08
111 SET_BDA(floppy_motor_counter, BX_FLOPPY_ON_CNT);
113 // wait for drive readiness
114 while ((inb(PORT_FD_STATUS) & 0xc0) != 0x80)
117 if (prev_reset == 0) {
121 v = GET_BDA(floppy_recalibration_status);
122 } while ((v & FRS_TIMEOUT) == 0);
126 SET_BDA(floppy_recalibration_status, v);
131 floppy_pio(u8 *cmd, u8 cmdlen)
133 floppy_prepare_controller(cmd[1] & 1);
135 // send command to controller
137 for (i=0; i<cmdlen; i++)
138 outb(cmd[i], PORT_FD_DATA);
143 if (!GET_BDA(floppy_motor_counter)) {
145 floppy_reset_controller();
146 return DISK_RET_ETIMEOUT;
148 v = GET_BDA(floppy_recalibration_status);
149 } while (!(v & FRS_TIMEOUT));
153 SET_BDA(floppy_recalibration_status, v);
159 floppy_cmd(struct bregs *regs, u16 count, u8 *cmd, u8 cmdlen)
161 // es:bx = pointer to where to place information from diskette
162 // port 04: DMA-1 base and current address, channel 2
163 // port 05: DMA-1 base and current count, channel 2
164 u16 page = regs->es >> 12; // upper 4 bits
165 u16 base_es = regs->es << 4; // lower 16bits contributed by ES
166 u16 base_address = base_es + regs->bx; // lower 16 bits of address
167 // contributed by ES:BX
168 if (base_address < base_es)
169 // in case of carry, adjust page by 1
172 // check for 64K boundary overrun
173 u16 last_addr = base_address + count;
174 if (last_addr < base_address)
175 return DISK_RET_EBOUNDARY;
177 u8 mode_register = 0x4a; // single mode, increment, autoinit disable,
180 mode_register = 0x46;
182 //DEBUGF("floppy dma c2\n");
183 outb(0x06, PORT_DMA1_MASK_REG);
184 outb(0x00, PORT_DMA1_CLEAR_FF_REG); // clear flip-flop
185 outb(base_address, PORT_DMA_ADDR_2);
186 outb(base_address>>8, PORT_DMA_ADDR_2);
187 outb(0x00, PORT_DMA1_CLEAR_FF_REG); // clear flip-flop
188 outb(count, PORT_DMA_CNT_2);
189 outb(count>>8, PORT_DMA_CNT_2);
191 // port 0b: DMA-1 Mode Register
192 // transfer type=write, channel 2
193 outb(mode_register, PORT_DMA1_MODE_REG);
195 // port 81: DMA-1 Page Register, channel 2
196 outb(page, PORT_DMA_PAGE_2);
198 outb(0x02, PORT_DMA1_MASK_REG); // unmask channel 2
200 u8 ret = floppy_pio(cmd, cmdlen);
204 // check port 3f4 for accessibility to status bytes
205 if ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0)
206 BX_PANIC("int13_diskette: ctrl not ready\n");
208 // read 7 return status bytes from controller
210 for (i=0; i<7; i++) {
211 u8 v = inb(PORT_FD_DATA);
213 SET_BDA(floppy_return_status[i], v);
220 floppy_drive_recal(u8 drive)
222 // send Recalibrate command (2 bytes) to controller
224 data[0] = 0x07; // 07: Recalibrate
225 data[1] = drive; // 0=drive0, 1=drive1
228 SETBITS_BDA(floppy_recalibration_status, 1<<drive);
229 set_diskette_current_cyl(drive, 0);
233 floppy_media_sense(u8 drive)
236 u8 config_data, media_state;
238 floppy_drive_recal(drive);
240 // for now cheat and get drive type from CMOS,
241 // assume media is same as drive type
244 // Bitfields for diskette media control:
245 // Bit(s) Description (Table M0028)
246 // 7-6 last data rate set by controller
247 // 00=500kbps, 01=300kbps, 10=250kbps, 11=1Mbps
248 // 5-4 last diskette drive step rate selected
249 // 00=0Ch, 01=0Dh, 10=0Eh, 11=0Ah
250 // 3-2 {data rate at start of operation}
254 // Bitfields for diskette drive media state:
255 // Bit(s) Description (Table M0030)
257 // 00=500kbps, 01=300kbps, 10=250kbps, 11=1Mbps
258 // 5 double stepping required (e.g. 360kB in 1.2MB)
259 // 4 media type established
260 // 3 drive capable of supporting 4MB media
261 // 2-0 on exit from BIOS, contains
262 // 000 trying 360kB in 360kB
263 // 001 trying 360kB in 1.2MB
264 // 010 trying 1.2MB in 1.2MB
265 // 011 360kB in 360kB established
266 // 100 360kB in 1.2MB established
267 // 101 1.2MB in 1.2MB established
269 // 111 all other formats/drives
271 switch (get_drive_type(drive)) {
274 config_data = 0x00; // 0000 0000
275 media_state = 0x25; // 0010 0101
279 // 1.2 MB 5.25" drive
280 config_data = 0x00; // 0000 0000
281 media_state = 0x25; // 0010 0101 // need double stepping??? (bit 5)
286 config_data = 0x00; // 0000 0000 ???
287 media_state = 0x17; // 0001 0111
291 // 1.44 MB 3.5" drive
292 config_data = 0x00; // 0000 0000
293 media_state = 0x17; // 0001 0111
297 // 2.88 MB 3.5" drive
298 config_data = 0xCC; // 1100 1100
299 media_state = 0xD7; // 1101 0111
303 // Extended floppy size uses special cmos setting
306 config_data = 0x00; // 0000 0000
307 media_state = 0x27; // 0010 0111
312 config_data = 0x00; // 0000 0000
313 media_state = 0x27; // 0010 0111
318 config_data = 0x00; // 0000 0000
319 media_state = 0x27; // 0010 0111
324 config_data = 0x00; // 0000 0000
325 media_state = 0x00; // 0000 0000
329 SET_BDA(floppy_last_data_rate, config_data);
330 SET_BDA(floppy_media_state[drive], media_state);
335 floppy_ret(struct bregs *regs, u8 code)
337 SET_BDA(floppy_last_status, code);
339 set_code_fail(regs, code);
341 set_code_success(regs);
345 floppy_fail(struct bregs *regs, u8 code)
347 floppy_ret(regs, code);
348 regs->al = 0; // no sectors read
352 check_drive(struct bregs *regs, u8 drive)
354 // see if drive exists
355 if (drive > 1 || !get_drive_type(drive)) {
356 // XXX - return type doesn't match
357 floppy_fail(regs, DISK_RET_ETIMEOUT);
361 // see if media in drive, and type is known
362 if (floppy_media_known(drive) == 0 && floppy_media_sense(drive) == 0) {
363 floppy_fail(regs, DISK_RET_EMEDIA);
369 // diskette controller reset
371 floppy_1300(struct bregs *regs, u8 drive)
374 floppy_ret(regs, DISK_RET_EPARAM);
377 if (!get_drive_type(drive)) {
378 floppy_ret(regs, DISK_RET_ETIMEOUT);
381 set_diskette_current_cyl(drive, 0); // current cylinder
382 floppy_ret(regs, DISK_RET_SUCCESS);
385 // Read Diskette Status
387 floppy_1301(struct bregs *regs, u8 drive)
389 u8 v = GET_BDA(floppy_last_status);
394 // Read Diskette Sectors
396 floppy_1302(struct bregs *regs, u8 drive)
398 if (check_drive(regs, drive))
401 u8 num_sectors = regs->al;
403 u8 sector = regs->cl;
406 if (head > 1 || sector == 0 || num_sectors == 0
407 || track > 79 || num_sectors > 72) {
408 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
409 floppy_fail(regs, DISK_RET_EPARAM);
413 // send read-normal-data command (9 bytes) to controller
415 data[0] = 0xe6; // e6: read normal data
416 data[1] = (head << 2) | drive; // HD DR1 DR2
420 data[5] = 2; // 512 byte sector size
421 data[6] = sector + num_sectors - 1; // last sector to read on track
422 data[7] = 0; // Gap length
423 data[8] = 0xff; // Gap length
425 u16 ret = floppy_cmd(regs, (num_sectors * 512) - 1, data, 9);
427 floppy_fail(regs, ret);
431 if (data[0] & 0xc0) {
432 floppy_fail(regs, DISK_RET_ECONTROLLER);
436 // ??? should track be new val from return_status[3] ?
437 set_diskette_current_cyl(drive, track);
438 // AL = number of sectors read (same value as passed)
439 floppy_ret(regs, DISK_RET_SUCCESS);
442 // Write Diskette Sectors
444 floppy_1303(struct bregs *regs, u8 drive)
446 if (check_drive(regs, drive))
449 u8 num_sectors = regs->al;
451 u8 sector = regs->cl;
454 if (head > 1 || sector == 0 || num_sectors == 0
455 || track > 79 || num_sectors > 72) {
456 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
457 floppy_fail(regs, DISK_RET_EPARAM);
461 // send write-normal-data command (9 bytes) to controller
463 data[0] = 0xc5; // c5: write normal data
464 data[1] = (head << 2) | drive; // HD DR1 DR2
468 data[5] = 2; // 512 byte sector size
469 data[6] = sector + num_sectors - 1; // last sector to write on track
470 data[7] = 0; // Gap length
471 data[8] = 0xff; // Gap length
473 u8 ret = floppy_cmd(regs, (num_sectors * 512) - 1, data, 9);
475 floppy_fail(regs, ret);
479 if (data[0] & 0xc0) {
480 if (data[1] & 0x02) {
485 BX_PANIC("int13_diskette_function: read error\n");
488 // ??? should track be new val from return_status[3] ?
489 set_diskette_current_cyl(drive, track);
490 // AL = number of sectors read (same value as passed)
491 floppy_ret(regs, DISK_RET_SUCCESS);
494 // Verify Diskette Sectors
496 floppy_1304(struct bregs *regs, u8 drive)
498 if (check_drive(regs, drive))
501 u8 num_sectors = regs->al;
503 u8 sector = regs->cl;
506 if (head > 1 || sector == 0 || num_sectors == 0
507 || track > 79 || num_sectors > 72) {
508 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
509 floppy_fail(regs, DISK_RET_EPARAM);
513 // ??? should track be new val from return_status[3] ?
514 set_diskette_current_cyl(drive, track);
515 // AL = number of sectors verified (same value as passed)
516 floppy_ret(regs, DISK_RET_SUCCESS);
519 // format diskette track
521 floppy_1305(struct bregs *regs, u8 drive)
523 DEBUGF("floppy f05\n");
525 if (check_drive(regs, drive))
528 u8 num_sectors = regs->al;
531 if (head > 1 || num_sectors == 0 || num_sectors > 18) {
532 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
533 floppy_fail(regs, DISK_RET_EPARAM);
537 // send format-track command (6 bytes) to controller
539 data[0] = 0x4d; // 4d: format track
540 data[1] = (head << 2) | drive; // HD DR1 DR2
541 data[2] = 2; // 512 byte sector size
542 data[3] = num_sectors; // number of sectors per track
543 data[4] = 0; // Gap length
544 data[5] = 0xf6; // Fill byte
546 u8 ret = floppy_cmd(regs, (num_sectors * 4) - 1, data, 6);
548 floppy_fail(regs, ret);
552 if (data[0] & 0xc0) {
553 if (data[1] & 0x02) {
558 BX_PANIC("int13_diskette_function: read error\n");
561 set_diskette_current_cyl(drive, 0);
565 // read diskette drive parameters
567 floppy_1308(struct bregs *regs, u8 drive)
569 DEBUGF("floppy f08\n");
571 u8 drive_type = inb_cmos(CMOS_FLOPPY_DRIVE_TYPE);
573 if (drive_type & 0xf0)
575 if (drive_type & 0x0f)
585 regs->dl = num_floppies;
596 regs->bl = drive_type;
599 regs->dl = num_floppies;
601 switch (drive_type) {
604 regs->dh = 0; // max head #
607 case 1: // 360KB, 5.25"
608 regs->cx = 0x2709; // 40 tracks, 9 sectors
609 regs->dh = 1; // max head #
612 case 2: // 1.2MB, 5.25"
613 regs->cx = 0x4f0f; // 80 tracks, 15 sectors
614 regs->dh = 1; // max head #
617 case 3: // 720KB, 3.5"
618 regs->cx = 0x4f09; // 80 tracks, 9 sectors
619 regs->dh = 1; // max head #
622 case 4: // 1.44MB, 3.5"
623 regs->cx = 0x4f12; // 80 tracks, 18 sectors
624 regs->dh = 1; // max head #
627 case 5: // 2.88MB, 3.5"
628 regs->cx = 0x4f24; // 80 tracks, 36 sectors
629 regs->dh = 1; // max head #
632 case 6: // 160k, 5.25"
633 regs->cx = 0x2708; // 40 tracks, 8 sectors
634 regs->dh = 0; // max head #
637 case 7: // 180k, 5.25"
638 regs->cx = 0x2709; // 40 tracks, 9 sectors
639 regs->dh = 0; // max head #
642 case 8: // 320k, 5.25"
643 regs->cx = 0x2708; // 40 tracks, 8 sectors
644 regs->dh = 1; // max head #
648 BX_PANIC("floppy: int13: bad floppy type\n");
651 /* set es & di to point to 11 byte diskette param table in ROM */
653 regs->di = (u16)&diskette_param_table2;
654 /* disk status not changed upon success */
657 // read diskette drive type
659 floppy_1315(struct bregs *regs, u8 drive)
661 DEBUGF("floppy f15\n");
664 regs->ah = 0; // only 2 drives supported
665 // set_diskette_ret_status here ???
668 u8 drive_type = get_drive_type(drive);
670 regs->ah = (drive_type != 0);
674 // get diskette change line status
676 floppy_1316(struct bregs *regs, u8 drive)
678 DEBUGF("floppy f16\n");
680 floppy_ret(regs, DISK_RET_EPARAM);
683 floppy_ret(regs, DISK_RET_ECHANGED);
687 floppy_13XX(struct bregs *regs, u8 drive)
689 BX_INFO("int13_diskette: unsupported AH=%02x\n", regs->ah);
690 floppy_ret(regs, DISK_RET_EPARAM);
694 floppy_13(struct bregs *regs, u8 drive)
696 if (! CONFIG_FLOPPY_SUPPORT) {
699 case 0x01: floppy_1301(regs, drive); break;
700 default: floppy_13XX(regs, drive); break;
705 case 0x00: floppy_1300(regs, drive); break;
706 case 0x01: floppy_1301(regs, drive); break;
707 case 0x02: floppy_1302(regs, drive); break;
708 case 0x03: floppy_1303(regs, drive); break;
709 case 0x04: floppy_1304(regs, drive); break;
710 case 0x05: floppy_1305(regs, drive); break;
711 case 0x08: floppy_1308(regs, drive); break;
712 case 0x15: floppy_1315(regs, drive); break;
713 case 0x16: floppy_1316(regs, drive); break;
714 default: floppy_13XX(regs, drive); break;
718 // INT 0Eh Diskette Hardware ISR Entry Point
723 if ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0) {
724 outb(0x08, PORT_FD_DATA); // sense interrupt status
725 while ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0)
729 } while ((inb(PORT_FD_STATUS) & 0xc0) == 0xc0);
732 // diskette interrupt has occurred
733 SETBITS_BDA(floppy_recalibration_status, FRS_TIMEOUT);
736 // Called from int08 handler.
740 // time to turn off drive(s)?
741 u8 fcount = GET_BDA(floppy_motor_counter);
744 SET_BDA(floppy_motor_counter, fcount);
747 outb(inb(PORT_FD_DOR) & 0xcf, PORT_FD_DOR);