Library to handle the X-NUCLEO-IHM06A1 Motor Control Expansion Board based on the STSPIN220 component.

Dependencies:   ST_INTERFACES

Dependents:   HelloWorld_IHM06A1

Fork of X-NUCLEO-IHM06A1 by ST Expansion SW Team

Motor Control Library

Library to handle the X-NUCLEO-IHM06A1 Motor Control Expansion Board based on the STSPIN220 component.

It features the:

  • Read and write of the device parameters; GPIO, PWM and IRQ configuration; microstepping, direction position, speed, acceleration, deceleration and torque controls
  • Automatic full-step switch management; high impedance or hold stop mode selection; enable and standby management
  • Fault interrupts handling (over current, short-circuit and over temperature)
  • Command locking until the device completes movement

The API allows to easily:

  • perform various positioning, moves and stops
  • get/set or monitor the motor positions
  • set the home position and mark another position
  • get/set the minimum and maximum speed
  • get the current speed
  • get/set the acceleration and deceleration
  • get/set the stop mode (hold, hiz or standby)
  • get/set the torque
  • get/set the torque boost
  • get/set the step mode (up to 1/256)

Platform compatibility

Compatible platforms have been tested with the configurations provided by the HelloWorld_IHM06A1 example.

Committer:
Davidroid
Date:
Fri Jul 28 13:28:00 2017 +0000
Revision:
5:fd1315beea32
Parent:
3:a132aa6d66e4
Aligning to ARM mbed coding style.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
davide.aliprandi@st.com 3:a132aa6d66e4 1 /**
davide.aliprandi@st.com 3:a132aa6d66e4 2 ******************************************************************************
davide.aliprandi@st.com 3:a132aa6d66e4 3 * @file motor_def.h
davide.aliprandi@st.com 3:a132aa6d66e4 4 * @author IPC Rennes
davide.aliprandi@st.com 3:a132aa6d66e4 5 * @version V1.5.0
davide.aliprandi@st.com 3:a132aa6d66e4 6 * @date January 25, 2016
davide.aliprandi@st.com 3:a132aa6d66e4 7 * @brief This file contains all the functions prototypes for motor drivers.
davide.aliprandi@st.com 3:a132aa6d66e4 8 ******************************************************************************
davide.aliprandi@st.com 3:a132aa6d66e4 9 * @attention
davide.aliprandi@st.com 3:a132aa6d66e4 10 *
davide.aliprandi@st.com 3:a132aa6d66e4 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
davide.aliprandi@st.com 3:a132aa6d66e4 12 *
davide.aliprandi@st.com 3:a132aa6d66e4 13 * Redistribution and use in source and binary forms, with or without modification,
davide.aliprandi@st.com 3:a132aa6d66e4 14 * are permitted provided that the following conditions are met:
davide.aliprandi@st.com 3:a132aa6d66e4 15 * 1. Redistributions of source code must retain the above copyright notice,
davide.aliprandi@st.com 3:a132aa6d66e4 16 * this list of conditions and the following disclaimer.
davide.aliprandi@st.com 3:a132aa6d66e4 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
davide.aliprandi@st.com 3:a132aa6d66e4 18 * this list of conditions and the following disclaimer in the documentation
davide.aliprandi@st.com 3:a132aa6d66e4 19 * and/or other materials provided with the distribution.
davide.aliprandi@st.com 3:a132aa6d66e4 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
davide.aliprandi@st.com 3:a132aa6d66e4 21 * may be used to endorse or promote products derived from this software
davide.aliprandi@st.com 3:a132aa6d66e4 22 * without specific prior written permission.
davide.aliprandi@st.com 3:a132aa6d66e4 23 *
davide.aliprandi@st.com 3:a132aa6d66e4 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
davide.aliprandi@st.com 3:a132aa6d66e4 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
davide.aliprandi@st.com 3:a132aa6d66e4 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
davide.aliprandi@st.com 3:a132aa6d66e4 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
davide.aliprandi@st.com 3:a132aa6d66e4 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
davide.aliprandi@st.com 3:a132aa6d66e4 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
davide.aliprandi@st.com 3:a132aa6d66e4 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
davide.aliprandi@st.com 3:a132aa6d66e4 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
davide.aliprandi@st.com 3:a132aa6d66e4 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
davide.aliprandi@st.com 3:a132aa6d66e4 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
davide.aliprandi@st.com 3:a132aa6d66e4 34 *
davide.aliprandi@st.com 3:a132aa6d66e4 35 ******************************************************************************
davide.aliprandi@st.com 3:a132aa6d66e4 36 */
davide.aliprandi@st.com 3:a132aa6d66e4 37
davide.aliprandi@st.com 3:a132aa6d66e4 38 /* Define to prevent recursive inclusion -------------------------------------*/
davide.aliprandi@st.com 3:a132aa6d66e4 39 #ifndef __MOTOR_H
davide.aliprandi@st.com 3:a132aa6d66e4 40 #define __MOTOR_H
davide.aliprandi@st.com 3:a132aa6d66e4 41
davide.aliprandi@st.com 3:a132aa6d66e4 42 #ifdef __cplusplus
davide.aliprandi@st.com 3:a132aa6d66e4 43 extern "C" {
davide.aliprandi@st.com 3:a132aa6d66e4 44 #endif
davide.aliprandi@st.com 3:a132aa6d66e4 45
davide.aliprandi@st.com 3:a132aa6d66e4 46 /* Includes ------------------------------------------------------------------*/
davide.aliprandi@st.com 3:a132aa6d66e4 47 #include <stdint.h>
davide.aliprandi@st.com 3:a132aa6d66e4 48 #include "component_def.h"
davide.aliprandi@st.com 3:a132aa6d66e4 49
davide.aliprandi@st.com 3:a132aa6d66e4 50 /* Definitions ---------------------------------------------------------------*/
davide.aliprandi@st.com 3:a132aa6d66e4 51 /// boolean for false condition
davide.aliprandi@st.com 3:a132aa6d66e4 52 #ifndef FALSE
davide.aliprandi@st.com 3:a132aa6d66e4 53 #define FALSE (0)
davide.aliprandi@st.com 3:a132aa6d66e4 54 #endif
davide.aliprandi@st.com 3:a132aa6d66e4 55 /// boolean for true condition
davide.aliprandi@st.com 3:a132aa6d66e4 56 #ifndef TRUE
davide.aliprandi@st.com 3:a132aa6d66e4 57 #define TRUE (1)
davide.aliprandi@st.com 3:a132aa6d66e4 58 #endif
davide.aliprandi@st.com 3:a132aa6d66e4 59
davide.aliprandi@st.com 3:a132aa6d66e4 60 /* Types ---------------------------------------------------------------------*/
davide.aliprandi@st.com 3:a132aa6d66e4 61 /** @addtogroup BSP
davide.aliprandi@st.com 3:a132aa6d66e4 62 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 63 */
davide.aliprandi@st.com 3:a132aa6d66e4 64
davide.aliprandi@st.com 3:a132aa6d66e4 65 /** @addtogroup Components
davide.aliprandi@st.com 3:a132aa6d66e4 66 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 67 */
davide.aliprandi@st.com 3:a132aa6d66e4 68
davide.aliprandi@st.com 3:a132aa6d66e4 69 /** @defgroup Motor Motor
davide.aliprandi@st.com 3:a132aa6d66e4 70 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 71 */
davide.aliprandi@st.com 3:a132aa6d66e4 72
davide.aliprandi@st.com 3:a132aa6d66e4 73 /** @defgroup Motor_Exported_Types Motor Exported Types
davide.aliprandi@st.com 3:a132aa6d66e4 74 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 75 */
davide.aliprandi@st.com 3:a132aa6d66e4 76
davide.aliprandi@st.com 3:a132aa6d66e4 77 /** @defgroup Device_Direction_Options Device Direction Options
davide.aliprandi@st.com 3:a132aa6d66e4 78 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 79 */
davide.aliprandi@st.com 3:a132aa6d66e4 80 /// Direction options
davide.aliprandi@st.com 3:a132aa6d66e4 81 typedef enum {
davide.aliprandi@st.com 3:a132aa6d66e4 82 BACKWARD = 0,
davide.aliprandi@st.com 3:a132aa6d66e4 83 FORWARD = 1,
davide.aliprandi@st.com 3:a132aa6d66e4 84 UNKNOW_DIR = ((uint8_t)0xFF)
davide.aliprandi@st.com 3:a132aa6d66e4 85 } motorDir_t;
davide.aliprandi@st.com 3:a132aa6d66e4 86 /**
davide.aliprandi@st.com 3:a132aa6d66e4 87 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 88 */
davide.aliprandi@st.com 3:a132aa6d66e4 89
davide.aliprandi@st.com 3:a132aa6d66e4 90 /** @defgroup Device_Action_Options Device Action Options
davide.aliprandi@st.com 3:a132aa6d66e4 91 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 92 */
davide.aliprandi@st.com 3:a132aa6d66e4 93 /// Action options
davide.aliprandi@st.com 3:a132aa6d66e4 94 typedef enum {
davide.aliprandi@st.com 3:a132aa6d66e4 95 ACTION_RESET = ((uint8_t)0x00),
davide.aliprandi@st.com 3:a132aa6d66e4 96 ACTION_COPY = ((uint8_t)0x08)
davide.aliprandi@st.com 3:a132aa6d66e4 97 } motorAction_t;
davide.aliprandi@st.com 3:a132aa6d66e4 98 /**
davide.aliprandi@st.com 3:a132aa6d66e4 99 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 100 */
davide.aliprandi@st.com 3:a132aa6d66e4 101
davide.aliprandi@st.com 3:a132aa6d66e4 102 /** @defgroup Device_States Device States
davide.aliprandi@st.com 3:a132aa6d66e4 103 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 104 */
davide.aliprandi@st.com 3:a132aa6d66e4 105 /// Device states
davide.aliprandi@st.com 3:a132aa6d66e4 106 typedef enum {
davide.aliprandi@st.com 3:a132aa6d66e4 107 ACCELERATING = 0,
davide.aliprandi@st.com 3:a132aa6d66e4 108 DECELERATINGTOSTOP = 1,
davide.aliprandi@st.com 3:a132aa6d66e4 109 DECELERATING = 2,
davide.aliprandi@st.com 3:a132aa6d66e4 110 STEADY = 3,
davide.aliprandi@st.com 3:a132aa6d66e4 111 INDEX_ACCEL = 4,
davide.aliprandi@st.com 3:a132aa6d66e4 112 INDEX_RUN = 5,
davide.aliprandi@st.com 3:a132aa6d66e4 113 INDEX_DECEL = 6,
davide.aliprandi@st.com 3:a132aa6d66e4 114 INDEX_DWELL = 7,
davide.aliprandi@st.com 3:a132aa6d66e4 115 INACTIVE = 8,
davide.aliprandi@st.com 3:a132aa6d66e4 116 STANDBY = 9,
davide.aliprandi@st.com 3:a132aa6d66e4 117 STANDBYTOINACTIVE = 10
davide.aliprandi@st.com 3:a132aa6d66e4 118 } motorState_t;
davide.aliprandi@st.com 3:a132aa6d66e4 119 /**
davide.aliprandi@st.com 3:a132aa6d66e4 120 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 121 */
davide.aliprandi@st.com 3:a132aa6d66e4 122
davide.aliprandi@st.com 3:a132aa6d66e4 123 /** @defgroup Device_Step_mode Device Step mode
davide.aliprandi@st.com 3:a132aa6d66e4 124 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 125 */
davide.aliprandi@st.com 3:a132aa6d66e4 126 /// Stepping options
davide.aliprandi@st.com 3:a132aa6d66e4 127 typedef enum {
davide.aliprandi@st.com 3:a132aa6d66e4 128 STEP_MODE_FULL = ((uint8_t)0x00),
davide.aliprandi@st.com 3:a132aa6d66e4 129 STEP_MODE_HALF = ((uint8_t)0x01),
davide.aliprandi@st.com 3:a132aa6d66e4 130 STEP_MODE_1_4 = ((uint8_t)0x02),
davide.aliprandi@st.com 3:a132aa6d66e4 131 STEP_MODE_1_8 = ((uint8_t)0x03),
davide.aliprandi@st.com 3:a132aa6d66e4 132 STEP_MODE_1_16 = ((uint8_t)0x04),
davide.aliprandi@st.com 3:a132aa6d66e4 133 STEP_MODE_1_32 = ((uint8_t)0x05),
davide.aliprandi@st.com 3:a132aa6d66e4 134 STEP_MODE_1_64 = ((uint8_t)0x06),
davide.aliprandi@st.com 3:a132aa6d66e4 135 STEP_MODE_1_128 = ((uint8_t)0x07),
davide.aliprandi@st.com 3:a132aa6d66e4 136 STEP_MODE_1_256 = ((uint8_t)0x08),
davide.aliprandi@st.com 3:a132aa6d66e4 137 STEP_MODE_UNKNOW = ((uint8_t)0xFE),
davide.aliprandi@st.com 3:a132aa6d66e4 138 STEP_MODE_WAVE = ((uint8_t)0xFF)
davide.aliprandi@st.com 3:a132aa6d66e4 139 } motorStepMode_t;
davide.aliprandi@st.com 3:a132aa6d66e4 140
davide.aliprandi@st.com 3:a132aa6d66e4 141 /**
davide.aliprandi@st.com 3:a132aa6d66e4 142 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 143 */
davide.aliprandi@st.com 3:a132aa6d66e4 144
davide.aliprandi@st.com 3:a132aa6d66e4 145 /** @defgroup Decay_mode Decay mode
davide.aliprandi@st.com 3:a132aa6d66e4 146 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 147 */
davide.aliprandi@st.com 3:a132aa6d66e4 148 /// Decay Mode
davide.aliprandi@st.com 3:a132aa6d66e4 149 typedef enum {
davide.aliprandi@st.com 3:a132aa6d66e4 150 SLOW_DECAY = 0,
davide.aliprandi@st.com 3:a132aa6d66e4 151 FAST_DECAY = 1,
davide.aliprandi@st.com 3:a132aa6d66e4 152 UNKNOW_DECAY = ((uint8_t)0xFF)
davide.aliprandi@st.com 3:a132aa6d66e4 153 } motorDecayMode_t;
davide.aliprandi@st.com 3:a132aa6d66e4 154 /**
davide.aliprandi@st.com 3:a132aa6d66e4 155 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 156 */
davide.aliprandi@st.com 3:a132aa6d66e4 157
davide.aliprandi@st.com 3:a132aa6d66e4 158 /** @defgroup Stop_mode Stop mode
davide.aliprandi@st.com 3:a132aa6d66e4 159 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 160 */
davide.aliprandi@st.com 3:a132aa6d66e4 161 /// Stop mode
davide.aliprandi@st.com 3:a132aa6d66e4 162 typedef enum
davide.aliprandi@st.com 3:a132aa6d66e4 163 {
davide.aliprandi@st.com 3:a132aa6d66e4 164 HOLD_MODE = 0,
davide.aliprandi@st.com 3:a132aa6d66e4 165 HIZ_MODE = 1,
davide.aliprandi@st.com 3:a132aa6d66e4 166 STANDBY_MODE = 2,
davide.aliprandi@st.com 3:a132aa6d66e4 167 UNKNOW_STOP_MODE = ((uint8_t)0xFF)
davide.aliprandi@st.com 3:a132aa6d66e4 168 } motorStopMode_t;
davide.aliprandi@st.com 3:a132aa6d66e4 169 /**
davide.aliprandi@st.com 3:a132aa6d66e4 170 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 171 */
davide.aliprandi@st.com 3:a132aa6d66e4 172
davide.aliprandi@st.com 3:a132aa6d66e4 173 /** @defgroup Torque_mode Torque mode
davide.aliprandi@st.com 3:a132aa6d66e4 174 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 175 */
davide.aliprandi@st.com 3:a132aa6d66e4 176 /// Torque mode
davide.aliprandi@st.com 3:a132aa6d66e4 177 typedef enum
davide.aliprandi@st.com 3:a132aa6d66e4 178 {
davide.aliprandi@st.com 3:a132aa6d66e4 179 ACC_TORQUE = 0,
davide.aliprandi@st.com 3:a132aa6d66e4 180 DEC_TORQUE = 1,
davide.aliprandi@st.com 3:a132aa6d66e4 181 RUN_TORQUE = 2,
davide.aliprandi@st.com 3:a132aa6d66e4 182 HOLD_TORQUE = 3,
davide.aliprandi@st.com 3:a132aa6d66e4 183 CURRENT_TORQUE = 4,
davide.aliprandi@st.com 3:a132aa6d66e4 184 UNKNOW_TORQUE = ((uint8_t)0xFF)
davide.aliprandi@st.com 3:a132aa6d66e4 185 } motorTorqueMode_t;
davide.aliprandi@st.com 3:a132aa6d66e4 186 /**
davide.aliprandi@st.com 3:a132aa6d66e4 187 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 188 */
davide.aliprandi@st.com 3:a132aa6d66e4 189
davide.aliprandi@st.com 3:a132aa6d66e4 190 /** @defgroup Dual_Full_Bridge_Configuration Dual Full Bridge Configuration
davide.aliprandi@st.com 3:a132aa6d66e4 191 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 192 */
davide.aliprandi@st.com 3:a132aa6d66e4 193 ///Dual full bridge configurations for brush DC motors
davide.aliprandi@st.com 3:a132aa6d66e4 194 typedef enum {
davide.aliprandi@st.com 3:a132aa6d66e4 195 PARALLELING_NONE___1_BIDIR_MOTOR_BRIDGE_A__1_BIDIR_MOTOR_BRIDGE_B = 0,
davide.aliprandi@st.com 3:a132aa6d66e4 196 PARALLELING_NONE___1_BIDIR_MOTOR_BRIDGE_A__2_UNDIR_MOTOR_BRIDGE_B = 1,
davide.aliprandi@st.com 3:a132aa6d66e4 197 PARALLELING_NONE___2_UNDIR_MOTOR_BRIDGE_A__1_BIDIR_MOTOR_BRIDGE_B = 2,
davide.aliprandi@st.com 3:a132aa6d66e4 198 PARALLELING_NONE___2_UNDIR_MOTOR_BRIDGE_A__2_UNDIR_MOTOR_BRIDGE_B = 3,
davide.aliprandi@st.com 3:a132aa6d66e4 199 PARALLELING_IN1A_IN2A__1_UNDIR_MOTOR_BRIDGE_A__1_BIDIR_MOTOR_BRIDGE_B = 4,
davide.aliprandi@st.com 3:a132aa6d66e4 200 PARALLELING_IN1A_IN2A__1_UNDIR_MOTOR_BRIDGE_A__2_UNDIR_MOTOR_BRIDGE_B = 5,
davide.aliprandi@st.com 3:a132aa6d66e4 201 PARALLELING_IN1B_IN2B__1_BIDIR_MOTOR_BRIDGE_A__1_UNDIR_MOTOR_BRIDGE_B = 6,
davide.aliprandi@st.com 3:a132aa6d66e4 202 PARALLELING_IN1B_IN2B__2_UNDIR_MOTOR_BRIDGE_A__1_UNDIR_MOTOR_BRIDGE_B = 7,
davide.aliprandi@st.com 3:a132aa6d66e4 203 PARALLELING_IN1A_IN2A__IN1B_IN2B__1_UNDIR_MOTOR_BRIDGE_A__1_UNDIR_MOTOR_BRIDGE_B = 8,
davide.aliprandi@st.com 3:a132aa6d66e4 204 PARALLELING_IN1A_IN2A__IN1B_IN2B__1_BIDIR_MOTOR = 9,
davide.aliprandi@st.com 3:a132aa6d66e4 205 PARALLELING_IN1A_IN1B__IN2A_IN2B__1_UNDIR_MOTOR_BRIDGE_1A__1_UNDIR_MOTOR_BRIDGE_2A = 10,
davide.aliprandi@st.com 3:a132aa6d66e4 206 PARALLELING_IN1A_IN1B__IN2A_IN2B__1_BIDIR_MOTOR = 11,
davide.aliprandi@st.com 3:a132aa6d66e4 207 PARALLELING_ALL_WITH_IN1A___1_UNDIR_MOTOR = 12,
davide.aliprandi@st.com 3:a132aa6d66e4 208 PARALLELING_END_ENUM = 13
davide.aliprandi@st.com 3:a132aa6d66e4 209 } dualFullBridgeConfig_t;
davide.aliprandi@st.com 3:a132aa6d66e4 210 /**
davide.aliprandi@st.com 3:a132aa6d66e4 211 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 212 */
davide.aliprandi@st.com 3:a132aa6d66e4 213
davide.aliprandi@st.com 3:a132aa6d66e4 214 /** @defgroup Motor_Driver_Structure Motor Driver Structure
davide.aliprandi@st.com 3:a132aa6d66e4 215 * @{
davide.aliprandi@st.com 3:a132aa6d66e4 216 */
davide.aliprandi@st.com 3:a132aa6d66e4 217 /**
davide.aliprandi@st.com 3:a132aa6d66e4 218 * @brief MOTOR driver virtual table structure definition.
davide.aliprandi@st.com 3:a132aa6d66e4 219 */
davide.aliprandi@st.com 3:a132aa6d66e4 220 typedef struct
davide.aliprandi@st.com 3:a132aa6d66e4 221 {
davide.aliprandi@st.com 3:a132aa6d66e4 222 /* ACTION ----------------------------------------------------------------*
davide.aliprandi@st.com 3:a132aa6d66e4 223 * Declare here the component's generic functions. *
davide.aliprandi@st.com 3:a132aa6d66e4 224 * Tag this group of functions with the " Generic " C-style comment. *
davide.aliprandi@st.com 3:a132aa6d66e4 225 * A component's interface has to define at least the two generic *
davide.aliprandi@st.com 3:a132aa6d66e4 226 * functions provided here below within the "Example" section, as the *
davide.aliprandi@st.com 3:a132aa6d66e4 227 * first and second functions of its Virtual Table. They have to be *
davide.aliprandi@st.com 3:a132aa6d66e4 228 * specified exactly in the given way. *
davide.aliprandi@st.com 3:a132aa6d66e4 229 * *
davide.aliprandi@st.com 3:a132aa6d66e4 230 * Example: *
davide.aliprandi@st.com 3:a132aa6d66e4 231 * status_t (*init) (void *handle, void *init); *
davide.aliprandi@st.com 3:a132aa6d66e4 232 * status_t (*read_id) (void *handle, uint8_t *id); *
davide.aliprandi@st.com 3:a132aa6d66e4 233 *------------------------------------------------------------------------*/
davide.aliprandi@st.com 3:a132aa6d66e4 234 /* Generic */
davide.aliprandi@st.com 3:a132aa6d66e4 235 status_t (*init)(void *handle, void *init);
davide.aliprandi@st.com 3:a132aa6d66e4 236 status_t (*read_id)(void *handle, uint8_t *id);
davide.aliprandi@st.com 3:a132aa6d66e4 237 /* ACTION ----------------------------------------------------------------*
davide.aliprandi@st.com 3:a132aa6d66e4 238 * Declare here the component's interrupts related functions. *
davide.aliprandi@st.com 3:a132aa6d66e4 239 * Tag this group of functions with the " Interrupts " C-style comment. *
davide.aliprandi@st.com 3:a132aa6d66e4 240 * Do not specify any function if not required. *
davide.aliprandi@st.com 3:a132aa6d66e4 241 * *
davide.aliprandi@st.com 3:a132aa6d66e4 242 * Example: *
davide.aliprandi@st.com 3:a132aa6d66e4 243 * void (*ConfigIT) (void *handle, int a); *
davide.aliprandi@st.com 3:a132aa6d66e4 244 *------------------------------------------------------------------------*/
davide.aliprandi@st.com 3:a132aa6d66e4 245 /* Interrupts */
davide.aliprandi@st.com 3:a132aa6d66e4 246 /// Function pointer to attach_error_handler
davide.aliprandi@st.com 3:a132aa6d66e4 247 void (*attach_error_handler)(void *handle, void (*callback)(void *handle, uint16_t error));
davide.aliprandi@st.com 3:a132aa6d66e4 248 /// Function pointer to attach_flag_interrupt
davide.aliprandi@st.com 3:a132aa6d66e4 249 void (*attach_flag_interrupt)(void *handle, void (*callback)(void *handle));
davide.aliprandi@st.com 3:a132aa6d66e4 250 /// Function pointer to AttachBusyInterrupt
davide.aliprandi@st.com 3:a132aa6d66e4 251 void (*AttachBusyInterrupt)(void *handle, void (*callback)(void *handle));
davide.aliprandi@st.com 3:a132aa6d66e4 252 /// Function pointer to FlagInterruptHandler
davide.aliprandi@st.com 3:a132aa6d66e4 253 void (*FlagInterruptHandler)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 254 /* ACTION ----------------------------------------------------------------*
davide.aliprandi@st.com 3:a132aa6d66e4 255 * Declare here the component's specific functions. *
davide.aliprandi@st.com 3:a132aa6d66e4 256 * Tag this group of functions with the " Specific " C-style comment. *
davide.aliprandi@st.com 3:a132aa6d66e4 257 * Do not specify any function if not required. *
davide.aliprandi@st.com 3:a132aa6d66e4 258 * *
davide.aliprandi@st.com 3:a132aa6d66e4 259 * Example: *
davide.aliprandi@st.com 3:a132aa6d66e4 260 * status_t (*GetValue) (void *handle, float *f); *
davide.aliprandi@st.com 3:a132aa6d66e4 261 *------------------------------------------------------------------------*/
davide.aliprandi@st.com 3:a132aa6d66e4 262 /* Specific */
davide.aliprandi@st.com 3:a132aa6d66e4 263 /// Function pointer to get_acceleration
davide.aliprandi@st.com 3:a132aa6d66e4 264 uint16_t (*get_acceleration)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 265 /// Function pointer to GetCurrentSpeed
davide.aliprandi@st.com 3:a132aa6d66e4 266 uint16_t (*GetCurrentSpeed)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 267 /// Function pointer to get_deceleration
davide.aliprandi@st.com 3:a132aa6d66e4 268 uint16_t (*get_deceleration)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 269 /// Function pointer to get_device_state
davide.aliprandi@st.com 3:a132aa6d66e4 270 motorState_t(*get_device_state)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 271 /// Function pointer to get_fw_version
davide.aliprandi@st.com 3:a132aa6d66e4 272 uint8_t (*get_fw_version)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 273 /// Function pointer to get_mark
davide.aliprandi@st.com 3:a132aa6d66e4 274 int32_t (*get_mark)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 275 /// Function pointer to get_max_speed
davide.aliprandi@st.com 3:a132aa6d66e4 276 uint16_t (*get_max_speed)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 277 /// Function pointer to get_min_speed
davide.aliprandi@st.com 3:a132aa6d66e4 278 uint16_t (*get_min_speed)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 279 /// Function pointer to get_position
davide.aliprandi@st.com 3:a132aa6d66e4 280 int32_t (*get_position)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 281 /// Function pointer to go_home
davide.aliprandi@st.com 3:a132aa6d66e4 282 void (*go_home)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 283 /// Function pointer to go_mark
davide.aliprandi@st.com 3:a132aa6d66e4 284 void (*go_mark)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 285 /// Function pointer to go_to
davide.aliprandi@st.com 3:a132aa6d66e4 286 void (*go_to)(void *handle, int32_t targetPosition);
davide.aliprandi@st.com 3:a132aa6d66e4 287 /// Function pointer to hard_stop
davide.aliprandi@st.com 3:a132aa6d66e4 288 void (*hard_stop)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 289 /// Function pointer to move
davide.aliprandi@st.com 3:a132aa6d66e4 290 void (*move)(void *handle, motorDir_t direction, uint32_t stepCount);
davide.aliprandi@st.com 3:a132aa6d66e4 291 /// Function pointer to ResetAllDevices
davide.aliprandi@st.com 3:a132aa6d66e4 292 //void (*ResetAllDevices)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 293 /// Function pointer to run
davide.aliprandi@st.com 3:a132aa6d66e4 294 void (*run)(void *handle, motorDir_t direction);
davide.aliprandi@st.com 3:a132aa6d66e4 295 /// Function pointer to set_acceleration
davide.aliprandi@st.com 3:a132aa6d66e4 296 bool (*set_acceleration)(void *handle, uint16_t newAcc);
davide.aliprandi@st.com 3:a132aa6d66e4 297 /// Function pointer to set_deceleration
davide.aliprandi@st.com 3:a132aa6d66e4 298 bool (*set_deceleration)(void *handle, uint16_t newDec);
davide.aliprandi@st.com 3:a132aa6d66e4 299 /// Function pointer to set_home
davide.aliprandi@st.com 3:a132aa6d66e4 300 void (*set_home)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 301 /// Function pointer to set_mark
davide.aliprandi@st.com 3:a132aa6d66e4 302 void (*set_mark)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 303 /// Function pointer to set_max_speed
davide.aliprandi@st.com 3:a132aa6d66e4 304 bool (*set_max_speed)(void *handle, uint16_t newMaxSpeed);
davide.aliprandi@st.com 3:a132aa6d66e4 305 /// Function pointer to set_min_speed
davide.aliprandi@st.com 3:a132aa6d66e4 306 bool (*set_min_speed)(void *handle, uint16_t newMinSpeed);
davide.aliprandi@st.com 3:a132aa6d66e4 307 /// Function pointer to soft_stop
davide.aliprandi@st.com 3:a132aa6d66e4 308 bool (*soft_stop)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 309 /// Function pointer to StepClockHandler
davide.aliprandi@st.com 3:a132aa6d66e4 310 void (*StepClockHandler)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 311 /// Function pointer to wait_while_active
davide.aliprandi@st.com 3:a132aa6d66e4 312 void (*wait_while_active)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 313 /// Function pointer to CmdDisable
davide.aliprandi@st.com 3:a132aa6d66e4 314 void (*CmdDisable)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 315 /// Function pointer to CmdEnable
davide.aliprandi@st.com 3:a132aa6d66e4 316 void (*CmdEnable)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 317 /// Function pointer to CmdGetParam
davide.aliprandi@st.com 3:a132aa6d66e4 318 uint32_t (*CmdGetParam)(void *handle, uint32_t param);
davide.aliprandi@st.com 3:a132aa6d66e4 319 /// Function pointer to CmdGetStatus
davide.aliprandi@st.com 3:a132aa6d66e4 320 uint16_t (*CmdGetStatus)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 321 /// Function pointer to CmdNop
davide.aliprandi@st.com 3:a132aa6d66e4 322 void (*CmdNop)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 323 /// Function pointer to CmdSetParam
davide.aliprandi@st.com 3:a132aa6d66e4 324 void (*CmdSetParam)(void *handle, uint32_t param, uint32_t value);
davide.aliprandi@st.com 3:a132aa6d66e4 325 /// Function pointer to read_status_register
davide.aliprandi@st.com 3:a132aa6d66e4 326 uint16_t (*read_status_register)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 327 /// Function pointer to release_reset
davide.aliprandi@st.com 3:a132aa6d66e4 328 void (*release_reset)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 329 /// Function pointer to Reset
davide.aliprandi@st.com 3:a132aa6d66e4 330 void (*Reset)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 331 /// Function pointer to SelectStepMode
davide.aliprandi@st.com 3:a132aa6d66e4 332 void (*SelectStepMode)(void *handle, motorStepMode_t);
davide.aliprandi@st.com 3:a132aa6d66e4 333 /// Function pointer to set_direction
davide.aliprandi@st.com 3:a132aa6d66e4 334 void (*set_direction)(void *handle, motorDir_t direction);
davide.aliprandi@st.com 3:a132aa6d66e4 335 /// Function pointer to CmdGoToDir
davide.aliprandi@st.com 3:a132aa6d66e4 336 void (*CmdGoToDir)(void *handle, motorDir_t direction, int32_t targetPosition);
davide.aliprandi@st.com 3:a132aa6d66e4 337 /// Function pointer to check_busy_hw
davide.aliprandi@st.com 3:a132aa6d66e4 338 uint8_t (*check_busy_hw)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 339 /// Function pointer to check_status_hw
davide.aliprandi@st.com 3:a132aa6d66e4 340 uint8_t (*check_status_hw)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 341 /// Function pointer to CmdGoUntil
davide.aliprandi@st.com 3:a132aa6d66e4 342 void (*CmdGoUntil)(void *handle, motorAction_t action, motorDir_t direction, uint32_t targetPosition);
davide.aliprandi@st.com 3:a132aa6d66e4 343 /// Function pointer to CmdHardHiZ
davide.aliprandi@st.com 3:a132aa6d66e4 344 void (*CmdHardHiZ)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 345 /// Function pointer to CmdReleaseSw
davide.aliprandi@st.com 3:a132aa6d66e4 346 void (*CmdReleaseSw)(void *handle, motorAction_t action, motorDir_t direction);
davide.aliprandi@st.com 3:a132aa6d66e4 347 /// Function pointer to CmdResetDevice
davide.aliprandi@st.com 3:a132aa6d66e4 348 void (*CmdResetDevice)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 349 /// Function pointer to CmdResetPos
davide.aliprandi@st.com 3:a132aa6d66e4 350 void (*CmdResetPos)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 351 /// Function pointer to CmdRun
davide.aliprandi@st.com 3:a132aa6d66e4 352 void (*CmdRun)(void *handle, motorDir_t direction, uint32_t targetPosition);
davide.aliprandi@st.com 3:a132aa6d66e4 353 /// Function pointer to CmdSoftHiZ
davide.aliprandi@st.com 3:a132aa6d66e4 354 void (*CmdSoftHiZ)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 355 /// Function pointer to CmdStepClock
davide.aliprandi@st.com 3:a132aa6d66e4 356 void (*CmdStepClock)(void *handle, motorDir_t direction);
davide.aliprandi@st.com 3:a132aa6d66e4 357 /// Function pointer to fetch_and_clear_all_status
davide.aliprandi@st.com 3:a132aa6d66e4 358 void (*fetch_and_clear_all_status)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 359 /// Function pointer to get_fetched_status
davide.aliprandi@st.com 3:a132aa6d66e4 360 uint16_t (*get_fetched_status)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 361 /// Function pointer to get_nb_devices
davide.aliprandi@st.com 3:a132aa6d66e4 362 uint8_t (*get_nb_devices)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 363 /// Function pointer to is_device_busy
davide.aliprandi@st.com 3:a132aa6d66e4 364 bool (*is_device_busy)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 365 /// Function pointer to send_queued_commands
davide.aliprandi@st.com 3:a132aa6d66e4 366 void (*send_queued_commands)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 367 /// Function pointer to queue_commands
davide.aliprandi@st.com 3:a132aa6d66e4 368 void (*queue_commands)(void *handle, uint8_t command, int32_t value);
davide.aliprandi@st.com 3:a132aa6d66e4 369 /// Function pointer to WaitForAllDevicesNotBusy
davide.aliprandi@st.com 3:a132aa6d66e4 370 void (*WaitForAllDevicesNotBusy)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 371 /// Function pointer to error_handler
davide.aliprandi@st.com 3:a132aa6d66e4 372 void (*error_handler)(void *handle, uint16_t error);
davide.aliprandi@st.com 3:a132aa6d66e4 373 /// Function pointer to BusyInterruptHandler
davide.aliprandi@st.com 3:a132aa6d66e4 374 void (*BusyInterruptHandler)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 375 /// Function pointer to CmdSoftStop
davide.aliprandi@st.com 3:a132aa6d66e4 376 void (*CmdSoftStop)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 377 /// Function pointer to StartStepClock
davide.aliprandi@st.com 3:a132aa6d66e4 378 void (*StartStepClock)(void *handle, uint16_t newFreq);
davide.aliprandi@st.com 3:a132aa6d66e4 379 /// Function pointer to StopStepClock
davide.aliprandi@st.com 3:a132aa6d66e4 380 void (*StopStepClock)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 381 /// Function pointer to set_dual_full_bridge_config
davide.aliprandi@st.com 3:a132aa6d66e4 382 void (*set_dual_full_bridge_config)(void *handle, uint8_t config);
davide.aliprandi@st.com 3:a132aa6d66e4 383 /// Function pointer to get_bridge_input_pwm_freq
davide.aliprandi@st.com 3:a132aa6d66e4 384 uint32_t (*get_bridge_input_pwm_freq)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 385 /// Function pointer to set_bridge_input_pwm_freq
davide.aliprandi@st.com 3:a132aa6d66e4 386 void (*set_bridge_input_pwm_freq)(void *handle, uint32_t newFreq);
davide.aliprandi@st.com 3:a132aa6d66e4 387 /// Function pointer to set_stop_mode
davide.aliprandi@st.com 3:a132aa6d66e4 388 void (*set_stop_mode)(void *handle, motorStopMode_t stopMode);
davide.aliprandi@st.com 3:a132aa6d66e4 389 /// Function pointer to get_stop_mode
davide.aliprandi@st.com 3:a132aa6d66e4 390 motorStopMode_t (*get_stop_mode)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 391 /// Function pointer to set_decay_mode
davide.aliprandi@st.com 3:a132aa6d66e4 392 void (*set_decay_mode)(void *handle, motorDecayMode_t decayMode);
davide.aliprandi@st.com 3:a132aa6d66e4 393 /// Function pointer to get_decay_mode
davide.aliprandi@st.com 3:a132aa6d66e4 394 motorDecayMode_t (*get_decay_mode)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 395 /// Function pointer to get_step_mode
davide.aliprandi@st.com 3:a132aa6d66e4 396 motorStepMode_t (*get_step_mode)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 397 /// Function pointer to get_direction
davide.aliprandi@st.com 3:a132aa6d66e4 398 motorDir_t (*get_direction)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 399 /// Function pointer to ExitDeviceFromReset
davide.aliprandi@st.com 3:a132aa6d66e4 400 void (*ExitDeviceFromReset)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 401 /// Function pointer to set_torque
davide.aliprandi@st.com 3:a132aa6d66e4 402 void (*set_torque)(void *handle, motorTorqueMode_t torqueMode, uint8_t torqueValue);
davide.aliprandi@st.com 3:a132aa6d66e4 403 /// Function pointer to get_torque
davide.aliprandi@st.com 3:a132aa6d66e4 404 uint8_t (*get_torque)(void *handle, motorTorqueMode_t torqueMode);
davide.aliprandi@st.com 3:a132aa6d66e4 405 /// Function pointer to SetVRefFreq
davide.aliprandi@st.com 3:a132aa6d66e4 406 void (*SetRefFreq)(void *handle, uint32_t newFreq);
davide.aliprandi@st.com 3:a132aa6d66e4 407 /// Function pointer to GetVRefFreq
davide.aliprandi@st.com 3:a132aa6d66e4 408 uint32_t (*GetRefFreq)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 409 /// Function pointer to SetVRefDc
davide.aliprandi@st.com 3:a132aa6d66e4 410 void (*SetRefDc)(void *handle, uint8_t newDc);
davide.aliprandi@st.com 3:a132aa6d66e4 411 /// Function pointer to GetVRefDc
davide.aliprandi@st.com 3:a132aa6d66e4 412 uint8_t (*GetRefDc)(void *handle);
davide.aliprandi@st.com 3:a132aa6d66e4 413 /// Function pointer to set_nb_devices
davide.aliprandi@st.com 3:a132aa6d66e4 414 bool (*set_nb_devices)(void *handle, uint8_t nbDevices);
davide.aliprandi@st.com 3:a132aa6d66e4 415 /// Function pointer to set a parameter
davide.aliprandi@st.com 3:a132aa6d66e4 416 bool (*set_analog_value)(void *handle, uint32_t param, float value);
davide.aliprandi@st.com 3:a132aa6d66e4 417 /// Function pointer to get a parameter
davide.aliprandi@st.com 3:a132aa6d66e4 418 float (*get_analog_value)(void *handle, uint32_t param);
davide.aliprandi@st.com 3:a132aa6d66e4 419 } MOTOR_VTable_t;
davide.aliprandi@st.com 3:a132aa6d66e4 420 /**
davide.aliprandi@st.com 3:a132aa6d66e4 421 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 422 */
davide.aliprandi@st.com 3:a132aa6d66e4 423
davide.aliprandi@st.com 3:a132aa6d66e4 424 /**
davide.aliprandi@st.com 3:a132aa6d66e4 425 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 426 */
davide.aliprandi@st.com 3:a132aa6d66e4 427
davide.aliprandi@st.com 3:a132aa6d66e4 428 /**
davide.aliprandi@st.com 3:a132aa6d66e4 429 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 430 */
davide.aliprandi@st.com 3:a132aa6d66e4 431
davide.aliprandi@st.com 3:a132aa6d66e4 432 /**
davide.aliprandi@st.com 3:a132aa6d66e4 433 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 434 */
davide.aliprandi@st.com 3:a132aa6d66e4 435
davide.aliprandi@st.com 3:a132aa6d66e4 436 /**
davide.aliprandi@st.com 3:a132aa6d66e4 437 * @}
davide.aliprandi@st.com 3:a132aa6d66e4 438 */
davide.aliprandi@st.com 3:a132aa6d66e4 439
davide.aliprandi@st.com 3:a132aa6d66e4 440 #ifdef __cplusplus
davide.aliprandi@st.com 3:a132aa6d66e4 441 }
davide.aliprandi@st.com 3:a132aa6d66e4 442 #endif
davide.aliprandi@st.com 3:a132aa6d66e4 443
davide.aliprandi@st.com 3:a132aa6d66e4 444 #endif /* __MOTOR_H */
davide.aliprandi@st.com 3:a132aa6d66e4 445
davide.aliprandi@st.com 3:a132aa6d66e4 446 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/