144 lines
5.0 KiB
C
144 lines
5.0 KiB
C
/****************************************************************************
|
|
* include/nuttx/lcd/ug-9664hswag01.h
|
|
*
|
|
* Driver for the Univision UG-9664HSWAG01 Display with the Solomon Systech
|
|
* SSD1305 LCD controller.
|
|
*
|
|
* 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_LCD_UG_9664HSWAG01_H
|
|
#define __INCLUDE_NUTTX_LCD_UG_9664HSWAG01_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <stdbool.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* UG-9664HSWAG01 Configuration Settings:
|
|
*
|
|
* CONFIG_UG9664HSWAG01_SPIMODE - Controls the SPI mode
|
|
* CONFIG_UG9664HSWAG01_FREQUENCY - Define to use a different bus frequency
|
|
* CONFIG_UG9664HSWAG01_NINTERFACES - Specifies the number of physical
|
|
* UG-9664HSWAG01 devices that will be supported. NOTE: At present, this
|
|
* must be undefined or defined to be 1.
|
|
* CONFIG_UG9664HSWAG01_POWER
|
|
* If the hardware supports a controllable OLED a power supply, this
|
|
* configuration should be defined. (See ug_power() below).
|
|
*
|
|
* Required LCD driver settings:
|
|
* CONFIG_LCD_UG9664HSWAG01 - Enable UG-9664HSWAG01 support
|
|
* CONFIG_LCD_MAXCONTRAST should be 255, but any value >0 and <=255 will be
|
|
* accepted.
|
|
* CONFIG_LCD_MAXPOWER should be 2: 0=off, 1=dim, 2=normal
|
|
*
|
|
* Required SPI driver settings:
|
|
* CONFIG_SPI_CMDDATA - Include support for cmd/data selection.
|
|
*/
|
|
|
|
/* Some important "colors" */
|
|
|
|
#define UG_Y1_BLACK 0
|
|
#define UG_Y1_WHITE 1
|
|
|
|
/* Only three power settings are supported: */
|
|
|
|
#define UG_POWER_OFF 0
|
|
#define UG_POWER_DIM 1
|
|
#define UG_POWER_ON 2
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: ug_initialize
|
|
*
|
|
* Description:
|
|
* Initialize the UG-9664HSWAG01 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:
|
|
*
|
|
* spi - A reference to the SPI driver instance.
|
|
* devno - A value in the range of 0 through
|
|
* CONFIG_UG9664HSWAG01_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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
struct lcd_dev_s; /* see nuttx/lcd.h */
|
|
struct spi_dev_s; /* see nuttx/spi/spi.h */
|
|
FAR struct lcd_dev_s *ug_initialize(FAR struct spi_dev_s *spi,
|
|
unsigned int devno);
|
|
|
|
/****************************************************************************
|
|
* Name: ug_power
|
|
*
|
|
* Description:
|
|
* If the hardware supports a controllable OLED a power supply, this
|
|
* interface should be provided. It may be called by the driver to turn
|
|
* the OLED power on and off as needed.
|
|
*
|
|
* Input Parameters:
|
|
*
|
|
* devno - A value in the range of 0 through
|
|
* CONFIG_UG9664HSWAG01_NINTERFACES-1.
|
|
* This allows support for multiple OLED devices.
|
|
* on - true:turn power on, false: turn power off.
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_UG9664HSWAG01_POWER
|
|
void ug_power(unsigned int devno, bool on);
|
|
#else
|
|
# define ug_power(a,b)
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_NUTTX_LCD_UG_9664HSWAG01_H */
|