1  /* ----------------------------------------------------------------------
 2   * Project:      CMSIS DSP Library
 3   * Title:        arm_pid_reset_q31.c
 4   * Description:  Q31 PID Control reset function
 5   *
 6   * $Date:        23 April 2021
 7   * $Revision:    V1.9.0
 8   *
 9   * Target Processor: Cortex-M and Cortex-A cores
10   * -------------------------------------------------------------------- */
11  /*
12   * Copyright (C) 2010-2021 ARM Limited or its affiliates. All rights reserved.
13   *
14   * SPDX-License-Identifier: Apache-2.0
15   *
16   * Licensed under the Apache License, Version 2.0 (the License); you may
17   * not use this file except in compliance with the License.
18   * You may obtain a copy of the License at
19   *
20   * www.apache.org/licenses/LICENSE-2.0
21   *
22   * Unless required by applicable law or agreed to in writing, software
23   * distributed under the License is distributed on an AS IS BASIS, WITHOUT
24   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25   * See the License for the specific language governing permissions and
26   * limitations under the License.
27   */
28  
29  #include "dsp/controller_functions.h"
30  
31  /**
32    @addtogroup PID
33    @{
34   */
35  
36  /**
37    @brief         Reset function for the Q31 PID Control.
38    @param[in,out] S  points to an instance of the Q31 PID structure
39    @return        none
40  
41    @par           Details
42                     The function resets the state buffer to zeros.
43   */
44  
45  void arm_pid_reset_q31(
46    arm_pid_instance_q31 * S)
47  {
48    /* Reset state to zero, The size will be always 3 samples */
49    memset(S->state, 0, 3U * sizeof(q31_t));
50  }
51  
52  /**
53    @} end of PID group
54   */