ADPD188 driver implementation. More...

#include <stdlib.h>
#include "adpd188.h"
#include "no_os_error.h"
#include "no_os_delay.h"
#include "no_os_alloc.h"

Include dependency graph for adpd188.c:

Functions
int32_t	adpd188_init (struct adpd188_dev *device, struct adpd188_init_param init_param)
	Initialize the ADPD188 driver. More...

int32_t	adpd188_remove (struct adpd188_dev *dev)
	Free resources allocated by adpd188_init(). More...

int32_t	adpd188_reg_read (struct adpd188_dev dev, uint8_t reg_addr, uint16_t reg_val)
	Read one 16 bit register of the ADPD188. More...

int32_t	adpd188_reg_write (struct adpd188_dev *dev, uint8_t reg_addr, uint16_t reg_val)
	Write one 16 bit register of the ADPD188. More...

int32_t	adpd188_mode_get (struct adpd188_dev dev, enum adpd188_mode mode)
	Get the mode of operation of the ADPD188. More...

int32_t	adpd188_mode_set (struct adpd188_dev *dev, enum adpd188_mode new_mode)
	Set the mode of operation of the ADPD188. More...

int32_t	adpd188_fifo_status_get (struct adpd188_dev dev, uint8_t bytes_no)
	Get the number of bytes currently present in FIFO. More...

int32_t	adpd188_fifo_clear (struct adpd188_dev *dev)
	Empty the FIFO. More...

int32_t	adpd188_fifo_thresh_set (struct adpd188_dev *dev, uint8_t word_no)
	Set the number of 16 bit words that need to be in the FIFO to trigger an interrupt. More...

int32_t	adpd188_interrupt_get (struct adpd188_dev dev, uint8_t flags)
	Get the slot and FIFO interrupt flags. More...

int32_t	adpd188_interrupt_clear (struct adpd188_dev *dev, uint8_t flags)
	Clear the slot and FIFO interrupt flags. More...

int32_t	adpd188_interrupt_en (struct adpd188_dev *dev, uint8_t flags)
	Enable the slot and FIFO interrupt flags. More...

int32_t	adpd188_gpio_setup (struct adpd188_dev *dev, struct adpd188_gpio_config config)
	Setup drive and polarity of the GPIOs. Also enable GPIO if necessary. More...

int32_t	adpd188_gpio_alt_setup (struct adpd188_dev *dev, uint8_t gpio_id, enum adpd188_gpio_alt_config config)
	Setup the GPIO source. More...

int32_t	adpd188_sw_reset (struct adpd188_dev *dev)
	Do software reset of the device. More...

int32_t	adpd188_clk32mhz_cal (struct adpd188_dev *dev)
	Do internal 32MHz clock calibration. This calibration requires the 32kHz clock to be calibrated first. The 32kHz calibration needs an external reference. More...

int32_t	adpd188_slot_setup (struct adpd188_dev *dev, struct adpd188_slot_config config)
	Enable slot and setup its FIFO interaction. More...

int32_t	adpd188_adc_fsample_set (struct adpd188_dev *dev, uint16_t freq_hz)
	Set sample frequency of the ADC. More...

int32_t	adpd188_adc_fsample_get (struct adpd188_dev dev, uint16_t freq_hz)
	Get sample frequency of the ADC. More...

int32_t	adpd188_smoke_detect_setup (struct adpd188_dev *dev)
	Do initial configuration of the device to use as a smoke detector. The configuration is described in the datasheet. More...

Detailed Description

ADPD188 driver implementation.

Author: Andrei Drimbarean (Andre.nosp@m.i.Dr.nosp@m.imbar.nosp@m.ean@.nosp@m.analo.nosp@m.g.co.nosp@m.m)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.

Function Documentation

◆ adpd188_adc_fsample_get()

int32_t adpd188_adc_fsample_get	(	struct adpd188_dev *	dev,
		uint16_t *	freq_hz
	)

Get sample frequency of the ADC.

Parameters

dev	- The ADPD188 descriptor.
freq_hz	- ADC sample frequency.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_adc_fsample_set()

int32_t adpd188_adc_fsample_set	(	struct adpd188_dev *	dev,
		uint16_t	freq_hz
	)

Set sample frequency of the ADC.

Parameters

dev	- The ADPD188 descriptor.
freq_hz	- Desired ADC sample frequency.

Returns: 0 in case of success, -1 otherwise.

Here is the caller graph for this function:

◆ adpd188_clk32mhz_cal()

int32_t adpd188_clk32mhz_cal ( struct adpd188_dev * dev )

Do internal 32MHz clock calibration. This calibration requires the 32kHz clock to be calibrated first. The 32kHz calibration needs an external reference.

Parameters

dev	- The ADPD188 descriptor.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_fifo_clear()

int32_t adpd188_fifo_clear ( struct adpd188_dev * dev )

Empty the FIFO.

Parameters

dev	- The ADPD188 descriptor.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_fifo_status_get()

int32_t adpd188_fifo_status_get	(	struct adpd188_dev *	dev,
		uint8_t *	bytes_no
	)

Get the number of bytes currently present in FIFO.

Parameters

dev	- The ADPD188 descriptor.
bytes_no	- Number of bytes in the FIFO.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_fifo_thresh_set()

int32_t adpd188_fifo_thresh_set	(	struct adpd188_dev *	dev,
		uint8_t	word_no
	)

Set the number of 16 bit words that need to be in the FIFO to trigger an interrupt.

Parameters

dev	- The ADPD188 descriptor.
word_no	- Number of words that trigger an interrupt.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_gpio_alt_setup()

int32_t adpd188_gpio_alt_setup	(	struct adpd188_dev *	dev,
		uint8_t	gpio_id,
		enum adpd188_gpio_alt_config	config
	)

Setup the GPIO source.

Parameters

dev	- The ADPD188 descriptor.
gpio_id	- ID of the GPIO (0 or 1).
config	- ID of the source of the GPIO.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_gpio_setup()

int32_t adpd188_gpio_setup	(	struct adpd188_dev *	dev,
		struct adpd188_gpio_config	config
	)

Setup drive and polarity of the GPIOs. Also enable GPIO if necessary.

Parameters

dev	- The ADPD188 descriptor.
config	- Configuration structure of the GPIO.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_init()

int32_t adpd188_init	(	struct adpd188_dev **	device,
		struct adpd188_init_param *	init_param
	)

Initialize the ADPD188 driver.

Parameters

device	- The ADPD188 descriptor.
init_param	- The structure that contains the ADPD188 initialization parameters.

Returns: 0 in case of success, -1 otherwise.

Here is the caller graph for this function:

◆ adpd188_interrupt_clear()

int32_t adpd188_interrupt_clear	(	struct adpd188_dev *	dev,
		uint8_t	flags
	)

Clear the slot and FIFO interrupt flags.

Parameters

dev	- The ADPD188 descriptor.
flags	- The ORed value of the flags that need to be cleared. If no interrupt needs to be cleared the value will be zero. Otherwise do a logical OR between the flags that need to be cleared: ADPD188_SLOTA_INT; ADPD188_SLOTB_INT; ADPD188_FIFO_INT.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_interrupt_en()

int32_t adpd188_interrupt_en	(	struct adpd188_dev *	dev,
		uint8_t	flags
	)

Enable the slot and FIFO interrupt flags.

Parameters

dev	- The ADPD188 descriptor.
flags	- The ORed value of the flags that need to be enabled. If no interrupt needs to be enabled the value will be zero. Otherwise do a logical OR between the flags that need to be enabled: ADPD188_SLOTA_INT; ADPD188_SLOTB_INT; ADPD188_FIFO_INT.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_interrupt_get()

int32_t adpd188_interrupt_get	(	struct adpd188_dev *	dev,
		uint8_t *	flags
	)

Get the slot and FIFO interrupt flags.

Parameters

dev	- The ADPD188 descriptor.
flags	- The ORed value of the flags. If no interrupt has triggered the value will be zero. Otherwise it can be a logical OR between: ADPD188_SLOTA_INT; ADPD188_SLOTB_INT; ADPD188_FIFO_INT.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_mode_get()

int32_t adpd188_mode_get	(	struct adpd188_dev *	dev,
		enum adpd188_mode *	mode
	)

Get the mode of operation of the ADPD188.

Parameters

dev	- The ADPD188 descriptor.
mode	- The cur mode of operation. Values can be: ADPD188_STANDBY; ADPD188_PROGRAM; ADPD188_NORMAL.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_mode_set()

int32_t adpd188_mode_set	(	struct adpd188_dev *	dev,
		enum adpd188_mode	new_mode
	)

Set the mode of operation of the ADPD188.

Parameters

dev	- The ADPD188 descriptor.
new_mode	- The new mode of operation. Values can be: ADPD188_STANDBY; ADPD188_PROGRAM; ADPD188_NORMAL.

Returns: 0 in case of success, -1 otherwise.

Here is the caller graph for this function:

◆ adpd188_reg_read()

int32_t adpd188_reg_read	(	struct adpd188_dev *	dev,
		uint8_t	reg_addr,
		uint16_t *	reg_val
	)

Read one 16 bit register of the ADPD188.

Parameters

dev	- The ADPD188 descriptor.
reg_addr	- The register address.
reg_val	- Value of the read register.

Returns: 0 in case of success, -1 otherwise.

Store read values starting with the second place in the buffer to have the value in the same spaces as in the SPI case. This way the register value can be compiled only once outside the if clause.

Here is the caller graph for this function:

◆ adpd188_reg_write()

int32_t adpd188_reg_write	(	struct adpd188_dev *	dev,
		uint8_t	reg_addr,
		uint16_t	reg_val
	)

Write one 16 bit register of the ADPD188.

Parameters

dev	- The ADPD188 descriptor.
reg_addr	- The register address.
reg_val	- The new value of the register.

Returns: 0 in case of success, -1 otherwise.

Here is the caller graph for this function:

◆ adpd188_remove()

int32_t adpd188_remove ( struct adpd188_dev * dev )

Free resources allocated by adpd188_init().

Parameters

dev	- The ADPD188 descriptor.

Returns: 0 in case of success, -1 otherwise.

Here is the caller graph for this function:

◆ adpd188_slot_setup()

int32_t adpd188_slot_setup	(	struct adpd188_dev *	dev,
		struct adpd188_slot_config	config
	)

Enable slot and setup its FIFO interaction.

Parameters

dev	- The ADPD188 descriptor.
config	- Configuration structure for the slot.

Returns: 0 in case of success, -1 otherwise.

Here is the caller graph for this function:

◆ adpd188_smoke_detect_setup()

int32_t adpd188_smoke_detect_setup ( struct adpd188_dev * dev )

Do initial configuration of the device to use as a smoke detector. The configuration is described in the datasheet.

Parameters

dev	- The ADPD188 descriptor.

Returns: 0 in case of success, -1 otherwise.

◆ adpd188_sw_reset()

int32_t adpd188_sw_reset ( struct adpd188_dev * dev )

Do software reset of the device.

Parameters

dev	- The ADPD188 descriptor.

Returns: 0 in case of success, -1 otherwise.

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ adpd188_adc_fsample_get()

◆ adpd188_adc_fsample_set()

◆ adpd188_clk32mhz_cal()

◆ adpd188_fifo_clear()

◆ adpd188_fifo_status_get()

◆ adpd188_fifo_thresh_set()

◆ adpd188_gpio_alt_setup()

◆ adpd188_gpio_setup()

◆ adpd188_init()

◆ adpd188_interrupt_clear()

◆ adpd188_interrupt_en()

◆ adpd188_interrupt_get()

◆ adpd188_mode_get()

◆ adpd188_mode_set()

◆ adpd188_reg_read()

◆ adpd188_reg_write()

◆ adpd188_remove()

◆ adpd188_slot_setup()

◆ adpd188_smoke_detect_setup()

◆ adpd188_sw_reset()