AM263x Motor Control SDK  09.00.00
dcl_common.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 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 EXPgResS 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_COMMON_H_
34 #define _DCL_COMMON_H_
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
48 typedef float float32_t;
52 typedef double float64_t;
53 
55 #define _DCL_CODE_ACCESS static inline
56 
60 #define _DCL_CODE_SECTION __attribute__((section("dclfuncs")))
61 
65 #ifdef DCL_VOLATILE_ENABLED
66  #define _DCL_VOLATILE volatile
67 #else
68  #define _DCL_VOLATILE
69 #endif
70 
73 #if defined (__TMS320C28XX__) //C28 ISA
74  #define DCL_setBreakPoint() asm(" ESTOP")
75 #elif defined (__ARM_ARCH) //ARM ISA
76  #define DCL_setBreakPoint() __asm(" bkpt #0")
77 #else
78  #define DCL_setBreakPoint()
79  #warning "DCL currently doesn't support break point for this architecture"
80 #endif
81 
84 #if defined (__TMS320C28XX__)
85  #define DCL_disableInts() __disable_interrupts()
86  #define DCL_restoreInts(v) if (0U == (v & 0x1)) __enable_interrupts()
87  typedef uint16_t dcl_interrupt_t;
88 #elif defined (SOC_AM64X) || defined (SOC_AM243X) || defined (SOC_AM263X)
89  #include <kernel/dpl/HwiP.h>
90  #define DCL_disableInts() HwiP_disable()
91  #define DCL_restoreInts(v) HwiP_restore(v)
92  typedef uint32_t dcl_interrupt_t;
93 #else
94  #define DCL_disableInts() 0
95  #define DCL_restoreInts(v)
96  typedef uint32_t dcl_interrupt_t;
97  #warning "DCL currently doesn't support interrupt operations for this architecture"
98 #endif
99 
100 #include <stdint.h>
101 #include <stdbool.h>
102 #include "common/dcl_aux.h"
103 #include "common/dcl_css.h"
104 #include "common/dcl_zpk3.h"
105 #include "common/dcl_clamp.h"
106 #include "common/dcl_stability.h"
107 
110 #ifdef __cplusplus
111 }
112 #endif // extern "C"
113 
114 #endif // _DCL_COMMON_H_
dcl_aux.h
Defines all the auxiliary macros for DCL.
dcl_zpk3.h
Defines ZPK3 strcture that represents a third order transfer function of poles and zeros.
dcl_clamp.h
Defines both single, double precision clamp function for saturation.
dcl_interrupt_t
uint32_t dcl_interrupt_t
Definition: dcl_common.h:96
dcl_css.h
Defines Controller Common Support Structure (CSS) and related macros.
float64_t
double float64_t
Definition: dcl_common.h:52
float32_t
float float32_t
Defines single,double precision data type. Note: Assumes ABI to be TI_EABI, does not support legacy T...
Definition: dcl_common.h:51
dcl_stability.h
Defines polynomial stability functions.