Changes between Version 1 and Version 2 of ClrxAsmInvoke


Ignore:
Timestamp:
10/27/15 20:41:43 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ClrxAsmInvoke

    v1 v2  
    11{{{
    2 #!Markdown
    3 ## CLRadeonExtender Assembler
    4 
    5 This is CLRadeonExtender assembler. This assembler can assemble code for all Radeon GPU's
     2#!html
     3<h2>CLRadeonExtender Assembler</h2>
     4<p>This is CLRadeonExtender assembler. This assembler can assemble code for all Radeon GPU's
    65that based on the GCN1.0/1.1/1.2 architecture and it can generate AMD Catalyst
    76OpenCL binaries and the GalliumCompute OpenCL binaries. It is compatible with GNU as
    87and support the almost GNU as pseudo-operations (directives) including macros and
    9 repetitions.
    10 
    11 ### Invoking an assembler
    12 
    13 the `clrxasm` can be invoked in following way:
    14 
    15 clrxasm [-6Sw?] [-D SYM[=VALUE]] [-I PATH] [-o OUTFILE] [-b BINFORMAT]
     8repetitions.</p>
     9<h3>Invoking an assembler</h3>
     10<p>the <code>clrxasm</code> can be invoked in following way:</p>
     11<p>clrxasm [-6Sw?] [-D SYM[=VALUE]] [-I PATH] [-o OUTFILE] [-b BINFORMAT]
    1612[-g GPUDEVICE] [-A ARCH] [-t VERSION] [--defsym=SYM[=VALUE]] [--includePath=PATH]
    1713[--output OUTFILE] [--binaryFormat=BINFORMAT] [--64bit] [--gpuType=GPUDEVICE]
    1814[--arch=ARCH] [--driverVersion=VERSION] [--forceAddSymbols] [--noWarnings]
    19 [--help] [--usage] [--version] [file...]
    20 
    21 ### Input
    22 
    23 An assembler read source from many files. If no input file specified an assembler
    24 will read source from standard input.
    25 
    26 ### Program options
    27 
    28 Following options `clrxasm` can recognize:
    29 
    30 * **-D SYMBOL=[VALUE]**, **--defsym=SYMBOL[=VALUE]**
    31 
    32     Define symbol. Value is optional and if it is not given then assembler set 0 by default.
    33 This option can be occurred many times to defining many symbols.
    34 
    35 * **-I PATH**, **--includePath=PATH**
    36 
    37     Add  an include path to search path list. Assembler begins search from current directory
     15[--help] [--usage] [--version] [file...]</p>
     16<h3>Input</h3>
     17<p>An assembler read source from many files. If no input file specified an assembler
     18will read source from standard input.</p>
     19<h3>Program options</h3>
     20<p>Following options <code>clrxasm</code> can recognize:</p>
     21<ul>
     22<li>
     23<p><strong>-D SYMBOL=[VALUE]</strong>, <strong>--defsym=SYMBOL[=VALUE]</strong></p>
     24<p>Define symbol. Value is optional and if it is not given then assembler set 0 by default.
     25This option can be occurred many times to defining many symbols.</p>
     26</li>
     27<li>
     28<p><strong>-I PATH</strong>, <strong>--includePath=PATH</strong></p>
     29<p>Add  an include path to search path list. Assembler begins search from current directory
    3830and follows to next include paths.
    39 This option can be occurred many times to adding many include paths.
    40 
    41 * **-o FILENAME**, **--output=FILENAME**
    42 
    43     Set output file name. By default assembler write output to the 'a.out' file.
    44 
    45 * **-b BINFORMAT**, **--binaryFormat=BINFORMAT**
    46 
    47     Set output binary format. This settings can be overriden in source code.
    48 Assembler accepts following formats: 'amd', 'gallium', 'rawcode'.
    49 
    50 * **-6**, **--64bit**
    51 
    52     Enable generating of the 64-bit binaries (only for AMD catalyst format).
    53 
    54 * **-g GPUDEVICE**, **--gpuType=GPUDEVICE**
    55 
    56     Choose device type. Device type name is case-insensitive.
     31This option can be occurred many times to adding many include paths.</p>
     32</li>
     33<li>
     34<p><strong>-o FILENAME</strong>, <strong>--output=FILENAME</strong></p>
     35<p>Set output file name. By default assembler write output to the 'a.out' file.</p>
     36</li>
     37<li>
     38<p><strong>-b BINFORMAT</strong>, <strong>--binaryFormat=BINFORMAT</strong></p>
     39<p>Set output binary format. This settings can be overriden in source code.
     40Assembler accepts following formats: 'amd', 'gallium', 'rawcode'.</p>
     41</li>
     42<li>
     43<p><strong>-6</strong>, <strong>--64bit</strong></p>
     44<p>Enable generating of the 64-bit binaries (only for AMD catalyst format).</p>
     45</li>
     46<li>
     47<p><strong>-g GPUDEVICE</strong>, <strong>--gpuType=GPUDEVICE</strong></p>
     48<p>Choose device type. Device type name is case-insensitive.
    5749Currently is supported:
    5850CapeVerde, Pitcairn, Tahiti, Oland, Bonaire, Spectre, Spooky, Kalindi,
    59 Hainan, Hawaii, Iceland, Tonga, Mullins, Fiji and Carrizo.
    60 
    61 * **-A ARCH**, **--arch=ARCH**
    62 
    63     Choose device architecture. Architecture name is case-insensitive.
     51Hainan, Hawaii, Iceland, Tonga, Mullins, Fiji and Carrizo.</p>
     52</li>
     53<li>
     54<p><strong>-A ARCH</strong>, <strong>--arch=ARCH</strong></p>
     55<p>Choose device architecture. Architecture name is case-insensitive.
    6456List of supported architectures:
    65 GCN1.0, GCN1.1 and GCN1.2.
    66 
    67 * **-t VERSION**, **--driverVersion=VERSION**
    68 
    69     Choose AMD Catalyst OpenCL driver version. Version can retrieved from clinfo program
     57GCN1.0, GCN1.1 and GCN1.2.</p>
     58</li>
     59<li>
     60<p><strong>-t VERSION</strong>, <strong>--driverVersion=VERSION</strong></p>
     61<p>Choose AMD Catalyst OpenCL driver version. Version can retrieved from clinfo program
    7062that display field 'Driver version' where version is. Version is number in that form:
    71 MajorVersion*100 + MinorVersion.
    72 
    73 * **-S**, **--forceAddSymbols**
    74 
    75     Add all non-local symbols to binaries. By default any assembler does not add any symbols
    76 to keep compatibility with original format.
    77 
    78 * **-w**, **--noWarnings**
    79 
    80     Do not print all warnings.
    81 
    82 * **-?**, **--help**
    83 
    84     Print help and list of the options.
    85 
    86 * **--usage**
    87 
    88     Print usage for this program
    89 
    90 * **--version**
    91 
    92     Print version
    93 
    94 ### Output
    95 
    96 An assembler generates single output binary. If no output specified an assembler will
    97 generate `a.out` binary file. `clrxasm` returns 0 if succeeded, otherwise
    98 it returns 1 and prints an error messages to stderr.
    99 
    100 }}}
     63MajorVersion*100 + MinorVersion.</p>
     64</li>
     65<li>
     66<p><strong>-S</strong>, <strong>--forceAddSymbols</strong></p>
     67<p>Add all non-local symbols to binaries. By default any assembler does not add any symbols
     68to keep compatibility with original format.</p>
     69</li>
     70<li>
     71<p><strong>-w</strong>, <strong>--noWarnings</strong></p>
     72<p>Do not print all warnings.</p>
     73</li>
     74<li>
     75<p><strong>-?</strong>, <strong>--help</strong></p>
     76<p>Print help and list of the options.</p>
     77</li>
     78<li>
     79<p><strong>--usage</strong></p>
     80<p>Print usage for this program</p>
     81</li>
     82<li>
     83<p><strong>--version</strong></p>
     84<p>Print version</p>
     85</li>
     86</ul>
     87<h3>Output</h3>
     88<p>An assembler generates single output binary. If no output specified an assembler will
     89generate <code>a.out</code> binary file. <code>clrxasm</code> returns 0 if succeeded, otherwise
     90it returns 1 and prints an error messages to stderr.</p>}}}