@DATABASE "PICAsm" @AUTHOR "Dirk Düsterberg" @(C) "1996-1997 @$VER: PICAsmguide 1.0c @NODE MAIN "PICAsm Manual" @{b}PICAsm guide@{ub} Version 0.9.4 A Pic Cross Assembler for Amiga Computers by Joannis Petroglou 18.05.97 @{" Overview " LINK Overview} What is PICasm? @{" Support " LINK Support} Call me! @{" Installation " LINK Installation} How to install PICSim @{" Requirements " LINK Requirements} System Requirement @{" Registration " LINK Registration} limitations ? Using PICAsm @{" format " LINK format} Source Code format @{" directives " LINK directives} assembler directives @{" expression " LINK expression} Expression evaluation @{" Processors " LINK processors} supported PIC`s @{" Pic_Info " LINK Pic_info} about PIC`s @{" editor " LINK editor} using with CygnusEd @{" Copyright " LINK LegalMush} Legal mush @{" Bug reports " LINK BugReports} How to report bugs @{" The author " LINK author} Programmer's address @{" History " LINK History} Revision history of PICSim @ENDNODE @NODE Overview PICAsm is an Amiga cross assembler for 12, 14 and 16 bit microcontroller from microchip. PICAsm uses the microchip commands and many features of microchip`s mpasm assembler. Questions, criticism, suggestions and @{"bug reports" LINK BugReports} are always welcome. @ENDNODE @NODE processors 12 bit types: - PIC16C54 - PIC16C55 - PIC16C56 - PIC16C57 - PIC16C58 14 bit types: - PIC16C61 - PIC16C62 - PIC16C64 - PIC16C65 - PIC16C620 - PIC16C621 - PIC16C622 - PIC16C71 - PIC16C73 - PIC16C74 - PIC16C84 16 bit types: - PIC17C42 - PIC17C43 - PIC17C44 @ENDNODE @NODE Support The official PICAsm homepage in the WWW has always the latest version and other information related to PIC Tools: http://linux.rz.fh-hannover.de/~duesterb @ENDNODE @NODE Installation just copy the files in a directory on your harddisk @ENDNODE @NODE Requirements Requirements: · The Amiga must have at least a 68020 processor. PICAsm will run on every Amiga with at least OS 2.0 · some free mem @ENDNODE @NODE Registration THIS PICAsm VERSION HAS NO LIMITATIONS ! please let us know if you like this program. @ENDNODE @NODE LegalMush The programs "PICSim", "PicProgger", "PicASM" may be freely distributed as long as they remain unchanged (archiving and packing are allowed). No profit must be made by distributing PICSim, especially the price of a disk containing PICSim may not exceed US$ 5,- (or equivalent amounts in other currencies). Please feel free to distribute PICSim over bulletin board systems and networks and as part of shareware/freeware CD-ROMs. All rights for commercial use remain at the @{"author" LINK author}. The Program that registered users will receive, must @{b}only@{ub} be installed one one computer and @{b}in no case@{ub} passed on to others. Offences will result in penal prosecution by me. With your signature on the order form, you accept these conditions. The program is presented to the users as it is, without any warranty of any kind, be it expressed or implicit. Anyone using this program agrees to incur the @{b}risk@{ub} of using it @{b}for himself@{ub}. @{b}In no way@{ub} can the author be made responsible for any damage directly or indirectly caused by the use or misuse of the program. Names of other hardware and software items mentioned in this manual and in program texts are in most cases registered trade marks of the respective companies and not marked as such. So the lack of such a note may not be used as an indication that these names are free. @ENDNODE @NODE BugReports If you find a bug or a misfeature in PICAsm, or have an idea how to make some things better, then please drop me a note so I'll be able to improve PICAsm in the future. My address can be found @{"here" LINK author}. Important for a bug report is the following information: · Version of PICAsm · Used AmigaOS version (e.g. 3.1, 2.0 etc.) · Used sourcefile · Information about installed startup programs on the Amiga · Detailed description what program produces the bug and how it can be reproduced @ENDNODE @NODE author There was no Pic Simulator on Amiga. So I had to do it. :-) My address is: Mail: petroglo@unixserv.rz.fh-hannover.de WWW: http://linux.rz.fh-hannover.de/~duesterb/ Questions, criticism, suggestions and @{"bug reports" LINK BugReports} are always welcome. @ENDNODE @NODE History xx.04.97 -several beta releases 06.05.97 -first release v0.9 18.05.97 -second release v0.9.4 @ENDNODE @NODE expression "Expression evaluation" Expresion evalution Numeric Constnts and Radix 10 ;binary, dezimal or hexadezimal term, ;use RADIX to choose, hexadezimal is default .10 ;dezimal term 0ch or 0xc ;hexadezimal term, must begin with number ;end with h or begins with "0x" 1100b ;binary term, end with "b" ;this term could make probs if hex is default 362o ;octal term, end with "o" number ;symbol "A" ;ascii, case sensitive (A = 41h, a = 61h), ;could be a "string" at RETLW command or: D'123' ;dezimal H'1f' ;hexadezimal O'123' ;octal B'10001010' ;binary A'W' or 'W' ;ascii, only single character symbol declaration: number = .12 or: count equ .13 where ever a symbol is found in a term it will be substituted by declared value. Arithmetic operators: These operators perform their normal functions + add ; eg 4 + 5 - subtract ; eg 156 - 38 * multiply ; eg 7 * 101b / divide ; eg 20h / 5 % modulus ; eg 134%2 ( left paranthesis ) right paranthesis { every kind of paranthesis needs same kind to end } expression [ ] Boolean operators Boolean operators perform bit-wise logical operations on 8 bit data. The following Boolean operators are supported: & and ; eg 1001101 & value | or ; eg 0fh | 12h ^ exclusive-or ; eg 25 ^ number >> term shift right term times ; eg 89 >> 4 << term shift left term times ; eg (4 * 8) << 4 ! complement of expression misc operators low low byte of expression high high byte of expression $ value of program counter comparation operators == equal != not equal > Greater < Less >= Greater or equal <= Less or equal && Logical AND || Logical OR substraction and addition have the lowest priority, division, multiplikation and boolean operation have the same priority. expressions are resolved from left to right. eg: 4h * -5 + 30 = 10 ;-20 + 30 4h * (-5 + 30) = 100 ;4 * 25 (4h * (-5 + 30)) >> 1 = 50 ;(4 * 25) shifted one time right clockspeed = 4000000 ;clockspeed is 4 Mhz baudrate = 19200 ;enter baudrate here delay = (clockspeed/4/baudrate-12)/4 ;value for delay digits after point are truncated. eg: 10/4 => 2 @ENDNODE @NODE directives "assembler directives" assembler directives assembler directives must be found in PASS1, location in source doesn`t matter. @{"device" LINK device} -setup a device @{"list" LINK list} -switches listfile outputon @{"nolist" LINK nolist} -switches listfile output off @{"radix" LINK radix} -set value radix @{"processor" LINK processor} -setup a processor @{"org" LINK org} -define adress in memory @{"end" LINK end} -stop assembling @{"ds" LINK ds} -define space @{"res" LINK res} -reserve space @{"cblock" LINK cblock} -constant block @{"dt" LINK dt} -define table @{"macro" LINK macro} -macro @{"include" LINK include} -include file @{"incdir" LINK incdir} -set include directory @{"#define" LINK define} -define symbol @{"#undefine" LINK undefine} -undefine symbol @{"ifdef" LINK ifdef} -conditional assembling @{"ifndef" LINK ifndef} -conditional assembling @{"else" LINK else} -conditional assembling @{"endif" LINK endif} -end of conditional assembling @{"if" LINK if} -end of conditional assembling @{"messg" LINK messg} -Create User Defined Message @{"error" LINK error} -Issue an Error Message @{"space" LINK space} -Insert Blank Listing Lines @{"expand" LINK expand} -future @{"noexpand" LINK noexpand} -future @{"title" LINK title} -future @{"subtitle" LINK subtite} -future @ENDNODE ******************************************************************************* @NODE device DEVICE DEVICE sets pictype eg: DEVICE PIC16c54 ;defines pic type or: DEVICE 16c54 for mpasm compatibility use @{"LIST" LINK list} or @{"PROCESSOR" Link processor} command @ENDNODE @NODE list LIST switches the listfile on, following source is written to the listfile until NOLIST command, optionally following options can be used: default @{"radix" LINK radix} (can changed several in source): r=dez ;radix is dezimal (default for values) r=hex ;radix is hexadezimal r=bin ;radix is binary eg: LIST r=dec ;radix is decimal movlw 32 ;move d'32' (h'20') to w LIST r=hex ;radix is hexa decimal movlw 32 ;move d'50' (h'32') to w @{"processor" Link processor} type: (last device in source used if several devices choosed) p=pic16c58 or: p=16c58 case sensitivity (can changed several in source): s=on ;case sensitive on (default) s=off ;case sensitive off eg: LIST p=16c84, s=on, r=dec key = 4 ;key is 4 (4) KEY = 5*key ;KEY is 5*key (20) number = KEY-2 ;number is KEY-2 (18) LIST s=off movlw Number ;Number (number) to w (18) look also: @{"RADIX" Link radix} @{"PROCESSOR" Link processor} @{"DEVICE" Link device} @{"NOLIST" Link nolist} @ENDNODE @NODE nolist NOLIST switches the listfile off, following source is not written to listfile until @{"LIST" Link list} command. @ENDNODE @NODE radix RADIX spezify default radix (can changed several in source) see also @{"LIST" Link list} command RADIX dec ;radix is decimal RADIX hex ;radix is hexadecimal (default) RADIX bin ;radix is binary @ENDNODE @NODE processor PROCESSOR set processor type see also @{"LIST" Link list} command PROCESSOR 16c84 or: PROCESSOR pic16c84 @ENDNODE @NODE org ORG define address in memory ORG 1ffh sets program counter to 1ffh, following code begins at this address. Reset vektor of 5x PIC types is last memory address (1ffh, 3ffh or 7ffh) eg: ORG 1ffh ;this is the reset vektor goto start ;start label ORG 0 ;beginning of code @ENDNODE @NODE end END this causes the assembler to end assembling, following source doesn`t matter. @ENDNODE @NODE ds DS define space in program memory, equal to @{"res" Link res} command eg: DS 2 defines space of two bytes @ENDNODE @NODE res RES reserve memory, equal to @{"ds" Link ds} command eg: RES 2 defines space of two bytes @ENDNODE @NODE cblock CBLOCK define a block of constants Define a list of defined constants. Each is assigned a value of one higher than the last one. The end of block is defined by ENDC eg: cblock [expr] ;optionaly expression sets ;start name_1 ;assigned to expr name_2 ;assigned to expr + 1 name_3 ;assigned to expr + 2 name_4, name_5, name_6 ;assigned to +3, +4, +5 endc indicates the starting value for the first name in the block. If no expression is found, the first name will receive a value one higher than the final name in the previous CBLOCK or the current program counter @ENDNODE @NODE macro macro defines a macro eg: macro page1 ;this is a macro named page1 bcf 03h,5 ;clear pageselect bit 0 bsf 03h,6 ;set page select bit 1 endm ;end of macro or: macro wait arg1,arg2 ;this is a macro with two arguments movlw arg1 ;arg1 is a value movwf arg2 ;arg2 is a fileregister loop decfsz arg2 ;do loop arg1 times goto loop ;labels in macros are local loops endm using macros: page1 ;set page select bits to page 1 goto adress ;jump to adress on page 1 wait 100, 0x1f ;wait 100 loops, use register 0x1f @ENDNODE @NODE include #include includes source file, includes could be nested without limits eg: #include "includes:p16c5x.inc" ;include file @{"p16c5x.inc" LINK p16c5x.inc} -include file for 16c5x types @{"p16cxx.inc" LINK p16cxx.inc} -include file for 16cxx types see also @{"incdir" Link incdir} command @ENDNODE @NODE incdir #incdir sets include directory. eg: #incdir "pictools:includes" see also @{"include" Link include} command @ENDNODE @NODE define #define defines text substitution or symbols (ifdef, etc) eg: #define demo #define page1 bsf 03h,5 ;if page1 occures it will ;be exchanged with with 'bsf 03h' defined names can be used in command or operand field. see also @{"#undefine" Link undefine} command @ENDNODE @NODE undefine #undefine defined labels can be undefined eg: #undefine demo see also @{"#define" Link list} command @ENDNODE @NODE ifdef ifdef assemble following source if label is defined, several ifdef`s can be nested eg: ifdef demo call demo endif see also @{"#define" Link define} command @ENDNODE @NODE ifndef ifndef assemble following source if label is not defined eg: ifndef fullversion call demo endif see also @{"#define" Link define} command @ENDNODE @NODE else else end of case in conditional assembly eg: ifdef demo call demo else call nodemo endif goto loop see also @{"#define" Link define} command @ENDNODE @NODE endif endif end of conditional assembly @ENDNODE @NODE dt define table same as @{"retlw" LINK dt} @ENDNODE @NODE if if see also: @{"else" Link else} @{"endif" Link endif} eg: num1 = 5 num2 = 5 ; == equal ; != not equal ; >= Greater or equal ; <= Less or equal ; && Logical AND ; || Logical OR ; if num1+num2 == 7 error "num1+num2 = 7 else error "num1+num2 != 7" endif if (num1 != 3) && (num2 != 5) error "num1 is not 3 and num2 not 5" endif if num1 < num2 error "num1 is less than num2" else error "num2 is not less than num1" endif if num1 <= num2 error "num1 is less or equal num2" endif if num1 >= num2 error "num1 is greater or equal num2" endif if num1 != num2 error "num1 is not equal num2" endif if (num1==5) || (num2 == 5) error "num1 or num2 is 5" endif @ENDNODE @NODE messg MESSG "" - Create User Defined Message Causes an informational message to be printed in the listing file. The message text can be up to 255 characters. Issuing a MESSG directive does not set any error return codes. @ENDNODE @NODE error ERROR "" - Issue an Error Message The is printed in a format identical to any PICAsm error message. may be from oneto eighty characters. @ENDNODE @NODE space SPACE - Insert Blank Listing Lines example: space 3 Insert number of blank lines into the listing file. @ENDNODE @NODE format "source Code format" source code format format: @{"[label]" Link label} @{"[command]" Link command} @{"[operands]" Link operands} ;@{"[comments]" Link comments} eg: loop incfsz 0fh ;increase register file 0fh goto loop ;goto loop movlw 01100b*4 ;move literal to working register @ENDNODE @NODE label "label" [label] the label may begin with A...Z, a...z or underscore ("_"). case is sensitive as default, you can toggle sensitivity in source with the list parameter. The label may optionally be followed by a colon, which is ignored, but is useful in searching for the line where a label is defined. Labels have to begin at the beginning of the line. eg: loop incfsz 09h goto loop "loop:" is handled same as "loop" without colon behind. A colon before the label defines a local label. :[label] this is an local label, same local labels can be used more than one time in the same program. An local label is only between two normal labels valid. There must be different root labels for same local labels. eg: start swapf 0eh,f :loop incfsz 0eh,f goto :loop next bsf 0fh,6 :loop incfsz 0fh goto :loop @ENDNODE @NODE command "command" [command] PIC mnemonic, macro or assembler directive eg: list p=pic16c54, r=dec, s=off movlw 89 ;move literal to w @ENDNODE @NODE operands "operands" [operand] this could be a literal, expression or label eg: movlw 2*(9*(0x8-5)+10011b) ;move literal (expr) to w movlw h'ff'^"k" ;complement of "k" ;(xor`ed with h'ff') @ENDNODE @NODE comments "comments" [comments] comments to source eg: ;this is a comment @ENDNODE @NODE editor "Using PICasm with CygnusEd" use with CygnusEd you can start PICAsm automatic with Cygnus Ed. If you opened a source file you only need to press choosed function key to save and assemble the actuel source file (when ARexx is running). Here is an ARexx example: -Save this ARexx file to s:PICAsm.ced -Choose "Spezial / Dos/ARexx interface / Install dos Arexx command" in Cygnus Ed -Choose FKey number -Enter Rexx commando (s:PICAsm.ced) -Choose "Spezial / Dos/ARexx interface / Save dos Arexx command" in Cygnus Ed ----------------------------cut here----------------------------------------------------- /* automtic assembling of Pic source code with CygnusEd */ PARSE SOURCE com res called resolved ext host . /* Get host */ IF host="REXX" THEN /* From command line */ ADDRESS "rexx_ced" /* Talk to default ced */ OPTIONS RESULTS /* Enable results from commands */ ARG windowType . /* How to show? */ ADDRESS COMMAND "relabel ram: Ram_Disk" 'DM "assembling source..."' 'Status NUMCHANGES' /* Get number of changes made to file */ IF RESULT~=0 THEN /* Changes were made */ 'Save' /* Save current file */ 'Status FILENAME' /* Fet file name (with path) */ FileName=RESULT Comm="c:PICAsm" FileName /* Set up command string */ /* Change status bar again */ ADDRESS COMMAND Comm /* do the command */ 'CEdToFront' /* Jump back to CEd's screen */ 'DM' /* Restore status line */ EXIT --------------------------cut here-------------------------------------------------------- @ENDNODE @NODE Pic_info "about PIC`s" about PIC`s PIC16c5x register: 00h indirect addressing 01h real time clock counter (RTTC) 02h program counter 03h Status register bit0 => carry bit (c) bit1 => digit carry bit (dc) bit2 => zero bit (z) bit3 => power down bit (pd) bit4 => time out bit (to) bit5 => page select bit (pa0) bit6 => page select bit (pa1) bit7 => unused bit (pa2) 04h file select register, memory page select 05h I/O portA 4bit 06h I/O portB 8bit 07h I/O portC 8bit 08h user Ram . . . Pic16C5x commands: fr => fileregister lit => literal the RETLW literal can be a string, eg: retlw "hello World", h'0a', "good morning", h'0a' retlw 'S','C','E','E' retlw 0x1, 100011b, h'ef' W => Workingregister addr8 => 8bit address (goto) addr9 => 9bit address (call) d => d=0 -> result in W, d=1 -> result in fr (microchip) or: d=w -> result in w, d=f -> result in fr default is d=1 Microchip Description: command: operand: change: description: @{"ADDWF" Link } fr,d c,dc,z add W and fr @{"ANDLW" Link } lit z and W with literal @{"ANDWF" Link } fr,d z and W with fr @{"BCF" Link } fr,b - clear bit @{"BSF" Link } fr,b - set bit @{"BTFSC" Link } fr,b - bit test f and skip if bit clear @{"BTFSS" Link } fr,b - bit test f and skip if bit set @{"CALL" Link } addr8 - call address @{"CLRF" Link } fr z clear fileregister @{"CLRW" Link } z clear Workingregister @{"CLRWDT" Link } to,pd clear Watchdogtimer @{"COMF" Link } fr,d z complement from fr @{"DECF" Link } fr,d z decrease fr @{"DECFSC" Link } fr,d - decrease fr and skip if zero @{"GOTO" Link } addr9 - goto address @{"INCF" Link } fr,d z increase fr @{"INCFSC" Link } fr,d - increase fr and skip if zero @{"IORLW" Link } lit z inclusive or literal with W @{"IORWF" Link } fr,d z inclusive or fr with W @{"MOVF" Link } fr,d z move fr @{"MOVLW" Link } lit - move literal to W @{"MOVWF" Link } fr - move W to fr @{"NOP" Link } - no operation @{"OPTION" Link } - move W to Optionregister @{"RETLW" Link } lit - return from subroutine with literal in W @{"RLF" Link } fr,d c rotate fr left @{"RRF" Link } fr,d c rotate fr right @{"SLEEP" Link } to,pd sleep mode @{"SUBWF" Link } fr,d c,dc,z sub W from fr @{"SWAPF" Link } fr,d - swap nibbles from fr @{"TRIS" Link } port_fr - move W to Tristate register @{"XORLW" Link } lit z literal xor W @{"XORWF" Link } fr,d z exclusive or w with fr additional 16Cxx commands: @{"ADDLW" Link } lit c,dc,z add literal and fr @{"RETFIE" Link } addr - return from interrupt @{"RETURN" Link } addr - return @{"SUBLW" Link } lit c,dc,z sub literal from w Dirk Düsterberg, duesterb@unixserv.rz.fh-hannover.de http://linux.rz.fh-hannover.de/~duesterb @ENDNODE @NODE p16c5x.inc LIST ; P16C5X.INC Standard PICAsm Header File NOLIST ; 16C54 ; 16C55 ; 16C56 ; 16C57 ;========================================================================== W EQU H'0000' F EQU H'0001' ;----- Register Files ----------------------------------------------------- CBLOCK H'0' INDF TMR0 PCL STATUS FSR PORTA PORTB ENDC ;----- STATUS Bits -------------------------------------------------------- CBLOCK H'0' C DC Z NOT_PD NOT_TO PA0 PA1 PA2 ENDC ;----- OPTION Bits -------------------------------------------------------- CBLOCK H'0' PS0 PS1 PS2 PSA T0SE T0CS ENDC LIST @ENDNODE @NODE p16cxx.inc LIST ; P16CXX.INC Standard PICAsm Header File NOLIST ;========================================================================== W EQU H'0000' F EQU H'0001' ;----- Register Files------------------------------------------------------ INDF EQU H'0000' TMR0 EQU H'0001' PCL EQU H'0002' STATUS EQU H'0003' FSR EQU H'0004' PORTA EQU H'0005' PORTB EQU H'0006' PCLATH EQU H'000A' INTCON EQU H'000B' OPTION_REG EQU H'0081' TRISA EQU H'0085' TRISB EQU H'0086' ;----- INTCON Bits (except ADC/Periph) ------------------------------------ GIE EQU H'0007' T0IE EQU H'0005' INTE EQU H'0004' RBIE EQU H'0003' T0IF EQU H'0002' INTF EQU H'0001' RBIF EQU H'0000' ;----- OPTION Bits -------------------------------------------------------- NOT_RBPU EQU H'0007' INTEDG EQU H'0006' T0CS EQU H'0005' T0SE EQU H'0004' PSA EQU H'0003' PS2 EQU H'0002' PS1 EQU H'0001' PS0 EQU H'0000' ;----- STATUS Bits -------------------------------------------------------- IRP EQU H'0007' RP1 EQU H'0006' RP0 EQU H'0005' NOT_TO EQU H'0004' NOT_PD EQU H'0003' Z EQU H'0002' DC EQU H'0001' C EQU H'0000' ;----- Register Files ----------------------------------------------------- EEDATA EQU H'0008' EEADR EQU H'0009' EECON1 EQU H'0088' EECON2 EQU H'0089' LIST @ENDNODE