argus_def.h File Reference

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

#include "argus_status.h"
#include "argus_version.h"
#include "utility/fp_def.h"
#include "utility/time.h"
#include <assert.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for argus_def.h:

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

Go to the source code of this file.

Macros
#define	ARGUS_PHASECOUNT   4
	Maximum number of phases per measurement cycle.
#define	ARGUS_PIXELS_X   8
	The device pixel field size in x direction (long edge).
#define	ARGUS_PIXELS_Y   4
	The device pixel field size in y direction (short edge).
#define	ARGUS_PIXELS   ((ARGUS_PIXELS_X)*(ARGUS_PIXELS_Y))
	The total device pixel count.
#define	MODULE_EXTENDED_FLAG   (0x40U)
	A flag indicating that the device is a extended range device.

Typedefs
typedef struct argus_hnd_t	argus_hnd_t
typedef status_t(*	argus_measurement_ready_callback_t) (status_t status, argus_hnd_t *hnd)
	Measurement Ready API callback function.

Enumerations
enum	argus_module_version_t {   MODULE_NONE = 0 ,   AFBR_S50MV85G_V1 = 0x01 ,   AFBR_S50MV85G_V2 = 0x02 ,   AFBR_S50LV85D_V1 = 0x03 ,   AFBR_S50MV68B_V1 = 0x04 ,   AFBR_S50MV85I_V1 = 0x05 ,   AFBR_S50SV85K_V1 = 0x06 ,   AFBR_S50MV85G_V3 = 0x07 ,   AFBR_S50LX85D_V1 = AFBR_S50LV85D_V1 | MODULE_EXTENDED_FLAG ,   AFBR_S50MX68B_V1 = AFBR_S50MV68B_V1 | MODULE_EXTENDED_FLAG ,   AFBR_S50MX85I_V1 = AFBR_S50MV85I_V1 | MODULE_EXTENDED_FLAG ,   AFBR_S50SX85K_V1 = AFBR_S50SV85K_V1 | MODULE_EXTENDED_FLAG ,   AFBR_S50MX85G_V1 = AFBR_S50MV85G_V3 | MODULE_EXTENDED_FLAG }
	The AFBR-S50 module types. More...
enum	argus_laser_type_t {   LASER_NONE = 0 ,   LASER_H_V1 = 1 ,   LASER_H_V2 = 2 ,   LASER_R_V1 = 3 ,   LASER_H_V2X = 4 ,   LASER_R_V1X = 5 }
	The AFBR-S50 laser configurations. More...
enum	argus_chip_version_t {   ADS0032_NONE = 0 ,   ADS0032_V1A = 1 ,   ADS0032_V1B = 2 ,   ADS0032_V1C = 3 ,   ADS0032_V1D = 4 ,   ADS0032_V1E = 5 }
	The AFBR-S50 chip versions. More...
enum	argus_mode_flags_t {   ARGUS_MODE_FLAG_SHORT_RANGE = 0x01 << 0 ,   ARGUS_MODE_FLAG_LONG_RANGE = 0x01 << 1 ,   ARGUS_MODE_FLAG_HIGH_SPEED = 0x01 << 2 }
	The measurement mode flags. More...
enum	argus_mode_t {   ARGUS_MODE_SHORT_RANGE ,   ARGUS_MODE_LONG_RANGE ,   ARGUS_MODE_HIGH_SPEED_SHORT_RANGE ,   ARGUS_MODE_HIGH_SPEED_LONG_RANGE }
	The measurement modes. More...

Detailed Description

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

This file provides generic definitions belonging to all devices from the AFBR-S50 product family.

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.