The IDE64 Project user’s guide September 17, 2005 preview for card versions V2.1, V3.1, V3.2, V3.4 and V3.4+ with IDEDOS 0.9x (20050917)! THE ATA / ATAPI CONTROLLER CARD FOR COMMODORE 64 / 128 COMPUTERS SUPPORTING HARD DISK, CDROM, DVD, ZIP DRIVE, LS-120 (A-DRIVE), COMPACTFLASH AND MORE September 17, 2005 preview Document maintained by: Kajtár Zsolt Szigliget Hóvirág u.15. 8264 Hungary mail: soci at c64.rulez.org Latest version of this document at: http://singularcrew.hu/idedos/ Copyright © 2003-2005 Kajtár Zsolt (Soci/Singular). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with the no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled “20 GNU Free Documentation License”. 2 September 17, 2005 preview Foreword This is the official user’s guide for the IDE64 interface cartridge V2.1, V3.1, V3.2, V3.4 and V3.4+ with the upcoming IDEDOS 0.9x. In- complete but planned parts are marked this way. This document always represents the actual state of development and the facts stated here may or may not apply to future or old ver- sions of IDEDOS or the IDE64 cartridge. Please make sure you have the current version for your software and hardware! It’s recommended that you read all sections of this manual. For most of your questions the answers are somewhere in this text ;) Disclaimer All copyrights are held by their by their respective owners, unless specifically noted otherwise. Use of a term in this document should not be regarded as affecting the validity of any trademark or service mark. Naming of particular products or brands should not be seen as endorsements. No liability for the contents of this document can be accepted. Use the concepts, examples and information at your own risk. There may be errors and inaccuracies that could be damaging to your sys- tem, although any damage is highly unlikely. Proceed with caution; the author(s) do not take any responsibility. 3 September 17, 2005 preview 4 CONTENTS September 17, 2005 preview Contents 1 About the IDE64 interface cartridge 13 2 Set up and begin using the cartridge 15 2.1 Cabling, jumpers ................... 15 2.2 Power supply ..................... 15 2.3 CompactFlash ..................... 16 2.4 ZiP drive ....................... 16 2.5 LS-120, A-Drive ................... 17 2.6 Peripherals ...................... 17 2.7 Battery ......................... 17 2.8 Let’s start ....................... 17 3 The CMOS Setup utility 19 3.1 Standard setup ..................... 19 3.2 Color setup ...................... 24 3.3 Device numbers .................... 24 3.4 Advanced setup .................... 26 3.5 Restore defaults .................... 28 3.6 Save & exit ...................... 28 3.7 Discard & exit ..................... 29 4 Preparing a blank disk 31 4.1 The format utility ................... 32 5 Using partitions 39 5 September 17, 2005 preview CONTENTS 6 Using directories 41 6.1 Paths .......................... 44 6.2 Wildcards ....................... 46 6.3 Raw directory access ................. 49 7 Using files 51 7.1 SAVE ......................... 51 7.2 LOAD ......................... 52 7.3 OPEN ......................... 53 7.3.1 Opening a direct channel ........... 54 7.3.2 Opening a formatted directory list ...... 54 7.3.3 Opening a raw directory list ......... 55 7.3.4 Opening a regular regular file for read .... 55 7.3.5 Creating and replacing regular a file ..... 56 7.3.6 Opening a regular file for append ...... 57 7.3.7 Opening a regular file for read and write ... 58 7.3.8 Opening the command channel ........ 58 7.4 CLOSE ........................ 58 7.5 File operations .................... 59 8 Direct access 61 8.1 BLOCK-READ .................... 61 8.1.1 Reading from a CHS-ATA device ...... 61 8.1.2 Reading from a LBA-ATA or ATAPI device . 62 8.1.3 Getting device identity ............ 62 8.2 BLOCK-WRITE ................... 62 8.2.1 Writing to a CHS-ATA device ........ 62 8.2.2 Writing to a LBA-ATA or ATAPI device ... 62 8.3 BUFFER-POINTER ................. 63 6 CONTENTS September 17, 2005 preview 8.3.1 Selecting a byte ................ 63 8.4 TOC-READ ...................... 63 8.4.1 Reading TOC from a CD ........... 63 8.5 SUB-CHANNEL-READ ............... 65 8.5.1 Reading sub-channel information ...... 66 9 The File Manager 69 9.1 Plugins ........................ 72 9.1.1 Plugin format ................. 72 9.2 Manager config file .................. 74 10 Using the monitor 77 10.1 Disk commands .................... 79 10.2 Display and modify memory ............. 83 10.3 Execution control ................... 92 10.4 Memory area commands ............... 93 10.5 Miscellaneous ..................... 95 11 DOS Wedge 101 11.1 @ (at sign) ..................... 101 11.2 @# (at, number sign) ................ 101 11.3 @$ (at, dollar sign) ................. 102 11.4 / (slash) ....................... 102 11.5 % (percent sign) ................... 103 11.6 ´ (apostrophe) .................... 104 11.7 ↑ (up arrow) ..................... 104 11.8 ← (left arrow) .................... 105 11.9 £ (pound sign) .................... 105 11.10. (period) ...................... 105 7 September 17, 2005 preview CONTENTS 11.11# (hashmark) .................... 106 12 BASIC extensions 109 12.1 CD – change directory ................. 109 12.2 CDCLOSE – insert media ............... 110 12.3 CDOPEN – eject media ................ 110 12.4 CHANGE – change device number .......... 110 12.5 DATE – display date .................. 111 12.6 DEF – redefine F-keys ................. 111 12.7 DIR – list directory .................. 112 12.8 HDINIT – redetect devices ............... 113 12.9 INIT – init memory .................. 113 12.10KILL – disable cartridge ................ 114 12.11LL – long directory list ................ 114 12.12LOAD – load a program ................ 116 12.13MAN – start manager ................. 117 12.14MKDIR – create directory ............... 117 12.15RM – remove file ................... 117 12.16RMDIR – remove directory .............. 118 12.17SAVE – save a program ................ 118 12.18SYS – start ML program ............... 119 12.19VERIFY – verify program ............... 119 13 Programming in assembly 121 13.1 Standard kernal routines ............... 121 13.1.1 $FFB7 – READST ............... 121 13.1.2 $FF90 – SETMSG ............... 122 13.1.3 $FFE1 – STOP ................ 123 13.1.4 $FFBA – SETLFS ............... 124 8 CONTENTS September 17, 2005 preview 13.1.5 $FFBD – SETNAM .............. 125 13.1.6 $FFC0 – OPEN ................ 126 13.1.7 $FFC3 – CLOSE ............... 128 13.1.8 $FFC6 – CHKIN ............... 128 13.1.9 $FFC9 – CHKOUT .............. 129 13.1.10 $FFCF – CHRIN ............... 130 13.1.11 $FFE4 – GETIN ................ 131 13.1.12 $FFD2 – CHROUT .............. 132 13.1.13 $FFE7 – CLALL ............... 133 13.1.14 $FFCC – CLRCHN .............. 133 13.1.15 $FFD5 – LOAD ................ 134 13.1.16 $FFD8 – SAVE ................ 135 13.2 IDE64 specific routines ................ 137 13.2.1 IDE64 card detection ............. 137 13.2.2 $DEF1 – WRITE ............... 139 13.2.3 $DEF1 – WRITE replacement ........ 139 13.2.4 $DEF4 – READ ................ 141 13.2.5 $DEF4 – READ replacement ......... 144 13.3 Common programming problems ........... 146 13.3.1 Serial bus specific code ............ 146 13.3.2 Direct kernal calls .............. 147 14 PCLink 149 14.1 PCLink on XPClink cable .............. 149 14.2 PCLink on PC64 cable ................ 150 14.3 PCLink on null modem cable ............. 151 9 September 17, 2005 preview LIST OF TABLES 15 Command channel 153 15.1 File management commands ............. 153 15.2 Filesystem management commands ......... 154 15.3 Partition management commands ........... 157 15.4 Device management commands ........... 159 15.5 Direct access commands ............... 165 15.6 Directory handling commands ............ 166 15.7 CDROM related commands .............. 169 15.8 Misc commands .................... 177 16 Command channel error messages 179 17 Compatibility 183 18 Updating IDEDOS 187 19 Frequently Asked Questions 191 20 GNU Free Documentation License 193 21 Appendix A – The Short Bus 203 22 Appendix B – More information 207 22.1 Related Internet sites ................. 207 22.2 Distributors ...................... 207 List of Tables 1 C128 extra keys .................... 23 10 LIST OF TABLES September 17, 2005 preview 2 Default function key assignment ........... 24 3 Detailed directory filetypes .............. 42 4 Bits of TOC format .................. 64 5 Bits of sub-channel read format ............ 66 6 Sub-channel read modes ............... 66 7 Sub-channel read data header ............. 67 8 Sub-channel read audio status codes ......... 67 9 Sub-channel CD current position data format .... 67 10 Sub-channel control field of CD current position ... 68 11 Manager keys ..................... 76 12 Monitor commands .................. 100 13 LL format ....................... 115 14 Device status ($90) .................. 122 15 Messages ($9D) .................... 123 16 File numbers ($B8) .................. 125 17 Device numbers ($BA) ................. 126 18 Secondary addresses ($B9) .............. 127 19 Error codes returned by IDEDOS and KERNAL ... 137 20 Direct kernal call replacement table ......... 147 21 Disk init and message display example ........ 148 22 X1541 PCLink cable ................