X-CUBE-SPN11 for X-NUCLEO-IHM11M1: STSPIN230.c Source File

X-CUBE-SPN11 for X-NUCLEO-IHM11M1

STSPIN230.c
Go to the documentation of this file.
1 /**
2  ******************************************************************************
3  * @file STSPIN230.c
4  * @author IPC
5  * @version V0
6  * @date 28-April-2016
7  * @brief This file provides a set of functions to manage STSPIN230 driver
8  ******************************************************************************
9  * @attention
10  *
11  * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
12  *
13  * Redistribution and use in source and binary forms, with or without modification,
14  * are permitted provided that the following conditions are met:
15  * 1. Redistributions of source code must retain the above copyright notice,
16  * this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright notice,
18  * this list of conditions and the following disclaimer in the documentation
19  * and/or other materials provided with the distribution.
20  * 3. Neither the name of STMicroelectronics nor the names of its contributors
21  * may be used to endorse or promote products derived from this software
22  * without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  ******************************************************************************
36  */
37 
38 #include "STSPIN230.h"
39 
40 
41 /** @addtogroup DRIVERS DRIVERS
42  * @brief Driver Layer
43  * @{
44  */
45 
46 /** @addtogroup BSP BSP
47  * @brief BSP Layer
48  * @{
49  */
50 
51 /** @addtogroup COMPONENTS COMPONENTS
52  * @brief Components
53  * @{
54  */
55 
56 /** @addtogroup STSPIN230 STSPIN230
57  * @brief STSPIN230 driver section
58  * @{
59  */
60 
61 /** @defgroup STSPIN230MotorDriver STSPIN230MotorDriver
62  * @{
63  * @brief API pointer for STSPIN230
64  */
65 /**
66  * @brief It handles all API functions for STSPIN230 MC Driver
67  * @retval None
68 */
69 
71 {
84 };
85 
86  /**
87  * @}
88  */
89 
90 /** @defgroup EnableInput_CH1_E_CH2_E_CH3_D EnableInput_CH1_E_CH2_E_CH3_D
91  * @{
92  * @brief Enable Input channel CH1 and CH2 for STSPIN230
93  * @retval None
94  */
95 
97 {
99 }
100 
101 /**
102  * @}
103  */
104 
105 
106 /** @defgroup EnableInput_CH1_E_CH2_D_CH3_E EnableInput_CH1_E_CH2_D_CH3_E
107  * @{
108  * @brief Enable Input channel CH1 and CH3 for STSPIN230
109  * @retval None
110 */
111 
113 {
115 }
116 
117 /**
118  * @}
119  */
120 
121 /** @defgroup EnableInput_CH1_D_CH2_E_CH3_E EnableInput_CH1_D_CH2_E_CH3_E
122  * @{
123  * @brief Enable Input channel CH2 and CH3 for STSPIN230
124  * @retval None
125 */
126 
128 {
130 }
131 
132 /**
133  * @}
134  */
135 
136 
137 /** @defgroup DisableInput_CH1_D_CH2_D_CH3_D DisableInput_CH1_D_CH2_D_CH3_D
138  * @{
139  * @brief Enable Input channel CH2 and CH3 for STSPIN230
140  * @retval None
141 */
142 
144 {
146 }
147 
148 /**
149  * @}
150  */
151 
152 /** @defgroup Start_PWM_driving Start_PWM_driving
153  * @{
154  * @brief Enable PWM channels for STSPIN230
155  * @retval None
156 */
157 
159 {
161 }
162 
163 /**
164  * @}
165  */
166 
167 /** @defgroup Stop_PWM_driving Stop_PWM_driving
168  * @{
169  * @brief Disable PWM channels for STSPIN230
170  * @retval None
171 */
172 
174 {
176 }
177 
178 /**
179  * @}
180  */
181 
182 /** @defgroup HF_TIMx_SetDutyCycle_CH1 HF_TIMx_SetDutyCycle_CH1
183  * @{
184  * @brief Set the Duty Cycle value for CH1
185  * @retval None
186 */
187 
188 void HF_TIMx_SetDutyCycle_CH1(uint16_t CCR_value)
189 {
191 }
192 
193 
194 /**
195  * @}
196  */
197 
198 /** @defgroup HF_TIMx_SetDutyCycle_CH2 HF_TIMx_SetDutyCycle_CH2
199  * @{
200  * @brief Set the Duty Cycle value for CH2
201  * @retval None
202 */
203 
204 void HF_TIMx_SetDutyCycle_CH2(uint16_t CCR_value)
205 {
207 }
208 
209 /**
210  * @}
211  */
212 
213 /** @defgroup HF_TIMx_SetDutyCycle_CH3 HF_TIMx_SetDutyCycle_CH3
214  * @{
215  * @brief Set the Duty Cycle value for CH3
216  * @retval None
217 */
218 
219 void HF_TIMx_SetDutyCycle_CH3(uint16_t CCR_value)
220 {
222 }
223 
224 /**
225  * @}
226  */
227 
228 
229 
230 
231 /** @defgroup Current_Reference_Start Current_Reference_Start
232  * @{
233  * @brief Enable the Current Reference generation
234  * @retval None
235 */
236 
238 {
240 }
241 
242 /**
243  * @}
244  */
245 
246 
247 /** @defgroup Current_Reference_Stop Current_Reference_Stop
248  * @{
249  * @brief Disable the Current Reference generation
250  * @retval None
251 */
252 
254 {
256 }
257 
258 /**
259  * @}
260  */
261 
262 
263 /** @defgroup Current_Reference_Setvalue Current_Reference_Setvalue
264  * @{
265  * @brief Set the value for Current Reference
266  * @retval None
267 */
268 
269 void Current_Reference_Setvalue(uint16_t Iref)
270 {
272 }
273 
274 /**
275  * @}
276  */
277 
278 
279 
280 
281 
282 
283 /**
284  * @} end STSPIN230
285  */
286 
287 /**
288  * @} end COMPONENTS
289  */
290 
291 /**
292  * @} end BSP
293  */
294 
295 /**
296  * @} end DRIVERS
297  */
298 
void STSPIN230_Current_Reference_Start(void)
Enable the Current Reference generation.
void DisableInput_CH1_D_CH2_D_CH3_D()
Definition: STSPIN230.c:143
void STSPIN230_HF_TIMx_SetDutyCycle_CH3(uint16_t)
Set the Duty Cycle value for CH3.
void STSPIN230_EnableInput_CH1_E_CH2_D_CH3_E(void)
Enable Input channel CH1 and CH3 for STSPIN230.
void EnableInput_CH1_E_CH2_E_CH3_D()
Definition: STSPIN230.c:96
void EnableInput_CH1_E_CH2_D_CH3_E()
Definition: STSPIN230.c:112
This file provides a set of functions to manage STSPIN230 driver.
void STSPIN230_HF_TIMx_SetDutyCycle_CH2(uint16_t)
Set the Duty Cycle value for CH2.
void Current_Reference_Setvalue(uint16_t Iref)
Definition: STSPIN230.c:269
void HF_TIMx_SetDutyCycle_CH2(uint16_t CCR_value)
Definition: STSPIN230.c:204
void STSPIN230_DisableInput_CH1_D_CH2_D_CH3_D(void)
Enable Input channel CH2 and CH3 for STSPIN230.
void HF_TIMx_SetDutyCycle_CH1(uint16_t CCR_value)
Definition: STSPIN230.c:188
void STSPIN230_EnableInput_CH1_D_CH2_E_CH3_E(void)
Enable Input channel CH2 and CH3 for STSPIN230.
void HF_TIMx_SetDutyCycle_CH3(uint16_t CCR_value)
Definition: STSPIN230.c:219
void Current_Reference_Start()
Definition: STSPIN230.c:237
void STSPIN230_HF_TIMx_SetDutyCycle_CH1(uint16_t)
Set the Duty Cycle value for CH1.
void EnableInput_CH1_D_CH2_E_CH3_E()
Definition: STSPIN230.c:127
STSPIN230_MotorDriver_TypeDef STSPIN230MotorDriver
It handles all API functions for STSPIN230 MC Driver.
Definition: STSPIN230.c:70
void STSPIN230_Current_Reference_Setvalue(uint16_t)
Set the value for Current Reference.
void Stop_PWM_driving()
Definition: STSPIN230.c:173
void Start_PWM_driving()
Definition: STSPIN230.c:158
void Current_Reference_Stop()
Definition: STSPIN230.c:253
void STSPIN230_Current_Reference_Stop(void)
Disable the Current Reference generation.
void STSPIN230_Start_PWM_driving(void)
Enable PWM channels for STSPIN230.
void STSPIN230_EnableInput_CH1_E_CH2_E_CH3_D(void)
Enable Input channel CH1 and CH2 for STSPIN230.
void STSPIN230_Stop_PWM_driving(void)
Disable PWM channels for STSPIN230.
Generated by   doxygen 1.8.11