Merged in K-man23/nuttx/ncp5623c (pull request #56)

Add RGB driver NCP5623C
This commit is contained in:
Gregory Nutt 2016-06-14 16:15:34 -06:00
commit 00a67b5d2b
3 changed files with 475 additions and 0 deletions

View File

@ -56,4 +56,12 @@ config PCA9635PW
Enable support for the NXP PCA9635PW LED driver which can be
utilized to drive up to 16 LED's.
config NCP5623C
bool "NCP5623C I2C LED Driver"
default n
select I2C
---help---
Enable support for the onsemi NCP5623C LED driver which can be
utilized to drive up to 3 LED's.
endmenu # LED Support

View File

@ -61,6 +61,11 @@ ifeq ($(CONFIG_PCA9635PW),y)
LEDDEPATH = --dep-path leds
LEDVPATH = :leds
endif
ifeq ($(CONFIG_NCP5623C),y)
CSRCS += ncp5623c.c
LEDDEPATH = --dep-path leds
LEDVPATH = :leds
endif
# Include LED build support (if any LED drivers were selected)

462
drivers/leds/ncp5623c.c Normal file
View File

@ -0,0 +1,462 @@
/****************************************************************************
* drivers/leds/ncp5623c.c
* based on drivers/leds/pca9635pw.c
*
* Author: Konstantin Berzenko <kpberezenko@gmail.com>
*
* 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. Neither the name NuttX 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 OWNER 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.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/i2c/i2c_master.h>
#include <nuttx/kmalloc.h>
#include <nuttx/leds/ncp5623c.h>
#if defined(CONFIG_I2C) && defined(CONFIG_NCP5623C)
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#ifdef CONFIG_DEBUG_LEDS
# define derr llerr
# ifdef CONFIG_DEBUG_INFO
# define dinfo llinfo
# else
# define dinfo(x...)
# endif
#else
# define derr(x...)
# define dinfo(x...)
#endif
/****************************************************************************
* Private Type Definitions
****************************************************************************/
struct ncp5623c_dev_s
{
FAR struct i2c_master_s *i2c;
uint8_t i2c_addr;
};
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
static int ncp5623c_i2c_write_byte(FAR struct ncp5623c_dev_s *priv,
uint8_t const reg_addr,
uint8_t const reg_val);
static int ncp5623c_open(FAR struct file *filep);
static int ncp5623c_close(FAR struct file *filep);
static int ncp5623c_ioctl(FAR struct file *filep, int cmd, unsigned long arg);
static ssize_t ncp5623c_read(FAR struct file *filep, FAR char *buffer,
size_t buflen);
static ssize_t ncp5623c_write(FAR struct file *filep, FAR const char *buffer,
size_t buflen);
/****************************************************************************
* Private Data
****************************************************************************/
static const struct file_operations g_ncp5623c_fileops =
{
ncp5623c_open, /* open */
ncp5623c_close, /* close */
ncp5623c_read, /* read */
ncp5623c_write, /* write */
0, /* seek */
ncp5623c_ioctl, /* ioctl */
0 /* poll */
};
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: ncp5623c_i2c_write_byte
*
* Description:
* Write a single byte to one of the NCP5623C configuration registers.
*
****************************************************************************/
static int ncp5623c_i2c_write_byte(FAR struct ncp5623c_dev_s *priv,
uint8_t const reg_addr,
uint8_t const reg_val)
{
struct i2c_config_s config;
int ret = OK;
/* assemble the 1 byte message comprised of reg_val */
uint8_t const BUFFER_SIZE = 1;
uint8_t buffer[BUFFER_SIZE];
buffer[0] = NCP5623C_SET_REG(reg_addr, reg_val);
/* Setup up the I2C configuration */
config.frequency = I2C_BUS_FREQ_HZ;
config.address = priv->i2c_addr;
config.addrlen = 7;
/* Write the data (no RESTART) */
dinfo("i2c addr: 0x%02X value: 0x%02X\n", priv->i2c_addr,
buffer[0]);
ret = i2c_write(priv->i2c, &config, buffer, BUFFER_SIZE);
if (ret != OK)
{
derr("i2c_write returned error code %d\n", ret);
return ret;
}
return OK;
}
/****************************************************************************
* Name: ncp5623c_open
*
* Description:
* This function is called whenever a NCP5623C device is opened.
*
****************************************************************************/
static int ncp5623c_open(FAR struct file *filep)
{
dinfo("ncp5623c_open\n");
FAR struct inode *inode = filep->f_inode;
FAR struct ncp5623c_dev_s *priv = inode->i_private;
int ret = -1;
/* shutdown the NCP5623C */
ret = ncp5623c_i2c_write_byte(priv, NCP5623C_SHUTDOWN,
0x00);
if (ret != OK)
{
derr("Could not shut down the NCP5623C\n");
return ret;
}
/* Set up Max current */
ret = ncp5623c_i2c_write_byte(priv, NCP5623C_ILED,
0x1F);
if (ret != OK)
{
derr("Could not set up max current\n");
return ret;
}
// let the chip settle a bit
usleep(1);
return OK;
}
/****************************************************************************
* Name: ncp5623c_close
*
* Description:
* This function is called whenever a NCP5623C device is closed.
*
****************************************************************************/
static int ncp5623c_close(FAR struct file *filep)
{
dinfo("ncp5623c_close\n");
FAR struct inode *inode = filep->f_inode;
FAR struct ncp5623c_dev_s *priv = inode->i_private;
int ret = -1;
/* shut down NCP5623C */
ret =ncp5623c_i2c_write_byte(priv, NCP5623C_SHUTDOWN,
0x00);
if (ret != OK)
{
return ret;
}
return OK;
}
/****************************************************************************
* Name: ncp5623c_ioctl
*
* Description:
* This function is called whenever an ioctl call to a NCP5623C is performed.
*
****************************************************************************/
static int ncp5623c_ioctl(FAR struct file *filep, int cmd, unsigned long arg)
{
FAR struct inode *inode = filep->f_inode;
FAR struct ncp5623c_dev_s *priv = inode->i_private;
int ret = OK;
dinfo("cmd: %d arg: %ld\n", cmd, arg);
switch (cmd)
{
case LEDIOC_SET_REG:
{
/* Retrieve the information handed over as argument for this ioctl */
FAR const struct ncp5623c_set_reg_s *ptr =
(FAR const struct ncp5623c_set_reg_s *)((uintptr_t)arg);
DEBUGASSERT(ptr != NULL);
if (ptr->reg > NCP5623C_MAX_REG) {
derr("Unrecognized register: %d\n", ptr->reg);
ret = -EFAULT;
break;
}
ret = ncp5623c_i2c_write_byte(priv, ptr->reg, ptr->val);
}
break;
/* The used ioctl command was invalid */
default:
{
derr("Unrecognized cmd: %d\n", cmd);
ret = -ENOTTY;
}
break;
}
return ret;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: ncp5623c_register
*
* Description:
* Register the NCP5623C device as 'devpath'
*
* Input Parameters:
* devpath - The full path to the driver to register. E.g., "/dev/rgbdrv0".
* i2c - An instance of the I2C interface to use to communicate
* with the LED driver.
* ncp5623c_i2c_addr
* - The I2C address of the NCP5623C.
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int ncp5623c_register(FAR const char *devpath, FAR struct i2c_master_s *i2c,
uint8_t const ncp5623c_i2c_addr)
{
/* Sanity check */
DEBUGASSERT(i2c != NULL);
/* Initialize the NCP5623C device structure */
FAR struct ncp5623c_dev_s *priv =
(FAR struct ncp5623c_dev_s *)kmm_malloc(sizeof(struct ncp5623c_dev_s));
if (priv == NULL)
{
derr("Failed to allocate instance of ncp5623c_dev_s\n");
return -ENOMEM;
}
priv->i2c = i2c;
priv->i2c_addr = ncp5623c_i2c_addr;
/* Register the character driver */
int const ret = register_driver(devpath, &g_ncp5623c_fileops, 666, priv);
if (ret != OK)
{
derr("Failed to register driver: %d\n", ret);
kmm_free(priv);
return ret;
}
return OK;
}
/****************************************************************************
* Name: ncp5623c_read
*
* Description:
* A dummy read method. This is provided only to satisfy the VFS layer.
*
****************************************************************************/
static ssize_t ncp5623c_read(FAR struct file *filep, FAR char *buffer,
size_t buflen)
{
/* Return zero -- usually meaning end-of-file */
return 0;
}
/****************************************************************************
* Name: ncp5623c_write
*
* Description:
* A dummy write method. This is provided only to satisfy the VFS layer.
*
****************************************************************************/
static ssize_t ncp5623c_write(FAR struct file *filep, FAR const char *buffer,
size_t buflen)
{
dinfo("%s\n", buffer);
FAR struct inode *inode = filep->f_inode;
FAR struct ncp5623c_dev_s *priv = inode->i_private;
int ret = OK;
unsigned int red;
unsigned int green;
unsigned int blue;
char color[3];
/* We need to receive a string #RRGGBB = 7 bytes */
if (buffer == NULL || buflen < 7)
{
/* Well... nothing to do */
return -EINVAL;
}
/* Check if it is a color format */
if (buffer[0] != '#')
{
/* The color code needs to start with # */
return -EINVAL;
}
/* Move buffer to next character */
buffer++;
color[0] = buffer[0];
color[1] = buffer[1];
color[2] = '\0';
red = strtol(color, NULL, 16);
color[0] = buffer[2];
color[1] = buffer[3];
color[2] = '\0';
green = strtol(color, NULL, 16);
color[0] = buffer[4];
color[1] = buffer[5];
color[2] = '\0';
blue = strtol(color, NULL, 16);
/* Sane check */
if (red > NCP5623C_MAX_VALUE)
{
red = NCP5623C_MAX_VALUE;
}
if (green > NCP5623C_MAX_VALUE)
{
green = NCP5623C_MAX_VALUE;
}
if (blue > NCP5623C_MAX_VALUE)
{
blue = NCP5623C_MAX_VALUE;
}
/* Setup LED R */
ret = ncp5623c_i2c_write_byte(priv, NCP5623C_PWM1,
red);
if (ret != OK)
{
derr("Could set red led\n");
return ret;
}
/* Setup LED G */
ret = ncp5623c_i2c_write_byte(priv, NCP5623C_PWM2,
green);
if (ret != OK)
{
derr("Could set green led\n");
return ret;
}
/* Setup LED B */
ret = ncp5623c_i2c_write_byte(priv, NCP5623C_PWM3,
blue);
if (ret != OK)
{
derr("Could set blue led\n");
return ret;
}
return buflen;
}
#endif /* CONFIG_I2C && CONFIG_I2C_NCP5623C */