/* $Id$ * $URL$ * * new style driver for Matrix Orbital serial display modules * * Copyright (C) 1999, 2000 Michael Reinelt <michael@reinelt.co.at> * Copyright (C) 2004 The LCD4Linux Team <lcd4linux-devel@users.sourceforge.net> * * This file is part of LCD4Linux. * * LCD4Linux 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 2, or (at your option) * any later version. * * LCD4Linux 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, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. * */ /* * * exported fuctions: * * struct DRIVER drv_MatrixOrbital * */ #include "config.h" #include <stdlib.h> #include <stdio.h> #include <string.h> #include <unistd.h> #include <time.h> #include "debug.h" #include "cfg.h" #include "plugin.h" #include "widget.h" #include "widget_text.h" #include "widget_icon.h" #include "widget_bar.h" #include "drv.h" #include "drv_generic_text.h" #include "drv_generic_gpio.h" #include "drv_generic_serial.h" static char Name[] = "MatrixOrbital"; static int Model; static int Protocol; typedef struct { int type; char *name; int rows; int cols; int gpis; int gpos; int protocol; } MODEL; /* Fixme #1: number of gpo's should be verified */ /* Fixme #2: protocol should be verified */ static MODEL Models[] = { {0x01, "LCD0821", 2, 8, 0, 1, 1}, {0x03, "LCD2021", 2, 20, 0, 1, 1}, {0x04, "LCD1641", 4, 16, 0, 1, 1}, {0x05, "LCD2041", 4, 20, 0, 1, 1}, {0x06, "LCD4021", 2, 40, 0, 1, 1}, {0x07, "LCD4041", 4, 40, 0, 1, 1}, {0x08, "LK202-25", 2, 20, 8, 8, 2}, {0x09, "LK204-25", 4, 20, 8, 8, 2}, {0x0a, "LK404-55", 4, 40, 8, 8, 2}, {0x0b, "VFD2021", 2, 20, 0, 1, 1}, {0x0c, "VFD2041", 4, 20, 0, 1, 1}, {0x0d, "VFD4021", 2, 40, 0, 1, 1}, {0x0e, "VK202-25", 2, 20, 0, 1, 1}, {0x0f, "VK204-25", 4, 20, 0, 1, 1}, {0x10, "GLC12232", -1, -1, 0, 1, 1}, {0x13, "GLC24064", -1, -1, 0, 1, 1}, {0x15, "GLK24064-25", -1, -1, 0, 1, 1}, {0x22, "GLK12232-25", -1, -1, 0, 1, 1}, {0x31, "LK404-AT", 4, 40, 8, 8, 2}, {0x32, "VFD1621", 2, 16, 0, 1, 1}, {0x33, "LK402-12", 2, 40, 8, 8, 2}, {0x34, "LK162-12", 2, 16, 8, 8, 2}, {0x35, "LK204-25PC", 4, 20, 8, 8, 2}, {0x36, "LK202-24-USB", 2, 20, 8, 8, 2}, {0x38, "LK204-24-USB", 4, 20, 8, 8, 2}, {0x39, "VK204-24-USB", 4, 20, 8, 8, 2}, {0xff, "Unknown", -1, -1, 0, 0, 0} }; /****************************************/ /*** hardware dependant functions ***/ /****************************************/ static void drv_MO_clear(void) { switch (Protocol) { case 1: drv_generic_serial_write("\014", 1); /* Clear Screen */ break; case 2: drv_generic_serial_write("\376\130", 2); /* Clear Screen */ break; } } static void drv_MO_write(const int row, const int col, const char *data, const int len) { char cmd[5] = "\376Gyx"; cmd[2] = (char) col + 1; cmd[3] = (char) row + 1; drv_generic_serial_write(cmd, 4); drv_generic_serial_write(data, len); } static void drv_MO_defchar(const int ascii, const unsigned char *matrix) { int i; char cmd[11] = "\376N"; cmd[2] = (char) ascii; for (i = 0; i < 8; i++) { cmd[i + 3] = matrix[i] & 0x1f; } drv_generic_serial_write(cmd, 11); } static int drv_MO_contrast(int contrast) { static unsigned char Contrast = 0; char cmd[3] = "\376Pn"; /* -1 is used to query the current contrast */ if (contrast == -1) return Contrast; if (contrast < 0) contrast = 0; if (contrast > 255) contrast = 255; Contrast = contrast; cmd[2] = Contrast; drv_generic_serial_write(cmd, 3); return Contrast; } static int drv_MO_backlight(int backlight) { static unsigned char Backlight = 0; char cmd[3] = "\376Bn"; /* -1 is used to query the current backlight */ if (backlight == -1) return Backlight; if (backlight < 0) backlight = 0; if (backlight > 255) backlight = 255; Backlight = backlight; if (backlight <= 0) { /* backlight off */ drv_generic_serial_write("\376F", 2); } else { /* backlight on for n minutes */ cmd[2] = Backlight; drv_generic_serial_write(cmd, 3); } return Backlight; } static int drv_MO_GPI(const int num) { static int GPI[8] = { -1, -1, -1, -1, -1, -1, -1, -1 }; static time_t T[8], now; if (num < 0 || num > 7) { return 0; } /* read RPM every two seconds */ if (time(&now) - T[num] >= 2) { char cmd[3]; unsigned char ans[7]; T[num] = now; cmd[0] = '\376'; cmd[1] = '\301'; cmd[2] = (char) num + 1; drv_generic_serial_write(cmd, 3); usleep(100000); if (drv_generic_serial_read((char *) ans, 7) == 7) { if (ans[0] == 0x23 && ans[1] == 0x2a && ans[2] == 0x03 && ans[3] == 0x52 && ans[4] == num + 1) { GPI[num] = 18750000 / (256 * ans[5] + ans[6]); } else { error("%s: strange answer %02x %02x %02x %02x %02x %02x %02x", Name, ans[0], ans[1], ans[2], ans[3], ans[4], ans[5], ans[6]); } } } return GPI[num]; } static int drv_MO_GPO(const int num, const int val) { int v = 0; char cmd[4]; switch (Protocol) { case 1: if (num == 0) { if (val > 0) { v = 1; drv_generic_serial_write("\376W", 2); /* GPO on */ } else { v = 0; drv_generic_serial_write("\376V", 2); /* GPO off */ } } break; case 2: if (val <= 0) { v = 0; cmd[0] = '\376'; cmd[1] = 'V'; /* GPO off */ cmd[2] = (char) num + 1; drv_generic_serial_write(cmd, 3); } else if (val >= 255) { v = 255; cmd[0] = '\376'; cmd[1] = 'W'; /* GPO on */ cmd[2] = (char) num + 1; drv_generic_serial_write(cmd, 3); } else { v = val; cmd[0] = '\376'; cmd[1] = '\300'; /* PWM control */ cmd[2] = (char) num + 1; cmd[3] = (char) v; drv_generic_serial_write(cmd, 4); } break; } return v; } static int drv_MO_start(const char *section, const int quiet) { int i; char *model; char buffer[256]; model = cfg_get(section, "Model", NULL); if (model != NULL && *model != '\0') { for (i = 0; Models[i].type != 0xff; i++) { if (strcasecmp(Models[i].name, model) == 0) break; } if (Models[i].type == 0xff) { error("%s: %s.Model '%s' is unknown from %s", Name, section, model, cfg_source()); return -1; } Model = i; info("%s: using model '%s'", Name, Models[Model].name); } else { info("%s: no '%s.Model' entry from %s, auto-dedecting", Name, section, cfg_source()); Model = -1; } if (drv_generic_serial_open(section, Name, 0) < 0) return -1; if (Model == -1 || Models[Model].protocol > 1) { /* read module type */ drv_generic_serial_write("\3767", 2); usleep(1000); if (drv_generic_serial_read(buffer, 1) == 1) { for (i = 0; Models[i].type != 0xff; i++) { if (Models[i].type == (int) *buffer) break; } info("%s: display reports model '%s' (type 0x%02x)", Name, Models[i].name, Models[i].type); /* auto-dedection */ if (Model == -1) Model = i; /* auto-dedection matches specified model? */ if (Models[i].type != 0xff && Model != i) { error("%s: %s.Model '%s' from %s does not match dedected Model '%s'", Name, section, model, cfg_source(), Models[i].name); return -1; } } else { info("%s: display detection failed.", Name); } } /* initialize global variables */ DROWS = Models[Model].rows; DCOLS = Models[Model].cols; GPIS = Models[Model].gpis; GPOS = Models[Model].gpos; Protocol = Models[Model].protocol; if (Protocol > 1) { /* read serial number */ drv_generic_serial_write("\3765", 2); usleep(100000); if (drv_generic_serial_read(buffer, 2) == 2) { info("%s: display reports serial number 0x%x", Name, *(short *) buffer); } /* read version number */ drv_generic_serial_write("\3766", 2); usleep(100000); if (drv_generic_serial_read(buffer, 1) == 1) { info("%s: display reports firmware version 0x%x", Name, *buffer); } } drv_MO_clear(); drv_generic_serial_write("\376B", 3); /* backlight on */ drv_generic_serial_write("\376K", 2); /* cursor off */ drv_generic_serial_write("\376T", 2); /* blink off */ drv_generic_serial_write("\376D", 2); /* line wrapping off */ drv_generic_serial_write("\376R", 2); /* auto scroll off */ /* set contrast */ if (cfg_number(section, "Contrast", 0, 0, 255, &i) > 0) { drv_MO_contrast(i); } /* set backlight */ if (cfg_number(section, "Backlight", 0, 0, 255, &i) > 0) { drv_MO_backlight(i); } if (!quiet) { if (drv_generic_text_greet(Models[Model].name, "MatrixOrbital")) { sleep(3); drv_MO_clear(); } } return 0; } /****************************************/ /*** plugins ***/ /****************************************/ static void plugin_contrast(RESULT * result, const int argc, RESULT * argv[]) { double contrast; switch (argc) { case 0: contrast = drv_MO_contrast(-1); SetResult(&result, R_NUMBER, &contrast); break; case 1: contrast = drv_MO_contrast(R2N(argv[0])); SetResult(&result, R_NUMBER, &contrast); break; default: error("%s::contrast(): wrong number of parameters", Name); SetResult(&result, R_STRING, ""); } } static void plugin_backlight(RESULT * result, const int argc, RESULT * argv[]) { double backlight; switch (argc) { case 0: backlight = drv_MO_backlight(-1); SetResult(&result, R_NUMBER, &backlight); break; case 1: backlight = drv_MO_backlight(R2N(argv[0])); SetResult(&result, R_NUMBER, &backlight); break; default: error("%s::backlight(): wrong number of parameters", Name); SetResult(&result, R_STRING, ""); } } /****************************************/ /*** widget callbacks ***/ /****************************************/ /* using drv_generic_text_draw(W) */ /* using drv_generic_text_icon_draw(W) */ /* using drv_generic_text_bar_draw(W) */ /* using drv_generic_gpio_draw(W) */ /****************************************/ /*** exported functions ***/ /****************************************/ /* list models */ int drv_MO_list(void) { int i; for (i = 0; Models[i].type != 0xff; i++) { printf("%s ", Models[i].name); } return 0; } /* initialize driver & display */ int drv_MO_init(const char *section, const int quiet) { WIDGET_CLASS wc; int ret; int asc255bug; info("%s: %s", Name, "$Rev$"); /* display preferences */ XRES = 5; /* pixel width of one char */ YRES = 8; /* pixel height of one char */ CHARS = 8; /* number of user-defineable characters */ CHAR0 = 0; /* ASCII of first user-defineable char */ GOTO_COST = 4; /* number of bytes a goto command requires */ /* real worker functions */ drv_generic_text_real_write = drv_MO_write; drv_generic_text_real_defchar = drv_MO_defchar; drv_generic_gpio_real_get = drv_MO_GPI; drv_generic_gpio_real_set = drv_MO_GPO; /* start display */ if ((ret = drv_MO_start(section, quiet)) != 0) return ret; /* initialize generic text driver */ if ((ret = drv_generic_text_init(section, Name)) != 0) return ret; /* initialize generic icon driver */ if ((ret = drv_generic_text_icon_init()) != 0) return ret; /* initialize generic bar driver */ if ((ret = drv_generic_text_bar_init(0)) != 0) return ret; /* add fixed chars to the bar driver */ /* most displays have a full block on ascii 255, but some have kind of */ /* an 'inverted P'. If you specify 'asc255bug 1 in the config, this */ /* char will not be used, but rendered by the bar driver */ cfg_number(section, "asc255bug", 0, 0, 1, &asc255bug); drv_generic_text_bar_add_segment(0, 0, 255, 32); /* ASCII 32 = blank */ if (!asc255bug) drv_generic_text_bar_add_segment(255, 255, 255, 255); /* ASCII 255 = block */ /* initialize generic GPIO driver */ if ((ret = drv_generic_gpio_init(section, Name)) != 0) return ret; /* register text widget */ wc = Widget_Text; wc.draw = drv_generic_text_draw; widget_register(&wc); /* register icon widget */ wc = Widget_Icon; wc.draw = drv_generic_text_icon_draw; widget_register(&wc); /* register bar widget */ wc = Widget_Bar; wc.draw = drv_generic_text_bar_draw; widget_register(&wc); /* register plugins */ AddFunction("LCD::contrast", -1, plugin_contrast); AddFunction("LCD::backlight", -1, plugin_backlight); return 0; } /* close driver & display */ int drv_MO_quit(const int quiet) { info("%s: shutting down display.", Name); drv_generic_text_quit(); drv_generic_gpio_quit(); /* clear display */ drv_MO_clear(); /* say goodbye... */ if (!quiet) { drv_generic_text_greet("goodbye!", NULL); } drv_generic_serial_close(); return (0); } DRIVER drv_MatrixOrbital = { .name = Name, .list = drv_MO_list, .init = drv_MO_init, .quit = drv_MO_quit, };