31 Commits

Author	SHA1	Message	Date
Damien George	97af1001ae	rp2/machine_uart: Make it so TX is done only when no longer busy. ... Prior to this commit, when flushing a UART on the rp2 port, it returns just before the last character is sent out the wire. Fix this by waiting until the BUSY flag is cleared. This also fixes the behaviour of `UART.txdone()` to return `True` only when the last byte has gone out. Updated docs and tests to match. The test now checks that UART TX time is very close to the expected time (prior, it was just testing that the TX time was less than the expected time). Signed-off-by: Damien George <damien@micropython.org>	2024-10-22 10:17:05 +11:00
robert-hh	03b1b6d8e6	docs/library/machine.UART: Extend the documentation for UART.irq. ... For more ports and trigger options, based on the current state of the code. Signed-off-by: robert-hh <robert@hammelrath.com>	2024-08-29 16:48:09 +10:00
Damien George	9bbe61607a	docs/library/machine.UART: Fix UART.irq docs to match current code. ... These docs now match the code in `extmod/machine_uart.c`. IRQ trigger support still need to be updated for each port (to be done in a follow-up commit). Signed-off-by: Damien George <damien@micropython.org>	2024-08-29 16:34:45 +10:00
robert-hh	988b6e2dae	renesas-ra: Add the UART methods uart.txdone() and uart.flush(). ... This required to add two functions down the stack to uart.c and ra.sci.c. - One for telling, whther the transmission is busy. - One for reporting the size of the TX buffer. Tested with a EK-RA6M2 board.	2022-12-15 12:09:34 +01:00
robert-hh	b74eeee5e0	docs/library/machine.UART: Add docs for uart.flush() and uart.txdone().	2022-08-31 00:20:44 +10:00
Tomasz 'CeDeROM' CEDRO	602f9db2f3	docs/library/machine.UART: Add notes about UART init and deinit. ... * `init()` can be called multiple times to reconfigure UART. * After `deinit()` it is impossible to call `init()` again. Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>	2022-08-26 15:13:45 +10:00
Jan	5d9171b5cc	docs/library/machine.UART.rst: Add details for invert parameter.	2022-03-07 14:12:50 +11:00
Damien George	d9d67adef1	docs: Remove trailing spaces and convert tabs to spaces. ... Signed-off-by: Damien George <damien@micropython.org>	2021-12-15 11:49:22 +11:00
Will Sowerbutts	a3675294ae	esp32/machine_uart: Add flow kw-arg to enable hardware flow control. ... This enables optional support for the hardware UART to use the RTS and/or CTS pins for flow control. The new "flow" constructor keyword specifies a bitmask of RTS and/or CTS. This matches the interface used by machine.UART on stm32 and rp2. Previously on ESP32 it was possible to specify which pins to use for the RTS and CTS signals, but hardware flow control was never functional: CTS was not checked before transmitting bytes, and RTS was always driven high (signalling no buffer space available). With this patch, CTS and RTS both operate as expected. This also includes an update to the machine.UART documentation. Signed-off-by: Will Sowerbutts <will@sowerbutts.com>	2021-08-04 13:52:15 +10:00
Zenix27	e76c7466b6	docs: Change \* to * in argument lists. ... Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.	2020-08-21 12:24:13 +10:00
Jason Neal	5ef3b6b2d9	docs/library/machine.UART.rst: Detail timeout behaviour of read methods. ... Also document existence of "invert" argument to constructor.	2020-01-06 22:50:58 +11:00
Damien George	b18fa1e606	docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args. ... If a port would like to expose the configuration of transmit and/or receive buffers then it can use these arguments.	2018-08-14 15:21:54 +10:00
Damien George	4cc65e22d4	docs/library/machine.UART: Remove conditional docs for wipy port. ... The UART.init() method is now included unconditionally and its wording adjusted to better describe ports other than the cc3200. UART.irq() is also included unconditionally, but this is currently only available on the WiPy target.	2018-07-18 16:20:53 +10:00
Paul Sokolovsky	3ff7040c8a	docs/library: Add xrefs to "stream" dictionary entry for many modules.	2017-12-04 18:36:20 +02:00
Paul Sokolovsky	7c0e1f1a08	docs/machine*: Use markup adhering to the latest docs conventions.	2017-06-25 13:30:29 +03:00
Ville Skyttä	ca16c38210	various: Spelling fixes	2017-05-29 11:36:05 +03:00
Damien George	436d97b3f9	docs/library/machine.UART: Update and improve uart.any() docs.	2017-05-19 15:48:22 +10:00
Damien George	d4675e7674	docs/library/machine.*: Add cross-reference label to individual classes.	2017-04-18 15:27:37 +10:00
Damien George	fabaa61437	docs/library/machine.UART: Remove pyboard-specific section. ... stmhal doesn't have a machine.UART class so this section is not needed.	2017-04-18 12:13:51 +10:00
Paul Sokolovsky	a8ece0358f	docs/machine.UART: Deconditionalize normal methods.	2017-04-16 09:54:55 +03:00
Paul Sokolovsky	1d74559b6b	docs/library/machine.UART: Remove some conditionals.	2017-04-09 00:25:27 +03:00
Damien George	a392b3aa75	docs: Remove references to readall() and update stream read() docs.	2016-11-14 23:31:40 +11:00
Mike Causer	ce166e6b68	docs: Spelling mistakes	2016-08-02 11:17:46 +03:00
Paul Sokolovsky	79b40d1127	docs/machine*: Remove explicit targets and "machine." prefixes on classes. ... With currentmodule:: set properly, none are needed. Extra "machine." prefix produces wrong indexing data.	2016-06-09 03:03:53 +03:00
Paul Sokolovsky	7d7243f44c	docs/machine.*: Use proper class case in method headers. ... Class designator will be used as is in indexes, so must match actual class name.	2016-06-08 01:33:49 +03:00
Paul Sokolovsky	93968bd6fb	docs/machine.UART: Cleanup pyboard section.	2016-06-08 01:32:16 +03:00
Paul Sokolovsky	c8b7628094	docs/machine.*: Add "currentmodule:: machine" directive. ... Makes sure that classes described in these separate files are properly designated as belonging to "machine" module in indexes.	2016-06-08 00:46:27 +03:00
Radomir Dopieralski	0c86a9471a	docs/machine.UART: Filter out unimplemented UART methods from esp8266 docs.	2016-05-07 20:20:04 +03:00
Paul Sokolovsky	cf6daa0966	docs: Explicitly specify behavior of UART stream protocol methods on timeout.	2015-10-25 08:25:34 +03:00
danicampora	ceb169008d	docs: Several corrections to the classes in the machine module.	2015-10-21 15:30:56 +02:00
danicampora	4542643025	docs: Update all WiPy docs to reflect the new API.	2015-10-17 23:29:04 +02:00