drivers: display: grove_lcd_rgb: move to misc
The driver does not implement a display API, it has a custom API. Having it under display is confusing, since display API consumers may expect they can use it. These sort of custom drivers fit better under drivers/misc. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas
Marti Bolivar
parent
2fdc551acc
commit
9a00b99884
17 changed files with 14 additions and 10 deletions
|
|
@ -1,3 +1,4 @@
|
|||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
add_subdirectory_ifdef(CONFIG_FT800 ft8xx)
|
||||
add_subdirectory_ifdef(CONFIG_GROVE_LCD_RGB grove_lcd_rgb)
|
||||
|
|
|
|||
|
|
@ -6,5 +6,6 @@
|
|||
menu "Miscellaneous Drivers"
|
||||
|
||||
source "drivers/misc/ft8xx/Kconfig"
|
||||
source "drivers/misc/grove_lcd_rgb/Kconfig"
|
||||
|
||||
endmenu
|
||||
|
|
|
|||
5
drivers/misc/grove_lcd_rgb/CMakeLists.txt
Normal file
5
drivers/misc/grove_lcd_rgb/CMakeLists.txt
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
zephyr_library()
|
||||
|
||||
zephyr_library_sources(grove_lcd_rgb.c)
|
||||
16
drivers/misc/grove_lcd_rgb/Kconfig
Normal file
16
drivers/misc/grove_lcd_rgb/Kconfig
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# Copyright (c) 2015 Intel Corporation
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
config GROVE_LCD_RGB
|
||||
bool "Enable the Seeed Grove LCD RGB Backlight"
|
||||
help
|
||||
Setting this value will enable driver support for the Groove-LCD RGB
|
||||
Backlight.
|
||||
|
||||
config GROVE_LCD_RGB_I2C_MASTER_DEV_NAME
|
||||
string "I2C Master where Grove LCD is connected"
|
||||
depends on GROVE_LCD_RGB
|
||||
default "I2C_0"
|
||||
help
|
||||
Specify the device name of the I2C master device to which the
|
||||
Grove LCD is connected.
|
||||
348
drivers/misc/grove_lcd_rgb/grove_lcd_rgb.c
Normal file
348
drivers/misc/grove_lcd_rgb/grove_lcd_rgb.c
Normal file
|
|
@ -0,0 +1,348 @@
|
|||
/*
|
||||
* Copyright (c) 2015 Intel Corporation
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <errno.h>
|
||||
#include <kernel.h>
|
||||
#include <init.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include <drivers/i2c.h>
|
||||
#include <drivers/misc/grove_lcd/grove_lcd.h>
|
||||
#include <sys/util.h>
|
||||
|
||||
#define LOG_LEVEL CONFIG_DISPLAY_LOG_LEVEL
|
||||
#include <logging/log.h>
|
||||
LOG_MODULE_REGISTER(grove_lcd);
|
||||
|
||||
#define SLEEP_IN_US(_x_) ((_x_) * 1000)
|
||||
|
||||
#define GROVE_LCD_DISPLAY_ADDR (0x3E)
|
||||
#define GROVE_RGB_BACKLIGHT_ADDR (0x62)
|
||||
|
||||
struct command {
|
||||
uint8_t control;
|
||||
uint8_t data;
|
||||
};
|
||||
|
||||
struct glcd_data {
|
||||
const struct device *i2c;
|
||||
uint8_t input_set;
|
||||
uint8_t display_switch;
|
||||
uint8_t function;
|
||||
};
|
||||
|
||||
struct glcd_driver {
|
||||
uint16_t lcd_addr;
|
||||
uint16_t rgb_addr;
|
||||
};
|
||||
|
||||
|
||||
#define ON 0x1
|
||||
#define OFF 0x0
|
||||
|
||||
/********************************************
|
||||
* LCD FUNCTIONS
|
||||
*******************************************/
|
||||
|
||||
/* GLCD_CMD_SCREEN_CLEAR has no options */
|
||||
/* GLCD_CMD_CURSOR_RETURN has no options */
|
||||
|
||||
/* Defines for the GLCD_CMD_CURSOR_SHIFT */
|
||||
#define GLCD_CS_DISPLAY_SHIFT (1 << 3)
|
||||
#define GLCD_CS_RIGHT_SHIFT (1 << 2)
|
||||
|
||||
/* LCD Display Commands */
|
||||
#define GLCD_CMD_SCREEN_CLEAR (1 << 0)
|
||||
#define GLCD_CMD_CURSOR_RETURN (1 << 1)
|
||||
#define GLCD_CMD_INPUT_SET (1 << 2)
|
||||
#define GLCD_CMD_DISPLAY_SWITCH (1 << 3)
|
||||
#define GLCD_CMD_CURSOR_SHIFT (1 << 4)
|
||||
#define GLCD_CMD_FUNCTION_SET (1 << 5)
|
||||
#define GLCD_CMD_SET_CGRAM_ADDR (1 << 6)
|
||||
#define GLCD_CMD_SET_DDRAM_ADDR (1 << 7)
|
||||
|
||||
|
||||
/********************************************
|
||||
* RGB FUNCTIONS
|
||||
*******************************************/
|
||||
|
||||
#define REGISTER_POWER 0x08
|
||||
#define REGISTER_R 0x04
|
||||
#define REGISTER_G 0x03
|
||||
#define REGISTER_B 0x02
|
||||
|
||||
static uint8_t color_define[][3] = {
|
||||
{ 255, 255, 255 }, /* white */
|
||||
{ 255, 0, 0 }, /* red */
|
||||
{ 0, 255, 0 }, /* green */
|
||||
{ 0, 0, 255 }, /* blue */
|
||||
};
|
||||
|
||||
|
||||
/********************************************
|
||||
* PRIVATE FUNCTIONS
|
||||
*******************************************/
|
||||
static void rgb_reg_set(const struct device *i2c, uint8_t addr, uint8_t dta)
|
||||
{
|
||||
uint8_t data[2] = { addr, dta };
|
||||
|
||||
i2c_write(i2c, data, sizeof(data), GROVE_RGB_BACKLIGHT_ADDR);
|
||||
}
|
||||
|
||||
|
||||
static inline void sleep(uint32_t sleep_in_ms)
|
||||
{
|
||||
k_busy_wait(SLEEP_IN_US(sleep_in_ms));
|
||||
}
|
||||
|
||||
|
||||
/********************************************
|
||||
* PUBLIC FUNCTIONS
|
||||
*******************************************/
|
||||
void glcd_print(const struct device *port, char *data, uint32_t size)
|
||||
{
|
||||
const struct glcd_driver * const rom = (const struct glcd_driver *)
|
||||
port->config;
|
||||
struct glcd_data *dev = port->data;
|
||||
uint8_t buf[] = { GLCD_CMD_SET_CGRAM_ADDR, 0 };
|
||||
int i;
|
||||
|
||||
for (i = 0; i < size; i++) {
|
||||
buf[1] = data[i];
|
||||
i2c_write(dev->i2c, buf, sizeof(buf), rom->lcd_addr);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void glcd_cursor_pos_set(const struct device *port, uint8_t col, uint8_t row)
|
||||
{
|
||||
const struct glcd_driver * const rom = (const struct glcd_driver *)
|
||||
port->config;
|
||||
struct glcd_data *dev = port->data;
|
||||
|
||||
unsigned char data[2];
|
||||
|
||||
if (row == 0U) {
|
||||
col |= 0x80;
|
||||
} else {
|
||||
col |= 0xC0;
|
||||
}
|
||||
|
||||
data[0] = GLCD_CMD_SET_DDRAM_ADDR;
|
||||
data[1] = col;
|
||||
|
||||
i2c_write(dev->i2c, data, 2, rom->lcd_addr);
|
||||
}
|
||||
|
||||
|
||||
void glcd_clear(const struct device *port)
|
||||
{
|
||||
const struct glcd_driver * const rom = (const struct glcd_driver *)
|
||||
port->config;
|
||||
struct glcd_data *dev = port->data;
|
||||
uint8_t clear[] = { 0, GLCD_CMD_SCREEN_CLEAR };
|
||||
|
||||
i2c_write(dev->i2c, clear, sizeof(clear), rom->lcd_addr);
|
||||
LOG_DBG("clear, delay 20 ms");
|
||||
sleep(20);
|
||||
}
|
||||
|
||||
|
||||
void glcd_display_state_set(const struct device *port, uint8_t opt)
|
||||
{
|
||||
const struct glcd_driver * const rom = (const struct glcd_driver *)
|
||||
port->config;
|
||||
struct glcd_data *dev = port->data;
|
||||
uint8_t data[] = { 0, 0 };
|
||||
|
||||
dev->display_switch = opt;
|
||||
data[1] = (opt | GLCD_CMD_DISPLAY_SWITCH);
|
||||
|
||||
i2c_write(dev->i2c, data, sizeof(data), rom->lcd_addr);
|
||||
|
||||
LOG_DBG("set display_state options, delay 5 ms");
|
||||
sleep(5);
|
||||
}
|
||||
|
||||
|
||||
uint8_t glcd_display_state_get(const struct device *port)
|
||||
{
|
||||
struct glcd_data *dev = port->data;
|
||||
|
||||
return dev->display_switch;
|
||||
}
|
||||
|
||||
|
||||
void glcd_input_state_set(const struct device *port, uint8_t opt)
|
||||
{
|
||||
const struct glcd_driver * const rom = port->config;
|
||||
struct glcd_data *dev = port->data;
|
||||
uint8_t data[] = { 0, 0 };
|
||||
|
||||
dev->input_set = opt;
|
||||
data[1] = (opt | GLCD_CMD_INPUT_SET);
|
||||
|
||||
i2c_write(dev->i2c, &dev->input_set, sizeof(dev->input_set),
|
||||
rom->lcd_addr);
|
||||
LOG_DBG("set the input_set, no delay");
|
||||
}
|
||||
|
||||
|
||||
uint8_t glcd_input_state_get(const struct device *port)
|
||||
{
|
||||
struct glcd_data *dev = port->data;
|
||||
|
||||
return dev->input_set;
|
||||
}
|
||||
|
||||
|
||||
void glcd_color_select(const struct device *port, uint8_t color)
|
||||
{
|
||||
if (color > 3) {
|
||||
LOG_WRN("selected color is too high a value");
|
||||
return;
|
||||
}
|
||||
glcd_color_set(port, color_define[color][0],
|
||||
color_define[color][1],
|
||||
color_define[color][2]);
|
||||
}
|
||||
|
||||
|
||||
void glcd_color_set(const struct device *port, uint8_t r, uint8_t g,
|
||||
uint8_t b)
|
||||
{
|
||||
struct glcd_data * const dev = port->data;
|
||||
|
||||
rgb_reg_set(dev->i2c, REGISTER_R, r);
|
||||
rgb_reg_set(dev->i2c, REGISTER_G, g);
|
||||
rgb_reg_set(dev->i2c, REGISTER_B, b);
|
||||
}
|
||||
|
||||
|
||||
void glcd_function_set(const struct device *port, uint8_t opt)
|
||||
{
|
||||
const struct glcd_driver * const rom = port->config;
|
||||
struct glcd_data *dev = port->data;
|
||||
uint8_t data[] = { 0, 0 };
|
||||
|
||||
dev->function = opt;
|
||||
data[1] = (opt | GLCD_CMD_FUNCTION_SET);
|
||||
|
||||
i2c_write(dev->i2c, data, sizeof(data), rom->lcd_addr);
|
||||
|
||||
LOG_DBG("set function options, delay 5 ms");
|
||||
sleep(5);
|
||||
}
|
||||
|
||||
|
||||
uint8_t glcd_function_get(const struct device *port)
|
||||
{
|
||||
struct glcd_data *dev = port->data;
|
||||
|
||||
return dev->function;
|
||||
}
|
||||
|
||||
|
||||
int glcd_initialize(const struct device *port)
|
||||
{
|
||||
struct glcd_data *dev = port->data;
|
||||
uint8_t cmd;
|
||||
|
||||
LOG_DBG("initialize called");
|
||||
|
||||
dev->input_set = 0U;
|
||||
dev->display_switch = 0U;
|
||||
dev->function = 0U;
|
||||
|
||||
/*
|
||||
* First set up the device driver...
|
||||
* we need a pointer to the I2C device we are bound to
|
||||
*/
|
||||
dev->i2c = device_get_binding(
|
||||
CONFIG_GROVE_LCD_RGB_I2C_MASTER_DEV_NAME);
|
||||
|
||||
if (!dev->i2c) {
|
||||
return -EPERM;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Initialization sequence from the data sheet:
|
||||
* 1 - Power on
|
||||
* - Wait for more than 30 ms AFTER VDD rises to 4.5v
|
||||
* 2 - Send FUNCTION set
|
||||
* - Wait for 39 us
|
||||
* 3 - Send DISPLAY Control
|
||||
* - wait for 39 us
|
||||
* 4 - send DISPLAY Clear
|
||||
* - wait for 1.5 ms
|
||||
* 5 - send ENTRY Mode
|
||||
* 6 - Initialization is done
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* We're here! Let's just make sure we've had enough time for the
|
||||
* VDD to power on, so pause a little here, 30 ms min, so we go 50
|
||||
*/
|
||||
LOG_DBG("delay 50 ms while the VDD powers on");
|
||||
sleep(50);
|
||||
|
||||
/* Configure everything for the display function first */
|
||||
cmd = GLCD_CMD_FUNCTION_SET | GLCD_FS_ROWS_2;
|
||||
glcd_function_set(port, cmd);
|
||||
|
||||
/* turn the display on - by default no cursor and no blinking */
|
||||
cmd = GLCD_DS_DISPLAY_ON | GLCD_DS_CURSOR_OFF | GLCD_DS_BLINK_OFF;
|
||||
|
||||
glcd_display_state_set(port, cmd);
|
||||
|
||||
/* Clear the screen */
|
||||
glcd_clear(port);
|
||||
|
||||
/* Initialize to the default text direction for romance languages */
|
||||
cmd = GLCD_IS_ENTRY_LEFT | GLCD_IS_SHIFT_DECREMENT;
|
||||
|
||||
glcd_input_state_set(port, cmd);
|
||||
|
||||
/* Now power on the background RGB control */
|
||||
LOG_INF("configuring the RGB background");
|
||||
rgb_reg_set(dev->i2c, 0x00, 0x00);
|
||||
rgb_reg_set(dev->i2c, 0x01, 0x05);
|
||||
rgb_reg_set(dev->i2c, 0x08, 0xAA);
|
||||
|
||||
/* Now set the background color to white */
|
||||
LOG_DBG("background set to white");
|
||||
rgb_reg_set(dev->i2c, REGISTER_R, color_define[GROVE_RGB_WHITE][0]);
|
||||
rgb_reg_set(dev->i2c, REGISTER_G, color_define[GROVE_RGB_WHITE][1]);
|
||||
rgb_reg_set(dev->i2c, REGISTER_B, color_define[GROVE_RGB_WHITE][2]);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static const struct glcd_driver grove_lcd_config = {
|
||||
.lcd_addr = GROVE_LCD_DISPLAY_ADDR,
|
||||
.rgb_addr = GROVE_RGB_BACKLIGHT_ADDR,
|
||||
};
|
||||
|
||||
static struct glcd_data grove_lcd_driver = {
|
||||
.i2c = NULL,
|
||||
.input_set = 0,
|
||||
.display_switch = 0,
|
||||
.function = 0,
|
||||
};
|
||||
|
||||
/* Since device_get_binding() will not return any
|
||||
* reference to a driver instance if driver_api
|
||||
* is NULL and grove_lcd does not have any API struct,
|
||||
* just populate it with some magic number
|
||||
* so grove_lcd can be referenced.
|
||||
* since grove_lcd_driver struct is available, populating with it
|
||||
*/
|
||||
DEVICE_DEFINE(grove_lcd, GROVE_LCD_NAME, glcd_initialize,
|
||||
NULL, &grove_lcd_driver, &grove_lcd_config,
|
||||
POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEVICE,
|
||||
(void *)&grove_lcd_driver);
|
||||
Loading…
Add table
Add a link
Reference in a new issue