{"id":5280,"date":"2021-03-03T09:12:20","date_gmt":"2021-03-03T09:12:20","guid":{"rendered":"http:\/\/fastbitlab.com\/?p=5280"},"modified":"2023-09-04T15:24:04","modified_gmt":"2023-09-04T09:54:04","slug":"stm32-usart-lecture-3-configuration-options-and-usart-registers","status":"publish","type":"post","link":"https:\/\/fastbitlab.com\/blog\/stm32-usart-lecture-3-configuration-options-and-usart-registers\/","title":{"rendered":"STM32 USART Lecture 3 – Configuration options and USART registers"},"content":{"rendered":"
\n
\n
\n
\n

 <\/p>\n<\/div>\n

\n

Configuration options and USART registers<\/span><\/h1>\n
\n
\n
\n

 <\/p>\n

<\/div>\n

 <\/p>\n<\/div>\n<\/div>\n<\/div>\n

In the usart_driver.h file, in the beginning, mention the device specific header file (Figure 1).<\/span><\/p>\n

\"Device
Figure 1. Device specific header in driver.h file.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Figure 2 shows the configuration and handle structure for the USART peripheral.<\/span><\/p>\n

\"Configuration
Figure 2. Configuration and handle structure.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

All the prototypes are copied into the driver.h file, as shown in Figure 3.<\/span><\/p>\n

\"Prototypes
Figure 3. Prototypes of all the APIs supported by this driver.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Mention the usart_driver.h header file in the usart_driver.c (Figure 4).<\/span><\/p>\n

\"Adding
Figure 4. Adding usart_driver.h header file in the usart_driver.c.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Include the usart_driver.h at the end of the MCU specific header file (Figure 5).<\/span><\/p>\n

\"Adding
Figure 5. Adding usart_driver.h in MCU specific header file.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

In the driver.c file, you must implement peripheral control, peripheral clock control, and other APIs, as shown in Figure 6 and Figure 7, respectively.<\/span><\/p>\n

\"Configuration
Figure 6. Peripheral control API.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

\"Configuration
Figure 7. Peripheral clock control API.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Now let\u2019s go to the usart_driver.h file to discuss the options to configure the configuration structure.<\/span><\/p>\n

USART_Mode:<\/strong><\/span> In order to configure the USART mode, the user application can use the macros shown in Figure 8, which you can get from the file USART_API_prototype.h attached in the resource section. 0, 1 and 2 are the codes for USART_MODE_ONLY_TX, USART_MODE_ONLY_RX and USART_MODE_TXRX macros.<\/span><\/p>\n

\"Configuration
Figure 8. Macros used to configure the USART_Mode.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

USART_Baud:<\/span> <\/strong>The standard baud rate values from 1200bps to 3Mbps (Figure 9) can be used to decide the baud rate value. The USART baud macros can be selected by going through the baud rate generation table of the USART peripheral mentioned in the reference manual.<\/span><\/p>\n

\"Configuration
Figure 9. Macros used to configure the USART_Baud.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

In the reference manual, go to the functional description section of the USART peripheral, there you will get a fractional baud rate generation section (Figure 10).<\/span><\/p>\n

\"Configuration
Figure 10. Fractional baud rate generation Section.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

As you browse through this document, you will get a table shown in Figure 11. Since our peripheral clock is 16MHz, we have to use this table for baud rate calculation<\/a><\/span>. <\/span><\/p>\n

In Figure 11, you can see that if the peripheral clock is 16MHz, then it is possible to reach up to 3Mbps. Since the baud rates in Figure 11 are standard baud rates, they are coded as C macros.<\/span><\/p>\n

\"Configuration
Figure 11. Error calculation for programmed baud rates at fPCLK = 16MHz or fPCLK = 24MHz, oversampling by 16(1).<\/span><\/figcaption><\/figure>\n

 <\/p>\n

USART_ParityControl:<\/strong> <\/span>There are three options (Figure 12) for parity control. One is USART_PARITY_DISABLE, then USART_PARITY_EN_EVEN, and another is USART_PARITY_EN_ODD.<\/span><\/p>\n

\"Configuration
Figure 12. Macros to configure USART parity control.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

USART_WordLength:<\/span><\/strong> There are two choices for word length, either 8 bits or 9 bits. Therefore, you can use two macros, as shown in Figure 13, to configure the word length.<\/span><\/p>\n

\"Configuration
Figure 13. Macros to configure the USART word length.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

USART_NoOfStopBits:<\/span><\/strong> There are four options for the number of stop bits, as shown in Figure 14. They are only one stop bit, 0.5 stop bit, 2 stop bits, or 1.5 stop bits.<\/span><\/p>\n

\"Macros
Figure 14. Macros to configure the number of stop bits.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

USART_HWFlowControl:<\/span><\/strong> Hardware flow control none, hardware flow control CTS, hardware flow control RTS and hardware flow control both CTS and RTS are the macros used to configure the hardware flow control (Figure 15).<\/span><\/p>\n

\"Macros
Figure 15. Macros to configure hardware flow control.<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Where to configure the USART_Mode?<\/span><\/strong><\/p>\n

The USART_Mode can be configured by enabling or disabling bits 2 and 3 of the CR1 register (Figure 16). Bit 2 is receiver enable, and bit 3 is transmitter enable. <\/span><\/p>\n

If you want to configure the microcontroller only to transmit the data over the USART peripheral, then you need to enable the transmitter, not a receiver, thereby saving some power. <\/span><\/p>\n

If you only want receive data, then you can use the receiver enable bit by turning off the transmitter. If you want it to be involved in both transmission and reception, then you can turn on both bits 2 and 3.<\/span><\/p>\n

\"USART
Figure 16. USART control register 1 (USART_CR1).<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Where to configure the USART_Baud?<\/span><\/strong><\/p>\n

Remember that, to configure the baud rate, you have to properly configure the mantissa and fraction part of the USART_BRR register shown in Figure 17 according to the baud rate you want to use.<\/span><\/p>\n

\"Configuration
Figure 17. USART baud rate register (USART_BRR).<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Where to configure the USART parity control?<\/span><\/strong><\/p>\n

You have to configure bits 9 and 10 of the CR1 register (Figure 18) in order to control the parity. The bit number 10 is disabled by default. Once you enable the bit number 10, the parity control will be enabled. Bit 9 can make sense only when the parity control is enabled. By using bit 9, you can configure either even parity or odd parity. By default, it will be even parity.<\/span><\/p>\n

\"Configuration
Figure 18. USART control register 1 (USART_CR1).<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Where to configure the USART word length?<\/span><\/strong><\/p>\n

The word length can be configured in the bit number 12 of the CR1 register (Figure 19). The 12th bit of the CR1 register determines the word length, and it is set and cleared by the software. If this bit is zero means one start bit, 8 data bits, and n stop bits. Here the n will be decided later by using another control bit. If it is 1, then it means 1 start bit, 9 data bits, and n stop bits.<\/span><\/p>\n

\"USART
Figure 19. USART control register 1 (USART_CR1).<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Where to configure the number of stop bits?<\/span><\/strong><\/p>\n

The number of stop bits can be configured in the CR2 register (Figure 20). There are 4 options for configuring stop bits. They are:<\/span><\/p>\n