1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
# Copyright 2017 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Utilities for using lightweight console functions."""
# Note: This is a py2/3 compatible file.
import datetime
import sys
import time
import six
import usb # pylint:disable=import-error
from . import pty_driver, stm32uart
def get_subprocess_args():
if six.PY3:
return {"encoding": "utf-8"}
return {}
class TinyServoError(Exception):
"""Exceptions."""
def log(output):
"""Print output to console, logfiles can be added here.
Args:
output: string to output.
"""
sys.stdout.write(output)
sys.stdout.write("\n")
sys.stdout.flush()
def check_usb(vidpid, serialname=None):
"""Check if |vidpid| is present on the system's USB.
Args:
vidpid: string representation of the usb vid:pid, eg. '18d1:2001'
serialname: serialname if specified.
Returns:
True if found, False, otherwise.
"""
if get_usb_dev(vidpid, serialname):
return True
return False
def check_usb_sn(vidpid):
"""Return the serial number
Return the serial number of the first USB device with VID:PID vidpid,
or None if no device is found. This will not work well with two of
the same device attached.
Args:
vidpid: string representation of the usb vid:pid, eg. '18d1:2001'
Returns:
string serial number if found, None otherwise.
"""
dev = get_usb_dev(vidpid)
if dev:
dev_serial = usb.util.get_string(dev, dev.iSerialNumber)
return dev_serial
return None
def get_usb_dev(vidpid, serialname=None):
"""Return the USB pyusb devie struct
Return the dev struct of the first USB device with VID:PID vidpid,
or None if no device is found. If more than one device check serial
if supplied.
Args:
vidpid: string representation of the usb vid:pid, eg. '18d1:2001'
serialname: serialname if specified.
Returns:
pyusb device if found, None otherwise.
"""
vidpidst = vidpid.split(":")
vid = int(vidpidst[0], 16)
pid = int(vidpidst[1], 16)
dev_g = usb.core.find(idVendor=vid, idProduct=pid, find_all=True)
dev_list = list(dev_g)
if not dev_list:
return None
# Check if we have multiple devices and we've specified the serial.
dev = None
if serialname:
for d in dev_list:
dev_serial = usb.util.get_string(d, d.iSerialNumber)
if dev_serial == serialname:
dev = d
break
if dev is None:
return None
else:
try:
dev = dev_list[0]
except StopIteration:
return None
return dev
def check_usb_dev(vidpid, serialname=None):
"""Return the USB dev number
Return the dev number of the first USB device with VID:PID vidpid,
or None if no device is found. If more than one device check serial
if supplied.
Args:
vidpid: string representation of the usb vid:pid, eg. '18d1:2001'
serialname: serialname if specified.
Returns:
usb device number if found, None otherwise.
"""
dev = get_usb_dev(vidpid, serialname=serialname)
if dev:
return dev.address
return None
def wait_for_usb_remove(vidpid, serialname=None, timeout=None):
"""Wait for USB device with vidpid to be removed.
Wrapper for wait_for_usb below
"""
wait_for_usb(
vidpid, serialname=serialname, timeout=timeout, desiredpresence=False
)
def wait_for_usb(vidpid, serialname=None, timeout=None, desiredpresence=True):
"""Wait for usb device with vidpid to be present/absent.
Args:
vidpid: string representation of the usb vid:pid, eg. '18d1:2001'
serialname: serialname if specificed.
timeout: timeout in seconds, None for no timeout.
desiredpresence: True for present, False for not present.
Raises:
TinyServoError: on timeout.
"""
if timeout:
finish = datetime.datetime.now() + datetime.timedelta(seconds=timeout)
while check_usb(vidpid, serialname) != desiredpresence:
time.sleep(0.1)
if timeout:
if datetime.datetime.now() > finish:
raise TinyServoError(
"Timeout", "Timeout waiting for USB %s" % vidpid
)
def do_serialno(serialno, pty):
"""Set serialnumber 'serialno' via ec console 'pty'.
Commands are:
# > serialno set 1234
# Saving serial number
# Serial number: 1234
Args:
serialno: string serial number to set.
pty: tinyservo console to send commands.
Raises:
TinyServoError: on failure to set.
ptyError: on command interface error.
"""
cmd = r"serialno set %s" % serialno
regex = r"Serial number:\s+(\S+)"
results = pty._issue_cmd_get_results(cmd, [regex])[0]
sn = results[1].strip().strip("\n\r")
if sn == serialno:
log("Success !")
log("Serial set to %s" % sn)
else:
log("Serial number set to %s but saved as %s." % (serialno, sn))
raise TinyServoError(
"Serial Number",
"Serial number set to %s but saved as %s." % (serialno, sn),
)
def setup_tinyservod(vidpid, interface, serialname=None, debuglog=False):
"""Set up a pty
Set up a pty to the ec console in order
to send commands. Returns a pty_driver object.
Args:
vidpid: string vidpid of device to access.
interface: not used.
serialname: string serial name of device requested, optional.
debuglog: chatty printout (boolean)
Returns:
pty object
Raises:
UsbError, SusbError: on device not found
"""
vidstr, pidstr = vidpid.split(":")
vid = int(vidstr, 16)
pid = int(pidstr, 16)
suart = stm32uart.Suart(
vendor=vid,
product=pid,
interface=interface,
serialname=serialname,
debuglog=debuglog,
)
suart.run()
pty = pty_driver.ptyDriver(suart, [])
return pty
|