Luca Istorico / X_NUCLEO_IHM02A1

Library to handle the X_NUCLEO_IHM02A1 Motor Control Expansion Board based on the L6470 component.

Dependencies:   X_NUCLEO_COMMON

Fork of X_NUCLEO_IHM02A1 by ST

BSP/x_nucleo_ihm02a1_class.cpp@0:92706998571a, 2015-11-20 (annotated)

Committer:
Davidroid
Date:
Fri Nov 20 18:07:45 2015 +0000
Revision:
0:92706998571a
Child:
1:b78dab6d2c58
Library to handle the X_NUCLEO_IHM02A1 Motor Control Expansion Board based on the the L6470 component.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Davidroid 0:92706998571a 1 /**
Davidroid 0:92706998571a 2 ******************************************************************************
Davidroid 0:92706998571a 3 * @file x_nucleo_ihm02a1_class.cpp
Davidroid 0:92706998571a 4 * @author AST / Software Platforms and Cloud
Davidroid 0:92706998571a 5 * @version V1.0
Davidroid 0:92706998571a 6 * @date November 3rd, 2015
Davidroid 0:92706998571a 7 * @brief Implementation file for the X_NUCLEO_IHM02A1 expansion board.
Davidroid 0:92706998571a 8 ******************************************************************************
Davidroid 0:92706998571a 9 * @attention
Davidroid 0:92706998571a 10 *
Davidroid 0:92706998571a 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Davidroid 0:92706998571a 12 *
Davidroid 0:92706998571a 13 * Redistribution and use in source and binary forms, with or without modification,
Davidroid 0:92706998571a 14 * are permitted provided that the following conditions are met:
Davidroid 0:92706998571a 15 * 1. Redistributions of source code must retain the above copyright notice,
Davidroid 0:92706998571a 16 * this list of conditions and the following disclaimer.
Davidroid 0:92706998571a 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Davidroid 0:92706998571a 18 * this list of conditions and the following disclaimer in the documentation
Davidroid 0:92706998571a 19 * and/or other materials provided with the distribution.
Davidroid 0:92706998571a 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Davidroid 0:92706998571a 21 * may be used to endorse or promote products derived from this software
Davidroid 0:92706998571a 22 * without specific prior written permission.
Davidroid 0:92706998571a 23 *
Davidroid 0:92706998571a 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Davidroid 0:92706998571a 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Davidroid 0:92706998571a 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Davidroid 0:92706998571a 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Davidroid 0:92706998571a 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Davidroid 0:92706998571a 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Davidroid 0:92706998571a 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Davidroid 0:92706998571a 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Davidroid 0:92706998571a 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Davidroid 0:92706998571a 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Davidroid 0:92706998571a 34 *
Davidroid 0:92706998571a 35 ******************************************************************************
Davidroid 0:92706998571a 36 */
Davidroid 0:92706998571a 37
Davidroid 0:92706998571a 38
Davidroid 0:92706998571a 39 /* Generated with Stm32CubeTOO -----------------------------------------------*/
Davidroid 0:92706998571a 40
Davidroid 0:92706998571a 41
Davidroid 0:92706998571a 42 /* Includes ------------------------------------------------------------------*/
Davidroid 0:92706998571a 43
Davidroid 0:92706998571a 44 /* ACTION 1 ------------------------------------------------------------------*
Davidroid 0:92706998571a 45 * Include here platform specific header files. *
Davidroid 0:92706998571a 46 *----------------------------------------------------------------------------*/
Davidroid 0:92706998571a 47 #include "mbed.h"
Davidroid 0:92706998571a 48 #include "DevSPI.h"
Davidroid 0:92706998571a 49 /* ACTION 2 ------------------------------------------------------------------*
Davidroid 0:92706998571a 50 * Include here expansion board specific header files. *
Davidroid 0:92706998571a 51 *----------------------------------------------------------------------------*/
Davidroid 0:92706998571a 52 #include "x_nucleo_ihm02a1_class.h"
Davidroid 0:92706998571a 53
Davidroid 0:92706998571a 54
Davidroid 0:92706998571a 55 /* Static variables ----------------------------------------------------------*/
Davidroid 0:92706998571a 56
Davidroid 0:92706998571a 57 /* Singleton instance of X_NUCLEO_IHM02A1 class. */
Davidroid 0:92706998571a 58 X_NUCLEO_IHM02A1 *X_NUCLEO_IHM02A1::_instance;
Davidroid 0:92706998571a 59
Davidroid 0:92706998571a 60 /* Number of instantiated expansion boards. */
Davidroid 0:92706998571a 61 uint8_t X_NUCLEO_IHM02A1::number_of_boards = 0;
Davidroid 0:92706998571a 62
Davidroid 0:92706998571a 63 /**
Davidroid 0:92706998571a 64 * @brief This array contains the initial parameters for the motors that are
Davidroid 0:92706998571a 65 * linked with each L6470 mounted on each stacked X-NUCLEO-IHM02A1.
Davidroid 0:92706998571a 66 */
Davidroid 0:92706998571a 67 const MICROSTEPPING_MOTOR_InitTypeDef X_NUCLEO_IHM02A1::MotorParameterInitData[EXPBRD_MOUNTED_NR_MAX][L6470DAISYCHAINSIZE] =
Davidroid 0:92706998571a 68 {
Davidroid 0:92706998571a 69 {
Davidroid 0:92706998571a 70 {
Davidroid 0:92706998571a 71 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 72 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 73 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 74 },
Davidroid 0:92706998571a 75 {
Davidroid 0:92706998571a 76 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 77 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 78 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 79 },
Davidroid 0:92706998571a 80 },
Davidroid 0:92706998571a 81 {
Davidroid 0:92706998571a 82 {
Davidroid 0:92706998571a 83 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 84 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 85 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 86 },
Davidroid 0:92706998571a 87 {
Davidroid 0:92706998571a 88 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 89 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 90 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 91 },
Davidroid 0:92706998571a 92 },
Davidroid 0:92706998571a 93 {
Davidroid 0:92706998571a 94 {
Davidroid 0:92706998571a 95 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 96 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 97 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 98 },
Davidroid 0:92706998571a 99 {
Davidroid 0:92706998571a 100 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 101 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 102 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 103 },
Davidroid 0:92706998571a 104 },
Davidroid 0:92706998571a 105 {
Davidroid 0:92706998571a 106 {
Davidroid 0:92706998571a 107 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 108 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 109 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 110 },
Davidroid 0:92706998571a 111 {
Davidroid 0:92706998571a 112 9.0, 400, 1.7, 3.06, 300.0, 500.0, 500.0, 400.0, 0.0, 602.7, 3.06, 3.06,\
Davidroid 0:92706998571a 113 3.06, 3.06, 61.52, 392.1569e-6, 643.1372e-6, 643.1372e-6, 0,\
Davidroid 0:92706998571a 114 3.06*1000*1.10, 3.06*1000*1.00, MICROSTEP_1_128, 0xFF, 0x2E88
Davidroid 0:92706998571a 115 },
Davidroid 0:92706998571a 116 },
Davidroid 0:92706998571a 117 };
Davidroid 0:92706998571a 118
Davidroid 0:92706998571a 119
Davidroid 0:92706998571a 120 /* Methods -------------------------------------------------------------------*/
Davidroid 0:92706998571a 121
Davidroid 0:92706998571a 122 /**
Davidroid 0:92706998571a 123 * @brief Constructor.
Davidroid 0:92706998571a 124 * @param flag_irq pin name of the FLAG pin of the component.
Davidroid 0:92706998571a 125 * @param standby_reset pin name of the STBY\RST pin of the component.
Davidroid 0:92706998571a 126 * @param ssel pin name of the SSEL pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 127 * @param spi SPI device to be used for communication.
Davidroid 0:92706998571a 128 */
Davidroid 0:92706998571a 129 X_NUCLEO_IHM02A1::X_NUCLEO_IHM02A1(PinName flag_irq, PinName standby_reset, PinName ssel, DevSPI *spi) : dev_spi(spi)
Davidroid 0:92706998571a 130 {
Davidroid 0:92706998571a 131 /* Instantiating the components. */
Davidroid 0:92706998571a 132 /* ACTION 3 --------------------------------------------------------------*
Davidroid 0:92706998571a 133 * Instantiate here the expansion board's components. *
Davidroid 0:92706998571a 134 * *
Davidroid 0:92706998571a 135 * Example: *
Davidroid 0:92706998571a 136 * component_1 = new COMPONENT_1(COMPONENT_1_SPI_SSEL, *dev_spi); *
Davidroid 0:92706998571a 137 * component_2 = new COMPONENT_2(COMPONENT_2_SPI_SSEL, *dev_spi); *
Davidroid 0:92706998571a 138 *------------------------------------------------------------------------*/
Davidroid 0:92706998571a 139 X_NUCLEO_IHM02A1_Id = number_of_boards++;
Davidroid 0:92706998571a 140 l6470_0 = new L6470(flag_irq, standby_reset, ssel, *dev_spi);
Davidroid 0:92706998571a 141 l6470_1 = new L6470(flag_irq, standby_reset, ssel, *dev_spi);
Davidroid 0:92706998571a 142 }
Davidroid 0:92706998571a 143
Davidroid 0:92706998571a 144 /**
Davidroid 0:92706998571a 145 * @brief Getting a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 146 * @param flag_irq pin name of the FLAG pin of the component.
Davidroid 0:92706998571a 147 * @param standby_reset pin name of the STBY\RST pin of the component.
Davidroid 0:92706998571a 148 * @param ssel pin name of the SSEL pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 149 * @param spi SPI device to be used for communication.
Davidroid 0:92706998571a 150 * @retval a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 151 */
Davidroid 0:92706998571a 152 X_NUCLEO_IHM02A1 *X_NUCLEO_IHM02A1::Instance(PinName flag_irq, PinName standby_reset, PinName ssel, DevSPI *spi)
Davidroid 0:92706998571a 153 {
Davidroid 0:92706998571a 154 if (_instance == NULL)
Davidroid 0:92706998571a 155 {
Davidroid 0:92706998571a 156 /* SPI communication. */
Davidroid 0:92706998571a 157 if (spi == NULL)
Davidroid 0:92706998571a 158 spi = new DevSPI(X_NUCLEO_IHM02A1_PIN_SPI_MOSI, X_NUCLEO_IHM02A1_PIN_SPI_MISO, X_NUCLEO_IHM02A1_PIN_SPI_SCLK);
Davidroid 0:92706998571a 159
Davidroid 0:92706998571a 160 /* Instantiating the board. */
Davidroid 0:92706998571a 161 _instance = new X_NUCLEO_IHM02A1(flag_irq, standby_reset, ssel, spi);
Davidroid 0:92706998571a 162
Davidroid 0:92706998571a 163 /* Initializing the components. */
Davidroid 0:92706998571a 164 if (!_instance->Init())
Davidroid 0:92706998571a 165 error("Initialization of the X_NUCLEO_IHM02A1 expansion board failed.\n");
Davidroid 0:92706998571a 166 }
Davidroid 0:92706998571a 167
Davidroid 0:92706998571a 168 return _instance;
Davidroid 0:92706998571a 169 }
Davidroid 0:92706998571a 170
Davidroid 0:92706998571a 171 /**
Davidroid 0:92706998571a 172 * @brief Getting a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 173 * @param flag_irq pin name of the FLAG pin of the component.
Davidroid 0:92706998571a 174 * @param standby_reset pin name of the STBY\RST pin of the component.
Davidroid 0:92706998571a 175 * @param ssel pin name of the SSEL pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 176 * @param mosi pin name of the MOSI pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 177 * @param miso pin name of the MISO pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 178 * @param sclk pin name of the SCLK pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 179 * @retval a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 180 */
Davidroid 0:92706998571a 181 X_NUCLEO_IHM02A1 *X_NUCLEO_IHM02A1::Instance(PinName flag_irq, PinName standby_reset, PinName ssel, PinName mosi, PinName miso, PinName sclk)
Davidroid 0:92706998571a 182 {
Davidroid 0:92706998571a 183 if (_instance == NULL)
Davidroid 0:92706998571a 184 {
Davidroid 0:92706998571a 185 /* SPI communication. */
Davidroid 0:92706998571a 186 DevSPI *spi = new DevSPI(mosi, miso, sclk);
Davidroid 0:92706998571a 187
Davidroid 0:92706998571a 188 /* Instantiating the board. */
Davidroid 0:92706998571a 189 _instance = new X_NUCLEO_IHM02A1(flag_irq, standby_reset, ssel, spi);
Davidroid 0:92706998571a 190
Davidroid 0:92706998571a 191 /* Initializing the components. */
Davidroid 0:92706998571a 192 if (!_instance->Init())
Davidroid 0:92706998571a 193 error("Initialization of the X_NUCLEO_IHM02A1 expansion board failed.\n");
Davidroid 0:92706998571a 194 }
Davidroid 0:92706998571a 195
Davidroid 0:92706998571a 196 return _instance;
Davidroid 0:92706998571a 197 }
Davidroid 0:92706998571a 198
Davidroid 0:92706998571a 199 /**
Davidroid 0:92706998571a 200 * @brief Initializing the X_NUCLEO_IHM02A1 board.
Davidroid 0:92706998571a 201 * @retval true if initialization is successful, false otherwise.
Davidroid 0:92706998571a 202 */
Davidroid 0:92706998571a 203 bool X_NUCLEO_IHM02A1::Init(void)
Davidroid 0:92706998571a 204 {
Davidroid 0:92706998571a 205 /* Initializing the components. */
Davidroid 0:92706998571a 206 /* ACTION 4 --------------------------------------------------------------*
Davidroid 0:92706998571a 207 * Initialize here the expansion board's components. *
Davidroid 0:92706998571a 208 * *
Davidroid 0:92706998571a 209 * Example: *
Davidroid 0:92706998571a 210 * return (Init_COMPONENT_1() && Init_COMPONENT_2()); *
Davidroid 0:92706998571a 211 *------------------------------------------------------------------------*/
Davidroid 0:92706998571a 212 return (Init_L6470_0() && Init_L6470_1());
Davidroid 0:92706998571a 213 }
Davidroid 0:92706998571a 214
Davidroid 0:92706998571a 215 /* ACTION 5 ------------------------------------------------------------------*
Davidroid 0:92706998571a 216 * Implement here an initialization method for each expansion board's *
Davidroid 0:92706998571a 217 * component. *
Davidroid 0:92706998571a 218 * *
Davidroid 0:92706998571a 219 * Example: *
Davidroid 0:92706998571a 220 * bool EXPANSION_BOARD::Init_COMPONENT_1(void) *
Davidroid 0:92706998571a 221 * { *
Davidroid 0:92706998571a 222 * // Verifying identity. *
Davidroid 0:92706998571a 223 * uint8_t id = 0; *
Davidroid 0:92706998571a 224 * int ret = component_1->ReadID(&id); *
Davidroid 0:92706998571a 225 * if ((ret != COMPONENT_OK) || (id != I_AM_COMPONENT_1)) *
Davidroid 0:92706998571a 226 * { *
Davidroid 0:92706998571a 227 * delete component_1; *
Davidroid 0:92706998571a 228 * component_1 = NULL; *
Davidroid 0:92706998571a 229 * return true; *
Davidroid 0:92706998571a 230 * } *
Davidroid 0:92706998571a 231 * *
Davidroid 0:92706998571a 232 * // Configuration. *
Davidroid 0:92706998571a 233 * INTERFACE_InitTypeDef InitStructure; *
Davidroid 0:92706998571a 234 * InitStructure.Property_1 = COMPONENT_1_PROPERY_1_INIT; *
Davidroid 0:92706998571a 235 * InitStructure.Property_N = COMPONENT_1_PROPERY_N_INIT; *
Davidroid 0:92706998571a 236 * *
Davidroid 0:92706998571a 237 * // Initialization. *
Davidroid 0:92706998571a 238 * if (component_1->Init(&InitStructure) != COMPONENT_OK) *
Davidroid 0:92706998571a 239 * return false; *
Davidroid 0:92706998571a 240 * *
Davidroid 0:92706998571a 241 * return true; *
Davidroid 0:92706998571a 242 * } *
Davidroid 0:92706998571a 243 *----------------------------------------------------------------------------*/
Davidroid 0:92706998571a 244 /**
Davidroid 0:92706998571a 245 * @brief Initialize the L6470 component.
Davidroid 0:92706998571a 246 * @retval true if initialization is successful, false otherwise.
Davidroid 0:92706998571a 247 */
Davidroid 0:92706998571a 248 bool X_NUCLEO_IHM02A1::Init_L6470_0(void)
Davidroid 0:92706998571a 249 {
Davidroid 0:92706998571a 250 /* Initialization. */
Davidroid 0:92706998571a 251 if (l6470_0->Init((void *) &MotorParameterInitData[X_NUCLEO_IHM02A1_Id][0]) != COMPONENT_OK)
Davidroid 0:92706998571a 252 return false;
Davidroid 0:92706998571a 253
Davidroid 0:92706998571a 254 return true;
Davidroid 0:92706998571a 255 }
Davidroid 0:92706998571a 256
Davidroid 0:92706998571a 257 /**
Davidroid 0:92706998571a 258 * @brief Initialize the L6470 component.
Davidroid 0:92706998571a 259 * @retval true if initialization is successful, false otherwise.
Davidroid 0:92706998571a 260 */
Davidroid 0:92706998571a 261 bool X_NUCLEO_IHM02A1::Init_L6470_1(void)
Davidroid 0:92706998571a 262 {
Davidroid 0:92706998571a 263 /* Initialization. */
Davidroid 0:92706998571a 264 if (l6470_1->Init((void *) &MotorParameterInitData[X_NUCLEO_IHM02A1_Id][1]) != COMPONENT_OK)
Davidroid 0:92706998571a 265 return false;
Davidroid 0:92706998571a 266
Davidroid 0:92706998571a 267 return true;
Davidroid 0:92706998571a 268 }
Davidroid 0:92706998571a 269
Davidroid 0:92706998571a 270 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/