diff options
Diffstat (limited to 'zephyr/include/emul/emul_tcs3400.h')
| -rw-r--r-- | zephyr/include/emul/emul_tcs3400.h | 156 |
1 files changed, 0 insertions, 156 deletions
diff --git a/zephyr/include/emul/emul_tcs3400.h b/zephyr/include/emul/emul_tcs3400.h deleted file mode 100644 index 49ec382a66..0000000000 --- a/zephyr/include/emul/emul_tcs3400.h +++ /dev/null @@ -1,156 +0,0 @@ -/* Copyright 2021 The Chromium OS Authors. All rights reserved. - * Use of this source code is governed by a BSD-style license that can be - * found in the LICENSE file. - */ - -/** - * @file - * - * @brief Backend API for TCS3400 emulator - */ - -#ifndef __EMUL_TCS3400_H -#define __EMUL_TCS3400_H - -#include <emul.h> -#include <drivers/i2c.h> -#include <drivers/i2c_emul.h> - -/** - * @brief TCS3400 emulator backend API - * @defgroup tcs_emul TCS3400 emulator - * @{ - * - * TCS3400 emulator supports responses to all write and read I2C messages. - * Light sensor data registers are obtained from internal emulator state, gain - * and acquisition time. Application may alter emulator state: - * - * - define a devicetree overlay file to set which inadvisable driver behaviour - * should be treated as error and emulated device ID and revision - * - call @ref tcs_emul_set_reg and @ref tcs_emul_get_reg to set and get value - * of TCS3400 registers - * - call @ref tcs_emul_set_val and @ref tcs_emul_set_val to set and get - * light sensor value - * - call tcs_emul_set_err_* to change emulator behaviour on inadvisable driver - * behaviour - * - call functions from emul_common_i2c.h to setup custom handlers for I2C - * messages - */ - -/** - * Maximum number of integration cycles (when ATIME is zero). Value read from - * sensor is proportional to number of integration cycles, e.g. with constant - * light, value obtainded with 128 cycles will be two times smaller than value - * obtained with 256 cycles. - */ -#define TCS_EMUL_MAX_CYCLES 256 -/** - * Maximum gain supported by TCS3400. Value read from sensor is multiplied by - * gain selected in CONTROL register. - */ -#define TCS_EMUL_MAX_GAIN 64 - -/** - * Emulator units are value returned with gain x64 and 256 integration cycles. - * Max value is 1024 returned when gain is x1 and 1 integration cycle. Max value - * represented in emulator units is 1024 * 64 * 256 - */ -#define TCS_EMUL_MAX_VALUE (1024 * TCS_EMUL_MAX_GAIN * TCS_EMUL_MAX_CYCLES) - -/** Axis argument used in @ref tcs_emul_set_val @ref tcs_emul_get_val */ -enum tcs_emul_axis { - TCS_EMUL_R, - TCS_EMUL_G, - TCS_EMUL_B, - TCS_EMUL_C, - TCS_EMUL_IR, -}; - -/** - * Emulator saves only those registers in memory. IR select is stored sparately - * and other registers are write only. - */ -#define TCS_EMUL_FIRST_REG TCS_I2C_ENABLE -#define TCS_EMUL_LAST_REG TCS_I2C_BDATAH -#define TCS_EMUL_REG_COUNT (TCS_EMUL_LAST_REG - TCS_EMUL_FIRST_REG + 1) - -/** - * @brief Get pointer to TCS3400 emulator using device tree order number. - * - * @param ord Device tree order number obtained from DT_DEP_ORD macro - * - * @return Pointer to TCS3400 emulator - */ -struct i2c_emul *tcs_emul_get(int ord); - -/** - * @brief Set value of given register of TCS3400 - * - * @param emul Pointer to TCS3400 emulator - * @param reg Register address which value will be changed - * @param val New value of the register - */ -void tcs_emul_set_reg(struct i2c_emul *emul, int reg, uint8_t val); - -/** - * @brief Get value of given register of TCS3400 - * - * @param emul Pointer to TCS3400 emulator - * @param reg Register address - * - * @return Value of the register - */ -uint8_t tcs_emul_get_reg(struct i2c_emul *emul, int reg); - -/** - * @brief Get internal value of light sensor for given axis - * - * @param emul Pointer to TCS3400 emulator - * @param axis Axis to access - * - * @return Value of given axis with gain x64 and 256 integration cycles - */ -int tcs_emul_get_val(struct i2c_emul *emul, enum tcs_emul_axis axis); - -/** - * @brief Set internal value of light sensor for given axis - * - * @param emul Pointer to TCS3400 emulator - * @param axis Axis to access - * @param val New value of light sensor for given axis with gain x64 and - * 256 integration cycles - */ -void tcs_emul_set_val(struct i2c_emul *emul, enum tcs_emul_axis axis, int val); - -/** - * @brief Set if error should be generated when read only register is being - * written - * - * @param emul Pointer to TCS3400 emulator - * @param set Check for this error - */ -void tcs_emul_set_err_on_ro_write(struct i2c_emul *emul, bool set); - -/** - * @brief Set if error should be generated when reserved bits of register are - * not set to 0 on write I2C message - * - * @param emul Pointer to TCS3400 emulator - * @param set Check for this error - */ -void tcs_emul_set_err_on_rsvd_write(struct i2c_emul *emul, bool set); - -/** - * @brief Set if error should be generated when MSB register is accessed before - * LSB register - * - * @param emul Pointer to TCS3400 emulator - * @param set Check for this error - */ -void tcs_emul_set_err_on_msb_first(struct i2c_emul *emul, bool set); - -/** - * @} - */ - -#endif /* __EMUL_TCS3400_H */ |