Forth v6 Function Summary
Summary of
Forth language functions
This document provides an overview by way of subject-sorted lists of the functions (called "Words" in QED-Forth) in the Forth firmware library available in V6.x Forth for the PDQ Board and PDQ Board Lite controllers. QED-Forth is both a programming language and a real-time embedded operating system.
The firmware functions listed on this page are described in detail in their appropriate glossaries:
Using this page
You can click on the function names listed on this page to view their definitions in a popup box.
On this page you'll find a categorized list of all functions (i.e., words) in the v6.x kernel. Unless otherwise noted, their full definitions are found in the main glossary, Forth V6 Function Glossary.
For help in understanding the notation used in the function definitions in the glossaries, consult the description of stack symbols, abbreviations and naming conventions.
If you have been programming the controllers that used the v4.4x kernels and are now using this newer v6.x kernel to program the PDQ Board or PDQ Screen controllers, you might want to consult Forth V6 New Features for a list of differences between this kernel and prior versions.
A separate listing of functions that temporarily disable interrupts is available to assist you in planning the time-critical aspects of your application.
Software development in Forth uses the Codeblocks-based Mosaic IDE Plus Integrated Development Environment; this is the same IDE used for software development in C. While Forth programmers will not use the IDE's GNU C (GCC) compiler, the IDE provides a full-featured text editor and includes Mosaic Terminal for rapid Forth code downloads and interactive Forth debugging sessions with the 9S12 (HCS12) processor on the controller board.
Arrays
(See also the Matrices section.)
| 2ARRAY.FETCH | BLANK.ARRAY | PF.STACK.FRAME |
| 2ARRAY.STORE | COPY.ARRAY | SWAP.ARRAYS |
| ?ARRAY.SIZE | DELETED | ZERO.ARRAY |
| ?DIMENSIONS | DIM.CONSTANT.ARRAY: | [0] |
| ARRAY.PF | DIMENSIONED | [] |
| ARRAY: | FILL.ARRAY | |
Assembler (HCS12/9S12 MCU)
The definitions for these words are found in the Forth V6 Assembler Glossary.
| +LOOP, | BGT | EMUL | LDAB | ROLA |
| ,+PC | BHI | EMULS | LDD | ROLB |
| ,+S | BHS | END-CODE | LDS | ROR |
| ,+X | BITA | END.CODE | LDX | RORA |
| ,+Y | BITB | ENDIF, | LDY | RORB |
| ,-PC | BLE | EORA | LE | RTC |
| ,-S | BLO | EORB | LEAS | RTI |
| ,-X | BLS | EQ | LEAX | RTS |
| ,-Y | BLT | ETBL | LEAY | S, |
| ,PC | BMI | EXG | LO | SBA |
| ,PC+ | BNE | EXT | LONG.AGAIN, | SBCA |
| ,PC- | BPL | FDIV | LONG.BEGIN, | SBCB |
| ,PCR | BRA | GE | LONG.ELSE, | SEC |
| ,S | BRCLR | GT | LONG.ENDIF, | SEI |
| ,S+ | BRN | HI | LONG.IF, | SEV |
| ,S- | BRSET | HS | LONG.REPEAT, | SEX |
| ,X | BSET | IBEQ | LONG.THEN, | STAA |
| ,X+ | BSR | IBNE | LONG.UNTIL, | STAB |
| ,X- | BVC | IDIV | LONG.WHILE, | STD |
| ,Y | BVS | IDIVS | LS | STOP |
| ,Y+ | CALL | IF, | LSL | STS |
| ,Y- | CALL, | IMM | LSLA | STX |
| -LOOP, | CBA | INC | LSLB | STY |
| >ASSM | CC | INCA | LSLD | SUBA |
| >FORTH | CCR, | INCB | LSR | SUBB |
| A, | CLC | IND,PC | LSRA | SUBD |
| A,PC | CLI | IND,S | LSRB | SWI |
| A,S | CLR | IND,X | LSRD | TAB |
| A,X | CLRA | IND,Y | LT | TAP |
| A,Y | CLRB | IND16,PC | MAXA | TBA |
| ABA | CLV | IND16,S | MAXM | TBEQ |
| ABX | CMPA | IND16,X | MEM | TBL |
| ABY | CMPB | IND16,Y | MI | TBNE |
| ADCA | CODE | IND5,PC | MINA | TFR |
| ADCB | COM | IND5,S | MINM | THEN, |
| ADDA | COMA | IND5,X | MOVB | TPA |
| ADDB | COMB | IND5,Y | MOVW | TST |
| ADDD | CPD | IND9,PC | MUL | TSTA |
| AGAIN, | CPS | IND9,S | NE | TSTB |
| ALWAYS | CPX | IND9,X | NEG | TSX |
| ANDA | CPY | IND9,Y | NEGA | TSY |
| ANDB | CS | INS | NEGB | TXS |
| ANDCC | D, | INX | NEVER | TYS |
| ANY.BITS.CLR | D,PC | INY | NOP | UNTIL, |
| ANY.BITS.SET | D,S | JMP | ORAA | VC |
| ASL | D,X | JSR | ORAB | VS |
| ASLA | D,Y | LBCC | ORCC | WAI |
| ASLB | DAA | LBCS | PL | WAV |
| ASLD | DBEQ | LBEQ | PSHA | WHILE, |
| ASR | DBNE | LBGE | PSHB | X, |
| ASRA | DEC | LBGT | PSHC | XCODE |
| ASRB | DECA | LBHI | PSHD | XGDX |
| ASSEMBLER | DECB | LBHS | PSHX | XGDY |
| B, | DES | LBLE | PSHY | Y, |
| B,PC | DEX | LBLO | PULA | [D,PC] |
| B,S | DEY | LBLS | PULB | [D,S] |
| B,X | DIR | LBLT | PULC | [D,X] |
| B,Y | EDIV | LBMI | PULD | [D,Y] |
| BCC | EDIVS | LBNE | PULX | [IND16,PC] |
| BCLR | ELSE, | LBPL | PULY | [IND16,S] |
| BCS | EMACS | LBRA | REL | [IND16,X] |
| BEGIN, | EMAXD | LBRN | REPEAT, | [IND16,Y] |
| BEQ | EMAXM | LBVC | REV | |
| BGE | EMIND | LBVS | REVW | |
| BGND | EMINM | LDAA | ROL | |
C debugging functions
Detailed definitions for these words are found in Forth V6 Functions for C Debugging.
| =CHAR | CHAR* | LONG | =FLOAT | DO[] |
| LONG* | =INT | FLOAT | MAIN | =LONG |
| FLOAT* | MAIN2 | C$>COUNTED$ | FPtoString | PrintFP |
| CALL.CFN | INT | CHAR | INT* | |
Comparison operators
| < | 0= | DMAX | U< | XU< | <> | 0> |
| DMIN | U> | XU> | <= | D< | DRANGE | UMAX |
| = | D<> | DU< | UMIN | > | D= | DU> |
| URANGE | >= | D> | MAX | X<> | 0< | D0<> |
| MIN | X= | 0<> | D0= | RANGE | XRANGE | |
Constants (integer)
Control structures
| +LOOP | ENDIFTRUE | IF | RANGE.OF |
| AGAIN | ENDOF | IFTRUE | RECURSE |
| BEGIN | EXIT | J | REPEAT |
| CASE | FOR | LEAVE | THEN |
| DO | I | LOOP | UNLOOP |
| ELSE | I' | NEXT | UNTIL |
| ENDCASE | I- | OF | URANGE.OF |
| ENDIF | I+ | OTHERWISE | WHILE |
Debug, trace and benchmark functions
| (BENCHMARK:) | BENCHMARK: | DUMP.REGISTERS |
| .HANDLES | BREAK | IS.TRACE.ACTION |
| .MAP | BREAK.ALL | SINGLE.STEP |
| .S | DEBUG | TRACE |
| .SEGMENTS | DEFAULT.TRACE.ACTION | |
| .TASKS | DUMP | |
Definition
(See also Structures)
| CONSTANT | 2CONSTANT | FCONSTANT | XCONSTANT | XCONSTANT.REL |
| VARIABLE | 2VARIABLE | FVARIABLE | XVARIABLE | LOCALS{ |
| EEVARIABLE | EE2VARIABLE | EEFVARIABLE | EEXVARIABLE | USER |
| INTEGER: | DOUBLE: | REAL: | ADDR: | XADDR: |
| REGISTER: | X: | R: | ARRAY: | MATRIX: |
| (CREATE) | CREATE | <DBUILDS | <VBUILDS | DOES> |
| REDEFINE | XCREATE | CODE | RCODE | XCODE |
| : | ; | NO.OP | V.INSTANCE: | D.INSTANCE: |
Device drivers
Analog to digital (ATD)
| ATD.DIGITAL.INPUTS | ATD.ON | ATD.START.SAMPLE |
| ATD.MULTIPLE | ATD.SAMPLE | ATD0-7.RESULTS |
| ATD.OFF | ATD.SINGLE | ATD8-15.RESULTS |
Digital I/O drivers
| PORTAD0 | PORTJ.DIRECTION | PORTP.IN |
| PORTAD0.MODE | PORTM | PORTT |
| PORTAD1 | PORTM.DIRECTION | PORTT.DIRECTION |
| PORTAD1.MODE | PORTP | PORTT.IN |
| PORTJ | PORTP.DIRECTION | |
I2C serial bus drivers
| IIC.104KHZ.23PERCENT | IIC.NUM.BYTES.TO.XMIT | IIC.SEND.FRAME |
| IIC.10KHZ.13PERCENT | IIC.RCV.BUF.FULL | IIC.SEND.NEXT.FRAME |
| IIC.96KHZ.25PERCENT | IIC.RCV.BUF.OFFSET | IIC.TIMEOUT.ERROR |
| IIC.ARB.LOST.ERROR | IIC.RCV.BUF.OVERFLOW | IIC.XMIT.BUF.EMPTY |
| IIC.ERROR | IIC.RCV.BUF.PTR | IIC.XMIT.BUF.OFFSET |
| IIC.FREQUENCIES | IIC.RCV.BUFFER | IIC.XMIT.BUF.OVERFLOW |
| IIC.INIT | IIC.RCV.BUF.SIZE | IIC.XMIT.BUF.PTR |
| IIC.MASTER.RECEIVER | IIC.RECEIVE | IIC.XMIT.BUFFER |
| IIC.NAK.ERROR | IIC.RECEIVE.FRAME | IIC.XMIT.BUF.SIZE |
| IIC.NUM.BYTES.TO.RCV | IIC.SEND | |
Pulse-width modulation (PWM)
| PWM.ACTIVE.HIGH | PWM.DISABLE.MULTIPLE | PWM.SCALED.CLOCK |
| PWM.ACTIVE.LOW | PWM.DUTY.READ | PWM.SCALER |
| PWM.CENTER.ALIGN | PWM.DUTY.WRITE | PWM.SEPARATE |
| PWM.CLOCKA | PWM.ENABLE | PWM.SETUP |
| PWM.CLOCKB | PWM.ENABLE.MULTIPLE | PWM.UNSCALED.CLOCK |
| PWM.CONCATENATE | PWM.LEFT.ALIGN | PWM01 |
| PWM.COUNTER.READ | PWM.PERIOD.READ | PWM23 |
| PWM.COUNTER.WRITE | PWM.PERIOD.WRITE | PWM45 |
| PWM.DISABLE | PWM.PRESCALER | PWM67 |
SPI drivers
| INIT.IP.SPI | SPI.FALLING.LEADING.EDGE | SPI.RISING.LEADING.EDGE |
| INIT.SPI | SPI.FALLING.TRAILING.EDGE | SPI.RISING.TRAILING.EDGE |
| MASTER2 | SPI.FREQUENCIES | SPI.SAVE |
| SPI.CONFIG | SPI.RESOURCE | |
| SPI.EXCHANGE | SPI.RESTORE | |
Timer-controlled I/O drivers
| ECT.CLEAR.INTERRUPT.FLAG | OC.SET.ACTION |
| ECT.FAST.CLEAR | OC.TOGGLE.ACTION |
| ECT.INTERRUPT.DISABLE | OC.TOGGLE.ON.OVERFLOW |
| ECT.INTERRUPT.ENABLE | OC7.CLEARS.IT |
| ECT.PRESCALER | OC7.DISCONNECT |
| ECT.STANDARD.CLEAR | OC7.SETS.IT |
| HOLDING.REG.FORCE.LATCH | OUTPUT.COMPARE |
| IC.1024.CYCLE.DELAY | PULSE.A |
| IC.256.CYCLE.DELAY | PULSE.A.EDGE |
| IC.512.CYCLE.DELAY | PULSE.A.FALLING.EDGE |
| IC.DELAY.DISABLED | PULSE.A.GATED.HIGH |
| IC.FIRST.POLARITY | PULSE.A.GATED.LOW |
| IC.HOLDING.READ | PULSE.A.OVERFLOW |
| IC.NO.OVERWRITE | PULSE.A.RISING.EDGE |
| IC.NOISE.DELAY | PULSE.A.SETUP |
| IC.OVERWRITE.OK | PULSE.B |
| IC.PULSE.CONFIG | PULSE.B.OVERFLOW |
| INPUT.CAPTURE | PULSE.B.SETUP |
| MOD.COUNTER.LOAD | PULSE.DISABLE |
| MOD.COUNTER.READ | PULSE.ENABLE |
| MOD.COUNTER.SETUP | PULSE.HOLDING.READ |
| MOD.COUNTER.UPDATE | PULSE.REG.READ |
| MODULUS.UNDERFLOW | PULSE.REG.WRITE |
| OC.ACTION | TCNT.OVERFLOW |
| OC.CLEAR.ACTION | TCNT.READ |
| OC.FORCE | TRIGGER.EDGE |
| OC.IC.REG.READ | TRIGGER.OFF |
| OC.NO.ACTION | TRIGGER.ON.ANY.EDGE |
| OC.NO.TOGGLE.ON.OVERFLOW | TRIGGER.ON.FALLING.EDGE |
| OC.REG.WRITE | TRIGGER.ON.RISING.EDGE |
Wildcard I/O drivers
| FROM.IO | IO.CHANGE.BITS | SMART.IO.@ |
| FROM.SMART.IO | IO.CLEAR.BITS | SMART.IO.C@ |
| IO.! | IO.F! | SMART.IO.F@ |
| IO.2! | IO.F@ | SMART.IO.X@ |
| IO.2@ | IO.SET.BITS | TO.IO |
| IO.@ | IO.X! | TO.IO.REGISTER |
| IO.C! | IO.X@ | |
| IO.C@ | SMART.IO.2@ | |
Dictionary
| ' | CFA>PFA | IMMEDIATE | NP.NOBUMP |
| (CREATE) | CHANGE.NFA.TYPE | LAST.DP.PAGE | NPAGE |
| (HERE) | CONTEXT | LAST.NP.PAGE | ON.FORGET |
| , | CURRENT | LATEST | PFA>NAME |
| ?C.CALLABLE | DEFINITIONS | LIB2LIB.CFA.FOR | PFA>NFA |
| ?HAS.PFA | DP | LINK | PRIVATE |
| ?IMMEDIATE | DP.NOBUMP | LINK.HASH | SMUDGE |
| ALLOT | DPAGE | MOVE.HEADERS | SMUDGE: |
| ANEW | FORGET | NFA.FOR | VALID.HASH |
| ASSEMBLER | FORTH | NFA>CFA | VFORTH |
| BUILD.HASH.TABLE | FUNCTION.TYPE | NFA>L$ | VOCABULARY |
| C, | HAS.PFA | NFA>LFA | WIDTH |
| C.CALLABLE | HASH.INDEX | NFA>PFA | WORDS |
| CFA.FOR | HASH.INDEX>XADDR | NFA>PROPERTIES | |
| CFA>NAME | HERE | NHERE | |
| CFA>NFA | ID. | NP | |
Floating point comparison
| F< | F= | F0< | F0= | FMAX |
| F<> | F> | F0<> | F0> |
