This page (revision-16) was last changed on 03-Feb-2023 15:21 by Steve N 

This page was created on 23-Jan-2016 02:37 by Steve N

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
16 03-Feb-2023 15:21 25 KB Steve N to previous
15 26-Jan-2016 01:32 25 KB Steve N to previous | to last Added table of contents
14 24-Jan-2016 11:42 25 KB Steve N to previous | to last Amended relocation text
13 24-Jan-2016 09:38 25 KB Steve N to previous | to last Added alternate drive check information. Needs comments on status codes.
12 24-Jan-2016 05:58 24 KB Steve N to previous | to last Added credit information
11 23-Jan-2016 10:21 24 KB Steve N to previous | to last Cleaned up the English from Google English to UK English in the examples sectio.
10 23-Jan-2016 10:03 24 KB Steve N to previous | to last Previously missed out a couple of updates
9 23-Jan-2016 10:02 24 KB Steve N to previous | to last Cleaned up plenty of copied and pasted code.
8 23-Jan-2016 08:32 24 KB Steve N to previous | to last Wiki restricts consecutive spaces to 1, using code formatting to stop this.
7 23-Jan-2016 06:55 24 KB Steve N to previous | to last Added download location information and amended formatting...
6 23-Jan-2016 06:49 24 KB Steve N to previous | to last Formatting amendments... needs a lot more
5 23-Jan-2016 06:41 24 KB Steve N to previous | to last Formatting corrections...
4 23-Jan-2016 03:13 24 KB Steve N to previous | to last Added .cfg file details
3 23-Jan-2016 02:57 23 KB Steve N to previous | to last Cleaned up formatting a lot. Ready for public viewing and amendment.
2 23-Jan-2016 02:45 23 KB Steve N to previous | to last Some headers set up, still needs lots of reformatting... (work in progress)
1 23-Jan-2016 02:37 25 KB Steve N to last Initial raw dump from document released on AtariAge

Page References

Incoming links Outgoing links

Version management

Difference between version and

At line 1 changed 2 lines
xBIOS Documentation
BETA DOCUMENT: The accuracy of this document is not guaranteed. Use with care!
!!!xBIOS Overview
At line 4 removed 86 lines
Document Version: 0.4.0
Published on: Monday 11th January 2016
Authors:
Krzysztof Dudek - “XXL” - Code examples, xBIOS author and lots of input.
Steve Nicklin - “snicklin” - Main document.
Known Issues with Document:
Incomplete, not enough examples.
Google translation of code examples needs refining. [ Incomplete ]
Initial version.
Only a handful of peer reviews conducted.
Some code examples use V3 code. May or may not work with v4.3
Likely Priorities for Next Major Version of Document:
Fill out with content.
Correct errors and English.
Mention more about the xBIOS menu.
Mention using other devices.
Mention how to switch off / not use Atari I/O.
Add a “directories” usage example.
Formatting needs improving for some code examples.
Document Scope:
This document is only intended to cover xBIOS versions 4.1 and above.
Code examples will use MADS syntax/formatting.
Disclaimer:
The author of this document is not an expert in xBIOS. This document is being used to collate information for personal knowledge gain. Errors may occur and not all supplied routines have been tested by the author. Technical queries should be addressed to Krzysztof and feedback given to Steve. This document is intended to represent the latest version of xBIOS, which is currently v4.3. It is however appreciated that a lot of information in the document may have been provided for older versions of xBIOS, but in all likeliness, they will still work with the latest xBIOS.
Software download location and original documentation: http://xxl.atari.pl
Document Amendments with Feedback Person Listed
v0.2.0 : Heaven/TQA@AA : Added xBOOT section.
v0.3.0 : Kyle22@AA : Extension of ‘Practical Usage’ section.
v0.3.1 : Kyle22@AA, Heaven/TQA@AA : Update code start advice.
v0.3.2 : MaPa@AA : Re-update code start advice with additional information.
v.0.4.0 : XXL@AA: Practical usage info and directory size information.
xBIOS Overview
At line 92 changed one line
General Notes
!!General Notes
At line 97 changed one line
Autorun
!Autorun
At line 101 changed one line
Filename Format
!Filename Format
At line 109 changed one line
xBIOS Limitations
!xBIOS Limitations
At line 115 changed one line
Default Memory Layout
!Default Memory Layout
At line 31 added one line
At line 119 changed one line
$0700-$07FF xBIOS I/O buffer
$0700-$07FF xBIOS I/O buffer
At line 125 changed one line
Disk Images
!Disk Images
At line 41 added one line
At line 131 changed 2 lines
‘dir2atr’ :
http://www.horus.com/~hias/atari
‘dir2atr’ : [http://www.horus.com/~hias/atari]
At line 135 changed one line
‘franny’ : http://atariage.com/forums/topic/159325-program-to-add-to-and-extract-files-from-atr/
‘franny’ : [http://atariage.com/forums/topic/159325-program-to-add-to-and-extract-files-from-atr/]
At line 138 changed one line
Practical Usage
!!Practical Usage
At line 155 changed one line
xBIOS equ $800
xBIOS equ $800
At line 193 changed one line
xSEGMENT equ xBIOS+$3f3 ; Bytes to go in binary file segment (2 bytes)
xSEGMENT equ xBIOS+$3f3 ; Bytes to go in binary file segment (2 bytes)
At line 204 changed one line
Examples
!Examples
At line 209 changed one line
xBIOS_RENAME_ENTRY
!xBIOS_RENAME_ENTRY
At line 221 changed one line
xBIOS_LOAD_FILE
!xBIOS_LOAD_FILE
At line 230 changed one line
xBIOS_OPEN_FILE
!xBIOS_OPEN_FILE
At line 239 changed one line
xBIOS_LOAD_DATA
!xBIOS_LOAD_DATA
At line 245 changed one line
xBIOS_WRITE_DATA
!xBIOS_WRITE_DATA
At line 251 changed one line
xBIOS_OPEN_CURRENT_DIR
!xBIOS_OPEN_CURRENT_DIR
At line 255 changed one line
xBIOS_GET_BYTE
!xBIOS_GET_BYTE
At line 259 changed one line
xBIOS_PUT_BYTE
!xBIOS_PUT_BYTE
At line 264 changed one line
xBIOS_FLUSH_BUFFER
!xBIOS_FLUSH_BUFFER
At line 268 changed one line
xBIOS_SET_LENGTH
!xBIOS_SET_LENGTH
At line 274 changed one line
xBIOS_SET_INIAD
!xBIOS_SET_INIAD
At line 281 changed one line
xBIOS_SET_FILE_OFFSET
!xBIOS_SET_FILE_OFFSET
At line 288 changed one line
xBIOS_SET_RUNAD
!xBIOS_SET_RUNAD
At line 294 changed one line
xBIOS_SET_DEFAULT_DEVICE
!xBIOS_SET_DEFAULT_DEVICE
At line 298 changed one line
xBIOS_OPEN_DIR
!xBIOS_OPEN_DIR
At line 309 changed one line
xBIOS_OPEN_DEFAULT_DIR
!xBIOS_OPEN_DEFAULT_DIR
At line 313 changed one line
xBIOS_SET_DEVICE
!xBIOS_SET_DEVICE
At line 319 changed one line
xBIOS_RELOCATE_BUFFER
!xBIOS_RELOCATE_BUFFER
At line 324 changed one line
xBIOS_GET_ENTRY
!xBIOS_GET_ENTRY
At line 328 changed one line
xBIOS_OPEN_DEFAULT_FILE
!xBIOS_OPEN_DEFAULT_FILE
At line 332 changed one line
xBIOS_READ_SECTOR
!xBIOS_READ_SECTOR
At line 338 changed one line
xBIOS_FIND_ENTRY
!xBIOS_FIND_ENTRY
At line 350 changed one line
[ Please note that this example originates from xBios v3 ] [ FORMATTING requires cleanup ]
[ Please note that this example originates from xBios v3 ]
At line 480 changed one line
Playing Music During I/O
!Playing Music During I/O
At line 587 changed 2 lines
Indexed Data within File - LZ4 Graphics De/compression
[ Please note this example originates from xBios v3 ] [ Formatting requires cleanup ]
!Indexed Data within File - LZ4 Graphics De/compression
[ Please note this example originates from xBios v3 ]
At line 667 changed one line
Use of High Speed Devices
!Use of High Speed Devices