From 8918afdf94c230cf59cb70dbfd34e15bf163a000 Mon Sep 17 00:00:00 2001 From: "Collin J. Doering" Date: Wed, 11 Jul 2018 23:42:56 -0400 Subject: [PATCH] Initial commit Signed-off-by: Collin J. Doering --- .gitignore | 6 + README.md | 26 + UART-Echo-LCD/UART-Echo-LCD-cache.lib | 4 + UART-Echo-LCD/UART-Echo-LCD.bak | 1 + UART-Echo-LCD/UART-Echo-LCD.kicad_pcb | 1 + UART-Echo-LCD/UART-Echo-LCD.pro | 61 ++ UART-Echo-LCD/UART-Echo-LCD.sch | 46 ++ UART-Echo-LCD/kicad_lib/CharacterLCD.bak | 238 ++++++ UART-Echo-LCD/kicad_lib/CharacterLCD.bck | 13 + UART-Echo-LCD/kicad_lib/CharacterLCD.dcm | 13 + UART-Echo-LCD/kicad_lib/CharacterLCD.lib | 238 ++++++ src/LICENSE | 677 ++++++++++++++++ src/Makefile | 196 +++++ src/USART.c | 62 ++ src/USART.h | 43 + src/lcdLib/ansi_escapes.h | 56 ++ src/lcdLib/lcdLib.c | 969 +++++++++++++++++++++++ src/lcdLib/lcdLib.h | 328 ++++++++ src/lcdLib/lcdLibConfig.h | 156 ++++ src/lcdLib/lcd_instr.h | 61 ++ src/uart_echo.c | 107 +++ 21 files changed, 3302 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 UART-Echo-LCD/UART-Echo-LCD-cache.lib create mode 100644 UART-Echo-LCD/UART-Echo-LCD.bak create mode 100644 UART-Echo-LCD/UART-Echo-LCD.kicad_pcb create mode 100644 UART-Echo-LCD/UART-Echo-LCD.pro create mode 100644 UART-Echo-LCD/UART-Echo-LCD.sch create mode 100644 UART-Echo-LCD/kicad_lib/CharacterLCD.bak create mode 100644 UART-Echo-LCD/kicad_lib/CharacterLCD.bck create mode 100644 UART-Echo-LCD/kicad_lib/CharacterLCD.dcm create mode 100644 UART-Echo-LCD/kicad_lib/CharacterLCD.lib create mode 100644 src/LICENSE create mode 100644 src/Makefile create mode 100644 src/USART.c create mode 100644 src/USART.h create mode 100644 src/lcdLib/ansi_escapes.h create mode 100644 src/lcdLib/lcdLib.c create mode 100644 src/lcdLib/lcdLib.h create mode 100644 src/lcdLib/lcdLibConfig.h create mode 100644 src/lcdLib/lcd_instr.h create mode 100644 src/uart_echo.c diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6e92e60 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*.elf +*.map +*.o +*.hex +*.lst +*~ diff --git a/README.md b/README.md new file mode 100644 index 0000000..57381c6 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Echo Serial terminal to LCD character display (using lcdLib) + +* [Features](#features) +* [Tools](#tools) +* [License](#license) +* [Building](#building) +* [Issues](#issues) +* [Road Map](#road-map) + +## Features + +## Tools + +## License + +Code licensed under ([GPLv3][]. Please see the LICENSE file for full details. + +## Building + +## Issues + +## Road Map + + +[Gnu Emacs]: http://www.gnu.org/software/emacs/ +[GPLv3]: https://www.gnu.org/licenses/gpl.html diff --git a/UART-Echo-LCD/UART-Echo-LCD-cache.lib b/UART-Echo-LCD/UART-Echo-LCD-cache.lib new file mode 100644 index 0000000..2063b3a --- /dev/null +++ b/UART-Echo-LCD/UART-Echo-LCD-cache.lib @@ -0,0 +1,4 @@ +EESchema-LIBRARY Version 2.3 +#encoding utf-8 +# +#End Library diff --git a/UART-Echo-LCD/UART-Echo-LCD.bak b/UART-Echo-LCD/UART-Echo-LCD.bak new file mode 100644 index 0000000..8b829fb --- /dev/null +++ b/UART-Echo-LCD/UART-Echo-LCD.bak @@ -0,0 +1 @@ +EESchema Schematic File Version 2 diff --git a/UART-Echo-LCD/UART-Echo-LCD.kicad_pcb b/UART-Echo-LCD/UART-Echo-LCD.kicad_pcb new file mode 100644 index 0000000..02c8ecb --- /dev/null +++ b/UART-Echo-LCD/UART-Echo-LCD.kicad_pcb @@ -0,0 +1 @@ +(kicad_pcb (version 4) (host kicad "dummy file") ) diff --git a/UART-Echo-LCD/UART-Echo-LCD.pro b/UART-Echo-LCD/UART-Echo-LCD.pro new file mode 100644 index 0000000..c2ceb74 --- /dev/null +++ b/UART-Echo-LCD/UART-Echo-LCD.pro @@ -0,0 +1,61 @@ +update=Tue 12 Jan 2016 02:07:56 AM EST +version=1 +last_client=kicad +[pcbnew] +version=1 +LastNetListRead= +UseCmpFile=1 +PadDrill=0.600000000000 +PadDrillOvalY=0.600000000000 +PadSizeH=1.500000000000 +PadSizeV=1.500000000000 +PcbTextSizeV=1.500000000000 +PcbTextSizeH=1.500000000000 +PcbTextThickness=0.300000000000 +ModuleTextSizeV=1.000000000000 +ModuleTextSizeH=1.000000000000 +ModuleTextSizeThickness=0.150000000000 +SolderMaskClearance=0.000000000000 +SolderMaskMinWidth=0.000000000000 +DrawSegmentWidth=0.200000000000 +BoardOutlineThickness=0.100000000000 +ModuleOutlineThickness=0.150000000000 +[cvpcb] +version=1 +NetIExt=net +[general] +version=1 +[eeschema] +version=1 +LibDir= +[eeschema/libraries] +LibName1=power +LibName2=device +LibName3=transistors +LibName4=conn +LibName5=linear +LibName6=regul +LibName7=74xx +LibName8=cmos4000 +LibName9=adc-dac +LibName10=memory +LibName11=xilinx +LibName12=microcontrollers +LibName13=dsp +LibName14=microchip +LibName15=analog_switches +LibName16=motorola +LibName17=texas +LibName18=intel +LibName19=audio +LibName20=interface +LibName21=digital-audio +LibName22=philips +LibName23=display +LibName24=cypress +LibName25=siliconi +LibName26=opto +LibName27=atmel +LibName28=contrib +LibName29=valves +LibName30=kicad_lib/CharacterLCD diff --git a/UART-Echo-LCD/UART-Echo-LCD.sch b/UART-Echo-LCD/UART-Echo-LCD.sch new file mode 100644 index 0000000..1b5fad4 --- /dev/null +++ b/UART-Echo-LCD/UART-Echo-LCD.sch @@ -0,0 +1,46 @@ +EESchema Schematic File Version 2 +LIBS:power +LIBS:device +LIBS:transistors +LIBS:conn +LIBS:linear +LIBS:regul +LIBS:74xx +LIBS:cmos4000 +LIBS:adc-dac +LIBS:memory +LIBS:xilinx +LIBS:microcontrollers +LIBS:dsp +LIBS:microchip +LIBS:analog_switches +LIBS:motorola +LIBS:texas +LIBS:intel +LIBS:audio +LIBS:interface +LIBS:digital-audio +LIBS:philips +LIBS:display +LIBS:cypress +LIBS:siliconi +LIBS:opto +LIBS:atmel +LIBS:contrib +LIBS:valves +LIBS:CharacterLCD +EELAYER 25 0 +EELAYER END +$Descr A4 11693 8268 +encoding utf-8 +Sheet 1 1 +Title "" +Date "" +Rev "" +Comp "" +Comment1 "" +Comment2 "" +Comment3 "" +Comment4 "" +$EndDescr +$EndSCHEMATC diff --git a/UART-Echo-LCD/kicad_lib/CharacterLCD.bak b/UART-Echo-LCD/kicad_lib/CharacterLCD.bak new file mode 100644 index 0000000..79a10da --- /dev/null +++ b/UART-Echo-LCD/kicad_lib/CharacterLCD.bak @@ -0,0 +1,238 @@ +EESchema-LIBRARY Version 2.3 +#encoding utf-8 +# +# DISPLAY +# +DEF DISPLAY S 0 40 Y Y 1 F N +F0 "S" -1050 750 60 H V C CNN +F1 "DISPLAY" 700 -450 60 H V C CNN +F2 "" 0 -150 60 H V C CNN +F3 "" 0 -150 60 H V C CNN +DRAW +S -1550 700 1200 -400 0 1 0 N +S -1300 450 950 -200 0 1 0 N +S -1250 -50 -1200 -150 0 1 0 N +S -1250 100 -1200 0 0 1 0 N +S -1250 250 -1200 150 0 1 0 N +S -1250 400 -1200 300 0 1 0 N +S -1150 -50 -1100 -150 0 1 0 N +S -1150 100 -1100 0 0 1 0 N +S -1150 250 -1100 150 0 1 0 N +S -1150 400 -1100 300 0 1 0 N +S -1050 -50 -1000 -150 0 1 0 N +S -1050 100 -1000 0 0 1 0 N +S -1050 250 -1000 150 0 1 0 N +S -1050 400 -1000 300 0 1 0 N +S -950 -50 -900 -150 0 1 0 N +S -950 100 -900 0 0 1 0 N +S -950 250 -900 150 0 1 0 N +S -950 400 -900 300 0 1 0 N +S -850 -50 -800 -150 0 1 0 N +S -850 100 -800 0 0 1 0 N +S -850 250 -800 150 0 1 0 N +S -850 400 -800 300 0 1 0 N +S -750 -50 -700 -150 0 1 0 N +S -750 100 -700 0 0 1 0 N +S -750 250 -700 150 0 1 0 N +S -750 400 -700 300 0 1 0 N +S -650 -50 -600 -150 0 1 0 N +S -650 100 -600 0 0 1 0 N +S -650 250 -600 150 0 1 0 N +S -650 400 -600 300 0 1 0 N +S -550 -50 -500 -150 0 1 0 N +S -550 100 -500 0 0 1 0 N +S -550 250 -500 150 0 1 0 N +S -550 400 -500 300 0 1 0 N +S -450 -50 -400 -150 0 1 0 N +S -450 100 -400 0 0 1 0 N +S -450 250 -400 150 0 1 0 N +S -450 400 -400 300 0 1 0 N +S -350 -50 -300 -150 0 1 0 N +S -350 100 -300 0 0 1 0 N +S -350 250 -300 150 0 1 0 N +S -350 400 -300 300 0 1 0 N +S -250 -50 -200 -150 0 1 0 N +S -250 100 -200 0 0 1 0 N +S -250 250 -200 150 0 1 0 N +S -250 400 -200 300 0 1 0 N +S -150 -50 -100 -150 0 1 0 N +S -150 100 -100 0 0 1 0 N +S -150 250 -100 150 0 1 0 N +S -150 400 -100 300 0 1 0 N +S -50 -50 0 -150 0 1 0 N +S -50 100 0 0 0 1 0 N +S -50 250 0 150 0 1 0 N +S -50 400 0 300 0 1 0 N +S 50 -50 100 -150 0 1 0 N +S 50 100 100 0 0 1 0 N +S 50 250 100 150 0 1 0 N +S 50 400 100 300 0 1 0 N +S 150 -50 200 -150 0 1 0 N +S 150 100 200 0 0 1 0 N +S 150 250 200 150 0 1 0 N +S 150 400 200 300 0 1 0 N +S 250 -50 300 -150 0 1 0 N +S 250 100 300 0 0 1 0 N +S 250 250 300 150 0 1 0 N +S 250 400 300 300 0 1 0 N +S 350 -50 400 -150 0 1 0 N +S 350 100 400 0 0 1 0 N +S 350 250 400 150 0 1 0 N +S 350 400 400 300 0 1 0 N +S 450 -50 500 -150 0 1 0 N +S 450 100 500 0 0 1 0 N +S 450 250 500 150 0 1 0 N +S 450 400 500 300 0 1 0 N +S 550 -50 600 -150 0 1 0 N +S 550 100 600 0 0 1 0 N +S 550 250 600 150 0 1 0 N +S 550 400 600 300 0 1 0 N +S 650 -50 700 -150 0 1 0 N +S 650 100 700 0 0 1 0 N +S 650 250 700 150 0 1 0 N +S 650 400 700 300 0 1 0 N +S 750 -50 800 -150 0 1 0 N +S 750 100 800 0 0 1 0 N +S 750 250 800 150 0 1 0 N +S 750 400 800 300 0 1 0 N +S 850 -50 900 -150 0 1 0 N +S 850 100 900 0 0 1 0 N +S 850 250 900 150 0 1 0 N +S 850 400 900 300 0 1 0 N +X VSS 1 1450 650 250 L 50 50 1 1 W +X VDD 2 1450 550 250 L 50 50 1 1 W +X V0 3 1450 450 250 L 50 50 1 1 I +X RS 4 -1800 650 250 R 50 50 1 1 I +X RW 5 -1800 550 250 R 50 50 1 1 I +X E 6 -1800 450 250 R 50 50 1 1 I +X D0 7 -1800 350 250 R 50 50 1 1 T +X D1 8 -1800 250 250 R 50 50 1 1 T +X D2 9 -1800 150 250 R 50 50 1 1 T +X D3 10 -1800 50 250 R 50 50 1 1 T +X D4 11 -1800 -50 250 R 50 50 1 1 T +X D5 12 -1800 -150 250 R 50 50 1 1 T +X D6 13 -1800 -250 250 R 50 50 1 1 T +X D7 14 -1800 -350 250 R 50 50 1 1 T +X A 15 1450 -250 250 L 50 50 1 1 W +X K 16 1450 -350 250 L 50 50 1 1 W +ENDDRAW +ENDDEF +# +# LCD_CHAR_DISPLAY +# +DEF LCD_CHAR_DISPLAY S 0 40 Y Y 1 F N +F0 "S" -1050 750 60 H V C CNN +F1 "LCD_CHAR_DISPLAY" 700 -450 60 H V C CNN +F2 "" 0 -150 60 H V C CNN +F3 "" 0 -150 60 H V C CNN +DRAW +S -1550 700 1200 -400 0 1 0 N +S -1300 450 950 -200 0 1 0 N +S -1250 -50 -1200 -150 0 1 0 N +S -1250 100 -1200 0 0 1 0 N +S -1250 250 -1200 150 0 1 0 N +S -1250 400 -1200 300 0 1 0 N +S -1150 -50 -1100 -150 0 1 0 N +S -1150 100 -1100 0 0 1 0 N +S -1150 250 -1100 150 0 1 0 N +S -1150 400 -1100 300 0 1 0 N +S -1050 -50 -1000 -150 0 1 0 N +S -1050 100 -1000 0 0 1 0 N +S -1050 250 -1000 150 0 1 0 N +S -1050 400 -1000 300 0 1 0 N +S -950 -50 -900 -150 0 1 0 N +S -950 100 -900 0 0 1 0 N +S -950 250 -900 150 0 1 0 N +S -950 400 -900 300 0 1 0 N +S -850 -50 -800 -150 0 1 0 N +S -850 100 -800 0 0 1 0 N +S -850 250 -800 150 0 1 0 N +S -850 400 -800 300 0 1 0 N +S -750 -50 -700 -150 0 1 0 N +S -750 100 -700 0 0 1 0 N +S -750 250 -700 150 0 1 0 N +S -750 400 -700 300 0 1 0 N +S -650 -50 -600 -150 0 1 0 N +S -650 100 -600 0 0 1 0 N +S -650 250 -600 150 0 1 0 N +S -650 400 -600 300 0 1 0 N +S -550 -50 -500 -150 0 1 0 N +S -550 100 -500 0 0 1 0 N +S -550 250 -500 150 0 1 0 N +S -550 400 -500 300 0 1 0 N +S -450 -50 -400 -150 0 1 0 N +S -450 100 -400 0 0 1 0 N +S -450 250 -400 150 0 1 0 N +S -450 400 -400 300 0 1 0 N +S -350 -50 -300 -150 0 1 0 N +S -350 100 -300 0 0 1 0 N +S -350 250 -300 150 0 1 0 N +S -350 400 -300 300 0 1 0 N +S -250 -50 -200 -150 0 1 0 N +S -250 100 -200 0 0 1 0 N +S -250 250 -200 150 0 1 0 N +S -250 400 -200 300 0 1 0 N +S -150 -50 -100 -150 0 1 0 N +S -150 100 -100 0 0 1 0 N +S -150 250 -100 150 0 1 0 N +S -150 400 -100 300 0 1 0 N +S -50 -50 0 -150 0 1 0 N +S -50 100 0 0 0 1 0 N +S -50 250 0 150 0 1 0 N +S -50 400 0 300 0 1 0 N +S 50 -50 100 -150 0 1 0 N +S 50 100 100 0 0 1 0 N +S 50 250 100 150 0 1 0 N +S 50 400 100 300 0 1 0 N +S 150 -50 200 -150 0 1 0 N +S 150 100 200 0 0 1 0 N +S 150 250 200 150 0 1 0 N +S 150 400 200 300 0 1 0 N +S 250 -50 300 -150 0 1 0 N +S 250 100 300 0 0 1 0 N +S 250 250 300 150 0 1 0 N +S 250 400 300 300 0 1 0 N +S 350 -50 400 -150 0 1 0 N +S 350 100 400 0 0 1 0 N +S 350 250 400 150 0 1 0 N +S 350 400 400 300 0 1 0 N +S 450 -50 500 -150 0 1 0 N +S 450 100 500 0 0 1 0 N +S 450 250 500 150 0 1 0 N +S 450 400 500 300 0 1 0 N +S 550 -50 600 -150 0 1 0 N +S 550 100 600 0 0 1 0 N +S 550 250 600 150 0 1 0 N +S 550 400 600 300 0 1 0 N +S 650 -50 700 -150 0 1 0 N +S 650 100 700 0 0 1 0 N +S 650 250 700 150 0 1 0 N +S 650 400 700 300 0 1 0 N +S 750 -50 800 -150 0 1 0 N +S 750 100 800 0 0 1 0 N +S 750 250 800 150 0 1 0 N +S 750 400 800 300 0 1 0 N +S 850 -50 900 -150 0 1 0 N +S 850 100 900 0 0 1 0 N +S 850 250 900 150 0 1 0 N +S 850 400 900 300 0 1 0 N +X VSS 1 1450 650 250 L 50 50 1 1 W +X VDD 2 1450 550 250 L 50 50 1 1 W +X V0 3 1450 450 250 L 50 50 1 1 I +X RS 4 -1800 650 250 R 50 50 1 1 I +X RW 5 -1800 550 250 R 50 50 1 1 I +X E 6 -1800 450 250 R 50 50 1 1 I +X D0 7 -1800 350 250 R 50 50 1 1 T +X D1 8 -1800 250 250 R 50 50 1 1 T +X D2 9 -1800 150 250 R 50 50 1 1 T +X D3 10 -1800 50 250 R 50 50 1 1 T +X D4 11 -1800 -50 250 R 50 50 1 1 T +X D5 12 -1800 -150 250 R 50 50 1 1 T +X D6 13 -1800 -250 250 R 50 50 1 1 T +X D7 14 -1800 -350 250 R 50 50 1 1 T +X A 15 1450 -250 250 L 50 50 1 1 W +X K 16 1450 -350 250 L 50 50 1 1 W +ENDDRAW +ENDDEF +# +#End Library diff --git a/UART-Echo-LCD/kicad_lib/CharacterLCD.bck b/UART-Echo-LCD/kicad_lib/CharacterLCD.bck new file mode 100644 index 0000000..70e7907 --- /dev/null +++ b/UART-Echo-LCD/kicad_lib/CharacterLCD.bck @@ -0,0 +1,13 @@ +EESchema-DOCLIB Version 2.0 +# +$CMP DISPLAY +D Afficheur LCD nLignes +K DEV +$ENDCMP +# +$CMP LCD_CHAR_DISPLAY +D Afficheur LCD nLignes +K DEV +$ENDCMP +# +#End Doc Library diff --git a/UART-Echo-LCD/kicad_lib/CharacterLCD.dcm b/UART-Echo-LCD/kicad_lib/CharacterLCD.dcm new file mode 100644 index 0000000..b4115c9 --- /dev/null +++ b/UART-Echo-LCD/kicad_lib/CharacterLCD.dcm @@ -0,0 +1,13 @@ +EESchema-DOCLIB Version 2.0 +# +$CMP DISPLAY +D Afficheur LCD nLignes +K DEV +$ENDCMP +# +$CMP LCD_CHAR_DISPLAY +D Character LCD Display +K DEV +$ENDCMP +# +#End Doc Library diff --git a/UART-Echo-LCD/kicad_lib/CharacterLCD.lib b/UART-Echo-LCD/kicad_lib/CharacterLCD.lib new file mode 100644 index 0000000..79a10da --- /dev/null +++ b/UART-Echo-LCD/kicad_lib/CharacterLCD.lib @@ -0,0 +1,238 @@ +EESchema-LIBRARY Version 2.3 +#encoding utf-8 +# +# DISPLAY +# +DEF DISPLAY S 0 40 Y Y 1 F N +F0 "S" -1050 750 60 H V C CNN +F1 "DISPLAY" 700 -450 60 H V C CNN +F2 "" 0 -150 60 H V C CNN +F3 "" 0 -150 60 H V C CNN +DRAW +S -1550 700 1200 -400 0 1 0 N +S -1300 450 950 -200 0 1 0 N +S -1250 -50 -1200 -150 0 1 0 N +S -1250 100 -1200 0 0 1 0 N +S -1250 250 -1200 150 0 1 0 N +S -1250 400 -1200 300 0 1 0 N +S -1150 -50 -1100 -150 0 1 0 N +S -1150 100 -1100 0 0 1 0 N +S -1150 250 -1100 150 0 1 0 N +S -1150 400 -1100 300 0 1 0 N +S -1050 -50 -1000 -150 0 1 0 N +S -1050 100 -1000 0 0 1 0 N +S -1050 250 -1000 150 0 1 0 N +S -1050 400 -1000 300 0 1 0 N +S -950 -50 -900 -150 0 1 0 N +S -950 100 -900 0 0 1 0 N +S -950 250 -900 150 0 1 0 N +S -950 400 -900 300 0 1 0 N +S -850 -50 -800 -150 0 1 0 N +S -850 100 -800 0 0 1 0 N +S -850 250 -800 150 0 1 0 N +S -850 400 -800 300 0 1 0 N +S -750 -50 -700 -150 0 1 0 N +S -750 100 -700 0 0 1 0 N +S -750 250 -700 150 0 1 0 N +S -750 400 -700 300 0 1 0 N +S -650 -50 -600 -150 0 1 0 N +S -650 100 -600 0 0 1 0 N +S -650 250 -600 150 0 1 0 N +S -650 400 -600 300 0 1 0 N +S -550 -50 -500 -150 0 1 0 N +S -550 100 -500 0 0 1 0 N +S -550 250 -500 150 0 1 0 N +S -550 400 -500 300 0 1 0 N +S -450 -50 -400 -150 0 1 0 N +S -450 100 -400 0 0 1 0 N +S -450 250 -400 150 0 1 0 N +S -450 400 -400 300 0 1 0 N +S -350 -50 -300 -150 0 1 0 N +S -350 100 -300 0 0 1 0 N +S -350 250 -300 150 0 1 0 N +S -350 400 -300 300 0 1 0 N +S -250 -50 -200 -150 0 1 0 N +S -250 100 -200 0 0 1 0 N +S -250 250 -200 150 0 1 0 N +S -250 400 -200 300 0 1 0 N +S -150 -50 -100 -150 0 1 0 N +S -150 100 -100 0 0 1 0 N +S -150 250 -100 150 0 1 0 N +S -150 400 -100 300 0 1 0 N +S -50 -50 0 -150 0 1 0 N +S -50 100 0 0 0 1 0 N +S -50 250 0 150 0 1 0 N +S -50 400 0 300 0 1 0 N +S 50 -50 100 -150 0 1 0 N +S 50 100 100 0 0 1 0 N +S 50 250 100 150 0 1 0 N +S 50 400 100 300 0 1 0 N +S 150 -50 200 -150 0 1 0 N +S 150 100 200 0 0 1 0 N +S 150 250 200 150 0 1 0 N +S 150 400 200 300 0 1 0 N +S 250 -50 300 -150 0 1 0 N +S 250 100 300 0 0 1 0 N +S 250 250 300 150 0 1 0 N +S 250 400 300 300 0 1 0 N +S 350 -50 400 -150 0 1 0 N +S 350 100 400 0 0 1 0 N +S 350 250 400 150 0 1 0 N +S 350 400 400 300 0 1 0 N +S 450 -50 500 -150 0 1 0 N +S 450 100 500 0 0 1 0 N +S 450 250 500 150 0 1 0 N +S 450 400 500 300 0 1 0 N +S 550 -50 600 -150 0 1 0 N +S 550 100 600 0 0 1 0 N +S 550 250 600 150 0 1 0 N +S 550 400 600 300 0 1 0 N +S 650 -50 700 -150 0 1 0 N +S 650 100 700 0 0 1 0 N +S 650 250 700 150 0 1 0 N +S 650 400 700 300 0 1 0 N +S 750 -50 800 -150 0 1 0 N +S 750 100 800 0 0 1 0 N +S 750 250 800 150 0 1 0 N +S 750 400 800 300 0 1 0 N +S 850 -50 900 -150 0 1 0 N +S 850 100 900 0 0 1 0 N +S 850 250 900 150 0 1 0 N +S 850 400 900 300 0 1 0 N +X VSS 1 1450 650 250 L 50 50 1 1 W +X VDD 2 1450 550 250 L 50 50 1 1 W +X V0 3 1450 450 250 L 50 50 1 1 I +X RS 4 -1800 650 250 R 50 50 1 1 I +X RW 5 -1800 550 250 R 50 50 1 1 I +X E 6 -1800 450 250 R 50 50 1 1 I +X D0 7 -1800 350 250 R 50 50 1 1 T +X D1 8 -1800 250 250 R 50 50 1 1 T +X D2 9 -1800 150 250 R 50 50 1 1 T +X D3 10 -1800 50 250 R 50 50 1 1 T +X D4 11 -1800 -50 250 R 50 50 1 1 T +X D5 12 -1800 -150 250 R 50 50 1 1 T +X D6 13 -1800 -250 250 R 50 50 1 1 T +X D7 14 -1800 -350 250 R 50 50 1 1 T +X A 15 1450 -250 250 L 50 50 1 1 W +X K 16 1450 -350 250 L 50 50 1 1 W +ENDDRAW +ENDDEF +# +# LCD_CHAR_DISPLAY +# +DEF LCD_CHAR_DISPLAY S 0 40 Y Y 1 F N +F0 "S" -1050 750 60 H V C CNN +F1 "LCD_CHAR_DISPLAY" 700 -450 60 H V C CNN +F2 "" 0 -150 60 H V C CNN +F3 "" 0 -150 60 H V C CNN +DRAW +S -1550 700 1200 -400 0 1 0 N +S -1300 450 950 -200 0 1 0 N +S -1250 -50 -1200 -150 0 1 0 N +S -1250 100 -1200 0 0 1 0 N +S -1250 250 -1200 150 0 1 0 N +S -1250 400 -1200 300 0 1 0 N +S -1150 -50 -1100 -150 0 1 0 N +S -1150 100 -1100 0 0 1 0 N +S -1150 250 -1100 150 0 1 0 N +S -1150 400 -1100 300 0 1 0 N +S -1050 -50 -1000 -150 0 1 0 N +S -1050 100 -1000 0 0 1 0 N +S -1050 250 -1000 150 0 1 0 N +S -1050 400 -1000 300 0 1 0 N +S -950 -50 -900 -150 0 1 0 N +S -950 100 -900 0 0 1 0 N +S -950 250 -900 150 0 1 0 N +S -950 400 -900 300 0 1 0 N +S -850 -50 -800 -150 0 1 0 N +S -850 100 -800 0 0 1 0 N +S -850 250 -800 150 0 1 0 N +S -850 400 -800 300 0 1 0 N +S -750 -50 -700 -150 0 1 0 N +S -750 100 -700 0 0 1 0 N +S -750 250 -700 150 0 1 0 N +S -750 400 -700 300 0 1 0 N +S -650 -50 -600 -150 0 1 0 N +S -650 100 -600 0 0 1 0 N +S -650 250 -600 150 0 1 0 N +S -650 400 -600 300 0 1 0 N +S -550 -50 -500 -150 0 1 0 N +S -550 100 -500 0 0 1 0 N +S -550 250 -500 150 0 1 0 N +S -550 400 -500 300 0 1 0 N +S -450 -50 -400 -150 0 1 0 N +S -450 100 -400 0 0 1 0 N +S -450 250 -400 150 0 1 0 N +S -450 400 -400 300 0 1 0 N +S -350 -50 -300 -150 0 1 0 N +S -350 100 -300 0 0 1 0 N +S -350 250 -300 150 0 1 0 N +S -350 400 -300 300 0 1 0 N +S -250 -50 -200 -150 0 1 0 N +S -250 100 -200 0 0 1 0 N +S -250 250 -200 150 0 1 0 N +S -250 400 -200 300 0 1 0 N +S -150 -50 -100 -150 0 1 0 N +S -150 100 -100 0 0 1 0 N +S -150 250 -100 150 0 1 0 N +S -150 400 -100 300 0 1 0 N +S -50 -50 0 -150 0 1 0 N +S -50 100 0 0 0 1 0 N +S -50 250 0 150 0 1 0 N +S -50 400 0 300 0 1 0 N +S 50 -50 100 -150 0 1 0 N +S 50 100 100 0 0 1 0 N +S 50 250 100 150 0 1 0 N +S 50 400 100 300 0 1 0 N +S 150 -50 200 -150 0 1 0 N +S 150 100 200 0 0 1 0 N +S 150 250 200 150 0 1 0 N +S 150 400 200 300 0 1 0 N +S 250 -50 300 -150 0 1 0 N +S 250 100 300 0 0 1 0 N +S 250 250 300 150 0 1 0 N +S 250 400 300 300 0 1 0 N +S 350 -50 400 -150 0 1 0 N +S 350 100 400 0 0 1 0 N +S 350 250 400 150 0 1 0 N +S 350 400 400 300 0 1 0 N +S 450 -50 500 -150 0 1 0 N +S 450 100 500 0 0 1 0 N +S 450 250 500 150 0 1 0 N +S 450 400 500 300 0 1 0 N +S 550 -50 600 -150 0 1 0 N +S 550 100 600 0 0 1 0 N +S 550 250 600 150 0 1 0 N +S 550 400 600 300 0 1 0 N +S 650 -50 700 -150 0 1 0 N +S 650 100 700 0 0 1 0 N +S 650 250 700 150 0 1 0 N +S 650 400 700 300 0 1 0 N +S 750 -50 800 -150 0 1 0 N +S 750 100 800 0 0 1 0 N +S 750 250 800 150 0 1 0 N +S 750 400 800 300 0 1 0 N +S 850 -50 900 -150 0 1 0 N +S 850 100 900 0 0 1 0 N +S 850 250 900 150 0 1 0 N +S 850 400 900 300 0 1 0 N +X VSS 1 1450 650 250 L 50 50 1 1 W +X VDD 2 1450 550 250 L 50 50 1 1 W +X V0 3 1450 450 250 L 50 50 1 1 I +X RS 4 -1800 650 250 R 50 50 1 1 I +X RW 5 -1800 550 250 R 50 50 1 1 I +X E 6 -1800 450 250 R 50 50 1 1 I +X D0 7 -1800 350 250 R 50 50 1 1 T +X D1 8 -1800 250 250 R 50 50 1 1 T +X D2 9 -1800 150 250 R 50 50 1 1 T +X D3 10 -1800 50 250 R 50 50 1 1 T +X D4 11 -1800 -50 250 R 50 50 1 1 T +X D5 12 -1800 -150 250 R 50 50 1 1 T +X D6 13 -1800 -250 250 R 50 50 1 1 T +X D7 14 -1800 -350 250 R 50 50 1 1 T +X A 15 1450 -250 250 L 50 50 1 1 W +X K 16 1450 -350 250 L 50 50 1 1 W +ENDDRAW +ENDDEF +# +#End Library diff --git a/src/LICENSE b/src/LICENSE new file mode 100644 index 0000000..8be83cc --- /dev/null +++ b/src/LICENSE @@ -0,0 +1,677 @@ + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + +------------------------------------------------------------------------ diff --git a/src/Makefile b/src/Makefile new file mode 100644 index 0000000..779a111 --- /dev/null +++ b/src/Makefile @@ -0,0 +1,196 @@ + +##########------------------------------------------------------########## +########## Project-specific Details ########## +########## Check these every time you start a new project ########## +##########------------------------------------------------------########## + +MCU = atmega328p +F_CPU = 8000000UL +BAUD = 9600 +## Also try BAUD = 19200 or 38400 if you're feeling lucky. + +## A directory for common include files and the simple USART library. +## If you move either the current folder or the Library folder, you'll +## need to change this path to match. +LIBDIR = lcdLib + +##########------------------------------------------------------########## +########## Programmer Defaults ########## +########## Set up once, then forget about it ########## +########## (Can override. See bottom of file.) ########## +##########------------------------------------------------------########## + +PROGRAMMER_TYPE = avrisp +# extra arguments to avrdude: baud rate, chip type, -F flag, etc. +PROGRAMMER_ARGS = -b 19200 -P /dev/ttyUSB0 + +##########------------------------------------------------------########## +########## Program Locations ########## +########## Won't need to change if they're in your PATH ########## +##########------------------------------------------------------########## + +CC = avr-gcc +OBJCOPY = avr-objcopy +OBJDUMP = avr-objdump +AVRSIZE = avr-size +AVRDUDE = avrdude + +##########------------------------------------------------------########## +########## Makefile Magic! ########## +########## Summary: ########## +########## We want a .hex file ########## +########## Compile source files into .elf ########## +########## Convert .elf file into .hex ########## +########## You shouldn't need to edit below. ########## +##########------------------------------------------------------########## + +## The name of your project (without the .c) +# TARGET = blinkLED +## Or name it automatically after the enclosing directory +TARGET = $(lastword $(subst /, ,$(CURDIR))) + +# Object files: will find all .c/.h files in current directory +# and in LIBDIR. If you have any other (sub-)directories with code, +# you can add them in to SOURCES below in the wildcard statement. +SOURCES=$(wildcard *.c $(LIBDIR)/*.c) +OBJECTS=$(SOURCES:.c=.o) +HEADERS=$(SOURCES:.c=.h) + +## Compilation options, type man avr-gcc if you're curious. +CPPFLAGS = -DF_CPU=$(F_CPU) -DBAUD=$(BAUD) -I. -I$(LIBDIR) +CFLAGS = -Os -g -std=gnu99 -Wall +## Use short (8-bit) data types +CFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums +## Splits up object files per function +CFLAGS += -ffunction-sections -fdata-sections +LDFLAGS = -Wl,-Map,$(TARGET).map +## Optional, but often ends up with smaller code +LDFLAGS += -Wl,--gc-sections +## Relax shrinks code even more, but makes disassembly messy +## LDFLAGS += -Wl,--relax +## LDFLAGS += -Wl,-u,vfprintf -lprintf_flt -lm ## for floating-point printf +## LDFLAGS += -Wl,-u,vfprintf -lprintf_min ## for smaller printf +TARGET_ARCH = -mmcu=$(MCU) + +## Explicit pattern rules: +## To make .o files from .c files +%.o: %.c $(HEADERS) Makefile + $(CC) $(CFLAGS) $(CPPFLAGS) $(TARGET_ARCH) -c -o $@ $<; + +$(TARGET).elf: $(OBJECTS) + $(CC) $(LDFLAGS) $(TARGET_ARCH) $^ $(LDLIBS) -o $@ + +%.hex: %.elf + $(OBJCOPY) -j .text -j .data -O ihex $< $@ + +%.eeprom: %.elf + $(OBJCOPY) -j .eeprom --change-section-lma .eeprom=0 -O ihex $< $@ + +%.lst: %.elf + $(OBJDUMP) -S $< > $@ + +## These targets don't have files named after them +.PHONY: all disassemble disasm eeprom size clean squeaky_clean flash fuses + +all: $(TARGET).hex + +debug: + @echo + @echo "Source files:" $(SOURCES) + @echo "MCU, F_CPU, BAUD:" $(MCU), $(F_CPU), $(BAUD) + @echo + +# Optionally create listing file from .elf +# This creates approximate assembly-language equivalent of your code. +# Useful for debugging time-sensitive bits, +# or making sure the compiler does what you want. +disassemble: $(TARGET).lst + +disasm: disassemble + +# Optionally show how big the resulting program is +size: $(TARGET).elf + $(AVRSIZE) -C --mcu=$(MCU) $(TARGET).elf + +clean: + rm -f $(TARGET).elf $(TARGET).hex $(TARGET).obj \ + $(TARGET).o $(TARGET).d $(TARGET).eep $(TARGET).lst \ + $(TARGET).lss $(TARGET).sym $(TARGET).map $(TARGET)~ \ + $(TARGET).eeprom + +squeaky_clean: + rm -f *.elf *.hex *.obj *.o *.d *.eep *.lst *.lss *.sym *.map *~ *.eeprom + +##########------------------------------------------------------########## +########## Programmer-specific details ########## +########## Flashing code to AVR using avrdude ########## +##########------------------------------------------------------########## + +flash: $(TARGET).hex + $(AVRDUDE) -c $(PROGRAMMER_TYPE) -p $(MCU) $(PROGRAMMER_ARGS) -U flash:w:$< + +## An alias +program: flash + +flash_eeprom: $(TARGET).eeprom + $(AVRDUDE) -c $(PROGRAMMER_TYPE) -p $(MCU) $(PROGRAMMER_ARGS) -U eeprom:w:$< + +avrdude_terminal: + $(AVRDUDE) -c $(PROGRAMMER_TYPE) -p $(MCU) $(PROGRAMMER_ARGS) -nt + +## If you've got multiple programmers that you use, +## you can define them here so that it's easy to switch. +## To invoke, use something like `make flash_arduinoISP` +flash_usbtiny: PROGRAMMER_TYPE = usbtiny +flash_usbtiny: PROGRAMMER_ARGS = # USBTiny works with no further arguments +flash_usbtiny: flash + +flash_usbasp: PROGRAMMER_TYPE = usbasp +flash_usbasp: PROGRAMMER_ARGS = # USBasp works with no further arguments +flash_usbasp: flash + +flash_arduinoISP: PROGRAMMER_TYPE = avrisp +flash_arduinoISP: PROGRAMMER_ARGS = -b 19200 -P /dev/ttyACM0 +## (for windows) flash_arduinoISP: PROGRAMMER_ARGS = -b 19200 -P com5 +flash_arduinoISP: flash + +flash_109: PROGRAMMER_TYPE = avr109 +flash_109: PROGRAMMER_ARGS = -b 9600 -P /dev/ttyUSB0 +flash_109: flash + +##########------------------------------------------------------########## +########## Fuse settings and suitable defaults ########## +##########------------------------------------------------------########## + +## Mega 48, 88, 168, 328 default values +LFUSE = 0x62 +HFUSE = 0xdf +EFUSE = 0x00 + +## Generic +FUSE_STRING = -U lfuse:w:$(LFUSE):m -U hfuse:w:$(HFUSE):m -U efuse:w:$(EFUSE):m + +fuses: + $(AVRDUDE) -c $(PROGRAMMER_TYPE) -p $(MCU) \ + $(PROGRAMMER_ARGS) $(FUSE_STRING) +show_fuses: + $(AVRDUDE) -c $(PROGRAMMER_TYPE) -p $(MCU) $(PROGRAMMER_ARGS) -nv + +## Called with no extra definitions, sets to defaults +set_default_fuses: FUSE_STRING = -U lfuse:w:$(LFUSE):m -U hfuse:w:$(HFUSE):m -U efuse:w:$(EFUSE):m +set_default_fuses: fuses + +## Set the fuse byte for full-speed mode +## Note: can also be set in firmware for modern chips +set_fast_fuse: LFUSE = 0xE2 +set_fast_fuse: FUSE_STRING = -U lfuse:w:$(LFUSE):m +set_fast_fuse: fuses + +## Set the EESAVE fuse byte to preserve EEPROM across flashes +set_eeprom_save_fuse: HFUSE = 0xD7 +set_eeprom_save_fuse: FUSE_STRING = -U hfuse:w:$(HFUSE):m +set_eeprom_save_fuse: fuses + +## Clear the EESAVE fuse byte +clear_eeprom_save_fuse: FUSE_STRING = -U hfuse:w:$(HFUSE):m +clear_eeprom_save_fuse: fuses diff --git a/src/USART.c b/src/USART.c new file mode 100644 index 0000000..be022cb --- /dev/null +++ b/src/USART.c @@ -0,0 +1,62 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + +/** + * File: USART.c + * Author: Collin J. Doering + * Date: Oct 6, 2015 + */ + +#include +#include "USART.h" +#include + +#ifndef BAUD /* if not defined in Makefile... */ +#define BAUD 9600 /* set a safe default baud rate */ +#endif + +void initUSART(void) { /* requires BAUD */ + UBRR0H = UBRRH_VALUE; /* defined in setbaud.h */ + UBRR0L = UBRRL_VALUE; +#if USE_2X + UCSR0A |= (1 << U2X0); +#else + UCSR0A &= ~(1 << U2X0); +#endif + /* Enable USART transmitter/receiver */ + UCSR0B = (1 << TXEN0) | (1 << RXEN0); + UCSR0C = (1 << UCSZ01) | (1 << UCSZ00); /* 8 data bits, 1 stop bit */ +} + + +void transmitByte(uint8_t data) { + /* Wait for empty transmit buffer */ + loop_until_bit_is_set(UCSR0A, UDRE0); + UDR0 = data; /* send data */ +} + +void transmitString(const char* data) { + while (*data != '\0') { + transmitByte(*data); + data++; + } +} + +uint8_t receiveByte(void) { + loop_until_bit_is_set(UCSR0A, RXC0); /* Wait for incoming data */ + return UDR0; /* return register value */ +} diff --git a/src/USART.h b/src/USART.h new file mode 100644 index 0000000..5594e15 --- /dev/null +++ b/src/USART.h @@ -0,0 +1,43 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + +/** + * @file USART.h + * @author Collin J. Doering + * @date Oct 6, 2015 + * @brief Functions to initialize, read and write using USART. + */ + +/** + Initialize USART hardware. +*/ +void initUSART(void); + +/** + Transmit a single byte using USART. +*/ +void transmitByte(uint8_t data); + +/** + Transmit a string using USART. +*/ +void transmitString(const char* data); + +/** + Receive a single byte using USART +*/ +uint8_t receiveByte(void); diff --git a/src/lcdLib/ansi_escapes.h b/src/lcdLib/ansi_escapes.h new file mode 100644 index 0000000..0024915 --- /dev/null +++ b/src/lcdLib/ansi_escapes.h @@ -0,0 +1,56 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * @file ansi_escapes.h + * @author Collin J. Doering + * @date Oct 9, 2015 + * @brief Macros to ease writing ANSI escapes. + */ + +#define CSI "\e[" ///< Control Sequence Introducer + +#define CUU(n) CSI #n "A" ///< Cursor up +#define CUD(n) CSI #n "B" ///< Cursor down +#define CUF(n) CSI #n "C" ///< Cursor forward +#define CUB(n) CSI #n "D" ///< Cursor backward + +#define CNL(n) CSI #n "E" ///< Cursor next line +#define CPL(n) CSI #n "F" ///< Cursor previous line + +#define CHA(n) CSI #n "G" ///< Cursor horizontal absolute +#define CUP(n,m) CSI #n ";" #m "H" ///< Cursor position + +#define ED(n) CSI #n "J" ///< Erase display +#define EL(n) CSI #n "K" ///< Erase in line +#define SU(n) CSI #n "S" ///< Scroll up +#define SD(n) CSI #n "T" ///< Scroll down + +#define HVP(n,m) CSI #n ";" #m "f" ///< Horizontal and vertical position + +// #define SGR(n,m) CSI #n #m ///< Select graphic rendition + +#define AUX_ON CSI "5i" ///< AUX port on +#define AUX_OFF CSI "4i" ///< AUX port off + +// #define DSR CSI "6 n" ///< Device status report + +#define SCP CSI "s" ///< Save cursor position +#define RCP CSI "u" ///< Restore cursor position + +#define HIDE_CURSOR CSI "?25l" ///< DECTCEM: hide cursor +#define SHOW_CURSOR CSI "?25h" ///< DECTCEM: show cursor diff --git a/src/lcdLib/lcdLib.c b/src/lcdLib/lcdLib.c new file mode 100644 index 0000000..5fee24f --- /dev/null +++ b/src/lcdLib/lcdLib.c @@ -0,0 +1,969 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * File: lcdLib.c + * Author: Collin J. Doering + * Date: Sep 29, 2015 + */ + +// Includes ----------------------------------------------------------------------------------- +#include +#include +#include + +#include "lcdLib.h" + +//--------------------------------------------------------------------------------------------- +// Static global variables + +static volatile uint8_t currentLineNum; +static volatile uint8_t currentLineChars; + +static volatile uint8_t saveCursorLineNum; +static volatile uint8_t saveCursorLineChars; + +static volatile uint8_t lcdState; + +static const uint8_t lineBeginnings[LCD_NUMBER_OF_LINES] = { LCD_LINE_BEGINNINGS }; + +//--------------------------------------------------------------------------------------------- +// Static functions + +/* + Bring LCD_ENABLE line high, wait for LCD_ENABLE_HIGH_DELAY; then bring LCD_ENABLE line low + and wait for LCD_ENABLE_LOW_DELAY. + + Note: LCD_ENABLE, LCD_ENABLE_HIGH_DELAY, and LCD_ENABLE_LOW_DELAY must be defined in lcdLibConfig.h + */ +static void clkLCD(void) { + LCD_ENABLE_PORT |= (1 << LCD_ENABLE); + _delay_us(LCD_ENABLE_HIGH_DELAY); + LCD_ENABLE_PORT &= ~(1 << LCD_ENABLE); + _delay_us(LCD_ENABLE_LOW_DELAY); +} + +/* + Wait until LCD_BF (busy flag) is cleared (low). + */ +static void loop_until_LCD_BF_clear(void) { + uint8_t bf; + + LCD_RS_PORT &= ~(1 << LCD_RS); // RS=0 + LCD_RW_PORT |= (1 << LCD_RW); // RW=1 + + // Set LCD_BF as input + LCD_DBUS7_DDR &= ~(1 << LCD_BF); + + do { + bf = 0; + LCD_ENABLE_PORT |= (1 << LCD_ENABLE); + _delay_us(1); // 'delay data time' and 'enable pulse width' + + bf |= (LCD_DBUS7_PIN & (1 << LCD_BF)); + + LCD_ENABLE_PORT &= ~(1 << LCD_ENABLE); + _delay_us(1); // 'address hold time', 'data hold time' and 'enable cycle width' + +#ifdef FOUR_BIT_MODE + LCD_ENABLE_PORT |= (1 << LCD_ENABLE); + _delay_us(1); // 'delay data time' and 'enable pulse width' + LCD_ENABLE_PORT &= ~(1 << LCD_ENABLE); + _delay_us(1); // 'address hold time', 'data hold time' and 'enable cycle width' +#endif + } while (bf); + +#if defined (FOUR_BIT_MODE) || defined (EIGHT_BIT_ARBITRARY_PIN_MODE) + LCD_DBUS7_DDR |= (1 << LCD_DBUS7); + LCD_DBUS6_DDR |= (1 << LCD_DBUS6); + LCD_DBUS5_DDR |= (1 << LCD_DBUS5); + LCD_DBUS4_DDR |= (1 << LCD_DBUS4); +#ifdef EIGHT_BIT_ARBITRARY_PIN_MODE + LCD_DBUS3_DDR |= (1 << LCD_DBUS3); + LCD_DBUS2_DDR |= (1 << LCD_DBUS2); + LCD_DBUS1_DDR |= (1 << LCD_DBUS1); + LCD_DBUS0_DDR |= (1 << LCD_DBUS0); +#endif +#else + LCD_DBUS_DDR = 0xff; // Reset all LCD_DBUS_PORT pins as outputs +#endif +} + +/* + Given a 8 bit integer, writes the four MSB's (one nibble) to the LCD data bus. + + Note: this is only defined in FOUR_BIT_MODE + */ +#ifdef FOUR_BIT_MODE +static void writeLCDDBusNibble_(uint8_t b) { + // Reset data lines to zeros + LCD_DBUS7_PORT &= ~(1 << LCD_DBUS7); + LCD_DBUS6_PORT &= ~(1 << LCD_DBUS6); + LCD_DBUS5_PORT &= ~(1 << LCD_DBUS5); + LCD_DBUS4_PORT &= ~(1 << LCD_DBUS4); + + // Write 1's where appropriate on data lines + if (b & (1 << 7)) LCD_DBUS7_PORT |= (1 << LCD_DBUS7); + if (b & (1 << 6)) LCD_DBUS6_PORT |= (1 << LCD_DBUS6); + if (b & (1 << 5)) LCD_DBUS5_PORT |= (1 << LCD_DBUS5); + if (b & (1 << 4)) LCD_DBUS4_PORT |= (1 << LCD_DBUS4); + + // Pulse the enable line + clkLCD(); +} +#endif + +/* + Given an 8 bit integer, writes it to the LCD data bus, regardless of its + configuration (default 8-bit mode, 8-bit arbitrary pin mode and 4-bit mode). In the default + 8-bit mode and EIGHT_BIT_ARBITRARY_PIN_MODE, the given data is written in one cycle using the + writeLCDDBusByte_ function. In FOUR_BIT_MODE however, the given data is written in two cycles + using two successive calls to the writeLCDDBusNibble_ function. + + This function does not ensure the LCD is ready to accept new data and thus needs to + be handled by the caller. + */ +static void writeLCDDBusByte_(uint8_t b) { +#ifdef FOUR_BIT_MODE + writeLCDDBusNibble_(b); + writeLCDDBusNibble_(b << 4); +#elif defined (EIGHT_BIT_ARBITRARY_PIN_MODE) + // Reset data lines to zeros + LCD_DBUS7_PORT &= ~(1 << LCD_DBUS7); + LCD_DBUS6_PORT &= ~(1 << LCD_DBUS6); + LCD_DBUS5_PORT &= ~(1 << LCD_DBUS5); + LCD_DBUS4_PORT &= ~(1 << LCD_DBUS4); + LCD_DBUS3_PORT &= ~(1 << LCD_DBUS3); + LCD_DBUS2_PORT &= ~(1 << LCD_DBUS2); + LCD_DBUS1_PORT &= ~(1 << LCD_DBUS1); + LCD_DBUS0_PORT &= ~(1 << LCD_DBUS0); + + // Write 1's where appropriate on data lines + if (b & (1 << 7)) LCD_DBUS7_PORT |= (1 << LCD_DBUS7); + if (b & (1 << 6)) LCD_DBUS6_PORT |= (1 << LCD_DBUS6); + if (b & (1 << 5)) LCD_DBUS5_PORT |= (1 << LCD_DBUS5); + if (b & (1 << 4)) LCD_DBUS4_PORT |= (1 << LCD_DBUS4); + if (b & (1 << 3)) LCD_DBUS3_PORT |= (1 << LCD_DBUS3); + if (b & (1 << 2)) LCD_DBUS2_PORT |= (1 << LCD_DBUS2); + if (b & (1 << 1)) LCD_DBUS1_PORT |= (1 << LCD_DBUS1); + if (b & (1 << 0)) LCD_DBUS0_PORT |= (1 << LCD_DBUS0); + + clkLCD(); +#else + LCD_DBUS_PORT = b; + clkLCD(); +#endif +} + +/* + Given a 8 bit integer representing a LCD instruction, sends it to the LCD display. + + Sets RS=RW=0 and writes the given 8 bit integer to the LCD databus. + + Note that this function does not ensure the LCD is ready to accept a new instruction and thus + needs to be handled by the caller. +*/ +static void writeLCDInstr_(uint8_t instr) { + LCD_RS_PORT &= ~(1 << LCD_RS); // RS=0 + LCD_RW_PORT &= ~(1 << LCD_RW); // RW=0 + + writeLCDDBusByte_(instr); +} + +/* + Given a 8 bit integer representing a LCD instruction, waits until the LCD is ready and sends + the instruction. + */ +static inline void writeLCDInstr(uint8_t instr) { + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + writeLCDInstr_(instr); +} + +/* + Sets RS=1, RW=0 and accepts a char (8 bit) and outputs it to the current cursor position of + the LCD. In the default 8-bit mode and EIGHT_BIT_ARBITRARY_PIN_MODE, the given data is + written in one cycle using the writeLCDDBusByte_ function. In FOUR_BIT_MODE however, the given + data is written in two cycles using two successive calls to the writeLCDDBusNibble_ function. +*/ +static void writeCharToLCD_(char c) { + LCD_RS_PORT |= (1 << LCD_RS); // RS=1 + LCD_RW_PORT &= ~(1 << LCD_RW); // RW=0 + + writeLCDDBusByte_(c); +} + +static uint8_t readLCDDBusByte_(void) { + LCD_RS_PORT |= (1 << LCD_RS); // RS=1 + LCD_RW_PORT |= (1 << LCD_RW); // RW=1 + + LCD_ENABLE_PORT |= (1 << LCD_ENABLE); + _delay_us(1); // 'delay data time' and 'enable pulse width' + + // Read data + char c = 0; +#if defined(FOUR_BIT_MODE) + if (LCD_DBUS7_PIN & (1 << LCD_DBUS7)) c |= (1 << 7); + if (LCD_DBUS6_PIN & (1 << LCD_DBUS6)) c |= (1 << 6); + if (LCD_DBUS5_PIN & (1 << LCD_DBUS5)) c |= (1 << 5); + if (LCD_DBUS4_PIN & (1 << LCD_DBUS4)) c |= (1 << 4); + + LCD_ENABLE_PORT &= ~(1 << LCD_ENABLE); + _delay_us(1); // 'address hold time', 'data hold time' and 'enable cycle width' + LCD_ENABLE_PORT |= (1 << LCD_ENABLE); + _delay_us(1); // 'delay data time' and 'enable pulse width' + + if (LCD_DBUS7_PIN & (1 << LCD_DBUS7)) c |= (1 << 3); + if (LCD_DBUS6_PIN & (1 << LCD_DBUS6)) c |= (1 << 2); + if (LCD_DBUS5_PIN & (1 << LCD_DBUS5)) c |= (1 << 1); + if (LCD_DBUS4_PIN & (1 << LCD_DBUS4)) c |= (1 << 0); +#elif defined(EIGHT_BIT_ARBITRARY_PIN_MODE) + if (LCD_DBUS7_PIN & (1 << LCD_DBUS7)) c |= (1 << 7); + if (LCD_DBUS6_PIN & (1 << LCD_DBUS6)) c |= (1 << 6); + if (LCD_DBUS5_PIN & (1 << LCD_DBUS5)) c |= (1 << 5); + if (LCD_DBUS4_PIN & (1 << LCD_DBUS4)) c |= (1 << 4); + if (LCD_DBUS3_PIN & (1 << LCD_DBUS3)) c |= (1 << 3); + if (LCD_DBUS2_PIN & (1 << LCD_DBUS2)) c |= (1 << 2); + if (LCD_DBUS1_PIN & (1 << LCD_DBUS1)) c |= (1 << 1); + if (LCD_DBUS0_PIN & (1 << LCD_DBUS0)) c |= (1 << 0); +#else + c = LCD_DBUS_PIN; +#endif + + LCD_ENABLE_PORT &= ~(1 << LCD_ENABLE); + _delay_us(1); // 'address hold time', 'data hold time' and 'enable cycle width' + + return c; +} + +/* + Given a character string, and a uint8_t pointer, reads the character string until a + non-numerical ASCII character, returning the integer representation of the number read. At + the end of the functions execution, the found_num uint8_t* will be updated to indicate how + many digits were read. The new_loc char** will be updated with the new parsing position in + the string. + */ +static uint8_t readASCIINumber(char* str, uint8_t* found_num, char** new_loc) { + uint8_t nums[3]; + + *found_num = 0; + while (*str != '\0' && *found_num < 3) { + if (*str >= 0x30 && *str <= 0x39) { + // Use *str as a number (specified in ASCII) + nums[(*found_num)++] = *str - 0x30; + } else { + break; + } + + str++; + } + *new_loc = str; + + uint8_t ret = 0; + uint8_t i = *found_num - 1; + for (uint8_t fnd = 0; fnd < *found_num; fnd++) + ret += nums[fnd] * pow(10, i--); + return ret; +} + +/* + Set all pins of LCD_DBUS as outputs +*/ +static inline void setLCDDBusAsOutputs(void) { +#if defined (FOUR_BIT_MODE) || defined (EIGHT_BIT_ARBITRARY_PIN_MODE) + LCD_DBUS7_DDR |= (1 << LCD_DBUS7); + LCD_DBUS6_DDR |= (1 << LCD_DBUS6); + LCD_DBUS5_DDR |= (1 << LCD_DBUS5); + LCD_DBUS4_DDR |= (1 << LCD_DBUS4); +#ifdef EIGHT_BIT_ARBITRARY_PIN_MODE + LCD_DBUS3_DDR |= (1 << LCD_DBUS3); + LCD_DBUS2_DDR |= (1 << LCD_DBUS2); + LCD_DBUS1_DDR |= (1 << LCD_DBUS1); + LCD_DBUS0_DDR |= (1 << LCD_DBUS0); +#endif +#else + LCD_DBUS_DDR = 0xff; +#endif +} + +/* + Set all pins of LCD_DBUS as inputs (disabling their output) +*/ +static inline void setLCDDBusAsInputs(void) { +#if defined (FOUR_BIT_MODE) || defined (EIGHT_BIT_ARBITRARY_PIN_MODE) + LCD_DBUS7_DDR &= ~(1 << LCD_DBUS7); + LCD_DBUS6_DDR &= ~(1 << LCD_DBUS6); + LCD_DBUS5_DDR &= ~(1 << LCD_DBUS5); + LCD_DBUS4_DDR &= ~(1 << LCD_DBUS4); +#ifdef EIGHT_BIT_ARBITRARY_PIN_MODE + LCD_DBUS3_DDR &= ~(1 << LCD_DBUS3); + LCD_DBUS2_DDR &= ~(1 << LCD_DBUS2); + LCD_DBUS1_DDR &= ~(1 << LCD_DBUS1); + LCD_DBUS0_DDR &= ~(1 << LCD_DBUS0); +#endif +#else + LCD_DBUS_DDR = 0; +#endif +} + +/* + Set RS=RW=0 and write the CMD_INIT command to the LCD data bus. Note that an appropriate + pause must follow before sending new commands to the LCD using writeLCD*_ functions. + */ +static inline void softwareLCDInitPulse(void) { + LCD_RS_PORT &= ~(1 << LCD_RS); // RS=0 + LCD_RW_PORT &= ~(1 << LCD_RW); // RW=0 + +#ifdef FOUR_BIT_MODE + writeLCDDBusNibble_(CMD_INIT); +#else + writeLCDDBusByte_(CMD_INIT); +#endif +} + + +//--------------------------------------------------------------------------------------------- +// Library function definitions + +/* + Do software initialization as specified by the datasheet +*/ +void initLCD(void) { + // Set LCD_RS, LCD_RW and LCD_ENABLE as outputs + LCD_RS_DDR |= (1 << LCD_RS); + LCD_RW_DDR |= (1 << LCD_RW); + LCD_ENABLE_DDR |= (1 << LCD_ENABLE); + + setLCDDBusAsOutputs(); + + _delay_us(LCD_INIT_DELAY0); // Wait minimum 15ms as per datasheet + softwareLCDInitPulse(); + _delay_us(LCD_INIT_DELAY1); // Wait minimum 4.1ms as per datasheet + softwareLCDInitPulse(); + _delay_us(LCD_INIT_DELAY2); // Wait minimum 100us as per datasheet + softwareLCDInitPulse(); + +#if defined (FOUR_BIT_MODE) + // Function Set (4-bit interface) + writeLCDDBusNibble_(CMD_INIT_FOUR_BIT); + writeLCDInstr_(CMD_INIT_FOUR_BIT | LCD_LINES | LCD_FONT); +#else + // Function set (8-bit interface) + writeLCDInstr_(INSTR_FUNC_SET | (1 << INSTR_FUNC_SET_DL) | LCD_LINES | LCD_FONT); +#endif + + /* BF now can be checked */ + + // Set functions of LCD + writeLCDInstr(INSTR_DISPLAY); // Display off + + // Clear display + writeLCDInstr(CMD_CLEAR_DISPLAY); + + // Increment mode, no shift + writeLCDInstr(INSTR_ENTRY_SET | (1 << INSTR_ENTRY_SET_ID)); + + // Display on, cursor on, blink off + lcdState = (1 << INSTR_DISPLAY_D) | (1 << INSTR_DISPLAY_C); + writeLCDInstr(INSTR_DISPLAY | lcdState); +} + +/* + Given a single character, checks whether its a ASCII escape and does the following: + + - Newline '\n': moves the cursor to the next physical line of the LCD display; if the cursor is on + the last line of the display, clears the display and positions the cursor at the top left + of the LCD + - Carriage return '\r': moves the cursor to the beginning of the current line + - Backspace '\b': moves the cursor one position backwards, wrapping to the end of the + previous line when at the beginning of a line (other then the first one). A space is then + inserted to replace the character at point, without moving the cursor. When the cursor is + at the beginning of the first line, does nothing. + - Form feed '\f': clears the LCD display and places the cursor at the beginning of the first line. + - Alarm '\a': ignored + + Any other character is sent to the LCD display using writeCharToLCD_. +*/ +void writeCharToLCD(char c) { + switch (c) { + case '\n': // Line feed + if (currentLineNum == LCD_NUMBER_OF_LINES - 1) { + scrollUp(1); + + currentLineChars = 0; + writeLCDInstr(INSTR_DDRAM_ADDR | lineBeginnings[currentLineNum]); + } else { + currentLineChars = 0; + writeLCDInstr(INSTR_DDRAM_ADDR | lineBeginnings[++currentLineNum]); + } + break; + case '\a': // Alarm + break; + case '\b': // Backspace (non-destructive) + if (currentLineChars == 0 && currentLineNum == 0) { + // At first line, first column; there is no where to move; do nothing + break; + } else if (currentLineChars == 0) { + // At beginning of line, need to move the end of previous line + currentLineChars = LCD_CHARACTERS_PER_LINE - 1; + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[--currentLineNum] + currentLineChars)); + } else { + // OK, simply go back one character + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + --currentLineChars)); + } + + break; + case '\r': // Carriage return + writeLCDInstr(INSTR_DDRAM_ADDR | lineBeginnings[currentLineNum]); + currentLineChars = 0; + break; + case '\f': // Form feed + clearDisplay(); + break; + default: // Printable character + if (currentLineChars == LCD_CHARACTERS_PER_LINE - 1 && currentLineNum == LCD_NUMBER_OF_LINES - 1) { + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + writeCharToLCD_(c); + + scrollUp(1); + + currentLineChars = 0; + writeLCDInstr(INSTR_DDRAM_ADDR | lineBeginnings[currentLineNum]); + } else if (currentLineChars == LCD_CHARACTERS_PER_LINE - 1) { + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + writeCharToLCD_(c); + + currentLineChars = 0; + writeLCDInstr(INSTR_DDRAM_ADDR | lineBeginnings[++currentLineNum]); + } else { + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + writeCharToLCD_(c); + currentLineChars++; + } + } +} + +void writeStringToLCD(char* str) { + while (*str != '\0') { +#ifdef LCD_ANSI_ESCAPE_ENABLE + // Check for ANSI CSI (Control Sequence Introducer) + if (*str == '\e') { + if (*(++str) != '\0' && *str == '[') { + char* str_ref = ++str; + switch (*str) { + case 's': // SCP - Save cursor position + saveCursorPosition(); + return; + case 'u': // RCP - Restore cursor position + restoreCursorPosition(); + return; + case '?': // DECTCEM + if (*(++str_ref) != '\0' && *str_ref == '2') { + if (*(++str_ref) != '\0' && *str_ref == '5') { + if (*(++str_ref) != '\0') { + if (*str_ref == 'l') { + hideCursor(); + } else if (*str_ref == 'h') { + showCursor(); + } else { + // Invalid escape + } + } // Invalid escape (early termination) + } // Invalid escape + } // Invalid escape + return; + default: + break; + } + + // Read optional variable length number in ASCII (0x30 - 0x3f) where 0x3a - 0x3f are + // ignored (they are used as flags by some terminals) + uint8_t fnd0; + uint8_t num0 = readASCIINumber(str, &fnd0, &str); + + // Read optional (semicolon followed by optional variable length number) + uint8_t fnd1; + uint8_t num1; + if (*str != '\0' && *str == ';') { + num1 = readASCIINumber(++str, &fnd1, &str); + + // Read control character (between 0x40 - 0x7e) for two argument sequences + switch (*str) { + case 'f': // HVP - Horizontal and vertical position + case 'H': // CUP - Cursor position + num0 = fnd0 ? num0 : 1; + num1 = fnd1 ? num1 : 1; + setCursorPosition(num0, num1); + break; + default: // Invalid control character + break; + } + } else if (*str != '\0') { + // Read control character (between 0x40 - 0x7e) for single argument sequences + switch (*str) { + case 'A': // CUU - Cursor up + num0 = fnd0 ? num0 : 1; + moveCursorUp(num0); + break; + case 'B': // CUD - Cursor down + num0 = fnd0 ? num0 : 1; + moveCursorDown(num0); + break; + case 'C': // CUF - Cursor forward + num0 = fnd0 ? num0 : 1; + moveCursorForward(num0); + break; + case 'D': // CUB - Cursor back + num0 = fnd0 ? num0 : 1; + moveCursorBackward(num0); + break; + case 'E': // CNL - Cursor next line + num0 = fnd0 ? num0 : 1; + moveCursorNextLine(num0); + break; + case 'F': // CPL - Cursor previous line + num0 = fnd0 ? num0 : 1; + moveCursorPreviousLine(num0); + break; + case 'G': // CHA - Cursor horizontal absolute + num0 = fnd0 ? num0 : 1; + moveCursorToColumn(num0); + break; + case 'J': // ED - Erase display + num0 = fnd0 ? num0 : 1; + eraseDisplay(num0); + break; + case 'K': // EL - Erase in line + num0 = fnd0 ? num0 : 1; + eraseInline(num0); + break; + case 'S': // SU - Scroll up + num0 = fnd0 ? num0 : 1; + scrollUp(num0); + break; + case 'T': // SD Scroll down + num0 = fnd0 ? num0 : 1; + scrollDown(num0); + break; + case 'm': // SGR - Select graphic rendition (single optional argument) + break; + case ';': // SGR - Select graphic rendition (multiple arguments) + if (fnd0) { + while (fnd0) { + readASCIINumber(++str, &fnd0, &str); + if (fnd0) { + if (*str == 'm') { + break; // Valid SGR + } else if (*str == ';') { + continue; // More SGR parameters yet + } else { + break; // Invalid escape + } + } else { + // Invalid escape; expected SGR parameter + } + } + } else { + // Invalid escape; expected first SGR parameter but none given + } + break; + case 'n': // DSR - Device status report + if (fnd0 && num0 == 6) { + // Valid DSR + } else { + // Invalid DSR + } + break; + default: // Invalid control character + writeCharToLCD(*str); + break; + } + } else { + return; // Invalid escape sequence (terminated early) + } + } + } else { + writeCharToLCD(*str); + } + + str++; +#else + writeCharToLCD(*(str++)); +#endif + } +} + +//--------------------------------------------------------------------------------------------- +// LCD command functions (all have associated ANSI escape) + +/* + Writes the CMD_CLEAR_DISPLAY command to the LCD using writeLCDINSTR, and clears the local + char and line counters. +*/ +void clearDisplay(void) { + writeLCDInstr(CMD_CLEAR_DISPLAY); + + // Reset line and char number tracking + currentLineNum = 0; + currentLineChars = 0; +} + +/* + Writes the CMD_RETURN_HOME command to the LCD using writeLCDInstr, and clears the local char + and line counters. +*/ +void returnHome(void) { + writeLCDInstr(CMD_RETURN_HOME); + + // Reset line and char number tracking + currentLineNum = 0; + currentLineChars = 0; +} + +void getCursorPosition(uint8_t* row, uint8_t* column) { + *row = currentLineNum + 1; + *column = currentLineChars + 1; +} + +void setCursorPosition(uint8_t row, uint8_t column) { + // Set currentLineNum and currentLineChars + currentLineNum = row ? row - 1 : 0; + currentLineChars = column ? column - 1 : 0; + + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void moveCursorUp(uint8_t n) { + if (n < currentLineNum + 1) { + currentLineNum -= n; + } else { + currentLineNum = 0; + } + + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void moveCursorDown(uint8_t n) { + if (n + currentLineNum < LCD_NUMBER_OF_LINES) { + currentLineNum += n; + } else { + currentLineNum = LCD_NUMBER_OF_LINES - 1; + } + + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void moveCursorForward(uint8_t n) { + if (n + currentLineChars < LCD_CHARACTERS_PER_LINE) { + currentLineChars += n; + } else { + currentLineChars = LCD_CHARACTERS_PER_LINE - 1; + } + + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void moveCursorBackward(uint8_t n) { + if (n < currentLineChars + 1) { + currentLineChars -= n; + } else { + currentLineChars = 0; + } + + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void moveCursorNextLine(uint8_t n) { + currentLineChars = 0; + + if (n + currentLineNum < LCD_NUMBER_OF_LINES) { + currentLineNum += n; + } else { + currentLineNum = LCD_NUMBER_OF_LINES - 1; + } + + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void moveCursorPreviousLine(uint8_t n) { + currentLineChars = 0; + + if (n < currentLineNum + 1) { + currentLineNum -= n; + } else { + currentLineNum = 0; + } + + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void moveCursorToColumn(uint8_t n) { + if (n <= LCD_CHARACTERS_PER_LINE) { + currentLineChars = n ? n - 1 : 0; + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); + } // else index out of range (off screen column) +} + +void eraseDisplay(uint8_t n) { + uint8_t old_row, old_column; + getCursorPosition(&old_row, &old_column); + + switch (n) { + case 0: // Clear from cursor to end of screen + { + uint8_t len = (LCD_NUMBER_OF_LINES - old_row)*LCD_CHARACTERS_PER_LINE + (LCD_CHARACTERS_PER_LINE - old_column); + for (uint8_t i = 0; i < len; i++) + writeCharToLCD(' '); + + // Write last char without scrolling + loop_until_LCD_BF_clear(); + writeCharToLCD_(' '); + break; + } + case 1: // Clear from cursor to beginning of screen + { + uint8_t len = (old_row - 1)*LCD_CHARACTERS_PER_LINE + old_column; + returnHome(); + for (uint8_t i = 0; i < len; i++) + writeCharToLCD(' '); + + // Write last char without scrolling + loop_until_LCD_BF_clear(); + writeCharToLCD_(' '); + break; + } + case 2: // Clear entire screen + clearDisplay(); + break; + default: // Invalid argument; do nothing + break; + } + + setCursorPosition(old_row, old_column); +} + +void eraseInline(uint8_t n) { + uint8_t old_row, old_column; + getCursorPosition(&old_row, &old_column); + + switch (n) { + case 0: // Clear from cursor to end of line + for (uint8_t i = old_column; i <= LCD_CHARACTERS_PER_LINE; i++) + writeCharToLCD(' '); + break; + case 1: // Clear from cursor to beginning of line + setCursorPosition(old_row, 1); + for (uint8_t i = 1; i <= old_column; i++) + writeCharToLCD(' '); + break; + case 2: // Clear entire line + setCursorPosition(old_row, 1); + for (uint8_t i = 1; i <= LCD_CHARACTERS_PER_LINE; i++) { + loop_until_LCD_BF_clear(); + writeCharToLCD_(' '); + } + break; + default: // Invalid argument; do nothing + return; + } + + setCursorPosition(old_row, old_column); +} + +void scrollUp(uint8_t n) { +#if LCD_NUMBER_OF_LINES == 1 + clearDisplay(); +#else + if (n >= LCD_NUMBER_OF_LINES) { + clearDisplay(); + } else { + uint8_t old_row, old_column; + getCursorPosition(&old_row, &old_column); + + uint8_t len = (LCD_NUMBER_OF_LINES - n)*LCD_CHARACTERS_PER_LINE + 1; + char str[len]; + readCharsFromLCD(n + 1, 1, LCD_NUMBER_OF_LINES, LCD_CHARACTERS_PER_LINE, str, len); + setCursorPosition(1, 1); // returnHome(); + writeStringToLCD(str); + + // Add n newlines to bottom of screen + for (uint8_t i = 0; i < n; i++) { + setCursorPosition(LCD_NUMBER_OF_LINES - i, 1); + eraseInline(2); + } + + setCursorPosition(old_row, old_column); + } +#endif +} + +void scrollDown(uint8_t n) { +#if LCD_NUMBER_OF_LINES == 1 + clearDisplay(); +#else + if (n >= LCD_NUMBER_OF_LINES) { + clearDisplay(); + } else { + uint8_t old_row, old_column; + getCursorPosition(&old_row, &old_column); + + uint8_t len = (LCD_NUMBER_OF_LINES - n)*LCD_CHARACTERS_PER_LINE + 1; + char str[len]; + readCharsFromLCD(1, 1, LCD_NUMBER_OF_LINES - n, LCD_CHARACTERS_PER_LINE, str, len); + + for (uint8_t column = n + 1, i = 0; column <= LCD_NUMBER_OF_LINES; column++) { + setCursorPosition(column , 1); + for (uint8_t row = 1; row <= LCD_CHARACTERS_PER_LINE; row++) { + loop_until_LCD_BF_clear(); + writeCharToLCD_(str[i++]); + } + } + + // Add n newlines to top of screen + for (uint8_t i = 1; i <= n; i++) { + setCursorPosition(i, 1); + eraseInline(2); + } + + setCursorPosition(old_row, old_column); + } +#endif +} + +void saveCursorPosition() { + saveCursorLineNum = currentLineNum; + saveCursorLineChars = currentLineChars; +} + +void restoreCursorPosition() { + currentLineNum = saveCursorLineNum; + currentLineChars = saveCursorLineChars; + writeLCDInstr(INSTR_DDRAM_ADDR | (lineBeginnings[currentLineNum] + currentLineChars)); +} + +void hideCursor(void) { + lcdState &= ~(1 << INSTR_DISPLAY_C); + writeLCDInstr(INSTR_DISPLAY | lcdState); +} + +void showCursor(void) { + lcdState |= (1 << INSTR_DISPLAY_C); + writeLCDInstr(INSTR_DISPLAY | lcdState); +} + +//----------------------------------------------------------------------------------------------- +// Utility functions (with no associated ASCII or ANSI escape) + +void blinkCursorOff(void) { + lcdState &= ~(1 << INSTR_DISPLAY_B); + writeLCDInstr(INSTR_DISPLAY | lcdState); +} + +void blinkCursorOn(void) { + lcdState |= (1 << INSTR_DISPLAY_B); + writeLCDInstr(INSTR_DISPLAY | lcdState); +} + +void displayOff(void) { + lcdState &= ~(1 << INSTR_DISPLAY_D); + writeLCDInstr(INSTR_DISPLAY | lcdState); +} + +void displayOn(void) { + lcdState |= (1 << INSTR_DISPLAY_D); + writeLCDInstr(INSTR_DISPLAY | lcdState); +} + +//----------------------------------------------------------------------------------------------- + +char readCharFromLCD(uint8_t row, uint8_t column) { + uint8_t old_row, old_column; + getCursorPosition(&old_row, &old_column); + + setCursorPosition(row, column); + + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + setLCDDBusAsInputs(); + char c = readLCDDBusByte_(); + setLCDDBusAsOutputs(); + + setCursorPosition(old_row, old_column); + return c; +} + +void readLCDLine(uint8_t i, char* str) { + readCharsFromLCD(i, 1, i, LCD_CHARACTERS_PER_LINE, str, LCD_CHARACTERS_PER_LINE + 1); +} + +//--------------------------------------------------------------------------------------------- +// Advanced functions for special cases + +void readCharsFromLCD(uint8_t from_row, uint8_t from_column, uint8_t to_row, uint8_t to_column, char* str, uint8_t len) { + uint8_t old_row, old_column; + getCursorPosition(&old_row, &old_column); + setCursorPosition(from_row, from_column); + + for (uint8_t i = 0; i < len - 1 && from_row <= to_row; i++) { + if (from_row == LCD_NUMBER_OF_LINES && from_column == LCD_CHARACTERS_PER_LINE) { + // Last character on screen + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + setLCDDBusAsInputs(); + *(str++) = readLCDDBusByte_(); + setLCDDBusAsOutputs(); + } else if (from_column == LCD_CHARACTERS_PER_LINE) { // End of line (but not last one) + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + setLCDDBusAsInputs(); + *(str++) = readLCDDBusByte_(); + setLCDDBusAsOutputs(); + + from_row += 1; + from_column = 1; + setCursorPosition(from_row, from_column); + } else { + loop_until_LCD_BF_clear(); // Wait until LCD is ready for new instructions + setLCDDBusAsInputs(); + *(str++) = readLCDDBusByte_(); + setLCDDBusAsOutputs(); + + from_column++; + } + } + + // Ensure array is terminated with null character + *str = '\0'; + + setCursorPosition(old_row, old_column); + setLCDDBusAsOutputs(); +} + +/* + Initialize LCD using the internal reset circuitry. + + Note: This currently only works with 8 bit modes, but is not recommended. Instead use the + initLCD function which uses the software initialization method and works for 8-bit + modes as well the 4-bit mode. + */ +void initLCDByInternalReset(void) { + setLCDDBusAsOutputs(); + + // Function set (8-bit interface; 2 lines with 5x7 dot character font) + writeLCDInstr_(INSTR_FUNC_SET | (1 << INSTR_FUNC_SET_DL) | (1 << INSTR_FUNC_SET_N)); + + writeLCDInstr_(0x0F); + writeLCDInstr_(0x06); + writeLCDInstr_(CMD_CLEAR_DISPLAY); + _delay_ms(LCD_CLEAR_DISPLAY_DELAY); +} diff --git a/src/lcdLib/lcdLib.h b/src/lcdLib/lcdLib.h new file mode 100644 index 0000000..461290f --- /dev/null +++ b/src/lcdLib/lcdLib.h @@ -0,0 +1,328 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + +/** + * @file lcdLib.h + * @author Collin J. Doering + * @date Sep 29, 2015 + * @brief Functions to initialize, and operate a character LCD. + */ + +#ifndef LCD_LIB_H +#define LCD_LIB_H + +// Includes ----------------------------------------------------------------------------------- +#include "lcd_instr.h" +#include "lcdLibConfig.h" + +//--------------------------------------------------------------------------------------------- +// Library function declarations + +/** + Initialize the LCD display via software initialization as specified by the datasheet. +*/ +void initLCD(void); + +/** + Writes a character to the LCD display at the current cursor position after the LCD display is + ready for new data. Allows the following ASCII escapes: '\n', '\r', '\f' and '\b'; ignores + ASCII escape '\a'. + */ +void writeCharToLCD(char); + +/** + Writes a string to the LCD starting from the current cursor position. + */ +void writeStringToLCD(char*); + +//--------------------------------------------------------------------------------------------- +// LCD command functions (all have associated ANSI escape) + +/** + Clears the display and positions the cursor in the top left of the LCD screen. + */ +void clearDisplay(void); + +/** + Brings the cursor the the top left of the LCD screen. + */ +void returnHome(void); + +/** + Gets the current row and column of the LCD cursor and sets given pointers row and column to + their respective values. Note indexes start at 1. +*/ +void getCursorPosition(uint8_t* row, uint8_t* column); + +/** + Using the given parameters row and column, sets the current row and column occupied by the LCD + cursor. Note indexes start at 1. + */ +void setCursorPosition(uint8_t row, uint8_t column); + +/** + Moves the cursor n positions up. If the cursor is at the edge of the screen this has no effect. + */ +void moveCursorUp(uint8_t n); + +/** + Moves the cursor n positions down. If the cursor is at the edge of the screen this has no effect. + */ +void moveCursorDown(uint8_t n); + +/** + Moves the cursor n positions forward. If the cursor is at the edge of the screen this has no effect. + */ +void moveCursorForward(uint8_t n); + +/** + Moves the cursor n positions backwards. If the cursor is at the edge of the screen this has no effect. + */ +void moveCursorBackward(uint8_t n); + +/** + Moves the cursor to the beginning of the line n lines down. + */ +void moveCursorNextLine(uint8_t n); + +/** + Moves the cursor to the beginning of the line n lines up. + */ +void moveCursorPreviousLine(uint8_t n); + +/** + Moves the cursor to column n. If n is off screen go to the last line. + */ +void moveCursorToColumn(uint8_t n); + +/** + Scroll whole page up by n lines. New lines are added at the bottom. + */ +void scrollUp(uint8_t n); + +/** + Scroll whole page down by n lines. New lines are added at the top. + */ +void scrollDown(uint8_t n); + +/** + Saves the cursors current position. + */ +void saveCursorPosition(void); + +/** + Restores the last saved cursor position. + */ +void restoreCursorPosition(void); + +/** + Clears part or all of screen dependent on the value of n: + 0 or missing: clear from cursor to end of screen + 1: clear from cursor to end of screen + 2: clear entire screen + */ +void eraseDisplay(uint8_t n); + +/** + Erases part of a line dependent on the value of n: + 0 or missing: clear from cursor to end of the line + 1: clear from cursor to beginning of the line + 2: clear entire line + */ +void eraseInline(uint8_t n); + +/** + Hides the cursor + */ +void hideCursor(void); + +/** + Shows the cursor + */ +void showCursor(void); + +//--------------------------------------------------------------------------------------------- +// Utility functions (with no associated ASCII or ANSI escape) + +/** + Turns the cursor blink off. + */ +void blinkCursorOff(void); + +/** + Turns the cursor blink on. + */ +void blinkCursorOn(void); + +/** + Turns the display off. + */ +void displayOff(void); + +/** + Turns the display on. + */ +void displayOn(void); + +//--------------------------------------------------------------------------------------------- + +/** + Read a single character from the row and column given (1 based) returning the cursor to + its previous original position. + */ +char readCharFromLCD(uint8_t row, uint8_t column); + +/** + Read a line i (ones based) into str. +*/ +void readLCDLine(uint8_t i, char* str); + +//--------------------------------------------------------------------------------------------- +// Advanced functions for special cases + +/** + Read len characters from (from_row, from_column) to (to_row, to_column) returning the cursor + to its original position after the read. Upon success (not overflowing the screen), 0 is + returned; otherwise non zero will be returned. The str pointer will be updated with the + characters read from the screen. Even in the case of failure, str may be partially populated. + */ +void readCharsFromLCD(uint8_t from_row, uint8_t from_column, uint8_t to_row, uint8_t to_column, char* str, uint8_t len); + +/** + Initialize the LCD display via its internal reset circuit. + + Note: this is not the recommended way to initialize the LCD as it is unreliable and depends + on the power supply. Preferably the software initialization method should be used (via + the initLCD function). + */ +void initLCDByInternalReset(void); + + +//--------------------------------------------------------------------------------------------- +// Mode and settings sanity check (preprocessor tests of lcdLibConfig.h) +//--------------------------------------------------------------------------------------------- + +#if !defined(LCD_CHARACTERS_PER_LINE) +#error "All modes require LCD_CHARACTERS_PER_LINE to be defined." +#elif !defined(LCD_NUMBER_OF_LINES) +#error "All modes require LCD_NUMBER_OF_LINES to be defined." +#elif !defined(LCD_LINE_BEGINNINGS) +#error "All modes require LCD_LINE_BEGINNINGS to be defined." +#else + +#if LCD_NUMBER_OF_LINES == 1 +#define LCD_LINES 0 +#else +#define LCD_LINES (1 << INSTR_FUNC_SET_N) +#endif + +#define LCD_CHARACTERS_PER_SCREEN (LCD_CHARACTERS_PER_LINE * LCD_NUMBER_OF_LINES) +#endif + +#if !defined(LCD_FONT_5x8) &&\ + !defined(LCD_FONT_5x10) +#error "All modes require LCD_FONT_5x8 or LCD_FONT_5x10 to be defined." +#elif defined(LCD_FONT_5x8) && \ + defined(LCD_FONT_5x10) +#error "LCD_FONT_5x8 and LCD_FONT_5x10 are mutually exclusive. Choose one." +#elif defined(LCD_FONT_5x8) +#define LCD_FONT 0 +#elif defined(LCD_FONT_5x10) +#define LCD_FONT (1 << INSTR_FUNC_SET_F) +#endif + +#if !defined (LCD_RS) || \ + !defined (LCD_RS_PORT) || \ + !defined (LCD_RS_DDR) || \ + !defined (LCD_RW) || \ + !defined (LCD_RW_PORT) || \ + !defined (LCD_RW_DDR) || \ + !defined (LCD_ENABLE) || \ + !defined (LCD_ENABLE_PORT) || \ + !defined (LCD_ENABLE_DDR) +#error "All modes require LCD_RS[,_PORT,_DDR], LCD_RW[,_PORT,_DDR], and LCD_ENABLE[,_PORT,_DDR] be defined." +#endif + +#if defined (EIGHT_BIT_ARBITRARY_PIN_MODE) && \ + defined (FOUR_BIT_MODE) +#error "EIGHT_BIT_ARBITRARY_PIN_MODE and FOUR_BIT_MODE are mutually exclusive. Choose one." +#elif defined (EIGHT_BIT_ARBITRARY_PIN_MODE) || \ + defined (FOUR_BIT_MODE) + +// EIGHT_BIT_ARBITRARY_PIN_MODE specific requirements +#ifdef EIGHT_BIT_ARBITRARY_PIN_MODE +#if !defined (LCD_DBUS0) || \ + !defined (LCD_DBUS0_PORT) || \ + !defined (LCD_DBUS0_DDR) || \ + !defined (LCD_DBUS0_PIN) || \ + !defined (LCD_DBUS1) || \ + !defined (LCD_DBUS1_PORT) || \ + !defined (LCD_DBUS1_DDR) || \ + !defined (LCD_DBUS1_PIN) || \ + !defined (LCD_DBUS2) || \ + !defined (LCD_DBUS2_PORT) || \ + !defined (LCD_DBUS2_DDR) || \ + !defined (LCD_DBUS2_PIN) || \ + !defined (LCD_DBUS3) || \ + !defined (LCD_DBUS3_PORT) || \ + !defined (LCD_DBUS3_DDR) || \ + !defined (LCD_DBUS3_PIN) +#error "EIGHT_BIT_ARBITRARY_PIN_MODE require that LCD_DBUS*[,_PORT,_DDR,_PIN] be defined." +#endif +#endif + +// Requirements for EIGHT_BIT_ARBITRARY_PIN_MODE and FOUR_BIT_MODE +#if !defined (LCD_DBUS4) || \ + !defined (LCD_DBUS4_PORT) || \ + !defined (LCD_DBUS4_DDR) || \ + !defined (LCD_DBUS4_PIN) || \ + !defined (LCD_DBUS5) || \ + !defined (LCD_DBUS5_PORT) || \ + !defined (LCD_DBUS5_DDR) || \ + !defined (LCD_DBUS5_PIN) || \ + !defined (LCD_DBUS6) || \ + !defined (LCD_DBUS6_PORT) || \ + !defined (LCD_DBUS6_DDR) || \ + !defined (LCD_DBUS6_PIN) || \ + !defined (LCD_DBUS7) || \ + !defined (LCD_DBUS7_PORT) || \ + !defined (LCD_DBUS7_DDR) || \ + !defined (LCD_DBUS7_PIN) +#error "Both EIGHT_BIT_ARBITRARY_PIN_MODE and FOUR_BIT_MODE require that LCD_DBUS*[,_PORT,_DDR,_PIN] be defined." +#endif + +// Set LCD_BF automatically for both EIGHT_BIT_ARBITRARY_PIN_MODE and FOUR_BIT_MODE +#undef LCD_BF +#define LCD_BF LCD_DBUS7 + +#else +#if !defined (LCD_DBUS_PORT) || \ + !defined (LCD_DBUS_DDR) || \ + !defined (LCD_DBUS_PIN) || \ + !defined (LCD_BF) +#error "Default mode requires that LCD_DBUS_[PORT,DDR,PIN] and LCD_BF be defined." +#endif + +#undef LCD_DBUS7_PORT +#define LCD_DBUS7_PORT LCD_DBUS_PORT +#undef LCD_DBUS7_DDR +#define LCD_DBUS7_DDR LCD_DBUS_DDR +#undef LCD_DBUS7_PIN +#define LCD_DBUS7_PIN LCD_DBUS_PIN +#endif + +#endif /* LCD_LIB_H */ diff --git a/src/lcdLib/lcdLibConfig.h b/src/lcdLib/lcdLibConfig.h new file mode 100644 index 0000000..bdc9b58 --- /dev/null +++ b/src/lcdLib/lcdLibConfig.h @@ -0,0 +1,156 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + +/** + * @file lcdLibConfig.h + * @author Collin J. Doering + * @date Oct 4, 2015 + * @brief Configuration file for lcdLib.h + */ + +// Includes ------------------------------------------------------------------------------- + +#include + +//------------------------------------------------------------------------------------------ + +/** + Usage + ===== + + Operates in 3 mutually exclusive modes: + 1. Default Mode + 8-bit mode that requires all its data bus lines be on the same PORT. + 2. EIGHT_BIT_ARBITRARY_PIN_MODE + 8-bit mode that allows the data bus lines to use any IO pin. + 3. FOUR_BIT_MODE + 4-bit mode that allows the data bus lines to use any IO pin. +*/ + +/* + Screen characteristics +*/ + +#define LCD_CHARACTERS_PER_LINE 20 ///< Number of characters per line of the LCD +#define LCD_NUMBER_OF_LINES 4 ///< Number of lines of the LCD +#define LCD_LINE_BEGINNINGS 0x00, \ + 0x40, \ + 0x14, \ + 0x54 ///< Memory locations for each physical line ordered 1 to LCD_NUMBER_OF_LINES + +/* Which font to use (can only leave one uncommented) */ +#define LCD_FONT_5x8 +//#define LCD_FONT_5x10 + +/* Support ANSI escapes; comment to disable */ +#define LCD_ANSI_ESCAPE_ENABLE + +/* Modes */ + +// Default mode: 8-bit data bus + +// 8-bit mode with data bus on arbitrary pins +//#define EIGHT_BIT_ARBITRARY_PIN_MODE + +// LCD in 4-bit mode (on arbitrary pins) +#define FOUR_BIT_MODE + +/* All mode options */ + +#define LCD_RS PD2 +#define LCD_RS_PORT PORTD +#define LCD_RS_DDR DDRD + +#define LCD_RW PD3 +#define LCD_RW_PORT PORTD +#define LCD_RW_DDR DDRD + +#define LCD_ENABLE PD4 +#define LCD_ENABLE_PORT PORTD +#define LCD_ENABLE_DDR DDRD + +/* + Mode specific settings +*/ + +/* Default Mode */ + +// LCD data bus PORT, PIN and DDR. +#define LCD_DBUS_PORT PORTB + +#define LCD_DBUS_DDR DDRB +#define LCD_DBUS_PIN PINB + +// This must be set in default mode to the MSB of the data lines +#define LCD_BF PB7 + +/* EIGHT_BIT_ARBITRARY_PIN_MODE specific settings */ + +#define LCD_DBUS0 PB0 +#define LCD_DBUS0_PORT PORTB +#define LCD_DBUS0_DDR DDRB +#define LCD_DBUS0_PIN PINB + +#define LCD_DBUS1 PB1 +#define LCD_DBUS1_PORT PORTB +#define LCD_DBUS1_DDR DDRB +#define LCD_DBUS1_PIN PINB + +#define LCD_DBUS2 PB2 +#define LCD_DBUS2_PORT PORTB +#define LCD_DBUS2_DDR DDRB +#define LCD_DBUS2_PIN PINB + +#define LCD_DBUS3 PB3 +#define LCD_DBUS3_PORT PORTB +#define LCD_DBUS3_DDR DDRB +#define LCD_DBUS3_PIN PINB + +/* FOUR_BIT_MODE and EIGHT_BIT_ARBITRARY_PIN_MODE shared settings */ + +#define LCD_DBUS4 PB4 +#define LCD_DBUS4_PORT PORTB +#define LCD_DBUS4_DDR DDRB +#define LCD_DBUS4_PIN PINB + +#define LCD_DBUS5 PB5 +#define LCD_DBUS5_PORT PORTB +#define LCD_DBUS5_DDR DDRB +#define LCD_DBUS5_PIN PINB + +#define LCD_DBUS6 PB6 +#define LCD_DBUS6_PORT PORTB +#define LCD_DBUS6_DDR DDRB +#define LCD_DBUS6_PIN PINB + +#define LCD_DBUS7 PB7 +#define LCD_DBUS7_PORT PORTB +#define LCD_DBUS7_DDR DDRB +#define LCD_DBUS7_PIN PINB + + +/* LCD delays (in microseconds when unspecified) */ + +#define LCD_ENABLE_HIGH_DELAY 25 +#define LCD_ENABLE_LOW_DELAY 25 +#define LCD_INIT_DELAY0 15000 +#define LCD_INIT_DELAY1 8200 +#define LCD_INIT_DELAY2 200 + +#define LCD_CLEAR_DISPLAY_DELAY 16000 +#define LCD_RETURN_HOME_DELAY 16000 +#define LCD_GENERIC_INSTR_DELAY 50 diff --git a/src/lcdLib/lcd_instr.h b/src/lcdLib/lcd_instr.h new file mode 100644 index 0000000..6a50d69 --- /dev/null +++ b/src/lcdLib/lcd_instr.h @@ -0,0 +1,61 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + +/** + * @file lcd_instr.h + * @author Collin J. Doering + * @date Oct 26, 2015 + * @brief Constant macro definitions of HD44780 compatible character LCD instruction set + */ + +/* + LCD character display instructions +*/ + +// Simple instructions with no options +#define CMD_INIT 0x30 +#define CMD_INIT_FOUR_BIT 0x20 +#define CMD_CLEAR_DISPLAY 0x01 +#define CMD_RETURN_HOME 0x02 + +// Entry Set instruction and associated options +#define INSTR_ENTRY_SET 0x04 +#define INSTR_ENTRY_SET_ID 1 +#define INSTR_ENTRY_SET_S 0 + +// Display control instruction and associated options +#define INSTR_DISPLAY 0x08 +#define INSTR_DISPLAY_D 2 +#define INSTR_DISPLAY_C 1 +#define INSTR_DISPLAY_B 0 + +// Cursor or display shift instruction and associated options +#define INSTR_MOV_SHIFT 0x10 +#define INSTR_MOV_SHIFT_SC 3 +#define INSTR_MOV_SHIFT_RL 2 + +// Function set instruction and associated options +#define INSTR_FUNC_SET 0x20 +#define INSTR_FUNC_SET_DL 4 +#define INSTR_FUNC_SET_N 3 +#define INSTR_FUNC_SET_F 2 + +// Set CG RAM address instruction +#define INSTR_CGRAM_ADDR 0x60 + +// Set DD RAM address instruction +#define INSTR_DDRAM_ADDR 0x80 diff --git a/src/uart_echo.c b/src/uart_echo.c new file mode 100644 index 0000000..44eebab --- /dev/null +++ b/src/uart_echo.c @@ -0,0 +1,107 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * File: uart_echo.c + * Author: Collin J. Doering + * Date: Sep 17, 2015 + */ + +/*---------. +| Includes | +`---------*/ + +#include +#include +#include +#include +#include + +#include "lcdLib.h" +#include "ansi_escapes.h" +#include "USART.h" + +#define STATUS_LED_PORT PORTC +#define STATUS_LED_DDR DDRC +#define STATUS_LED PC5 + +//-------------------------------------------------- + +void flashLED(uint8_t times) { + while (times > 0) { + STATUS_LED_PORT |= 1 << STATUS_LED; // turn on status LED + _delay_ms(100); + STATUS_LED_PORT &= ~(1 << STATUS_LED); // turn status LED off + _delay_ms(100); + times--; + } +} + +//-------------------------------------------------- + +int main(void) { + clock_prescale_set(clock_div_1); + + STATUS_LED_DDR |= 1 << STATUS_LED; // DEBUG + + initUSART(); + char serialChar; + + initLCD(); + //initLCDByInternalReset(); + flashLED(5); // DEBUG + + while (1) { + serialChar = receiveByte(); + + switch (serialChar) { + case '\r': + writeStringToLCD("\r\n"); + transmitString("\n" CNL(1) "\r"); + break; + case '\f': + writeCharToLCD(serialChar); + transmitString(ED(2) CUP(1,1)); + break; + case 0x7f: // Backspace (sent as delete) + writeStringToLCD("\b \b"); + transmitString(CUB(1) " " CUB(1)); + break; + case '\e': // Beginning of ANSI escape + { + char j = receiveByte(); + + if (j == '[') { + char buf[11] = "\e["; + for (uint8_t i = 2, j = receiveByte(); i < 10 && j > 0x20 && j < 0x7e; i++, j = receiveByte()) { + buf[i] = j; + if (j > 0x40 && j < 0x7e) { + break; + } + } + writeStringToLCD(buf); + } + break; + } + default: + writeCharToLCD(serialChar); + transmitByte(serialChar); // Echo character back to serial console + } + } + + return 0; +}