1 /*****************************************************************************/ 2 /* */ 3 /* cbm.h */ 4 /* */ 5 /* CBM system-specific definitions */ 6 /* */ 7 /* */ 8 /* */ 9 /* (C) 1998-2015, Ullrich von Bassewitz */ 10 /* Roemerstrasse 52 */ 11 /* D-70794 Filderstadt */ 12 /* EMail: uz@cc65.org */ 13 /* */ 14 /* */ 15 /* This software is provided 'as-is', without any expressed or implied */ 16 /* warranty. In no event will the authors be held liable for any damages */ 17 /* arising from the use of this software. */ 18 /* */ 19 /* Permission is granted to anyone to use this software for any purpose, */ 20 /* including commercial applications, and to alter it and redistribute it */ 21 /* freely, subject to the following restrictions: */ 22 /* */ 23 /* 1. The origin of this software must not be misrepresented; you must not */ 24 /* claim that you wrote the original software. If you use this software */ 25 /* in a product, an acknowledgment in the product documentation would be */ 26 /* appreciated but is not required. */ 27 /* 2. Altered source versions must be plainly marked as such, and must not */ 28 /* be misrepresented as being the original software. */ 29 /* 3. This notice may not be removed or altered from any source */ 30 /* distribution. */ 31 /* */ 32 /*****************************************************************************/ 33 34 35 36 #ifndef _CBM_H 37 #define _CBM_H 38 39 40 41 /* Check for errors */ 42 #if !defined(__CBM__) 43 # error This module may be used only when compiling for CBM machines! 44 #endif 45 46 47 48 /* We need NULL. */ 49 #include <stddef.h> 50 51 /* Load the system-specific files here, if needed. */ 52 #if defined(__C64__) && !defined(_C64_H) 53 # include <c64.h> 54 #elif defined(__VIC20__) && !defined(_VIC20_H) 55 # include <vic20.h> 56 #elif defined(__C128__) && !defined(_C128_H) 57 # include <c128.h> 58 #elif defined(__PLUS4__) && !defined(_PLUS4_H) 59 # include <plus4.h> 60 #elif defined(__C16__) && !defined(_C16_H) 61 # include <c16.h> 62 #elif defined(__CBM510__) && !defined(_CBM510_H) 63 # include <cbm510.h> 64 #elif defined(__CBM610__) && !defined(_CBM610_H) 65 # include <cbm610.h> 66 #elif defined(__PET__) && !defined(_PET_H) 67 # include <pet.h> 68 #elif defined(__CX16__) && !defined(_CX16_H) 69 # include <cx16.h> 70 #endif 71 72 /* Include definitions for CBM file types */ 73 #include <cbm_filetype.h> 74 75 76 77 #define JOY_FIRE_MASK JOY_BTN_1_MASK 78 #define JOY_FIRE(v) ((v) & JOY_FIRE_MASK) 79 80 81 82 /*****************************************************************************/ 83 /* Variables */ 84 /*****************************************************************************/ 85 86 87 88 /* The file stream implementation and the POSIX I/O functions will 89 ** use the following variable to determine the file type to use. 90 */ 91 extern char _filetype; /* Defaults to 's' */ 92 93 94 95 /*****************************************************************************/ 96 /* Character-codes (CBM charset) */ 97 /*****************************************************************************/ 98 99 100 101 #define CH_HLINE 192 102 #define CH_VLINE 221 103 #define CH_ULCORNER 176 104 #define CH_URCORNER 174 105 #define CH_LLCORNER 173 106 #define CH_LRCORNER 189 107 #define CH_TTEE 178 108 #define CH_BTEE 177 109 #define CH_LTEE 171 110 #define CH_RTEE 179 111 #define CH_CROSS 219 112 #define CH_CURS_UP 145 113 #define CH_CURS_DOWN 17 114 #define CH_CURS_LEFT 157 115 #define CH_CURS_RIGHT 29 116 #define CH_PI 222 117 #define CH_HOME 19 118 #define CH_DEL 20 119 #define CH_INS 148 120 #define CH_ENTER 13 121 #define CH_STOP 3 122 #define CH_LIRA 92 123 #define CH_ESC 27 124 #define CH_FONT_LOWER 14 125 #define CH_FONT_UPPER 142 126 127 128 129 /*****************************************************************************/ 130 /* Definitions for directory reading functions */ 131 /*****************************************************************************/ 132 133 134 135 /* CBM FILE ACCESS */ 136 #define CBM_A_RO 1 /* Read only */ 137 #define CBM_A_WO 2 /* Write only */ 138 #define CBM_A_RW 3 /* Read, Write */ 139 140 struct cbm_dirent { 141 char name[17]; /* File name in PetSCII, limited to 16 chars */ 142 unsigned int size; /* Size, in 254-/256-byte blocks */ 143 unsigned char type; 144 unsigned char access; 145 }; 146 147 148 149 /*****************************************************************************/ 150 /* Machine info */ 151 /*****************************************************************************/ 152 153 154 155 #define TV_NTSC 0 156 #define TV_PAL 1 157 #define TV_OTHER 2 158 159 unsigned char get_tv (void); 160 /* Return the video mode the machine is using. */ 161 162 #define KBREPEAT_CURSOR 0x00 163 #define KBREPEAT_NONE 0x40 164 #define KBREPEAT_ALL 0x80 165 166 unsigned char __fastcall__ kbrepeat (unsigned char mode); 167 /* Changes which keys have automatic repeat. */ 168 169 #if !defined(__CBM610__) && !defined(__PET__) 170 void waitvsync (void); 171 /* Wait for the start of the next video field. */ 172 #endif 173 174 /*****************************************************************************/ 175 /* CBM kernal functions */ 176 /*****************************************************************************/ 177 178 179 180 /* Constants to use with cbm_open() for openning a file for reading or 181 ** writing without the need to append ",r" or ",w" to the filename. 182 ** 183 ** e.g., cbm_open(2, 8, CBM_READ, "0:data,s"); 184 */ 185 #define CBM_READ 0 /* default is ",p" */ 186 #define CBM_WRITE 1 /* ditto */ 187 #define CBM_SEQ 2 /* default is ",r" -- or ",s" when writing */ 188 189 /* Kernal-level functions */ 190 unsigned char cbm_k_acptr (void); 191 unsigned char cbm_k_basin (void); 192 void __fastcall__ cbm_k_bsout (unsigned char C); 193 unsigned char __fastcall__ cbm_k_chkin (unsigned char FN); 194 void __fastcall__ cbm_k_ciout (unsigned char C); 195 unsigned char __fastcall__ cbm_k_ckout (unsigned char FN); 196 void cbm_k_clall (void); 197 void __fastcall__ cbm_k_close (unsigned char FN); 198 void cbm_k_clrch (void); 199 unsigned char cbm_k_getin (void); 200 unsigned cbm_k_iobase (void); 201 void __fastcall__ cbm_k_listen (unsigned char dev); 202 unsigned int __fastcall__ cbm_k_load(unsigned char flag, unsigned addr); 203 unsigned char cbm_k_open (void); 204 unsigned char cbm_k_readst (void); 205 unsigned char __fastcall__ cbm_k_save(unsigned int start, unsigned int end); 206 void cbm_k_scnkey (void); 207 void __fastcall__ cbm_k_second (unsigned char addr); 208 void __fastcall__ cbm_k_setlfs (unsigned char LFN, unsigned char DEV, 209 unsigned char SA); 210 void __fastcall__ cbm_k_setnam (const char* Name); 211 void __fastcall__ cbm_k_settim (unsigned long timer); 212 void __fastcall__ cbm_k_talk (unsigned char dev); 213 void __fastcall__ cbm_k_tksa (unsigned char addr); 214 void cbm_k_udtim (void); 215 void cbm_k_unlsn (void); 216 void cbm_k_untlk (void); 217 218 219 220 /*****************************************************************************/ 221 /* BASIC-like file I/O functions */ 222 /*****************************************************************************/ 223 224 225 226 /* The cbm_* I/O functions below set _oserror (see errno.h), 227 ** in case of an error. 228 ** 229 ** error-code BASIC error 230 ** ---------- ----------- 231 ** 1 = too many files 232 ** 2 = file open 233 ** 3 = file not open 234 ** 4 = file not found 235 ** 5 = device not present 236 ** 6 = not input-file 237 ** 7 = not output-file 238 ** 8 = missing file-name 239 ** 9 = illegal device-number 240 ** 241 ** 10 = STOP-key pushed 242 ** 11 = general I/O-error 243 */ 244 245 246 247 unsigned int __fastcall__ cbm_load (const char* name, unsigned char device, void* data); 248 /* Loads file "name", from given device, to given address -- or, to the load 249 ** address of the file if "data" is the null pointer (like load"name",8,1 250 ** in BASIC). 251 ** Returns number of bytes that were loaded if loading was successful; 252 ** otherwise 0, "_oserror" contains an error-code, then (see table above). 253 */ 254 255 unsigned char __fastcall__ cbm_save (const char* name, unsigned char device, 256 const void* addr, unsigned int size); 257 /* Saves "size" bytes, starting at "addr", to a file. 258 ** Returns 0 if saving was successful, otherwise an error-code (see table 259 ** above). 260 */ 261 262 unsigned char __fastcall__ cbm_open (unsigned char lfn, unsigned char device, 263 unsigned char sec_addr, const char* name); 264 /* Opens a file. Works just like the BASIC command. 265 ** Returns 0 if openning was successful, otherwise an error-code (see table 266 ** above). 267 */ 268 269 void __fastcall__ cbm_close (unsigned char lfn); 270 /* Closes a file */ 271 272 int __fastcall__ cbm_read (unsigned char lfn, void* buffer, unsigned int size); 273 /* Reads up to "size" bytes from a file into "buffer". 274 ** Returns the number of actually-read bytes, 0 if there are no bytes left. 275 ** -1 in case of an error; then, _oserror contains an error-code (see table 276 ** above). (Remember: 0 means end-of-file; -1 means error.) 277 */ 278 279 int __fastcall__ cbm_write (unsigned char lfn, const void* buffer, 280 unsigned int size); 281 /* Writes up to "size" bytes from "buffer" to a file. 282 ** Returns the number of actually-written bytes, or -1 in case of an error; 283 ** _oserror contains an error-code, then (see above table). 284 */ 285 286 unsigned char cbm_opendir (unsigned char lfn, unsigned char device, ...); 287 /* Opens directory listing. Returns 0 if opening directory was successful; 288 ** otherwise, an error-code corresponding to cbm_open(). As an optional 289 ** argument, the name of the directory may be passed to the function. If 290 ** no explicit name is specified, "$" is used. 291 */ 292 293 unsigned char __fastcall__ cbm_readdir (unsigned char lfn, 294 struct cbm_dirent* l_dirent); 295 /* Reads one directory line into cbm_dirent structure. 296 ** Returns 0 if reading directory-line was successful. 297 ** Returns non-zero if reading directory failed, or no more file-names to read. 298 ** Returns 2 on last line. Then, l_dirent->size = the number of "blocks free." 299 */ 300 301 void __fastcall__ cbm_closedir (unsigned char lfn); 302 /* Closes directory by cbm_close(lfn) */ 303 304 305 306 /* End of cbm.h */ 307 #endif 308