src/biosvar.h

   1 // Variable layouts of bios.
   2 //
   3 // Copyright (C) 2008,2009  Kevin O'Connor <kevin@koconnor.net>
   4 //
   5 // This file may be distributed under the terms of the GNU LGPLv3 license.
   6 #ifndef __BIOSVAR_H
   7 #define __BIOSVAR_H
   8
   9 #include "types.h" // u8
  10 #include "farptr.h" // GET_FARVAR
  11 #include "config.h" // CONFIG_*
  12 #include "disk.h" // struct chs_s
  13
  14
  15 /****************************************************************
  16  * Interupt vector table
  17  ****************************************************************/
  18
  19 struct rmode_IVT {
  20     struct segoff_s ivec[256];
  21 };
  22
  23 #define GET_IVT(vector)                                         \
  24     GET_FARVAR(SEG_IVT, ((struct rmode_IVT *)0)->ivec[vector])
  25 #define SET_IVT(vector, segoff)                                         \
  26     SET_FARVAR(SEG_IVT, ((struct rmode_IVT *)0)->ivec[vector], segoff)
  27
  28
  29 /****************************************************************
  30  * Bios Data Area (BDA)
  31  ****************************************************************/
  32
  33 struct bios_data_area_s {
  34     // 40:00
  35     u16 port_com[4];
  36     u16 port_lpt[3];
  37     u16 ebda_seg;
  38     // 40:10
  39     u16 equipment_list_flags;
  40     u8 pad1;
  41     u16 mem_size_kb;
  42     u8 pad2;
  43     u8 ps2_ctrl_flag;
  44     u8 kbd_flag0;
  45     u8 kbd_flag1;
  46     u8 alt_keypad;
  47     u16 kbd_buf_head;
  48     u16 kbd_buf_tail;
  49     // 40:1e
  50     u8 kbd_buf[32];
  51     u8 floppy_recalibration_status;
  52     u8 floppy_motor_status;
  53     // 40:40
  54     u8 floppy_motor_counter;
  55     u8 floppy_last_status;
  56     u8 floppy_return_status[7];
  57     u8 video_mode;
  58     u16 video_cols;
  59     u16 video_pagesize;
  60     u16 video_pagestart;
  61     // 40:50
  62     u16 cursor_pos[8];
  63     // 40:60
  64     u16 cursor_type;
  65     u8 video_page;
  66     u16 crtc_address;
  67     u8 video_msr;
  68     u8 video_pal;
  69     struct segoff_s jump;
  70     u8 other_6b;
  71     u32 timer_counter;
  72     // 40:70
  73     u8 timer_rollover;
  74     u8 break_flag;
  75     u16 soft_reset_flag;
  76     u8 disk_last_status;
  77     u8 hdcount;
  78     u8 disk_control_byte;
  79     u8 port_disk;
  80     u8 lpt_timeout[4];
  81     u8 com_timeout[4];
  82     // 40:80
  83     u16 kbd_buf_start_offset;
  84     u16 kbd_buf_end_offset;
  85     u8 video_rows;
  86     u16 char_height;
  87     u8 video_ctl;
  88     u8 video_switches;
  89     u8 modeset_ctl;
  90     u8 dcc_index;
  91     u8 floppy_last_data_rate;
  92     u8 disk_status_controller;
  93     u8 disk_error_controller;
  94     u8 disk_interrupt_flag;
  95     u8 floppy_harddisk_info;
  96     // 40:90
  97     u8 floppy_media_state[4];
  98     u8 floppy_track[2];
  99     u8 kbd_flag2;
 100     u8 kbd_flag3;
 101     struct segoff_s user_wait_complete_flag;
 102     u32 user_wait_timeout;
 103     // 40:A0
 104     u8 rtc_wait_flag;
 105     u8 other_a1[7];
 106     struct segoff_s video_savetable;
 107     u8 other_ac[4];
 108     // 40:B0
 109     u8 other_b0[10];
 110     u16 vbe_mode;
 111 } PACKED;
 112
 113 // BDA floppy_recalibration_status bitdefs
 114 #define FRS_TIMEOUT (1<<7)
 115
 116 // BDA rtc_wait_flag bitdefs
 117 #define RWS_WAIT_PENDING (1<<0)
 118 #define RWS_WAIT_ELAPSED (1<<7)
 119
 120 // BDA floppy_media_state bitdefs
 121 #define FMS_DRIVE_STATE_MASK        (0x07)
 122 #define FMS_MEDIA_DRIVE_ESTABLISHED (1<<4)
 123 #define FMS_DOUBLE_STEPPING         (1<<5)
 124 #define FMS_DATA_RATE_MASK          (0xc0)
 125
 126 // Bit definitions for kbd_flag[0123]
 127 #define KF0_RSHIFT       (1<<0)
 128 #define KF0_LSHIFT       (1<<1)
 129 #define KF0_CTRLACTIVE   (1<<2)
 130 #define KF0_ALTACTIVE    (1<<3)
 131 #define KF0_SCROLLACTIVE (1<<4)
 132 #define KF0_NUMACTIVE    (1<<5)
 133 #define KF0_CAPSACTIVE   (1<<6)
 134
 135 #define KF1_LCTRL        (1<<0)
 136 #define KF1_LALT         (1<<1)
 137 #define KF1_PAUSEACTIVE  (1<<3)
 138 #define KF1_SCROLL       (1<<4)
 139 #define KF1_NUM          (1<<5)
 140 #define KF1_CAPS         (1<<6)
 141
 142 #define KF2_LAST_E1    (1<<0)
 143 #define KF2_LAST_E0    (1<<1)
 144 #define KF2_RCTRL      (1<<2)
 145 #define KF2_RALT       (1<<3)
 146 #define KF2_101KBD     (1<<4)
 147
 148 #define KF3_SCROLL_LED  (1<<0)
 149 #define KF3_NUM_LED     (1<<1)
 150 #define KF3_CAPS_LED    (1<<2)
 151 #define KF3_CMD_PENDING (1<<6)
 152
 153 // Accessor functions
 154 #define GET_BDA(var) \
 155     GET_FARVAR(SEG_BDA, ((struct bios_data_area_s *)0)->var)
 156 #define SET_BDA(var, val) \
 157     SET_FARVAR(SEG_BDA, ((struct bios_data_area_s *)0)->var, (val))
 158 #define CLEARBITS_BDA(var, val) do {                                    \
 159         typeof(((struct bios_data_area_s *)0)->var) __val = GET_BDA(var); \
 160         SET_BDA(var, (__val & ~(val)));                                 \
 161     } while (0)
 162 #define SETBITS_BDA(var, val) do {                                      \
 163         typeof(((struct bios_data_area_s *)0)->var) __val = GET_BDA(var); \
 164         SET_BDA(var, (__val | (val)));                                  \
 165     } while (0)
 166
 167
 168 /****************************************************************
 169  * Extended Bios Data Area (EBDA)
 170  ****************************************************************/
 171
 172 // DPTE definition
 173 struct dpte_s {
 174     u16 iobase1;
 175     u16 iobase2;
 176     u8  prefix;
 177     u8  unused;
 178     u8  irq;
 179     u8  blkcount;
 180     u8  dma;
 181     u8  pio;
 182     u16 options;
 183     u16 reserved;
 184     u8  revision;
 185     u8  checksum;
 186 };
 187
 188 // ElTorito Device Emulation data
 189 struct cdemu_s {
 190     struct drive_s *emulated_drive;
 191     u32 ilba;
 192     u16 buffer_segment;
 193     u16 load_segment;
 194     u16 sector_count;
 195     u8  active;
 196     u8  media;
 197     u8  emulated_extdrive;
 198
 199     // Virtual device
 200     struct chs_s lchs;
 201 };
 202
 203 struct fdpt_s {
 204     u16 cylinders;
 205     u8 heads;
 206     u8 a0h_signature;
 207     u8 phys_sectors;
 208     u16 precompensation;
 209     u8 reserved;
 210     u8 drive_control_byte;
 211     u16 phys_cylinders;
 212     u8 phys_heads;
 213     u16 landing_zone;
 214     u8 sectors;
 215     u8 checksum;
 216 } PACKED;
 217
 218 struct usbkeyinfo {
 219     union {
 220         struct {
 221             u8 modifiers;
 222             u8 repeatcount;
 223             u8 keys[6];
 224         };
 225         u64 data;
 226     };
 227 };
 228
 229 struct extended_bios_data_area_s {
 230     u8 size;
 231     u8 reserved1[0x21];
 232     struct segoff_s far_call_pointer;
 233     u8 mouse_flag1;
 234     u8 mouse_flag2;
 235     u8 mouse_data[0x08];
 236     // 0x30
 237     u8 other1[0x0d];
 238
 239     // 0x3d
 240     struct fdpt_s fdpt[2];
 241
 242     // 0x5d
 243     u8 other2[0xC4];
 244
 245     // 0x121 - Begin custom storage.
 246     struct usbkeyinfo usbkey_last;
 247
 248     int RTCusers;
 249
 250     // El Torito Emulation data
 251     struct cdemu_s cdemu;
 252
 253     // Buffer for disk DPTE table
 254     struct dpte_s dpte;
 255
 256     // Locks for removable devices
 257     u8 cdrom_locks[CONFIG_MAX_EXTDRIVE];
 258
 259     u16 boot_sequence;
 260
 261     // Stack space available for code that needs it.
 262     u8 extra_stack[512] __aligned(8);
 263
 264     u8 cdemu_buf[2048 * !!CONFIG_CDROM_EMU];
 265 } PACKED;
 266
 267 // The initial size and location of EBDA
 268 #define EBDA_SIZE_START \
 269     DIV_ROUND_UP(sizeof(struct extended_bios_data_area_s), 1024)
 270 #define EBDA_SEGMENT_START \
 271     FLATPTR_TO_SEG(BUILD_LOWRAM_END - EBDA_SIZE_START*1024)
 272
 273 // Accessor functions
 274 static inline u16 get_ebda_seg(void) {
 275     return GET_BDA(ebda_seg);
 276 }
 277 static inline struct extended_bios_data_area_s *
 278 get_ebda_ptr(void)
 279 {
 280     ASSERT32FLAT();
 281     return MAKE_FLATPTR(get_ebda_seg(), 0);
 282 }
 283 #define GET_EBDA2(eseg, var)                                            \
 284     GET_FARVAR(eseg, ((struct extended_bios_data_area_s *)0)->var)
 285 #define SET_EBDA2(eseg, var, val)                                       \
 286     SET_FARVAR(eseg, ((struct extended_bios_data_area_s *)0)->var, (val))
 287 #define GET_EBDA(var)                           \
 288     GET_EBDA2(get_ebda_seg(), var)
 289 #define SET_EBDA(var, val)                      \
 290     SET_EBDA2(get_ebda_seg(), var, (val))
 291
 292 #define EBDA_OFFSET_TOP_STACK                                   \
 293     offsetof(struct extended_bios_data_area_s, extra_stack[     \
 294                  FIELD_SIZEOF(struct extended_bios_data_area_s  \
 295                               , extra_stack)])
 296
 297
 298 /****************************************************************
 299  * Global variables
 300  ****************************************************************/
 301
 302 #if MODE16 == 0 && MODESEGMENT == 1
 303 // In 32bit segmented mode %cs may not be readable and the code may be
 304 // relocated.  The entry code sets up %gs with a readable segment and
 305 // the code offset can be determined by get_global_offset().
 306 #define GLOBAL_SEGREG GS
 307 static inline u32 __attribute_const get_global_offset(void) {
 308     u32 ret;
 309     asm("  calll 1f\n"
 310         "1:popl %0\n"
 311         "  subl $1b, %0"
 312         : "=r"(ret));
 313     return ret;
 314 }
 315 #else
 316 #define GLOBAL_SEGREG CS
 317 static inline u32 __attribute_const get_global_offset(void) {
 318     return 0;
 319 }
 320 #endif
 321 static inline u16 get_global_seg(void) {
 322     return GET_SEG(GLOBAL_SEGREG);
 323 }
 324 #define GET_GLOBAL(var)                                                 \
 325     GET_VAR(GLOBAL_SEGREG, *(typeof(&(var)))((void*)&(var)              \
 326                                              + get_global_offset()))
 327 #define SET_GLOBAL(var, val) do {               \
 328         ASSERT32FLAT();                         \
 329         (var) = (val);                          \
 330     } while (0)
 331 #if MODESEGMENT
 332 #define ADJUST_GLOBAL_PTR(var) (var)
 333 #else
 334 #define ADJUST_GLOBAL_PTR(var) ((typeof(var))((void*)var - BUILD_BIOS_ADDR))
 335 #endif
 336
 337
 338 /****************************************************************
 339  * Bios Config Table
 340  ****************************************************************/
 341
 342 struct bios_config_table_s {
 343     u16 size;
 344     u8 model;
 345     u8 submodel;
 346     u8 biosrev;
 347     u8 feature1, feature2, feature3, feature4, feature5;
 348 } PACKED;
 349
 350 extern struct bios_config_table_s BIOS_CONFIG_TABLE __aligned(1);
 351
 352 #endif // __BIOSVAR_H