diff --git a/drivers/lcd/Kconfig b/drivers/lcd/Kconfig index cfbbdd89469..666d7e71205 100644 --- a/drivers/lcd/Kconfig +++ b/drivers/lcd/Kconfig @@ -330,6 +330,47 @@ config SSD1306_FREQUENCY endif +config LCD_ST7565 + bool "ST7565 LCD Display Module" + default n + ---help--- + LCD Display Module, ST7565, Univision Technology Inc. + + Required LCD driver settings: + LCD_MAXCONTRAST should be 255, but any value >0 and <=255 will be accepted. + +if LCD_ST7565 + +choice + prompt "LCD Display Module initialization sequence" + default NHD_C12864KGZ + +config NHD_C12864KGZ + bool "like NHD C12864KGZ" + +endchoice + +config ST7565_NINTERFACES + int "Number of ST7565 Devices" + default 1 + ---help--- + Specifies the number of physical ST7565 devices that will be + supported. NOTE: At present, this must be undefined or defined to be 1. + +config ST7565_XRES + int "ST7565 X Resolution" + default 128 + ---help--- + Specifies the X resolution of the LCD. + +config ST7565_YRES + int "ST7565 Y Resolution" + default 64 + ---help--- + Specifies the Y resolution of the LCD. + +endif # LCD_ST7565 + config LCD_ST7567 bool "ST7567 LCD Display Module" default n @@ -386,7 +427,7 @@ config ST7567_YRES ---help--- Specifies the Y resolution of the LCD. -endif +endif # LCD_ST7567 config LCD_UG2864AMBAG01 bool "UG-2864AMBAG01 OLED Display Module" diff --git a/drivers/lcd/st7565.c b/drivers/lcd/st7565.c new file mode 100644 index 00000000000..fc1bad7732a --- /dev/null +++ b/drivers/lcd/st7565.c @@ -0,0 +1,1057 @@ +/************************************************************************************** + * drivers/lcd/st7565.c + * + * Definitions for the ST7565 128x64 Dot Matrix LCD Driver with C + * + * Copyright (C) 2014 Pierre-noel Bouteville. All rights reserved. + * Author: Pierre-noel Boutevlle + * + * Based on drivers/lcd/st7567.c + * Copyright (C) 2013 Zilogic Systems. All rights reserved. + * Author: Manikandan + * + * Based on drivers/lcd/ug-9664hswag01.c + * + * Copyright (C) 2011 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * Reference: "Product Specification, OEL Display Module, ST7567", Univision + * Technology Inc., SAS1-6020-B, January 3, 2008. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + **************************************************************************************/ + +/************************************************************************************** + * Included Files + **************************************************************************************/ + +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "st7565.h" + +/************************************************************************************** + * Pre-processor Definitions + **************************************************************************************/ + +/* Configuration **********************************************************************/ + +/* ST7565 Configuration Settings: + * + * CONFIG_ST7565_NINTERFACES - Specifies the number of physical + * ST7565 devices that will be supported. NOTE: At present, this + * must be undefined or defined to be 1. + * CONFIG_LCD_ST7565DEBUG - Enable detailed ST7565 debst7565 output + * (CONFIG_DEBUG and CONFIG_VERBOSE must also be enabled). + * + * Required LCD driver settings: + * CONFIG_LCD_ST7565 - Enable ST7565 support + * CONFIG_LCD_MAXCONTRAST should be 255, but any value >0 and <=255 will be accepted. + * + */ + +/* Verify that all configuration requirements have been met */ + +/* CONFIG_ST7565_NINTERFACES determines the number of physical interfaces + * that will be supported. + */ + +#ifndef CONFIG_ST7565_NINTERFACES +# define CONFIG_ST7565_NINTERFACES 1 +#endif + +#if CONFIG_ST7565_NINTERFACES != 1 +# warning "Only a single ST7565 interface is supported" +# undef CONFIG_ST7565_NINTERFACES +# define CONFIG_ST7565_NINTERFACES 1 +#endif + +/* Verbose debst7565 must also be enabled to use the extra OLED debst7565 */ + +#ifndef CONFIG_DEBUG +# undef CONFIG_DEBUG_VERBOSE +# undef CONFIG_DEBUG_GRAPHICS +#endif + +#ifndef CONFIG_DEBUG_VERBOSE +# undef CONFIG_LCD_ST7565DEBUG +#endif + +/* Check contrast selection */ + +#ifndef CONFIG_LCD_MAXCONTRAST +# define CONFIG_LCD_MAXCONTRAST 255 +#endif + +#if CONFIG_LCD_MAXCONTRAST <= 0 || CONFIG_LCD_MAXCONTRAST > 255 +# error "CONFIG_LCD_MAXCONTRAST exceeds supported maximum" +#endif + +#if CONFIG_LCD_MAXCONTRAST < 255 +# warning "Optimal setting of CONFIG_LCD_MAXCONTRAST is 255" +#endif + +/* Check power setting */ + +/* Color is 1bpp monochrome with leftmost column contained in bits 0 */ + +#ifdef CONFIG_NX_DISABLE_1BPP +# warning "1 bit-per-pixel support needed" +#endif + +/* Color Properties *******************************************************************/ + +/* The ST7565 display controller can handle a resolution of 128x64. + */ + +/* Display Resolution */ + +#ifdef CONFIG_ST7565_XRES +# define ST7565_XRES CONFIG_ST7565_XRES +#else +# define ST7565_XRES 128 +#endif + +#ifdef CONFIG_ST7565_YRES +# define ST7565_YRES CONFIG_ST7565_YRES +#else +# define ST7565_YRES 64 +#endif + +/* Color depth and format */ + +#define ST7565_BPP 1 +#define ST7565_COLORFMT FB_FMT_Y1 + +/* Bytes per logical row andactual device row */ + +#define ST7565_XSTRIDE (ST7565_XRES >> 3) /* Pixels arrange "horizontally + * for user" */ +#define ST7565_YSTRIDE (ST7565_YRES >> 3) /* But actual device + * arrangement is "vertical" */ + +/* The size of the shadow frame buffer */ + +#define ST7565_FBSIZE (ST7565_XRES * ST7565_YSTRIDE) + +/* Bit helpers */ + +#define LS_BIT (1 << 0) +#define MS_BIT (1 << 7) + +/* Debst7565 ******************************************************************************/ + +#ifdef CONFIG_LCD_ST7565DEBUG +# define st7565dbg(format, ...) vdbg(format, ##__VA_ARGS__) +#else +# define st7565dbg(x...) +#endif + +/************************************************************************************** + * Private Type Definition + **************************************************************************************/ + +/* This structure describes the state of this driver */ + +struct st7565_dev_s +{ + /* Publicly visible device structure */ + + struct lcd_dev_s dev; + + /* Private LCD-specific information follows */ + + FAR struct st7565_lcd_s *lcd; + uint8_t contrast; + uint8_t power_level; + + /* TODO implement READ mode, possible in 8080bus interface */ + + /* The ST7565 does not support reading from the display memory in SPI mode. + * Since there is 1 BPP and access is byte-by-byte, it is necessary to keep + * a shadow copy of the framebuffer memory. */ + + uint8_t fb[ST7565_FBSIZE]; +}; + +/************************************************************************************** + * Private Function Prototypes + **************************************************************************************/ + +/* Drivers helpers */ + +static inline void st7565_reset(FAR struct st7565_dev_s *priv, bool on); + +static inline void st7565_select(FAR struct st7565_dev_s *priv); +static inline void st7565_deselect(FAR struct st7565_dev_s *priv); + +static inline void st7565_cmddata(FAR struct st7565_dev_s *priv, bool cmd); +static inline int st7565_send_one_data(FAR struct st7565_dev_s *priv, + uint8_t data); +static inline int st7565_send_data_buf(FAR struct st7565_dev_s *priv, + FAR const uint8_t * buf, int size); +static inline int st7565_backlight(FAR struct st7565_dev_s *priv, int level); + +/* LCD Data Transfer Methods */ + +static int st7565_putrun(fb_coord_t row, fb_coord_t col, + FAR const uint8_t * buffer, size_t npixels); +static int st7565_getrun(fb_coord_t row, fb_coord_t col, FAR uint8_t * buffer, + size_t npixels); + +/* LCD Configuration */ + +static int st7565_getvideoinfo(FAR struct lcd_dev_s *dev, + FAR struct fb_videoinfo_s *vinfo); +static int st7565_getplaneinfo(FAR struct lcd_dev_s *dev, unsigned int planeno, + FAR struct lcd_planeinfo_s *pinfo); + +/* LCD RGB Mapping */ + +#ifdef CONFIG_FB_CMAP +# error "RGB color mapping not supported by this driver" +#endif + +/* Cursor Controls */ + +#ifdef CONFIG_FB_HWCURSOR +# error "Cursor control not supported by this driver" +#endif + +/* LCD Specific Controls */ + +static int st7565_getpower(struct lcd_dev_s *dev); +static int st7565_setpower(struct lcd_dev_s *dev, int power); +static int st7565_getcontrast(struct lcd_dev_s *dev); +static int st7565_setcontrast(struct lcd_dev_s *dev, unsigned int contrast); + +/* Initialization */ + +static inline void up_clear(FAR struct st7565_dev_s *priv); + +/************************************************************************************** + * Private Data + **************************************************************************************/ + +/* This is working memory allocated by the LCD driver for each LCD device + * and for each color plane. This memory will hold one raster line of data. + * The size of the allocated run buffer must therefore be at least + * (bpp * xres / 8). Actual alignment of the buffer must conform to the + * bitwidth of the underlying pixel type. + * + * If there are multiple planes, they may share the same working buffer + * because different planes will not be operate on concurrently. However, + * if there are multiple LCD devices, they must each have unique run buffers. + */ + +static uint8_t g_runbuffer[ST7565_XSTRIDE + 1]; + +/* This structure describes the overall LCD video controller */ + +static const struct fb_videoinfo_s g_videoinfo = +{ + .fmt = ST7565_COLORFMT, /* Color format: RGB16-565: RRRR RGGG GGGB BBBB */ + .xres = ST7565_XRES, /* Horizontal resolution in pixel columns */ + .yres = ST7565_YRES, /* Vertical resolution in pixel rows */ + .nplanes = 1, /* Number of color planes supported */ +}; + +/* This is the standard, NuttX Plane information object */ + +static const struct lcd_planeinfo_s g_planeinfo = +{ + .putrun = st7565_putrun, /* Put a run into LCD memory */ + .getrun = st7565_getrun, /* Get a run from LCD memory */ + .buffer = (uint8_t *) g_runbuffer, /* Run scratch buffer */ + .bpp = ST7565_BPP, /* Bits-per-pixel */ +}; + +/* This is the standard, NuttX LCD driver object */ + +static struct st7565_dev_s g_st7565dev = +{ + .dev = + { + /* LCD Configuration */ + + .getvideoinfo = st7565_getvideoinfo, + .getplaneinfo = st7565_getplaneinfo, + + /* LCD RGB Mapping -- Not supported */ + /* Cursor Controls -- Not supported */ + + /* LCD Specific Controls */ + + .getpower = st7565_getpower, + .setpower = st7565_setpower, + .getcontrast = st7565_getcontrast, + .setcontrast = st7565_setcontrast, + }, +}; + +/************************************************************************************** + * Private Functions + **************************************************************************************/ + +/************************************************************************************** + * Name: st7565_reset + * + * Description: + * Enable/Disable reset pin of LCD the device. + * + * priv - A reference to the driver specific structure + * + **************************************************************************************/ + +static inline void st7565_reset(FAR struct st7565_dev_s *priv, bool on) +{ + if (priv->lcd->reset != NULL) + { + priv->lcd->reset(priv->lcd, on); + } +} + +/************************************************************************************** + * Name: st7565_select + * + * Description: + * Select the device (as necessary) before performing any operations. + * + * priv - A reference to the driver specific structure + * + **************************************************************************************/ + +static inline void st7565_select(FAR struct st7565_dev_s *priv) +{ + priv->lcd->select(priv->lcd); +} + +/************************************************************************************** + * Name: st7565_deselect + * + * Description: + * Deselect the device (as necessary). + * + * priv - A reference to the driver specific structure + * + **************************************************************************************/ + +static inline void st7565_deselect(FAR struct st7565_dev_s *priv) +{ + priv->lcd->deselect(priv->lcd); +} + +/************************************************************************************** + * Name: st7565_cmddata + * + * Description: + * Select command (A0 = 0) or data (A0 = 1) mode. + * + * priv - A reference to the driver specific structure. + * cmd - If true command mode will be selected. + * + **************************************************************************************/ + +static inline void st7565_cmddata(FAR struct st7565_dev_s *priv, bool cmd) +{ + priv->lcd->cmddata(priv->lcd, cmd); +} + +/************************************************************************************** + * Name: st7565_send_one_data + * + * Description: + * Send one data to the LCD driver (A0 = 1). + * + * priv - A reference to the driver specific structure. + * data - Byte to send as data to LCD driver. + * + **************************************************************************************/ + +static inline int st7565_send_one_data(FAR struct st7565_dev_s *priv, + uint8_t data) +{ + return priv->lcd->senddata(priv->lcd, &data, 1); +} + +/************************************************************************************** + * Name: st7565_send_data_buf + * + * Description: + * Send a data buffer to the LCD driver (A0 = 1). + * + * priv - A reference to the driver specific structure. + * buf - Buffer sent as data to LCD driver. + * size - Size of buffer in bytes. + * + **************************************************************************************/ + +static inline int st7565_send_data_buf(FAR struct st7565_dev_s *priv, + FAR const uint8_t * buf, int size) +{ + return priv->lcd->senddata(priv->lcd, buf, size); +} + +/************************************************************************************** + * Name: st7565_backlight + * + * Description: + * Change backlight level of display. + * + * priv - A reference to the driver specific structure. + * level - Set backlight pwm from 0 CONFIG_LCD_MAXPOWER-1. + * + **************************************************************************************/ + +static inline int st7565_backlight(FAR struct st7565_dev_s *priv, int level) +{ + return priv->lcd->backlight(priv->lcd, level); +} + +/************************************************************************************** + * Name: st7565_putrun + * + * Description: + * This method can be used to write a partial raster line to the LCD: + * + * row - Starting row to write to (range: 0 <= row < yres) + * col - Starting column to write to (range: 0 <= col <= xres-npixels) + * buffer - The buffer containing the run to be written to the LCD + * npixels - The number of pixels to write to the LCD + * (range: 0 < npixels <= xres-col) + * + **************************************************************************************/ + +static int st7565_putrun(fb_coord_t row, fb_coord_t col, + FAR const uint8_t * buffer, size_t npixels) +{ + /* Because of this line of code, we will only be able to support a single + * ST7565 device. + */ + + FAR struct st7565_dev_s *priv = &g_st7565dev; + FAR uint8_t *fbptr; + FAR uint8_t *ptr; + uint8_t fbmask; + uint8_t page; + uint8_t usrmask; + uint8_t i; + int pixlen; + + gvdbg("row: %d col: %d npixels: %d\n", row, col, npixels); + DEBUGASSERT(buffer); + + /* Clip the run to the display */ + + pixlen = npixels; + if ((unsigned int)col + (unsigned int)pixlen > (unsigned int)ST7565_XRES) + { + pixlen = (int)ST7565_XRES - (int)col; + } + + /* Verify that some portion of the run remains on the display */ + + if (pixlen <= 0 || row > ST7565_YRES) + { + return OK; + } + + /* Get the page number. The range of 64 lines is divided up into eight pages + * of 8 lines each. + */ + + page = row >> 3; + + /* Update the shadow frame buffer memory. First determine the pixel position + * in the frame buffer memory. Pixels are organized like this: + * + * --------+---+---+---+---+-...-+-----+ + * Segment | 0 | 1 | 2 | 3 | ... | 131 | + * --------+---+---+---+---+-...-+-----+ + * Bit 0 | | X | | | | | + * Bit 1 | | X | | | | | + * Bit 2 | | X | | | | | + * Bit 3 | | X | | | | | + * Bit 4 | | X | | | | | + * Bit 5 | | X | | | | | + * Bit 6 | | X | | | | | + * Bit 7 | | X | | | | | + * --------+---+---+---+---+-...-+-----+ + * + * So, in order to draw a white, horizontal line, at row 45. we would have + * to modify all of the bytes in* page 45/8 = 5. We would have to set bit + * 45%8 = 5 in every byte in the page. + */ + + fbmask = 1 << (row & 7); + fbptr = &priv->fb[page * ST7565_XRES + col]; + ptr = fbptr; +#ifdef CONFIG_NX_PACKEDMSFIRST + usrmask = MS_BIT; +#else + usrmask = LS_BIT; +#endif + + for (i = 0; i < pixlen; i++) + { + /* Set or clear the corresponding bit */ + + if ((*buffer & usrmask) != 0) + { + *ptr++ |= fbmask; + } + else + { + *ptr++ &= ~fbmask; + } + + /* Inc/Decrement to the next source pixel */ + +#ifdef CONFIG_NX_PACKEDMSFIRST + if (usrmask == LS_BIT) + { + buffer++; + usrmask = MS_BIT; + } + else + { + usrmask >>= 1; + } +#else + if (usrmask == MS_BIT) + { + buffer++; + usrmask = LS_BIT; + } + else + { + usrmask <<= 1; + } +#endif + } + + /* Select and lock the device */ + + st7565_select(priv); + + /* Select command transfer */ + + st7565_cmddata(priv, true); + + /* Set the starting position for the run */ + + (void)st7565_send_one_data(priv, ST7565_SETPAGESTART + page); + (void)st7565_send_one_data(priv, ST7565_SETCOLL + (col & 0x0f)); + (void)st7565_send_one_data(priv, ST7565_SETCOLH + (col >> 4)); + + /* Select data transfer */ + + st7565_cmddata(priv, false); + + /* Then transfer all of the data */ + + (void)st7565_send_data_buf(priv, fbptr, pixlen); + + /* Unlock and de-select the device */ + + st7565_deselect(priv); + + return OK; +} + +/************************************************************************************** + * Name: st7565_getrun + * + * TODO implement read function that possible in 8080bus + * + * Description: + * This method can be used to read a partial raster line from the LCD: + * + * row - Starting row to read from (range: 0 <= row < yres) + * col - Starting column to read read (range: 0 <= col <= xres-npixels) + * buffer - The buffer in which to return the run read from the LCD + * npixels - The number of pixels to read from the LCD + * (range: 0 < npixels <= xres-col) + * + **************************************************************************************/ + +static int st7565_getrun(fb_coord_t row, fb_coord_t col, FAR uint8_t * buffer, + size_t npixels) +{ + /* Because of this line of code, we will only be able to support a single + * ST7565 device. + */ + + FAR struct st7565_dev_s *priv = &g_st7565dev; + FAR uint8_t *fbptr; + uint8_t page; + uint8_t fbmask; + uint8_t usrmask; + uint8_t i; + int pixlen; + + gvdbg("row: %d col: %d npixels: %d\n", row, col, npixels); + DEBUGASSERT(buffer); + + /* Clip the run to the display */ + + pixlen = npixels; + if ((unsigned int)col + (unsigned int)pixlen > (unsigned int)ST7565_XRES) + { + pixlen = (int)ST7565_XRES - (int)col; + } + + /* Verify that some portion of the run is actually the display */ + + if (pixlen <= 0 || row > ST7565_YRES) + { + return -EINVAL; + } + + /* Then transfer the display data from the shadow frame buffer memory */ + /* Get the page number. The range of 64 lines is divided up into eight pages + * of 8 lines each. + */ + + page = row >> 3; + + /* Update the shadow frame buffer memory. First determine the pixel position + * in the frame buffer memory. Pixels are organized like this: + * + * --------+---+---+---+---+-...-+-----+ + * Segment | 0 | 1 | 2 | 3 | ... | 131 | + * --------+---+---+---+---+-...-+-----+ + * Bit 0 | | X | | | | | + * Bit 1 | | X | | | | | + * Bit 2 | | X | | | | | + * Bit 3 | | X | | | | | + * Bit 4 | | X | | | | | + * Bit 5 | | X | | | | | + * Bit 6 | | X | | | | | + * Bit 7 | | X | | | | | + * --------+---+---+---+---+-...-+-----+ + * + * So, in order to draw a white, horizontal line, at row 45. we would have + * to modify all of the bytes in page 45/8 = 5. We would have to set bit + * 45%8 = 5 in every byte in the page. + */ + + fbmask = 1 << (row & 7); + fbptr = &priv->fb[page * ST7565_XRES + col]; +#ifdef CONFIG_NX_PACKEDMSFIRST + usrmask = MS_BIT; +#else + usrmask = LS_BIT; +#endif + + *buffer = 0; + for (i = 0; i < pixlen; i++) + { + /* Set or clear the corresponding bit */ + + uint8_t byte = *fbptr++; + if ((byte & fbmask) != 0) + { + *buffer |= usrmask; + } + + /* Inc/Decrement to the next destination pixel. Hmmmm. It looks like this + * logic could write past the end of the user buffer. Revisit this! + */ + +#ifdef CONFIG_NX_PACKEDMSFIRST + if (usrmask == LS_BIT) + { + buffer++; + *buffer = 0; + usrmask = MS_BIT; + } + else + { + usrmask >>= 1; + } +#else + if (usrmask == MS_BIT) + { + buffer++; + *buffer = 0; + usrmask = LS_BIT; + } + else + { + usrmask <<= 1; + } +#endif + } + + return OK; +} + +/************************************************************************************** + * Name: st7565_getvideoinfo + * + * Description: + * Get information about the LCD video controller configuration. + * + **************************************************************************************/ + +static int st7565_getvideoinfo(FAR struct lcd_dev_s *dev, + FAR struct fb_videoinfo_s *vinfo) +{ + DEBUGASSERT(dev && vinfo); + gvdbg("fmt: %d xres: %d yres: %d nplanes: %d\n", + g_videoinfo.fmt, g_videoinfo.xres, g_videoinfo.yres, + g_videoinfo.nplanes); + memcpy(vinfo, &g_videoinfo, sizeof(struct fb_videoinfo_s)); + return OK; +} + +/************************************************************************************** + * Name: st7565_getplaneinfo + * + * Description: + * Get information about the configuration of each LCD color plane. + * + **************************************************************************************/ + +static int st7565_getplaneinfo(FAR struct lcd_dev_s *dev, unsigned int planeno, + FAR struct lcd_planeinfo_s *pinfo) +{ + DEBUGASSERT(dev && pinfo && planeno == 0); + gvdbg("planeno: %d bpp: %d\n", planeno, g_planeinfo.bpp); + memcpy(pinfo, &g_planeinfo, sizeof(struct lcd_planeinfo_s)); + return OK; +} + +/************************************************************************************** + * Name: st7565_getpower + * + * Description: + * Get the LCD panel power status (0: full off - CONFIG_LCD_MAXPOWER: full on). On + * backlit LCDs, this setting may correspond to the backlight setting. + * + **************************************************************************************/ + +static int st7565_getpower(struct lcd_dev_s *dev) +{ + struct st7565_dev_s *priv = (struct st7565_dev_s *)dev; + DEBUGASSERT(priv); + gvdbg("powered: %s\n", priv->power_level); + return priv->power_level; +} + +/************************************************************************************** + * Name: st7565_setpower + * + * Description: + * Enable/disable LCD panel power (0: full off - CONFIG_LCD_MAXPOWER: full on). On + * backlight LCDs, this setting may correspond to the backlight setting. + * + **************************************************************************************/ + +static int st7565_setpower(struct lcd_dev_s *dev, int power) +{ + struct st7565_dev_s *priv = (struct st7565_dev_s *)dev; + + DEBUGASSERT(priv && (unsigned)power <= CONFIG_LCD_MAXPOWER); + gvdbg("power: %s powered: %s\n", power, priv->power_level); + + /* Select and lock the device */ + + st7565_select(priv); + + st7565_cmddata(priv, true); + + if (power <= 0) + { + /* Turn the display off */ + + (void)st7565_send_one_data(priv, ST7565_DISPOFF); + (void)st7565_backlight(priv, 0); + priv->power_level = 0; + } + else + { + (void)st7565_send_one_data(priv, ST7565_DISPON); + (void)st7565_send_one_data(priv, ST7565_DISPRAM); + + /* Don't use value 1 of backlight to allow low power mode */ + + if (power == 1) + { + (void)st7565_backlight(priv, 0); + } + else + { + (void)st7565_backlight(priv, power); + } + + priv->power_level = 1; + } + + st7565_cmddata(priv, false); + st7565_deselect(priv); + + return OK; +} + +/************************************************************************************** + * Name: st7565_getcontrast + * + * Description: + * Get the current contrast setting (0-CONFIG_LCD_MAXCONTRAST). + * + **************************************************************************************/ + +static int st7565_getcontrast(struct lcd_dev_s *dev) +{ + struct st7565_dev_s *priv = (struct st7565_dev_s *)dev; + DEBUGASSERT(priv); + return (int)priv->contrast; +} + +/************************************************************************************** + * Name: st7565_setcontrast + * + * Description: + * Set LCD panel contrast (0-CONFIG_LCD_MAXCONTRAST). + * + **************************************************************************************/ + +static int st7565_setcontrast(struct lcd_dev_s *dev, unsigned int contrast) +{ + struct st7565_dev_s *priv = (struct st7565_dev_s *)dev; + + gvdbg("contrast: %d\n", contrast); + DEBUGASSERT(priv); + + if (contrast > 255) + { + return -EINVAL; + } + + /* Select and lock the device */ + + st7565_select(priv); + + /* Select command transfer */ + + st7565_cmddata(priv, true); + + /* Set the contrast */ + + (void)st7565_send_one_data(priv, ST7565_SETEVMODE); + (void)st7565_send_one_data(priv, ST7565_SETEVREG(contrast)); + priv->contrast = contrast; + + /* Deselect command transfer */ + + st7565_cmddata(priv, false); + + /* Unlock and de-select the device */ + + st7565_deselect(priv); + return OK; +} + +/************************************************************************************** + * Name: up_clear + * + * Description: + * Clear the display. + * + **************************************************************************************/ + +static inline void up_clear(FAR struct st7565_dev_s *priv) +{ + int page; + int i; + + /* Clear the framebuffer */ + + memset(priv->fb, 0x00, ST7565_FBSIZE); + + /* Select and lock the device */ + + st7565_select(priv); + + /* Go throw all 8 pages */ + + for (page = 0, i = 0; i < 8; i++) + { + /* Select command transfer */ + + st7565_cmddata(priv, true); + + /* Set the starting position for the run */ + + (void)st7565_send_one_data(priv, ST7565_SETPAGESTART + i); + (void)st7565_send_one_data(priv, ST7565_SETCOLL); + (void)st7565_send_one_data(priv, ST7565_SETCOLH); + + /* Select data transfer */ + + st7565_cmddata(priv, false); + + /* Then transfer all 96 columns of data */ + + (void)st7565_send_data_buf(priv, &priv->fb[page * ST7565_XRES], + ST7565_XRES); + } + + /* Unlock and de-select the device */ + + st7565_deselect(priv); +} + +/************************************************************************************** + * Public Functions + **************************************************************************************/ + +/************************************************************************************** + * Name: st7565_initialize + * + * Description: + * Initialize the ST7565 video hardware. The initial state of the + * OLED is fully initialized, display memory cleared, and the OLED ready to + * use, but with the power setting at 0 (full off == sleep mode). + * + * Input Parameters: + * + * lcd - A reference to the lcd low level driver instance. + * devno - A value in the range of 0 throw CONFIG_ST7565_NINTERFACES-1. + * This allows support for multiple OLED devices. + * + * Returned Value: + * + * On success, this function returns a reference to the LCD object + * for the specified + * OLED. NULL is returned on any failure. + * + **************************************************************************************/ + +FAR struct lcd_dev_s *st7565_initialize(FAR struct st7565_lcd_s *lcd, + unsigned int devno) +{ + /* Configure and enable LCD */ + + FAR struct st7565_dev_s *priv = &g_st7565dev; + + gvdbg("Initializing\n"); + DEBUGASSERT(lcd && devno == 0); + + /* Save the reference to the SPI device */ + + priv->lcd = lcd; + + /* Select and lock the device */ + + st7565_select(priv); + + /* Reset device */ + + st7565_reset(priv, true); + + /* it seems too long but written in NHD‐C12864KGZ DISPLAY + * INITIALIZATION... */ + + up_mdelay(150); + + st7565_reset(priv, false); + + /* it seems too long but written in NHD‐C12864KGZ DISPLAY + * INITIALIZATION... */ + + up_mdelay(150); + + /* Make sure that LCD backlight is off */ + + st7565_backlight(priv, 0); + + /* Select command transfer */ + + st7565_cmddata(priv, true); + + /* reset by command in case of st7565_reset not implemeted */ + + (void)st7565_send_one_data(priv, ST7565_EXIT_SOFTRST); + + /* Follow NHD‐C12864KGZ DISPLAY INITIALIZATION... */ + +#ifdef CONFIG_NHD_C12864KGZ + (void)st7565_send_one_data(priv, ST7565_BIAS_1_9); + (void)st7565_send_one_data(priv, ST7565_ADCNORMAL); + (void)st7565_send_one_data(priv, ST7565_SETCOMNORMAL); + (void)st7565_send_one_data(priv, ST7565_REG_RES_5_5); + (void)st7565_send_one_data(priv, ST7565_SETEVMODE); + (void)st7565_send_one_data(priv, ST7565_SETEVREG(15)); + (void)st7565_send_one_data(priv, ST7565_POWERCTRL_INT); + (void)st7565_send_one_data(priv, ST7565_SETSTARTLINE); +#else +# error "No initialization sequence selected" +#endif + +#if 0 + (void)st7565_send_one_data(priv, ST7565_DISPON); + (void)st7565_send_one_data(priv, ST7565_SETCOMREVERSE); + (void)st7565_send_one_data(priv, ST7565_REG_RES_RR1); + (void)st7565_send_one_data(priv, ST7565_SETEV); + (void)st7565_send_one_data(priv, 0x32); + (void)st7565_send_one_data(priv, ST7565_POWERCTRL); + (void)st7565_send_one_data(priv, ST7565_SETSTARTLINE); + (void)st7565_send_one_data(priv, ST7565_SETPAGESTART); + (void)st7565_send_one_data(priv, ST7565_SETCOLH); + (void)st7565_send_one_data(priv, ST7565_SETCOLL); + (void)st7565_send_one_data(priv, ST7565_DISPON); + (void)st7565_send_one_data(priv, ST7565_DISPRAM); +#endif + + /* Let go of the SPI lock and de-select the device */ + + st7565_deselect(priv); + + up_mdelay(10); + + /* Clear the framebuffer */ + + up_clear(priv); + + return &priv->dev; +} diff --git a/drivers/lcd/st7565.h b/drivers/lcd/st7565.h new file mode 100644 index 00000000000..0855f5e8ecc --- /dev/null +++ b/drivers/lcd/st7565.h @@ -0,0 +1,144 @@ +/************************************************************************************** + * drivers/lcd/st7565.h + * + * Definitions for the ST7565 128x64 Dot Matrix LCD + * Driver with C + * + * Copyright (C) 2014 Pierre-noel Bouteville. All rights reserved. + * Author: Pierre-noel Boutevlle + * + * Based on drivers/lcd/st7567.h + * Copyright (C) 2013 Zilogic Systems. All rights reserved. + * Author: Manikandan + * + * Based on drivers/lcd/ssd1305.h + * + * Copyright (C) 2010 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * References: SSD1305.pdf, "Solomon Systech SSD1305 136x64 Dot Matrix OLED/PLED + * Segment/Common Driver with Controller," Solomon Systech Limited, + * http://www.solomon-systech.com, May, 2008. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + **************************************************************************************/ + +#ifndef __DRIVERS_LCD_ST7565_H +#define __DRIVERS_LCD_ST7565_H + +/************************************************************************************** + * Included Files + **************************************************************************************/ + +/************************************************************************************** + * Pre-processor Definitions + **************************************************************************************/ + +/* Fundamental Commands ***************************************************************/ + +#define ST7565_DISPOFF 0xae /* 0xae: Display OFF (sleep mode) */ +#define ST7565_DISPON 0xaf /* 0xaf: Display ON in normal mode */ + +#define ST7565_SETSTARTLINE 0x40 /* 0x40-7f: Set display start line */ +# define ST7565_STARTLINE_MASK 0x3f + +#define ST7565_SETPAGESTART 0xb0 /* 0xb0-b7: Set page start address */ +# define ST7565_PAGESTART_MASK 0x0f + +#define ST7565_SETCOLL 0x00 /* 0x00-0x0f: Set lower column address */ +# define ST7565_COLL_MASK 0x0f +#define ST7565_SETCOLH 0x10 /* 0x10-0x1f: Set higher column address */ +# define ST7565_COLH_MASK 0x0f + +#define ST7565_ADCNORMAL 0xa0 /* 0xa6: ADC Normal */ +#define ST7565_ADCINVERSE 0xa1 /* 0xa7: ADC Inverse */ + +#define ST7565_DISPNORMAL 0xa6 /* 0xa6: Normal display */ +#define ST7565_DISPINVERSE 0xa7 /* 0xa7: Inverse display */ + +#define ST7565_DISPRAM 0xa4 /* 0xa4: Resume to RAM content display */ +#define ST7565_DISPENTIRE 0xa5 /* 0xa5: Entire display ON */ + +#define ST7565_BIAS_1_9 0xa2 /* 0xa2: Select BIAS setting 1/9 */ +#define ST7565_BIAS_1_7 0xa3 /* 0xa3: Select BIAS setting 1/7 */ + +#define ST7565_ENTER_RMWMODE 0xe0 /* 0xe0: Enter the Read Modify Write mode */ +#define ST7565_EXIT_RMWMODE 0xee /* 0xee: Leave the Read Modify Write mode */ +#define ST7565_EXIT_SOFTRST 0xe2 /* 0xe2: Software RESET */ + +#define ST7565_SETCOMNORMAL 0xc0 /* 0xc0: Set COM output direction, normal mode */ +#define ST7565_SETCOMREVERSE 0xc8 /* 0xc8: Set COM output direction, reverse mode */ + +#define ST7565_POWERCTRL_EXT 0x28 /* 0x28: Only the external power supply is used */ +#define ST7565_POWERCTRL_VF 0x29 /* 0x29: Only the V/F circuit is used */ +#define ST7565_POWERCTRL_VR 0x2b /* 0x2b: Only the voltage regulator circuit and the + * voltage follower circuit are used + */ +#define ST7565_POWERCTRL_INT 0x2f /* 0x2f: Only the internal power supply is used */ + +/* Regulation Resistior ratio V0 = (1+Rb/Ra)*Vev */ + +#define ST7565_REG_RES_3_0 0x20 /* (Ra/Rb = 3.0) */ +#define ST7565_REG_RES_3_5 0x21 /* (Ra/Rb = 5.5) */ +#define ST7565_REG_RES_4_0 0x22 /* (Ra/Rb = 4.0) */ +#define ST7565_REG_RES_4_5 0x23 /* (Ra/Rb = 4.5) */ +#define ST7565_REG_RES_5_0 0x24 /* (Ra/Rb = 5.0) */ +#define ST7565_REG_RES_5_5 0x25 /* (Ra/Rb = 5.5) */ +#define ST7565_REG_RES_6_0 0x26 /* (Ra/Rb = 6.0) */ +#define ST7565_REG_RES_6_5 0x27 /* (Ra/Rb = 6.5) */ + +/* Set Electronic volume mode */ + +#define ST7565_SETEVMODE 0x81 /* 0x81: Set contrast control */ + +/* Set Ev value register + * ratio Vev = (1-a/162)*Vreg, Vreg = 2.1V + */ + +#define ST7565_SETEVREG(x) (0x0 | ((x) & 0x3F)) + +/* Set booster ratio */ + +#define ST7565_MODE_NORMAL 0xac /* Set Normal Mode */ +#define ST7565_MODE_SLEEP 0xad /* Set Sleep Mode */ + +/* Set booster ratio */ + +#define ST7565_SETBOOSTER 0xf8 +#define ST7565_SETBOOSTER4X 0x00 /* x2, x3, x4 */ +#define ST7565_SETBOOSTER5X 0x01 /* x5 */ +#define ST7565_SETBOOSTER6X 0x02 /* x6 */ + +#define ST7565_NOP 0xe3 /* 0xe3: NOP Command for no operation */ + +/************************************************************************************** + * Public Data + **************************************************************************************/ + +#endif /* __DRIVERS_LCD_ST7565_H */ diff --git a/include/nuttx/lcd/st7565.h b/include/nuttx/lcd/st7565.h new file mode 100755 index 00000000000..a103f51cd70 --- /dev/null +++ b/include/nuttx/lcd/st7565.h @@ -0,0 +1,152 @@ +/**************************************************************************** + * include/nuttx/lcd/st7565.h + * + * Definitions for the ST7565 128x64 Dot Matrix LCD + * Driver with C + * + * Copyright (C) 2014 Pierre-noel Bouteville. All rights reserved. + * Author: Pierre-noel Boutevlle + * + * Based on drivers/lcd/st7567.h + * + * Copyright (C) 2013 Zilogic Systems. All rights reserved. + * Author: Manikandan + * + * Based on include/nuttx/lcd/ug-9664hswag01.h + * + * Copyright (C) 2011-2012 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + +#ifndef __INCLUDE_NUTTX_ST7565_H +#define __INCLUDE_NUTTX_ST7565_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +/* ST7565 Configuration Settings: + * + * CONFIG_ST7565_NINTERFACES - Specifies the number of physical + * ST7565 devices that will be supported. NOTE: At present, this + * must be undefined or defined to be 1. + * + * Required LCD driver settings: + * CONFIG_LCD_ST7565 - Enable ST7565 support + * CONFIG_LCD_MAXCONTRAST should be 255, but any value >0 and <=255 will be + * accepted. + */ + +/* Some important "colors" */ + +#define ST7565_Y1_BLACK 0 +#define ST7565_Y1_WHITE 1 + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +struct st7565_lcd_s +{ + /* Interface to control the st7565 like lcd driver + * + * - reset Switch reset pin of LCD (optional but as your risk). + * - select Select the device (as neccessary) before performing any + * operations. + * - deselect Deselect the device (as necessary). + * - cmddata Select command (A0 = 0) or data (A0 = 1) mode . + * - senddata Send data to the LCD driver. + * - backlight Change the backlight level of the connected display. + * In the context of the ili9341 that means change the + * backlight level of the connected LED driver. + * The implementation in detail is part of the platform + * specific sub driver. + */ + + void (*reset)(FAR struct st7565_lcd_s *lcd, bool on); + void (*select)(FAR struct st7565_lcd_s *lcd); + void (*deselect)(FAR struct st7565_lcd_s *lcd); + void (*cmddata)(FAR struct st7565_lcd_s *lcd, const uint8_t cmd); + int (*senddata)(FAR struct st7565_lcd_s *lcd, FAR const uint8_t *data, + int size); + int (*backlight)(FAR struct st7565_lcd_s *lcd, int level); + + /* MCU interface specific data following */ +}; + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +#ifdef __cplusplus +extern "C" +{ +#endif + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +/**************************************************************************** + * Name: st7565_initialize + * + * Description: + * Initialize the ST7565 video hardware. The initial state of the + * LCD is fully initialized, display memory cleared, and the LCD ready + * to use, but with the power setting at 0 (full off == sleep mode). + * + * Input Parameters: + * + * spi - A reference to the SPI driver instance. + * devno - A value in the range of 0 throw CONFIG_ST7565_NINTERFACES-1. + * This allows support for multiple LCD devices. + * + * Returned Value: + * + * On success, this function returns a reference to the LCD object for + * the specified LCD. NULL is returned on any failure. + * + ****************************************************************************/ + +FAR struct lcd_dev_s *st7565_initialize(FAR struct st7565_lcd_s *lcd, + unsigned int devno); + +#ifdef __cplusplus +} +#endif + +#endif /* __INCLUDE_NUTTX_ST7567_H */