precision-converters-firmware
app_config_stm32.h
Go to the documentation of this file.
1 /***************************************************************************/
13 #ifndef APP_CONFIG_STM32_H_
14 #define APP_CONFIG_STM32_H_
15 
16 /******************************************************************************/
17 /***************************** Include Files **********************************/
18 /******************************************************************************/
19 #include <stdint.h>
20 
21 #include "stm32_hal.h"
22 #include "stm32_i2c.h"
23 #include "stm32_irq.h"
24 #include "stm32_gpio_irq.h"
25 #include "stm32_spi.h"
26 #include "stm32_gpio.h"
27 #include "stm32_uart.h"
28 #include "stm32_dma.h"
29 #include "stm32_pwm.h"
30 
31 /******************************************************************************/
32 /********************** Macros and Constants Definition ***********************/
33 /******************************************************************************/
34 /* Note: The SDP-K1 board with the STM32F469NI MCU has been used
35 * for developing the firmware. The below parameters will change depending
36 * on the controller used. */
37 #define TARGET_NAME SDP_K1
38 
39 /* Pin mapping for AD405X w.r.t Arduino Headers */
40 #define I2C_DEV_ID 1 // I2C1
41 #define UART_MODULE 5 // UART5
42 #define UART_IRQ UART5_IRQn
43 #define SPI_DEVICE_ID 1 // SPI1
44 #define SPI_CS_PIN_NUM 15 // PA_15
45 #define STM32_SPI_CS_PORT_BASE GPIOA
46 #define STM32_SPI_CS_PORT_NUM 0 // PORTA = 0
47 #define CNV_PIN_NUM 10 // PA_10
48 #define CNV_PORT_NUM 0 // PORTA = 0
49 #define GP0_PIN_NUM 15 // PB_15
50 #define GP0_PORT_NUM 1 // PORTB = 1
51 #define GP1_PIN_NUM 11 // PG_11
52 #define GP1_PORT_NUM 6 // PORTG = 6
53 #define STM32_GP1_IRQ EXTI15_10_IRQn
54 #define STM32_DMA_CONT_HANDLE hdma_tim1_ch2
55 #define STM32_DMA_CONT_TRIGGER DMA2_Stream2_IRQn
56 #define STM32_DMA_SPI_RX_TRIGGER DMA2_Stream0_IRQn
57 
58 /* Timer specific macros used for calculating pwm
59  * period and duty cycle */
60 #define TIMER_1_PRESCALER 1
61 #define TIMER_2_PRESCALER 0
62 #define TIMER_1_CLK_DIVIDER 2
63 #define TIMER_2_CLK_DIVIDER 2
64 
65 /* Timer Channels */
66 #define TIMER_CHANNEL_1 1
67 #define TIMER_CHANNEL_2 2
68 #define TIMER_CHANNEL_3 3
69 
70 #define TIMER_8_PRESCALER 0
71 #define TIMER_8_CLK_DIVIDER 2
72 
73 #define TRIGGER_GPIO_PORT 0 // Unused macro
74 #define TRIGGER_GPIO_PIN PWM_TRIGGER
75 
76 #define TIMER1_ID 1
77 #define TIMER2_ID 2
78 #define TIMER8_ID 8
79 
80 #define AD405x_DMA_NUM_CHANNELS 2
81 
82 #define AD405x_TxDMA_CHANNEL_NUM DMA_CHANNEL_7
83 #define AD405x_RxDMA_CHANNEL_NUM DMA_CHANNEL_3
84 #define Rx_DMA_IRQ_ID DMA2_Stream0_IRQn
85 
86 /* Redefine the init params structure mapping w.r.t. platform */
87 #define uart_extra_init_params stm32_uart_extra_init_params
88 #define spi_extra_init_params stm32_spi_extra_init_params
89 #define cnv_extra_init_params stm32_gpio_cnv_extra_init_params
90 #define pwm_extra_init_params stm32_pwm_cnv_extra_init_params
91 #define pwm_gpio_extra_init_params stm32_pwm_gpio_extra_init_params
92 #define gp0_extra_init_params stm32_gpio_gp0_extra_init_params
93 #define gp1_extra_init_params stm32_gpio_gp1_extra_init_params
94 #define trigger_gpio_irq_extra_params stm32_gpio_irq_extra_init_params
95 #define dma_extra_init_params stm32_dma_extra_init_params
96 #define cs_extra_init_params stm32_cs_extra_init_params
97 #define tx_trigger_extra_init_params stm32_tx_trigger_extra_init_params
98 
99 /* Platform ops */
100 #define gpio_ops stm32_gpio_ops
101 #define spi_ops stm32_spi_ops
102 #define i2c_ops stm32_i2c_ops
103 #define uart_ops stm32_uart_ops
104 #define pwm_ops stm32_pwm_ops
105 #define trigger_gpio_irq_ops stm32_gpio_irq_ops
106 #define dma_ops stm32_dma_ops
107 
108 #define MAX_SPI_SCLK 22500000
109 #define MAX_SPI_SCLK_45MHz 45000000
110 
111 /* Define the max possible sampling (or output data) rate for a given platform.
112  * This is also used to find the time period to trigger a periodic conversion event.
113  * Note: Max possible ODR is 1000KSPS per channel for burst/continuous data capture on
114  * IIO client. This is derived by testing the firmware on STM32F469NI MCU @22Mhz SPI clock.
115  * The max possible ODR can vary from board to board and data continuity is not guaranteed
116  * above this ODR on IIO oscilloscope
117  */
118 #if (INTERFACE_MODE == SPI_INTERRUPT)
119 #if (APP_CAPTURE_MODE == WINDOWED_DATA_CAPTURE)
120 #define SAMPLING_RATE 62500
121 #else
122 #define SAMPLING_RATE 30000 //Note: Can be set as high as 62500 with -O3 optimization on ARM GCC
123 #endif
124 #define CONV_TRIGGER_DUTY_CYCLE_NSEC(x) (x / 10)
125 #else
126 #define SAMPLING_RATE (1000000)
127 #define DMA_MSB_DUTY_CYCLE_NS 200
128 #define DMA_LSB_DUTY_CYCLE_NS 600
129 #define OUTPUT_COMPARE_DUTY_CYCLE_NS 200
130 #define CHIP_SELECT_DUTY_CYCLE_NS 800
131 #endif
132 #define CONV_TRIGGER_PERIOD_NSEC(x) (((float)(1.0 / x) * 1000000) * 1000)
133 
134 /******************************************************************************/
135 /********************** Public/Extern Declarations ****************************/
136 /******************************************************************************/
137 extern I2C_HandleTypeDef hi2c1;
138 extern SPI_HandleTypeDef hspi1;
139 extern DMA_HandleTypeDef hdma_spi1_rx;
140 extern TIM_HandleTypeDef htim1;
141 extern TIM_HandleTypeDef htim2;
142 extern DMA_HandleTypeDef hdma_tim1_ch3;
143 extern DMA_HandleTypeDef hdma_tim1_ch2;
144 extern DMA_HandleTypeDef hdma_tim8_ch1;
145 extern UART_HandleTypeDef huart5;
146 extern volatile bool data_ready;
147 
148 extern struct stm32_uart_init_param stm32_uart_extra_init_params;
149 extern struct stm32_spi_init_param stm32_spi_extra_init_params;
150 extern struct stm32_gpio_init_param stm32_pwm_gpio_extra_init_params;
151 extern struct stm32_gpio_init_param stm32_gpio_cnv_extra_init_params;
152 extern struct stm32_gpio_init_param stm32_gpio_gp0_extra_init_params;
153 extern struct stm32_gpio_init_param stm32_gpio_gp1_extra_init_params;
154 extern struct stm32_gpio_init_param stm32_cs_pwm_gpio_extra_init_params;
155 extern struct stm32_gpio_irq_init_param stm32_gpio_irq_extra_init_params;
156 
157 extern struct stm32_pwm_init_param stm32_pwm_cnv_extra_init_params;
158 #if (INTERFACE_MODE == SPI_DMA)
159 extern struct stm32_pwm_init_param stm32_dma_extra_init_params;
160 extern struct stm32_pwm_init_param stm32_oc_extra_init_params;
161 extern struct stm32_pwm_init_param stm32_cs_extra_init_params;
162 extern struct stm32_pwm_init_param stm32_tx_trigger_extra_init_params;
163 extern volatile bool ad405x_conversion_flag;
164 extern struct stm32_dma_init_param stm32_spi_dma_extra_init_params;
165 extern struct stm32_dma_channel rxdma_channel;
166 extern struct stm32_dma_channel txdma_channel;
167 extern uint32_t rxdma_ndtr;
168 #endif
169 
170 extern int dma_cycle_count;
171 void halfcmplt_callback(DMA_HandleTypeDef * hdma);
172 void update_buff(uint32_t* local_buf, uint32_t* buf_start_addr);
173 void stm32_system_init(void);
174 void stm32_timer_enable(void);
175 void stm32_timer_stop(void);
176 void stm32_cs_output_gpio_config(bool is_gpio);
177 void stm32_cnv_output_gpio_config(bool is_gpio);
178 void stm32_configure_spi_dma(struct no_os_spi_init_param* spi_init_par,
179  struct no_os_spi_desc* spi_desc, bool is_dma_mode);
180 int stm32_abort_dma_transfer(void);
181 void receivecomplete_callback(DMA_HandleTypeDef * hdma);
182 void tim8_config(void);
183 void tim1_config(void);
184 
185 #endif /* APP_CONFIG_STM32_H_ */
UART_HandleTypeDef huart5
SPI_HandleTypeDef hspi1
struct stm32_dma_channel txdma_channel
Definition: app_config_stm32.c:29
DMA_HandleTypeDef hdma_tim1_ch2
struct stm32_dma_init_param stm32_spi_dma_extra_init_params
void tim1_config(void)
Configure CNV timer.
Definition: app_config_stm32.c:402
TIM_HandleTypeDef htim1
TIM_HandleTypeDef htim2
DMA_HandleTypeDef hdma_tim8_ch1
struct stm32_pwm_init_param stm32_oc_extra_init_params
volatile bool data_ready
Definition: ad405x_iio.c:168
volatile bool ad405x_conversion_flag
Definition: app_config_stm32.c:151
struct stm32_dma_channel rxdma_channel
Definition: app_config_stm32.c:39
uint32_t rxdma_ndtr
Definition: app_config_stm32.c:159
void stm32_cs_output_gpio_config(bool is_gpio)
Configures the chip select pin as output mode.
Definition: app_config_stm32.c:344
void stm32_system_init(void)
Initialize the STM32 system peripherals.
Definition: app_config_stm32.c:111
void halfcmplt_callback(DMA_HandleTypeDef *hdma)
Callback function to flag the capture of half the number of requested samples.
Definition: app_config_stm32.c:233
void tim8_config(void)
Configure Tx Trigger timer.
Definition: app_config_stm32.c:412
struct stm32_pwm_init_param stm32_cs_extra_init_params
Definition: app_config_stm32.c:125
void stm32_timer_enable(void)
Starts the timer signal generation for PWM and OC channels all at once.
Definition: app_config_stm32.c:267
struct stm32_gpio_init_param stm32_gpio_cnv_extra_init_params
Definition: app_config_stm32.c:60
void receivecomplete_callback(DMA_HandleTypeDef *hdma)
Callback function to flag the capture of number of requested samples.
Definition: app_config_stm32.c:306
struct stm32_pwm_init_param stm32_pwm_cnv_extra_init_params
Definition: app_config_stm32.c:112
DMA_HandleTypeDef hdma_tim1_ch3
int dma_cycle_count
Definition: app_config_stm32.c:156
struct stm32_pwm_init_param stm32_tx_trigger_extra_init_params
Definition: app_config_stm32.c:135
void stm32_cnv_output_gpio_config(bool is_gpio)
Configures the conversion pin as output mode.
Definition: app_config_stm32.c:363
struct stm32_pwm_init_param stm32_dma_extra_init_params
int stm32_abort_dma_transfer(void)
Abort ongoing SPI RX DMA transfer.
Definition: app_config_stm32.c:380
struct stm32_gpio_init_param stm32_pwm_gpio_extra_init_params
Definition: app_config_stm32.c:102
struct stm32_uart_init_param stm32_uart_extra_init_params
Definition: app_config_stm32.c:49
struct stm32_gpio_irq_init_param stm32_gpio_irq_extra_init_params
Definition: app_config_stm32.c:78
DMA_HandleTypeDef hdma_spi1_rx
void stm32_configure_spi_dma(struct no_os_spi_init_param *spi_init_par, struct no_os_spi_desc *spi_desc, bool is_dma_mode)
void stm32_timer_stop(void)
Stops generating timer signals.
Definition: app_config_stm32.c:285
void update_buff(uint32_t *local_buf, uint32_t *buf_start_addr)
Update buffer index.
Definition: app_config_stm32.c:253
struct stm32_spi_init_param stm32_spi_extra_init_params
Definition: app_config_stm32.c:54
struct stm32_gpio_init_param stm32_cs_pwm_gpio_extra_init_params
Definition: app_config_stm32.c:89
I2C_HandleTypeDef hi2c1
struct stm32_gpio_init_param stm32_gpio_gp0_extra_init_params
Definition: app_config_stm32.c:66
struct stm32_gpio_init_param stm32_gpio_gp1_extra_init_params
Definition: app_config_stm32.c:72
uint8_t local_buf[MAX_LOCAL_BUF_SIZE]
Definition: ad405x_iio.c:177