argus_dca.h File Reference

This file is part of the AFBR-S50 API. More...

#include "argus_def.h"

Include dependency graph for argus_dca.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	argus_cfg_dca_t
	Dynamic Configuration Adaption (DCA) Parameters. More...

Macros
#define	ARGUS_CFG_DCA_ATH_MIN   (1U << 6U)
#define	ARGUS_CFG_DCA_ATH_MAX   (0xFFFFU)
#define	ARGUS_CFG_DCA_PXTH_MIN   (1U)
#define	ARGUS_CFG_DCA_PXTH_MAX   (33U)
#define	ARGUS_CFG_DCA_DEPTH_MAX   ((uq10_6_t)(0xFFC0U))
#define	ARGUS_CFG_DCA_DEPTH_MIN   ((uq10_6_t)(1U))
#define	ARGUS_DCA_GAIN_STAGE_COUNT   (4U)
#define	ARGUS_STATE_DCA_GAIN_MASK   (0x03U)
#define	ARGUS_STATE_DCA_GAIN_SHIFT   (14U)
#define	ARGUS_STATE_DCA_GAIN_GET(state)    (((state) >> ARGUS_STATE_DCA_GAIN_SHIFT) & ARGUS_STATE_DCA_GAIN_MASK)
#define	ARGUS_DCA_POWER_STAGE_COUNT   (2U)
#define	ARGUS_STATE_DCA_POWER_MASK   (0x01U)
#define	ARGUS_STATE_DCA_POWER_SHIFT   (13U)
#define	ARGUS_STATE_DCA_POWER_GET(state)    (((state) >> ARGUS_STATE_DCA_POWER_SHIFT) & ARGUS_STATE_DCA_POWER_MASK)

Enumerations
enum	argus_dca_enable_t {   DCA_ENABLE_OFF = 0 ,   DCA_ENABLE_DYNAMIC = 1 ,   DCA_ENABLE_STATIC = -1 }
	The dynamic configuration algorithm enable flags. More...
enum	argus_dca_amplitude_mode_t {   DCA_AMPLITUDE_MAX = 1U ,   DCA_AMPLITUDE_AVG = 2U }
	The DCA amplitude evaluation method. More...
enum	argus_dca_power_t {   DCA_POWER_LOW = 0 ,   DCA_POWER_HIGH = 1 ,   DCA_POWER_AUTO = 2 }
	The dynamic configuration algorithm Optical Output Power stages enumerator. More...
enum	argus_dca_gain_t {   DCA_GAIN_LOW = 0 ,   DCA_GAIN_MEDIUM_LOW = 1 ,   DCA_GAIN_MEDIUM_HIGH = 2 ,   DCA_GAIN_HIGH = 3 }
	The dynamic configuration algorithm Pixel Input Gain stages enumerator. More...
enum	argus_state_t {   ARGUS_STATE_NONE = 0 ,   ARGUS_STATE_XTALK_MONITOR_ACTIVE = 1U << 0U ,   ARGUS_STATE_DUAL_FREQ_MODE = 1U << 1U ,   ARGUS_STATE_MEASUREMENT_FREQ = 1U << 2U ,   ARGUS_STATE_DEBUG_MODE = 1U << 3U ,   ARGUS_STATE_WEAK_SIGNAL = 1U << 4U ,   ARGUS_STATE_BGL_WARNING = 1U << 5U ,   ARGUS_STATE_BGL_ERROR = 1U << 6U ,   ARGUS_STATE_PLL_LOCKED = 1U << 7U ,   ARGUS_STATE_LASER_WARNING = 1U << 8U ,   ARGUS_STATE_LASER_ERROR = 1U << 9U ,   ARGUS_STATE_HAS_DATA = 1U << 10U ,   ARGUS_STATE_HAS_AUX_DATA = 1U << 11U ,   ARGUS_STATE_SATURATED_PIXELS = 1U << 12U ,   ARGUS_STATE_DCA_POWER_HIGH = DCA_POWER_HIGH << ARGUS_STATE_DCA_POWER_SHIFT ,   ARGUS_STATE_DCA_GAIN_LOW = DCA_GAIN_LOW << ARGUS_STATE_DCA_GAIN_SHIFT ,   ARGUS_STATE_DCA_GAIN_MED_LOW = DCA_GAIN_MEDIUM_LOW << ARGUS_STATE_DCA_GAIN_SHIFT ,   ARGUS_STATE_DCA_GAIN_MED_HIGH = DCA_GAIN_MEDIUM_HIGH << ARGUS_STATE_DCA_GAIN_SHIFT ,   ARGUS_STATE_DCA_GAIN_HIGH = DCA_GAIN_HIGH << ARGUS_STATE_DCA_GAIN_SHIFT ,   ARGUS_STATE_DCA_MIN = 1U << 16U ,   ARGUS_STATE_DCA_MAX = 1U << 17U ,   ARGUS_STATE_DCA_RESET = 1U << 18U }
	State flags for the current frame. More...

Detailed Description

This file is part of the AFBR-S50 API.

Defines the dynamic configuration adaption (DCA) setup parameters and data structure.

Copyright

Copyright (c) 2023, Broadcom Inc. All rights reserved.

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 of the copyright holder 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 HOLDER 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.