Extended TextLCD: uses Bus or Port output for added performance, with display/cursor control, with LCDType as a class, with character generator programming capability.
Revision 2:2773889d6143, committed 2011-02-05
- Comitter:
- osmeest
- Date:
- Sat Feb 05 23:20:53 2011 +0000
- Parent:
- 1:c360c4648b08
- Commit message:
- Republish after name clash with testbed
Changed in this revision
diff -r c360c4648b08 -r 2773889d6143 TextLCD.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/TextLCD.cpp Sat Feb 05 23:20:53 2011 +0000 @@ -0,0 +1,172 @@ +/* mbed TextLCD Library, for a 4-bit LCD based on HD44780 + * Copyright (c) 2007-2010, sford, http://mbed.org + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include "ext_text_lcd/TextLCD.h" +#include "mbed.h" + +namespace ext_text_lcd { + +namespace { + int makeLcdAddress(const TextLCD::LCDType &type, int column, int row) { + return column + row * 0x40; + } + + int makeLcdAddress40(const TextLCD::LCDType &type, int column, int row) { + return column + row * 40; + } + + int makeLcdAddress4Rows(const TextLCD::LCDType &type, int column, int row) { + return column + (row % 2) * 0x40 + (row / 2) * 20; + } +} + +const TextLCD::LCDType TextLCD::LCD16x2(16, 2, makeLcdAddress); +const TextLCD::LCDType TextLCD::LCD16x2B(16, 2, makeLcdAddress40); +const TextLCD::LCDType TextLCD::LCD20x2(20, 2, makeLcdAddress); +const TextLCD::LCDType TextLCD::LCD20x4(20, 4, makeLcdAddress4Rows); + +TextLCD::TextLCD(PinName rs, PinName e, PinName d4, PinName d5, + PinName d6, PinName d7, const LCDType &type) : + _rs(rs), _e(e), _output(new BusOutput(d4, d5, d6, d7)), + _type(type) +{ + init(); +} + +TextLCD::TextLCD(PinName rs, PinName e, PortName dport, std::size_t dlsb, + const LCDType &type) : + _rs(rs), _e(e), _output(new PortOutput(dport, dlsb)), + _type(type) +{ + init(); +} + +void TextLCD::init() { + _e = 1; + _rs = 0; // command mode + + wait(0.015); // Wait 15ms to ensure powered up + + // send "Display Settings" 3 times (Only top nibble of 0x30 as we've got 4-bit bus) + for (int i=0; i<3; i++) { + writeByte(0x3); + wait(0.00164); // this command takes 1.64ms, so wait for it + } + writeByte(0x2); // 4-bit mode + wait(0.000040f); // most instructions take 40us + + writeCommand(0x28); // Function set 001 BW N F - - + writeCommand(0x0C); + writeCommand(0x6); // Cursor Direction and Display Shift : 0000 01 CD S (CD 0-left, 1-right S(hift) 0-no, 1-yes + cls(); +} + +void TextLCD::cls() { + writeCommand(0x01); // cls, and set cursor to 0 + wait(0.00164f); // This command takes 1.64 ms + locate(0, 0); +} + +void TextLCD::locate(int column, int row) { + _column = column; + _row = row; + + int a = address(column, row); + writeCommand(0x80 | a); +} + +int TextLCD::_putc(int value) { + int column = _column; + int row = _row; + if (value == '\n') { + column = 0; + row = _row+1; + } else { + writeData(value); + column++; + if (column < columns()) { + return value; + } + + column = 0; + row++; + } + if (row >= rows()) { + row = 0; + } + locate(column, row); + return value; +} + +int TextLCD::_getc() { + return -1; +} + +void TextLCD::writeByte(int value) { + _output->writeNibble(value >> 4); + wait(0.000040f); // most instructions take 40us + _e = 0; + wait(0.000040f); + _e = 1; + _output->writeNibble(value); + wait(0.000040f); + _e = 0; + wait(0.000040f); // most instructions take 40us + _e = 1; +} + +void TextLCD::writeCommand(int command) { + _rs = 0; + writeByte(command); +} + +void TextLCD::writeData(int data) { + _rs = 1; + writeByte(data); +} + +void TextLCD::setDisplayControl(DisplayControl d, CursorDisplayControl c, CursorStyle b) +{ + writeCommand(0x08 | d | c | b); +} + +void TextLCD::writeToCGMem(unsigned addr, const char *buffer, std::size_t size) +{ + writeCommand(0x40 | (addr & 0x3f)); + while (size > 0) { + writeData(*buffer); + size--; + buffer++; + } + + locate(_column, _row); +} + +void TextLCD::BusOutput::writeNibble(int value) { + _bus = value; +} + +void TextLCD::PortOutput::writeNibble(int value) { + _port = value << _shift; +} + +} // ext_text_lcd namespace
diff -r c360c4648b08 -r 2773889d6143 ext_text_lcd/TextLCD.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ext_text_lcd/TextLCD.h Sat Feb 05 23:20:53 2011 +0000 @@ -0,0 +1,194 @@ +/* Extended TextLCD library. + * + * Based on the mbed TextLCD Library, for a 4-bit LCD based on HD44780 + * Copyright (c) 2007-2010, sford, http://mbed.org + * + * Original license: + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#ifndef EXT_TEXT_LCD_TEXTLCD_H +#define EXT_TEXT_LCD_TEXTLCD_H + +#include "mbed.h" + +namespace ext_text_lcd { + +/** A TextLCD interface for driving 4-bit HD44780-based LCDs + * + * Currently supports 16x2, 20x2 and 20x4 panels + * + * @code + * #include "mbed.h" + * #include "TextLCD.h" + * + * TextLCD lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7 on individual pins + * TextLCD lcd(p10, p12, Port2, 2); // rs, e, d4-d7 on P2.2-P2.5 + * + * int main() { + * lcd.printf("Hello World!\n"); + * } + * @endcode + */ +class TextLCD : public Stream { +public: + /** LCD panel format */ + class LCDType { + public: + int columns() const; + int rows() const; + int address(int column, int row) const; + + typedef int (*MakeAddrFunc)(const LCDType &, int, int); + + private: + LCDType(int columns, int rows, MakeAddrFunc makeAddr) : + _columns(columns), _rows(rows), _makeAddr(makeAddr) + { } + + friend class TextLCD; + + int _columns; + int _rows; + MakeAddrFunc _makeAddr; + }; + + static const LCDType LCD16x2; + static const LCDType LCD16x2B; + static const LCDType LCD20x2; + static const LCDType LCD20x4; + + /** Create a TextLCD interface + * + * @param rs Instruction/data control line + * @param e Enable line (clock) + * @param d4-d7 Data lines for using as a 4-bit interface + * @param type Sets the panel size/addressing mode (default = LCD16x2) + */ + TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, const LCDType &type = LCD16x2); + + /** Create a TextLCD interface + * + * @param rs Instruction/data control line + * @param e Enable line (clock) + * @param dport GPIO port with all data lines + * @param dlsb Index of the lowest data bit in the GPIO port + * @param type Sets the panel size/addressing mode (default = LCD16x2) + */ + TextLCD(PinName rs, PinName e, PortName dport, std::size_t dlsb, const LCDType &type = LCD16x2); + +#if DOXYGEN_ONLY + /** Write a character to the LCD + * + * @param c The character to write to the display + */ + int putc(int c); + + /** Write a formated string to the LCD + * + * @param format A printf-style format string, followed by the + * variables to use in formating the string. + */ + int printf(const char* format, ...); +#endif + + /** Locate to a screen column and row + * + * @param column The horizontal position from the left, indexed from 0 + * @param row The vertical position from the top, indexed from 0 + */ + void locate(int column, int row); + + /** Clear the screen and locate to 0,0 */ + void cls(); + + int columns() { return _type.columns(); } + int rows() const { return _type.rows(); } + + enum DisplayControl { + DisplayOn = 0x04, + DisplayOff = 0 + }; + enum CursorDisplayControl { + CursorOn = 0x02, + CursorOff = 0 + }; + enum CursorStyle { + BlinkingCursor = 0x01, + UnderlineCursor = 0 + }; + void setDisplayControl(DisplayControl d = DisplayOn, CursorDisplayControl c = CursorOff, CursorStyle b = UnderlineCursor); + + void writeToCGMem(unsigned addr, const char *buffer, std::size_t size); + +protected: + // Stream implementation functions + virtual int _putc(int value); + virtual int _getc(); + + int address(int column, int row) const { return _type.address(column, row); } + + void writeByte(int value); + void writeCommand(int command); + void writeData(int data); + +private: + void init(); + + struct LcdOutput { + virtual void writeNibble(int value) = 0; + virtual ~LcdOutput() { } + }; + + struct BusOutput : public LcdOutput { + BusOutput(PinName d4, PinName d5, PinName d6, PinName d7) : _bus(d4, d5, d6, d7) { } + virtual void writeNibble(int value); + private: + BusOut _bus; + }; + + struct PortOutput : public LcdOutput { + PortOutput(PortName dport, std::size_t dlsb) : _port(dport, 0x0f << dlsb), _shift(dlsb) { } + virtual void writeNibble(int value); + + private: + PortOut _port; + std::size_t _shift; + }; + + DigitalOut _rs, _e; + LcdOutput *_output; + LCDType _type; + int _column; + int _row; +}; + +inline int TextLCD::LCDType::columns() const { + return this->_columns; +} +inline int TextLCD::LCDType::rows() const { + return this->_rows; +} +inline int TextLCD::LCDType::address(int column, int row) const { + return this->_makeAddr(*this, column, row); +} + +} // ext_text_lcd namespace + +#endif
diff -r c360c4648b08 -r 2773889d6143 main.cpp --- a/main.cpp Sat Feb 05 22:07:11 2011 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,36 +0,0 @@ -// Hello World! for the TextLCD - -#include "ext_text_lcd/TextLCD.h" -#include <sstream> -#include <iostream> -#include <iomanip> - -using namespace std; -using namespace ext_text_lcd; - -//TextLCD lcd(p28, p27, p26, p25, p24, p23, TextLCD::LCD20x2); // rs, e, d4-d7 -TextLCD lcd(p28, p27, Port2, 0, TextLCD::LCD20x2); // rs, e, d4-d7 - -int main() { - lcd.setDisplayControl(TextLCD::DisplayOn, TextLCD::CursorOn, TextLCD::BlinkingCursor); - - lcd.locate(0,0); - lcd.printf("(0,0)"); - lcd.locate(0,1); - lcd.printf("(0,1)"); - lcd.locate(14,0); - lcd.printf("(19,0)"); - lcd.locate(14,1); - lcd.printf("(19,1)"); - - while (1) { - lcd.locate(0,0); - wait(2); - lcd.locate(0,1); - wait(2); - lcd.locate(19,0); - wait(2); - lcd.locate(19,1); - wait(2); - } -}
diff -r c360c4648b08 -r 2773889d6143 mbed.bld --- a/mbed.bld Sat Feb 05 22:07:11 2011 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1 +0,0 @@ -http://mbed.org/users/mbed_official/code/mbed/builds/e2ac27c8e93e