src/disk.h

   1 // Definitions for X86 bios disks.
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 //
   5 // This file may be distributed under the terms of the GNU LGPLv3 license.
   6 #ifndef __DISK_H
   7 #define __DISK_H
   8
   9 #include "types.h" // u8
  10 #include "config.h" // CONFIG_*
  11
  12 #define DISK_RET_SUCCESS       0x00
  13 #define DISK_RET_EPARAM        0x01
  14 #define DISK_RET_EADDRNOTFOUND 0x02
  15 #define DISK_RET_EWRITEPROTECT 0x03
  16 #define DISK_RET_ECHANGED      0x06
  17 #define DISK_RET_EBOUNDARY     0x09
  18 #define DISK_RET_EBADTRACK     0x0c
  19 #define DISK_RET_ECONTROLLER   0x20
  20 #define DISK_RET_ETIMEOUT      0x80
  21 #define DISK_RET_ENOTLOCKED    0xb0
  22 #define DISK_RET_ELOCKED       0xb1
  23 #define DISK_RET_ENOTREMOVABLE 0xb2
  24 #define DISK_RET_ETOOMANYLOCKS 0xb4
  25 #define DISK_RET_EMEDIA        0xC0
  26 #define DISK_RET_ENOTREADY     0xAA
  27
  28
  29 /****************************************************************
  30  * Interface structs
  31  ****************************************************************/
  32
  33 // Bios disk structures.
  34 struct int13ext_s {
  35     u8  size;
  36     u8  reserved;
  37     u16 count;
  38     u16 offset;
  39     u16 segment;
  40     u64 lba;
  41 } PACKED;
  42
  43 #define GET_INT13EXT(regs,var)                                          \
  44     GET_FARVAR((regs)->ds, ((struct int13ext_s*)((regs)->si+0))->var)
  45 #define SET_INT13EXT(regs,var,val)                                      \
  46     SET_FARVAR((regs)->ds, ((struct int13ext_s*)((regs)->si+0))->var, (val))
  47
  48 // Disk Physical Table definition
  49 struct int13dpt_s {
  50     u16 size;
  51     u16 infos;
  52     u32 cylinders;
  53     u32 heads;
  54     u32 spt;
  55     u64 sector_count;
  56     u16 blksize;
  57     u16 dpte_offset;
  58     u16 dpte_segment;
  59     u16 key;
  60     u8  dpi_length;
  61     u8  reserved1;
  62     u16 reserved2;
  63     u8  host_bus[4];
  64     u8  iface_type[8];
  65     u64 iface_path;
  66     u64 device_path;
  67     u8  reserved3;
  68     u8  checksum;
  69 } PACKED;
  70
  71 #define GET_INT13DPT(regs,var)                                          \
  72     GET_FARVAR((regs)->ds, ((struct int13dpt_s*)((regs)->si+0))->var)
  73 #define SET_INT13DPT(regs,var,val)                                      \
  74     SET_FARVAR((regs)->ds, ((struct int13dpt_s*)((regs)->si+0))->var, (val))
  75
  76 // Floppy "Disk Base Table"
  77 struct floppy_dbt_s {
  78     u8 specify1;
  79     u8 specify2;
  80     u8 shutoff_ticks;
  81     u8 bps_code;
  82     u8 sectors;
  83     u8 interblock_len;
  84     u8 data_len;
  85     u8 gap_len;
  86     u8 fill_byte;
  87     u8 settle_time;
  88     u8 startup_time;
  89 } PACKED;
  90
  91 struct floppy_ext_dbt_s {
  92     struct floppy_dbt_s dbt;
  93     // Extra fields
  94     u8 max_track;
  95     u8 data_rate;
  96     u8 drive_type;
  97 } PACKED;
  98
  99 // Helper function for setting up a return code.
 100 struct bregs;
 101 void __disk_ret(struct bregs *regs, u32 linecode, const char *fname);
 102 #define disk_ret(regs, code) \
 103     __disk_ret((regs), (code) | (__LINE__ << 8), __func__)
 104
 105
 106 /****************************************************************
 107  * Disk command request
 108  ****************************************************************/
 109
 110 struct disk_op_s {
 111     u64 lba;
 112     void *far_buffer;
 113     u16 count;
 114     u8 driveid;
 115     u8 command;
 116 };
 117
 118 #define CMD_CDROM_READ 1
 119 #define CMD_CDEMU_READ 2
 120
 121
 122 /****************************************************************
 123  * Global storage
 124  ****************************************************************/
 125
 126 struct chs_s {
 127     u16 heads;      // # heads
 128     u16 cylinders;  // # cylinders
 129     u16 spt;        // # sectors / track
 130 };
 131
 132 struct ata_channel_s {
 133     u16 iobase1;      // IO Base 1
 134     u16 iobase2;      // IO Base 2
 135     u16 pci_bdf;
 136     u8  irq;          // IRQ
 137 };
 138
 139 struct ata_device_s {
 140     u8  type;         // Detected type of ata (ata/atapi/none/unknown)
 141     u8  device;       // Detected type of attached devices (hd/cd/none)
 142     u8  removable;    // Removable device flag
 143     u8  mode;         // transfer mode : PIO 16/32 bits - IRQ - ISADMA - PCIDMA
 144     u16 blksize;      // block size
 145
 146     u8  translation;  // type of translation
 147     struct chs_s  lchs;         // Logical CHS
 148     struct chs_s  pchs;         // Physical CHS
 149
 150     u64 sectors;      // Total sectors count
 151 };
 152
 153 struct ata_s {
 154     // ATA channels info
 155     struct ata_channel_s channels[CONFIG_MAX_ATA_INTERFACES];
 156
 157     // ATA devices info
 158     struct ata_device_s  devices[CONFIG_MAX_ATA_DEVICES];
 159     //
 160     // map between bios hd/cd id and ata channels
 161     u8 cdcount;
 162     u8 idmap[2][CONFIG_MAX_ATA_DEVICES];
 163 };
 164
 165
 166 /****************************************************************
 167  * Function defs
 168  ****************************************************************/
 169
 170 // ata.c
 171 extern struct ata_s ATA;
 172 int ata_cmd_data(struct disk_op_s *op);
 173 int cdrom_read(struct disk_op_s *op);
 174 int cdrom_read_512(struct disk_op_s *op);
 175 int ata_cmd_packet(int driveid, u8 *cmdbuf, u8 cmdlen
 176                    , u32 length, void *far_buffer);
 177 void ata_reset(int driveid);
 178 void hard_drive_setup();
 179
 180 // floppy.c
 181 extern struct floppy_ext_dbt_s diskette_param_table2;
 182 void floppy_drive_setup();
 183 void floppy_13(struct bregs *regs, u8 drive);
 184 void floppy_tick();
 185
 186 // disk.c
 187 void disk_13(struct bregs *regs, u8 device);
 188 void disk_13XX(struct bregs *regs, u8 device);
 189
 190 // cdrom.c
 191 void cdrom_13(struct bregs *regs, u8 device);
 192 void cdemu_13(struct bregs *regs);
 193 void cdemu_134b(struct bregs *regs);
 194 int cdrom_boot();
 195
 196 #endif // disk.h