Line data    Source code

       1            1 : /*
       2              :  * Copyright 2023 Google LLC
       3              :  *
       4              :  * SPDX-License-Identifier: Apache-2.0
       5              :  */
       6              : 
       7              : /**
       8              :  * @file
       9              :  * @brief Public header file for API allowing to save analog axis calibration data.
      10              :  * @ingroup input_analog_axis
      11              :  */
      12              : 
      13              : #ifndef ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_SETTINGS_H_
      14              : #define ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_SETTINGS_H_
      15              : 
      16              : #include <stdint.h>
      17              : #include <zephyr/device.h>
      18              : 
      19              : /**
      20              :  * @addtogroup input_analog_axis
      21              :  * @{
      22              :  */
      23              : 
      24              : /**
      25              :  * @brief Save the calibration data.
      26              :  *
      27              :  * Save the calibration data permanently on the specified device, requires
      28              :  * the @ref settings subsystem to be configured and initialized.
      29              :  *
      30              :  * @param dev Analog axis device.
      31              :  *
      32              :  * @retval 0 If successful.
      33              :  * @retval -errno In case of any other error.
      34              :  */
      35            1 : int analog_axis_calibration_save(const struct device *dev);
      36              : 
      37              : /** @} */
      38              : 
      39              : #endif /* ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_SETTINGS_H_ */