source: xtideuniversalbios/trunk/XTIDE_Universal_BIOS/Inc/RomVars.inc @ 398

Last change on this file since 398 was 398, checked in by aitotat@…, 12 years ago

Changes to XTIDE Universal BIOS:

  • IRQ related stuff is now optional MODULE_IRQ.
  • XT builds no longer include support for IDE IRQ.
File size: 6.7 KB
Line 
1; Project name  :   XTIDE Universal BIOS
2; Description   :   Defines for ROMVARS struct containing variables stored
3;                   in BIOS ROM.
4
5;
6; XTIDE Universal BIOS and Associated Tools
7; Copyright (C) 2009-2010 by Tomi Tilli, 2011-2012 by XTIDE Universal BIOS Team.
8;
9; This program is free software; you can redistribute it and/or modify
10; it under the terms of the GNU General Public License as published by
11; the Free Software Foundation; either version 2 of the License, or
12; (at your option) any later version.
13;
14; This program is distributed in the hope that it will be useful,
15; but WITHOUT ANY WARRANTY; without even the implied warranty of
16; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17; GNU General Public License for more details.
18; Visit http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19;
20
21%ifndef ROMVARS_INC
22%define ROMVARS_INC
23
24; ROM Variables. Written to the ROM image before flashing.
25struc ROMVARS
26    .wRomSign           resb    2   ; ROM Signature (AA55h)
27    .bRomSize           resb    1   ; ROM size in 512 byte blocks
28    .rgbJump            resb    3   ; First instruction to ROM init (jmp)
29
30    .rgbSign            resb    8   ; Signature for XTIDE Configurator Program
31    .szTitle            resb    31  ; BIOS title string
32    .szVersion          resb    25  ; BIOS version string
33
34    .wFlags             resb    2   ; Word for ROM flags
35    .wDisplayMode       resb    2   ; Display mode for boot menu
36    .wfDisplayBootMenu:             ; Zero = no Boot Menu, non-zero = Boot Menu timeout
37    .wBootTimeout       resb    2   ; Boot Menu selection timeout in system timer ticks
38    .bIdeCnt            resb    1   ; Number of available IDE controllers
39    .bBootDrv           resb    1   ; Default drive to boot from
40    .bMinFddCnt         resb    1   ; Minimum number of Floppy Drives
41    .bStealSize         resb    1   ; Number of 1kB blocks stolen from 640kB base RAM
42    .bIdleTimeout       resb    1   ; Standby timer value
43
44    .ideVarsBegin:
45    .ideVars0           resb    IDEVARS_size
46    .ideVars1           resb    IDEVARS_size
47    .ideVars2           resb    IDEVARS_size
48    .ideVars3           resb    IDEVARS_size
49
50%ifdef MODULE_SERIAL
51    .ideVarsSerialAuto  resb    IDEVARS_size
52%endif
53
54    .ideVarsEnd:
55endstruc
56
57%ifndef CHECK_FOR_UNUSED_ENTRYPOINTS
58    %if ROMVARS.ideVarsEnd & 0xff00 <> 0
59        %error ".ideVars structures must fit within the first 256 bytes of the ROM image"
60    %endif
61    %if (ROMVARS.ideVarsEnd - ROMVARS.ideVarsBegin) = 0
62        %error "there must be at least one .ideVars structure, it would be bizarre if this were not true, but it is assumed in the ah0h reset code."
63    %endif
64%endif
65
66; Bit defines for ROMVARS.wFlags
67FLG_ROMVARS_FULLMODE                EQU (1<<0)  ; Full operating mode (steals base RAM, supports EBIOS etc.)
68FLG_ROMVARS_SERIAL_SCANDETECT       EQU (1<<3)  ; Scan COM ports at the end of drive detection.  Can also be invoked
69                                                ; by holding down the ALT key at the end of drive detection.
70                                                ; (Conveniently, this is 8, a fact we exploit when testing the bit)
71
72FLG_ROMVARS_MODULE_ADVANCED_ATA         EQU (1<<7)  ; Here in case the configuration needs to know functionality is present
73FLG_ROMVARS_MODULE_BOOT_MENU            EQU (1<<8)  ; Here in case the configuration needs to know functionality is present
74FLG_ROMVARS_MODULE_EBIOS                EQU (1<<9)  ; Here in case the configuration needs to know functionality is present
75FLG_ROMVARS_MODULE_HOTKEYS              EQU (1<<10) ; Here in case the configuration needs to know functionality is present
76FLG_ROMVARS_MODULE_IRQ                  EQU (1<<11) ; Here in case the configuration needs to know functionality is present
77FLG_ROMVARS_MODULE_JRIDE                EQU (1<<12) ; Here in case the configuration needs to know functionality is present
78FLG_ROMVARS_MODULE_SERIAL               EQU (1<<13) ; Here in case the configuration needs to know functionality is present
79FLG_ROMVARS_MODULE_SERIAL_FLOPPY        EQU (1<<14) ; Here in case the configuration needs to know functionality is present
80FLG_ROMVARS_MODULE_STRINGS_COMPRESSED   EQU (1<<15) ; Here in case the configuration needs to know functionality is present
81
82
83; Boot Menu Display Modes (see Assembly Library Display.inc for standard modes)
84DEFAULT_TEXT_MODE       EQU 4
85
86
87; Controller specific variables
88struc IDEVARS
89;;; Word 0
90    .wSerialPortAndBaud:                    ; Serial connection port (low, divided by 4) and baud rate divisor (high)
91    .wPort:                                 ; IDE Base Port for Command Block (usual) Registers
92    .bSerialPort                resb    1
93    .bSerialBaud                resb    1
94
95;;; Word 1
96    .wPortCtrl:
97    .bSerialUnused              resb    1   ; IDE Base Port for Control Block Registers
98
99    .wSerialCOMPortCharAndDevice:           ; In DetectPrint, we grab the COM Port char and Device at the same time
100    .bSerialCOMPortChar         resb    1   ; Serial connection COM port number/letter
101
102;;; Word 2
103    .bDevice                    resb    1   ; Device type
104
105    .bIRQ                       resb    1   ; Interrupt Request Number
106
107;;; And more...
108    .drvParamsMaster            resb    DRVPARAMS_size
109    .drvParamsSlave             resb    DRVPARAMS_size
110endstruc
111
112%ifndef CHECK_FOR_UNUSED_ENTRYPOINTS
113    %if IDEVARS.bSerialCOMPortChar+1 != IDEVARS.bDevice
114        %error "IDEVARS.bSerialCOMPortChar needs to come immediately before IDEVARS.bDevice so that both bytes can be fetched at the same time inside DetectPrint.asm"
115    %endif
116%endif
117
118; Default values for Port and PortCtrl, shared with the configurator
119;
120DEVICE_XTIDE_DEFAULT_PORT               EQU     300h
121DEVICE_XTIDE_DEFAULT_PORTCTRL           EQU     DEVICE_XTIDE_DEFAULT_PORT + 8h
122
123DEVICE_ATA_PRIMARY_PORT                 EQU     1F0h
124DEVICE_ATA_PRIMARY_PORTCTRL             EQU     DEVICE_ATA_PRIMARY_PORT + 200h
125
126DEVICE_ATA_SECONDARY_PORT               EQU     170h
127DEVICE_ATA_SECONDARY_PORTCTRL           EQU     DEVICE_ATA_SECONDARY_PORT + 200h
128
129DEVICE_ATA_TERTIARY_PORT                EQU     1E8h
130DEVICE_ATA_TERTIARY_PORTCTRL            EQU     DEVICE_ATA_TERTIARY_PORT + 200h
131
132DEVICE_ATA_QUATERNARY_PORT              EQU     168h
133DEVICE_ATA_QUATERNARY_PORTCTRL          EQU     DEVICE_ATA_QUATERNARY_PORT + 200h
134
135
136; Device types for IDEVARS.bDevice
137;
138DEVICE_XTIDE_REV1                       EQU (0<<1)
139DEVICE_XTIDE_REV2                       EQU (1<<1)  ; Or rev 1 with swapped A0 and A3 (chuck mod)
140DEVICE_FAST_XTIDE                       EQU (2<<1)  ; (CPLD v2 project)
141DEVICE_16BIT_ATA                        EQU (3<<1)
142DEVICE_32BIT_ATA                        EQU (4<<1)
143DEVICE_SERIAL_PORT                      EQU (5<<1)
144DEVICE_JRIDE_ISA                        EQU (6<<1)
145
146
147; Master/Slave drive specific parameters
148struc DRVPARAMS
149    .wFlags         resb    2   ; Drive flags
150    .dwMaximumLBA:              ; User specified maximum number of sectors
151    .wCylinders     resb    2   ; User specified cylinders (1...16383)
152    .wHeadsAndSectors:
153    .bHeads         resb    1   ; User specified Heads (1...16)
154    .bSect          resb    1   ; User specified Sectors per track (1...63)
155endstruc
156
157; Bit defines for DRVPARAMS.wFlags
158MASK_DRVPARAMS_WRITECACHE   EQU (3<<0)  ; Drive internal write cache settings (must start at bit 0)
159FLG_DRVPARAMS_BLOCKMODE     EQU (1<<2)  ; Enable Block mode transfers
160FLG_DRVPARAMS_USERCHS       EQU (1<<3)  ; User specified P-CHS values
161FLG_DRVPARAMS_USERLBA       EQU (1<<4)  ; User specified LBA values
162
163; Drive Write Cache values for DRVPARAMS.wFlags.MASK_DRVPARAMS_WRITECACHE
164DEFAULT_WRITE_CACHE         EQU 0       ; Must be 0
165DISABLE_WRITE_CACHE         EQU 1
166ENABLE_WRITE_CACHE          EQU 2
167
168%endif ; ROMVARS_INC
Note: See TracBrowser for help on using the repository browser.