1 // 16bit code to access floppy drives.
3 // Copyright (C) 2008,2009 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 LGPLv3 license.
8 #include "types.h" // u8
9 #include "disk.h" // DISK_RET_SUCCESS
10 #include "config.h" // CONFIG_FLOPPY
11 #include "biosvar.h" // SET_BDA
12 #include "util.h" // wait_irq
13 #include "cmos.h" // inb_cmos
14 #include "pic.h" // eoi_pic1
15 #include "bregs.h" // struct bregs
16 #include "boot.h" // boot_add_floppy
17 #include "pci.h" // pci_to_bdf
18 #include "pci_ids.h" // PCI_CLASS_BRIDGE_ISA
20 #define FLOPPY_SIZE_CODE 0x02 // 512 byte sectors
21 #define FLOPPY_DATALEN 0xff // Not used - because size code is 0x02
22 #define FLOPPY_MOTOR_TICKS 37 // ~2 seconds
23 #define FLOPPY_FILLBYTE 0xf6
24 #define FLOPPY_GAPLEN 0x1B
25 #define FLOPPY_FORMAT_GAPLEN 0x6c
27 // New diskette parameter table adding 3 parameters from IBM
28 // Since no provisions are made for multiple drive types, most
29 // values in this table are ignored. I set parameters for 1.44M
31 struct floppy_ext_dbt_s diskette_param_table2 VAR16VISIBLE = {
33 .specify1 = 0xAF, // step rate 12ms, head unload 240ms
34 .specify2 = 0x02, // head load time 4ms, DMA used
35 .shutoff_ticks = FLOPPY_MOTOR_TICKS, // ~2 seconds
36 .bps_code = FLOPPY_SIZE_CODE,
38 .interblock_len = FLOPPY_GAPLEN,
39 .data_len = FLOPPY_DATALEN,
40 .gap_len = FLOPPY_FORMAT_GAPLEN,
41 .fill_byte = FLOPPY_FILLBYTE,
42 .settle_time = 0x0F, // 15ms
43 .startup_time = 0x08, // 1 second
45 .max_track = 79, // maximum track
46 .data_rate = 0, // data transfer rate
47 .drive_type = 4, // drive type in cmos
50 // Since no provisions are made for multiple drive types, most
51 // values in this table are ignored. I set parameters for 1.44M
53 struct floppy_dbt_s diskette_param_table VAR16FIXED(0xefc7) = {
56 .shutoff_ticks = FLOPPY_MOTOR_TICKS,
57 .bps_code = FLOPPY_SIZE_CODE,
59 .interblock_len = FLOPPY_GAPLEN,
60 .data_len = FLOPPY_DATALEN,
61 .gap_len = FLOPPY_FORMAT_GAPLEN,
62 .fill_byte = FLOPPY_FILLBYTE,
73 struct floppyinfo_s FloppyInfo[] VAR16VISIBLE = {
75 { {0, 0, 0}, 0x00, 0x00},
76 // 1 - 360KB, 5.25" - 2 heads, 40 tracks, 9 sectors
77 { {2, 40, 9}, 0x00, 0x25},
78 // 2 - 1.2MB, 5.25" - 2 heads, 80 tracks, 15 sectors
79 { {2, 80, 15}, 0x00, 0x25},
80 // 3 - 720KB, 3.5" - 2 heads, 80 tracks, 9 sectors
81 { {2, 80, 9}, 0x00, 0x17},
82 // 4 - 1.44MB, 3.5" - 2 heads, 80 tracks, 18 sectors
83 { {2, 80, 18}, 0x00, 0x17},
84 // 5 - 2.88MB, 3.5" - 2 heads, 80 tracks, 36 sectors
85 { {2, 80, 36}, 0xCC, 0xD7},
86 // 6 - 160k, 5.25" - 1 heads, 40 tracks, 8 sectors
87 { {1, 40, 8}, 0x00, 0x27},
88 // 7 - 180k, 5.25" - 1 heads, 40 tracks, 9 sectors
89 { {1, 40, 9}, 0x00, 0x27},
90 // 8 - 320k, 5.25" - 2 heads, 40 tracks, 8 sectors
91 { {2, 40, 8}, 0x00, 0x27},
95 init_floppy(int floppyid, int ftype)
97 if (ftype <= 0 || ftype >= ARRAY_SIZE(FloppyInfo)) {
98 dprintf(1, "Bad floppy type %d\n", ftype);
102 struct drive_s *drive_g = malloc_fseg(sizeof(*drive_g));
107 memset(drive_g, 0, sizeof(*drive_g));
108 drive_g->cntl_id = floppyid;
109 drive_g->type = DTYPE_FLOPPY;
110 drive_g->blksize = DISK_SECTOR_SIZE;
111 drive_g->floppy_type = ftype;
112 drive_g->sectors = (u64)-1;
114 memcpy(&drive_g->lchs, &FloppyInfo[ftype].chs
115 , sizeof(FloppyInfo[ftype].chs));
120 addFloppy(int floppyid, int ftype)
122 struct drive_s *drive_g = init_floppy(floppyid, ftype);
125 char *desc = znprintf(MAXDESCSIZE, "Floppy [drive %c]", 'A' + floppyid);
126 struct pci_device *pci = pci_find_class(PCI_CLASS_BRIDGE_ISA); /* isa-to-pci bridge */
127 int prio = bootprio_find_fdc_device(pci, PORT_FD_BASE, floppyid);
128 boot_add_floppy(drive_g, desc, prio);
136 dprintf(3, "init floppy drives\n");
138 if (CONFIG_COREBOOT) {
139 // XXX - disable floppies on coreboot for now.
141 u8 type = inb_cmos(CMOS_FLOPPY_DRIVE_TYPE);
143 addFloppy(0, type >> 4);
145 addFloppy(1, type & 0x0f);
148 outb(0x02, PORT_DMA1_MASK_REG);
150 enable_hwirq(6, FUNC16(entry_0e));
153 // Find a floppy type that matches a given image size.
155 find_floppy_type(u32 size)
158 for (i=1; i<ARRAY_SIZE(FloppyInfo); i++) {
159 struct chs_s *c = &FloppyInfo[i].chs;
160 if (c->cylinders * c->heads * c->spt * DISK_SECTOR_SIZE == size)
167 /****************************************************************
168 * Low-level floppy IO
169 ****************************************************************/
172 floppy_reset_controller(void)
175 u8 val8 = inb(PORT_FD_DOR);
176 outb(val8 & ~0x04, PORT_FD_DOR);
177 outb(val8 | 0x04, PORT_FD_DOR);
179 // Wait for controller to come out of reset
180 while ((inb(PORT_FD_STATUS) & 0xc0) != 0x80)
185 wait_floppy_irq(void)
190 if (!GET_BDA(floppy_motor_counter))
192 v = GET_BDA(floppy_recalibration_status);
195 // Could use wait_irq() here, but that causes issues on
196 // bochs, so use yield() instead.
201 SET_BDA(floppy_recalibration_status, v);
206 floppy_prepare_controller(u8 floppyid)
208 CLEARBITS_BDA(floppy_recalibration_status, FRS_TIMEOUT);
210 // turn on motor of selected drive, DMA & int enabled, normal operation
211 u8 prev_reset = inb(PORT_FD_DOR) & 0x04;
217 outb(dor, PORT_FD_DOR);
219 // reset the disk motor timeout value of INT 08
220 SET_BDA(floppy_motor_counter, FLOPPY_MOTOR_TICKS);
222 // wait for drive readiness
223 while ((inb(PORT_FD_STATUS) & 0xc0) != 0x80)
231 floppy_pio(u8 *cmd, u8 cmdlen)
233 floppy_prepare_controller(cmd[1] & 1);
235 // send command to controller
237 for (i=0; i<cmdlen; i++)
238 outb(cmd[i], PORT_FD_DATA);
240 int ret = wait_floppy_irq();
242 floppy_reset_controller();
250 floppy_cmd(struct disk_op_s *op, u16 count, u8 *cmd, u8 cmdlen)
252 // es:bx = pointer to where to place information from diskette
253 u32 addr = (u32)op->buf_fl;
255 // check for 64K boundary overrun
257 u32 last_addr = addr + end;
258 if ((addr >> 16) != (last_addr >> 16))
259 return DISK_RET_EBOUNDARY;
261 u8 mode_register = 0x4a; // single mode, increment, autoinit disable,
264 mode_register = 0x46;
266 //DEBUGF("floppy dma c2\n");
267 outb(0x06, PORT_DMA1_MASK_REG);
268 outb(0x00, PORT_DMA1_CLEAR_FF_REG); // clear flip-flop
269 outb(addr, PORT_DMA_ADDR_2);
270 outb(addr>>8, PORT_DMA_ADDR_2);
271 outb(0x00, PORT_DMA1_CLEAR_FF_REG); // clear flip-flop
272 outb(end, PORT_DMA_CNT_2);
273 outb(end>>8, PORT_DMA_CNT_2);
275 // port 0b: DMA-1 Mode Register
276 // transfer type=write, channel 2
277 outb(mode_register, PORT_DMA1_MODE_REG);
279 // port 81: DMA-1 Page Register, channel 2
280 outb(addr>>16, PORT_DMA_PAGE_2);
282 outb(0x02, PORT_DMA1_MASK_REG); // unmask channel 2
284 int ret = floppy_pio(cmd, cmdlen);
286 return DISK_RET_ETIMEOUT;
288 // check port 3f4 for accessibility to status bytes
289 if ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0)
290 return DISK_RET_ECONTROLLER;
292 // read 7 return status bytes from controller
294 for (i=0; i<7; i++) {
295 u8 v = inb(PORT_FD_DATA);
297 SET_BDA(floppy_return_status[i], v);
300 return DISK_RET_SUCCESS;
304 /****************************************************************
306 ****************************************************************/
309 set_diskette_current_cyl(u8 floppyid, u8 cyl)
311 SET_BDA(floppy_track[floppyid], cyl);
315 floppy_drive_recal(u8 floppyid)
317 // send Recalibrate command (2 bytes) to controller
319 data[0] = 0x07; // 07: Recalibrate
320 data[1] = floppyid; // 0=drive0, 1=drive1
323 SETBITS_BDA(floppy_recalibration_status, 1<<floppyid);
324 set_diskette_current_cyl(floppyid, 0);
328 floppy_media_sense(struct drive_s *drive_g)
330 // for now cheat and get drive type from CMOS,
331 // assume media is same as drive type
334 // Bitfields for diskette media control:
335 // Bit(s) Description (Table M0028)
336 // 7-6 last data rate set by controller
337 // 00=500kbps, 01=300kbps, 10=250kbps, 11=1Mbps
338 // 5-4 last diskette drive step rate selected
339 // 00=0Ch, 01=0Dh, 10=0Eh, 11=0Ah
340 // 3-2 {data rate at start of operation}
344 // Bitfields for diskette drive media state:
345 // Bit(s) Description (Table M0030)
347 // 00=500kbps, 01=300kbps, 10=250kbps, 11=1Mbps
348 // 5 double stepping required (e.g. 360kB in 1.2MB)
349 // 4 media type established
350 // 3 drive capable of supporting 4MB media
351 // 2-0 on exit from BIOS, contains
352 // 000 trying 360kB in 360kB
353 // 001 trying 360kB in 1.2MB
354 // 010 trying 1.2MB in 1.2MB
355 // 011 360kB in 360kB established
356 // 100 360kB in 1.2MB established
357 // 101 1.2MB in 1.2MB established
359 // 111 all other formats/drives
361 u8 ftype = GET_GLOBAL(drive_g->floppy_type);
362 SET_BDA(floppy_last_data_rate, GET_GLOBAL(FloppyInfo[ftype].config_data));
363 u8 floppyid = GET_GLOBAL(drive_g->cntl_id);
364 SET_BDA(floppy_media_state[floppyid]
365 , GET_GLOBAL(FloppyInfo[ftype].media_state));
366 return DISK_RET_SUCCESS;
370 check_recal_drive(struct drive_s *drive_g)
372 u8 floppyid = GET_GLOBAL(drive_g->cntl_id);
373 if ((GET_BDA(floppy_recalibration_status) & (1<<floppyid))
374 && (GET_BDA(floppy_media_state[floppyid]) & FMS_MEDIA_DRIVE_ESTABLISHED))
376 return DISK_RET_SUCCESS;
378 // Recalibrate drive.
379 floppy_drive_recal(floppyid);
382 return floppy_media_sense(drive_g);
386 /****************************************************************
388 ****************************************************************/
391 lba2chs(struct disk_op_s *op, u8 *track, u8 *sector, u8 *head)
396 u16 nlspt = GET_GLOBAL(op->drive_g->lchs.spt);
397 *sector = tmp % nlspt;
400 u16 nlh = GET_GLOBAL(op->drive_g->lchs.heads);
407 // diskette controller reset
409 floppy_reset(struct disk_op_s *op)
411 u8 floppyid = GET_GLOBAL(op->drive_g->cntl_id);
412 set_diskette_current_cyl(floppyid, 0); // current cylinder
413 return DISK_RET_SUCCESS;
416 // Read Diskette Sectors
418 floppy_read(struct disk_op_s *op)
420 int res = check_recal_drive(op->drive_g);
424 u8 track, sector, head;
425 lba2chs(op, &track, §or, &head);
427 // send read-normal-data command (9 bytes) to controller
428 u8 floppyid = GET_GLOBAL(op->drive_g->cntl_id);
430 data[0] = 0xe6; // e6: read normal data
431 data[1] = (head << 2) | floppyid; // HD DR1 DR2
435 data[5] = FLOPPY_SIZE_CODE;
436 data[6] = sector + op->count - 1; // last sector to read on track
437 data[7] = FLOPPY_GAPLEN;
438 data[8] = FLOPPY_DATALEN;
440 res = floppy_cmd(op, op->count * DISK_SECTOR_SIZE, data, 9);
444 if (data[0] & 0xc0) {
445 res = DISK_RET_ECONTROLLER;
449 // ??? should track be new val from return_status[3] ?
450 set_diskette_current_cyl(floppyid, track);
451 return DISK_RET_SUCCESS;
453 op->count = 0; // no sectors read
457 // Write Diskette Sectors
459 floppy_write(struct disk_op_s *op)
461 int res = check_recal_drive(op->drive_g);
465 u8 track, sector, head;
466 lba2chs(op, &track, §or, &head);
468 // send write-normal-data command (9 bytes) to controller
469 u8 floppyid = GET_GLOBAL(op->drive_g->cntl_id);
471 data[0] = 0xc5; // c5: write normal data
472 data[1] = (head << 2) | floppyid; // HD DR1 DR2
476 data[5] = FLOPPY_SIZE_CODE;
477 data[6] = sector + op->count - 1; // last sector to write on track
478 data[7] = FLOPPY_GAPLEN;
479 data[8] = FLOPPY_DATALEN;
481 res = floppy_cmd(op, op->count * DISK_SECTOR_SIZE, data, 9);
485 if (data[0] & 0xc0) {
487 res = DISK_RET_EWRITEPROTECT;
489 res = DISK_RET_ECONTROLLER;
493 // ??? should track be new val from return_status[3] ?
494 set_diskette_current_cyl(floppyid, track);
495 return DISK_RET_SUCCESS;
497 op->count = 0; // no sectors read
501 // Verify Diskette Sectors
503 floppy_verify(struct disk_op_s *op)
505 int res = check_recal_drive(op->drive_g);
509 u8 track, sector, head;
510 lba2chs(op, &track, §or, &head);
512 // ??? should track be new val from return_status[3] ?
513 u8 floppyid = GET_GLOBAL(op->drive_g->cntl_id);
514 set_diskette_current_cyl(floppyid, track);
515 return DISK_RET_SUCCESS;
517 op->count = 0; // no sectors read
521 // format diskette track
523 floppy_format(struct disk_op_s *op)
525 int ret = check_recal_drive(op->drive_g);
531 // send format-track command (6 bytes) to controller
532 u8 floppyid = GET_GLOBAL(op->drive_g->cntl_id);
534 data[0] = 0x4d; // 4d: format track
535 data[1] = (head << 2) | floppyid; // HD DR1 DR2
536 data[2] = FLOPPY_SIZE_CODE;
537 data[3] = op->count; // number of sectors per track
538 data[4] = FLOPPY_FORMAT_GAPLEN;
539 data[5] = FLOPPY_FILLBYTE;
541 ret = floppy_cmd(op, op->count * 4, data, 6);
545 if (data[0] & 0xc0) {
547 return DISK_RET_EWRITEPROTECT;
548 return DISK_RET_ECONTROLLER;
551 set_diskette_current_cyl(floppyid, 0);
552 return DISK_RET_SUCCESS;
556 process_floppy_op(struct disk_op_s *op)
561 switch (op->command) {
563 return floppy_reset(op);
565 return floppy_read(op);
567 return floppy_write(op);
569 return floppy_verify(op);
571 return floppy_format(op);
574 return DISK_RET_EPARAM;
579 /****************************************************************
581 ****************************************************************/
583 // INT 0Eh Diskette Hardware ISR Entry Point
587 debug_isr(DEBUG_ISR_0e);
591 if ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0) {
592 outb(0x08, PORT_FD_DATA); // sense interrupt status
593 while ((inb(PORT_FD_STATUS) & 0xc0) != 0xc0)
597 } while ((inb(PORT_FD_STATUS) & 0xc0) == 0xc0);
599 // diskette interrupt has occurred
600 SETBITS_BDA(floppy_recalibration_status, FRS_TIMEOUT);
606 // Called from int08 handler.
613 // time to turn off drive(s)?
614 u8 fcount = GET_BDA(floppy_motor_counter);
617 SET_BDA(floppy_motor_counter, fcount);
620 outb(inb(PORT_FD_DOR) & 0xcf, PORT_FD_DOR);