diff options
Diffstat (limited to 'Drivers/CMSIS/DSP/Source/ControllerFunctions/arm_pid_reset_f32.c')
| -rw-r--r-- | Drivers/CMSIS/DSP/Source/ControllerFunctions/arm_pid_reset_f32.c | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/Drivers/CMSIS/DSP/Source/ControllerFunctions/arm_pid_reset_f32.c b/Drivers/CMSIS/DSP/Source/ControllerFunctions/arm_pid_reset_f32.c index 318ec8947..d839e55ea 100644 --- a/Drivers/CMSIS/DSP/Source/ControllerFunctions/arm_pid_reset_f32.c +++ b/Drivers/CMSIS/DSP/Source/ControllerFunctions/arm_pid_reset_f32.c @@ -3,13 +3,13 @@ * Title: arm_pid_reset_f32.c * Description: Floating-point PID Control reset function * - * $Date: 27. January 2017 - * $Revision: V.1.5.1 + * $Date: 18. March 2019 + * $Revision: V1.6.0 * * Target Processor: Cortex-M cores * -------------------------------------------------------------------- */ /* - * Copyright (C) 2010-2017 ARM Limited or its affiliates. All rights reserved. + * Copyright (C) 2010-2019 ARM Limited or its affiliates. All rights reserved. * * SPDX-License-Identifier: Apache-2.0 * @@ -28,26 +28,27 @@ #include "arm_math.h" - /** - * @addtogroup PID - * @{ +/** + @addtogroup PID + @{ */ /** -* @brief Reset function for the floating-point PID Control. -* @param[in] *S Instance pointer of PID control data structure. -* @return none. -* \par Description: -* The function resets the state buffer to zeros. -*/ + @brief Reset function for the floating-point PID Control. + @param[in,out] S points to an instance of the floating-point PID structure + @return none + + @par Details + The function resets the state buffer to zeros. + */ + void arm_pid_reset_f32( arm_pid_instance_f32 * S) { - - /* Clear the state buffer. The size will be always 3 samples */ + /* Reset state to zero, The size will be always 3 samples */ memset(S->state, 0, 3U * sizeof(float32_t)); } /** - * @} end of PID group + @} end of PID group */ |