lcd-pcf85162.h

Go to the documentation of this file.

#ifndef DRIVER_LCD_DRIVER_PCF85162_H
#define DRIVER_LCD_DRIVER_PCF85162_H
/**********************************************************************/
/*
 * Copyright (c) 2014, Jetro AS
 * All rights reserved.
 *
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief Driver for I2C-based LCD driver type NXP PCF85162.
 *
 * @author KLO, Jetro AS
 */ /******************************************************************/

#include <dev/i2c-master.h>

/**
 * \defgroup pcf85162 NXP PCF85162 LCD driver
 * \ingroup extdrv
 * \{
 *
 * This driver supports the I2C-based LCD driver type NXP PCF85162.
 * The LCD driver IC has 32 segment driver outputs and up to 4 backplanes,
 * and can operate in static mode or multiplexing modes 1:2, 1:3 or 1:4.
 * The LCD driver IC has also built-in versatile blinking modes.
 * Wide IC power supply range from 1.8V to 5.5V, and wide logic LCD supply
 * range from 2.5V to 6.5V.
 *
 * The LCD driver IC has 1 address line.
 * The I2C address range is 0x38 - 0x39. Max baudrate is 400 kbit/s.
 * Typical current consumption is 6µA for the IC and 18µA for the LCD.
 *
 * Both initialization, flashing control and printing at the LCD are supported.
 *
 * The selected I2C port must be initialized before using the driver.
 */

/***********************************************************************
 * Global defines
***********************************************************************/
/**
 * lcd_driver_flashing_t structure defines flashing intervals.
 *
 */
enum lcd_driver_flashing_t
{
  LCD_FLASHING_INTERVAL_OFF    = 0x00,
  LCD_FLASHING_INTERVAL_400MS  = 0x01,
  LCD_FLASHING_INTERVAL_800MS  = 0x02,
  LCD_FLASHING_INTERVAL_1600MS = 0x03,
};

/**
 * lcd_driver_mode_t structure defines static mode or multiplexed mode 1:2, 1:3 or 1:4.
 *
 */
enum lcd_multiplex_mode_t
{
  LCD_MULTIPLEX_MODE_STATIC = 0x01,
  LCD_MULTIPLEX_MODE_1_2    = 0x02,
  LCD_MULTIPLEX_MODE_1_3    = 0x03,
  LCD_MULTIPLEX_MODE_1_4    = 0x00,
};

/**
 * lcd_bias_mode_t structure defines the bias mode 1/2 or 1/3.
 *
 */
enum lcd_bias_mode_t
{
  LCD_BIAS_MODE_1_2 = 0x04,
  LCD_BIAS_MODE_1_3 = 0x00,
};

/**
 * lcd_driver_t structure holds I2C port, slave address to be used and LCD driving mode.
 *
 */
struct lcd_driver_t
{
  const struct i2c_t *I2c;
  uint8_t SlaveAddress;                 // I2C slave address 0x38 - 0x39
  enum lcd_multiplex_mode_t MultiplexMode;   // LCD multiplex mode - static or multiplexed 1:2, 1:3 or 1:4.
  enum lcd_bias_mode_t Bias;                 // LCD bias mode 1/2 or 1/3.
};

/**
  * @name Functions called from application programs
  * @{
  */

/**********************************************************************/
/**
 * @brief Name:     LcdInit\n
 * Initializes the I2C-based LCD driver.
 * I2C address range is 0x38 - 0x39. Max baudrate is 400 kbit/s.
 *
 * @param LcdDriver Parameters for the LCD driver to be used
 * @return          true if OK, else false
 ***********************************************************************/
extern bool LcdInit(const struct lcd_driver_t *LcdDriver);

/**********************************************************************/
/**
 * @brief Name:     LcdFlashing\n
 * Sets LCD flashing mode.
 *
 * @param LcdDriver Parameters for the LCD driver to be used
 * @param Flashing  Flashing parameter
 * @return          true if OK, else false
 ***********************************************************************/
extern bool LcdFlashing(const struct lcd_driver_t *LcdDriver, enum lcd_driver_flashing_t Flashing);

/**********************************************************************/
/**
 * @brief Name:     LcdPrint\n
 * Prints characters on LCD.
 *
 * @param LcdDriver Parameters for the LCD driver to be used
 * @param SrcBuffer Pointer to ASCII character buffer to print from
 * @param CharCount Numbers of characters to print
 * @return          true if OK, else false
 ***********************************************************************/
extern bool LcdPrint(const struct lcd_driver_t *LcdDriver, const void *SrcBuffer, uint8_t CharCount);

/** @} */
/** \} */

#endif // DRIVER_LCD_DRIVER_PCF85162_H