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

X-CUBE-SPN11 for X-NUCLEO-IHM11M1

previous page next page
STSPIN230.h
Go to the documentation of this file.
1 /**
2  ******************************************************************************
3  * @file STSPIN230.h
4  * @author IPC
5  * @version V0
6  * @date 04-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 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STSPIN230_H
40 #define __STSPIN230_H
41 
42 #include "stdint.h"
43 #include "MC_Common.h"
44 
45 
46 
47  extern void STSPIN230_EnableInput_CH1_E_CH2_E_CH3_D(void);
48  extern void STSPIN230_EnableInput_CH1_E_CH2_D_CH3_E(void);
49  extern void STSPIN230_EnableInput_CH1_D_CH2_E_CH3_E(void);
50  extern void STSPIN230_DisableInput_CH1_D_CH2_D_CH3_D(void);
51  extern void STSPIN230_Start_PWM_driving(void);
52  extern void STSPIN230_Stop_PWM_driving(void);
53  extern void STSPIN230_HF_TIMx_SetDutyCycle_CH1(uint16_t);
54  extern void STSPIN230_HF_TIMx_SetDutyCycle_CH2(uint16_t);
55  extern void STSPIN230_HF_TIMx_SetDutyCycle_CH3(uint16_t);
56  extern void STSPIN230_Current_Reference_Start(void);
57  extern void STSPIN230_Current_Reference_Stop(void);
58  extern void STSPIN230_Current_Reference_Setvalue(uint16_t);
59  extern void STSPIN230_START_Ref_Generation(void);
60  extern void STSPIN230_STOP_Ref_Generation(void);
61  extern void STSPIN230_Set_Ref_Generation(uint16_t);
62 
63  void EnableInput_CH1_E_CH2_E_CH3_D(void);
64  void EnableInput_CH1_E_CH2_D_CH3_E(void);
65  void EnableInput_CH1_D_CH2_E_CH3_E(void);
66  void DisableInput_CH1_D_CH2_D_CH3_D(void);
67  void Start_PWM_driving(void);
68  void Stop_PWM_driving(void);
69  void HF_TIMx_SetDutyCycle_CH1(uint16_t);
70  void HF_TIMx_SetDutyCycle_CH2(uint16_t);
71  void HF_TIMx_SetDutyCycle_CH3(uint16_t);
72  void Current_Reference_Start(void);
73  void Current_Reference_Stop(void);
74  void Current_Reference_Setvalue(uint16_t);
75 
76 
77  /** @addtogroup DRIVERS DRIVERS
78  * @brief Driver Layer
79  * @{
80  */
81 
82 /** @addtogroup BSP BSP
83  * @brief BSP Layer
84  * @{
85  */
86 
87 /** @addtogroup COMPONENTS COMPONENTS
88  * @brief Components
89  * @{
90  */
91 
92 /** @addtogroup STSPIN230 STSPIN230
93  * @brief STSPIN230 driver section
94  * @{
95  */
96 
97 
98 
99 /**
100  * @}
101  */
102 
103 #endif
STSPIN230_Current_Reference_Start
void STSPIN230_Current_Reference_Start(void)
Enable the Current Reference generation.
Definition: X-NUCLEO-IHM11M1.c:293
DisableInput_CH1_D_CH2_D_CH3_D
void DisableInput_CH1_D_CH2_D_CH3_D(void)
Definition: STSPIN230.c:143
STSPIN230_HF_TIMx_SetDutyCycle_CH3
void STSPIN230_HF_TIMx_SetDutyCycle_CH3(uint16_t)
Set the Duty Cycle value for CH3.
Definition: X-NUCLEO-IHM11M1.c:274
STSPIN230_EnableInput_CH1_E_CH2_D_CH3_E
void STSPIN230_EnableInput_CH1_E_CH2_D_CH3_E(void)
Enable Input channel CH1 and CH3 for STSPIN230.
Definition: X-NUCLEO-IHM11M1.c:104
STSPIN230_START_Ref_Generation
void STSPIN230_START_Ref_Generation(void)
EnableInput_CH1_E_CH2_E_CH3_D
void EnableInput_CH1_E_CH2_E_CH3_D(void)
Definition: STSPIN230.c:96
STSPIN230_STOP_Ref_Generation
void STSPIN230_STOP_Ref_Generation(void)
EnableInput_CH1_E_CH2_D_CH3_E
void EnableInput_CH1_E_CH2_D_CH3_E(void)
Definition: STSPIN230.c:112
STSPIN230_HF_TIMx_SetDutyCycle_CH2
void STSPIN230_HF_TIMx_SetDutyCycle_CH2(uint16_t)
Set the Duty Cycle value for CH2.
Definition: X-NUCLEO-IHM11M1.c:250
Current_Reference_Setvalue
void Current_Reference_Setvalue(uint16_t)
Definition: STSPIN230.c:269
HF_TIMx_SetDutyCycle_CH2
void HF_TIMx_SetDutyCycle_CH2(uint16_t)
Definition: STSPIN230.c:204
STSPIN230_DisableInput_CH1_D_CH2_D_CH3_D
void STSPIN230_DisableInput_CH1_D_CH2_D_CH3_D(void)
Enable Input channel CH2 and CH3 for STSPIN230.
Definition: X-NUCLEO-IHM11M1.c:154
STSPIN230_Set_Ref_Generation
void STSPIN230_Set_Ref_Generation(uint16_t)
HF_TIMx_SetDutyCycle_CH1
void HF_TIMx_SetDutyCycle_CH1(uint16_t)
Definition: STSPIN230.c:188
STSPIN230_EnableInput_CH1_D_CH2_E_CH3_E
void STSPIN230_EnableInput_CH1_D_CH2_E_CH3_E(void)
Enable Input channel CH2 and CH3 for STSPIN230.
Definition: X-NUCLEO-IHM11M1.c:129
HF_TIMx_SetDutyCycle_CH3
void HF_TIMx_SetDutyCycle_CH3(uint16_t)
Definition: STSPIN230.c:219
Current_Reference_Start
void Current_Reference_Start(void)
Definition: STSPIN230.c:237
STSPIN230_HF_TIMx_SetDutyCycle_CH1
void STSPIN230_HF_TIMx_SetDutyCycle_CH1(uint16_t)
Set the Duty Cycle value for CH1.
Definition: X-NUCLEO-IHM11M1.c:230
EnableInput_CH1_D_CH2_E_CH3_E
void EnableInput_CH1_D_CH2_E_CH3_E(void)
Definition: STSPIN230.c:127
STSPIN230_Current_Reference_Setvalue
void STSPIN230_Current_Reference_Setvalue(uint16_t)
Set the value for Current Reference.
Definition: X-NUCLEO-IHM11M1.c:334
MC_Common.h
This header file is a common file.
Stop_PWM_driving
void Stop_PWM_driving(void)
Definition: STSPIN230.c:173
Start_PWM_driving
void Start_PWM_driving(void)
Definition: STSPIN230.c:158
Current_Reference_Stop
void Current_Reference_Stop(void)
Definition: STSPIN230.c:253
STSPIN230_Current_Reference_Stop
void STSPIN230_Current_Reference_Stop(void)
Disable the Current Reference generation.
Definition: X-NUCLEO-IHM11M1.c:313
STSPIN230_Start_PWM_driving
void STSPIN230_Start_PWM_driving(void)
Enable PWM channels for STSPIN230.
Definition: X-NUCLEO-IHM11M1.c:179
STSPIN230_EnableInput_CH1_E_CH2_E_CH3_D
void STSPIN230_EnableInput_CH1_E_CH2_E_CH3_D(void)
Enable Input channel CH1 and CH2 for STSPIN230.
Definition: X-NUCLEO-IHM11M1.c:79
STSPIN230_Stop_PWM_driving
void STSPIN230_Stop_PWM_driving(void)
Disable PWM channels for STSPIN230.
Definition: X-NUCLEO-IHM11M1.c:204
Generated by   doxygen 1.8.11
previous page start next page