X-CUBE-SPN1-20150128 example source code for one motor compiled under mbed. Tested OK on Nucleo F401. l6474.cpp is modified from original with defines in l6474_target_config.h to select the original behaviour (motor de-energised when halted), or new mode to continue powering with a (reduced) current in the coils (braking/position hold capability). On F401 avoid using mbed's InterruptIn on pins 10-15 (any port). Beware of other conflicts! L0 & F0 are included but untested.
IHM01A1/stm32f4xx_nucleo_ihm01a1.h
- Committer:
- gregeric
- Date:
- 2015-09-05
- Revision:
- 0:b9444a40a999
File content as of revision 0:b9444a40a999:
/** ****************************************************************************** * @file stm32f4xx_nucleo_ihm01a1.h * @author IPC Rennes * @version V1.5.0 * @date November 12, 2014 * @brief Header for BSP driver for x-nucleo-ihm01a1 Nucleo extension board * (based on L6474) ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __STM32F4XX_NUCLEO_IHM01A1_H #define __STM32F4XX_NUCLEO_IHM01A1_H #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ //mbed #include "stm32f4xx_nucleo.h" /** @addtogroup BSP * @{ */ /** @addtogroup STM32F4XX_NUCLEO_IHM01A1 * @{ */ /** @defgroup IHM01A1_Board_Private_Function_Prototypes * @{ */ void BSP_MotorControlBoard_Delay(uint32_t delay); //Delay of the requested number of milliseconds void BSP_MotorControlBoard_DisableIrq(void); //Disable Irq void BSP_MotorControlBoard_EnableIrq(void); //Enable Irq void BSP_MotorControlBoard_GpioInit(uint8_t nbDevices); //Initialise GPIOs used for L6474s void BSP_MotorControlBoard_Pwm1SetFreq(uint16_t newFreq); //Set PWM1 frequency and start it void BSP_MotorControlBoard_Pwm2SetFreq(uint16_t newFreq); //Set PWM2 frequency and start it void BSP_MotorControlBoard_Pwm3SetFreq(uint16_t newFreq); //Set PWM3 frequency and start it void BSP_MotorControlBoard_PwmInit(uint8_t deviceId); //Init the PWM of the specified device void BSP_MotorControlBoard_PwmStop(uint8_t deviceId); //Stop the PWM of the specified device void BSP_MotorControlBoard_ReleaseReset(void); //Reset the L6474 reset pin void BSP_MotorControlBoard_Reset(void); //Set the L6474 reset pin void BSP_MotorControlBoard_SetDirectionGpio(uint8_t deviceId, uint8_t gpioState); //Set direction GPIO uint8_t BSP_MotorControlBoard_SpiInit(void); //Initialise the SPI used for L6474s uint8_t BSP_MotorControlBoard_SpiWriteBytes(uint8_t *pByteToTransmit, uint8_t *pReceivedByte, uint8_t nbDevices); //Write bytes to the L6474s via SPI /* Exported Constants --------------------------------------------------------*/ /** @defgroup IHM01A1_Exported_Constants * @{ */ /******************************************************************************/ /* USE_STM32F4XX_NUCLEO */ /******************************************************************************/ /** @defgroup Constants_For_STM32F4XX_NUCLEO * @{ */ /// Interrupt line used for L6474 FLAG #define EXTI_MCU_LINE_IRQn (EXTI15_10_IRQn) /// Timer used for PWM1 #define BSP_MOTOR_CONTROL_BOARD_TIMER_PWM1 (TIM3) /// Timer used for PWM2 #define BSP_MOTOR_CONTROL_BOARD_TIMER_PWM2 (TIM2) /// Timer used for PWM3 #define BSP_MOTOR_CONTROL_BOARD_TIMER_PWM3 (TIM4) /// Channel Timer used for PWM1 #define BSP_MOTOR_CONTROL_BOARD_CHAN_TIMER_PWM1 (TIM_CHANNEL_2) /// Channel Timer used for PWM2 #define BSP_MOTOR_CONTROL_BOARD_CHAN_TIMER_PWM2 (TIM_CHANNEL_2) /// Channel Timer used for PWM3 #define BSP_MOTOR_CONTROL_BOARD_CHAN_TIMER_PWM3 (TIM_CHANNEL_3) /// HAL Active Channel Timer used for PWM1 #define BSP_MOTOR_CONTROL_BOARD_HAL_ACT_CHAN_TIMER_PWM1 (HAL_TIM_ACTIVE_CHANNEL_2) /// HAL Active Channel Timer used for PWM2 #define BSP_MOTOR_CONTROL_BOARD_HAL_ACT_CHAN_TIMER_PWM2 (HAL_TIM_ACTIVE_CHANNEL_2) /// HAL Active Channel Timer used for PWM3 #define BSP_MOTOR_CONTROL_BOARD_HAL_ACT_CHAN_TIMER_PWM3 (HAL_TIM_ACTIVE_CHANNEL_3) /// Timer Clock Enable for PWM1 #define __BSP_MOTOR_CONTROL_BOARD_TIMER_PWM1_CLCK_ENABLE() __TIM3_CLK_ENABLE() /// Timer Clock Enable for PWM2 #define __BSP_MOTOR_CONTROL_BOARD_TIMER_PWM2_CLCK_ENABLE() __TIM2_CLK_ENABLE() /// Timer Clock Enable for PWM1 #define __BSP_MOTOR_CONTROL_BOARD_TIMER_PWM3_CLCK_ENABLE() __TIM4_CLK_ENABLE() /// Timer Clock Disable for PWM1 #define __BSP_MOTOR_CONTROL_BOARD_TIMER_PWM1_CLCK_DISABLE() __TIM3_CLK_DISABLE() /// Timer Clock Disable for PWM2 #define __BSP_MOTOR_CONTROL_BOARD_TIMER_PWM2_CLCK_DISABLE() __TIM2_CLK_DISABLE() /// Timer Clock Disable for PWM3 #define __BSP_MOTOR_CONTROL_BOARD_TIMER_PWM3_CLCK_DISABLE() __TIM4_CLK_DISABLE() /// PWM1 global interrupt #define BSP_MOTOR_CONTROL_BOARD_PWM1_IRQn (TIM3_IRQn) /// PWM2 global interrupt #define BSP_MOTOR_CONTROL_BOARD_PWM2_IRQn (TIM2_IRQn) /// PWM3 global interrupt #define BSP_MOTOR_CONTROL_BOARD_PWM3_IRQn (TIM4_IRQn) /// PWM1 GPIO alternate function #define BSP_MOTOR_CONTROL_BOARD_AFx_TIMx_PWM1 (GPIO_AF2_TIM3) /// PWM2 GPIO alternate function #define BSP_MOTOR_CONTROL_BOARD_AFx_TIMx_PWM2 (GPIO_AF1_TIM2) #ifndef BSP_MOTOR_CONTROL_BOARD_USE_SPI2 /// SPI SCK AF #define SPIx_SCK_AF (GPIO_AF5_SPI1) #else /* #ifndef BSP_MOTOR_CONTROL_BOARD_USE_SPI2 */ /// SPI SCK AF #define SPIx_SCK_AF (GPIO_AF5_SPI2) #endif /* #ifndef BSP_MOTOR_CONTROL_BOARD_USE_SPI2 */ /// PWM1 frequency rescaler (1 for HW PWM, 2 for SW PWM) #define BSP_MOTOR_CONTROL_BOARD_PWM1_FREQ_RESCALER (1) /// PWM2 frequency rescaler (1 for HW PWM, 2 for SW PWM) #define BSP_MOTOR_CONTROL_BOARD_PWM2_FREQ_RESCALER (1) /// PWM3 frequency rescaler (1 for HW PWM, 2 for SW PWM) #define BSP_MOTOR_CONTROL_BOARD_PWM3_FREQ_RESCALER (2) /** * @} */ /******************************************************************************/ /* Independent plateform definitions */ /******************************************************************************/ /** @defgroup Constants_For_All_Nucleo_Platforms * @{ */ /// GPIO Pin used for the L6474 flag pin #define BSP_MOTOR_CONTROL_BOARD_FLAG_PIN (GPIO_PIN_10) /// GPIO port used for the L6474 flag pin #define BSP_MOTOR_CONTROL_BOARD_FLAG_PORT (GPIOA) /// GPIO Pin used for the L6474 step clock pin of device 0 #define BSP_MOTOR_CONTROL_BOARD_PWM_1_PIN (GPIO_PIN_7) /// GPIO Port used for the L6474 step clock pin of device 0 #define BSP_MOTOR_CONTROL_BOARD_PWM_1_PORT (GPIOC) /// GPIO Pin used for the L6474 step clock pin of device 1 #define BSP_MOTOR_CONTROL_BOARD_PWM_2_PIN (GPIO_PIN_3) /// GPIO port used for the L6474 step clock pin of device 1 #define BSP_MOTOR_CONTROL_BOARD_PWM_2_PORT (GPIOB) /// GPIO Pin used for the L6474 step clock pin of device 2 #define BSP_MOTOR_CONTROL_BOARD_PWM_3_PIN (GPIO_PIN_10) /// GPIO port used for the L6474 step clock pin of device 2 #define BSP_MOTOR_CONTROL_BOARD_PWM_3_PORT (GPIOB) /// GPIO Pin used for the L6474 direction pin of device 0 #define BSP_MOTOR_CONTROL_BOARD_DIR_1_PIN (GPIO_PIN_8) /// GPIO port used for the L6474 direction pin of device 0 #define BSP_MOTOR_CONTROL_BOARD_DIR_1_PORT (GPIOA) /// GPIO Pin used for the L6474 direction pin of device 1 #define BSP_MOTOR_CONTROL_BOARD_DIR_2_PIN (GPIO_PIN_5) /// GPIO port used for the L6474 direction pin of device 1 #define BSP_MOTOR_CONTROL_BOARD_DIR_2_PORT (GPIOB) /// GPIO Pin used for the L6474 direction pin of device 2 #define BSP_MOTOR_CONTROL_BOARD_DIR_3_PIN (GPIO_PIN_4) /// GPIO port used for the L6474 direction pin of device 2 #define BSP_MOTOR_CONTROL_BOARD_DIR_3_PORT (GPIOB) /// GPIO Pin used for the L6474 reset pin #define BSP_MOTOR_CONTROL_BOARD_RESET_PIN (GPIO_PIN_9) /// GPIO port used for the L6474 reset pin #define BSP_MOTOR_CONTROL_BOARD_RESET_PORT (GPIOA) /// GPIO Pin used for the L6474 SPI chip select pin #define BSP_MOTOR_CONTROL_BOARD_CS_PIN (GPIO_PIN_6) /// GPIO port used for the L6474 SPI chip select pin #define BSP_MOTOR_CONTROL_BOARD_CS_PORT (GPIOB) /* Definition for SPIx clock resources */ #ifndef BSP_MOTOR_CONTROL_BOARD_USE_SPI2 /* Default SPI is SPI1 */ /// Used SPI #define SPIx (SPI1) /// SPI clock enable #define SPIx_CLK_ENABLE() __SPI1_CLK_ENABLE() /// SPI SCK enable #define SPIx_SCK_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE() /// SPI MISO enable #define SPIx_MISO_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE() /// SPI MOSI enable #define SPIx_MOSI_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE() /// SPI Force reset #define SPIx_FORCE_RESET() __SPI1_FORCE_RESET() /// SPI Release reset #define SPIx_RELEASE_RESET() __SPI1_RELEASE_RESET() /// SPI SCK pin #define SPIx_SCK_PIN (GPIO_PIN_5) /// SPI SCK port #define SPIx_SCK_GPIO_PORT (GPIOA) /// SPI MISO pin #define SPIx_MISO_PIN (GPIO_PIN_6) /// SPI MISO port #define SPIx_MISO_GPIO_PORT (GPIOA) /// SPI MOSI pin #define SPIx_MOSI_PIN (GPIO_PIN_7) /// SPI MOSI port #define SPIx_MOSI_GPIO_PORT (GPIOA) #else /* USE SPI2 */ /// Used SPI #define SPIx (SPI2) /// SPI clock enable #define SPIx_CLK_ENABLE() __SPI2_CLK_ENABLE() /// SPI SCK enable #define SPIx_SCK_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE() /// SPI MISO enable #define SPIx_MISO_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE() /// SPI MOSI enable #define SPIx_MOSI_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE() /// SPI Force reset #define SPIx_FORCE_RESET() __SPI2_FORCE_RESET() /// SPI Release reset #define SPIx_RELEASE_RESET() __SPI2_RELEASE_RESET() /// SPI SCK pin #define SPIx_SCK_PIN (GPIO_PIN_13) /// SPI SCK port #define SPIx_SCK_GPIO_PORT (GPIOB) /// SPI MISO pin #define SPIx_MISO_PIN (GPIO_PIN_14) /// SPI MISO port #define SPIx_MISO_GPIO_PORT (GPIOB) /// SPI MISO AF #define SPIx_MISO_AF (SPIx_SCK_AF) /// SPI MOSI pin #define SPIx_MOSI_PIN (GPIO_PIN_15) /// SPI MOSI port #define SPIx_MOSI_GPIO_PORT (GPIOB) #endif /// SPI MISO AF #define SPIx_MISO_AF (SPIx_SCK_AF) /// SPI MOSI AF #define SPIx_MOSI_AF (SPIx_SCK_AF) /** * @} */ /** * @} */ #ifdef __cplusplus } #endif #endif /* __STM32F4XX_NUCLEO_IHM01A1_H */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/