Laxmi Kant Tiwari / mbed-dsp

CMSIS DSP Lib

Fork of mbed-dsp by mbed official

cmsis_dsp/ControllerFunctions/arm_pid_init_f32.c@2:da51fb522205, 2013-05-30 (annotated)

Committer:
emilmont
Date:
Thu May 30 17:10:11 2013 +0100
Revision:
2:da51fb522205
Parent:
1:fdd22bb7aa52
Child:
3:7a284390b0ce
Keep "cmsis-dsp" module in synch with its source

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 1:fdd22bb7aa52 1 /* ----------------------------------------------------------------------
emilmont 1:fdd22bb7aa52 2 * Copyright (C) 2010 ARM Limited. All rights reserved.
emilmont 1:fdd22bb7aa52 3 *
emilmont 1:fdd22bb7aa52 4 * $Date: 15. February 2012
emilmont 2:da51fb522205 5 * $Revision: V1.1.0
emilmont 1:fdd22bb7aa52 6 *
emilmont 2:da51fb522205 7 * Project: CMSIS DSP Library
emilmont 2:da51fb522205 8 * Title: arm_pid_init_f32.c
emilmont 1:fdd22bb7aa52 9 *
emilmont 2:da51fb522205 10 * Description: Floating-point PID Control initialization function
emilmont 2:da51fb522205 11 *
emilmont 1:fdd22bb7aa52 12 *
emilmont 1:fdd22bb7aa52 13 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
emilmont 1:fdd22bb7aa52 14 *
emilmont 1:fdd22bb7aa52 15 * Version 1.1.0 2012/02/15
emilmont 1:fdd22bb7aa52 16 * Updated with more optimizations, bug fixes and minor API changes.
emilmont 1:fdd22bb7aa52 17 *
emilmont 1:fdd22bb7aa52 18 * Version 1.0.10 2011/7/15
emilmont 1:fdd22bb7aa52 19 * Big Endian support added and Merged M0 and M3/M4 Source code.
emilmont 1:fdd22bb7aa52 20 *
emilmont 1:fdd22bb7aa52 21 * Version 1.0.3 2010/11/29
emilmont 1:fdd22bb7aa52 22 * Re-organized the CMSIS folders and updated documentation.
emilmont 1:fdd22bb7aa52 23 *
emilmont 1:fdd22bb7aa52 24 * Version 1.0.2 2010/11/11
emilmont 1:fdd22bb7aa52 25 * Documentation updated.
emilmont 1:fdd22bb7aa52 26 *
emilmont 1:fdd22bb7aa52 27 * Version 1.0.1 2010/10/05
emilmont 1:fdd22bb7aa52 28 * Production release and review comments incorporated.
emilmont 1:fdd22bb7aa52 29 *
emilmont 1:fdd22bb7aa52 30 * Version 1.0.0 2010/09/20
emilmont 1:fdd22bb7aa52 31 * Production release and review comments incorporated.
emilmont 1:fdd22bb7aa52 32 * ------------------------------------------------------------------- */
emilmont 1:fdd22bb7aa52 33
emilmont 1:fdd22bb7aa52 34 #include "arm_math.h"
emilmont 1:fdd22bb7aa52 35
emilmont 1:fdd22bb7aa52 36 /**
emilmont 1:fdd22bb7aa52 37 * @addtogroup PID
emilmont 1:fdd22bb7aa52 38 * @{
emilmont 1:fdd22bb7aa52 39 */
emilmont 1:fdd22bb7aa52 40
emilmont 1:fdd22bb7aa52 41 /**
emilmont 1:fdd22bb7aa52 42 * @brief Initialization function for the floating-point PID Control.
emilmont 1:fdd22bb7aa52 43 * @param[in,out] *S points to an instance of the PID structure.
emilmont 1:fdd22bb7aa52 44 * @param[in] resetStateFlag flag to reset the state. 0 = no change in state & 1 = reset the state.
emilmont 1:fdd22bb7aa52 45 * @return none.
emilmont 1:fdd22bb7aa52 46 * \par Description:
emilmont 1:fdd22bb7aa52 47 * \par
emilmont 1:fdd22bb7aa52 48 * The <code>resetStateFlag</code> specifies whether to set state to zero or not. \n
emilmont 1:fdd22bb7aa52 49 * The function computes the structure fields: <code>A0</code>, <code>A1</code> <code>A2</code>
emilmont 1:fdd22bb7aa52 50 * using the proportional gain( \c Kp), integral gain( \c Ki) and derivative gain( \c Kd)
emilmont 1:fdd22bb7aa52 51 * also sets the state variables to all zeros.
emilmont 1:fdd22bb7aa52 52 */
emilmont 1:fdd22bb7aa52 53
emilmont 1:fdd22bb7aa52 54 void arm_pid_init_f32(
emilmont 1:fdd22bb7aa52 55 arm_pid_instance_f32 * S,
emilmont 1:fdd22bb7aa52 56 int32_t resetStateFlag)
emilmont 1:fdd22bb7aa52 57 {
emilmont 1:fdd22bb7aa52 58
emilmont 1:fdd22bb7aa52 59 /* Derived coefficient A0 */
emilmont 1:fdd22bb7aa52 60 S->A0 = S->Kp + S->Ki + S->Kd;
emilmont 1:fdd22bb7aa52 61
emilmont 1:fdd22bb7aa52 62 /* Derived coefficient A1 */
emilmont 1:fdd22bb7aa52 63 S->A1 = (-S->Kp) - ((float32_t) 2.0 * S->Kd);
emilmont 1:fdd22bb7aa52 64
emilmont 1:fdd22bb7aa52 65 /* Derived coefficient A2 */
emilmont 1:fdd22bb7aa52 66 S->A2 = S->Kd;
emilmont 1:fdd22bb7aa52 67
emilmont 1:fdd22bb7aa52 68 /* Check whether state needs reset or not */
emilmont 1:fdd22bb7aa52 69 if(resetStateFlag)
emilmont 1:fdd22bb7aa52 70 {
emilmont 1:fdd22bb7aa52 71 /* Clear the state buffer. The size will be always 3 samples */
emilmont 1:fdd22bb7aa52 72 memset(S->state, 0, 3u * sizeof(float32_t));
emilmont 1:fdd22bb7aa52 73 }
emilmont 1:fdd22bb7aa52 74
emilmont 1:fdd22bb7aa52 75 }
emilmont 1:fdd22bb7aa52 76
emilmont 1:fdd22bb7aa52 77 /**
emilmont 1:fdd22bb7aa52 78 * @} end of PID group
emilmont 1:fdd22bb7aa52 79 */