JHE YU CHEN / X_NUCLEO_IHM02A1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Fork of X_NUCLEO_IHM02A1 by ST

BSP/x_nucleo_ihm02a1_class.h@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.h
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 Class header 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 /* Define to prevent recursive inclusion -------------------------------------*/
Davidroid 0:92706998571a 43
Davidroid 0:92706998571a 44 #ifndef __X_NUCLEO_IHM02A1_CLASS_H
Davidroid 0:92706998571a 45 #define __X_NUCLEO_IHM02A1_CLASS_H
Davidroid 0:92706998571a 46
Davidroid 0:92706998571a 47
Davidroid 0:92706998571a 48 /* Includes ------------------------------------------------------------------*/
Davidroid 0:92706998571a 49
Davidroid 0:92706998571a 50 /* ACTION 1 ------------------------------------------------------------------*
Davidroid 0:92706998571a 51 * Include here platform specific header files. *
Davidroid 0:92706998571a 52 *----------------------------------------------------------------------------*/
Davidroid 0:92706998571a 53 #include "mbed.h"
Davidroid 0:92706998571a 54 #include "DevSPI.h"
Davidroid 0:92706998571a 55 /* ACTION 2 ------------------------------------------------------------------*
Davidroid 0:92706998571a 56 * Include here expansion board specific header files. *
Davidroid 0:92706998571a 57 *----------------------------------------------------------------------------*/
Davidroid 0:92706998571a 58 #include "x_nucleo_ihm02a1_config.h"
Davidroid 0:92706998571a 59 /* ACTION 3 ------------------------------------------------------------------*
Davidroid 0:92706998571a 60 * Include here expansion board's components' header files. *
Davidroid 0:92706998571a 61 * *
Davidroid 0:92706998571a 62 * Example: *
Davidroid 0:92706998571a 63 * #include "component_1_class.h" *
Davidroid 0:92706998571a 64 * #include "component_2_class.h" *
Davidroid 0:92706998571a 65 *----------------------------------------------------------------------------*/
Davidroid 0:92706998571a 66 #include "l6470_class.h"
Davidroid 0:92706998571a 67
Davidroid 0:92706998571a 68
Davidroid 0:92706998571a 69 /* Classes -------------------------------------------------------------------*/
Davidroid 0:92706998571a 70
Davidroid 0:92706998571a 71 /** Class representing a X_NUCLEO_IHM02A1 board.
Davidroid 0:92706998571a 72 */
Davidroid 0:92706998571a 73 class X_NUCLEO_IHM02A1
Davidroid 0:92706998571a 74 {
Davidroid 0:92706998571a 75 public:
Davidroid 0:92706998571a 76
Davidroid 0:92706998571a 77 /*** Instance, Initialization and Destructor Methods ***/
Davidroid 0:92706998571a 78
Davidroid 0:92706998571a 79 /**
Davidroid 0:92706998571a 80 * @brief Getting a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 81 * @param flag_irq pin name of the FLAG pin of the component.
Davidroid 0:92706998571a 82 * @param standby_reset pin name of the STBY\RST pin of the component.
Davidroid 0:92706998571a 83 * @param ssel pin name of the SSEL pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 84 * @param spi SPI device to be used for communication.
Davidroid 0:92706998571a 85 * @retval a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 86 */
Davidroid 0:92706998571a 87 static X_NUCLEO_IHM02A1 *Instance(PinName flag_irq, PinName standby_reset, PinName ssel, DevSPI *spi = NULL);
Davidroid 0:92706998571a 88
Davidroid 0:92706998571a 89 /**
Davidroid 0:92706998571a 90 * @brief Getting a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 91 * @param flag_irq pin name of the FLAG pin of the component.
Davidroid 0:92706998571a 92 * @param standby_reset pin name of the STBY\RST pin of the component.
Davidroid 0:92706998571a 93 * @param ssel pin name of the SSEL pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 94 * @param mosi pin name of the MOSI pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 95 * @param miso pin name of the MISO pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 96 * @param sclk pin name of the SCLK pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 97 * @retval a singleton instance of X_NUCLEO_IHM02A1 class.
Davidroid 0:92706998571a 98 */
Davidroid 0:92706998571a 99 static X_NUCLEO_IHM02A1 *Instance(PinName flag_irq, PinName standby_reset, PinName ssel, PinName miso, PinName mosi, PinName sclk);
Davidroid 0:92706998571a 100
Davidroid 0:92706998571a 101 /**
Davidroid 0:92706998571a 102 * @brief Initializing the X_NUCLEO_IHM02A1 board.
Davidroid 0:92706998571a 103 * @retval true if initialization is successful, false otherwise.
Davidroid 0:92706998571a 104 */
Davidroid 0:92706998571a 105 bool Init(void);
Davidroid 0:92706998571a 106
Davidroid 0:92706998571a 107 /**
Davidroid 0:92706998571a 108 * @brief Destructor.
Davidroid 0:92706998571a 109 */
Davidroid 0:92706998571a 110 ~X_NUCLEO_IHM02A1(void) {}
Davidroid 0:92706998571a 111
Davidroid 0:92706998571a 112
Davidroid 0:92706998571a 113 /*** Public Expansion Board Related Attributes ***/
Davidroid 0:92706998571a 114
Davidroid 0:92706998571a 115 /* ACTION 4 --------------------------------------------------------------*
Davidroid 0:92706998571a 116 * Declare here a public attribute for each expansion board's component. *
Davidroid 0:92706998571a 117 * You will have to call these attributes' public methods within your *
Davidroid 0:92706998571a 118 * main program. *
Davidroid 0:92706998571a 119 * *
Davidroid 0:92706998571a 120 * Example: *
Davidroid 0:92706998571a 121 * COMPONENT_1 *component_1; *
Davidroid 0:92706998571a 122 * COMPONENT_2 *component_2; *
Davidroid 0:92706998571a 123 *------------------------------------------------------------------------*/
Davidroid 0:92706998571a 124 L6470 *l6470_0;
Davidroid 0:92706998571a 125 L6470 *l6470_1;
Davidroid 0:92706998571a 126
Davidroid 0:92706998571a 127 /* Static data. */
Davidroid 0:92706998571a 128 static const MICROSTEPPING_MOTOR_InitTypeDef MotorParameterInitData[EXPBRD_MOUNTED_NR_MAX][L6470DAISYCHAINSIZE];
Davidroid 0:92706998571a 129
Davidroid 0:92706998571a 130
Davidroid 0:92706998571a 131 protected:
Davidroid 0:92706998571a 132
Davidroid 0:92706998571a 133 /*** Protected Constructor Method ***/
Davidroid 0:92706998571a 134
Davidroid 0:92706998571a 135 /**
Davidroid 0:92706998571a 136 * @brief Constructor.
Davidroid 0:92706998571a 137 * @param flag_irq pin name of the FLAG pin of the component.
Davidroid 0:92706998571a 138 * @param standby_reset pin name of the STBY\RST pin of the component.
Davidroid 0:92706998571a 139 * @param ssel pin name of the SSEL pin of the SPI device to be used for communication.
Davidroid 0:92706998571a 140 * @param spi SPI device to be used for communication.
Davidroid 0:92706998571a 141 */
Davidroid 0:92706998571a 142 X_NUCLEO_IHM02A1(PinName flag_irq, PinName standby_reset, PinName ssel, DevSPI *spi);
Davidroid 0:92706998571a 143
Davidroid 0:92706998571a 144
Davidroid 0:92706998571a 145 /*** Protected Expansion Board Related Initialization Methods ***/
Davidroid 0:92706998571a 146
Davidroid 0:92706998571a 147 /* ACTION 5 --------------------------------------------------------------*
Davidroid 0:92706998571a 148 * Declare here a protected initialization method for each expansion *
Davidroid 0:92706998571a 149 * board's component. *
Davidroid 0:92706998571a 150 * *
Davidroid 0:92706998571a 151 * Example: *
Davidroid 0:92706998571a 152 * bool Init_COMPONENT_1(void); *
Davidroid 0:92706998571a 153 * bool Init_COMPONENT_2(void); *
Davidroid 0:92706998571a 154 *------------------------------------------------------------------------*/
Davidroid 0:92706998571a 155 bool Init_L6470_0(void);
Davidroid 0:92706998571a 156 bool Init_L6470_1(void);
Davidroid 0:92706998571a 157
Davidroid 0:92706998571a 158
Davidroid 0:92706998571a 159 /*** Component's Instance Variables ***/
Davidroid 0:92706998571a 160
Davidroid 0:92706998571a 161 /* Singleton instance of X_NUCLEO_IHM02A1 class. */
Davidroid 0:92706998571a 162 static X_NUCLEO_IHM02A1 *_instance;
Davidroid 0:92706998571a 163
Davidroid 0:92706998571a 164 /* IO Device. */
Davidroid 0:92706998571a 165 DevSPI *dev_spi;
Davidroid 0:92706998571a 166
Davidroid 0:92706998571a 167 /* Data. */
Davidroid 0:92706998571a 168 /* ACTION 11 -------------------------------------------------------------*
Davidroid 0:92706998571a 169 * Declare here the component's data, one variable per line. *
Davidroid 0:92706998571a 170 * *
Davidroid 0:92706998571a 171 * Example: *
Davidroid 0:92706998571a 172 * uint8_t ExpansionBoard_Id; *
Davidroid 0:92706998571a 173 *------------------------------------------------------------------------*/
Davidroid 0:92706998571a 174 uint8_t X_NUCLEO_IHM02A1_Id;
Davidroid 0:92706998571a 175
Davidroid 0:92706998571a 176 /* Static data. */
Davidroid 0:92706998571a 177 static uint8_t number_of_boards;
Davidroid 0:92706998571a 178 };
Davidroid 0:92706998571a 179
Davidroid 0:92706998571a 180 #endif // __X_NUCLEO_IHM02A1_CLASS_H
Davidroid 0:92706998571a 181
Davidroid 0:92706998571a 182 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/