feat: add basic driver for amg88xx sensor

Basic amg88xx sensor handling (open, close, read, ioctl).
No interrupts supported. I intend to add support for this feature when I
gain more know-how on nuttx/posix.
This commit is contained in:
Luchian Mihai
2024-08-02 21:48:35 +03:00
committed by Xiang Xiao
parent 882c0d0a47
commit eadc2f5690
10 changed files with 1040 additions and 0 deletions
@@ -0,0 +1,79 @@
/****************************************************************************
* boards/arm/stm32/common/include/stm32_amg88xx.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 __BOARDS_ARM_STM32_COMMON_INCLUDE_STM32_AMG88XX_H
#define __BOARDS_ARM_STM32_COMMON_INCLUDE_STM32_AMG88XX_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Public Types
****************************************************************************/
/****************************************************************************
* Public Data
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Inline Functions
****************************************************************************/
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: board_amg88xx_initialize()
*
* Description:
* Initialize and register the AMG88xx infrared matrix sensor driver.
*
* Input Parameters:
* busno - The I2C bus number
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int board_amg88xx_initialize(int busno);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __BOARDS_ARM_STM32_COMMON_INCLUDE_STM32_AMG88XX_H */
@@ -128,6 +128,10 @@ if(CONFIG_CL_MFRC522)
list(APPEND SRCS stm32_mfrc522.c)
endif()
if(CONFIG_SENSORS_AMG88XX)
list(APPEND SRCS stm32_amg88xx.c)
endif()
if(CONFIG_LIS3DSH)
list(APPEND SRCS stm32_lis3dsh.c)
endif()
+4
View File
@@ -136,6 +136,10 @@ ifeq ($(CONFIG_CL_MFRC522),y)
CSRCS += stm32_mfrc522.c
endif
ifeq ($(CONFIG_SENSORS_AMG88XX),y)
CSRCS+= stm32_amg88xx.c
endif
ifeq ($(CONFIG_LIS3DSH),y)
CSRCS += stm32_lis3dsh.c
endif
+120
View File
@@ -0,0 +1,120 @@
/****************************************************************************
* boards/arm/stm32/common/src/stm32_amg88xx.c
*
* 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.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/i2c/i2c_master.h>
#include <nuttx/sensors/amg88xx.h>
#include <arch/board/board.h>
#include "stm32.h"
#include "stm32_i2c.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* What is the point of passing devno if only
* a single config struct is defined
* irm = infrared map / infrared matrix
*/
#define AMG88XX_DEVNO_PATH_0 "/dev/irm0"
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
/****************************************************************************
* Private Data
****************************************************************************/
/* One sensor connected to the board */
/* During device registration OS allocates an pointer to an amg88xx_config_s
* not the actual struct, that implies that for each sensor there is the
* need for a config struct at a valid memory location which will be passed
* to the pointer mentioned above. So there can be only one sensor,
* as there is one global config struct instantiated here.
* Is this the intended behaviour to minimize the memory allocated through
* malloc?
*/
static struct amg88xx_config_s g_amg88xx_config_0 =
{
.addr = CONFIG_SENSOR_AMG88XX_ADDR,
.speed = I2C_SPEED_STANDARD
};
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: board_amg88xx_initialize()
*
* Description:
* Initialize and register the AMG88xx infrared matrix sensor driver.
*
* Input Parameters:
* busno - The I2C bus number
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int board_amg88xx_initialize(int busno)
{
struct i2c_master_s *i2c;
int ret;
sninfo("Initializing AMG88xx!\n");
/* Initialize I2C */
i2c = stm32_i2cbus_initialize(busno);
if (!i2c)
{
return -ENODEV;
}
/* Then register the sensor */
ret = amg88xx_register(AMG88XX_DEVNO_PATH_0, i2c, &g_amg88xx_config_0);
if (ret < 0)
{
syslog(LOG_ERR, "ERROR: Error registering AMG88xx\n");
}
return ret;
}
@@ -35,6 +35,50 @@
#include "stm32_romfs.h"
#endif
#ifdef CONFIG_SENSORS_AMG88XX
#include "stm32_amg88xx.h"
#endif
#if defined(CONFIG_I2C) && defined(CONFIG_SYSTEM_I2CTOOL)
# include "stm32_i2c.h"
#endif
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: stm32_i2c_register
*
* Description:
* Register one I2C drivers for the I2C tool.
*
****************************************************************************/
#if defined(CONFIG_I2C) && defined(CONFIG_SYSTEM_I2CTOOL)
static void stm32_i2c_register(int bus)
{
struct i2c_master_s *i2c;
int ret;
i2c = stm32_i2cbus_initialize(bus);
if (i2c == NULL)
{
syslog(LOG_ERR, "ERROR: Failed to get I2C%d interface\n", bus);
}
else
{
ret = i2c_register(i2c, bus);
if (ret < 0)
{
syslog(LOG_ERR, "ERROR: Failed to register I2C%d driver: %d\n",
bus, ret);
stm32_i2cbus_uninitialize(i2c);
}
}
}
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
@@ -167,6 +211,14 @@ int board_app_initialize(uintptr_t arg)
}
#endif
#if defined(CONFIG_I2C) && defined(CONFIG_SYSTEM_I2CTOOL)
stm32_i2c_register(1);
#endif
#ifdef CONFIG_SENSORS_AMG88XX
board_amg88xx_initialize(1);
#endif
UNUSED(ret);
return OK;
}
+4
View File
@@ -284,6 +284,10 @@ if(CONFIG_SENSORS)
list(APPEND SRCS bmm150_uorb.c)
endif()
if(CONFIG_SENSORS_AMG88XX)
list(APPEND SRCS amg88xx.c)
endif()
endif() # CONFIG_I2C
# These drivers depend on SPI support
+32
View File
@@ -1717,4 +1717,36 @@ config SENSORS_LTR308_THREAD_STACKSIZE
endif # SENSORS_LTR308
config SENSORS_AMG88XX
bool "AMG88xx infrared array sensor"
default n
select I2C
---help---
Enable driver support for AMG88xx infrared array sensor.
if SENSORS_AMG88XX
choice
prompt "AMG88xx AD_SELECT value"
default SENSOR_AMG88XX_AD_SELECT_0
---help---
AD SELECT sets the amg88xx i2c address
AD_SELECT tied to GND -> sensor address 0x68
AD_SELECT tied to VCC -> sensor address 0x69
config SENSOR_AMG88XX_AD_SELECT_0
bool "AD_SELECT tied to GND"
config SENSOR_AMG88XX_AD_SELECT_1
bool "AD_SELECT tied to VCC"
endchoice
config SENSOR_AMG88XX_ADDR
hex
default 0x68 if SENSOR_AMG88XX_AD_SELECT_0
default 0x69 if SENSOR_AMG88XX_AD_SELECT_1
endif # SENSORS_AMG88XX
endif # SENSORS
File diff suppressed because it is too large Load Diff
+105
View File
@@ -0,0 +1,105 @@
/****************************************************************************
* include/nuttx/sensors/amg88xx.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_AMG88XX_H
#define __INCLUDE_NUTTX_SENSORS_AMG88XX_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <nuttx/i2c/i2c_master.h>
#include <stdint.h>
#include <stdbool.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#define AMG88XX_PIXELS (64) /* hex 0x40 */
#define AMG88XX_PIXELS_ARRAY_LENGTH (127)
#define AMG88XX_THERMISTOR_RESOLUTION (0.0625)
#define AMG88XX_THERMISTOR_MAX_VALUE (0x7FF) /* +127.9375 *c */
#define AMG88XX_THERMISTOR_MIN_VALUE (0xBBB) /* -59.6875 *c */
#define AMG88XX_PIXEL_RESOLUTION (0.25)
#define AMG88XX_PIXEL_MAX_VALUE (0x1F4) /* +125 *c */
#define AMG88XX_PIXEL_MIN_VALUE (0xF24) /* -55 *c */
/****************************************************************************
* Public Types
****************************************************************************/
/* Data returned by sensor read typedef */
typedef uint8_t amg88xx_pixels_temp_t[AMG88XX_PIXELS_ARRAY_LENGTH];
/* Typedef used to interact with ioctl syscall to set sensor operation mode */
typedef enum
{
op_mode_normal = 0,
op_mode_sleep = 1
} amg88xx_operation_mode_e;
/* Typedef used to interact with ioctl syscall to set sensor fps */
typedef enum
{
fps_one = 0,
fps_ten = 1
} amg88xx_fps_e;
/* Runtime configuration struct sent to the sensor driver */
struct amg88xx_config_s
{
uint8_t addr;
uint32_t speed;
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: amg88xx_register
*
* Description:
* Register the amg88xx character device as 'devpath'
*
* Input Parameters:
* devpath - The full path to the driver to register. E.g., "/dev/irm0"
* i2c - An instance of the I2C interface to use to communicate with
* AMG88xx
* config - Initial configuration of the sensor
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int amg88xx_register(FAR const char *devpath,
FAR struct i2c_master_s *i2c,
FAR struct amg88xx_config_s *config);
#endif /* __INCLUDE_NUTTX_SENSORS_AMG88XX_H */
+22
View File
@@ -240,6 +240,28 @@
#define SNIOC_FEAT_MANAGE _SNIOC(0x006b) /* Feature manage command */
#define SNIOC_SET_SCALE_XL _SNIOC(0x006c) /* Set accelerator scale command */
/* IOCTL commands unique to AMG88xx */
/* Command: SNIOC_SET_OPERATIONAL_MODE
* Description: Control power mode: Normal / Sleep
* Reuse from ISL29023
* Arg: amg88xx_operation_mode_e pointer
*/
/* Command: SNIOC_SET_FRAMERATE
* Description: Set the framerate of the sensor
* Arg: amg88xx_fps_e
*/
#define SNIOC_SET_FRAMERATE _SNIOC(0x006d)
/* Command: SNIOC_SET_MOVING_AVG
* Description: Toggle moving average mode
* Arg: bool
*/
#define SNIOC_SET_MOVING_AVG _SNIOC(0x006e)
/* Command: SNIOC_GET_STATE
* Description: Get state for all subscribers, include min_interval,
* min_latency and the number of subscribers.