MotorWare f2806x Module API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

fstart.h
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--*/
32 #ifndef _FSTART_H_
33 #define _FSTART_H_
34
40
41
42 // **************************************************************************
43 // the includes
44
45 #include "sw/modules/types/src/types.h"
46
51
52
53 // Include the algorithm overview defined in modules/<module>/docs/doxygen/doxygen.h
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60
61 // **************************************************************************
62 // the defines
63
64
65
66 // **************************************************************************
67 // the typedefs
68
69
72 typedef struct _FStart_Handle_ *FStart_Handle;
73
74
75 // **************************************************************************
76 // the globals
77
78
79 // **************************************************************************
80 // the function prototypes
81
84 extern FStart_Handle FStart_init(void);
85
86
92 extern _iq FStart_run(FStart_Handle handle,
93 const _iq fm_Hz,
94 const _iq flux_VpHz);
95
96
103 extern void FStart_setParams(FStart_Handle handle,
104 const float_t iqFullScaleVoltage_V,
105 const float_t iqFullScaleFreq_Hz,
106 const float_t estFreq_Hz,
107 const float_t maxFlux_VpHz);
108
109 #ifdef __cplusplus
110 }
111 #endif // extern "C"
112
114 #endif // end of _FSTART_H_ definition
115
FStart_Handle
struct _FStart_Handle_ * FStart_Handle
Defines the FStart handle.
Definition: fstart.h:72
types.h
Contains the public interface to the types definitions.
FStart_run
_iq FStart_run(FStart_Handle handle, const _iq fm_Hz, const _iq flux_VpHz)
Runs the flying start module.
FStart_init
FStart_Handle FStart_init(void)
Initializes the flying start module.
_iq
long _iq
Definition: 32b/IQmathLib.h:223
FStart_setParams
void FStart_setParams(FStart_Handle handle, const float_t iqFullScaleVoltage_V, const float_t iqFullScaleFreq_Hz, const float_t estFreq_Hz, const float_t maxFlux_VpHz)
Sets the parameters for the flying start module.
float_t
float float_t
Defines the portable data type for 32 bit, signed floating-point data.
Definition: types.h:121