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
46 u8 type = inb_cmos(CMOS_FLOPPY_DRIVE_TYPE);
52 SET_BDA(floppy_harddisk_info, out);
53 outb(0x02, PORT_DMA1_MASK_REG);
57 // Return codes vary greatly - AL not cleared consistenlty, BDA return
58 // status not set consistently, sometimes panics.
59 // Extra outb(0x000a, 0x02) in read?
60 // Does not disable interrupts on failure paths.
61 // numfloppies used before set in int_1308
62 // int_1305 verifies track but doesn't use it?
65 set_diskette_current_cyl(u8 drive, u8 cyl)
68 SET_BDA(floppy_track1, cyl);
70 SET_BDA(floppy_track0, cyl);
74 get_drive_type(u8 drive)
76 // check CMOS to see if drive exists
77 u8 drive_type = inb_cmos(CMOS_FLOPPY_DRIVE_TYPE);
86 floppy_media_known(u8 drive)
88 if (!(GET_BDA(floppy_recalibration_status) & (1<<drive)))
90 u8 v = GET_BDA(floppy_media_state[drive]);
91 if (!(v & FMS_MEDIA_DRIVE_ESTABLISHED))
97 floppy_reset_controller()
100 u8 val8 = inb(PORT_FD_DOR);
101 outb(val8 & ~0x04, PORT_FD_DOR);
102 outb(val8 | 0x04, PORT_FD_DOR);
104 // Wait for controller to come out of reset
105 while ((inb(PORT_FD_STATUS) & 0xc0) != 0x80)
110 floppy_prepare_controller(u8 drive)
112 CLEARBITS_BDA(floppy_recalibration_status, FRS_TIMEOUT);
114 // turn on motor of selected drive, DMA & int enabled, normal operation
115 u8 prev_reset = inb(PORT_FD_DOR) & 0x04;
121 outb(dor, PORT_FD_DOR);
123 // reset the disk motor timeout value of INT 08
124 SET_BDA(floppy_motor_counter, BX_FLOPPY_ON_CNT);
126 // wait for drive readiness
127 while ((inb(PORT_FD_STATUS) & 0xc0) != 0x80)
130 if (prev_reset == 0) {
134 v = GET_BDA(floppy_recalibration_status);
142 SET_BDA(floppy_recalibration_status, v);
147 floppy_pio(u8 *cmd, u8 cmdlen)
149 floppy_prepare_controller(cmd[1] & 1);
151 // send command to controller
153 for (i=0; i<cmdlen; i++)
154 outb(cmd[i], PORT_FD_DATA);
159 if (!GET_BDA(floppy_motor_counter)) {
161 floppy_reset_controller();
162 return DISK_RET_ETIMEOUT;
164 v = GET_BDA(floppy_recalibration_status);
172 SET_BDA(floppy_recalibration_status, v);
178 floppy_cmd(struct bregs *regs, u16 count, u8 *cmd, u8 cmdlen)
180 // es:bx = pointer to where to place information from diskette
181 // port 04: DMA-1 base and current address, channel 2
182 // port 05: DMA-1 base and current count, channel 2
183 u16 page = regs->es >> 12; // upper 4 bits
184 u16 base_es = regs->es << 4; // lower 16bits contributed by ES
185 u16 base_address = base_es + regs->bx; // lower 16 bits of address
186 // contributed by ES:BX
187 if (base_address < base_es)
188 // in case of carry, adjust page by 1
191 // check for 64K boundary overrun
192 u16 last_addr = base_address + count;
193 if (last_addr < base_address)
194 return DISK_RET_EBOUNDARY;
196 u8 mode_register = 0x4a; // single mode, increment, autoinit disable,
199 mode_register = 0x46;
201 //DEBUGF("floppy dma c2\n");
202 outb(0x06, PORT_DMA1_MASK_REG);
203 outb(0x00, PORT_DMA1_CLEAR_FF_REG); // clear flip-flop
204 outb(base_address, PORT_DMA_ADDR_2);
205 outb(base_address>>8, PORT_DMA_ADDR_2);
206 outb(0x00, PORT_DMA1_CLEAR_FF_REG); // clear flip-flop
207 outb(count, PORT_DMA_CNT_2);
208 outb(count>>8, PORT_DMA_CNT_2);
210 // port 0b: DMA-1 Mode Register
211 // transfer type=write, channel 2
212 outb(mode_register, PORT_DMA1_MODE_REG);
214 // port 81: DMA-1 Page Register, channel 2
215 outb(page, PORT_DMA_PAGE_2);
217 outb(0x02, PORT_DMA1_MASK_REG); // unmask channel 2
219 u8 ret = floppy_pio(cmd, cmdlen);
223 // check port 3f4 for accessibility to status bytes
224 if ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0)
225 BX_PANIC("int13_diskette: ctrl not ready\n");
227 // read 7 return status bytes from controller
229 for (i=0; i<7; i++) {
230 u8 v = inb(PORT_FD_DATA);
232 SET_BDA(floppy_return_status[i], v);
239 floppy_drive_recal(u8 drive)
241 // send Recalibrate command (2 bytes) to controller
243 data[0] = 0x07; // 07: Recalibrate
244 data[1] = drive; // 0=drive0, 1=drive1
247 SETBITS_BDA(floppy_recalibration_status, 1<<drive);
248 set_diskette_current_cyl(drive, 0);
252 floppy_media_sense(u8 drive)
255 u8 config_data, media_state;
257 floppy_drive_recal(drive);
259 // for now cheat and get drive type from CMOS,
260 // assume media is same as drive type
263 // Bitfields for diskette media control:
264 // Bit(s) Description (Table M0028)
265 // 7-6 last data rate set by controller
266 // 00=500kbps, 01=300kbps, 10=250kbps, 11=1Mbps
267 // 5-4 last diskette drive step rate selected
268 // 00=0Ch, 01=0Dh, 10=0Eh, 11=0Ah
269 // 3-2 {data rate at start of operation}
273 // Bitfields for diskette drive media state:
274 // Bit(s) Description (Table M0030)
276 // 00=500kbps, 01=300kbps, 10=250kbps, 11=1Mbps
277 // 5 double stepping required (e.g. 360kB in 1.2MB)
278 // 4 media type established
279 // 3 drive capable of supporting 4MB media
280 // 2-0 on exit from BIOS, contains
281 // 000 trying 360kB in 360kB
282 // 001 trying 360kB in 1.2MB
283 // 010 trying 1.2MB in 1.2MB
284 // 011 360kB in 360kB established
285 // 100 360kB in 1.2MB established
286 // 101 1.2MB in 1.2MB established
288 // 111 all other formats/drives
290 switch (get_drive_type(drive)) {
293 config_data = 0x00; // 0000 0000
294 media_state = 0x25; // 0010 0101
298 // 1.2 MB 5.25" drive
299 config_data = 0x00; // 0000 0000
300 media_state = 0x25; // 0010 0101 // need double stepping??? (bit 5)
305 config_data = 0x00; // 0000 0000 ???
306 media_state = 0x17; // 0001 0111
310 // 1.44 MB 3.5" drive
311 config_data = 0x00; // 0000 0000
312 media_state = 0x17; // 0001 0111
316 // 2.88 MB 3.5" drive
317 config_data = 0xCC; // 1100 1100
318 media_state = 0xD7; // 1101 0111
322 // Extended floppy size uses special cmos setting
325 config_data = 0x00; // 0000 0000
326 media_state = 0x27; // 0010 0111
331 config_data = 0x00; // 0000 0000
332 media_state = 0x27; // 0010 0111
337 config_data = 0x00; // 0000 0000
338 media_state = 0x27; // 0010 0111
343 config_data = 0x00; // 0000 0000
344 media_state = 0x00; // 0000 0000
348 SET_BDA(floppy_last_data_rate, config_data);
349 SET_BDA(floppy_media_state[drive], media_state);
353 #define floppy_ret(regs, code) \
354 __floppy_ret(__func__, (regs), (code))
357 __floppy_ret(const char *fname, struct bregs *regs, u8 code)
359 SET_BDA(floppy_last_status, code);
361 __set_code_fail(fname, regs, code);
363 set_code_success(regs);
367 floppy_fail(struct bregs *regs, u8 code)
369 floppy_ret(regs, code);
370 regs->al = 0; // no sectors read
374 check_drive(struct bregs *regs, u8 drive)
376 // see if drive exists
377 if (drive > 1 || !get_drive_type(drive)) {
378 // XXX - return type doesn't match
379 floppy_fail(regs, DISK_RET_ETIMEOUT);
383 // see if media in drive, and type is known
384 if (floppy_media_known(drive) == 0 && floppy_media_sense(drive) == 0) {
385 floppy_fail(regs, DISK_RET_EMEDIA);
391 // diskette controller reset
393 floppy_1300(struct bregs *regs, u8 drive)
396 floppy_ret(regs, DISK_RET_EPARAM);
399 if (!get_drive_type(drive)) {
400 floppy_ret(regs, DISK_RET_ETIMEOUT);
403 set_diskette_current_cyl(drive, 0); // current cylinder
404 floppy_ret(regs, DISK_RET_SUCCESS);
407 // Read Diskette Status
409 floppy_1301(struct bregs *regs, u8 drive)
411 u8 v = GET_BDA(floppy_last_status);
416 // Read Diskette Sectors
418 floppy_1302(struct bregs *regs, u8 drive)
420 if (check_drive(regs, drive))
423 u8 num_sectors = regs->al;
425 u8 sector = regs->cl;
428 if (head > 1 || sector == 0 || num_sectors == 0
429 || track > 79 || num_sectors > 72) {
430 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
431 floppy_fail(regs, DISK_RET_EPARAM);
435 // send read-normal-data command (9 bytes) to controller
437 data[0] = 0xe6; // e6: read normal data
438 data[1] = (head << 2) | drive; // HD DR1 DR2
442 data[5] = 2; // 512 byte sector size
443 data[6] = sector + num_sectors - 1; // last sector to read on track
444 data[7] = 0; // Gap length
445 data[8] = 0xff; // Gap length
447 u16 ret = floppy_cmd(regs, (num_sectors * 512) - 1, data, 9);
449 floppy_fail(regs, ret);
453 if (data[0] & 0xc0) {
454 floppy_fail(regs, DISK_RET_ECONTROLLER);
458 // ??? should track be new val from return_status[3] ?
459 set_diskette_current_cyl(drive, track);
460 // AL = number of sectors read (same value as passed)
461 floppy_ret(regs, DISK_RET_SUCCESS);
464 // Write Diskette Sectors
466 floppy_1303(struct bregs *regs, u8 drive)
468 if (check_drive(regs, drive))
471 u8 num_sectors = regs->al;
473 u8 sector = regs->cl;
476 if (head > 1 || sector == 0 || num_sectors == 0
477 || track > 79 || num_sectors > 72) {
478 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
479 floppy_fail(regs, DISK_RET_EPARAM);
483 // send write-normal-data command (9 bytes) to controller
485 data[0] = 0xc5; // c5: write normal data
486 data[1] = (head << 2) | drive; // HD DR1 DR2
490 data[5] = 2; // 512 byte sector size
491 data[6] = sector + num_sectors - 1; // last sector to write on track
492 data[7] = 0; // Gap length
493 data[8] = 0xff; // Gap length
495 u8 ret = floppy_cmd(regs, (num_sectors * 512) - 1, data, 9);
497 floppy_fail(regs, ret);
501 if (data[0] & 0xc0) {
502 if (data[1] & 0x02) {
507 BX_PANIC("int13_diskette_function: read error\n");
510 // ??? should track be new val from return_status[3] ?
511 set_diskette_current_cyl(drive, track);
512 // AL = number of sectors read (same value as passed)
513 floppy_ret(regs, DISK_RET_SUCCESS);
516 // Verify Diskette Sectors
518 floppy_1304(struct bregs *regs, u8 drive)
520 if (check_drive(regs, drive))
523 u8 num_sectors = regs->al;
525 u8 sector = regs->cl;
528 if (head > 1 || sector == 0 || num_sectors == 0
529 || track > 79 || num_sectors > 72) {
530 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
531 floppy_fail(regs, DISK_RET_EPARAM);
535 // ??? should track be new val from return_status[3] ?
536 set_diskette_current_cyl(drive, track);
537 // AL = number of sectors verified (same value as passed)
538 floppy_ret(regs, DISK_RET_SUCCESS);
541 // format diskette track
543 floppy_1305(struct bregs *regs, u8 drive)
545 DEBUGF("floppy f05\n");
547 if (check_drive(regs, drive))
550 u8 num_sectors = regs->al;
553 if (head > 1 || num_sectors == 0 || num_sectors > 18) {
554 BX_INFO("int13_diskette: read/write/verify: parameter out of range\n");
555 floppy_fail(regs, DISK_RET_EPARAM);
559 // send format-track command (6 bytes) to controller
561 data[0] = 0x4d; // 4d: format track
562 data[1] = (head << 2) | drive; // HD DR1 DR2
563 data[2] = 2; // 512 byte sector size
564 data[3] = num_sectors; // number of sectors per track
565 data[4] = 0; // Gap length
566 data[5] = 0xf6; // Fill byte
568 u8 ret = floppy_cmd(regs, (num_sectors * 4) - 1, data, 6);
570 floppy_fail(regs, ret);
574 if (data[0] & 0xc0) {
575 if (data[1] & 0x02) {
580 BX_PANIC("int13_diskette_function: read error\n");
583 set_diskette_current_cyl(drive, 0);
587 // read diskette drive parameters
589 floppy_1308(struct bregs *regs, u8 drive)
591 DEBUGF("floppy f08\n");
593 u8 drive_type = inb_cmos(CMOS_FLOPPY_DRIVE_TYPE);
595 if (drive_type & 0xf0)
597 if (drive_type & 0x0f)
607 regs->dl = num_floppies;
618 regs->bl = drive_type;
621 regs->dl = num_floppies;
623 switch (drive_type) {
626 regs->dh = 0; // max head #
629 case 1: // 360KB, 5.25"
630 regs->cx = 0x2709; // 40 tracks, 9 sectors
631 regs->dh = 1; // max head #
634 case 2: // 1.2MB, 5.25"
635 regs->cx = 0x4f0f; // 80 tracks, 15 sectors
636 regs->dh = 1; // max head #
639 case 3: // 720KB, 3.5"
640 regs->cx = 0x4f09; // 80 tracks, 9 sectors
641 regs->dh = 1; // max head #
644 case 4: // 1.44MB, 3.5"
645 regs->cx = 0x4f12; // 80 tracks, 18 sectors
646 regs->dh = 1; // max head #
649 case 5: // 2.88MB, 3.5"
650 regs->cx = 0x4f24; // 80 tracks, 36 sectors
651 regs->dh = 1; // max head #
654 case 6: // 160k, 5.25"
655 regs->cx = 0x2708; // 40 tracks, 8 sectors
656 regs->dh = 0; // max head #
659 case 7: // 180k, 5.25"
660 regs->cx = 0x2709; // 40 tracks, 9 sectors
661 regs->dh = 0; // max head #
664 case 8: // 320k, 5.25"
665 regs->cx = 0x2708; // 40 tracks, 8 sectors
666 regs->dh = 1; // max head #
670 BX_PANIC("floppy: int13: bad floppy type\n");
673 /* set es & di to point to 11 byte diskette param table in ROM */
675 regs->di = (u32)&diskette_param_table2;
676 /* disk status not changed upon success */
679 // read diskette drive type
681 floppy_1315(struct bregs *regs, u8 drive)
683 DEBUGF("floppy f15\n");
686 regs->ah = 0; // only 2 drives supported
687 // set_diskette_ret_status here ???
690 u8 drive_type = get_drive_type(drive);
692 regs->ah = (drive_type != 0);
696 // get diskette change line status
698 floppy_1316(struct bregs *regs, u8 drive)
700 DEBUGF("floppy f16\n");
702 floppy_ret(regs, DISK_RET_EPARAM);
705 floppy_ret(regs, DISK_RET_ECHANGED);
709 floppy_13XX(struct bregs *regs, u8 drive)
711 BX_INFO("int13_diskette: unsupported AH=%02x\n", regs->ah);
712 floppy_ret(regs, DISK_RET_EPARAM);
716 floppy_13(struct bregs *regs, u8 drive)
718 if (! CONFIG_FLOPPY_SUPPORT) {
721 case 0x01: floppy_1301(regs, drive); break;
722 default: floppy_13XX(regs, drive); break;
727 case 0x00: floppy_1300(regs, drive); break;
728 case 0x01: floppy_1301(regs, drive); break;
729 case 0x02: floppy_1302(regs, drive); break;
730 case 0x03: floppy_1303(regs, drive); break;
731 case 0x04: floppy_1304(regs, drive); break;
732 case 0x05: floppy_1305(regs, drive); break;
733 case 0x08: floppy_1308(regs, drive); break;
734 case 0x15: floppy_1315(regs, drive); break;
735 case 0x16: floppy_1316(regs, drive); break;
736 default: floppy_13XX(regs, drive); break;
740 // INT 0Eh Diskette Hardware ISR Entry Point
745 if ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0) {
746 outb(0x08, PORT_FD_DATA); // sense interrupt status
747 while ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0)
751 } while ((inb(PORT_FD_STATUS) & 0xc0) == 0xc0);
754 // diskette interrupt has occurred
755 SETBITS_BDA(floppy_recalibration_status, FRS_TIMEOUT);
758 // Called from int08 handler.
762 // time to turn off drive(s)?
763 u8 fcount = GET_BDA(floppy_motor_counter);
766 SET_BDA(floppy_motor_counter, fcount);
769 outb(inb(PORT_FD_DOR) & 0xcf, PORT_FD_DOR);