MotorWare f2806x Module API Documentation
float/pi.c
Go to the documentation of this file.
1 /* --COPYRIGHT--,BSD
2  * Copyright (c) 2014, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  * --/COPYRIGHT--*/
37 
38 
39 // **************************************************************************
40 // the includes
41 
43 
44 
45 // **************************************************************************
46 // the defines
47 
48 
49 #ifdef __TMS320C28XX_CLA__
50 #pragma CODE_SECTION(PI_init,"Cla1Prog2");
51 #endif
52 
53 
54 // **************************************************************************
55 // the globals
56 
57 
58 // **************************************************************************
59 // the functions
60 
61 PI_Handle PI_init(void *pMemory,const size_t numBytes)
62 {
63  PI_Handle handle;
64 
65 
66  if((int16_t)numBytes < (int16_t)sizeof(PI_Obj))
67  {
68  /*LDRA_INSPECTED 95 S MR12 11.3 "Below typecasting to NULL has no issues"*/
69  return((PI_Handle)NULL);
70  }
71 
72  // assign the handle
73  /*LDRA_INSPECTED 94 S MR12 11.3 "Below typecasting to void * has no issues"*/
74  /*LDRA_INSPECTED 95 S MR12 11.3 "Below typecasting to void * no issues"*/
75  handle = (PI_Handle)pMemory;
76 
77  /*LDRA_INSPECTED 71 S MR12 11.3 "Always, address of a static object is passed, so ok for wider scope"*/
78  return(handle);
79 } // end of PI_init() function
80 
81 // end of file
Defines the PI controller object.
Definition: 32b/pi.h:74
PI_Handle PI_init(void *pMemory, const size_t numBytes)
Initializes the PI controller.
Definition: float/pi.c:61
struct _PI_Obj_ * PI_Handle
Defines the PI handle.
Definition: 32b/pi.h:93
Contains the public interface to the Proportional-Integral (PI) controller module routines...