Skip to content

Fix: flush() now calls libftdi(>= 1.5) tc[io]flush functions. #14

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.

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
merged 1 commit into from
May 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions src/pylibftdi/device.py
Original file line number Diff line number Diff line change
Expand Up @@ -493,16 +493,18 @@ def flush(self, flush_what: int = FLUSH_BOTH) -> None:
`FLUSH_INPUT` (just the rx buffer);
`FLUSH_OUTPUT` (just the tx buffer)
"""

if flush_what == FLUSH_BOTH:
fn = self.fdll.ftdi_usb_purge_buffers
fn = self.fdll.ftdi_tcioflush
elif flush_what == FLUSH_INPUT:
fn = self.fdll.ftdi_usb_purge_rx_buffer
fn = self.fdll.ftdi_tciflush
elif flush_what == FLUSH_OUTPUT:
fn = self.fdll.ftdi_usb_purge_tx_buffer
fn = self.fdll.ftdi_tcoflush
else:
raise ValueError(
f"Invalid value passed to {self.__class__.__name__}.flush()"
)

res = fn(byref(self.ctx))
if res != 0:
msg = "%s (%d)" % (self.get_error_string(), res)
Expand Down
10 changes: 5 additions & 5 deletions tests/test_bitbang.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,11 @@ def x():
self.assertCallsExact(
x,
[
"ftdi_usb_purge_tx_buffer",
"ftdi_tcoflush",
"ftdi_write_data",
"ftdi_usb_purge_tx_buffer",
"ftdi_tcoflush",
"ftdi_write_data",
"ftdi_usb_purge_tx_buffer",
"ftdi_tcoflush",
"ftdi_write_data",
],
)
Expand Down Expand Up @@ -155,10 +155,10 @@ def _2():
dev.port |= 2

self.assertCallsExact(
_1, ["ftdi_read_pins", "ftdi_usb_purge_tx_buffer", "ftdi_write_data"]
_1, ["ftdi_read_pins", "ftdi_tcoflush", "ftdi_write_data"]
)
self.assertCallsExact(
_2, ["ftdi_read_pins", "ftdi_usb_purge_tx_buffer", "ftdi_write_data"]
_2, ["ftdi_read_pins", "ftdi_tcoflush", "ftdi_write_data"]
)


Expand Down
6 changes: 3 additions & 3 deletions tests/test_device.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ def testReadWrite(self):

def testFlush(self):
with Device() as dev:
self.assertCalls(dev.flush_input, "ftdi_usb_purge_rx_buffer")
self.assertCalls(dev.flush_output, "ftdi_usb_purge_tx_buffer")
self.assertCalls(dev.flush, "ftdi_usb_purge_buffers")
self.assertCalls(dev.flush_input, "ftdi_tciflush")
self.assertCalls(dev.flush_output, "ftdi_tcoflush")
self.assertCalls(dev.flush, "ftdi_tcioflush")

def testClose(self):
d = Device()
Expand Down