MotorWare f2806x Module API Documentation
float/traj.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 // the defines
46 
47 
48 #ifdef __TMS320C28XX_CLA__
49 #pragma CODE_SECTION(TRAJ_init,"Cla1Prog2");
50 #endif
51 
52 
53 // **************************************************************************
54 // the globals
55 
56 
57 // **************************************************************************
58 // the functions
59 
60 TRAJ_Handle TRAJ_init(void *pMemory,const size_t numBytes)
61 {
62  TRAJ_Handle handle;
63 
64 
65  if((int16_t)numBytes < (int16_t)sizeof(TRAJ_Obj))
66  {
67  /*LDRA_INSPECTED 95 S MR12 11.3 "Below typecasting to NULL has no issues"*/
68  return((TRAJ_Handle)NULL);
69  }
70 
71  // assign the handle
72  /*LDRA_INSPECTED 94 S MR12 11.3 "Below typecasting to void * has no issues"*/
73  /*LDRA_INSPECTED 95 S MR12 11.3 "Below typecasting to void * no issues"*/
74  handle = (TRAJ_Handle)pMemory;
75 
76  /*LDRA_INSPECTED 71 S MR12 11.3 "Always, address of a static object is passed, so ok for wider scope"*/
77  return(handle);
78 } // end of TRAJ_init() function
79 
80 
TRAJ_Handle TRAJ_init(void *pMemory, const size_t numBytes)
Initializes the trajectory (TRAJ) object.
Definition: float/traj.c:60
Defines the trajectory (TRAJ) object.
Definition: 32b/traj.h:67
struct _TRAJ_Obj_ * TRAJ_Handle
Defines the TRAJ handle.
Definition: 32b/traj.h:79
Contains public interface to various functions related to the trajectory (TRAJ) object.