From 96d6da4e252b06dcfdc041e7df23e86161c33007 Mon Sep 17 00:00:00 2001 From: rihab kouki Date: Tue, 28 Jul 2020 11:24:49 +0100 Subject: Official ARM version: v5.6.0 --- DSP/Source/ControllerFunctions/arm_pid_reset_q31.c | 31 +++++++++++----------- 1 file changed, 16 insertions(+), 15 deletions(-) (limited to 'DSP/Source/ControllerFunctions/arm_pid_reset_q31.c') diff --git a/DSP/Source/ControllerFunctions/arm_pid_reset_q31.c b/DSP/Source/ControllerFunctions/arm_pid_reset_q31.c index 4c5b14e..2aa391c 100644 --- a/DSP/Source/ControllerFunctions/arm_pid_reset_q31.c +++ b/DSP/Source/ControllerFunctions/arm_pid_reset_q31.c @@ -3,13 +3,13 @@ * Title: arm_pid_reset_q31.c * Description: Q31 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 Q31 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 Q31 PID Control. + @param[in,out] S points to an instance of the Q31 PID structure + @return none + + @par Details + The function resets the state buffer to zeros. + */ + void arm_pid_reset_q31( arm_pid_instance_q31 * 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(q31_t)); } /** - * @} end of PID group + @} end of PID group */ -- cgit