diff options
| author | Randall Spangler <rspangler@chromium.org> | 2017-07-27 16:00:52 -0700 |
|---|---|---|
| committer | chrome-bot <chrome-bot@chromium.org> | 2017-07-29 00:57:00 -0700 |
| commit | 96173345e7c56f82f6c746f574285849893977dd (patch) | |
| tree | 568b4ed052b7915ae89c4301fee1d43fc70734f9 /chip | |
| parent | b4691fe734f0525bdfcb8d64f305954f42b88351 (diff) | |
| download | chrome-ec-96173345e7c56f82f6c746f574285849893977dd.tar.gz | |
cr50: Rename uartn_enabled() to uartn_tx_is_connected()
Because that's what it means. That is, it reports the state of
uartn_tx_connect(), not uartn_enable().
No functional changes; just a rename.
BUG=none
BRANCH=cr50
TEST=make buildall -j
Change-Id: Ie2273b277bd73a40307be7ec215417c1225cd567
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/590859
Diffstat (limited to 'chip')
| -rw-r--r-- | chip/g/uartn.h | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/chip/g/uartn.h b/chip/g/uartn.h index e13c2f6552..967136de22 100644 --- a/chip/g/uartn.h +++ b/chip/g/uartn.h @@ -74,18 +74,37 @@ void uartn_tx_start(int uart); */ void uartn_tx_stop(int uart); -/* Get UART output status */ -int uartn_enabled(int uart); +/** + * Return non-zero if TX is connected for the UART. + * + * @param uart UART to check + * @return 1 if TX pin is connected, 0 if disconnected. + */ +int uart_tx_is_connected(int uart); -/* Enable UART output */ +/* Connect TX pin for the UART */ void uartn_tx_connect(int uart); -/* Disable UART output */ +/* Disconnect TX pin for the UART */ void uartn_tx_disconnect(int uart); -/* Enable TX and RX. Disable HW flow control and loopback */ +/** + * Enable TX and RX for the UART. Disable HW flow control and loopback. + * + * @param uart UART to enable + * + * Note that this does NOT connect the TX pin for the UART; that must be done + * explicitly via uartn_tx_connect(). + */ void uartn_enable(int uart); -/* Disable TX, RX, HW flow control, and loopback */ +/** + * Disable TX, RX, HW flow control, and loopback. + * + * @param uart UART to disable + * + * Note that this does NOT disconnect the TX pin for the UART; that must be + * done explicitly via uartn_tx_disconnect(). + */ void uartn_disable(int uart); #endif /* __CROS_EC_UARTN_H */ |