src/biosvar.h

   1 // Variable layouts of bios.
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 //
   5 // This file may be distributed under the terms of the GNU GPLv3 license.
   6 #ifndef __BIOSVAR_H
   7 #define __BIOSVAR_H
   8
   9 #include "types.h" // u8
  10 #include "farptr.h" // SET_SEG
  11 #include "config.h" // CONFIG_*
  12
  13
  14 /****************************************************************
  15  * Bios Data Area (BDA)
  16  ****************************************************************/
  17
  18 struct ivec {
  19     u16 offset;
  20     u16 seg;
  21 };
  22
  23 struct bios_data_area_s {
  24     // 00:00
  25     struct ivec ivecs[256];
  26     // 30:00
  27 //    u8 stack[256];
  28     // 40:00
  29     u16 port_com[4];
  30     u16 port_lpt[3];
  31     u16 ebda_seg;
  32     // 40:10
  33     u16 equipment_list_flags;
  34     u8 pad1;
  35     u16 mem_size_kb;
  36     u8 pad2;
  37     u8 ps2_ctrl_flag;
  38     u8 kbd_flag0;
  39     u8 kbd_flag1;
  40     u8 alt_keypad;
  41     u16 kbd_buf_head;
  42     u16 kbd_buf_tail;
  43     // 40:1e
  44     u8 kbd_buf[32];
  45     u8 floppy_recalibration_status;
  46     u8 floppy_motor_status;
  47     // 40:40
  48     u8 floppy_motor_counter;
  49     u8 floppy_last_status;
  50     u8 floppy_return_status[7];
  51     u8 other1[0x7];
  52     // 40:50
  53     u8 other2[0x10];
  54     // 40:60
  55     u8 other3[0x7];
  56     u32 jump_cs_ip;
  57     u8 dummy;
  58     u32 timer_counter;
  59     // 40:70
  60     u8 timer_rollover;
  61     u8 break_flag;
  62     u16 soft_reset_flag;
  63     u8 disk_last_status;
  64     u8 disk_count;
  65     u8 disk_control_byte;
  66     u8 port_disk;
  67     u8 lpt_timeout[4];
  68     u8 com_timeout[4];
  69     // 40:80
  70     u16 kbd_buf_start_offset;
  71     u16 kbd_buf_end_offset;
  72     u8 other5[7];
  73     u8 floppy_last_data_rate;
  74     u8 disk_status_controller;
  75     u8 disk_error_controller;
  76     u8 disk_interrupt_flag;
  77     u8 floppy_harddisk_info;
  78     // 40:90
  79     u8 floppy_media_state[4];
  80     u8 floppy_track0;
  81     u8 floppy_track1;
  82     u8 kbd_mode;
  83     u8 kbd_led;
  84     u32 ptr_user_wait_complete_flag;
  85     u32 user_wait_timeout;
  86     // 40:A0
  87     u8 rtc_wait_flag;
  88 } PACKED;
  89
  90 // BDA floppy_recalibration_status bitdefs
  91 #define FRS_TIMEOUT (1<<7)
  92
  93 // BDA rtc_wait_flag bitdefs
  94 #define RWS_WAIT_PENDING (1<<0)
  95 #define RWS_WAIT_ELAPSED (1<<7)
  96
  97 // BDA floppy_media_state bitdefs
  98 #define FMS_DRIVE_STATE_MASK        (0x07)
  99 #define FMS_MEDIA_DRIVE_ESTABLISHED (1<<4)
 100 #define FMS_DOUBLE_STEPPING         (1<<5)
 101 #define FMS_DATA_RATE_MASK          (0xc0)
 102
 103 // Accessor functions
 104 #define GET_BDA(var) \
 105     GET_FARVAR(0x0000, ((struct bios_data_area_s *)0)->var)
 106 #define SET_BDA(var, val) \
 107     SET_FARVAR(0x0000, ((struct bios_data_area_s *)0)->var, (val))
 108 #define CLEARBITS_BDA(var, val) do {                                    \
 109         typeof(((struct bios_data_area_s *)0)->var) __val = GET_BDA(var); \
 110         SET_BDA(var, (__val & ~(val)));                                 \
 111     } while (0)
 112 #define SETBITS_BDA(var, val) do {                                      \
 113         typeof(((struct bios_data_area_s *)0)->var) __val = GET_BDA(var); \
 114         SET_BDA(var, (__val | (val)));                                  \
 115     } while (0)
 116
 117
 118 /****************************************************************
 119  * Hard drive info
 120  ****************************************************************/
 121
 122 struct fdpt_s {
 123     u16 cylinders;
 124     u8 heads;
 125     u8 a0h_signature;
 126     u8 phys_sectors;
 127     u16 precompensation;
 128     u8 reserved;
 129     u8 drive_control_byte;
 130     u16 phys_cylinders;
 131     u8 phys_heads;
 132     u16 landing_zone;
 133     u8 sectors;
 134     u8 checksum;
 135 } PACKED;
 136
 137 struct chs_s {
 138     u16 heads;      // # heads
 139     u16 cylinders;  // # cylinders
 140     u16 spt;        // # sectors / track
 141 };
 142
 143 // DPTE definition
 144 struct dpte_s {
 145     u16 iobase1;
 146     u16 iobase2;
 147     u8  prefix;
 148     u8  unused;
 149     u8  irq;
 150     u8  blkcount;
 151     u8  dma;
 152     u8  pio;
 153     u16 options;
 154     u16 reserved;
 155     u8  revision;
 156     u8  checksum;
 157 };
 158
 159 struct ata_channel_s {
 160     u8  iface;        // ISA or PCI
 161     u16 iobase1;      // IO Base 1
 162     u16 iobase2;      // IO Base 2
 163     u8  irq;          // IRQ
 164 } PACKED;
 165
 166 struct ata_device_s {
 167     u8  type;         // Detected type of ata (ata/atapi/none/unknown)
 168     u8  device;       // Detected type of attached devices (hd/cd/none)
 169     u8  removable;    // Removable device flag
 170     u8  lock;         // Locks for removable devices
 171     u8  mode;         // transfer mode : PIO 16/32 bits - IRQ - ISADMA - PCIDMA
 172     u16 blksize;      // block size
 173
 174     u8  translation;  // type of translation
 175     struct chs_s  lchs;         // Logical CHS
 176     struct chs_s  pchs;         // Physical CHS
 177
 178     u32 sectors;      // Total sectors count
 179 } PACKED;
 180
 181 struct ata_s {
 182     // ATA channels info
 183     struct ata_channel_s channels[CONFIG_MAX_ATA_INTERFACES];
 184
 185     // ATA devices info
 186     struct ata_device_s  devices[CONFIG_MAX_ATA_DEVICES];
 187     //
 188     // map between (bios hd id - 0x80) and ata channels
 189     u8  hdcount, hdidmap[CONFIG_MAX_ATA_DEVICES];
 190
 191     // map between (bios cd id - 0xE0) and ata channels
 192     u8  cdcount, cdidmap[CONFIG_MAX_ATA_DEVICES];
 193
 194     // Buffer for DPTE table
 195     struct dpte_s dpte;
 196
 197     // Count of transferred sectors and bytes
 198     u16 trsfsectors;
 199     u32 trsfbytes;
 200 } PACKED;
 201
 202 // ElTorito Device Emulation data
 203 struct cdemu_s {
 204     u8  active;
 205     u8  media;
 206     u8  emulated_drive;
 207     u8  controller_index;
 208     u16 device_spec;
 209     u32 ilba;
 210     u16 buffer_segment;
 211     u16 load_segment;
 212     u16 sector_count;
 213
 214     // Virtual device
 215     struct chs_s  vdevice;
 216 } PACKED;
 217
 218
 219 /****************************************************************
 220  * Extended Bios Data Area (EBDA)
 221  ****************************************************************/
 222
 223 struct extended_bios_data_area_s {
 224     u8 size;
 225     u8 reserved1[0x21];
 226     u32 far_call_pointer;
 227     u8 mouse_flag1;
 228     u8 mouse_flag2;
 229     u8 mouse_data[0x08];
 230     // 0x30
 231     u8 other1[0x0d];
 232
 233     // 0x3d
 234     struct fdpt_s fdpt0;
 235     struct fdpt_s fdpt1;
 236
 237     u8 other2[0xC4];
 238
 239     // ATA Driver data
 240     struct ata_s   ata;
 241
 242     // El Torito Emulation data
 243     struct cdemu_s cdemu;
 244 };
 245
 246 // Accessor functions
 247 #define GET_EBDA(var) \
 248     GET_FARVAR(EBDA_SEG, ((struct extended_bios_data_area_s *)0)->var)
 249 #define SET_EBDA(var, val) \
 250     SET_FARVAR(EBDA_SEG, ((struct extended_bios_data_area_s *)0)->var, (val))
 251
 252
 253 /****************************************************************
 254  * Initial Program Load (IPL)
 255  ****************************************************************/
 256
 257 // XXX - is this a standard, or just a bochs bios thing?
 258
 259 struct ipl_entry_s {
 260     u16 type;
 261     u16 flags;
 262     u32 vector;
 263     u32 description;
 264     u32 reserved;
 265 };
 266
 267 struct ipl_s {
 268     struct ipl_entry_s table[8];
 269     u16 count;
 270     u16 sequence;
 271     u8 pad[124];
 272 };
 273
 274 #define IPL_TYPE_FLOPPY      0x01
 275 #define IPL_TYPE_HARDDISK    0x02
 276 #define IPL_TYPE_CDROM       0x03
 277 #define IPL_TYPE_BEV         0x80
 278
 279 // Accessor functions
 280 #define GET_IPL(var) \
 281     GET_FARVAR(IPL_SEG, ((struct ipl_s *)0)->var)
 282 #define SET_IPL(var, val) \
 283     SET_FARVAR(IPL_SEG, ((struct ipl_s *)0)->var, (val))
 284
 285
 286 /****************************************************************
 287  * Registers saved/restored in romlayout.S
 288  ****************************************************************/
 289
 290 #define UREG(ER, R, RH, RL) union { u32 ER; struct { u16 R; u16 R ## _hi; }; struct { u8 RL; u8 RH; u8 R ## _hilo; u8 R ## _hihi; }; }
 291
 292 struct bregs {
 293     u16 ds;
 294     u16 es;
 295     UREG(edi, di, di_hi, di_lo);
 296     UREG(esi, si, si_hi, si_lo);
 297     UREG(ebp, bp, bp_hi, bp_lo);
 298     UREG(esp, sp, sp_hi, sp_lo);
 299     UREG(ebx, bx, bh, bl);
 300     UREG(edx, dx, dh, dl);
 301     UREG(ecx, cx, ch, cl);
 302     UREG(eax, ax, ah, al);
 303     u16 ip;
 304     u16 cs;
 305     u16 flags;
 306 } __attribute__((packed));
 307
 308 // bregs flags bitdefs
 309 #define F_ZF (1<<6)
 310 #define F_CF (1<<0)
 311
 312 static inline void
 313 set_cf(struct bregs *regs, int cond)
 314 {
 315     if (cond)
 316         regs->flags |= F_CF;
 317     else
 318         regs->flags &= ~F_CF;
 319 }
 320
 321
 322 /****************************************************************
 323  * Bios Config Table
 324  ****************************************************************/
 325
 326 struct bios_config_table_s {
 327     u16 size;
 328     u8 model;
 329     u8 submodel;
 330     u8 biosrev;
 331     u8 feature1, feature2, feature3, feature4, feature5;
 332 } PACKED;
 333
 334 extern struct bios_config_table_s BIOS_CONFIG_TABLE;
 335
 336
 337 /****************************************************************
 338  * Memory layout info
 339  ****************************************************************/
 340
 341 #define SEG_BIOS     0xf000
 342
 343 #define EBDA_SEG           0x9FC0
 344 #define IPL_SEG            0x9FF0
 345 #define EBDA_SIZE          1              // In KiB
 346 #define BASE_MEM_IN_K   (640 - EBDA_SIZE)
 347
 348 #endif // __BIOSVAR_H