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

Last change on this file since 587 was 584, checked in by Tomi Tilli, 9 years ago

Changes to XTIDE Universal BIOS:

  • Added support for Lo-tech 8-bit IDE Adapter (untested)
File size: 8.7 KB
RevLine 
[90]1; Project name : XTIDE Universal BIOS
[3]2; Description : Defines for ROMVARS struct containing variables stored
3; in BIOS ROM.
[376]4
5;
[380]6; XTIDE Universal BIOS and Associated Tools
[526]7; Copyright (C) 2009-2010 by Tomi Tilli, 2011-2013 by XTIDE Universal BIOS Team.
[376]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.
[380]13;
[376]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
[380]17; GNU General Public License for more details.
[376]18; Visit http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19;
20
[3]21%ifndef ROMVARS_INC
22%define ROMVARS_INC
23
[181]24; ROM Variables. Written to the ROM image before flashing.
[3]25struc ROMVARS
[181]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)
[90]29
[181]30 .rgbSign resb 8 ; Signature for XTIDE Configurator Program
31 .szTitle resb 31 ; BIOS title string
32 .szVersion resb 25 ; BIOS version string
[90]33
[181]34 .wFlags resb 2 ; Word for ROM flags
35 .wDisplayMode resb 2 ; Display mode for boot menu
36 .wBootTimeout resb 2 ; Boot Menu selection timeout in system timer ticks
37 .bIdeCnt resb 1 ; Number of available IDE controllers
[392]38 .bBootDrv resb 1 ; Default drive to boot from
[181]39 .bMinFddCnt resb 1 ; Minimum number of Floppy Drives
40 .bStealSize resb 1 ; Number of 1kB blocks stolen from 640kB base RAM
[380]41 .bIdleTimeout resb 1 ; Standby timer value
[90]42
[316]43 .ideVarsBegin:
[181]44 .ideVars0 resb IDEVARS_size
45 .ideVars1 resb IDEVARS_size
46 .ideVars2 resb IDEVARS_size
47 .ideVars3 resb IDEVARS_size
[175]48
[176]49%ifdef MODULE_SERIAL
[175]50 .ideVarsSerialAuto resb IDEVARS_size
[176]51%endif
[316]52
53 .ideVarsEnd:
[3]54endstruc
55
[316]56%ifndef CHECK_FOR_UNUSED_ENTRYPOINTS
57 %if ROMVARS.ideVarsEnd & 0xff00 <> 0
58 %error ".ideVars structures must fit within the first 256 bytes of the ROM image"
59 %endif
60 %if (ROMVARS.ideVarsEnd - ROMVARS.ideVarsBegin) = 0
[322]61 %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."
[316]62 %endif
63%endif
64
[507]65NUMBER_OF_IDEVARS EQU ((ROMVARS.ideVarsEnd - ROMVARS.ideVarsBegin) / IDEVARS_size)
66
[3]67; Bit defines for ROMVARS.wFlags
[199]68FLG_ROMVARS_FULLMODE EQU (1<<0) ; Full operating mode (steals base RAM, supports EBIOS etc.)
69FLG_ROMVARS_SERIAL_SCANDETECT EQU (1<<3) ; Scan COM ports at the end of drive detection. Can also be invoked
70 ; by holding down the ALT key at the end of drive detection.
71 ; (Conveniently, this is 8, a fact we exploit when testing the bit)
[176]72
[400]73; Here in case the configuration needs to know functionality is present
[567]74FLG_ROMVARS_MODULE_POWER_MANAGEMENT EQU (1<<5)
[400]75FLG_ROMVARS_MODULE_8BIT_IDE EQU (1<<6)
[493]76FLG_ROMVARS_MODULE_8BIT_IDE_ADVANCED EQU (1<<7)
[400]77FLG_ROMVARS_MODULE_ADVANCED_ATA EQU (1<<8)
78FLG_ROMVARS_MODULE_BOOT_MENU EQU (1<<9)
79FLG_ROMVARS_MODULE_EBIOS EQU (1<<10)
80FLG_ROMVARS_MODULE_HOTKEYS EQU (1<<11)
81FLG_ROMVARS_MODULE_IRQ EQU (1<<12)
82FLG_ROMVARS_MODULE_SERIAL EQU (1<<13)
83FLG_ROMVARS_MODULE_SERIAL_FLOPPY EQU (1<<14)
84FLG_ROMVARS_MODULE_STRINGS_COMPRESSED EQU (1<<15)
[397]85
86
[143]87; Boot Menu Display Modes (see Assembly Library Display.inc for standard modes)
88DEFAULT_TEXT_MODE EQU 4
[3]89
[143]90
[3]91; Controller specific variables
92struc IDEVARS
[233]93;;; Word 0
94 .wSerialPortAndBaud: ; Serial connection port (low, divided by 4) and baud rate divisor (high)
[473]95 .wBasePort: ; IDE Base Port for Command Block (usual) Registers
[233]96 .bSerialPort resb 1
97 .bSerialBaud resb 1
[196]98
[233]99;;; Word 1
[473]100 .wControlBlockPort:
[233]101 .bSerialUnused resb 1 ; IDE Base Port for Control Block Registers
[196]102
[233]103 .wSerialCOMPortCharAndDevice: ; In DetectPrint, we grab the COM Port char and Device at the same time
104 .bSerialCOMPortChar resb 1 ; Serial connection COM port number/letter
105
106;;; Word 2
[196]107 .bDevice resb 1 ; Device type
108 .bIRQ resb 1 ; Interrupt Request Number
[233]109
110;;; And more...
[196]111 .drvParamsMaster resb DRVPARAMS_size
112 .drvParamsSlave resb DRVPARAMS_size
[3]113endstruc
114
[261]115%ifndef CHECK_FOR_UNUSED_ENTRYPOINTS
116 %if IDEVARS.bSerialCOMPortChar+1 != IDEVARS.bDevice
117 %error "IDEVARS.bSerialCOMPortChar needs to come immediately before IDEVARS.bDevice so that both bytes can be fetched at the same time inside DetectPrint.asm"
118 %endif
[233]119%endif
120
[496]121STANDARD_CONTROL_BLOCK_OFFSET EQU 200h
[545]122XTIDE_CONTROL_BLOCK_OFFSET EQU 8h ; for XTIDE, A3 is used to control selected register (CS0 vs CS1)...
[558]123XTCF_CONTROL_BLOCK_OFFSET EQU 10h ; ...and for XT-CF (all variants), it's A4
[536]124ADP50L_CONTROL_BLOCK_OFFSET EQU 10h
[496]125
[199]126; Default values for Port and PortCtrl, shared with the configurator
127;
[545]128DEVICE_XTIDE_DEFAULT_PORT EQU 300h ; Also the default port for XT-CF
[496]129DEVICE_XTIDE_DEFAULT_PORTCTRL EQU (DEVICE_XTIDE_DEFAULT_PORT + XTIDE_CONTROL_BLOCK_OFFSET)
[545]130; Note XT-CF control port is SHL 1 relative to XTIDE, and coded that way hence no need for specific definition like...
[547]131; DEVICE_XTCF_DEFAULT_PORTCTRL EQU (DEVICE_XTIDE_DEFAULT_PORT + XTCF_CONTROL_BLOCK_OFFSET)
[199]132
[496]133DEVICE_ATA_PRIMARY_PORT EQU 1F0h
134DEVICE_ATA_PRIMARY_PORTCTRL EQU (DEVICE_ATA_PRIMARY_PORT + STANDARD_CONTROL_BLOCK_OFFSET)
[398]135
136DEVICE_ATA_SECONDARY_PORT EQU 170h
[496]137DEVICE_ATA_SECONDARY_PORTCTRL EQU (DEVICE_ATA_SECONDARY_PORT + STANDARD_CONTROL_BLOCK_OFFSET)
[398]138
139DEVICE_ATA_TERTIARY_PORT EQU 1E8h
[503]140DEVICE_ATA_TERTIARY_PORTCTRL EQU (DEVICE_ATA_TERTIARY_PORT + STANDARD_CONTROL_BLOCK_OFFSET)
[398]141
142DEVICE_ATA_QUATERNARY_PORT EQU 168h
[503]143DEVICE_ATA_QUATERNARY_PORTCTRL EQU (DEVICE_ATA_QUATERNARY_PORT + STANDARD_CONTROL_BLOCK_OFFSET)
[398]144
145
[175]146; Device types for IDEVARS.bDevice
[473]147; IDE Devices are grouped so device numbers cannot be changed without modifying code elsewhere!
[584]148; (IdeTransfer.asm)
[480]149COUNT_OF_STANDARD_IDE_DEVICES EQU 2 ; 16- and 32-bit controllers
[584]150COUNT_OF_8BIT_IDE_DEVICES EQU 9
[473]151COUNT_OF_ALL_IDE_DEVICES EQU (COUNT_OF_8BIT_IDE_DEVICES + COUNT_OF_STANDARD_IDE_DEVICES)
152; Standard port mapped I/O
153DEVICE_16BIT_ATA EQU (0<<1)
154DEVICE_32BIT_ATA EQU (1<<1)
[482]155DEVICE_8BIT_ATA EQU ((COUNT_OF_STANDARD_IDE_DEVICES+0)<<1) ; 16- or 32-bit controller in 8-bit mode
156DEVICE_8BIT_XTIDE_REV1 EQU ((COUNT_OF_STANDARD_IDE_DEVICES+1)<<1)
[473]157; Address lines A0 and A3 are swapped
[480]158DEVICE_8BIT_XTIDE_REV2 EQU ((COUNT_OF_STANDARD_IDE_DEVICES+2)<<1) ; Or rev 1 with swapped A0 and A3
[473]159; IDE Register offsets are SHL 1
[584]160XTCF_DEVICE_OFFSET EQU 3
161DEVICE_8BIT_XTCF_PIO8 EQU ((COUNT_OF_STANDARD_IDE_DEVICES+XTCF_DEVICE_OFFSET)<<1) ; XT-CF using 8-bit PIO mode
[545]162DEVICE_8BIT_XTCF_PIO8_WITH_BIU_OFFLOAD EQU ((COUNT_OF_STANDARD_IDE_DEVICES+4)<<1) ; XT-CF using 8-bit PIO mode, but with 16-bit instructions
[584]163DEVICE_8BIT_XTCF_PIO16_WITH_BIU_OFFLOAD EQU ((COUNT_OF_STANDARD_IDE_DEVICES+5)<<1) ; Lo-tech 8-bit IDE Adapter
164DEVICE_8BIT_XTCF_DMA EQU ((COUNT_OF_STANDARD_IDE_DEVICES+6)<<1) ; XT-CFv3 using DMA
[473]165; Memory Mapped I/O
[584]166DEVICE_8BIT_JRIDE_ISA EQU ((COUNT_OF_STANDARD_IDE_DEVICES+7)<<1) ; JR-IDE/ISA (Memory Mapped I/O)
167DEVICE_8BIT_ADP50L EQU ((COUNT_OF_STANDARD_IDE_DEVICES+8)<<1) ; SVC ADP50L (Memory Mapped I/O)
[473]168; Virtual devices
[400]169DEVICE_SERIAL_PORT EQU (COUNT_OF_ALL_IDE_DEVICES<<1)
170
171
172
[3]173; Master/Slave drive specific parameters
174struc DRVPARAMS
175 .wFlags resb 2 ; Drive flags
[227]176 .dwMaximumLBA: ; User specified maximum number of sectors
[3]177 .wCylinders resb 2 ; User specified cylinders (1...16383)
[99]178 .wHeadsAndSectors:
179 .bHeads resb 1 ; User specified Heads (1...16)
[3]180 .bSect resb 1 ; User specified Sectors per track (1...63)
181endstruc
182
183; Bit defines for DRVPARAMS.wFlags
[422]184MASK_DRVPARAMS_WRITECACHE EQU (3<<0) ; Bits 0...1, Drive internal write cache settings (must start at bit 0)
185 DEFAULT_WRITE_CACHE EQU 0 ; Must be 0
186 DISABLE_WRITE_CACHE EQU 1
187 ENABLE_WRITE_CACHE EQU 2
188MASK_DRVPARAMS_TRANSLATEMODE EQU (3<<TRANSLATEMODE_FIELD_POSITION) ; Bits 2...3, Position shared with DPT
189 TRANSLATEMODE_FIELD_POSITION EQU 2
[535]190 TRANSLATEMODE_NORMAL EQU 0 ; Must be zero
[422]191 TRANSLATEMODE_LARGE EQU 1
192 TRANSLATEMODE_ASSISTED_LBA EQU 2 ; 28-bit or 48-bit LBA
193 TRANSLATEMODE_AUTO EQU 3 ; Only available in ROMVARS, not in DPTs
194FLG_DRVPARAMS_BLOCKMODE EQU (1<<4) ; Enable Block mode transfers
195FLG_DRVPARAMS_USERCHS EQU (1<<5) ; User specified P-CHS values
[547]196 MAX_PCHS_CYLINDERS EQU 16383
197 MAX_PCHS_HEADS EQU 16
198 MAX_PCHS_SECTORS_PER_TRACK EQU 63
199 MAX_PCHS_TOTAL_SECTOR_COUNT EQU (MAX_PCHS_CYLINDERS * MAX_PCHS_HEADS * MAX_PCHS_SECTORS_PER_TRACK) ; 16,514,064
[422]200FLG_DRVPARAMS_USERLBA EQU (1<<6) ; User specified LBA value
[3]201
202%endif ; ROMVARS_INC
Note: See TracBrowser for help on using the repository browser.