diff --git a/common-global_8asm.html b/common-global_8asm.html new file mode 100644 index 0000000..d1d9c55 --- /dev/null +++ b/common-global_8asm.html @@ -0,0 +1,220 @@ + + + + + + + +c128lib Base: common-global.asm File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
c128lib Base +
+
Base macros for C128
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Functions
+
common-global.asm File Reference
+
+
+ +

Common module. +More...

+ + + + + + + + + + + +

+Functions

macro c128lib_BasicUpstart128 (sysAddress)
 This macro sets up a BASIC program for the Commodore 128.
 
macro c128lib_fbne (label)
 This macro provides a far branch if not equal (BNE) operation.
 
macro c128lib_fbmi (label)
 This macro provides a far branch if minus (BMI) operation.
 
+

Detailed Description

+

Common module.

+

Simple macros for the Commodore 128.

+
Author
Raffaele Intorcia raffa.nosp@m.ele..nosp@m.intor.nosp@m.cia@.nosp@m.gmail.nosp@m..com
+
Copyright
MIT License Copyright (c) 2024 c128lib - https://github.com/c128lib
+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
Date
2024
+

Function Documentation

+ +

◆ c128lib_BasicUpstart128()

+ +
+
+ + + + + + + +
macro c128lib_BasicUpstart128 (sysAddress )
+
+ +

This macro sets up a BASIC program for the Commodore 128.

+

The macro sets the program counter to $1c01, which is the start of the BASIC area in C128. It then writes a link address to the end of the BASIC program, a line number, a SYS token, and the address to SYS to in ASCII decimal, followed by a null byte. After that, it writes a zero word to signal the end of the BASIC program and sets the program counter to $1c0e.

+
Parameters
+ + +
[in]sysAddressThe address to which the BASIC program will SYS to start the machine code part.
+
+
+
Since
0.1.0
+ +
+
+ +

◆ c128lib_fbne()

+ +
+
+ + + + + + + +
macro c128lib_fbne (label )
+
+ +

This macro provides a far branch if not equal (BNE) operation.

+

The 6502 processor's BNE instruction can only jump a limited distance (from -128 to +127 bytes relative to the instruction following BNE). This macro extends that range by using a combination of BNE, BEQ, and JMP instructions.

+

If the label is within the range of a normal BNE, it uses that. If not, it uses a BEQ to skip over a JMP instruction.; This works because BNE jumps if the zero flag is clear, and BEQ jumps if the zero flag is set - they are opposites. So if the BNE would not have jumped, the BEQ does, and the JMP is skipped. If the BNE would have jumped, the BEQ does not, and the JMP is executed, jumping to the label.;

+
Parameters
+ + +
[in]labelThe label to jump to if the zero flag is not set.;
+
+
+
Since
0.1.0
+ +
+
+ +

◆ c128lib_fbmi()

+ +
+
+ + + + + + + +
macro c128lib_fbmi (label )
+
+ +

This macro provides a far branch if minus (BMI) operation.

+

The 6502 processor's BMI instruction can only jump a limited distance (from -128 to +127 bytes relative to the instruction following BMI). This macro extends that range by using a combination of BMI, BPL, BEQ, and JMP instructions.

+

If the label is within the range of a normal BMI, it uses that. If not, it uses a BPL and BEQ to skip over a JMP instruction.; This works because BMI jumps if the negative flag is set, and BPL jumps if the negative flag is clear - they are opposites. So if the BMI would not have jumped, the BPL and BEQ do, and the JMP is skipped. If the BMI would have jumped, the BPL and BEQ do not, and the JMP is executed, jumping to the label.;

+
Parameters
+ + +
[in]labelThe label to jump to if the negative flag is set.;
+
+
+
Since
0.1.0
+ +
+
+
+
+ + + + diff --git a/common-global_8asm.js b/common-global_8asm.js new file mode 100644 index 0000000..3d67cc2 --- /dev/null +++ b/common-global_8asm.js @@ -0,0 +1,6 @@ +var common_global_8asm = +[ + [ "c128lib_BasicUpstart128", "common-global_8asm.html#a83e3c1a543120b67e330db3c1779656c", null ], + [ "c128lib_fbne", "common-global_8asm.html#a60ea2a187d9be7d14287b5fc88b30400", null ], + [ "c128lib_fbmi", "common-global_8asm.html#ae58c2d2ecaf1f626d4974a75b87f4b56", null ] +]; \ No newline at end of file diff --git a/common_8asm.html b/common_8asm.html new file mode 100644 index 0000000..879ecf2 --- /dev/null +++ b/common_8asm.html @@ -0,0 +1,223 @@ + + + + + + + +c128lib Base: common.asm File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
c128lib Base +
+
Base macros for C128
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Functions
+
common.asm File Reference
+
+
+ +

Common module. +More...

+ + + + + + + + + + + +

+Functions

macro BasicUpstart128 (sysAddress)
 This macro sets up a BASIC program for the Commodore 128.
 
macro fbne (label)
 This macro provides a far branch if not equal (BNE) operation.
 
macro fbmi (label)
 This macro provides a far branch if minus (BMI) operation.
 
+

Detailed Description

+

Common module.

+

Simple macros for the Commodore 128.

+
Author
Raffaele Intorcia raffa.nosp@m.ele..nosp@m.intor.nosp@m.cia@.nosp@m.gmail.nosp@m..com
+
Copyright
MIT License Copyright (c) 2024 c128lib - https://github.com/c128lib
+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
Date
2024
+

Function Documentation

+ +

◆ BasicUpstart128()

+ +
+
+ + + + + + + +
macro BasicUpstart128 (sysAddress )
+
+ +

This macro sets up a BASIC program for the Commodore 128.

+

The macro sets the program counter to $1c01, which is the start of the BASIC area in C128. It then writes a link address to the end of the BASIC program, a line number, a SYS token, and the address to SYS to in ASCII decimal, followed by a null byte. After that, it writes a zero word to signal the end of the BASIC program and sets the program counter to $1c0e.

+
Parameters
+ + +
[in]sysAddressThe address to which the BASIC program will SYS to start the machine code part.
+
+
+
Note
Use c128lib_BasicUpstart128 in common-global.asm
+
Since
0.1.0
+ +
+
+ +

◆ fbne()

+ +
+
+ + + + + + + +
macro fbne (label )
+
+ +

This macro provides a far branch if not equal (BNE) operation.

+

The 6502 processor's BNE instruction can only jump a limited distance (from -128 to +127 bytes relative to the instruction following BNE). This macro extends that range by using a combination of BNE, BEQ, and JMP instructions.

+

If the label is within the range of a normal BNE, it uses that. If not, it uses a BEQ to skip over a JMP instruction.; This works because BNE jumps if the zero flag is clear, and BEQ jumps if the zero flag is set - they are opposites. So if the BNE would not have jumped, the BEQ does, and the JMP is skipped. If the BNE would have jumped, the BEQ does not, and the JMP is executed, jumping to the label.;

+
Parameters
+ + +
[in]labelThe label to jump to if the zero flag is not set.;
+
+
+
Note
Use c128lib_fbne in common-global.asm
+
Since
0.1.0
+ +
+
+ +

◆ fbmi()

+ +
+
+ + + + + + + +
macro fbmi (label )
+
+ +

This macro provides a far branch if minus (BMI) operation.

+

The 6502 processor's BMI instruction can only jump a limited distance (from -128 to +127 bytes relative to the instruction following BMI). This macro extends that range by using a combination of BMI, BPL, BEQ, and JMP instructions.

+

If the label is within the range of a normal BMI, it uses that. If not, it uses a BPL and BEQ to skip over a JMP instruction.; This works because BMI jumps if the negative flag is set, and BPL jumps if the negative flag is clear - they are opposites. So if the BMI would not have jumped, the BPL and BEQ do, and the JMP is skipped. If the BMI would have jumped, the BPL and BEQ do not, and the JMP is executed, jumping to the label.;

+
Parameters
+ + +
[in]labelThe label to jump to if the negative flag is set.;
+
+
+
Note
Use c128lib_fbmi in common-global.asm
+
Since
0.1.0
+ +
+
+
+
+ + + + diff --git a/common_8asm.js b/common_8asm.js new file mode 100644 index 0000000..38fe495 --- /dev/null +++ b/common_8asm.js @@ -0,0 +1,6 @@ +var common_8asm = +[ + [ "BasicUpstart128", "common_8asm.html#ae141e681c2a80de68240579fabe2c02a", null ], + [ "fbne", "common_8asm.html#a915a7fb90c81699e0ffd9219a202057e", null ], + [ "fbmi", "common_8asm.html#ae50e1dbbf4b374220bfe5baf883205f1", null ] +]; \ No newline at end of file diff --git a/doxygen_crawl.html b/doxygen_crawl.html index 25dea3b..0a71a05 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -8,7 +8,16 @@ + + + + + + + + + diff --git a/files.html b/files.html new file mode 100644 index 0000000..fb5bd40 --- /dev/null +++ b/files.html @@ -0,0 +1,114 @@ + + + + + + + +c128lib Base: File List + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
c128lib Base +
+
Base macros for C128
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
File List
+
+
+
Here is a list of all files with brief descriptions:
+ + + +
 common-global.asmCommon module
 common.asmCommon module
+
+
+
+ + + + diff --git a/files_dup.js b/files_dup.js new file mode 100644 index 0000000..1ea2af4 --- /dev/null +++ b/files_dup.js @@ -0,0 +1,5 @@ +var files_dup = +[ + [ "common-global.asm", "common-global_8asm.html", "common-global_8asm" ], + [ "common.asm", "common_8asm.html", "common_8asm" ] +]; \ No newline at end of file diff --git a/globals.html b/globals.html new file mode 100644 index 0000000..4b57f48 --- /dev/null +++ b/globals.html @@ -0,0 +1,113 @@ + + + + + + + +c128lib Base: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
c128lib Base +
+
Base macros for C128
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:
+
+
+ + + + diff --git a/globals_func.html b/globals_func.html new file mode 100644 index 0000000..01fafe4 --- /dev/null +++ b/globals_func.html @@ -0,0 +1,113 @@ + + + + + + + +c128lib Base: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
c128lib Base +
+
Base macros for C128
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the files they belong to:
+
+
+ + + + diff --git a/index.html b/index.html index bd88529..664bdff 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ -c128lib Labels: Main Page +c128lib Base: Main Page @@ -28,9 +28,9 @@ Logo -
c128lib Labels +
c128lib Base
-
Labels definition for C128
+
Base macros for C128
@@ -93,7 +93,7 @@
-
c128lib Labels Documentation
+
c128lib Base Documentation
@@ -102,7 +102,7 @@ diff --git a/menudata.js b/menudata.js index d1ece13..c9435dd 100644 --- a/menudata.js +++ b/menudata.js @@ -23,4 +23,9 @@ @licend The above is the entire license notice for the JavaScript code in this file */ var menudata={children:[ -{text:"Main Page",url:"index.html"}]} +{text:"Main Page",url:"index.html"}, +{text:"Files",url:"files.html",children:[ +{text:"File List",url:"files.html"}, +{text:"Globals",url:"globals.html",children:[ +{text:"All",url:"globals.html"}, +{text:"Functions",url:"globals_func.html"}]}]}]} diff --git a/navtreedata.js b/navtreedata.js index 72f72e3..24bb645 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -24,12 +24,20 @@ */ var NAVTREE = [ - [ "c128lib Labels", "index.html", ] + [ "c128lib Base", "index.html", [ + [ "Files", "files.html", [ + [ "File List", "files.html", "files_dup" ], + [ "Globals", "globals.html", [ + [ "All", "globals.html", null ], + [ "Functions", "globals_func.html", null ] + ] ] + ] ] + ] ] ]; var NAVTREEINDEX = [ -"index.html" +"common-global_8asm.html" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/navtreeindex0.js b/navtreeindex0.js index 9e75a21..c21b841 100644 --- a/navtreeindex0.js +++ b/navtreeindex0.js @@ -1,5 +1,16 @@ var NAVTREEINDEX0 = { +"common-global_8asm.html":[0,0,0], +"common-global_8asm.html#a60ea2a187d9be7d14287b5fc88b30400":[0,0,0,1], +"common-global_8asm.html#a83e3c1a543120b67e330db3c1779656c":[0,0,0,0], +"common-global_8asm.html#ae58c2d2ecaf1f626d4974a75b87f4b56":[0,0,0,2], +"common_8asm.html":[0,0,1], +"common_8asm.html#a915a7fb90c81699e0ffd9219a202057e":[0,0,1,1], +"common_8asm.html#ae141e681c2a80de68240579fabe2c02a":[0,0,1,0], +"common_8asm.html#ae50e1dbbf4b374220bfe5baf883205f1":[0,0,1,2], +"files.html":[0,0], +"globals.html":[0,1,0], +"globals_func.html":[0,1,1], "index.html":[], "pages.html":[] }; diff --git a/search/all_0.js b/search/all_0.js new file mode 100644 index 0000000..38349d3 --- /dev/null +++ b/search/all_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['basicupstart128_0',['BasicUpstart128',['../common_8asm.html#ae141e681c2a80de68240579fabe2c02a',1,'common.asm']]] +]; diff --git a/search/all_1.js b/search/all_1.js new file mode 100644 index 0000000..c12c46c --- /dev/null +++ b/search/all_1.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['c128lib_5fbasicupstart128_0',['c128lib_BasicUpstart128',['../common-global_8asm.html#a83e3c1a543120b67e330db3c1779656c',1,'common-global.asm']]], + ['c128lib_5ffbmi_1',['c128lib_fbmi',['../common-global_8asm.html#ae58c2d2ecaf1f626d4974a75b87f4b56',1,'common-global.asm']]], + ['c128lib_5ffbne_2',['c128lib_fbne',['../common-global_8asm.html#a60ea2a187d9be7d14287b5fc88b30400',1,'common-global.asm']]], + ['common_2dglobal_2easm_3',['common-global.asm',['../common-global_8asm.html',1,'']]], + ['common_2easm_4',['common.asm',['../common_8asm.html',1,'']]] +]; diff --git a/search/all_2.js b/search/all_2.js new file mode 100644 index 0000000..574d4ee --- /dev/null +++ b/search/all_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['fbmi_0',['fbmi',['../common_8asm.html#ae50e1dbbf4b374220bfe5baf883205f1',1,'common.asm']]], + ['fbne_1',['fbne',['../common_8asm.html#a915a7fb90c81699e0ffd9219a202057e',1,'common.asm']]] +]; diff --git a/search/files_0.js b/search/files_0.js new file mode 100644 index 0000000..21085f2 --- /dev/null +++ b/search/files_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['common_2dglobal_2easm_0',['common-global.asm',['../common-global_8asm.html',1,'']]], + ['common_2easm_1',['common.asm',['../common_8asm.html',1,'']]] +]; diff --git a/search/functions_0.js b/search/functions_0.js new file mode 100644 index 0000000..38349d3 --- /dev/null +++ b/search/functions_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['basicupstart128_0',['BasicUpstart128',['../common_8asm.html#ae141e681c2a80de68240579fabe2c02a',1,'common.asm']]] +]; diff --git a/search/functions_1.js b/search/functions_1.js new file mode 100644 index 0000000..a9b5b39 --- /dev/null +++ b/search/functions_1.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['c128lib_5fbasicupstart128_0',['c128lib_BasicUpstart128',['../common-global_8asm.html#a83e3c1a543120b67e330db3c1779656c',1,'common-global.asm']]], + ['c128lib_5ffbmi_1',['c128lib_fbmi',['../common-global_8asm.html#ae58c2d2ecaf1f626d4974a75b87f4b56',1,'common-global.asm']]], + ['c128lib_5ffbne_2',['c128lib_fbne',['../common-global_8asm.html#a60ea2a187d9be7d14287b5fc88b30400',1,'common-global.asm']]] +]; diff --git a/search/functions_2.js b/search/functions_2.js new file mode 100644 index 0000000..574d4ee --- /dev/null +++ b/search/functions_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['fbmi_0',['fbmi',['../common_8asm.html#ae50e1dbbf4b374220bfe5baf883205f1',1,'common.asm']]], + ['fbne_1',['fbne',['../common_8asm.html#a915a7fb90c81699e0ffd9219a202057e',1,'common.asm']]] +]; diff --git a/search/searchdata.js b/search/searchdata.js index f95870c..7082e14 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,12 +1,21 @@ var indexSectionsWithContent = { + 0: "bcf", + 1: "c", + 2: "bcf" }; var indexSectionNames = { + 0: "all", + 1: "files", + 2: "functions" }; var indexSectionLabels = { + 0: "All", + 1: "Files", + 2: "Functions" };