You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/api-reference/peripherals/uart.rst
+31-34Lines changed: 31 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,9 @@ Functional Overview
23
23
24
24
The overview describes how to establish communication between an {IDF_TARGET_NAME} and other UART devices using the functions and data types of the UART driver. A typical programming workflow is broken down into the sections provided below:
25
25
26
-
1. :ref:`uart-api-setting-communication-parameters` - Setting baud rate, data bits, stop bits, etc.
27
-
2. :ref:`uart-api-setting-communication-pins` - Assigning pins for connection to a device
28
-
3. :ref:`uart-api-driver-installation` - Allocating {IDF_TARGET_NAME}'s resources for the UART driver
26
+
1. :ref:`uart-api-driver-installation` - Allocating {IDF_TARGET_NAME}'s resources for the UART driver
27
+
2. :ref:`uart-api-setting-communication-parameters` - Setting baud rate, data bits, stop bits, etc.
28
+
3. :ref:`uart-api-setting-communication-pins` - Assigning pins for connection to a device
29
29
4. :ref:`uart-api-running-uart-communication` - Sending/receiving data
30
30
5. :ref:`uart-api-using-interrupts` - Triggering interrupts on specific communication events
31
31
6. :ref:`uart-api-deleting-driver` - Freeing allocated resources if a UART communication is no longer required
@@ -39,13 +39,39 @@ Steps 1 to 3 comprise the configuration stage. Step 4 is where the UART starts o
39
39
The UART driver's functions identify each of the UART controllers using :cpp:type:`uart_port_t`. This identification is needed for all the following function calls.
40
40
41
41
42
+
.. _uart-api-driver-installation:
43
+
44
+
Install Drivers
45
+
^^^^^^^^^^^^^^^^^^^
46
+
47
+
First of all, install the driver by calling :cpp:func:`uart_driver_install` and specify the following parameters:
48
+
49
+
- UART port number
50
+
- Size of RX ring buffer
51
+
- Size of TX ring buffer
52
+
- Event queue size
53
+
- Pointer to store the event queue handle
54
+
- Flags to allocate an interrupt
55
+
56
+
.. _driver-code-snippet:
57
+
58
+
The function allocates the required internal resources for the UART driver.
0 commit comments