nuttx/drivers/sensors/bh1749nuc.c

/****************************************************************************
 * drivers/sensors/bh1749nuc.c
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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.
 *
 ****************************************************************************/

/* WARNING for developers:
 *
 * This driver uses the legacy style of writing sensor drivers for NuttX. The
 * project has since decided to adopt a new sensor framework in order to
 * have a consistent API and feature-set.
 *
 * Sensors which use the uORB framework are typically suffixed "_uorb". You
 * can also visit the documentation about the new sensor framework to learn
 * more.
 */

#warning "This is a deprecated legacy sensor driver."

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include "bh1749nuc_base.h"

/****************************************************************************
 * Private Function Prototypes
 ****************************************************************************/

/* Character driver methods */

static int bh1749nuc_open(FAR struct file *filep);
static int bh1749nuc_close(FAR struct file *filep);
static ssize_t bh1749nuc_read(FAR struct file *filep,
                              FAR char *buffer,
                              size_t buflen);
static ssize_t bh1749nuc_write(FAR struct file *filep,
                               FAR const char *buffer,
                               size_t buflen);
static int bh1749nuc_ioctl(FAR struct file *filep, int cmd,
                           unsigned long arg);

/****************************************************************************
 * Private Data
 ****************************************************************************/

static const struct file_operations g_bh1749nucfops =
{
  bh1749nuc_open,              /* open */
  bh1749nuc_close,             /* close */
  bh1749nuc_read,              /* read */
  bh1749nuc_write,             /* write */
  NULL,                        /* seek */
  bh1749nuc_ioctl,             /* ioctl */
};

/****************************************************************************
 * Private Functions
 ****************************************************************************/

/****************************************************************************
 * Name: bh1749nuc_open
 *
 * Description:
 *   This function is called whenever the BH1749NUC device is opened.
 *
 ****************************************************************************/

static int bh1749nuc_open(FAR struct file *filep)
{
  FAR struct inode           *inode = filep->f_inode;
  FAR struct bh1749nuc_dev_s *priv  = inode->i_private;
  uint8_t                     val;

  /* MODE_CONTROL1 */

  val = (BH1749NUC_MODE_CONTROL1_MEAS_TIME160MS |
         BH1749NUC_MODE_CONTROL1_IR_GAIN_X1 |
         BH1749NUC_MODE_CONTROL1_RGB_GAIN_X1);
  bh1749nuc_putreg8(priv, BH1749NUC_MODE_CONTROL1, val);

  /* MODE_CONTROL2 */

  val = BH1749NUC_MODE_CONTROL2_RGBI_EN;
  bh1749nuc_putreg8(priv, BH1749NUC_MODE_CONTROL2, val);

  return OK;
}

/****************************************************************************
 * Name: bh1749nuc_close
 *
 * Description:
 *   This routine is called when the BH1749NUC device is closed.
 *
 ****************************************************************************/

static int bh1749nuc_close(FAR struct file *filep)
{
  FAR struct inode           *inode = filep->f_inode;
  FAR struct bh1749nuc_dev_s *priv  = inode->i_private;
  uint8_t                     val;

  /* Stop sampling */

  val = (BH1749NUC_SYSTEM_CONTROL_SW_RESET |
         BH1749NUC_SYSTEM_CONTROL_INT_RESET);
  bh1749nuc_putreg8(priv, BH1749NUC_SYSTEM_CONTROL, val);

  return OK;
}

/****************************************************************************
 * Name: bh1749nuc_read
 ****************************************************************************/

static ssize_t bh1749nuc_read(FAR struct file *filep, FAR char *buffer,
                              size_t len)
{
  FAR struct inode            *inode = filep->f_inode;
  FAR struct bh1749nuc_dev_s  *priv  = inode->i_private;
  FAR struct bh1749nuc_data_s *data  =
    (FAR struct bh1749nuc_data_s *) buffer;

  if (len < sizeof(struct bh1749nuc_data_s))
    {
      snerr("ERROR: Not enough memory to read data sample.\n");
      return -ENOBUFS;
    }

  /* Get data */

  data->red    = bh1749nuc_read16(priv, BH1749NUC_RED_DATA_LSB);
  data->green  = bh1749nuc_read16(priv, BH1749NUC_GREEN_DATA_LSB);
  data->blue   = bh1749nuc_read16(priv, BH1749NUC_BLUE_DATA_LSB);
  data->ir     = bh1749nuc_read16(priv, BH1749NUC_IR_DATA_LSB);
  data->green2 = bh1749nuc_read16(priv, BH1749NUC_GREEN2_DATA_LSB);

  return sizeof(struct bh1749nuc_data_s);
}

/****************************************************************************
 * Name: bh1749nuc_write
 ****************************************************************************/

static ssize_t bh1749nuc_write(FAR struct file *filep,
                               FAR const char *buffer,
                               size_t buflen)
{
  return -ENOSYS;
}

/****************************************************************************
 * Name: bh1749nuc_ioctl
 ****************************************************************************/

static int bh1749nuc_ioctl(FAR struct file *filep,
                           int cmd,
                           unsigned long arg)
{
  return -ENOTTY;
}

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: bh1749nuc_register
 *
 * Description:
 *   Register the BH1749NUC character device as 'devpath'
 *
 * Input Parameters:
 *   devpath - The full path to the driver to register. E.g., "/dev/color0"
 *   i2c     - An instance of the I2C interface to use to communicate with
 *             BH1749NUC
 *   addr    - I2C address
 *
 * Returned Value:
 *   Zero (OK) on success; a negated errno value on failure.
 *
 ****************************************************************************/

int bh1749nuc_register(FAR const char *devpath, FAR struct i2c_master_s *i2c,
                       uint8_t addr)
{
  FAR struct bh1749nuc_dev_s *priv;
  int                         ret;

  /* Initialize the BH1749NUC device structure */

  priv = (FAR struct bh1749nuc_dev_s *)
    kmm_malloc(sizeof(struct bh1749nuc_dev_s));
  if (!priv)
    {
      snerr("Failed to allocate instance\n");
      return -ENOMEM;
    }

  priv->i2c   = i2c;
  priv->addr  = addr;
  priv->freq  = CONFIG_BH1749NUC_I2C_FREQUENCY;

  /* Check Device ID */

  ret = bh1749nuc_checkid(priv);
  if (ret < 0)
    {
      snerr("Failed to register driver: %d\n", ret);
      return ret;
    }

  /* Register the character driver */

  ret = register_driver(devpath, &g_bh1749nucfops, 0600, priv);
  if (ret < 0)
    {
      snerr("Failed to register driver: %d\n", ret);
      kmm_free(priv);
    }

  sninfo("BH1749NUC driver loaded successfully!\n");

  return ret;
}