; ----------------------------------- ; RC5toLCD.f ; ----------------------------------- \ \ to see kernel options, download FastForthSpecs.f \ FastForth kernel options: MSP430ASSEMBLER, CONDCOMP, FREQUENCY = 8/16/24 MHz \ \ TARGET SELECTION \ MSP_EXP430FR5739 MSP_EXP430FR5969 MSP_EXP430FR5994 MSP_EXP430FR6989 \ MSP_EXP430FR2355 \ \ REGISTERS USAGE \ R4 to R7 must be saved before use and restored after \ scratch registers Y to S are free for use \ under interrupt, IP is free for use \ interrupts reset SR register ! \ \ PUSHM order : PSP,TOS, IP, S, T, W, X, Y, rEXIT,rDOVAR,rDOCON, rDODOES, R3, SR,RSP, PC \ PUSHM order : R15,R14,R13,R12,R11,R10, R9, R8, R7 , R6 , R5 , R4 , R3, R2, R1, R0 \ \ example : PUSHM #6,IP pushes IP,S,T,W,X,Y registers to return stack \ \ POPM order : PC,RSP, SR, R3, rDODOES,rDOCON,rDOVAR,rEXIT, Y, X, W, T, S, IP,TOS,PSP \ POPM order : R0, R1, R2, R3, R4 , R5 , R6 , R7 , R8, R9,R10,R11,R12,R13,R14,R15 \ \ example : POPM #6,IP pop Y,X,W,T,S,IP registers from return stack \ \ ASSEMBLER conditionnal usage after IF UNTIL WHILE : S< S>= U< U>= 0= 0<> 0>= \ ASSEMBLER conditionnal usage before ?JMP ?GOTO : S< S>= U< U>= 0= 0<> 0< \ \ FORTH conditionnal : 0= 0< = < > U< \ \ display on a LCD 2x20 CHAR the code sent by an IR remote under philips RC5 protocol \ target : any TI MSP-EXP430FRxxxx launchpad (FRAM) \ LPM_MODE = LPM0 because use SMCLK for LCDVo \ \ DEMO : driver for IR remote compatible with the PHILIPS RC5 protocol \ plus : driver for 5V LCD 2x20 characters display with 4 bits data interface \ without usage of an auxiliary 5V to feed the LCD_Vo \ and without potentiometer to adjust the LCD contrast : \ to adjust LCD contrast, just press S1 (-) or S2 (+) \ LCDVo current consumption ~ 500 uA. \ \ =================================================================================== \ notice : adjust WDT_TIM_EX0,LCD_TIM_CTL,LCD_TIM_EX0 and 20_us to the target frequency if <> 8MHz ! \ =================================================================================== \ \ \ layout : I/O are defined in the launchpad.pat file (don't work with ChipStick_FR2433) \ \ GND <-------o---0V0----------> 1 LCD_Vss \ VCC >-------|---3V6-----o----> 2 LCD_Vdd \ | | \ ___ 470n --- \ ^ --- \ / \ 1N4148 | \ --- | \ 100n | 2k2 | \ TB0.2 >---||--o--^/\/\/v--o----> 3 LCD_Vo (= 0V6 without modulation) \ -------------------------> 4 LCD_RW \ -------------------------> 5 LCD_RW \ -------------------------> 6 LCD_EN \ <------------------------> 11 LCD_DB4 \ <------------------------> 12 LCD_DB5 \ <------------------------> 13 LCD_DB5 \ <------------------------> 14 LCD_DB7 \ \ <----- LCD contrast + <--- Sw1 <--- (finger) :-) \ <----- LCD contrast - <--- Sw2 <--- (finger) :-) \ \ rc5 <--- OUT IR_Receiver (1 TSOP32236) [DEFINED] {RC5TOLCD} [IF] {RC5TOLCD} [THEN] \ remove application MARKER {RC5TOLCD} [UNDEFINED] MAX [IF] \ MAX and MIN are defined in {ANS_COMP} CODE MAX \ n1 n2 -- n3 signed maximum CMP @PSP,TOS \ n2-n1 S< ?GOTO FW1 \ n2= 2) >R <# 0 # #S #> R> OVER - 0 MAX SPACES TYPE ; [THEN] CODE 20_US \ n -- n * 20 us BEGIN \ here we presume that LCD_TIM_IFG = 1... BEGIN BIT #1,&LCD_TIM_CTL \ 3 0<> UNTIL \ 2 loop until LCD_TIM_IFG set BIC #1,&LCD_TIM_CTL \ 3 clear LCD_TIM_IFG SUB #1,TOS \ 1 U< UNTIL \ 2 ...so add a dummy loop with U< instead of 0= MOV @PSP+,TOS \ 2 MOV @IP+,PC \ 4 ENDCODE CODE TOP_LCD \ LCD Sample \ \ if write : %xxxxWWWW -- \ \ if read : -- %0000RRRR BIS.B #LCD_EN,&LCD_CMD_OUT \ lcd_en 0-->1 BIT.B #LCD_RW,&LCD_CMD_IN \ lcd_rw test 0= IF \ write LCD bits pattern AND.B #LCD_DB,TOS \ MOV.B TOS,&LCD_DB_OUT \ send LCD_Data BIC.B #LCD_EN,&LCD_CMD_OUT \ lcd_en 1-->0 ==> strobe data MOV @PSP+,TOS \ MOV @IP+,PC THEN \ read LCD bits pattern SUB #2,PSP MOV TOS,0(PSP) BIC.B #LCD_EN,&LCD_CMD_OUT \ lcd_en 1-->0 ==> strobe data MOV.B &LCD_DB_IN,TOS \ get LCD_Data AND.B #LCD_DB,TOS \ MOV @IP+,PC ENDCODE CODE LCD_W \ byte -- write byte to LCD SUB #2,PSP \ MOV TOS,0(PSP) \ -- %xxxxLLLL %HHHHLLLL RRUM #4,TOS \ -- %xxxxLLLL %xxxxHHHH BIC.B #LCD_RW,&LCD_CMD_OUT \ lcd_rw=0 BIS.B #LCD_DB,&LCD_DB_DIR \ LCD_Data as output COLON \ high level word starts here TOP_LCD 2 20_US \ write high nibble first TOP_LCD 2 20_US ; CODE LCD_WRC \ char -- Write Char BIS.B #LCD_RS,&LCD_CMD_OUT \ lcd_rs=1 JMP LCD_W ENDCODE CODE LCD_WRF \ func -- Write Fonction BIC.B #LCD_RS,&LCD_CMD_OUT \ lcd_rs=0 JMP LCD_W ENDCODE : LCD_CLEAR $01 LCD_WRF 100 20_us \ $01 LCD_WrF 80 20_us ==> bad init ! ; : LCD_HOME $02 LCD_WRF 100 20_us ; [UNDEFINED] OR [IF] \ https://forth-standard.org/standard/core/OR \ C OR x1 x2 -- x3 logical OR CODE OR BIS @PSP+,TOS MOV @IP+,PC ENDCODE [THEN] : LCD_ENTRY_SET $04 OR LCD_WrF ; : LCD_DSP_CTRL $08 OR LCD_WrF ; : LCD_DSP_SHIFT $10 OR LCD_WrF ; : LCD_FN_SET $20 OR LCD_WrF ; : LCD_CGRAM_SET $40 OR LCD_WrF ; : LCD_GOTO $80 OR LCD_WrF ; CODE LCD_R \ -- byte read byte from LCD BIC.B #LCD_DB,&LCD_DB_DIR \ LCD_Data as intput BIS.B #LCD_RW,&LCD_CMD_OUT \ lcd_rw=1 COLON \ starts a FORTH word TOP_LCD 2 20_us \ -- %0000HHHH TOP_LCD 2 20_us \ -- %0000HHHH %0000LLLL HI2LO \ switch from FORTH to assembler RLAM #4,0(PSP) \ -- %HHHH0000 %0000LLLL ADD.B @PSP+,TOS \ -- %HHHHLLLL MOV @RSP+,IP \ restore IP saved by COLON MOV @IP+,PC \ ENDCODE CODE LCD_RDS \ -- status Read Status BIC.B #LCD_RS,&LCD_CMD_OUT \ lcd_rs=0 JMP LCD_R ENDCODE CODE LCD_RDC \ -- char Read Char BIS.B #LCD_RS,&LCD_CMD_OUT \ lcd_rs=1 JMP LCD_R ENDCODE \ ******************************\ ASM WDT_INT \ Watchdog interrupt routine, warning : not FORTH executable ! \ ******************************\ \ XOR.B #LED1,&LED1_OUT \ to visualise WDT BIT.B #SW2,&SW2_IN \ test switch S2 0= IF \ case of switch S2 pressed CMP #19,&LCD_TIM_CCR2 \ maxi Ton = 19/20 & VDD=3V6 ==> LCD_Vo = -1V4 U< IF ADD #1,&LCD_TIM_CCR2 \ action for switch S2 (P2.5) : 150 mV / increment THEN ELSE BIT.B #SW1,&SW1_IN \ test switch S1 input 0= IF \ case of Switch S1 pressed CMP #3,&LCD_TIM_CCR2 \ mini Ton = 3/20 & VDD=3V6 ==> LCD_Vo = 0V U>= IF \ SUB #1,&LCD_TIM_CCR2 \ action for switch S1 (P2.6) : -150 mV / decrement THEN \ THEN \ THEN \ BW1 \ from quit on truncated RC5 message BW2 \ from repeated RC5 command BW3 \ from end of RC5_INT BIC #$78,0(RSP) \ 4 SCG0,OSCOFF,CPUOFF and GIE are OFF in retiSR to force LPM0_LOOP despite pending interrupt RETI \ 5 ENDASM \ ******************************\ ASM RC5_INT \ wake up on Px.RC5 change interrupt \ ******************************\ \ IR_RC5 driver \ IP,S,T,W,X,Y registers are free for use \ ******************************\ \ \ in : SR(9)=old Toggle bit memory (ADD on) \ \ SMclock = 8|16|24 MHz \ \ use : T,W,X,Y, RC5_TIM_ timer, RC5_TIM_R register \ \ out : X = 0 C6 C5 C4 C3 C2 C1 C0 \ \ SR(9)=new Toggle bit memory (ADD on) \ ******************************\ \ RC5_FirstStartBitHalfCycle: \ \ ******************************\ division in RC5_TIM_CTL (SMCLK/1|SMCLK/1|SMCLK/2|SMCLK/4|SMCLK/8) \ FREQ_KHZ @ 8000 = [IF] \ 8 MHz ? \ MOV #0,&RC5_TIM_EX0 \ predivide by 1 in RC5_TIM_EX0 register, reset value \ [THEN] FREQ_KHZ @ 16000 = [IF] \ 16 MHz ? MOV #1,&RC5_TIM_EX0 \ predivide by 2 in RC5_TIM_EX0 register [THEN] FREQ_KHZ @ 24000 = [IF] \ 24 MHz ? MOV #2,&RC5_TIM_EX0 \ predivide by 3 in RC5_TIM_EX0 register [THEN] MOV #1778,X \ RC5_Period * 1us MOV #14,W \ count of loop BEGIN \ \ ******************************\ \ RC5_HalfCycle \ <--- loop back ---+ with readjusted RC5_Period \ ******************************\ | MOV #%1011100100,&RC5_TIM_CTL \ (re)start timer_A | SMCLK/8 time interval,free running,clear RC5_TIM__IFG and RC5_TIM_R \ RC5_Compute_3/4_Period: \ | RRUM #1,X \ X=1/2 cycle | MOV X,Y \ ^ RRUM #1,Y \ Y=1/4 ADD X,Y \ Y=3/4 cycle BEGIN CMP Y,&RC5_TIM_R \ 3 wait 1/2 + 3/4 cycle = n+1/4 cycles U>= UNTIL \ 2 \ ******************************\ \ RC5_SampleOnFirstQuarter \ at n+1/4 cycles, we sample RC5_input, ST2/C6 bit first \ ******************************\ BIT.B #RC5,&IR_IN \ C_flag = IR bit ADDC T,T \ C_flag <-- T(15):T(0) <-- C_flag MOV.B &IR_IN,&IR_IES \ preset Px_IES.y state for next IFG BIC.B #RC5,&IR_IFG \ clear Px_IFG.y after 4/4 cycle pin change SUB #1,W \ decrement count loop \ \ count = 13 ==> T = x x x x x x x x |x x x x x x x /C6 \ \ count = 0 ==> T = x x /C6 Tg A4 A3 A2 A1|A0 C5 C4 C3 C2 C1 C0 1 0<> WHILE \ ----> out of loop ----+ ADD X,Y \ | Y = n+3/4 cycles = time out because n+1/2 cycles edge is always present BEGIN \ | MOV &RC5_TIM_R,X \ 3 | X grows from n+1/4 up to n+3/4 cycles CMP Y,X \ 1 | cycle time out of bound ? U>= IF \ 2 ^ | yes: BIC #$30,&RC5_TIM_CTL \ | | stop timer GOTO BW1 \ | | quit on truncated RC5 message THEN \ | | BIT.B #RC5,&IR_IFG \ 3 | | n+1/2 cycles edge is always present 0<> UNTIL \ 2 | | REPEAT \ ----> loop back --+ | with X = new RC5_period value \ ******************************\ | \ RC5_SampleEndOf: \ <---------------------+ \ ******************************\ BIC #$30,&RC5_TIM_CTL \ stop timer \ ******************************\ \ RC5_ComputeNewRC5word \ \ ******************************\ RLAM #1,T \ T = x /C6 Tg A4 A3 A2 A1 A0|C5 C4 C3 C2 C1 C0 1 0 MOV.B T,X \ X = C5 C4 C3 C2 C1 C0 1 0 RRUM #2,X \ X = 0 0 C5 C4 C3 C2 C1 C0 \ ******************************\ \ RC5_ComputeC6bit \ \ ******************************\ BIT #BIT14,T \ test /C6 bit in T 0= IF BIS #BIT6,X \ set C6 bit in X THEN \ X = 0 C6 C5 C4 C3 C2 C1 C0 \ ******************************\ \ RC5_CommandByteIsDone \ -- BASE RC5_code \ ******************************\ \ Only New_RC5_Command ADD_ON \ use SR(9) bit as toggle bit \ ******************************\ RRUM #3,T \ new toggle bit = T(13) ==> T(10) XOR @RSP,T \ (new XOR old) Toggle bits BIT #UF10,T \ repeated RC5_command ? 0= ?GOTO BW2 \ yes, RETI without UF10 change and without action ! XOR #UF10,0(RSP) \ 5 toggle bit memory \ ******************************\ \ Display IR_RC5 code \ X = RC5 code \ ******************************\ SUB #4,PSP \ MOV &BASE,2(PSP) \ save current base MOV #$10,&BASE \ set hex base MOV TOS,0(PSP) \ save TOS MOV X,TOS \ LO2HI \ switch from assembler to FORTH ['] LCD_CLEAR IS CR \ redirects CR to LCD ['] LCD_WRC IS EMIT \ redirects EMIT to LCD CR ." $" 2 U.R \ print IR_RC5 code to LCD ['] CR >BODY IS CR \ restore CR ['] EMIT >BODY IS EMIT \ restore EMIT HI2LO \ switch from FORTH to assembler MOV TOS,&BASE \ restore current BASE MOV @PSP+,TOS \ \ ******************************\ GOTO BW3 \ ******************************\ ENDASM \ ------------------------------\ ASM BACKGROUND \ \ ------------------------------\ BEGIN \ ... \ insert here your background task \ ... \ \ ... \ BIS &LPM_MODE,SR \ \ ******************************\ \ here start all interrupts \ \ ******************************\ \ here return all interrupts \ \ ******************************\ AGAIN \ ENDASM \ \ ------------------------------\ CODE STOP \ stops multitasking, must to be used before downloading app \ ------------------------------\ \ restore default action of primary DEFERred word SLEEP (assembly version) MOV #SLEEP,X \ the ASM word SLEEP is only visible in mode assembler. ADD #4,X \ X = BODY of SLEEP, X-2 = PFA of SLEEP MOV X,-2(X) \ restore the default background COLON \ restore default action of primary DEFERred word WARM (FORTH version) ['] WARM >BODY IS WARM \ remove START from FORTH init process ECHO \ ." RC5toLCD is removed." CR \ display message ." type START to restart" \ COLD \ performs reset to reset all interrupt vectors. ; \ ------------------------------\ CODE START \ this routine completes the init of system, i.e. FORTH + this app. \ ------------------------------\ \ LCD_TIM_CTL = %0000 0010 1001 0100\$3C0 \ - - \CNTL Counter lentgh \ 00 = 16 bits \ -- \TBSSEL TimerB clock select \ 10 = SMCLK \ -- \ID input divider \ 10 = /4 \ -- \MC Mode Control \ 01 = up to LCD_TIM_CCR0 \ - \TBCLR TimerB Clear \ - \TBIE \ -\TBIFG \ -------------------------------\ \ LCD_TIM_CCTLx = %0000 0000 0110 0000\$3C{2,4,6,8,A,C,E} \ -- \CM Capture Mode \ -- \CCIS \ - \SCS \ -- \CLLD \ - \CAP \ --- \OUTMOD \ 011 = set/reset \ - \CCIE \ - \CCI \ - \OUT \ - \COV \ -\CCIFG \ -------------------------------\ \ LCD_TIM_CCRx \ \ -------------------------------\ \ LCD_TIM_EX0 \ \ ------------------------------\ \ set LCD_TIM_ to make 50kHz PWM \ for LCD_Vo; works without interrupt \ ------------------------------\ MOV #%1011010100,&LCD_TIM_CTL \ SMCLK/8, up mode, clear timer, no int \ MOV #0,&LCD_TIM_EX0 \ predivide by 1 in LCD_TIM_EX0 register (8 MHZ) FREQ_KHZ @ 16000 = [IF] \ if 16 MHz MOV #1,&LCD_TIM_EX0 \ predivide by 2 in LCD_TIM_EX0 register (16 MHZ) [THEN] FREQ_KHZ @ 24000 = [IF] \ if 24 MHz MOV #2,&LCD_TIM_EX0 \ predivide by 3 in LCD_TIM_EX0 register (24 MHZ) [THEN] MOV #19,&LCD_TIM_CCR0 \ 19+1=20*1us=20us \ ------------------------------\ \ set LCD_TIM_.2 to generate PWM for LCD_Vo \ ------------------------------\ MOV #%01100000,&LCD_TIM_CCTL2 \ output mode = set/reset \ clear CCIFG MOV #10,&LCD_TIM_CCR2 \ contrast adjust : 10/20 ==> LCD_Vo = -0V6|+3V6 (Vcc=3V6) \ MOV #12,&LCD_TIM_CCR2 \ contrast adjust : 12/20 ==> LCD_Vo = -1V4|+3V3 (Vcc=3V3) \ ------------------------------\ BIS.B #LCDVo,&LCDVo_DIR \ BIS.B #LCDVo,&LCDVo_SEL \ SEL.2 \ ------------------------------\ BIS.B #LCD_CMD,&LCD_CMD_DIR \ lcd_cmd as outputs BIC.B #LCD_CMD,&LCD_CMD_REN \ lcd_cmd pullup/down disable \ ------------------------------\ BIS.B #LCD_DB,&LCD_DB_DIR \ as output, wired to DB(4-7) LCD_Data BIC.B #LCD_DB,&LCD_DB_REN \ LCD_Data pullup/down disable \ ******************************\ \ init RC5_Int \ \ ******************************\ BIS.B #RC5,&IR_IE \ enable RC5_Int BIC.B #RC5,&IR_IFG \ reset RC5_Int flag MOV #RC5_INT,&IR_Vec \ init interrupt vector \ ******************************\ \ init WatchDog WDT_TIM_ \ eUSCI_A0 (FORTH terminal) has higher priority than WDT_TIM_ \ ******************************\ \ %01 0001 0100 \ TAxCTL \ -- \ TASSEL CLK = ACLK = LFXT = 32768 Hz \ -- \ ID divided by 1 \ -- \ MC MODE = up to TAxCCRn \ - \ TACLR clear timer count \ - \ TAIE \ - \ TAIFG \ ------------------------------\ MOV #%0100010100,&WDT_TIM_CTL \ start WDT_TIM_, ACLK, up mode, disable int, \ ------------------------------\ \ 000 \ TAxEX0 \ --- \ TAIDEX pre divisor \ ------------------------------\ \ %0000 0000 0000 0101 \ TAxCCR0 MOV ##1638,&WDT_TIM_CCR0 \ else init WDT_TIM_ for LFXT: 32768/20=1638 ==> 50ms \ ------------------------------\ \ %0000 0000 0001 0000 \ TAxCCTL0 \ - \ CAP capture/compare mode = compare \ - \ CCIEn \ - \ CCIFGn MOV #%10000,&WDT_TIM_CCTL0 \ enable compare interrupt, clear CCIFG0 \ ------------------------------\ MOV #WDT_INT,&WDT_TIM_0_Vec \ for only CCIFG0 int, this interrupt clears automatically CCIFG0 \ ------------------------------\ \ define LPM mode for ACCEPT \ \ ------------------------------\ \ MOV #LPM4,&LPM_MODE \ with MSP430FR59xx \ MOV #LPM2,&LPM_MODE \ with MSP430FR57xx, terminal input don't work for LPMx > 2 \ \ with MSP430FR2xxx, terminal input don't work for LPMx > 0 ; LPM0 is the default value \ ------------------------------\ \ redirects to background task \ \ ------------------------------\ MOV #SLEEP,X \ MOV #BACKGROUND,2(X) \ \ ------------------------------\ \ activate I/O \ \ ------------------------------\ BIC #1,&PM5CTL0 \ activate all previous I/O settings; if not activated, nothing works after reset ! BIS.B #TERM_BUS,&TERM_SEL \ Configure pins TXD & RXD for TERM_UART use, otherwise no TERMINAL ! \ ------------------------------\ \ RESET events handling \ search "SYSRSTIV" in your MSP430FRxxxx datasheet \ ------------------------------\ MOV &SAVE_SYSRSTIV,Y \ Y = SYSRSTIV register memory \ CMP #2,Y \ Power_ON event \ 0= ?JMP STOP \ uncomment if you want to loose application in this case... CMP #4,Y \ 0= ?JMP STOP \ hardware RESET performs STOP. Should be mandatory... \ CMP #6,Y \ \ 0= ?JMP STOP \ COLD event performs STOP... uncomment if it's that you want. \ CMP #$0A,Y \ \ 0= ?JMP STOP \ fault event (violation memory protected areas) performs STOP \ CMP #$16,Y \ \ U>= ?JMP STOP \ all other fault events + Deep Reset perform STOP \ ------------------------------\ COLON \ \ ------------------------------\ \ Init LCD 2x20 \ \ ------------------------------\ #1000 20_US \ 1- wait 20 ms %011 TOP_LCD \ 2- send DB5=DB4=1 #205 20_US \ 3- wait 4,1 ms %011 TOP_LCD \ 4- send again DB5=DB4=1 #5 20_US \ 5- wait 0,1 ms %011 TOP_LCD \ 6- send again again DB5=DB4=1 #2 20_US \ wait 40 us = LCD cycle %010 TOP_LCD \ 7- send DB5=1 DB4=0 #2 20_US \ wait 40 us = LCD cycle %00101000 LCD_WRF \ 8- %001DNFxx "FonctionSet" D=8/4 DataBus width, Number of lines=2/1, Font bold/normal %1000 LCD_WRF \ 9- %1DCB "DisplayControl" : Display off, Cursor off, Blink off. LCD_CLEAR \ 10- "LCD_Clear" %0110 LCD_WRF \ 11- %01xx "LCD_EntrySet" : address and cursor shift after writing in RAM %1100 LCD_WRF \ 12- %1DCB "DisplayControl" : Display on, Cursor off, Blink off. LCD_CLEAR \ 10- "LCD_Clear" ['] LCD_HOME IS CR \ ' CR redirected to LCD_HOME ['] LCD_WRC IS EMIT \ ' EMIT redirected to LCD_WrC CR ." I love you" \ display message on LCD ['] CR >BODY IS CR \ CR executes its default value ['] EMIT >BODY IS EMIT \ EMIT executes its defaulte value ." RC5toLCD is running. Type STOP to quit" \ display message on FastForth Terminal \ ------------------------------\ \ START replaces WARM \ \ ------------------------------\ LIT RECURSE IS WARM \ START replaces WARM... \ ['] WARM >BODY EXECUTE \ ...and end START with default WARM, no return. ABORT \ ...and end START with ABORT, no return. ; \ ECHO ; downloading RC5toLCD.4th is done RST_HERE ; this app is protected against \ START