fsfw/src/fsfw_hal/stm32h7/spi/mspInit.h

124 lines
4.6 KiB
C
Raw Normal View History

2021-07-13 19:19:25 +02:00
#ifndef FSFW_HAL_STM32H7_SPI_MSPINIT_H_
#define FSFW_HAL_STM32H7_SPI_MSPINIT_H_
2022-02-02 10:29:30 +01:00
#include <cstdint>
2021-10-27 18:05:18 +02:00
#include "../definitions.h"
2021-07-13 19:19:25 +02:00
#include "../dma.h"
2022-02-02 10:29:30 +01:00
#include "spiDefinitions.h"
2021-07-13 19:19:25 +02:00
#include "stm32h7xx_hal_spi.h"
#ifdef __cplusplus
extern "C" {
#endif
2022-02-02 10:29:30 +01:00
using mspCb = void (*)(void);
2021-10-27 18:05:18 +02:00
2021-07-13 19:19:25 +02:00
/**
* @brief This file provides MSP implementation for DMA, IRQ and Polling mode for the
* SPI peripheral. This configuration is required for the SPI communication to work.
*/
namespace spi {
struct MspCfgBase {
2022-04-11 17:30:27 +02:00
MspCfgBase() {}
2022-02-02 10:29:30 +01:00
MspCfgBase(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
mspCb cleanupCb = nullptr, mspCb setupCb = nullptr)
: sck(sck), mosi(mosi), miso(miso), cleanupCb(cleanupCb), setupCb(setupCb) {}
2021-10-27 18:05:18 +02:00
2022-02-02 10:29:30 +01:00
virtual ~MspCfgBase() = default;
2021-07-13 19:19:25 +02:00
2022-02-02 10:29:30 +01:00
stm32h7::GpioCfg sck;
stm32h7::GpioCfg mosi;
stm32h7::GpioCfg miso;
2021-10-27 18:05:18 +02:00
2022-02-02 10:29:30 +01:00
mspCb cleanupCb = nullptr;
mspCb setupCb = nullptr;
2021-07-13 19:19:25 +02:00
};
2022-02-02 10:29:30 +01:00
struct MspPollingConfigStruct : public MspCfgBase {
MspPollingConfigStruct() : MspCfgBase(){};
MspPollingConfigStruct(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
mspCb cleanupCb = nullptr, mspCb setupCb = nullptr)
: MspCfgBase(sck, mosi, miso, cleanupCb, setupCb) {}
2021-10-27 18:05:18 +02:00
};
2021-07-13 19:19:25 +02:00
/* A valid instance of this struct must be passed to the MSP initialization function as a void*
argument */
2022-02-02 10:29:30 +01:00
struct MspIrqConfigStruct : public MspPollingConfigStruct {
MspIrqConfigStruct() : MspPollingConfigStruct(){};
MspIrqConfigStruct(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
mspCb cleanupCb = nullptr, mspCb setupCb = nullptr)
: MspPollingConfigStruct(sck, mosi, miso, cleanupCb, setupCb) {}
SpiBus spiBus = SpiBus::SPI_1;
user_handler_t spiIrqHandler = nullptr;
user_args_t spiUserArgs = nullptr;
IRQn_Type spiIrqNumber = SPI1_IRQn;
// Priorities for NVIC
// Pre-Empt priority ranging from 0 to 15. If FreeRTOS calls are used, only 5-15 are allowed
IrqPriorities preEmptPriority = IrqPriorities::LOWEST;
IrqPriorities subpriority = IrqPriorities::LOWEST;
2021-07-13 19:19:25 +02:00
};
/* A valid instance of this struct must be passed to the MSP initialization function as a void*
argument */
2022-02-02 10:29:30 +01:00
struct MspDmaConfigStruct : public MspIrqConfigStruct {
MspDmaConfigStruct() : MspIrqConfigStruct(){};
MspDmaConfigStruct(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
mspCb cleanupCb = nullptr, mspCb setupCb = nullptr)
: MspIrqConfigStruct(sck, mosi, miso, cleanupCb, setupCb) {}
void (*dmaClkEnableWrapper)(void) = nullptr;
dma::DMAIndexes txDmaIndex = dma::DMAIndexes::DMA_1;
dma::DMAIndexes rxDmaIndex = dma::DMAIndexes::DMA_1;
dma::DMAStreams txDmaStream = dma::DMAStreams::STREAM_0;
dma::DMAStreams rxDmaStream = dma::DMAStreams::STREAM_0;
IRQn_Type txDmaIrqNumber = DMA1_Stream0_IRQn;
IRQn_Type rxDmaIrqNumber = DMA1_Stream1_IRQn;
// Priorities for NVIC
IrqPriorities txPreEmptPriority = IrqPriorities::LOWEST;
IrqPriorities rxPreEmptPriority = IrqPriorities::LOWEST;
IrqPriorities txSubpriority = IrqPriorities::LOWEST;
IrqPriorities rxSubpriority = IrqPriorities::LOWEST;
2021-07-13 19:19:25 +02:00
};
2022-02-02 10:29:30 +01:00
using msp_func_t = void (*)(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
2021-07-13 19:19:25 +02:00
2022-02-02 10:29:30 +01:00
void getMspInitFunction(msp_func_t* init_func, MspCfgBase** args);
void getMspDeinitFunction(msp_func_t* deinit_func, MspCfgBase** args);
2021-07-13 19:19:25 +02:00
void halMspInitDma(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
void halMspDeinitDma(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
void halMspInitInterrupt(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
void halMspDeinitInterrupt(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
void halMspInitPolling(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
void halMspDeinitPolling(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
/**
* Assign MSP init functions. Important for SPI configuration
* @param init_func
* @param init_args
* @param deinit_func
* @param deinit_args
*/
2022-02-02 10:29:30 +01:00
void setSpiDmaMspFunctions(MspDmaConfigStruct* cfg, msp_func_t initFunc = &spi::halMspInitDma,
msp_func_t deinitFunc = &spi::halMspDeinitDma);
void setSpiIrqMspFunctions(MspIrqConfigStruct* cfg, msp_func_t initFunc = &spi::halMspInitInterrupt,
msp_func_t deinitFunc = &spi::halMspDeinitInterrupt);
2021-07-13 19:19:25 +02:00
void setSpiPollingMspFunctions(MspPollingConfigStruct* cfg,
2022-02-02 10:29:30 +01:00
msp_func_t initFunc = &spi::halMspInitPolling,
msp_func_t deinitFunc = &spi::halMspDeinitPolling);
2021-07-13 19:19:25 +02:00
2022-02-02 10:29:30 +01:00
void mspErrorHandler(const char* const function, const char* const message);
2021-07-13 19:19:25 +02:00
2022-02-02 10:29:30 +01:00
} // namespace spi
2021-07-13 19:19:25 +02:00
#ifdef __cplusplus
}
#endif
#endif /* FSFW_HAL_STM32H7_SPI_MSPINIT_H_ */