diff --git a/.gitignore b/.gitignore index fdc4b61..4e5f666 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ -/MyLibsGeneral/.vscode/ -/Doc/ \ No newline at end of file +/MyLibsGeneral/.vscode/ \ No newline at end of file diff --git a/Doc/html/_s_p_i__usage__example-example.html b/Doc/html/_s_p_i__usage__example-example.html new file mode 100644 index 0000000..e9f6df9 --- /dev/null +++ b/Doc/html/_s_p_i__usage__example-example.html @@ -0,0 +1,165 @@ + + +
+ + + + +|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Пример использования SPI_Base_Init.
+Пример использования SPI_Base_Init. Инициализация SPI1 с базовыми настройками:
|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Модуль для инициализации SPI. +More...
+Go to the source code of this file.
++Functions | |
| HAL_StatusTypeDef | SPI_Base_Init (SPI_SettingsTypeDef *sspi) |
| Инициализация SPI с помощью структуры SPI_SettingsTypeDef. | |
| void | SPI_GPIO_Init (SPI_SettingsTypeDef *sspi) |
| Инициализация GPIO для SPI. | |
| void | SPI_DMA_Init (SPI_HandleTypeDef *hspi, DMA_HandleTypeDef *hdma_rx, DMA_Stream_TypeDef *DMAChannel, uint32_t DMA_CHANNEL_X) |
| void | SPI_MspInit (SPI_HandleTypeDef *hspi) |
| Настройка тактирования и прерываний SPI. | |
| void | SPI_MspDeInit (SPI_HandleTypeDef *hspi) |
| Деинициализация тактирования и прерываний SPI. | |
| HAL_StatusTypeDef | SPI_Check_Init_Struct (SPI_SettingsTypeDef *sspi) |
| Проверка корректности структуры инициализации SPI. | |
Модуль для инициализации SPI.
+Реализация функций для работы с SPI:
Definition in file general_spi.c.
+| void SPI_GPIO_Init | +( | +SPI_SettingsTypeDef * | sspi | ) | ++ |
Инициализация GPIO для SPI.
+| sspi | Указатель на структуру с настройками SPI. |
Definition at line 58 of file general_spi.c.
+ +| void SPI_DMA_Init | +( | +SPI_HandleTypeDef * | hspi, | +
| + | + | DMA_HandleTypeDef * | hdma_rx, | +
| + | + | DMA_Stream_TypeDef * | DMAChannel, | +
| + | + | uint32_t | DMA_CHANNEL_X ) | +
Definition at line 89 of file general_spi.c.
+ +|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Заголовочный файл для модуля инициализации SPI. +More...
+#include "mylibs_defs.h"Go to the source code of this file.
++Classes | |
| struct | SPI_SettingsTypeDef |
| Структура настроек SPI. More... | |
+Macros | |
| #define | HAL_SPI_MODULE_ENABLED |
| Включение HAL SPI. | |
| #define | USE_SPI1 |
| Включить SPI1 в SPI_MspInit. | |
| #define | USE_SPI2 |
| Включить SPI2 в SPI_MspInit. | |
| #define | USE_SPI3 |
| Включить SPI3 в SPI_MspInit. | |
+Functions | |
| HAL_StatusTypeDef | SPI_Base_Init (SPI_SettingsTypeDef *sspi) |
| Инициализация SPI с помощью структуры SPI_SettingsTypeDef. | |
| HAL_StatusTypeDef | SPI_Check_Init_Struct (SPI_SettingsTypeDef *sspi) |
| Проверка корректности структуры инициализации SPI. | |
| void | SPI_MspInit (SPI_HandleTypeDef *hspi) |
| Настройка тактирования и прерываний SPI. | |
| void | SPI_MspDeInit (SPI_HandleTypeDef *hspi) |
| Деинициализация тактирования и прерываний SPI. | |
Заголовочный файл для модуля инициализации SPI.
+ +Definition in file general_spi.h.
+|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Модуль для инициализации UART. +More...
+Go to the source code of this file.
++Functions | |
| HAL_StatusTypeDef | UART_Base_Init (UART_SettingsTypeDef *suart) |
| Инициализация UART с помощью структуры UART_SettingsTypeDef. | |
| void | UART_GPIO_Init (GPIO_TypeDef *GPIOx, uint16_t GPIO_PIN_RX, uint16_t GPIO_PIN_TX) |
| Инициализация GPIO для UART. | |
| void | UART_DMA_Init (UART_HandleTypeDef *huart, DMA_HandleTypeDef *hdma_rx, DMA_Stream_TypeDef *DMAChannel, uint32_t DMA_CHANNEL_X) |
| Инициализация DMA для UART. | |
| void | UART_MspInit (UART_HandleTypeDef *huart) |
| Настройка тактирования и прерываний UART. | |
| void | UART_MspDeInit (UART_HandleTypeDef *huart) |
| Деинициализация тактирования и прерываний UART. | |
| HAL_StatusTypeDef | UART_Check_Init_Struct (UART_SettingsTypeDef *suart) |
| Проверка корректности структуры инициализации UART. | |
Модуль для инициализации UART.
+Реализация функций для работы с UART:
Definition in file general_uart.c.
+| void UART_GPIO_Init | +( | +GPIO_TypeDef * | GPIOx, | +
| + | + | uint16_t | GPIO_PIN_RX, | +
| + | + | uint16_t | GPIO_PIN_TX ) | +
Инициализация GPIO для UART.
+| GPIOx | Порт для настройки. |
| GPIO_PIN_RX | Пин для приема. |
| GPIO_PIN_TX | Пин для передачи. |
Definition at line 69 of file general_uart.c.
+ +| void UART_DMA_Init | +( | +UART_HandleTypeDef * | huart, | +
| + | + | DMA_HandleTypeDef * | hdma_rx, | +
| + | + | DMA_Stream_TypeDef * | DMAChannel, | +
| + | + | uint32_t | DMA_CHANNEL_X ) | +
Инициализация DMA для UART.
+| huart | Указатель на хендл UART. |
| hdma_rx | Указатель на хендл DMA для линии приема UART. |
| DMAChannel | Указатель на канал DMA/поток DMA в STM32F407. |
| DMA_CHANNEL_X | Канал DMA. |
Definition at line 109 of file general_uart.c.
+ +|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Заголовочный файл для модуля инициализации UART. +More...
+#include "mylibs_defs.h"Go to the source code of this file.
++Classes | |
| struct | UART_SettingsTypeDef |
| Структура настроек UART. More... | |
+Macros | |
| #define | HAL_UART_MODULE_ENABLED |
| Включение HAL UART. | |
| #define | USE_USART1 |
| Включить USART1 в UART_MspInit. | |
| #define | USE_USART2 |
| Включить USART2 в UART_MspInit. | |
| #define | USE_USART3 |
| Включить USART3 в UART_MspInit. | |
| #define | USE_UART4 |
| Включить UART4 в UART_MspInit. | |
| #define | USE_UART5 |
| Включить UART5 в UART_MspInit. | |
| #define | USE_USART6 |
| Включить USART6 в UART_MspInit. | |
+Functions | |
| HAL_StatusTypeDef | UART_Base_Init (UART_SettingsTypeDef *suart) |
| Инициализация UART с помощью структуры UART_SettingsTypeDef. | |
| HAL_StatusTypeDef | UART_Check_Init_Struct (UART_SettingsTypeDef *suart) |
| Проверка корректности структуры инициализации UART. | |
| void | UART_MspInit (UART_HandleTypeDef *huart) |
| Настройка тактирования и прерываний UART. | |
| void | UART_MspDeInit (UART_HandleTypeDef *huart) |
| Деинициализация тактирования и прерываний UART. | |
Заголовочный файл для модуля инициализации UART.
+ +Definition in file general_uart.h.
+|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Функции и макросы для удобной работы с SPI. +More...
++Topics | |
| Init defines | |
| Настройка SPI. | |
+Classes | |
| struct | SPI_SettingsTypeDef |
| Структура настроек SPI. More... | |
+Functions | |
| HAL_StatusTypeDef | SPI_Base_Init (SPI_SettingsTypeDef *sspi) |
| Инициализация SPI с помощью структуры SPI_SettingsTypeDef. | |
| HAL_StatusTypeDef | SPI_Check_Init_Struct (SPI_SettingsTypeDef *sspi) |
| Проверка корректности структуры инициализации SPI. | |
| void | SPI_MspInit (SPI_HandleTypeDef *hspi) |
| Настройка тактирования и прерываний SPI. | |
| void | SPI_MspDeInit (SPI_HandleTypeDef *hspi) |
| Деинициализация тактирования и прерываний SPI. | |
Функции и макросы для удобной работы с SPI.
+Модуль предоставляет функции для базовой инициализации SPI
+| HAL_StatusTypeDef SPI_Base_Init | +( | +SPI_SettingsTypeDef * | sspi | ) | ++ |
Инициализация SPI с помощью структуры SPI_SettingsTypeDef.
+| sspi | Указатель на структуру с настройками SPI. |
+ Инициализирует SPI и его GPIO. Настройка аналогична HAL_SPI_Init
но дополнительно надо прописать пины CLK/MISO/MOSI SPI_SettingsTypeDef
+ +Definition at line 28 of file general_spi.c.
+ +| HAL_StatusTypeDef SPI_Check_Init_Struct | +( | +SPI_SettingsTypeDef * | sspi | ) | ++ |
Проверка корректности структуры инициализации SPI.
+| sspi | Указатель на структуру с настройками SPI. |
Definition at line 246 of file general_spi.c.
+ +| void SPI_MspInit | +( | +SPI_HandleTypeDef * | hspi | ) | ++ |
Настройка тактирования и прерываний SPI.
+| hspi | Указатель на хендл SPI. |
Definition at line 127 of file general_spi.c.
+ +| void SPI_MspDeInit | +( | +SPI_HandleTypeDef * | hspi | ) | ++ |
Деинициализация тактирования и прерываний SPI.
+| hspi | Указатель на хендл SPI. |
Definition at line 191 of file general_spi.c.
+ +|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Функции и макросы для удобной работы с UART. +More...
++Topics | |
| Init defines | |
| Настройка UART. | |
+Classes | |
| struct | UART_SettingsTypeDef |
| Структура настроек UART. More... | |
+Functions | |
| HAL_StatusTypeDef | UART_Base_Init (UART_SettingsTypeDef *suart) |
| Инициализация UART с помощью структуры UART_SettingsTypeDef. | |
| HAL_StatusTypeDef | UART_Check_Init_Struct (UART_SettingsTypeDef *suart) |
| Проверка корректности структуры инициализации UART. | |
| void | UART_MspInit (UART_HandleTypeDef *huart) |
| Настройка тактирования и прерываний UART. | |
| void | UART_MspDeInit (UART_HandleTypeDef *huart) |
| Деинициализация тактирования и прерываний UART. | |
Функции и макросы для удобной работы с UART.
+Модуль предоставляет функции для базовой инициализации UART
+| HAL_StatusTypeDef UART_Base_Init | +( | +UART_SettingsTypeDef * | suart | ) | ++ |
Инициализация UART с помощью структуры UART_SettingsTypeDef.
+| suart | Указатель на структуру с настройками UART. |
+ Инициализирует UART и его GPIO и при необходимости DMA. Настройка аналогична HAL_UART_Init
но дополнительно надо прописать пины RX/TX UART_SettingsTypeDef
Definition at line 32 of file general_uart.c.
+ +| HAL_StatusTypeDef UART_Check_Init_Struct | +( | +UART_SettingsTypeDef * | suart | ) | ++ |
Проверка корректности структуры инициализации UART.
+| suart | Указатель на структуру с настройками UART. |
Definition at line 364 of file general_uart.c.
+ +| void UART_MspInit | +( | +UART_HandleTypeDef * | huart | ) | ++ |
Настройка тактирования и прерываний UART.
+| huart | Указатель на хендл UART. |
Definition at line 146 of file general_uart.c.
+ +| void UART_MspDeInit | +( | +UART_HandleTypeDef * | huart | ) | ++ |
Деинициализация тактирования и прерываний UART.
+| huart | Указатель на хендл UART. |
Definition at line 267 of file general_uart.c.
+ +|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Функции для базовой инициализации UART. +More...
++Topics | |
| Init defines | |
| Настройка UART. | |
+Classes | |
| struct | UART_SettingsTypeDef |
| Структура настроек UART. More... | |
+Functions | |
| HAL_StatusTypeDef | UART_Base_Init (UART_SettingsTypeDef *suart) |
| Инициализация UART с помощью структуры UART_SettingsTypeDef. | |
| HAL_StatusTypeDef | Check_UART_Init_Struct (UART_SettingsTypeDef *suart) |
| Проверка корректности структуры инициализации UART. | |
| void | UART_MspInit (UART_HandleTypeDef *huart) |
| Настройка тактирования и прерываний UART. | |
| void | UART_MspDeInit (UART_HandleTypeDef *huart) |
| Deinitialize UART & DMA clock and interrupt. | |
Функции для базовой инициализации UART.
+| HAL_StatusTypeDef UART_Base_Init | +( | +UART_SettingsTypeDef * | suart | ) | ++ |
Инициализация UART с помощью структуры UART_SettingsTypeDef.
+| suart | Указатель на структуру с настройками UART. |
+ Инициализирует UART и при необходимости его GPIO и DMA.
Definition at line 24 of file general_uart.c.
+ +| HAL_StatusTypeDef Check_UART_Init_Struct | +( | +UART_SettingsTypeDef * | suart | ) | ++ |
Проверка корректности структуры инициализации UART.
+| suart | Указатель на структуру с настройками UART. |
Definition at line 356 of file general_uart.c.
+ +| void UART_MspInit | +( | +UART_HandleTypeDef * | huart | ) | ++ |
Настройка тактирования и прерываний UART.
+| huart | Указатель на хендл UART. |
Definition at line 138 of file general_uart.c.
+ +| void UART_MspDeInit | +( | +UART_HandleTypeDef * | huart | ) | ++ |
Deinitialize UART & DMA clock and interrupt.
+| huart | - указатель на хендл UART для деинициализации. |
Definition at line 259 of file general_uart.c.
+ +|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Настройка SPI. +More...
++Macros | |
| #define | HAL_SPI_MODULE_ENABLED |
| Включение HAL SPI. | |
| #define | USE_SPI1 |
| Включить SPI1 в SPI_MspInit. | |
| #define | USE_SPI2 |
| Включить SPI2 в SPI_MspInit. | |
| #define | USE_SPI3 |
| Включить SPI3 в SPI_MspInit. | |
Настройка SPI.
+| #define HAL_SPI_MODULE_ENABLED | +
Включение HAL SPI.
+ +Definition at line 75 of file general_spi.h.
+ +| #define USE_SPI1 | +
Включить SPI1 в SPI_MspInit.
+ +Definition at line 77 of file general_spi.h.
+ +| #define USE_SPI2 | +
Включить SPI2 в SPI_MspInit.
+ +Definition at line 78 of file general_spi.h.
+ +| #define USE_SPI3 | +
Включить SPI3 в SPI_MspInit.
+ +Definition at line 79 of file general_spi.h.
+ +|
+ MyLibs 1.0
+
+ Расширенные библиотеки для STM32
+ |
+
Настройка UART. +More...
++Macros | |
| #define | HAL_UART_MODULE_ENABLED |
| Включение HAL UART. | |
| #define | USE_USART1 |
| Включить USART1 в UART_MspInit. | |
| #define | USE_USART2 |
| Включить USART2 в UART_MspInit. | |
| #define | USE_USART3 |
| Включить USART3 в UART_MspInit. | |
| #define | USE_UART4 |
| Включить UART4 в UART_MspInit. | |
| #define | USE_UART5 |
| Включить UART5 в UART_MspInit. | |
| #define | USE_USART6 |
| Включить USART6 в UART_MspInit. | |
Настройка UART.
+| #define HAL_UART_MODULE_ENABLED | +
Включение HAL UART.
+ +Definition at line 65 of file general_uart.h.
+ +| #define USE_USART1 | +
Включить USART1 в UART_MspInit.
+ +Definition at line 67 of file general_uart.h.
+ +| #define USE_USART2 | +
Включить USART2 в UART_MspInit.
+ +Definition at line 68 of file general_uart.h.
+ +| #define USE_USART3 | +
Включить USART3 в UART_MspInit.
+ +Definition at line 69 of file general_uart.h.
+ +| #define USE_UART4 | +
Включить UART4 в UART_MspInit.
+ +Definition at line 70 of file general_uart.h.
+ +| #define USE_UART5 | +
Включить UART5 в UART_MspInit.
+ +Definition at line 71 of file general_uart.h.
+ +| #define USE_USART6 | +
Включить USART6 в UART_MspInit.
+ +Definition at line 72 of file general_uart.h.
+ +