sharplcd.h

Go to the documentation of this file.

/* Copyright 2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the software 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 HOLDER 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 BSP430_UTILITY_SHARPLCD_H
#define BSP430_UTILITY_SHARPLCD_H

#include <bsp430/core.h>
#include <bsp430/serial.h>
#include <bsp430/periph/port.h>

#ifndef configBSP430_PLATFORM_SHARPLCD
#define configBSP430_PLATFORM_SHARPLCD 0
#endif /* configBSP430_PLATFORM_SHARPLCD */

#if defined(BSP430_DOXYGEN)
#define BSP430_PLATFORM_SHARPLCD include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

#ifndef configBSP430_PLATFORM_BOOSTERPACK_SHARP96
#define configBSP430_PLATFORM_BOOSTERPACK_SHARP96 0
#endif /* configBSP430_PLATFORM_BOOSTERPACK_SHARP96 */

#if defined(BSP430_DOXYGEN)
#define BSP430_PLATFORM_BOOSTERPACK_SHARP96 include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN)

#define BSP430_PLATFORM_SHARPLCD_ROWS include <bsp430/platform.h>
#endif /* BSP430_PLATFORM_SHARPLCD_ROWS */
#if defined(BSP430_DOXYGEN)

#define BSP430_PLATFORM_SHARPLCD_COLUMNS include <bsp430/platform.h>
#endif /* BSP430_PLATFORM_SHARPLCD_COLUMNS */

#define BSP430_PLATFORM_SHARPLCD_BYTES_PER_LINE ((7 + BSP430_PLATFORM_SHARPLCD_COLUMNS) / 8)

#if defined(BSP430_DOXYGEN) || !defined(BSP430_SHARPLCD_REFRESH_INTERVAL_MS)

#define BSP430_SHARPLCD_REFRESH_INTERVAL_MS 1000
#endif /* BSP430_SHARPLCD_REFRESH_INTERVAL_MS */

#if defined(BSP430_DOXYGEN) || !defined(BSP430_PLATFORM_SHARPLCD_SPI_BUS_HZ)
#define BSP430_PLATFORM_SHARPLCD_SPI_BUS_HZ 1000000UL
#endif /* BSP430_SHARPLCD_SPI_BUS_HZ */

#define BSP430_SHARPLCD_CTL0_INITIALIZER BSP430_SERIAL_ADJUST_CTL0_INITIALIZER(UCCKPH | UCMSB | UCMST)

#if defined(BSP430_DOXYGEN)

#define BSP430_PLATFORM_SHARPLCD_CS_PORT_PERIPH_HANDLE include <bsp430/platform.h>

#define BSP430_PLATFORM_SHARPLCD_CS_PORT_BIT include <bsp430/platform.h>

#define BSP430_PLATFORM_SHARPLCD_LCD_EN_PORT_PERIPH_HANDLE include <bsp430/platform.h>

#define BSP430_PLATFORM_SHARPLCD_LCD_EN_PORT_BIT include <bsp430/platform.h>

#define BSP430_PLATFORM_SHARPLCD_PWR_EN_PORT_PERIPH_HANDLE include <bsp430/platform.h>

#define BSP430_PLATFORM_SHARPLCD_PWR_EN_PORT_BIT include <bsp430/platform.h>

#define BSP430_PLATFORM_SHARPLCD_SPI_PERIPH_HANDLE include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

typedef struct sBSP430sharplcd {
  volatile sBSP430hplPORT * cs; 
  volatile sBSP430hplPORT * lcd_en; 
  volatile sBSP430hplPORT * pwr_en; 
  hBSP430halSERIAL spi;             
  unsigned int lines;               
  unsigned int columns;             
  unsigned int line_size;           
  uint8_t cs_bit;                   
  uint8_t lcd_en_bit;               
  uint8_t pwr_en_bit;               
  uint8_t vcom_state_;              
} sBSP430sharplcd;

typedef sBSP430sharplcd * hBSP430sharplcd;

#define BSP430_SHARPLCD_MODE_DYNAMIC 0x80

#define BSP430_SHARPLCD_VCOM 0x40

#define BSP430_SHARPLCD_CLEAR_ALL 0x20

#define BSP430_SHARPLCD_CS_ASSERT(_dev) do {                            \
    (_dev)->cs->out |= (_dev)->cs_bit;                                  \
  } while (0)

#define BSP430_SHARPLCD_CS_DEASSERT(_dev) do {                          \
    (_dev)->cs->out &= ~(_dev)->cs_bit;                                 \
  } while (0)

hBSP430sharplcd hBSP430sharplcdInitializePlatformDevice (hBSP430sharplcd dev);

int iBSP430sharplcdSetEnabled_ni (hBSP430sharplcd dev, int enablep);

int iBSP430sharplcdClearDisplay_rh (hBSP430sharplcd dev);

int iBSP430sharplcdRefreshDisplay_rh (hBSP430sharplcd dev);

int iBSP430sharplcdUpdateDisplayLines_rh (hBSP430sharplcd dev,
                                          int start_line,
                                          int num_lines,
                                          const uint8_t * line_data);

#endif /* BSP430_UTILITY_SHARPLCD_H */