121 lines
4.4 KiB
C
121 lines
4.4 KiB
C
/****************************************************************************
|
|
* include/nuttx/sensors/mb7040.h
|
|
*
|
|
* Copyright (C) 2015 Omni Hoverboards Inc. All rights reserved.
|
|
* Author: Paul Alexander Patience <paul-a.patience@polymtl.ca>
|
|
*
|
|
* 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_SENSORS_MB7040
|
|
#define __INCLUDE_NUTTX_SENSORS_MB7040
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#include <nuttx/fs/ioctl.h>
|
|
|
|
#if defined(CONFIG_I2C) && defined(CONFIG_MB7040)
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
/* Configuration ************************************************************
|
|
* Prerequisites:
|
|
*
|
|
* CONFIG_I2C
|
|
* Enables support for I2C drivers
|
|
* CONFIG_MB7040
|
|
* Enables support for the MB7040 driver
|
|
*/
|
|
|
|
/* IOCTL Commands ***********************************************************/
|
|
|
|
#define SNIOC_MEASURE _SNIOC(0x0001) /* Arg: None */
|
|
#define SNIOC_RANGE _SNIOC(0x0002) /* Arg: int32_t* pointer */
|
|
#define SNIOC_CHANGEADDR _SNIOC(0x0003) /* Arg: uint8_t value */
|
|
|
|
/* I2C Addresses ************************************************************/
|
|
|
|
#define MB7040_DEFAULTADDR 0x70 /* Default I2C Address */
|
|
|
|
/* Register Definitions *****************************************************/
|
|
/* Register Addresses */
|
|
|
|
#define MB7040_RANGE_REG 0x51
|
|
#define MB7040_ADDRUNLOCK1_REG 0xaa
|
|
#define MB7040_ADDRUNLOCK2_REG 0xa5
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
struct i2c_master_s;
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: mb7040_register
|
|
*
|
|
* Description:
|
|
* Register the MB7040 character device as 'devpath'
|
|
*
|
|
* Input Parameters:
|
|
* devpath - The full path to the driver to register, e.g., "/dev/sonar0".
|
|
* i2c - An I2C driver instance.
|
|
* addr - The I2C address of the MB7040.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) on success; a negated errno value on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int mb7040_register(FAR const char *devpath, FAR struct i2c_master_s *i2c,
|
|
uint8_t addr);
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* CONFIG_I2C && CONFIG_MB7040 */
|
|
#endif /* __INCLUDE_NUTTX_SENSORS_MB7040 */
|