6502/cc65
1
0
Fork 0
mirror of https://github.com/cc65/cc65.git synced 2024-12-25 17:29:50 +00:00
Code Issues Projects Releases Wiki Activity

Minor updates

Browse Source
This commit is contained in:
Wayne Parham 2022-03-04 06:23:06 -06:00 committed by mrdudz
parent cb322551e5
commit eb25027f7b
2 changed files with 108 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
doc/sym1.sgml
View File

@ -15,21 +15,40 @@ An overview over the Sym-1 runtime system as it is implemented for the cc65 C co
<sect>Overview<p> <sect>Overview<p>
This file contains an overview of the Sym-1 runtime system as it comes with the cc65 C compiler. It describes the memory layout, Sym-1 specific header files, available drivers, and any pitfalls specific to the platform. This file contains an overview of the Sym-1 runtime system as it comes with the cc65 C compiler.
It describes the memory layout, Sym-1 specific header files, available drivers, and any pitfalls
specific to the platform.
Please note that Sym-1 specific functions are just mentioned here, they are described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. Please note that Sym-1 specific functions are just mentioned here, they are described in detail
in the separate <url url="funcref.html" name="function reference">. Even functions marked as
&quot;platform dependent&quot; may be available on more than one platform. Please see the
function reference for more information.
<sect>Binary format<p> <sect>Binary format<p>
The output format generated by the linker for the Sym-1 target is a raw binary BIN file, which is essentially a memory image. You can convert this to a HEX file using BIN2HEX, which is a popular open-source conversion utility program. A HEX file has ASCII representations of the hexadecimal byte values of the machine-language program. So the HEX file can be transferred to the Sym-1 using the RS-232 terminal port, just as if the machine-code was entered by hand. Enter 'm 200' in the monitor and start the HEX file transfer. The output format generated by the linker for the Sym-1 target is a raw binary BIN file, which
is essentially a memory image. You can convert this to a HEX file using BIN2HEX, which is a
popular open-source conversion utility program. A HEX file has ASCII representations of the
hexadecimal byte values of the machine-language program. So the HEX file can be transferred
to the Sym-1 using the RS-232 terminal port, just as if the machine-code was entered by hand.
Enter 'm 200' in the monitor and start the HEX file transfer.
<p> <p>
Included with this distribution is a 4k configuration file and a 32k config file. The Sym-1 on-board memory is limited to 4 kbytes but system memory can be increased to 32 kbytes of contiguous RAM with aftermarket add-on boards. So choose the config file that matches your system configuration before compiling and linking user programs. Included with this distribution is a 4k configuration file and a 32k config file. The Sym-1
on-board memory is limited to 4 kbytes but system memory can be increased to 32 kbytes of
contiguous RAM with aftermarket add-on boards. So choose the config file that matches your
system configuration before compiling and linking user programs.
<sect>Memory layout<p> <sect>Memory layout<p>
The ROMs and I/O areas are defined in the configuration files, as are most of the entry points for useful subroutines in the Sym-1 monitor ROM. cc65 generated programs compiled and linked using 4k config run in the memory range of &dollar;200 - &dollar;0FFF. The 32k config expands this range to &dollar;7FFF. Memory above 32K can be used to extend the heap, as described below. The starting memory location and entry point for running the program is &dollar;200, so when the program is transferred to the Sym-1, it is executed by typing 'g 200'. The system returns control back to the monitor ROM when the program terminates, providing the '.' prompt. The ROMs and I/O areas are defined in the configuration files, as are most of the entry points
for useful subroutines in the Sym-1 monitor ROM. cc65 generated programs compiled and linked
using 4k config run in the memory range of &dollar;200 - &dollar;0FFF. The 32k config expands
this range to &dollar;7FFF. Memory above 32k can be used to extend the heap, as described below.
The starting memory location and entry point for running the program is &dollar;200, so when the
program is transferred to the Sym-1, it is executed by typing 'g 200'. The system returns control
back to the monitor ROM when the program terminates, providing the '.' prompt.
Special locations: Special locations:
@ -38,10 +57,12 @@ Special locations:
Conio support is not currently available for the Sym-1. But stdio console functions are available. Conio support is not currently available for the Sym-1. But stdio console functions are available.
<tag/Stack/ <tag/Stack/
The C runtime stack is located at &dollar;0FFF on 4KB Syms, or at &dollar;7FFF for 32KB systems. The stack always grows downwards. The C runtime stack is located at &dollar;0FFF on 4kb Syms, or at &dollar;7FFF for 32kb systems.
The stack always grows downwards.
<tag/Heap/ <tag/Heap/
The C heap is located at the end of the program and grows towards the C runtime stack. Extended memory can be added to the heap, as described below. The C heap is located at the end of the program and grows towards the C runtime stack. Extended
memory can be added to the heap, as described below.
</descrip><p> </descrip><p>
@ -51,7 +72,8 @@ Programs containing Sym-1 code may use the <tt/sym1.h/ header file. See the hea
<sect1>Hardware access<p> <sect1>Hardware access<p>
The pseudo variables declared in the <tt/sym1.inc/ include file allow access to hardware located in the address space. See the include file for more information. The pseudo variables declared in the <tt/sym1.inc/ include file allow access to hardware located in the
address space. See the include file for more information.
<sect>Loadable drivers<p> <sect>Loadable drivers<p>
@ -61,7 +83,9 @@ No graphics drivers are currently available for the Sym-1.
<sect1>Extended memory drivers<p> <sect1>Extended memory drivers<p>
There are no extended memory drivers for the Sym-1. However, there is a way to access memory beyond the 32k boundary, if memory is physically present in the system. See the example program, symExtendedMemory, in the samples directory. There are no extended memory drivers for the Sym-1. However, there is a way to access memory beyond the
32kb boundary, if extended memory is physically present in the system. See the example program,
symExtendedMemory, in the samples directory.
<sect1>Joystick drivers<p> <sect1>Joystick drivers<p>
@ -73,7 +97,8 @@ No mouse drivers are currently available for the Sym-1.
<sect1>RS232 device drivers<p> <sect1>RS232 device drivers<p>
No communication port drivers are currently available for the Sym-1. It has only the &quot;master console&quot; e.g. stdin and stdout. No communication port drivers are currently available for the Sym-1. It has only the &quot;master console&quot;
e.g. stdin and stdout.
<sect>Limitations<p> <sect>Limitations<p>
@ -94,23 +119,32 @@ To be more specific, this limitation means that you cannot use any of the follow
<sect>Other hints<p> <sect>Other hints<p>
<sect1>sym1.h<p> <sect1>sym1.h<p>
This header exposes Sym-specific I/O functions that are useful for reading and writing its ports and front panel. See the <tt/sym1.h/ include file for a list of the functions available. This header exposes Sym-specific I/O functions that are useful for reading and writing its ports and front panel.
See the <tt/sym1.h/ include file for a list of the functions available.
<sect2>Limited memory applications<p> <sect2>Limited memory applications<p>
As stated earlier, there are config files for 4KB and 32KB systems. If you have 32KB RAM, then you will probably want to use the sym1-32k configuration, but if not - if you are using the sym1-4k configuration - then you may want to use functions like getchar, putchar, gets and puts rather than functions like scanf and printf. Printf, for example, requires about 1KB because it needs to know how to process all the format specifiers. As stated earlier, there are config files for 4kb and 32kb systems. If you have 32kb RAM, then you will probably
want to use the sym1-32k configuration, but if not - if you are using the sym1-4k configuration - then you may
want to use functions like getchar, putchar, gets and puts rather than functions like scanf and printf.
Printf, for example, requires about 1KB because it needs to know how to process all the format specifiers.
<sect3>Using extended memory<p> <sect3>Using extended memory<p>
Memory may be physically present that is addressed at locations above the monitor ROM at $8000. This extended memory is accessible by adding to the heap, as described in the symExtendedMemory sample program. Memory may be physically present that is addressed at locations above the monitor ROM at $8000. This extended
memory is accessible by adding to the heap, as described in the symExtendedMemory sample program.
<sect4>Sample programs<p> <sect4>Sample programs<p>
All the samples will run on the &quot;stock&quot; 4KB Sym-1, except for symIO and symNotepad, which require 32KB. Additionally, symExtendedMemory shows how to access memory above 32KB, so it expects more than 32KB. These sample programs can be found in the samples/sym1 directory: All the samples will run on the &quot;stock&quot; 4kb Sym-1, except for symIO and symNotepad, which require 32kb.
Additionally, symExtendedMemory shows how to access memory above 32kb, so it expects more than 32kb.
These sample programs can be found in the samples/sym1 directory:
<itemize> <itemize>
<item>symHello prints &quot;Hello World!&quot; and then inputs characters, which are echoed on the screen. It also makes a &quot;beep&quot; sound.</item> <item>symHello prints &quot;Hello World!&quot; and then inputs characters, which are echoed on the screen.
<item>symTiny does the same as symHello, but does it with puts() rather than printf() to show the difference in compiled binary size.</item> It also makes a &quot;beep&quot; sound.</item>
<item>symTiny does the same as symHello, but does it with puts() rather than printf() to show the difference
in compiled binary size.</item>
<item>symDisplay allows entry of a message, which is then displayed by scrolling it across the front panel display.</item> <item>symDisplay allows entry of a message, which is then displayed by scrolling it across the front panel display.</item>
<item>symIO allows access to the Sym-1 digital I/O ports.</item> <item>symIO allows access to the Sym-1 digital I/O ports.</item>
<item>symNotepad is a simple text entry/retrieval program that uses tape storage.</item> <item>symNotepad is a simple text entry/retrieval program that uses tape storage.</item>
@ -119,9 +153,11 @@ All the samples will run on the &quot;stock&quot; 4KB Sym-1, except for symIO an
<sect>License<p> <sect>License<p>
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. 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: 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:
<enum> <enum>
<item> The origin of this software must not be misrepresented; you must not <item> The origin of this software must not be misrepresented; you must not

102
samples/sym1/symExtendedMemory.c
View File

@ -26,12 +26,13 @@
#include <stdlib.h> #include <stdlib.h>
#include <string.h> #include <string.h>
#define SEGMENT 0x9000 // First 4K segment of extended memory #define STD_MEM 0x7FFF // Last address of standard memory
#define SEG_END 0x0FFF // Last location of segment #define SEGMENT 0x9000 // First 4K segment of extended memory
#define BLOCK_SIZE 0x1000 // Size of segment #define SEG_END 0x0FFF // Last location of segment
#define TOP_END 0x0F7F // Last location of memory #define BLOCK_SIZE 0x1000 // Size of segment
#define TOP_SIZE 0x0F80 // Size of top segment #define TOP_END 0x0F7F // Last location of memory
#define UNAVAILABLE 0xA000 // System I/O area #define TOP_SIZE 0x0F80 // Size of top segment
#define UNAVAILABLE 0xA000 // System I/O area
int main (void) { int main (void) {
int error = 0; int error = 0;
@ -44,49 +45,54 @@ int main (void) {
printf ( "Main memory has %u bytes available.\n", heap_size ); printf ( "Main memory has %u bytes available.\n", heap_size );
while ( (int) segment < 0xEFFF ) { // Iterate through 4K memory blocks if ( heap_size > STD_MEM ) {
if( (int) segment != UNAVAILABLE ) { printf ( "Extended memory already installed.\n" );
segment[0] = 0x00; // Check beginning of segment } else {
if ( segment[0] != 0x00 )
error = 1;
segment[0] = 0xFF;
if ( segment[0] != 0xFF )
error = 1;
segment[SEG_END] = 0x00; // Check end of segment
if ( segment[SEG_END] != 0x00 )
error = 1;
segment[SEG_END] = 0xFF;
if ( segment[SEG_END] != 0xFF )
error = 1;
if ( ! error ) { // If memory found, add to the heap
printf ( "Memory found at location %p, ", segment );
_heapadd ( segment, BLOCK_SIZE );
heap_size = _heapmemavail();
printf( "so the system now has %u bytes available.\n", heap_size );
} else {
error = 0;
}
}
segment += 0x1000; // Increment to next segment
}
segment[0] = 0x00; // Check beginning of top memory segment while ( (int) segment < 0xEFFF ) { // Iterate through 4K memory blocks
if ( segment[0] != 0x00 ) if( (int) segment != UNAVAILABLE ) {
error = 1; segment[0] = 0x00; // Check beginning of segment
segment[0] = 0xFF; if ( segment[0] != 0x00 )
if ( segment[0] != 0xFF ) error = 1;
error = 1; segment[0] = 0xFF;
segment[TOP_END] = 0x00; // Check end of usable memory if ( segment[0] != 0xFF )
if ( segment[TOP_END] != 0x00 ) error = 1;
error = 1; segment[SEG_END] = 0x00; // Check end of segment
segment[TOP_END] = 0xFF; if ( segment[SEG_END] != 0x00 )
if ( segment[TOP_END] != 0xFF ) error = 1;
error = 1; segment[SEG_END] = 0xFF;
if ( ! error ) { // If memory found, add to the heap if ( segment[SEG_END] != 0xFF )
printf ( "Memory found at location %p, ", segment ); error = 1;
_heapadd ( segment, TOP_SIZE ); if ( ! error ) { // If memory found, add to the heap
heap_size = _heapmemavail(); printf ( "Memory found at location %p, ", segment );
printf( "so the system now has %u bytes available.\n", heap_size ); _heapadd ( segment, BLOCK_SIZE );
heap_size = _heapmemavail();
printf( "so the system now has %u bytes available.\n", heap_size );
} else {
error = 0;
}
}
segment += 0x1000; // Increment to next segment
}
segment[0] = 0x00; // Check beginning of top memory segment
if ( segment[0] != 0x00 )
error = 1;
segment[0] = 0xFF;
if ( segment[0] != 0xFF )
error = 1;
segment[TOP_END] = 0x00; // Check end of usable memory
if ( segment[TOP_END] != 0x00 )
error = 1;
segment[TOP_END] = 0xFF;
if ( segment[TOP_END] != 0xFF )
error = 1;
if ( ! error ) { // If memory found, add to the heap
printf ( "Memory found at location %p, ", segment );
_heapadd ( segment, TOP_SIZE );
heap_size = _heapmemavail();
printf( "so the system now has %u bytes available.\n", heap_size );
}
} }
puts ("\nEnjoy your day!\n"); puts ("\nEnjoy your day!\n");