-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathi440fx.inc
398 lines (362 loc) · 17.8 KB
/
i440fx.inc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
comment |*******************************************************************
* Copyright (c) 1984-2024 Forever Young Software Benjamin David Lunt *
* *
* i440FX BIOS ROM v1.0 *
* FILE: cmos.asm *
* *
* This code is freeware, not public domain. Please use respectfully. *
* *
* You may: *
* - use this code for learning purposes only. *
* - use this code in your own Operating System development. *
* - distribute any code that you produce pertaining to this code *
* as long as it is for learning purposes only, not for profit, *
* and you give credit where credit is due. *
* *
* You may NOT: *
* - distribute this code for any purpose other than listed above. *
* - distribute this code for profit. *
* *
* You MUST: *
* - include this whole comment block at the top of this file. *
* - include contact information to where the original source is located. *
* https://github.com/fysnet/i440fx *
* *
* DESCRIPTION: *
* main include file *
* *
* BUILT WITH: NewBasic Assembler *
* http://www.fysnet/newbasic.htm *
* NBASM ver 00.27.16 *
* Command line: nbasm i440fx /z<enter> *
* *
* Last Updated: 5 Feb 2025 *
* *
****************************************************************************
* Notes: *
* *
***************************************************************************|
; our bios version (in ascii format)
BIOS_VERSION equ '1.00.00'
; our base for this bios
BIOS_BASE equ 0xE000
BIOS_BASE2 equ 0xF000
; set to 1 to add debug code
DO_DEBUG equ 0
DO_SERIAL_DEBUG equ 0
; what version of the ACPI specs we support
; 0 = 1.0 (though we specify x.1 in the headers)
; 2 = 2.0
; 3 = 3.0
; ** Currently, this must remain 0 ***
APCI_VERSION equ 0 ; 0 = 1.x
; set to 1 to do the pci32/smp/acpi/etc bios setup
; (setting to 0 is more like the 'legacy' bios)
; (setting to 1 is more like the 'latest' bios)
DO_INIT_BIOS32 equ 1
; if 1, send chars to debug ports
BX_VIRTUAL_PORTS equ (1 | DO_DEBUG)
BX_INFO_PORT equ 0x402
BX_DEBUG_PORT equ 0x403
; =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
; EBDA area and sizes
EBDA_SIZE equ 4 ; in 1k's ; 1k size points to 0x9FC0
EBDA_SEG equ (0xA000 - (EBDA_SIZE << 6)) ; 2k size points to 0x9F80
BASE_MEM_IN_K equ (640 - EBDA_SIZE) ; 3k size points to 0x9F40
; 4k size points to 0x9F00
; =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
; Port List
PORT_DMA_ADDR_2 equ 0x0004
PORT_DMA_CNT_2 equ 0x0005
PORT_DMA1_MASK_REG equ 0x000A
PORT_DMA1_MODE_REG equ 0x000B
PORT_DMA1_CLEAR_FF_REG equ 0x000C
PORT_DMA1_MASTER_CLEAR equ 0x000D
PORT_PIC_MASTER_CMD equ 0x0020
PORT_PIC_MASTER_DATA equ 0x0021
PORT_PIT_CHANNEL0 equ 0x0040
PORT_PIT_CHANNEL1 equ 0x0041
PORT_PIT_CHANNEL2 equ 0x0042
PORT_PIT_MODE equ 0x0043
PORT_PS2_DATA equ 0x0060
PORT_PS2_CTRLB equ 0x0061
PORT_PS2_STATUS equ 0x0064
PORT_DIAG equ 0x0080
PORT_DMA_PAGE_2 equ 0x0081
PORT_A20 equ 0x0092
PORT_PIC_SLAVE_CMD equ 0x00A0
PORT_PIC_SLAVE_DATA equ 0x00A1
PORT_DMA2_MASK_REG equ 0x00D4
PORT_DMA2_MODE_REG equ 0x00D6
PORT_DMA2_MASTER_CLEAR equ 0x00DA
PORT_ATA2_CMD_BASE equ 0x0170
PORT_ATA1_CMD_BASE equ 0x01F0
PORT_FD_DOR equ 0x03F2
PORT_FD_STATUS equ 0x03F4
PORT_FD_DATA equ 0x03F5
; =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
; BIOS Boot Specification stuff:
IPL_BOOT_FIRST_NONE equ 0x00FF
IPL_TABLE_ENTRY_CNT equ 16 ; maximum count of entries allowed
IPL_ENTRY_MAX_DESC_LEN equ 16
; entry types
IPL_TYPE_FLOPPY equ 0x01 ; BIOS Spec compliant type number 1
IPL_TYPE_HARDDISK equ 0x02 ; BIOS Spec compliant type number 2
IPL_TYPE_CDROM equ 0x03 ; BIOS Spec compliant type number 3
IPL_TYPE_PCMCIA equ 0x04 ; BIOS Spec compliant type number 4
IPL_TYPE_USB equ 0x05 ; BIOS Spec compliant type number 5
IPL_TYPE_NET equ 0x06 ; BIOS Spec compliant type number 6
IPL_TYPE_BEV equ 0x80 ; BIOS Spec compliant type number 128
IPL_FLAGS_NSATA equ (0 << 0) ; not SATA hard drive (any device that is not an SATA device)
IPL_FLAGS_SATA equ (1 << 0) ; is SATA device
; (the format here are not BIOS Boot Specification compliant)
; (If the caller calls PNP/BIOS Boot Spec serivce 0x62, we will build the IPL table on the fly)
IPL_ENTRY struct
type byte ; type of device
device byte ; device value to use to read/write using bios services
vector dword ; if rom device, this is seg:offset to call for services
base_lba dword ; emulated base LBA (lba from start of media to emulated image)
description dup IPL_ENTRY_MAX_DESC_LEN ; character description of the device
flags word ; flags: see IPL_FLAGS_* above
reserved dup 4 ; not used
IPL_ENTRY ends
; =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
; USB Device
USB_DEVICE_MAX equ 4 ; max devices supported per controller
USB_MSD_MEDIA_FLOPPY equ 0
USB_MSD_MEDIA_HARDDRIVE equ 1
USB_MSD_MEDIA_CDROM equ 2
; these values are combined with the 'usb_disk_emulated_drive' value
; zero based controller type in bits 7:6 (CC)
; zero based controller index in bits 5:4 (II)
; zero based device number in bits 3:0 (DDDD)
; CCIIDDDD
USB_CONTROLLER_UHCI equ 00000000b
USB_CONTROLLER_OHCI equ 01000000b
USB_CONTROLLER_EHCI equ 10000000b
USB_CONTROLLER_xHCI equ 11000000b
; 4 bytes
USB_DEVICE_EP struct
ep_val byte ; endpoint value (0x01, 0x02, etc)
ep_toggle byte ; current toggle
ep_mps word ; endpoints max packet size
ep_interval byte ; interval (usually 0x00)
ep_max_burst byte ; xhci: max burst (usually 0x0F)
USB_DEVICE_EP ends
; this is a structure that all present devices get. It holds information
; about the device, its buffers, etc.
; 4096 bytes
USB_DEVICE struct
device_num byte ; zero based device index on this controller
port byte ; port (0, 1, etc)
speed byte ; speed (0 = fs, 1 = ls, 2 = hs, 3 = ss)
mps word ; max packet size (ep 0)
dev_addr byte ; device address (port + 1)
protocol byte ; BBB / CBI / UASP
controller byte ; type of controller
bios_addr byte ; the address we give it for BIOS use
endpoint_in dup (sizeof(USB_DEVICE_EP)) ; IN endpoint
endpoint_out dup (sizeof(USB_DEVICE_EP)) ; OUT endpoint
org_media byte ; type of device before emulation
cyls word ; emulated number of cyls
heads byte ; emulated number of heads
spt byte ; emulated number of spt
media byte ; emulated media type
boot_dl byte ; emulated BIOS DL number
block_size word ; size of a sector
log_size word ; logical size of a sector
sectors qword ; count of sectors
base_lba qword ; base lba of (emulated) image
request dup 8
cbw dup 31
filler1 byte
csw dup 13
filler2 dup 3
next_tag dword
event_status qword
reserved dup 626
xhci_protocol byte ; xhci: protocol of the port (XHCI_USB2 or XHCI_USB3)
slot_id byte ; xhci: slot id for this device
slot_context dup 24 ; xhci: sizeof(xHCI_SLOT_CONTEXT)
ep_contexts dup (40 * 32) ; xhci: sizeof(xHCI_EP_CONTEXT) * 32
rxtx_buffer dup 2048
USB_DEVICE ends
.if (sizeof(USB_DEVICE) != 4096)
%ERROR 1 'USB_DEVICE != 4096 bytes'
%print sizeof(USB_DEVICE)
.endif
; =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
MAX_USB_CONTROLLERS equ 4 ; we allow up to 4 controllers of each type
; (with ehci, there will be 1 UHCI plus 3 UHCI/OHCI controllers)
; 100 bytes
USB_CONTROLLER struct
valid byte ; is this information valid?
busdevfunc word ; bus dev/func
base dword ; base IO address (Port IO or Memmapped)
irq byte ; irq
numports byte ; number of root hub ports on this controller
base_memory dword ; base of our allocated memory (xhci: is extended caps instead)
callback_bulk word ; BIOS_BASE:offset of callback routine for bulk transfers
callback_control word ; BIOS_BASE:offset of callback routine for control transfers
op_reg_offset byte ; xhci & ehci: op register set offset
context_size byte ; xhci: context size (32 or 64)
flags byte ; xhci: bit 0 = use 64-bit addresses (remaining are reserved)
page_size word ; xhci: page_size
max_slots byte ; xhci: max slots
slots_buffer dword ; xhci: physical address of the slots buffers
command_ring dup 12 ; xhci: command ring (struct xHCI_RING)
event_ring dup 20 ; xhci: event ring (struct xHCI_EVENT_RING)
dcbaap_addr dword ; xhci: dcbaap address
reserved dup 20
device_cnt byte ; count of devices found on this controller
device_data dup (sizeof(dword) * USB_DEVICE_MAX)
USB_CONTROLLER ends
; =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
MAX_SATA_CONTROLLERS equ 2 ; we allow up to 2 controllers (no more than 4)
MAX_PRDT_ENTRIES equ 8 ; we allow up to 8 PRDT entries per command slot (this aligns the next entry for us)
SATA_DEVICE_MAX equ 4 ; four drives per SATA controller (no more than 16)
; 16 bytes
SATA_PRDT_ENTRY struct
dba dword
dbau dword
reserved dword
dword3 dword
SATA_PRDT_ENTRY ends
; 256 bytes
SATA_COMMAND_TABLE struct
cfis dup 64
acmd dup 16
reserved dup 48
prdt_entries dup (MAX_PRDT_ENTRIES * sizeof(SATA_PRDT_ENTRY))
SATA_COMMAND_TABLE ends
; 12,288 bytes
SATA_DEVICE struct
; the following three items must remain first and in this order
command_list dup 1024 ; command list buffer (32 * sizeof(HBA_CMD_LIST))
command_table dup (32 * sizeof(SATA_COMMAND_TABLE)) ; command table
recv_fis dup 256
rxtx_buffer dup 2048 ; temp buffer for transfers
device_num byte ; zero based device index on this controller
port byte ; port (0, 1, etc)
device_sig dword ; device signature (type) SATA_SIG_ATA or SATA_SIG_ATAPI
blk_size word ; bytes per sector
cylinders word ; count of cylinders
heads word ; count of heads
spt word ; count of sectors per track
sectors_low dword ; count of sectors (low dword)
sectors_high dword ; count of sectors (high dword)
reserved dup 746
SATA_DEVICE ends
.if (sizeof(SATA_DEVICE) != 12288)
%error 1 "SATA_DEVICE table abnormal size"
%print sizeof(SATA_DEVICE)
.endif
; 100 bytes
SATA_CONTROLLER struct
valid byte ; is this information valid?
busdevfunc word ; bus dev/func
base dword ; base IO address (Memmapped)
irq byte ; irq
numports byte ; number of ports on this controller
command_slots byte ; number command slots
numdrives byte ; number of drives on this controller
version dword ; controller version
;base_memory dword ; base of our allocated memory (xhci: is extended caps instead)
;callback_bulk word ; BIOS_BASE:offset of callback routine for bulk transfers
;callback_control word ; BIOS_BASE:offset of callback routine for control transfers
;op_reg_offset byte ; xhci & ehci: op register set offset
;context_size byte ; xhci: context size (32 or 64)
;flags byte ; xhci: bit 0 = use 64-bit addresses (remaining are reserved)
;page_size word ; xhci: page_size
;max_slots byte ; xhci: max slots
;slots_buffer dword ; xhci: physical address of the slots buffers
;command_ring dup 12 ; xhci: command ring (struct xHCI_RING)
;event_ring dup 20 ; xhci: event ring (struct xHCI_EVENT_RING)
;dcbaap_addr dword ; xhci: dcbaap address
reserved dup 69
;device_cnt byte ; count of devices found on this controller
device_data dup (sizeof(dword) * SATA_DEVICE_MAX)
SATA_CONTROLLER ends
; =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
; E820 style memory table
E820_RAM equ 1
E820_RESERVED equ 2
E820_ACPI equ 3
E820_NVS equ 4
E820_UNUSABLE equ 5
MEM_TABLE_ENTRIES equ 20
BIOS_EXT_MEMORY_USE equ (65536 * 4)
ACPI_DATA_SIZE equ 0x00010000 ; 64k (65536)
BX_MAX_ATA_INTERFACES equ 4
BX_MAX_ATA_DEVICES equ 8
MEM_TABLE struct
mem_base qword
mem_size qword
mem_type dword
ext_attrbs dword ; only used if ACPI_VERSION => 3 (bit 0 = 0 == entry is ignored)
MEM_TABLE ends ; (bit 1 = 1 == non-volatile)
PM_IO_BASE equ 0xB000
SMB_IO_BASE equ 0xB100
AP_BOOT_ADDR_SZ equ 0x100 ; must be a multiple of 0x10
AP_BOOT_ADDR equ ((EBDA_SEG << 4) - AP_BOOT_ADDR_SZ)
APIC_BASE_ADDR equ 0xFEE00000
APIC_REG_SEL equ 0x000
APIC_REG_DATA equ 0x010
APIC_REG_ID equ 0x020
APIC_REG_VER equ 0x030
APIC_REG_TRP equ 0x080
APIC_REG_EOI equ 0x0B0
APIC_REG_LDR equ 0x0D0
APIC_REG_DFR equ 0x0E0
APIC_REG_SIV equ 0x0F0
APIC_REG_ICR equ 0x300
APIC_REG_TIMER equ 0x320
APIC_REG_THERM equ 0x330
APIC_REG_PERFORM equ 0x340
APIC_REG_LINT0 equ 0x350
APIC_REG_LINT1 equ 0x360
APIC_REG_LERROR equ 0x370
IOAPIC_BASE_ADDR equ 0xFEC00000
IOAPIC_REG_ID equ 0x000
IOAPIC_REG_VER equ 0x001
IOAPIC_REG_ARB equ 0x002
IOAPIC_REG_REDIR equ 0x010 ; first indirect table register (0x10 and 0x11)
; 0x012 ; second indirect table register (0x12 and 0x13)
; ....
; each service call pushes the registers onto the stack with pusha
; we can then access them via [bp+regoffset]
; (we compensate for pushing bp first)
; flags cs ip es ds
; [bp+44] [bp+42] [bp+40] [bp+38] [bp+36]
; edi esi ebp esp ebx edx ecx eax
; [bp+04] [bp+08] [bp+12] [bp+16] [bp+20] [bp+24] [bp+28] [bp+32]
REG_FLAGS equ [bp+44]
REG_CS equ [bp+42]
REG_IP equ [bp+40]
REG_ES equ [bp+38]
REG_DS equ [bp+36]
REG_EAX equ [bp+32]
REG_AX equ [bp+32]
REG_AL equ [bp+32]
REG_AH equ [bp+33]
REG_ECX equ [bp+28]
REG_CX equ [bp+28]
REG_CL equ [bp+28]
REG_CH equ [bp+29]
REG_EDX equ [bp+24]
REG_DX equ [bp+24]
REG_DL equ [bp+24]
REG_DH equ [bp+25]
REG_EBX equ [bp+20]
REG_BX equ [bp+20]
REG_BL equ [bp+20]
REG_BH equ [bp+21]
REG_ESP equ [bp+16]
REG_SP equ [bp+16]
REG_EBP equ [bp+12]
REG_BP equ [bp+12]
REG_ESI equ [bp+08]
REG_SI equ [bp+08]
REG_EDI equ [bp+04]
REG_DI equ [bp+04]
.end