[wiki:ClrxToc Back to Table of content]
{{{
#!html
<h2>CLRadeonExtender Assembler</h2>
<p>This is CLRadeonExtender assembler. This assembler can assemble code for all Radeon GPU's
that based on the GCN1.0/1.1/1.2 architecture and it can generate AMD Catalyst
OpenCL binaries and the GalliumCompute OpenCL binaries. It is compatible with GNU as
and support the almost GNU as pseudo-operations (directives) including macros and
repetitions.</p>
<h3>Invoking an assembler</h3>
<p>the <code>clrxasm</code> can be invoked in following way:</p>
<p>clrxasm [-6Sw?] [-D SYM[=VALUE]] [-I PATH] [-o OUTFILE] [-b BINFORMAT]
[-g GPUDEVICE] [-A ARCH] [-t VERSION] [--defsym=SYM[=VALUE]] [--includePath=PATH]
[--output OUTFILE] [--binaryFormat=BINFORMAT] [--64bit] [--gpuType=GPUDEVICE]
[--arch=ARCH] [--driverVersion=VERSION] [--forceAddSymbols] [--noWarnings]
[--help] [--usage] [--version] [file...]</p>
<h3>Input</h3>
<p>An assembler read source from many files. If no input file specified an assembler
will read source from standard input.</p>
<h3>Program options</h3>
<p>Following options <code>clrxasm</code> can recognize:</p>
<ul>
<li>
<p><strong>-D SYMBOL[=VALUE]</strong>, <strong>--defsym=SYMBOL[=VALUE]</strong></p>
<p>Define symbol. Value is optional and if it is not given then assembler set 0 by default.
This option can be occurred many times to defining many symbols.</p>
</li>
<li>
<p><strong>-I PATH</strong>, <strong>--includePath=PATH</strong></p>
<p>Add  an include path to search path list. Assembler begins search from current directory
and follows to next include paths.
This option can be occurred many times to adding many include paths.</p>
</li>
<li>
<p><strong>-o FILENAME</strong>, <strong>--output=FILENAME</strong></p>
<p>Set output file name. By default assembler write output to the 'a.out' file.</p>
</li>
<li>
<p><strong>-b BINFORMAT</strong>, <strong>--binaryFormat=BINFORMAT</strong></p>
<p>Set output binary format. This settings can be overriden in source code.
Assembler accepts following formats: 'amd', 'gallium', 'rawcode'.</p>
</li>
<li>
<p><strong>-6</strong>, <strong>--64bit</strong></p>
<p>Enable generating of the 64-bit binaries (only for AMD catalyst format).</p>
</li>
<li>
<p><strong>-g GPUDEVICE</strong>, <strong>--gpuType=GPUDEVICE</strong></p>
<p>Choose device type. Device type name is case-insensitive.
Currently is supported: 
CapeVerde, Pitcairn, Tahiti, Oland, Bonaire, Spectre, Spooky, Kalindi,
Hainan, Hawaii, Iceland, Tonga, Mullins, Fiji and Carrizo.</p>
</li>
<li>
<p><strong>-A ARCH</strong>, <strong>--arch=ARCH</strong></p>
<p>Choose device architecture. Architecture name is case-insensitive.
List of supported architectures:
GCN1.0, GCN1.1 and GCN1.2.</p>
</li>
<li>
<p><strong>-t VERSION</strong>, <strong>--driverVersion=VERSION</strong></p>
<p>Choose AMD Catalyst OpenCL driver version. Version can retrieved from clinfo program
that display field 'Driver version' where version is. Version is number in that form:
MajorVersion*100 + MinorVersion.</p>
</li>
<li>
<p><strong>-S</strong>, <strong>--forceAddSymbols</strong></p>
<p>Add all non-local symbols to binaries. By default any assembler does not add any symbols
to keep compatibility with original format.</p>
</li>
<li>
<p><strong>-w</strong>, <strong>--noWarnings</strong></p>
<p>Do not print all warnings.</p>
</li>
<li>
<p><strong>-?</strong>, <strong>--help</strong></p>
<p>Print help and list of the options.</p>
</li>
<li>
<p><strong>--usage</strong></p>
<p>Print usage for this program</p>
</li>
<li>
<p><strong>--version</strong></p>
<p>Print version</p>
</li>
</ul>
<h3>Output</h3>
<p>An assembler generates single output binary. If no output specified an assembler will
generate <code>a.out</code> binary file. <code>clrxasm</code> returns 0 if succeeded, otherwise
it returns 1 and prints an error messages to stderr.</p>
}}}