lib/main/CMSIS/DSP/Source/ControllerFunctions/arm_pid_reset_q31.c

   1 /* ----------------------------------------------------------------------
   2  * Project:      CMSIS DSP Library
   3  * Title:        arm_pid_reset_q31.c
   4  * Description:  Q31 PID Control reset function
   5  *
   6  * $Date:        27. January 2017
   7  * $Revision:    V.1.5.1
   8  *
   9  * Target Processor: Cortex-M cores
  10  * -------------------------------------------------------------------- */
  11 /*
  12  * Copyright (C) 2010-2017 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 "arm_math.h"
  30
  31  /**
  32  * @addtogroup PID
  33  * @{
  34  */
  35
  36 /**
  37 * @brief  Reset function for the Q31 PID Control.
  38 * @param[in] *S Instance pointer of PID control data structure.
  39 * @return none.
  40 * \par Description:
  41 * The function resets the state buffer to zeros.
  42 */
  43 void arm_pid_reset_q31(
  44   arm_pid_instance_q31 * S)
  45 {
  46
  47   /* Clear the state buffer.  The size will be always 3 samples */
  48   memset(S->state, 0, 3U * sizeof(q31_t));
  49 }
  50
  51 /**
  52  * @} end of PID group
  53  */