Универсальные асинхронные последовательные средства связи |
209 |
Все платы Nucleo-64 спроектированы таким образом, что USART2 целевого микроконтроллера связан с интерфейсом ST-LINK3. Когда мы устанавливаем драйверы ST-LINK, также устанавливается дополнительный драйвер для виртуального COM-порта (Virtual COM Port, VCP): он позволяет нам получить доступ к USART2 целевого микроконтроллера через интерфейс USB без использования специального конвертера TTL/USB. Используя программу эмуляции терминала, мы можем обмениваться сообщениями и данными с нашей Nucleo.
CubeHAL разделяет API для управления интерфейсами UART и USART. Все функции и дескрипторы, используемые для обработки USART, начинаются с префикса HAL_USART и содержатся в файлах stm32xxx_hal_usart.{c,h}, а связанные с управлением UART начинаются с префикса HAL_UART и содержатся в файлах stm32xxx_hal_uart.{c,h}. Поскольку оба модуля концептуально идентичны, а UART является наиболее распространенной формой последовательного соединения между различными модулями, в данной книге будут рассмотрены только функции модуля HAL_UART.
8.2. Инициализация UART
Как и все периферийные устройства STM32, даже USART4 отображается в области периферийной памяти, которая начинается с 0x4000 0000. CubeHAL абстрагируется от действующего отображения в памяти каждого USART для какого-либо микроконтроллера STM32 благодаря дескриптору USART_TypeDef5. Например, мы можем просто использовать макрос USART2 для ссылки на второе периферийное устройство USART, предоставляемое всеми микроконтроллерами STM32 с корпусом LQFP64.
Однако все функции HAL, связанные с управлением UART, спроектированы таким образом, чтобы они принимали в качестве первого параметра экземпляр структуры Си UART_HandleTypeDef, которая определена следующим образом:
typedef struct { |
|
USART_TypeDef |
*Instance; |
UART_InitTypeDef |
Init; |
UART_AdvFeatureInitTypeDef |
AdvancedInit; |
uint8_t |
*pTxBuffPtr; |
uint16_t |
TxXferSize; |
uint16_t |
TxXferCount; |
uint8_t |
*pRxBuffPtr; |
uint16_t |
RxXferSize; |
uint16_t |
RxXferCount; |
DMA_HandleTypeDef |
*hdmatx; |
DMA_HandleTypeDef |
*hdmarx; |
HAL_LockTypeDef |
Lock; |
__IO HAL_UART_StateTypeDef |
State; |
__IO HAL_UART_ErrorTypeDef |
ErrorCode; |
} UART_HandleTypeDef; |
|
/* Базовый адрес регистров UART |
*/ |
/* Параметры UART-связи |
*/ |
/* Параметры инициализации |
|
продвинутых функций UART |
*/ |
/* Указатель на буфер Tx-передачи UART |
*/ |
/* Размер Tx-передачи UART |
*/ |
/* Счетчик Tx-передачи UART |
*/ |
/* Указатель на буфер Rx-передачи UART |
*/ |
/* Размер Rx-передачи UART |
*/ |
/* Счетчик Rx-передачи UART |
*/ |
/* Параметры дескриптора DMA для Tx UART */ /* Параметры дескриптора DMA для Rx UART */
/* Блокировка объекта UART |
*/ |
/* Состояние работы UART |
*/ |
/* Код ошибки UART |
*/ |
3Обратите внимание, что это утверждение может быть неверным, если вы используете плату Nucleo-32 или Nucleo-144. Проверьте документацию ST для получения дополнительной информации об этом.
4Начиная с данного параграфа, термины USART и UART используются взаимозаменяемо, если не указано иное.
5Анализ полей этой структуры Си выходит за рамки данной книги.
Универсальные асинхронные последовательные средства связи |
210 |
Давайте более подробно рассмотрим наиболее важные поля данной структуры.
•Instance (экземпляр): является указателем на дескриптор USART, который мы со-
бираемся использовать. Например, USART2 – это дескриптор UART, связанный с интерфейсом ST-LINK каждой платы Nucleo.
•Init: является экземпляром структуры Си UART_InitTypeDef, использующейся для
конфигурации интерфейса UART. Мы рассмотрим ее более подробно в ближайшее время.
•AdvancedInit: это поле используется для конфигурации более сложных функций
UART, таких как автоматическое обнаружение скорости передачи данных (BaudRate) и замена выводов TX/RX. Некоторые HAL не предоставляют это дополнительное поле. Это происходит потому, что интерфейсы USART не одинаковы у всех микроконтроллеров STM32. Это важный аспект, который необходимо учитывать при выборе подходящего микроконтроллера для вашего приложения. Анализ этого поля выходит за рамки данной книги.
•pTxBuffPtr и pRxBuffPtr: эти поля указывают на буферы передачи и приема соот-
ветственно. Они используются в качестве источника для передачи байтов TxXferSizebytes по UART и для получения RxXferSize при сконфигурированном UART в полнодуплексном режиме (Full Duplex Mode). Поля TxXferCount и RxXferCount используются HAL для внутреннего учета количества переданных и полученных байтов.
•Lock: это поле используется внутри HAL для блокировки одновременного доступа к интерфейсам UART.
Как сказано выше, поле Lock используется для управления одновременным доступом почти во всех процедурах HAL. Если вы посмотрите на код HAL, вы увидите несколько вариантов использования макроса __HAL_LOCK(), который расширяется следующим образом:
#define __HAL_LOCK(__HANDLE__) |
\ |
do{ |
\ |
if((__HANDLE__)->Lock == HAL_LOCKED) |
\ |
{ |
\ |
return HAL_BUSY; |
\ |
} |
\ |
else |
\ |
{ |
\ |
(__HANDLE__)->Lock = HAL_LOCKED; |
\ |
} |
\ |
}while (0) |
|
Неясно, почему инженеры ST решили позаботиться об одновременном доступе к процедурам HAL. Вероятно, они решили использовать потокобезопасный (thread safe) подход, освобождая разработчика приложений от ответственности за управление множественным доступом к одному и тому же аппаратному интерфейсу в случае нескольких потоков, работающих в одном приложении.
Однако это вызывает раздражающий побочный эффект для всех пользователей HAL: даже если мое приложение не выполняет одновременный доступ к одному и тому же периферийному устройству, мой код будет плохо оптимизирован из-за множества проверок состояния поля Lock. Более того, такой способ блокировки по своей сути является небезопасным потоком, потому что нет критической секции, используемой для предотвращения условий гонки (race
Универсальные асинхронные последовательные средства связи |
211 |
conditions) в случае, если более привилегированная ISR прерывает исполняемый код. Наконец, если мое приложение использует ОСРВ, гораздо лучше использовать собственные примитивы блокировки используемой ОС (такие как семафоры и мьютексы, которые не только атомарны, но и правильно управляют планированием задач, избегая циклы активного ожидания (busy waiting)) для обработки одновременных обращений, без необходимости проверять наличие специального возвращаемого значения (HAL_BUSY) функций HAL.
Многие разработчики не одобряют данный способ блокировки периферийных устройств с момента первого выпуска HAL. Инженеры ST недавно объявили, что они активно работают над лучшим решением.
Все действия по конфигурации UART выполняются с использованием экземпляра структуры Си UART_InitTypeDef, которая определена следующим образом:
typedef struct { uint32_t BaudRate; uint32_t WordLength; uint32_t StopBits; uint32_t Parity; uint32_t Mode; uint32_t HwFlowCtl; uint32_t OverSampling;
} UART_InitTypeDef;
•BaudRate: этот параметр относится к скорости соединения, выраженной в битах в
секунду. Несмотря на то что параметр может принимать произвольное значение, обычно скорость передачи данных BaudRate выбирается из списка известных и стандартных значений. Это связано с тем, что она является функцией периферийного тактового сигнала, связанного с USART (который ответвляется от основных тактовых сигналов HSI или HSE через сложную цепочку множителей PLL в некоторых микроконтроллерах STM32), и не все BaudRate могут быть легко достигнуты без введения погрешностей скорости передачи выборки битов и, следовательно, ошибок обмена данными. Таблица 2 показывает список общепринятых BaudRate и вычисленные соответствующие погрешности скорости передачи выборки (%Error) для микроконтроллера STM32F030. Всегда обращайтесь к справочному руководству для вашего микроконтроллера, чтобы узнать, какая из периферийных тактовых частот наилучшим образом соответствует необходимой BaudRate на имеющемся микроконтроллере STM32.
•WordLength: она (длина слова) задает количество битов данных, переданных или
полученных в кадре данных. Это поле может принимать значение
UART_WORDLENGTH_8B или UART_WORDLENGTH_9B, что означает, что мы можем переда-
вать данные по UART пакетами, содержащими 8 или 9 битов. Это число не включает передаваемые служебные биты, такие как биты начала и конца передачи пакета.
•StopBits: в этом поле задается количество передаваемых стоп-битов. Оно может
принимать значение UART_STOPBITS_1 или UART_STOPBITS_2, что означает, что мы можем использовать один или два стоп-бита, чтобы сигнализировать об окончании кадра передаваемых данных.
Универсальные асинхронные последовательные средства связи |
212 |
Таблица 2: Расчет погрешности для запрограммированных скоростей передачи данных на 48 МГц
вобоих случаях передискретизации в 16 или в 8 отсчетов на бит данных
•Parity: это поле задает режим проверки четности и может принимать значения
из Таблицы 3. Учтите, что при включенной проверке четности вычисленная четность вставляется в позицию MSB передаваемых данных (9-й бит, когда длина слова установлена в 9 бит данных; 8-й бит, когда длина слова установлена на 8 бит данных). Проверка четности – это очень простая форма проверки ошибок. Она бывает двух видов: на нечетное (odd) или на четное (even) число единиц. Чтобы получить бит четности, все биты данных суммируются, и проверка четности по сумме определяет, установлен этот бит или нет. Например, предполагая, что установлена проверка четности на четное число единиц, то складывая их в байте данных, таком как 0b01011101, имеющем нечетное число 1 (5), бит четности будет установлен в 1. И наоборот, если был установлен режим проверки четности на нечетное число единиц, бит четности будет равен 0. Проверка четности является необязательной и не очень часто применяется. Она может быть полезна для передачи по зашумленным средам, при этом она также немного замедлит передачу данных и требует, чтобы отправитель и получатель реализовали обработку ошибок (обычно полученные данные, которые дают сбой, должны быть повторно отправлены). Когда возникает ошибка при проверке четности (parity error), все микроконтроллеры STM32 генерируют определенное прерывание, как мы увидим далее.
•Mode: это поле определяет, включен ли режим RX или TX или отключен. Оно мо-
жет принимать одно из значений из таблицы 4.
Универсальные асинхронные последовательные средства связи |
213 |
•HwFlowCtl: Это поле определяет, включен ли аппаратный режим управления по-
током RS2326 или отключен. Этот параметр может принимать одно из значений из таблицы 5.
Таблица 3: Доступные режимы проверки четности для UART-соединения
Режим проверки четности |
Описание |
|
UART_PARITY_NONE |
|
Проверка четности отключена |
UART_PARITY_EVEN |
|
Бит четности устанавливается в 1, если число битов, равных 1, |
|
является нечетным |
|
|
|
|
UART_PARITY_ODD |
|
Бит четности устанавливается в 1, если число битов, равных 1, |
|
является четным |
|
|
|
|
|
Таблица 4: Доступные режимы UART |
|
Режим работы UART |
Описание |
|
UART_MODE_RX |
UART сконфигурирован только в режиме приема |
|
UART_MODE_TX |
UART сконфигурирован только в режиме передачи |
|
UART_MODE_TX_RX |
UART сконфигурирован на работу в режиме и приема, и передачи |
|
Таблица 5: Доступные режимы управления потоком для UART-соединения |
||
Режим управления потоком |
Описание |
|
UART_HWCONTROL_NONE |
|
Аппаратное управление потоком отключено |
UART_HWCONTROL_RTS |
|
Линия «Запрос на передачу» (RTS) включена |
UART_HWCONTROL_CTS |
|
Линия «Готовность к передаче» (CTS) включена |
UART_HWCONTROL_RTS_CTS |
|
Обе линии RTS и CTS включены |
•OverSampling: когда UART получает кадр данных от удаленного узла (remote peer),
он отбирает сигналы для вычисления числа 1 и 0, составляющих сообщение.
Передискретизация или избыточная дискретизация (Oversampling) – это метод от-
бора сигнала с частотой дискретизации, значительно превышающей частоту Найквиста. Приемник реализует различные конфигурируемые пользователем методы передискретизации (за исключением синхронного режима) для восстановления данных, различая действительные входящие данные и шум. Это позволяет найти компромисс между максимальной скоростью связи и помехоустойчивостью. Поле OverSampling может принимать значение UART_OVERSAMPLING_16 для выполнения 16 отсчетов на каждый бит кадра данных или UART_OVERSAMPLING_8 для выполнения 8 отсчетов. В таблице 2 показан расчет погрешностей передачи для запрограммированных скоростей передачи данных при 48 МГц в микроконтроллере STM32F030 в случаях передискретизации в 16 или в 8 отсчетов на бит данных.
Теперь самое время начать писать немного кода. Давайте посмотрим, как сконфигурировать USART2 в микроконтроллере, оснащающим нашу Nucleo, для обмена сообщениями через интерфейс ST-LINK.
int main(void) { UART_HandleTypeDef huart2;
6 Это поле используется только для включения управления потоком RS232. Чтобы включить управление потоком RS485, HAL предоставляет специальную функцию HAL_RS485Ex_Init(), определенную в файле
stm32xxxx_hal_uart_ex.c.
Универсальные асинхронные последовательные средства связи |
214 |
/* Инициализация HAL */
HAL_Init();
/* Конфигурирование системного тактового сигнала */
SystemClock_Config();
/* Конфигурирование USART2 */ huart2.Instance = USART2; huart2.Init.BaudRate = 38400; huart2.Init.WordLength = UART_WORDLENGTH_8B; huart2.Init.StopBits = UART_STOPBITS_1; huart2.Init.Parity = UART_PARITY_NONE; huart2.Init.Mode = UART_MODE_TX_RX; huart2.Init.HwFlowCtl = UART_HWCONTROL_NONE;
huart2.Init.OverSampling = UART_OVERSAMPLING_16; HAL_UART_Init(&huart2);
...
}
Первым шагом является конфигурация периферийного устройства USART2. Здесь мы используем следующую конфигурацию: 38400, N, 1. То есть BaudRate, равную 38400 бит/с, без проверки на четность и только один стоп-бит. Затем мы отключаем все формы аппаратного управления потоком и выбираем самую высокую частоту передискретизации, то есть 16 тактовых тиков на каждый передаваемый бит. Вызов функции HAL_UART_Init() гарантирует, что HAL инициализирует USART2 в соответствии с заданными параметрами.
Однако приведенного выше кода по-прежнему недостаточно для обмена сообщениями через виртуальный COM-порт Nucleo. Не забывайте, что каждое периферийное устройство, предназначенное для обмена данными с внешним миром, должно быть надлежащим образом связано с соответствующими GPIO, то есть мы должны сконфигурировать выводы TX и RX USART2. Рассматривая схемы Nucleo, мы увидим, что выводами TX и RX USART2 являются PA2 и PA3 соответственно. Более того, мы уже видели в Главе 4, что HAL спроектирован таким образом, что функция HAL_UART_Init() автоматически вызывает HAL_UART_MspInit() (см. рисунок 19 в Главе 4) для правильной инициализации вводов/выводов: наша обязанность – написать тело этой функции в нашем коде приложения, которая будет автоматически вызываться HAL.
Обязательно ли определять данную функцию?
Ответ: нет. Это просто практика, применяемая HAL и кодом, автоматически генерируемым CubeMX. HAL_UART_MspInit() и соответствующая функция
HAL_UART_MspDeInit(), которая вызывается функцией HAL_UART_DeInit(), объяв-
ляются внутри HAL следующим образом:
__weak void HAL_UART_MspInit(UART_HandleTypeDef *huart);
Атрибут функции __weak представляет собой способ GCC объявить символы (в данном случае, имя функции) со слабой областью видимости, которую мы будем перезаписывать, если другие символы с таким же именем будет иметь глобальную область видимости (то есть без атрибута __weak), определяясь в
Универсальные асинхронные последовательные средства связи |
215 |
другом месте приложения (то есть в другом перемещаемом файле). Компоновщик автоматически заменит вызов функции HAL_UART_MspInit(), определенной внутри HAL, если мы реализуем его в нашем коде приложения.
Код ниже показывает, как правильно написать код для функции HAL_UART_MspInit().
void HAL_UART_MspInit(UART_HandleTypeDef* huart) { GPIO_InitTypeDef GPIO_InitStruct;
if(huart ->Instance == USART2) {
/* Разрешение тактирования периферии */
__HAL_RCC_USART2_CLK_ENABLE();
/**Конфигурация GPIO USART2
PA2 ------> USART2_TX
PA3 ------> USART2_RX
*/
GPIO_InitStruct.Pin = USART_TX_Pin|USART_RX_Pin; GPIO_InitStruct.Mode = GPIO_MODE_AF_PP; GPIO_InitStruct.Pull = GPIO_NOPULL; GPIO_InitStruct.Speed = GPIO_SPEED_LOW;
GPIO_InitStruct.Alternate = GPIO_AF1_USART2; /* ПРЕДУПРЕЖДЕНИЕ: зависит от конкретного микроконтроллера STM32 */
HAL_GPIO_Init(GPIOA, &GPIO_InitStruct);
}
}
Как видите, функция разработана так, что она является общей для каждого USART, используемого внутри приложения. Оператор if дисциплинирует код инициализации для используемого USART (в нашем случае, USART2). Оставшаяся часть кода конфигу-
рирует выводы PA2 и PA3. Пожалуйста, обратите внимание, что альтернативная функция может отличаться в зависимости от микроконтроллера, оснащающего вашу Nucleo. Обратитесь к примерам книги, чтобы увидеть правильный код инициализации для вашей Nucleo.
После конфигурации интерфейса USART2 мы можем начать обмен сообщениями с нашим ПК.
Обратите внимание, что представленный ранее код не может быть достаточным для правильной инициализации периферийного устройства USART для нескольких микроконтроллеров STM32. Некоторые микроконтроллеры STM32, такие как STM32F334R8, позволяют разработчику выбирать источник тактового сигнала для используемого периферийного устройства (например, USART2 в микроконтроллере STM32F334R8 может опционально тактироваться от SYSCLK, HSI, LSE или PCLK1). Настоятельно рекомендуется использовать CubeMX при первой конфигурации периферийных устройств для вашего микроконтроллера и тщательно проверять сгенерированный код в поисках подобных исключений. В противном случае техническое описание является единственным источником данной информации.