home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 405.lha / Z8_CrossAsm / z8ca.doc < prev    next >
Text File  |  1990-06-05  |  6KB  |  209 lines
  1. ;
  2. ; z8ca.doc
  3. ;
  4. ; Brief Documentation for operation of the z8 Cross Assembler.
  5. ;
  6. ;  Copyright (C) 1990 R.Bush. All rights reserved.
  7. ;
  8. ;  This program is freely distributable as long as this copyright notice
  9. ;  is retained. It intended for personal, non-commercial use.  
  10. ;
  11. ; Version 1.2
  12. ;
  13. ; Updates from original 1989 release:
  14. ;
  15. ; The following enhancements/fixes incorporated into this version:
  16. ; 
  17.     1) allow symbols to be case sensitive.
  18.     2) allow math operations on defs.
  19.     3) fixed bug in Intel Hex file output.
  20.     4) added sorted symbol table option.
  21.     5) enabled 'DS' (define storage) pseudo op.
  22.     6) Bug fixed in 'DB' evaluation which prevented spaces after
  23.        pseudo op.
  24.  
  25. Invoking the assembler:
  26. -----------------------
  27.  
  28.   z8ca [filename] <opt1> <opt2> <opt3>
  29.  
  30.    -- [filename]
  31.       Required. automatically supplies .asm
  32.       extension and creates .hex file as output.
  33.  
  34.    -- <opt1>
  35.    -i -- Creates Intel format .hex output file.
  36.    -m -- Creates Motorola format .hex output file. (Default)
  37.    -z -- Creates special z8 format .hex output file
  38.      the use of which is explained later..
  39.  
  40.    If none of the above options are specified the
  41.    assembler defaults to Motorola .hex output.
  42.  
  43.    -- <opt2>
  44.    -l -- Enable the generation of program listing.
  45.  
  46.    -- <opt3>
  47.    -s -- Enable sorted symbol table listing.
  48.  
  49. Examples:
  50.  
  51.     z8ca serial
  52.     -- assembles the file serial.asm. Note: do not
  53.        supply the '.asm' extension as the assembler
  54.        will do it for you.  The file 'serial.hex'
  55.        is created in the default Motorola hex format.
  56.  
  57.     z8ca serial -i -l -s
  58.     -- assembles the file serial.asm. The file 'serial.hex'
  59.        is created in the Intel hex format. The listing of the
  60.        assembled program appears on the default output (terminal)
  61.        along with a listing of the sorted symbol table.
  62.  
  63.  
  64. Labels, radix specifiers, etc..
  65. -------------------------------
  66.  
  67.    Source code may be in upper or lower case.
  68.  
  69.    Any comment lines should start with a semi-colon.
  70.    e.g.
  71.    ;This is a comment..
  72.  
  73.    All labels must start with an alpha character and end with a colon. No
  74.    limit on the length of a label. Labels must start in the first column of
  75.    text..
  76.  
  77.    e.g. TEST01:   EQU   $0a 
  78.  
  79.    Note: Remember that the assembler is case sensitive for labels.
  80.          'TEST' and 'test' are recognized as two seperate labels.
  81.  
  82.    The following radix specifiers are allowed:
  83.    $ = hex
  84.    % = binary
  85.    0 thru 9 = decimal
  86.    ' = ascii literal
  87.  
  88.    e.g.    ld   r1,#$0a        ;the '#' means literal (immediate) data
  89.        ld   r1,#123
  90.        ld   r1,#%01101010
  91.        ld    r1,#'a'         ;ascii literal..
  92.  
  93.  
  94.    Simple math and logical operators allowed. (no parentheses please!!)
  95.    Evaluation occurs in order of appearance only.. No spaces are allowed
  96.    between operators and operands.
  97.  
  98.    +,-,*,/
  99.    & -- logical and
  100.    | -- logical or
  101.  
  102.    e.g.
  103.     test:    equ    $0a
  104.         ld    r1,#test+2*5/3
  105.             ld    r1,#test|$80
  106.  
  107.  
  108. z8 notes:
  109. ---------
  110.    All address modes supported.
  111.  
  112.    #   ---  Specifies immediate data.
  113.         e.g.  ld   r1,#10
  114.  
  115.    rx  ---  Specifies working register where 'x' in the range 0 thru 15.
  116.         e.g.  ld   r1,r12
  117.  
  118.    r:xxx -  Specifies an absolute register where 'x' in the range 0 thru
  119.         255. The colon operator is used to specify an absolute register. 
  120.         e.g.  ld   r1,r:242
  121.           ld   r2,r:$30
  122.  
  123.    rr  --   Specifies register pair.
  124.         e.g.  incw  rr2        ;working register pair
  125.           decw  rr:2       ;absolute register pair
  126.  
  127.    @r   --  Specifies indirect register.
  128.         e.g.  ld    r1,@r2     ;working indirect register
  129.           ld    r1,@r:48   ;absolute indirect register
  130.  
  131.    @rr  --  Specifies indirect register pair.
  132.         e.g   ldc   r1,@rr2    ;working indirect register pair
  133.           call  @rr:2      ;absolute indirect register pair
  134.  
  135.    !x  ---  Specifies hi or low portion of 16 bit operand where 'x' = 'h'
  136.         for hi-order bits and 'x' = 'l' for low order bits. This is
  137.         normally used to load register pairs with an address.
  138.             e.g.  ld    r2,message!h
  139.           ld    r3,message!l  ;loads reg. pair r2,r3 with address of
  140.                       ;message..
  141.             message:  db  'Hello World!!'
  142.  
  143.    ()  ---  Indexed addressing for ld instruction.
  144.             In the following example assume r5 = 1, r2 = 255.
  145.             e.g.  ld    r:40(r5),r2  ;load register 40+r5 (reg 41) with 255.
  146.           ld    r2,r:40(r5)  ;load r2 with content of r:41
  147.             Note: The base register for indirect addressing must be an
  148.           absolute register (r:40 in the examples). The remaining
  149.           registers used in forming the instruction (r2 and r5 in the
  150.           examples) must be working registers.
  151.  
  152. ------------------------------------------------------------------------------
  153.  
  154. Pseudo-ops.
  155. -----------
  156.  
  157.    Six Pseudo-ops are supported: ORG, EQU, DEF, DB, DW, and DS.
  158.  
  159.    ORG  --- Set program counter (origin).
  160.         e.g.
  161.         org $0800
  162.         Sets program to originate at 0800 hex.
  163.  
  164.    EQU  --- Allows a label to be equated to a value.
  165.         e.g.
  166.         test:  equ  $0a
  167.         Equates the label 'test' to the value 0a hex.
  168.  
  169.    DEF  --- Define. Similar to the 'C' language #define statement. This
  170.             will do a text substitution for the defined text.
  171.         e.g.
  172.               def      rp    r:253
  173.           push    rp
  174.           pop   rp
  175.         Substitutes 'r:253' for the text 'rp'. This is normally used
  176.             to allow the use of an ascii name for a special z8 register.
  177.  
  178.    DB   --- Define byte.
  179.         e.g.
  180.         test:    db    'text',$0a,$0d,00,%00010001
  181.  
  182.    DW   --- Define word (16 bit).
  183.         e.g.
  184.         rest:    dw    test,$1faf,0,$0100
  185.  
  186.    DS   --- Define Storage
  187.             e.g.
  188.             buffer:    ds    32
  189.         
  190.         Note: DS only reserves memory. The net effect is of the above
  191.                   example is to advance the program counter 32 bytes.
  192.         
  193. Error Messages:
  194. ---------------
  195.    I have made an attempt to supply meaningful error messages. Any error
  196.    should terminate the assembly and list the line number in error. If the
  197.    error message doesn't make much sense, well.., I said I made an ATTEMPT..
  198.  
  199. z8 .hex format output
  200. ----------------------
  201.    This is a special format file suitable for use with the supplied program
  202.    'download.bas'. It allows the user to load programs created by this 
  203.    assembler to a z8-Basic controller via an RS-232 link and a user supplied
  204.    terminal program.
  205.    See the file 'amiga.doc' for a more detailed explanation..
  206.  
  207.  
  208. ******** End of file ********
  209.