annotate portasm/README.txt @ 341:ab2d78e48ca2

- gen-masm . fallback on clang if gcc not available . consolidated use of redundant scripts . regen of portasm based masm files - minor symbol name changes for clarity/consistency
author Tassilo Philipp
date Sat, 04 Jan 2020 23:00:02 +0100
parents 3e629dc19168
children cab0031c6691
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
1 portasm - a toolkit for writing portable generic assembler sources
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
2 ------------------------------------------------------------------
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
4 Copyright (C) 2011 Daniel Adler <dadler@uni-goettingen.de>.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
5 Licensed under BSD two-clause license.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
7
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
8 Requirements
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
9 ------------
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10 - C Preprocessor
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
12
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13 Supported Architectures and Tool-chains:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
14 ----------------------------------------
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
15
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
16 - x86: gas, apple as, masm
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
17 - x64: gas, apple as, masm
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
18 - ppc: gas, apple as
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19 - arm: gas, apple as
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
20
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22 Usage:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23 ------
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25 Implement assembler sources in *.S files which use C preprocessor.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26 #include portasm-<ARCH>.S at front
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28 In order to generate MASM files for X86 and X64, run
341
ab2d78e48ca2 - gen-masm
Tassilo Philipp
parents: 0
diff changeset
29 'gen-masm.sh <name> [<outsuffix>]' script which reads <name>.S and outputs <name><outsuffix>.masm file.
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32 Common Macros:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 --------------
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35 BEGIN_ASM
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 END_ASM
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
37 BEGIN_PROC(name)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
38 END_PROC(name)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
39 GLOBAL(name)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40 HEX(value)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
41
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42