Skip to content

drivers: uart: clarification of poll_out blocking duration #81358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kartben merged 1 commit into from
Dec 13, 2024
Merged

drivers: uart: clarification of poll_out blocking duration #81358

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions include/zephyr/drivers/uart.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,10 +561,11 @@ static inline int z_impl_uart_poll_in_u16(const struct device *dev,
/**
* @brief Write a character to the device for output.
*
* This routine checks if the transmitter is full. When the
* This routine checks if the transmitter is full. When the
* transmitter is not full, it writes a character to the data
* register. It waits and blocks the calling thread, otherwise. This
* function is a blocking call.
* register. It waits and blocks the calling thread otherwise. This
* function is a blocking call. It blocks the calling thread until the
* character is sent.
Copy link
Contributor

@gramsay0 gramsay0 Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't it block until the TX FIFO has space for the character, rather than until the character is sent?

Copy link
Member Author

@hubertmis hubertmis Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc I linked says "until the give character is sent". My intention is to unify these docs.

*
* To send a character when hardware flow control is enabled, the handshake
* signal CTS must be asserted.
Expand Down
Loading