# Commodore 16/116 specific information for cc65

## Ullrich von Bassewitz

An overview over the C16 runtime system as it is implemented for the cc65 C compiler.

## 1. Overview

## 2. Binary format

## 3. Memory layout

## 4. Platform specific header files

- 4.1 C16/C116 specific functions
- 4.2 CBM specific functions
- 4.3 CBM specific CPU functions
- 4.4 Hardware access

## 5. Loadable drivers

- 5.1 Graphics drivers
- 5.2 Extended memory drivers
- 5.3 Joystick drivers
- 5.4 Mouse drivers
- 5.5 RS232 device drivers

## 6. Limitations

## 7. Other hints

- 7.1 Passing arguments to the program
- 7.2 Program return code
- 7.3 Interrupts

## 8. License

## 1. Overview

This file contains an overview of the C16 runtime system as it comes with the cc65 C compiler. It describes the memory layout, C16/116 specific header files, available drivers, and any pitfalls specific to that platform.

Please note that C16 specific functions are just mentioned here, they are described in detail in the separate function reference. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information.

Since the C16/C116 and the Commodore Plus/4 are almost identical (the former don't have the 6551 ACIA and only 16KB of memory), the Plus/4 documentation is also worth a look. The difference between both cc65 targets is that the Plus/4 runtime uses banking to support full 64K RAM, while the C16 does not use banking and supports up to 32K RAM. Because banking is not needed, most C16 programs will be somewhat smaller than the same program compiled for the Plus/4. However, programs C16 will always run on the Plus/4, while the reverse is not necessarily true.

## 2. Binary format

The standard binary output format generated by the linker for the C16/116 target is a machine language program with a one line BASIC stub which, calls the machine language part via SYS. This means that a program can be loaded as BASIC program and started with RUN. It is of course possible to change this behaviour by using a modified startup file and linker config.

## 3. Memory layout

cc65 generated programs with the default setup run with the kernal and basic banked in. This gives a usable memory range of $1000 - $4000 (or $8000 if the machine is equipped with 32K RAM or more). Having the kernal and basic ROMs banked in means, that ROM entry points may be called directly from user code.

Special locations:

Text screen

  The text screen is located at $C00 (as in the standard setup).

Color RAM

  The color RAM is located at $800 (standard location).

Stack

  The C runtime stack is located at $3FFF ($7FFF in case of a machine with 32K of memory or more) and growing downwards.

Heap

  The C heap is located at the end of the program and grows towards the C runtime stack.

## 4. Platform specific header files

Programs containing C16 specific code may use the `c16.h` or `cbm.h` header files. Using the later may be an option when writing code for more than one CBM platform, since it includes `c16.h` and declares several functions common to all CBM platforms.

Please note that most of the header file declarations from the `c16.h` header file are shared between the C16 and Plus/4 configurations. For this reason, most of it is located in a common header file named `cbm264.h`.

## 4.1 C16/C116 specific functions

There are currently no special C16/C116 functions.

## 4.2 CBM specific functions

Some functions are available for all (or at least most) of the Commodore machines. See the function reference for declaration and usage.

- cbm_close
- cbm_closedir
- cbm_k_setlfs
- cbm_k_setnam
- cbm_k_load
- cbm_k_save
- cbm_k_open
- cbm_k_close
- cbm_k_readst
- cbm_k_chkin
- cbm_k_ckout
- cbm_k_basin
- cbm_k_bsout
- cbm_k_clrch
- cbm_k_tksa
- cbm_k_second
- cbm_load
- cbm_open
- cbm_opendir
- cbm_read
- cbm_readdir
- cbm_save
- cbm_write
- get_tv
- waitvsync

## 4.3 CBM specific CPU functions

Some CPU related functions are available for some of the Commodore machines. See the function reference for declaration and usage.

- fast
- slow
- isfast

## 4.4 Hardware access

The following pseudo variables declared in the `c16.h` header file do allow access to hardware located in the address space. Some variables are structures, accessing the struct fields will access the chip registers.

`TED`

  The `TED` structure allows access to the TED chip. See the `_ted.h` header file located in the include directory for the declaration of the structure.

`COLOR_RAM`

  A character array that mirrors the color RAM of the C16 at $0800.

## 5. Loadable drivers

The names in the parentheses denote the symbols to be used for static linking of the drivers.

## 5.1 Graphics drivers

No graphics drivers are currently available for the C16/C116.

## 5.2 Extended memory drivers

`c16-ram.emd (c16_ram_emd)`

  A driver for the hidden RAM below the BASIC and KERNAL ROMs. Supports 125 pages with 256 bytes each if the machine is equipped with 64K of memory (a Plus/4 or a memory extended C16/116).

## 5.3 Joystick drivers

`c16-stdjoy.joy (c16_stdjoy_joy)`

  Supports up to two joysticks connected to the standard joysticks port of the Commodore 16/116.

## 5.4 Mouse drivers

No mouse drivers are currently available for the C16/C116.

## 5.5 RS232 device drivers

The Commodore 16 does not have a builtin ACIA and no RS232 extensions are known. For this reason, there are no RS232 drivers available. Please note that the standard Plus/4 driver will not run together with the C16 library, because the latter does not support interrupts needed by the driver.

## 6. Limitations

## 7. Other hints

## 7.1 Passing arguments to the program

Command line arguments can be passed to `main()`. Since this is not supported by BASIC, the following syntax was chosen:

> `

>         RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5

> `

1. Arguments are separated by spaces.
2. Arguments may be quoted.
3. Leading and trailing spaces around an argument are ignored. Spaces within a quoted argument are allowed.
4. The first argument passed to `main` is the program name.
5. A maximum number of 10 arguments (including the program name) are supported.

## 7.2 Program return code

The program return code (low byte) is passed back to BASIC by use of the `ST` variable.

## 7.3 Interrupts

The runtime for the C16 uses routines marked as `.INTERRUPTOR` for interrupt handlers. Such routines must be written as simple machine language subroutines and will be called automatically by the interrupt handler code when they are linked into a program. See the discussion of the `.CONDES` feature in the assembler manual.

## 8. License

This software is provided 'as-is', without any expressed or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.