nuttx/drivers/lcd/st7735.c

/****************************************************************************
 * drivers/lcd/st7735.c
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include <sys/types.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include <debug.h>

#include <nuttx/arch.h>
#include <nuttx/spi/spi.h>
#include <nuttx/lcd/lcd.h>
#include <nuttx/lcd/st7735.h>

#include "st7735.h"

#ifdef CONFIG_LCD_ST7735

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

/* Verify that all configuration requirements have been met */

#ifndef CONFIG_LCD_ST7735_SPIMODE
#  define CONFIG_LCD_ST7735_SPIMODE SPIDEV_MODE0
#endif

/* SPI frequency */

#ifndef CONFIG_LCD_ST7735_FREQUENCY
#  define CONFIG_LCD_ST7735_FREQUENCY 3000000
#endif

/* Check contrast selection */

#if !defined(CONFIG_LCD_MAXCONTRAST)
#  define CONFIG_LCD_MAXCONTRAST 1
#endif

/* Check power setting */

#if !defined(CONFIG_LCD_MAXPOWER) || CONFIG_LCD_MAXPOWER < 1
#  define CONFIG_LCD_MAXPOWER 1
#endif

#if CONFIG_LCD_MAXPOWER > 255
#  error "CONFIG_LCD_MAXPOWER must be less than 256 to fit in uint8_t"
#endif

/* Check orientation */

#if defined(CONFIG_LCD_PORTRAIT)
#  if defined(CONFIG_LCD_LANDSCAPE) || defined(CONFIG_LCD_RLANDSCAPE) ||\
      defined(CONFIG_LCD_RPORTRAIT)
#    error "Cannot define both portrait and any other orientations"
#  endif
#elif defined(CONFIG_LCD_RPORTRAIT)
#  if defined(CONFIG_LCD_LANDSCAPE) || defined(CONFIG_LCD_RLANDSCAPE)
#    error "Cannot define both rportrait and any other orientations"
#  endif
#elif defined(CONFIG_LCD_LANDSCAPE)
#  ifdef CONFIG_LCD_RLANDSCAPE
#    error "Cannot define both landscape and any other orientations"
#  endif
#elif !defined(CONFIG_LCD_RLANDSCAPE)
#  define CONFIG_LCD_LANDSCAPE 1
#endif

/* Display Resolution */

#ifdef CONFIG_LCD_ST7735_GM00
#  define CONFIG_ST7735_XRES 132
#  define CONFIG_ST7735_YRES 162
#  define ST7735_LUT_SIZE    162
#else
#  define CONFIG_ST7735_XRES 128
#  define CONFIG_ST7735_YRES 160
#  define ST7735_LUT_SIZE    160
#endif

#if defined(CONFIG_LCD_LANDSCAPE) || defined(CONFIG_LCD_RLANDSCAPE)
#  define ST7735_XRES       CONFIG_ST7735_YRES
#  define ST7735_YRES       CONFIG_ST7735_XRES
#else
#  define ST7735_XRES       CONFIG_ST7735_XRES
#  define ST7735_YRES       CONFIG_ST7735_YRES
#endif

/* Color depth and format */

#ifdef CONFIG_LCD_ST7735_BPP
#  if (CONFIG_LCD_ST7735_BPP == 12)
#    define ST7735_BPP           12
#    define ST7735_COLORFMT      FB_FMT_RGB12_444
#    define ST7735_BYTESPP       2
#  elif (CONFIG_LCD_ST7735_BPP == 16)
#    define ST7735_BPP           16
#    define ST7735_COLORFMT      FB_FMT_RGB16_565
#    define ST7735_BYTESPP       2
#  elif (CONFIG_LCD_ST7735_BPP == 18)
#    define ST7735_BPP           18
#    define ST7735_COLORFMT      FB_FMT_RGB16_666
#    define ST7735_BYTESPP       3
#  else
#    define ST7735_BPP           16
#    define ST7735_COLORFMT      FB_FMT_RGB16_565
#    define ST7735_BYTESPP       2
#    warning "Invalid color depth.  Falling back to 16bpp"
#  endif
#endif

/****************************************************************************
 * Private Types
 ****************************************************************************/

/* This structure describes the state of this driver */

struct st7735_dev_s
{
  /* Publicly visible device structure */

  struct lcd_dev_s dev;

  /* Private LCD-specific information follows */

  FAR struct spi_dev_s *spi;  /* SPI device */
  uint8_t bpp;                /* Selected color depth */
  uint8_t power;              /* Current power setting */

  /* 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.
   */

  uint16_t runbuffer[ST7735_LUT_SIZE];
};

/****************************************************************************
 * Private Function Protototypes
 ****************************************************************************/

/* Misc. Helpers */

static void st7735_select(FAR struct spi_dev_s *spi, int bits);
static void st7735_deselect(FAR struct spi_dev_s *spi);

static inline void st7735_sendcmd(FAR struct st7735_dev_s *dev, uint8_t cmd);
static void st7735_sleep(FAR struct st7735_dev_s *dev, bool sleep);
static void st7735_display(FAR struct st7735_dev_s *dev, bool on);
static void st7735_setarea(FAR struct st7735_dev_s *dev,
                           uint16_t x0, uint16_t y0,
                           uint16_t x1, uint16_t y1);
static void st7735_bpp(FAR struct st7735_dev_s *dev, int bpp);
static void st7735_wrram(FAR struct st7735_dev_s *dev,
                         FAR const uint16_t *buff, size_t size);
static void st7735_rdram(FAR struct st7735_dev_s *dev,
                         FAR uint16_t *buff, size_t size);
static void st7735_fill(FAR struct st7735_dev_s *dev, uint16_t color);

/* LCD Data Transfer Methods */

static int st7735_putrun(fb_coord_t row, fb_coord_t col,
                         FAR const uint8_t *buffer, size_t npixels);
#ifndef CONFIG_LCD_NOGETRUN
static int st7735_getrun(fb_coord_t row, fb_coord_t col,
                         FAR uint8_t *buffer, size_t npixels);
#endif

/* LCD Configuration */

static int st7735_getvideoinfo(FAR struct lcd_dev_s *dev,
                               FAR struct fb_videoinfo_s *vinfo);
static int st7735_getplaneinfo(FAR struct lcd_dev_s *dev,
                               unsigned int planeno,
                               FAR struct lcd_planeinfo_s *pinfo);

/* LCD Specific Controls */

static int st7735_getpower(FAR struct lcd_dev_s *dev);
static int st7735_setpower(FAR struct lcd_dev_s *dev, int power);
static int st7735_getcontrast(FAR struct lcd_dev_s *dev);
static int st7735_setcontrast(FAR struct lcd_dev_s *dev,
                              unsigned int contrast);

/****************************************************************************
 * Private Data
 ****************************************************************************/

static struct st7735_dev_s g_lcddev;

/****************************************************************************
 * Private Functions
 ****************************************************************************/

/****************************************************************************
 * Name: st7735_select
 *
 * Description:
 *   Select the SPI, locking and  re-configuring if necessary
 *
 * Input Parameters:
 *   spi   - Reference to the SPI driver structure
 *   bits  - Number of SPI bits
 *
 * Returned Value:
 *   None
 *
 * Assumptions:
 *
 ****************************************************************************/

static void st7735_select(FAR struct spi_dev_s *spi, int bits)
{
  /* Select ST7735 chip (locking the SPI bus in case there are multiple
   * devices competing for the SPI bus
   */

  SPI_LOCK(spi, true);
  SPI_SELECT(spi, SPIDEV_DISPLAY(0), true);

  /* Now make sure that the SPI bus is configured for the ST7735 (it
   * might have gotten configured for a different device while unlocked)
   */

  SPI_SETMODE(spi, CONFIG_LCD_ST7735_SPIMODE);
  SPI_SETBITS(spi, bits);
  SPI_SETFREQUENCY(spi, CONFIG_LCD_ST7735_FREQUENCY);
}

/****************************************************************************
 * Name: st7735_deselect
 *
 * Description:
 *   De-select the SPI
 *
 * Input Parameters:
 *   spi  - Reference to the SPI driver structure
 *
 * Returned Value:
 *   None
 *
 * Assumptions:
 *
 ****************************************************************************/

static void st7735_deselect(FAR struct spi_dev_s *spi)
{
  /* De-select ST7735 chip and relinquish the SPI bus. */

  SPI_SELECT(spi, SPIDEV_DISPLAY(0), false);
  SPI_LOCK(spi, false);
}

/****************************************************************************
 * Name: st7735_sendcmd
 *
 * Description:
 *   Send a command to the driver.
 *
 ****************************************************************************/

static inline void st7735_sendcmd(FAR struct st7735_dev_s *dev, uint8_t cmd)
{
  st7735_select(dev->spi, 8);
  SPI_CMDDATA(dev->spi, SPIDEV_DISPLAY(0), true);
  SPI_SEND(dev->spi, cmd);
  SPI_CMDDATA(dev->spi, SPIDEV_DISPLAY(0), false);
  st7735_deselect(dev->spi);
}

/****************************************************************************
 * Name: st7735_sleep
 *
 * Description:
 *   Sleep or wake up the driver.
 *
 ****************************************************************************/

static void st7735_sleep(FAR struct st7735_dev_s *dev, bool sleep)
{
  st7735_sendcmd(dev, sleep ? ST7735_SLPIN : ST7735_SLPOUT);
  up_mdelay(120);
}

/****************************************************************************
 * Name: st7735_display
 *
 * Description:
 *   Turn on or off the display.
 *
 ****************************************************************************/

static void st7735_display(FAR struct st7735_dev_s *dev, bool on)
{
  st7735_sendcmd(dev, on ? ST7735_DISPON : ST7735_DISPOFF);
}

/****************************************************************************
 * Name: st7735_setarea
 *
 * Description:
 *   Set the rectangular area for an upcoming read or write from RAM.
 *
 ****************************************************************************/

static void st7735_setarea(FAR struct st7735_dev_s *dev,
                           uint16_t x0, uint16_t y0,
                           uint16_t x1, uint16_t y1)
{
  /* Set row address */

  st7735_sendcmd(dev, ST7735_RASET);
  st7735_select(dev->spi, 16);
  SPI_SEND(dev->spi, y0);
  SPI_SEND(dev->spi, y1);
  st7735_deselect(dev->spi);

  /* Set column address */

  st7735_sendcmd(dev, ST7735_CASET);
  st7735_select(dev->spi, 16);
  SPI_SEND(dev->spi, x0);
  SPI_SEND(dev->spi, x1);
  st7735_deselect(dev->spi);
}

/****************************************************************************
 * Name: st7735_bpp
 *
 * Description:
 *   Set the color depth of the device.
 *
 ****************************************************************************/

static void st7735_bpp(FAR struct st7735_dev_s *dev, int bpp)
{
  uint8_t depth;

  /* Don't send any command if the depth hasn't changed. */

  if (dev->bpp != bpp)
    {
      /* REVISIT: Works only for 12 and 16 bpp! */

      depth = bpp >> 2 | 1;
      st7735_sendcmd(dev, ST7735_COLMOD);
      st7735_select(dev->spi, 8);
      SPI_SEND(dev->spi, depth);
      st7735_deselect(dev->spi);

      /* Cache the new BPP */

      dev->bpp = bpp;
    }
}

/****************************************************************************
 * Name: st7735_wrram
 *
 * Description:
 *   Write to the driver's RAM.
 *
 ****************************************************************************/

static void st7735_wrram(FAR struct st7735_dev_s *dev,
                         FAR const uint16_t *buff, size_t size)
{
  st7735_sendcmd(dev, ST7735_RAMWR);

  st7735_select(dev->spi, ST7735_BYTESPP * 8);
  SPI_SNDBLOCK(dev->spi, buff, size);
  st7735_deselect(dev->spi);
}

/****************************************************************************
 * Name: st7735_rdram
 *
 * Description:
 *   Read from the driver's RAM.
 *
 ****************************************************************************/

static void st7735_rdram(FAR struct st7735_dev_s *dev,
                         FAR uint16_t *buff, size_t size)
{
  st7735_sendcmd(dev, ST7735_RAMRD);

  st7735_select(dev->spi, ST7735_BYTESPP * 8);
  SPI_RECVBLOCK(dev->spi, buff, size);
  st7735_deselect(dev->spi);
}

/****************************************************************************
 * Name: st7735_fill
 *
 * Description:
 *   Fill the display with the specified color.
 *
 ****************************************************************************/

static void st7735_fill(FAR struct st7735_dev_s *dev, uint16_t color)
{
  int i;

  st7735_setarea(dev, 0, 0, ST7735_XRES - 1, ST7735_YRES - 1);

  st7735_sendcmd(dev, ST7735_RAMWR);
  st7735_select(dev->spi, ST7735_BYTESPP * 8);

  for (i = 0; i < ST7735_XRES * ST7735_YRES; i++)
    {
      SPI_SEND(dev->spi, color);
    }

  st7735_deselect(dev->spi);
}

/****************************************************************************
 * Name:  st7735_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 st7735_putrun(fb_coord_t row, fb_coord_t col,
                         FAR const uint8_t *buffer, size_t npixels)
{
  FAR struct st7735_dev_s *priv = &g_lcddev;
  FAR const uint16_t *src = (FAR const uint16_t *)buffer;

  ginfo("row: %d col: %d npixels: %d\n", row, col, npixels);
  DEBUGASSERT(buffer && ((uintptr_t)buffer & 1) == 0);

  st7735_setarea(priv, col, row, col + npixels - 1, row);
  st7735_wrram(priv, src, npixels);

  return OK;
}

/****************************************************************************
 * Name:  st7735_getrun
 *
 * 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)
 *
 ****************************************************************************/

#ifndef CONFIG_LCD_NOGETRUN
static int st7735_getrun(fb_coord_t row, fb_coord_t col, FAR uint8_t *buffer,
                         size_t npixels)
{
  FAR struct st7735_dev_s *priv = &g_lcddev;
  FAR uint16_t *dest = (FAR uint16_t *)buffer;

  ginfo("row: %d col: %d npixels: %d\n", row, col, npixels);
  DEBUGASSERT(buffer && ((uintptr_t)buffer & 1) == 0);

  st7735_setarea(priv, col, row, col + npixels - 1, row);
  st7735_rdram(priv, dest, npixels);

  return OK;
}
#endif

/****************************************************************************
 * Name:  st7735_getvideoinfo
 *
 * Description:
 *   Get information about the LCD video controller configuration.
 *
 ****************************************************************************/

static int st7735_getvideoinfo(FAR struct lcd_dev_s *dev,
                               FAR struct fb_videoinfo_s *vinfo)
{
  DEBUGASSERT(dev && vinfo);
  lcdinfo("fmt: %d xres: %d yres: %d nplanes: 1\n",
          ST7735_COLORFMT, ST7735_XRES, ST7735_YRES);

  vinfo->fmt     = ST7735_COLORFMT;    /* Color format: RGB16-565: RRRR RGGG GGGB BBBB */
  vinfo->xres    = ST7735_XRES;        /* Horizontal resolution in pixel columns */
  vinfo->yres    = ST7735_YRES;        /* Vertical resolution in pixel rows */
  vinfo->nplanes = 1;                  /* Number of color planes supported */
  return OK;
}

/****************************************************************************
 * Name:  st7735_getplaneinfo
 *
 * Description:
 *   Get information about the configuration of each LCD color plane.
 *
 ****************************************************************************/

static int st7735_getplaneinfo(FAR struct lcd_dev_s *dev,
                               unsigned int planeno,
                               FAR struct lcd_planeinfo_s *pinfo)
{
  FAR struct st7735_dev_s *priv = (FAR struct st7735_dev_s *)dev;

  DEBUGASSERT(dev && pinfo && planeno == 0);
  lcdinfo("planeno: %d bpp: %d\n", planeno, ST7735_BPP);

  pinfo->putrun = st7735_putrun;                  /* Put a run into LCD memory */
#ifndef CONFIG_LCD_NOGETRUN
  pinfo->getrun = st7735_getrun;                  /* Get a run from LCD memory */
#endif
  pinfo->buffer = (FAR uint8_t *)priv->runbuffer; /* Run scratch buffer */
  pinfo->bpp    = priv->bpp;                      /* Bits-per-pixel */
  return OK;
}

/****************************************************************************
 * Name:  st7735_getpower
 ****************************************************************************/

static int st7735_getpower(FAR struct lcd_dev_s *dev)
{
  FAR struct st7735_dev_s *priv = (FAR struct st7735_dev_s *)dev;

  lcdinfo("power: %d\n", priv->power);
  return priv->power;
}

/****************************************************************************
 * Name:  st7735_setpower
 ****************************************************************************/

static int st7735_setpower(FAR struct lcd_dev_s *dev, int power)
{
  FAR struct st7735_dev_s *priv = (FAR struct st7735_dev_s *)dev;

  lcdinfo("power: %d\n", power);
  DEBUGASSERT((unsigned)power <= CONFIG_LCD_MAXPOWER);

  /* Set new power level */

  if (power > 0)
    {
      /* Turn on the display */

      st7735_display(priv, true);

      /* Save the power */

      priv->power = power;
    }
  else
    {
      /* Turn off the display */

      st7735_display(priv, false);

      /* Save the power */

      priv->power = 0;
    }

  return OK;
}

/****************************************************************************
 * Name:  st7735_getcontrast
 *
 * Description:
 *   Get the current contrast setting (0-CONFIG_LCD_MAXCONTRAST).
 *
 ****************************************************************************/

static int st7735_getcontrast(FAR struct lcd_dev_s *dev)
{
  lcdinfo("Not implemented\n");
  return -ENOSYS;
}

/****************************************************************************
 * Name:  st7735_setcontrast
 *
 * Description:
 *   Set LCD panel contrast (0-CONFIG_LCD_MAXCONTRAST).
 *
 ****************************************************************************/

static int st7735_setcontrast(FAR struct lcd_dev_s *dev,
                              unsigned int contrast)
{
  lcdinfo("contrast: %d\n", contrast);
  return -ENOSYS;
}

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name:  st7735_initialize
 *
 * Description:
 *   Initialize the ST7735 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).
 *
 * 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 *st7735_lcdinitialize(FAR struct spi_dev_s *spi)
{
  FAR struct st7735_dev_s *priv = &g_lcddev;

  /* Initialize the driver data structure */

  priv->dev.getvideoinfo = st7735_getvideoinfo;
  priv->dev.getplaneinfo = st7735_getplaneinfo;
  priv->dev.getpower     = st7735_getpower;
  priv->dev.setpower     = st7735_setpower;
  priv->dev.getcontrast  = st7735_getcontrast;
  priv->dev.setcontrast  = st7735_setcontrast;
  priv->spi              = spi;

  /* Init the hardware and clear the display */

  st7735_sleep(priv, false);
  st7735_bpp(priv, ST7735_BPP);
  st7735_display(priv, true);
  st7735_fill(priv, 0xffff);

  return &priv->dev;
}

#endif /* CONFIG_LCD_ST7735 */