Mercurial > hg > Members > kono > nitros9-code
annotate defs/rbfdefs @ 1699:0ec4d6e34fcc
Added xmode (forgot for 6309) in makefile
author | boisy |
---|---|
date | Tue, 03 Aug 2004 19:53:36 +0000 |
parents | b75cb7ca03a6 |
children | 823c651e7dcd |
rev | line source |
---|---|
1541 | 1 IFNE RBFDEFS-1 |
373
c07686556109
Added ifeq statements at top to allow for multiple use's of same def
boisy
parents:
71
diff
changeset
|
2 |
c07686556109
Added ifeq statements at top to allow for multiple use's of same def
boisy
parents:
71
diff
changeset
|
3 RBFDEFS set 1 |
c07686556109
Added ifeq statements at top to allow for multiple use's of same def
boisy
parents:
71
diff
changeset
|
4 |
1200 | 5 ******************************************************************** |
6 * RBFDefs - Random Block File Manager Definitions | |
0 | 7 * |
1200 | 8 * $Id$ |
9 * | |
1199 | 10 * RBF stands for 'Random Block Filemanager' and is a package of subroutines |
11 * that define the logical structure of a disk and allows access to the files | |
12 * in that structure. | |
13 * | |
14 * The data structures in this file give RBF its 'personality' and are used | |
15 * by RBF itself, as well as applications that will require disk I/O. | |
1200 | 16 * |
17 * Edt/Rev YYYY/MM/DD Modified by | |
18 * Comment | |
19 * ------------------------------------------------------------------ | |
20 * 1982/07/13 Robert F. Doggett | |
21 * PD.Exten added to path descriptor and PE Entries defined. | |
22 * | |
23 * 1982/07/15 Robert F. Doggett | |
24 * V.FileHd inserted in driver static storage. | |
25 * | |
26 * 1982/09/10 WGP | |
27 * Level One/Level Two condionals added. | |
28 * | |
29 * 1982/09/17 WGP | |
30 * | |
31 * 1982/09/17 Robert F. Doggett | |
32 * PD.SLE renamed to PD.Creat. | |
33 * | |
34 * 1982/09/17 Robert F. Doggett | |
35 * V.DiskID, V.BMapSz, V.MapSct added for smart multi-sector bitmap searching. | |
36 * | |
37 * 1982/09/20 Robert F. Doggett | |
38 * Reserved areas added in static storage. | |
39 | |
40 * 1983/06/07 Robert F. Doggett | |
41 * Added InDriver flag in PD.SMF. | |
42 * | |
43 * 1983/06/13 Robert F. Doggett | |
44 * Added PE.Req tmp save for PE.Lock. | |
45 * | |
46 * 1983/08/08 Robert F. Doggett | |
47 * Reserved PD.SToff for Japanese. | |
48 * | |
49 * 1983/11/19 Robert F. Doggett | |
50 * Added V.ResBit in drive tables. | |
51 * | |
52 * 1983/12/12 Robert F. Doggett | |
53 * Added PE.Prior to save process priority. | |
54 * | |
55 * 1983/12/13 Robert F. Doggett | |
56 * Added BufBusy bit in state flag (PD.SMF). | |
57 * | |
58 * 1984/07/06 Mark G. Hawkins | |
59 * Added Bit Definitions for DD.FMT. | |
60 * | |
61 * 1987/06/23 Kevin K. Darling | |
62 * Updated with Dev Desc Info | |
63 * | |
64 * 2003/06/02 Boisy G. Pitre | |
65 * Updated comments for clarity. | |
1205
383d5981c23f
Updated for anticipation of 256-2048 byte sector support
boisy
parents:
1200
diff
changeset
|
66 * Added TYP.256-TYP.2048 definitions for future expansion. |
1530
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
67 * |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
68 * 2004/04/14 Boisy G. Pitre |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
69 * Added new entries to device descriptor as per OS-9 Level One V2.00.00 |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
70 * addendum. Pointed out by Rodney Hamilton. |
1200 | 71 |
72 nam RBFDefs | |
73 ttl Random Block File Manager Definitions | |
1199 | 74 |
0 | 75 |
1200 | 76 pag |
0 | 77 ******************************* |
78 * RBF Device Descriptor Offsets | |
79 * | |
1199 | 80 * These definitions are for RBF device descriptors. |
81 | |
0 | 82 org M$DTyp |
1199 | 83 rmb 1 Device type (DT.RBF) |
0 | 84 IT.DRV rmb 1 Drive number |
85 IT.STP rmb 1 Step rate | |
1199 | 86 IT.TYP rmb 1 Disk device type information |
0 | 87 IT.DNS rmb 1 Density capability |
88 IT.CYL rmb 2 Number of cylinders | |
89 IT.SID rmb 1 Number of surfaces | |
1199 | 90 IT.VFY rmb 1 Verify disk writes (0 = verify, 1 = don't) |
0 | 91 IT.SCT rmb 2 Default sectors/track |
1199 | 92 IT.T0S rmb 2 Default sectors/track for track 0 sector 0 |
0 | 93 IT.ILV rmb 1 Sector interleave offset |
94 IT.SAS rmb 1 Segment allocation size | |
1530
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
95 * The following fields are from the OS-9 Level One V2.00.00 Addendum |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
96 IT.TFM rmb 1 DMA Transfer Mode |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
97 IT.Exten rmb 2 Path Extension (PE) for record locking |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
98 IT.SToff rmb 1 Sector/Track offsets (for "foreign" disk formats) |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
99 * The following fields are not copied to the path descriptor |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
100 IT.WPC rmb 1 Write precomp cyl/4 (HD) |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
101 IT.OFS rmb 2 Starting cylinder offset (HD) |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
102 IT.RWC rmb 2 Reduced write current cylinder (HD) |
a02b18bfc376
New 'Old' fields added from OS-9 Level One V2.00.00 Addendum
boisy
parents:
1377
diff
changeset
|
103 |
0 | 104 |
1609 | 105 * IT.TYP Definitions |
0 | 106 * |
1626 | 107 TYP.HARD equ %10000000 Hard disk |
1199 | 108 TYP.FLP equ %00000000 Floppy disk |
1626 | 109 TYP.NSF equ %01000000 Non-standard format |
110 TYP.SOF equ %00000000 Standard NitrOS-9 format | |
1199 | 111 |
1609 | 112 * IT.TYP bit definitions if bit 7 of IT.TYP is set (hard disk) |
1626 | 113 TYPH.256 equ %00000000 256 byte sector media |
114 TYPH.512 equ %00000001 512 byte sector media | |
115 TYPH.1024 equ %00000010 1024 byte sector media | |
116 TYPH.2048 equ %00000011 2048 byte sector media | |
117 TYPH.SSM equ %00000011 Sector size mask | |
1637 | 118 TYPH.DRSV equ %00001100 Driver-reserved bits |
119 TYPH.DSQ equ %00010000 Drive size query flag | |
1609 | 120 |
121 * IT.TYP bit definitions if bit 7 of IT.TYP is clear (floppy disk) | |
0 | 122 TYP.5 equ %00000000 5" media |
1676 | 123 TYP.3 equ %00000001 3.5" media |
1693 | 124 TYP.SBO equ %00000010 Sector base offset (clear = 0; sect = 1) |
1609 | 125 TYP.256 equ %00000000 256 byte sector media |
126 TYP.512 equ %00000100 512 byte sector media | |
0 | 127 TYP.CCF equ %00100000 CoCo format |
128 TYP.NCCF equ %00000000 Non-CoCo format | |
129 | |
1609 | 130 * IT.DNS Definitions |
131 * | |
1626 | 132 |
133 * If bit 7 of IT.TYP is set, IT.DNS is driver-dependent | |
134 | |
1609 | 135 * IT.DNS bit definitions if bit 7 of IT.TYP is clear (floppy disk) |
0 | 136 DNS.FM equ %00000000 Single-density (FM) |
137 DNS.MFM equ %00000001 Double-density (MFM) | |
138 DNS.STD equ %00000000 Single track density (48 tpi) | |
1618 | 139 DNS.DTD equ %00000010 Double track density (96/135 tpi) |
0 | 140 |
1199 | 141 * Floppy disk step rate definitions |
0 | 142 STP.30ms equ 0 30ms step rate |
143 STP.20ms equ 1 20ms step rate | |
144 STP.12ms equ 2 12ms step rate | |
145 STP.6ms equ 3 6ms step rate | |
146 | |
1200 | 147 pag |
0 | 148 ************************************* |
149 * Random Block Path Descriptor Format | |
150 * | |
1199 | 151 * A path descriptor is created for every new path that is open |
152 * via the I$Open system call (processed by IOMan). Process | |
153 * descriptors track state information of a path. | |
154 * | |
0 | 155 org PD.FST |
156 PD.SMF rmb 1 State flags | |
157 PD.CP rmb 4 Current logical byte position | |
158 PD.SIZ rmb 4 File size | |
159 PD.SBL rmb 3 Segment beginning lsn | |
160 PD.SBP rmb 3 Segment beginning psn | |
161 PD.SSZ rmb 3 Segment size | |
162 PD.DSK rmb 2 Disk id | |
163 PD.DTB rmb 2 Drive table ptr | |
164 org PD.OPT | |
165 rmb 1 Device type | |
166 PD.DRV rmb 1 Drive number | |
167 PD.STP rmb 1 Step rate | |
168 PD.TYP rmb 1 Disk device type (5" 8" other) | |
169 PD.DNS rmb 1 Density capability | |
170 PD.CYL rmb 2 Number of cylinders | |
171 PD.SID rmb 1 Number of surfaces | |
172 PD.VFY rmb 1 0=verify disk writes | |
173 PD.SCT rmb 2 Default sectors/track | |
174 PD.T0S rmb 2 Default sectors/track tr00,s0 | |
175 PD.ILV rmb 1 Sector interleave offset | |
176 PD.SAS rmb 1 Segment allocation size | |
177 PD.TFM rmb 1 DMA Transfer Mode | |
178 PD.Exten rmb 2 Path Extension (PE) for record locking | |
179 PD.SToff rmb 1 Sector/Track offsets (for "foreign" disk formats) | |
180 PD.ATT rmb 1 File attributes | |
181 PD.FD rmb 3 File descriptor psn | |
182 PD.DFD rmb 3 Directory file descriptor psn | |
183 PD.DCP rmb 4 File directory entry ptr | |
184 PD.DVT rmb 2 User readable dev tbl ptr | |
185 | |
186 * State Flags | |
187 BUFMOD equ $01 Buffer modified | |
188 SINBUF equ $02 Sector in buffer | |
189 FDBUF equ $04 File descriptor in buffer | |
190 *EOFSEC equ $08 End of file sector | |
191 *EOF equ $10 End of file | |
192 InDriver equ $20 Currently in Disk Driver, or queued | |
193 BufBusy equ $40 Buffer is currently busy | |
194 | |
1199 | 195 IFNE Level-1 |
0 | 196 ************************************ |
197 * Random Block Path Extension Format | |
198 * | |
1199 | 199 * RBF paths under Level Two have additional information that |
200 * is referenced by the path extension area. | |
201 * | |
0 | 202 org 0 |
203 PE.PE rmb 1 PE path number | |
1199 | 204 PE.PDptr rmb 2 Back ptr to this PE's Path Descriptor |
0 | 205 PE.NxFil rmb 2 Drive Open-File list ptr |
1199 | 206 PE.Confl rmb 2 Circular File Conflict list |
0 | 207 PE.Lock rmb 1 Path lockout status |
208 PE.LoLck rmb 4 Low Locked Logical addr | |
209 PE.HiLck rmb 4 High Locked Logical addr | |
210 PE.Wait rmb 2 PE ptr to (next) locked-out PE | |
211 PE.TmOut rmb 2 Max ticks to wait for locked segment | |
212 PE.Owner rmb 1 Process ID of owner of locked segment | |
1199 | 213 PE.Req rmb 1 Temp for PE.Lock in GAIN when LockSeg fails |
214 PE.Prior rmb 1 Temp for process priority while in driver | |
215 PE.SigSg rmb 1 Signal code to send | |
216 PE.SigID rmb 1 Process ID to send the signal to | |
217 rmb 32-. Reserved | |
218 PE.FilNm rmb 32 Temp for filename during directory search | |
0 | 219 |
220 * PE.Lock status codes | |
1199 | 221 Unlocked equ 0 No portion of file is locked |
222 RcdLock equ 1 Record from LoLck to HiLck locked | |
223 FileLock equ 2 Entire file locked | |
0 | 224 EofLock equ 4 End of file is locked |
1199 | 225 ENDC |
226 | |
0 | 227 |
1200 | 228 pag |
0 | 229 *********************** |
230 * LSN0 Disk Data Format | |
231 * | |
1199 | 232 * Logical Sector Number 0 is the first sector on an RBF formatted device |
233 * and contains information about the device's size and format. | |
234 * | |
0 | 235 org 0 |
236 DD.TOT rmb 3 Total number of sectors | |
237 DD.TKS rmb 1 Track size in sectors | |
238 DD.MAP rmb 2 Number of bytes in allocation bit map | |
239 DD.BIT rmb 2 Number of sectors/bit | |
240 DD.DIR rmb 3 Address of root directory fd | |
241 DD.OWN rmb 2 Owner | |
242 DD.ATT rmb 1 Attributes | |
1199 | 243 DD.DSK rmb 2 Disk ID |
0 | 244 DD.FMT rmb 1 Disk format; density/sides |
245 DD.SPT rmb 2 Sectors/track | |
246 DD.RES rmb 2 Reserved for future use | |
247 DD.SIZ equ . Device descriptor minimum size | |
248 DD.BT rmb 3 System bootstrap sector | |
249 DD.BSZ rmb 2 Size of system bootstrap | |
250 DD.DAT rmb 5 Creation date | |
251 DD.NAM rmb 32 Volume name | |
1199 | 252 DD.OPT rmb 32 Option area |
0 | 253 |
1199 | 254 * DD.FMT Bit Definitions - valid only if device is a floppy disk |
1618 | 255 FMT.SIDE equ %00000001 Single Sided=0, Double Sided=1 |
256 FMT.DNS equ %00000010 Single Density=0, Double Density=1 | |
257 FMT.TDNS equ %00000100 Track Density: 48 TPI=0, 96/135 TPI=1 | |
258 FMT.T0DN equ %00100000 Track 0 Density, see FMT.DNS | |
0 | 259 |
1199 | 260 |
1200 | 261 pag |
0 | 262 ************************ |
263 * File Descriptor Format | |
264 * | |
1199 | 265 * The file descriptor is a sector that is present for every file |
266 * on an RBF device. It contains attributes, modification dates, | |
267 * and segment information on a file. | |
268 * | |
0 | 269 org 0 |
270 FD.ATT rmb 1 Attributes | |
271 FD.OWN rmb 2 Owner | |
272 FD.DAT rmb 5 Date last modified | |
273 FD.LNK rmb 1 Link count | |
274 FD.SIZ rmb 4 File size | |
275 FD.Creat rmb 3 Segment list extension | |
276 FD.SEG equ . Beginning of segment list | |
277 * Segment List Entry Format | |
278 org 0 | |
279 FDSL.A rmb 3 Segment beginning physical sector number | |
280 FDSL.B rmb 2 Segment size | |
281 FDSL.S equ . Segment list entry size | |
282 FD.LS1 equ FD.SEG+((256-FD.SEG)/FDSL.S-1)*FDSL.S | |
283 FD.LS2 equ (256/FDSL.S-1)*FDSL.S | |
284 MINSEC set 16 | |
285 | |
1199 | 286 |
1200 | 287 pag |
0 | 288 ************************ |
289 * Directory Entry Format | |
290 * | |
1199 | 291 * Directory entries are part of a directory and define the name |
292 * of the file, as well as a pointer to its file descriptor. | |
293 * | |
0 | 294 org 0 |
295 DIR.NM rmb 29 File name | |
296 DIR.FD rmb 3 File descriptor physical sector number | |
297 DIR.SZ equ . Directory record size | |
298 | |
1199 | 299 |
1200 | 300 pag |
301 ******************** | |
302 * RBF Static Storage | |
0 | 303 * |
304 * Overall Disk Static Storage | |
305 * | |
1199 | 306 * Note: This does not reserve any memory for drive tables. Each |
307 * driver is responsible for reserving sufficient memory for | |
308 * the appropriate number of tables. | |
0 | 309 * |
310 org V.USER Reserve required ($06) | |
311 V.NDRV rmb 1 Number of drives ($07) | |
312 rmb 8 reserved ($08) | |
313 DRVBEG equ . Beginning of drive tables ($10) | |
1199 | 314 |
315 | |
1200 | 316 pag |
1199 | 317 **************** |
0 | 318 * Global Storage For Disk Drive Tables |
1199 | 319 * |
320 * Each table contains the first 'DD.SIZ' bytes from | |
321 * LSN 0, and the current track, stepping rate, | |
322 * bitmap use flag, and disk type. | |
0 | 323 * |
324 org 0 | |
1199 | 325 rmb DD.SIZ Device descriptor, LSN 0 |
0 | 326 V.TRAK rmb 2 Current track |
327 V.BMB rmb 1 Bit-map use flag | |
1199 | 328 V.FileHd rmb 2 Open file list for this drive |
0 | 329 V.DiskID rmb 2 Disk ID |
330 V.BMapSz rmb 1 Bitmap Size | |
1199 | 331 V.MapSct rmb 1 Lowest reasonable bitmap sector |
332 V.ResBit rmb 1 Reserved bitmap sector (for compaction) | |
0 | 333 V.ScTkOf rmb 1 Sector/Track byte (Combined from descriptor) |
334 V.ScOfst rmb 1 Sector offset split from byte above | |
335 V.TkOfst rmb 1 Track offset split from byte above | |
1199 | 336 rmb 4 Reserved |
0 | 337 DRVMEM equ . |
338 | |
1199 | 339 ENDC |
373
c07686556109
Added ifeq statements at top to allow for multiple use's of same def
boisy
parents:
71
diff
changeset
|
340 |