AM263x Motor Control SDK  09.02.00
dcl.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2024 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * 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
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef _DCL_H_
34 #define _DCL_H_
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
61 #define DCL_VERSION 4020000
64 
67 //#define DCL_VOLATILE_ENABLED
68 
73 //#define DCL_ERROR_HANDLING_ENABLED
74 
78 //#define DCL_TESTPOINTS_ENABLED
79 
80 /* utilities */
81 #include "misc/dcl_error.h"
82 #include "misc/dcl_fdlog.h"
83 #include "misc/dcl_mlog.h"
84 #include "misc/dcl_refgen.h"
85 #include "misc/dcl_tcm.h"
86 
87 /* 32bit arithmetic */
88 #include "pi/dcl_pi.h"
89 #include "pi/dcl_pi2.h"
90 #include "pid/dcl_pid.h"
91 #include "pid/dcl_nlpid.h"
92 
93 #include "df/dcl_df11.h"
94 #include "df/dcl_df12.h"
95 #include "df/dcl_df13.h"
96 #include "df/dcl_df22.h"
97 #include "df/dcl_df23.h"
98 
99 /* 64bit arithmetic */
100 #include "pid/dcl_pidf64.h"
101 
104 #ifdef __cplusplus
105 }
106 #endif // extern "C"
107 
108 #endif // _DCL_H_
dcl_tcm.h
Defines the interface to the Transient Capture Module (TCM)
dcl_pi2.h
Contains PI2 (double integrator) controller with its related structures and functions.
dcl_df11.h
Contains direct form 1 1st order DF11 compensator with its related structures and functions.
dcl_df23.h
Contains direct form 2 3rd order DF23 compensator with its related structures and functions.
dcl_mlog.h
Defines the interface to Multi-channel data logger (mlog)
dcl_nlpid.h
Contains 32-bit non-linear PID controller with its related structures and functions.
dcl_refgen.h
Defines the interface to reference generator module (REFGEN)
dcl_pi.h
Contains PI controller with its related structures and functions.
dcl_df22.h
Contains direct form 2 2nd order DF22 compensator with its related structures and functions.
dcl_error.h
Defines all error handling strctures and macro.
dcl_df13.h
Contains direct form 1 3rd order DF13 compensator with its related structures and functions.
dcl_pid.h
Contains 32-bit PID controller with its related structures and functions.
dcl_fdlog.h
Defines a 32-bit floating-point data logger strcture and related functions.
dcl_pidf64.h
Contains 64-bit PID controller with its related structures and functions.