git.sur5r.net Git - cc65/blob - include/cbm.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                   cbm.h                                   */
   4 /*                                                                           */
   5 /*                      CBM system-specific definitions                      */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2012, 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
  50 #if !defined(_STDDEF_H)
  51 #  include <stddef.h>
  52 #endif
  53
  54 /* Load the system-specific files here, if needed. */
  55 #if   defined(__C64__)    && !defined(_C64_H)
  56 #  include <c64.h>
  57 #elif defined(__VIC20__)  && !defined(_VIC20_H)
  58 #  include <vic20.h>
  59 #elif defined(__C128__)   && !defined(_C128_H)
  60 #  include <c128.h>
  61 #elif defined(__PLUS4__)  && !defined(_PLUS4_H)
  62 #  include <plus4.h>
  63 #elif defined(__C16__)    && !defined(_C16_H)
  64 #  include <c16.h>
  65 #elif defined(__CBM510__) && !defined(_CBM510_H)
  66 #  include <cbm510.h>
  67 #elif defined(__CBM610__) && !defined(_CBM610_H)
  68 #  include <cbm610.h>
  69 #elif defined(__PET__)    && !defined(_PET_H)
  70 #  include <pet.h>
  71 #endif
  72
  73
  74
  75 /*****************************************************************************/
  76 /*                                 Variables                                 */
  77 /*****************************************************************************/
  78
  79
  80
  81 /* The file stream implementation and the POSIX I/O functions will use the
  82  * following variables to determine the file type and the disk unit to use.
  83  */
  84 extern unsigned char _curunit;  /* Defaults to current when program started */
  85 extern char _filetype;          /* Defaults to 'u' */
  86
  87
  88
  89 /*****************************************************************************/
  90 /*                       Character-codes (CBM charset)                       */
  91 /*****************************************************************************/
  92
  93
  94
  95 #define CH_HLINE        192
  96 #define CH_VLINE        221
  97 #define CH_ULCORNER     176
  98 #define CH_URCORNER     174
  99 #define CH_LLCORNER     173
 100 #define CH_LRCORNER     189
 101 #define CH_TTEE         178
 102 #define CH_BTEE         177
 103 #define CH_LTEE         171
 104 #define CH_RTEE         179
 105 #define CH_CROSS        219
 106 #define CH_CURS_UP      145
 107 #define CH_CURS_DOWN     17
 108 #define CH_CURS_LEFT    157
 109 #define CH_CURS_RIGHT    29
 110 #define CH_PI           222
 111 #define CH_HOME          19
 112 #define CH_DEL           20
 113 #define CH_INS          148
 114 #define CH_ENTER         13
 115 #define CH_STOP           3
 116 #define CH_LIRA          92
 117 #define CH_ESC           27
 118
 119
 120
 121 /*****************************************************************************/
 122 /*                Definitions for directory reading functions                */
 123 /*****************************************************************************/
 124
 125
 126
 127 /* CBM FILE TYPES */
 128 #define CBM_T_DEL    0
 129 #define CBM_T_SEQ    1
 130 #define CBM_T_PRG    2
 131 #define CBM_T_USR    3
 132 #define CBM_T_REL    4
 133 #define CBM_T_CBM    5          /* 1581 sub-partition */
 134 #define CBM_T_DIR    6          /* IDE64 and CMD sub-directory */
 135 #define CBM_T_LNK    7          /* IDE64 soft-link */
 136 #define CBM_T_VRP    8          /* Vorpal fast-loadable format */
 137 #define CBM_T_OTHER  9          /* File-type not recognized */
 138 #define CBM_T_HEADER 10         /* Disk header / title */
 139
 140 /* CBM FILE ACCESS */
 141 #define CBM_A_RO    1           /* Read only   */
 142 #define CBM_A_WO    2           /* Write only  */
 143 #define CBM_A_RW    3           /* Read, Write */
 144
 145 struct cbm_dirent {
 146              char name[17];     /* File name in PetSCII, limited to 16 chars */
 147     unsigned int  size;         /* Size, in 254-/256-byte blocks */
 148     unsigned char type;
 149     unsigned char access;
 150 };
 151
 152 unsigned char __fastcall__ _cbm_filetype (unsigned char c);
 153 /* Map the start character for a file type to one of the file types above.
 154  * Note: 'd' will always mapped to CBM_T_DEL. The calling function has to
 155  * look at the following character to determine if the file type is actually
 156  * CBM_T_DIR.
 157  * This is a function used by the implementation. There is usually no need
 158  * to call it from user code.
 159  */
 160
 161
 162 /*****************************************************************************/
 163 /*                               Machine info                                */
 164 /*****************************************************************************/
 165
 166
 167
 168 #define TV_NTSC         0
 169 #define TV_PAL          1
 170 #define TV_OTHER        2
 171
 172 unsigned char get_tv (void);
 173 /* Return the video mode the machine is using. */
 174
 175
 176
 177 /*****************************************************************************/
 178 /*                           CBM kernal functions                            */
 179 /*****************************************************************************/
 180
 181
 182
 183 /* Constants to use with cbm_open() for openning a file for reading or
 184  * writing without the need to append ",r" or ",w" to the filename.
 185  *
 186  * e.g., cbm_open(2, 8, CBM_READ, "0:data,s");
 187  */
 188 #define CBM_READ        0       /* default is ",p" */
 189 #define CBM_WRITE       1       /* ditto */
 190 #define CBM_SEQ         2       /* default is ",r" -- or ",s" when writing */
 191
 192 /* Kernal-level functions */
 193 void __fastcall__ cbm_k_setlfs (unsigned char LFN, unsigned char DEV,
 194                                 unsigned char SA);
 195 void __fastcall__ cbm_k_setnam (const char* Name);
 196 unsigned int __fastcall__ cbm_k_load(unsigned char flag, unsigned addr);
 197 unsigned char __fastcall__ cbm_k_save(unsigned int start, unsigned int end);
 198 unsigned char cbm_k_open (void);
 199 void __fastcall__ cbm_k_close (unsigned char FN);
 200 signed char cbm_k_readst (void);
 201 unsigned char __fastcall__ cbm_k_chkin (unsigned char FN);
 202 unsigned char __fastcall__ cbm_k_ckout (unsigned char FN);
 203 unsigned char cbm_k_basin (void);
 204 unsigned char cbm_k_getin (void);
 205 void __fastcall__ cbm_k_bsout (unsigned char C);
 206 void cbm_k_clrch (void);
 207 void cbm_clall (void);
 208
 209
 210
 211 /*****************************************************************************/
 212 /*                       BASIC-like file I/O functions                       */
 213 /*****************************************************************************/
 214
 215
 216
 217 /* The cbm_* I/O functions below set _oserror (see errno.h),
 218  * in case of an error.
 219  *
 220  * error-code   BASIC error
 221  * ----------   -----------
 222  *       1  =   too many files
 223  *       2  =   file open
 224  *       3  =   file not open
 225  *       4  =   file not found
 226  *       5  =   device not present
 227  *       6  =   not input-file
 228  *       7  =   not output-file
 229  *       8  =   missing file-name
 230  *       9  =   illegal device-number
 231  *
 232  *      10  =   STOP-key pushed
 233  *      11  =   general I/O-error
 234  */
 235
 236
 237
 238 unsigned int cbm_load (const char* name, unsigned char device, void* data);
 239 /* Loads file "name", from given device, to given address -- or, to the load
 240  * address of the file if "data" is the null pointer (like load"name",8,1
 241  * in BASIC).
 242  * Returns number of bytes that were loaded if loading was successful;
 243  * otherwise 0, "_oserror" contains an error-code, then (see table above).
 244  */
 245
 246 unsigned char __fastcall__ cbm_save (const char* name, unsigned char device,
 247                                      const void* addr, unsigned int size);
 248 /* Saves "size" bytes, starting at "addr", to a file.
 249  * Returns 0 if saving was successful, otherwise an error-code (see table
 250  * above).
 251  */
 252
 253 unsigned char __fastcall__ cbm_open (unsigned char lfn, unsigned char device,
 254                                      unsigned char sec_addr, const char* name);
 255 /* Opens a file. Works just like the BASIC command.
 256  * Returns 0 if openning was successful, otherwise an error-code (see table
 257  * above).
 258  */
 259
 260 void __fastcall__ cbm_close (unsigned char lfn);
 261 /* Closes a file */
 262
 263 int __fastcall__ cbm_read (unsigned char lfn, void* buffer, unsigned int size);
 264 /* Reads up to "size" bytes from a file into "buffer".
 265  * Returns the number of actually-read bytes, 0 if there are no bytes left.
 266  * -1 in case of an error; then, _oserror contains an error-code (see table
 267  * above).  (Remember:  0 means end-of-file; -1 means error.)
 268  */
 269
 270 int __fastcall__ cbm_write (unsigned char lfn, const void* buffer,
 271                             unsigned int size);
 272 /* Writes up to "size" bytes from "buffer" to a file.
 273  * Returns the number of actually-written bytes, or -1 in case of an error;
 274  * _oserror contains an error-code, then (see above table).
 275  */
 276
 277 unsigned char __fastcall__ cbm_opendir (unsigned char lfn, unsigned char device);
 278 /* Opens directory listing.
 279  * Returns 0 if openning directory was successful;
 280  * otherwise, an error-code corresponding to cbm_open().
 281  */
 282
 283 unsigned char __fastcall__ cbm_readdir (unsigned char lfn,
 284                                         struct cbm_dirent* l_dirent);
 285 /* Reads one directory line into cbm_dirent structure.
 286  * Returns 0 if reading directory-line was successful.
 287  * Returns non-zero if reading directory failed, or no more file-names to read.
 288  * Returns 2 on last line.  Then, l_dirent->size = the number of "blocks free."
 289  */
 290
 291 void __fastcall__ cbm_closedir (unsigned char lfn);
 292 /* Closes directory by cbm_close(lfn) */
 293
 294
 295
 296 /* End of cbm.h */
 297 #endif
 298
 299