Dseg.mac - Revision history

Mr z: Protected "Dseg.mac" ([edit=autoconfirmed] (indefinite) [move=autoconfirmed] (indefinite))

2010-12-04T08:20:07Z

Protected "Dseg.mac" ([edit=autoconfirmed] (indefinite) [move=autoconfirmed] (indefinite))

Mr z at 15:08, 16 September 2008

2008-09-16T15:08:08Z

Mr z: /* Functions Provided */

2008-09-07T04:42:12Z

‎Functions Provided

Mr z at 04:41, 7 September 2008

2008-09-07T04:41:55Z

Mr z at 04:08, 7 September 2008

2008-09-07T04:08:22Z

Mr z: /* Notes */

2008-09-07T04:07:27Z

‎Notes

Mr z at 04:06, 7 September 2008

2008-09-07T04:06:45Z

New page

[[Category:Programming]] [[Category:Library]]

= Functions Provided =

<CENTER><TABLE BORDER><TR><TH>Entry point</TH><TH>Function provided</TH><TH>Notes</TH></TR>
<TR><TD>SCRATCH</TD><TD>Allocate storage in 8-bit [[Scratchpad RAM]]</TD><TD>Allocated range will be in 8-bit memory from $102 - $1EF.</TD></TR>
<TR><TD>SYSTEM</TD><TD>Allocate storage in 16-bit [[System RAM]]</TD><TD>Allocated range will be in 16-bit memory from $2F0 - $35F.</TD></TR></TABLE></CENTER>
 
See source code below for calling convention. 

= Examples =

(todo... please contribute!)

= Notes =

These routines expect to have sole authority over how the 8-bit [[Scratchpad RAM]] and 16-bit [[System RAM]] are allocated. They are not compatible with programs that use the [[Executive ROM|EXEC]], as the EXEC reserves some of these locations to itself. The SCRATCH macro does not disturb the interrupt service vector at $100 - $101. 

When using this scheme, you should use the SYSTEM macro to declare a stack, and set the [[CP-1610#Registers|stack pointer (R6)]] to point to this stack early in your initialization. For instance: 

<pre>
STACK SYSTEM 32 ; Reserve 32 words of stack space
MVII #STACK, R6 ; Initialize stack pointer
</pre>

Note that you will lose the previous contents of your stack when you do this, which is why it should be one of the first things you do in your initialization. 

To get an idea of how much Scratchpad RAM and System RAM your program uses, look for the symbols ".SCRMEM" and ".SYSMEM" in the assembler listing file or symbol dump file. .SCRMEM indicates the first free location of Scratchpad RAM, and .SYSMEM indicates the first free location of System RAM. The macros allocate from the bottom of memory toward the top. Therefore, $1F0 - .SCRMEM gives the remaining amount of 8-bit Scratchpad RAM, and $360 - .SYSMEM gives the remaining amount of 16-bit System RAM. 

= Source Code =

<pre>
;* ======================================================================== *;
;* These routines are placed into the public domain by their author. All *;
;* copyright rights are hereby relinquished on the routines and data in *;
;* this file. -- Joseph Zbiciak, 2008 *;
;* ======================================================================== *;
IF (DEFINED _DSEG_MAC) == 0
_DSEG_MAC EQU 1

;; ======================================================================== ;;
;; SCRATCH Declare a variable in 8-bit (scratch) memory ;;
;; SYSTEM Declare a variable in 16-bit (system) memory ;;
;; ;;
;; These macros provide a convenient method for declaring variables in the ;;
;; Intellivision's internal memory. Rather than rely on EQUs and one's ;;
;; own memory, you can use these macros to declare your variables in RAM. ;;
;; ;;
;; Both work identically, with the only difference being which pool of ;;
;; memory the variable gets allocated in. SCRATCH allocates storage in ;;
;; 8-bit memory at $102 through $1EF. SYSTEM allocates storage in 16-bit ;;
;; memory at $2F0 through $35F. ;;
;; ;;
;; Both macros expect to own the entire pool. If you manually allocate ;;
;; some addresses in either range and use these macros, the two may clash. ;;
;; You will need to adapt these to skip those addresses, or change the ;;
;; manual allocations to use these macros. ;;
;; ;;
;; USAGE ;;
;; ;;
;; label SCRATCH len ;;
;; label SYSTEM len ;;
;; ;;
;; where 'label' is the name of the label to associate with the memory ;;
;; range, and 'len' is how many locations to set aside (typically 1). ;;
;; ;;
;; EXAMPLES ;;
;; ;;
;; FLAG SCRATCH 1 ; Allocate 1 8-bit location, named "FLAG" ;;
;; STACK SYSTEM 32 ; Allocate 32 16-bit locations, named "STACK" ;;
;; ;;
;; Note: For the "STACK" example, this won't place your stack there ;;
;; unless you also do "MVII #STACK, R6" to relocate your stack. ;;
;; ======================================================================== ;;

.SCRMEM SET $102
.SYSMEM SET $2F0

MACRO SCRATCH l
EQU .SCRMEM
LISTING "off"
.SCRMEM SET .SCRMEM + %l%
IF .SCRMEM > $1F0
ERR "Scratch Memory Overflow"
ENDI
LISTING "prev"
ENDM

MACRO SYSTEM l
EQU .SYSMEM
LISTING "off"
.SYSMEM SET .SYSMEM + %l%
IF .SYSMEM > $360
ERR "System Memory Overflow"
ENDI
LISTING "prev"
ENDM

ENDI

;; ======================================================================== ;;
;; End of File: dseg.mac ;;
;; ======================================================================== ;;
</pre>

← Older revision		Revision as of 15:08, 16 September 2008
Line 1:		Line 1:
	[[Category:Programming]] [[Category:Library]]		[[Category:Programming]] [[Category:Library]]
		+
		+	NOTE: This file has been superseded by [[cart.mac]]. You should consider using <CODE>cart.mac</CODE> instead of this file.

	= Functions Provided =		= Functions Provided =

@@ Line 7: / Line 7: @@
 <TR><TD><I>label</I> SYSTEM <I>len</I></TD><TD>Allocate <I>len</I> storage locations in 16-bit [[System RAM]], assigning the address to <I>label</I></TD><TD>Allocated range will be in 16-bit memory from $2F0 - $35F.</TD></TR></TABLE></CENTER>
 <br /><br />
 = Examples =

@@ Line 4: / Line 4: @@
 <CENTER><TABLE BORDER><TR><TH>Macro</TH><TH>Action performed</TH><TH>Notes</TH></TR>
-<TR><TD>SCRATCH</TD><TD>Allocate storage in 8-bit [[Scratchpad RAM]]</TD><TD>Allocated range will be in 8-bit memory from $102 - $1EF.</TD></TR>
+<TR><TD><I>label</I> SCRATCH <I>len</I></TD><TD>Allocate <I>len</I> storage locations in 8-bit [[Scratchpad RAM]], assigning the address to <I>label</I></TD><TD>Allocated range will be in 8-bit memory from $102 - $1EF.</TD></TR>
-<TR><TD>SYSTEM</TD><TD>Allocate storage in 16-bit [[System RAM]]</TD><TD>Allocated range will be in 16-bit memory from $2F0 - $35F.</TD></TR></TABLE></CENTER>
+<TR><TD><I>label</I> SYSTEM <I>len</I></TD><TD>Allocate <I>len</I> storage locations in 16-bit [[System RAM]], assigning the address to <I>label</I></TD><TD>Allocated range will be in 16-bit memory from $2F0 - $35F.</TD></TR></TABLE></CENTER>
 <br /><br />
 See source code below for calling convention.<br /><br />

@@ Line 17: / Line 17: @@
 These routines expect to have sole authority over how the 8-bit [[Scratchpad RAM]] and 16-bit [[System RAM]] are allocated.  They are not compatible with programs that use the [[Executive ROM|EXEC]], as the EXEC reserves some of these locations to itself.  The SCRATCH macro does not disturb the interrupt service vector at $100 - $101.<br /><br />
-When using this scheme, you should use the SYSTEM macro to declare a stack, and set the [[CP-1610#Registers|stack pointer (R6)]] to point to this stack early in your initialization.  For instance:<br /><br />
+When using this scheme, you should use the SYSTEM macro to declare a stack, and set the [[CP-1610#Registers|stack pointer (R6)]] to point to this stack early in your initialization.  For instance:<br />
 <pre>
 STACK   SYSTEM  32          ; Reserve 32 words of stack space
@@ Line 24: / Line 23: @@
 </pre>
-Note that you will lose the previous contents of your stack when you do this, which is why it should be one of the first things you do in your initialization.<br /><br />
+Note that you will effectively lose the previous contents of your stack when you do this, which is why it should be one of the first things you do in your initialization.<br /><br />
 To get an idea of how much Scratchpad RAM and System RAM your program uses, look for the symbols ".SCRMEM" and ".SYSMEM" in the assembler listing file or symbol dump file.  .SCRMEM indicates the first free location of Scratchpad RAM, and .SYSMEM indicates the first free location of System RAM.  The macros allocate from the bottom of memory toward the top.  Therefore, $1F0 - .SCRMEM gives the remaining amount of 8-bit Scratchpad RAM, and $360 - .SYSMEM gives the remaining amount of 16-bit System RAM.<br /><br />

← Older revision	Revision as of 08:20, 4 December 2010
(No difference)