Skip to content

Add ability to add more constraints to bdDetect USB device registration #17537

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
seanbudd merged 22 commits into from
Jan 3, 2025
Merged

Add ability to add more constraints to bdDetect USB device registration #17537

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
33228c6
Refactor fallback and allow match funcs for device registration
LeonarddeR Dec 14, 2024
1b95e81
Update albatross
LeonarddeR Dec 16, 2024
ce4d233
Add changes
LeonarddeR Dec 16, 2024
1791b18
Add brailliant
LeonarddeR Dec 16, 2024
9011882
Actually use the matchFunc and make it optional
LeonarddeR Dec 17, 2024
d0c3bce
Fixup typos
LeonarddeR Dec 20, 2024
b726cf6
Use constant in Albatros
LeonarddeR Dec 20, 2024
98d01bc
Uniform yield
LeonarddeR Dec 20, 2024
3b95bd7
use cache for HID device info
LeonarddeR Dec 26, 2024
673d742
Fix typo
LeonarddeR Dec 26, 2024
dcd8ffd
Deprecations
LeonarddeR Dec 27, 2024
0be066c
Use communication types
LeonarddeR Dec 27, 2024
6908f9d
Renames
LeonarddeR Dec 27, 2024
e18250f
Merge remote-tracking branch 'origin/master' into fallbackRevamp
LeonarddeR Dec 30, 2024
3a485cd
Update source/brailleDisplayDrivers/eurobraille/driver.py
LeonarddeR Dec 30, 2024
edcfe14
Update source/brailleDisplayDrivers/eurobraille/driver.py
LeonarddeR Dec 30, 2024
a3e129a
Update source/brailleDisplayDrivers/brailliantB.py
LeonarddeR Jan 2, 2025
2baa9a9
Update source/brailleDisplayDrivers/eurobraille/driver.py
LeonarddeR Jan 2, 2025
b0283da
Use StrEnum again
LeonarddeR Jan 2, 2025
c176ce6
Fix eurobraille mistakes due to coderabbit suggestions
LeonarddeR Jan 2, 2025
47e6fc5
Add doc string
LeonarddeR Jan 2, 2025
543f783
Undo more unrelated/faulty changes
LeonarddeR Jan 2, 2025
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
Prev Previous commit
Next Next commit
use cache for HID device info
  • Loading branch information
@LeonarddeR
LeonarddeR committed Dec 26, 2024
commit 3b95bd7447b3f1b823c45ee800199d783c20fdd7
41 changes: 28 additions & 13 deletions source/hwPortUtils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import hidpi
import winKernel
from logHandler import log
from winAPI.constants import SystemErrorCodes
from winKernel import SYSTEMTIME


Expand Down Expand Up @@ -496,7 +497,10 @@ def __init__(self, **kwargs):
super().__init__(Size=ctypes.sizeof(HIDD_ATTRIBUTES), **kwargs)


def _getHidInfo(hwId, path):
_getHidInfoCache: dict[str, dict] = {}


def _getHidInfo(hwId: str, path: str) -> dict[str, typing.Any]:
info = {
"hardwareID": hwId,
"devicePath": path,
Expand All @@ -517,18 +521,28 @@ def _getHidInfo(hwId, path):
# Fetch additional info about the HID device.
from serial.win32 import FILE_FLAG_OVERLAPPED, INVALID_HANDLE_VALUE, CreateFile

handle = CreateFile(
path,
0,
winKernel.FILE_SHARE_READ | winKernel.FILE_SHARE_WRITE,
None,
winKernel.OPEN_EXISTING,
FILE_FLAG_OVERLAPPED,
None,
)
if handle == INVALID_HANDLE_VALUE:
if _isDebug():
log.debugWarning(f"Opening device {path} to get additional info failed: {ctypes.WinError()}")
if (
handle := CreateFile(
path,
0,
winKernel.FILE_SHARE_READ | winKernel.FILE_SHARE_WRITE,
None,
winKernel.OPEN_EXISTING,
FILE_FLAG_OVERLAPPED,
None,
)
) == INVALID_HANDLE_VALUE:
if (err := ctypes.GetLastError()) == SystemErrorCodes.SHARING_VIOLATION:
if _isDebug():
log.debugWarning(
f"Opening device {path} to get additional info failed because the device is being used. "
"Falling back to cache for device info",
)
if cachedInfo := _getHidInfoCache.get(path):
cachedInfo.update(info)
return cachedInfo
elif _isDebug():
log.debugWarning(f"Opening device {path} to get additional info failed: {ctypes.WinError(err)}")
return info
try:
attribs = HIDD_ATTRIBUTES()
Expand All @@ -555,6 +569,7 @@ def _getHidInfo(hwId, path):
ctypes.windll.hid.HidD_FreePreparsedData(pd)
finally:
winKernel.closeHandle(handle)
_getHidInfoCache[path] = info
return info


Expand Down
2 changes: 2 additions & 0 deletions source/winAPI/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ class SystemErrorCodes(enum.IntEnum):
ACCESS_DENIED = 0x5
INVALID_DATA = 0xD
NOT_READY = 0x15
SHARING_VIOLATION = 0x20
"""The process cannot access the file because it is being used by another process."""
INVALID_PARAMETER = 0x57
MOD_NOT_FOUND = 0x7E
CANCELLED = 0x4C7
2 changes: 2 additions & 0 deletions user_docs/en/changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ Specifically, MathML inside of span and other elements that have the attribute `
In any document, if the cursor is on the last line, it will be moved to the end when using this command.
(#17251, #17430, @nvdaes)
* In web browsers, changes to text selection no longer sometimes fail to be reported in editable text controls. (#17501, @jcsteh)
* When the Standard HID Braille Display driver is explicitly selected as the braille display driver, and the braille display list is opened, NVDA correctly identifies the HID driver as the selected driver instead of showing no driver selected. (#17537, @LeonarddeR)
* The Humanware Brailliant driver is now more reliable in selecting the right connection endpoint, resulting in better connection stability and less errors. (#17537, @LeonarddeR)

### Changes for Developers

Expand Down