mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
9266a7c52e
Add idf.py monitor argument --no-reset (-R) to prevent resetting the CPU on monitor startup idf.py monitor: fix type signature idf.py monitor: fix reset key shortcut when --no-reset (-R) argument is used idf.py monitor: change --no-reset (-R) argument descriptions in help idf.py monitor: simplify --no-reset (-R) argument checks idf.py monitor: add warning if --no-reset is used, but --port is not given idf.py monitor: ignore --no-reset if --port is not given
121 lines
4.4 KiB
Python
121 lines
4.4 KiB
Python
# SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
import queue
|
|
import subprocess
|
|
import sys
|
|
import time
|
|
|
|
import serial
|
|
|
|
from .constants import CHECK_ALIVE_FLAG_TIMEOUT, MINIMAL_EN_LOW_DELAY, RECONNECT_DELAY, TAG_SERIAL
|
|
from .output_helpers import red_print, yellow_print
|
|
from .stoppable_thread import StoppableThread
|
|
|
|
|
|
class Reader(StoppableThread):
|
|
""" Output Reader base class """
|
|
|
|
|
|
class SerialReader(Reader):
|
|
""" Read serial data from the serial port and push to the
|
|
event queue, until stopped.
|
|
"""
|
|
|
|
def __init__(self, serial_instance, event_queue, reset):
|
|
# type: (serial.Serial, queue.Queue, bool) -> None
|
|
super(SerialReader, self).__init__()
|
|
self.baud = serial_instance.baudrate
|
|
self.serial = serial_instance
|
|
self.event_queue = event_queue
|
|
self.gdb_exit = False
|
|
self.reset = reset
|
|
if not hasattr(self.serial, 'cancel_read'):
|
|
# enable timeout for checking alive flag,
|
|
# if cancel_read not available
|
|
self.serial.timeout = CHECK_ALIVE_FLAG_TIMEOUT
|
|
|
|
def run(self):
|
|
# type: () -> None
|
|
if not self.serial.is_open:
|
|
self.serial.baudrate = self.baud
|
|
# We can come to this thread at startup or from external application line GDB.
|
|
# If we come from GDB we would like to continue to run without reset.
|
|
|
|
high = False
|
|
low = True
|
|
|
|
self.serial.dtr = low # Non reset state
|
|
self.serial.rts = high # IO0=HIGH
|
|
self.serial.dtr = self.serial.dtr # usbser.sys workaround
|
|
# Current state not reset the target!
|
|
self.serial.open()
|
|
if not self.gdb_exit and self.reset:
|
|
self.serial.dtr = high # Set dtr to reset state (affected by rts)
|
|
self.serial.rts = low # Set rts/dtr to the reset state
|
|
self.serial.dtr = self.serial.dtr # usbser.sys workaround
|
|
|
|
# Add a delay to meet the requirements of minimal EN low time (2ms for ESP32-C3)
|
|
time.sleep(MINIMAL_EN_LOW_DELAY)
|
|
self.gdb_exit = False
|
|
self.serial.rts = high # Set rts/dtr to the working state
|
|
self.serial.dtr = self.serial.dtr # usbser.sys workaround
|
|
try:
|
|
while self.alive:
|
|
try:
|
|
data = self.serial.read(self.serial.in_waiting or 1)
|
|
except (serial.serialutil.SerialException, IOError) as e:
|
|
data = b''
|
|
# self.serial.open() was successful before, therefore, this is an issue related to
|
|
# the disappearance of the device
|
|
red_print(e)
|
|
yellow_print('Waiting for the device to reconnect', newline='')
|
|
self.serial.close()
|
|
while self.alive: # so that exiting monitor works while waiting
|
|
try:
|
|
time.sleep(RECONNECT_DELAY)
|
|
self.serial.open()
|
|
break # device connected
|
|
except serial.serialutil.SerialException:
|
|
yellow_print('.', newline='')
|
|
sys.stderr.flush()
|
|
yellow_print('') # go to new line
|
|
if data:
|
|
self.event_queue.put((TAG_SERIAL, data), False)
|
|
finally:
|
|
self.serial.close()
|
|
|
|
def _cancel(self):
|
|
# type: () -> None
|
|
if hasattr(self.serial, 'cancel_read'):
|
|
try:
|
|
self.serial.cancel_read()
|
|
except Exception: # noqa
|
|
pass
|
|
|
|
|
|
class LinuxReader(Reader):
|
|
""" Read data from the subprocess that runs runnable and push to the
|
|
event queue, until stopped.
|
|
"""
|
|
|
|
def __init__(self, process, event_queue):
|
|
# type: (subprocess.Popen, queue.Queue) -> None
|
|
super().__init__()
|
|
self.proc = process
|
|
self.event_queue = event_queue
|
|
|
|
self._stdout = iter(self.proc.stdout.readline, b'') # type: ignore
|
|
|
|
def run(self): # type: () -> None
|
|
try:
|
|
while self.alive:
|
|
for line in self._stdout:
|
|
if line:
|
|
self.event_queue.put((TAG_SERIAL, line), False)
|
|
finally:
|
|
self.proc.terminate()
|
|
|
|
def _cancel(self): # type: () -> None
|
|
self.proc.terminate()
|