140 lines
4.9 KiB
C
140 lines
4.9 KiB
C
/****************************************************************************
|
|
* include/nuttx/sensors/apds9930.h
|
|
*
|
|
* 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_SENSORS_APDS9930_H
|
|
#define __INCLUDE_NUTTX_SENSORS_APDS9930_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
#include <nuttx/config.h>
|
|
|
|
#if defined(CONFIG_I2C) && (defined(CONFIG_SENSORS_APDS9930) || defined(CONFIG_SENSORS_APDS9930_SCU))
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Configuration */
|
|
|
|
/* Prerequisites:
|
|
*
|
|
* CONFIG_APDS9930
|
|
* Enables support for the APDS9930 driver
|
|
*/
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
struct i2c_master_s;
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/* IOCTL Commands */
|
|
|
|
/* These commands are valid for CONFIG_APDS9930_PROXIMITY_INTERRUPT=y */
|
|
|
|
#define SNIOC_SETPSLTHRESHOLD _SNIOC(0x0001) /* Set low threshold */
|
|
#define SNIOC_SETPSHTHRESHOLD _SNIOC(0x0002) /* Set high threshold */
|
|
#define SNIOC_SETPSPERSISTENCE _SNIOC(0x0003) /* Set persistence(0-15) */
|
|
#define SNIOC_STARTPSMEASUREMENT _SNIOC(0x0004) /* Start measurement */
|
|
#define SNIOC_STOPPSMEASUREMENT _SNIOC(0x0005) /* Stop measurement */
|
|
#define SNIOC_GETINTSTATUS _SNIOC(0x0006) /* Get interrupt status */
|
|
#define SNIOC_CLEARPSINT _SNIOC(0x0007) /* Clear interrupt */
|
|
|
|
/****************************************************************************
|
|
* Name: apds9930_init
|
|
*
|
|
* Description:
|
|
* Initialize APDS9930 proximity and ambient light sensor device
|
|
*
|
|
* Input Parameters:
|
|
* i2c - An instance of the I2C interface to use to communicate with
|
|
* APDS9930
|
|
* port - I2C port (0 or 1)
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) on success; a negated errno value on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int apds9930_init(FAR struct i2c_master_s *i2c, int port);
|
|
|
|
/****************************************************************************
|
|
* Name: apds9930als_register
|
|
*
|
|
* Description:
|
|
* Register the APDS9930 ambient light sensor character device as 'devpath'
|
|
*
|
|
* Input Parameters:
|
|
* devpath - The full path to the driver to register. E.g., "/dev/light0"
|
|
* minor - minor device number
|
|
* i2c - An instance of the I2C interface to use to communicate with
|
|
* APDS9930
|
|
* port - I2C port (0 or 1)
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) on success; a negated errno value on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int apds9930als_register(FAR const char *devpath, int minor,
|
|
FAR struct i2c_master_s *i2c, int port);
|
|
|
|
/****************************************************************************
|
|
* Name: apds9930ps_register
|
|
*
|
|
* Description:
|
|
* Register the APDS9930 proximity sensor character device as 'devpath'
|
|
*
|
|
* Input Parameters:
|
|
* devpath - The full path to the driver to register. E.g., "/dev/proxim0"
|
|
* minor - minor device number
|
|
* i2c - An instance of the I2C interface to use to communicate with
|
|
* APDS9930
|
|
* port - I2C port (0 or 1)
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) on success; a negated errno value on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int apds9930ps_register(FAR const char *devpath, int minor,
|
|
FAR struct i2c_master_s *i2c, int port);
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* CONFIG_I2C && CONFIG_SENSORS_APDS9930 */
|
|
#endif /* __INCLUDE_NUTTX_SENSORS_APDS9930_H */
|