Отладочный порт

Материал из Wiren Board



Контроллеры Wiren Board имеют отладочный порт, через который можно получить прямой доступ к консоли контроллера. Через него можно взаимодействовать с загрузчиком и следить за загрузкой операционной системы (последовательная консоль, serial console). Другие способы подключения к контроллеру: через веб-интерфейс, по SSH.

Физическая реализация порта отладочной консоли

Физически в разных версиях контроллера отладочный порт реализован по разному:

  • для версий WB 6 и позднее он выглядит как Micro-USB разъём (подпись Debug Console);
  • для версий WB 5.8 и позднее он выглядит как Micro-USB разъём (подпись Debug Console или Debug USB);
  • для версий WB 5.6 и ранее, до версии 2.8 он выглядит как трёхштыревой разъём (подпись Debug UART).

Программно во всех случаях это последовательный порт.

Варианты реализации отладочной консоли в разных версиях контроллеров перечислены ниже.

Реализация отладочной консоли в контроллерах Wiren Board

Версия коннтроллера Тип разъема Название разъема Интерфейс Чип USB/UART
6.4 и старше microUSB Debug Console USB/UART HT42B534
6.0 — 6.3 microUSB Debug Console USB/UART CH340/CH341
5.8 — 5.9 microUSB Debug Console USB/UART CH340/CH341
5.6.1 3-pin UART (Gnd, Rx, Tx) UART UART (3,3 В)
5.3 3-pin UART (Tx, Rx, GND) Debug UART UART (3,3 В)
4 3-pin UART (Gnd, Rx, Tx) Debug UART UART (3,3 В)
3.5 3-pin UART (Gnd, Tx, Rx) UEXT1 (выводы 2,3,4) и 3-pin разъем без названия UART (3,3 В)
2.8 3-pin UART (Gnd, Tx, Rx) UEXT1 (выводы 2,3,4) и 3-pin разъем без названия UART (3,3 В)

Поддержка в операционных системах

Версия контроллера Linux Windows XP, 7, 8 Windows 10 MacOS X (High Sierra) Android 9 + USB Serial Console
6.4 и старше Модуль ядра cdc_acm (все новые дистрибутивы — из коробки), смотрите дополнительную информацию по настройке порта Необходим драйвер HT42B534 Из коробки Из коробки Из коробки
6.0 — 6.3 Модуль ядра ch341 (все новые дистрибутивы — из коробки) Необходим драйвер CH341SER Необходим драйвер CH341SER [CH341SER_MAC.ZIP] Из коробки
5.8 — 5.9 Модуль ядра ch341 (все новые дистрибутивы — из коробки) Необходим драйвер CH341SER Необходим драйвер CH341SER [CH341SER_MAC.ZIP] Из коробки

Для контроллеров версии 5.6.1 и младше требуется переходник USB/UART. См. раздел Подключение к отладочному порту в Wiren Board 5.6 и младше

Подключение к отладочному порту контроллеров Wiren Board 6, Wiren Board 5.8 и Wiren Board 5.9

Разъем Debug Console Wiren Board 5.8 и 5.9
Разъем Debug Console Wiren Board 6
Кабель USB — Micro-USB
Номер порта в Windows

Как найти порт отладочной консоли

На корпусе напротив разъема порта отладочной консоли находится надпись Debug Console.

Подключение

Для подключения понадобится стандартный кабель USB — Micro-USB - такой же, как для подключения сотовых телефонов. Более точное название кабеля USB (A) — Micro-USB (B). Разъем USB (А) подключается к компьютеру, Micro-USB (B) — к контроллеру.

Кабели от зарядных устройств подходят, но бывают исключения. Лучше выбирать такие, на которых указано, что они предназначены для передачи данных. Если кабель выбран правильно, Windows сообщит звуком об обнаружении устройства.

Драйвера адаптеров и названия виртуальных COM-портов

Внутри контроллера установлен переходник USB-UART; подробнее — в таблице Реализация отладочной консоли в контроллерах Wiren Board.

  • Linux: адаптер обычно определяется автоматически, при подключении в выводе команды dmesg должна появится строка usb 1-1: ch341-uart converter now attached to ttyUSB0 или (для версий контроллера 6.4 и старше) cdc_acm:3-6:1.0: ttyACM0: USB ACM device. Номер порта ttyUSBx или ttyACMx может меняться, в зависимости от уже подключенных устройств. Смотрите список файлов в папке /dev/ . Консольный порт контроллеров новых версий 6.4 и старше определяется автоматически как устройство /dev/ttyACM0. Смотрите также раздел Настройка работы отладочного порта в Linux для WB6.4 и выше.
  • Windows: в зависимости от версии и типа контроллера возможно потребуется установка драйвера (см. таблицу Поддержка в операционных системах). В Диспетчере устройств (Device Manager) в разделе Ports(COM&LPT) должен появиться виртуальный COM-порт контроллера. Если не очевидно, какой из портов используется контроллером, можно отсоединить кабель и включить снова.
  • macOS: Начиная с High Sierra отладочная консоль контроллеров определяется из коробки, предыдущие версии операционной системы, возможно, потребуют установки драйверов. При подключении создается устройство /dev/tty.usbserial-1410 или /dev/tty.usbmodem00001 (для контроллеров версии 6.4 и старше).
  • Android: Поздние версии Android при подключении через OTG поддерживают отладочную консоль контроллеров без дополнительных драйверов. Тестировалось с приложением USB Serial Console.

Настройка работы отладочного порта в Linux для WB6.4 и выше

Суть проблемы: на некоторых системах процесс ModemManager автоматически открывает устройство /dev/ttyACM0. Для этого необходимо отключить ModemManager для данного устройства с помощью правил udev.

  • Создаем файл исключений udev
 sudo nano /etc/udev/rules.d/99-wb-debug-usb.rules
  • в который записываем cтрочку
 ATTRS{idVendor}=="04d9" ATTRS{idProduct}=="b534", ENV{ID_MM_DEVICE_IGNORE}="1"
  • После сохранения файла необходимо перезагрузить правила udev:
 sudo udevadm control --reload-rules


Переходите к настройке работы с последовательным портом.


Подключение к отладочному порту в Wiren Board 5.6 и младше

Как найти штыревой разъем порта отладочной консоли

Подключение

Для подключения понадобится адаптер USB-UART. Внимание!

Адаптер USB-UART и набор соединительных проводов
  • Подключайте Debug UART только через переходники USB-UART с напряжением 3,3 В.
  • UART не является синонимом RS-232 (где напряжение на линии может быть 5 В, 12 В и т.д.). Подключение Debug UART к порту RS-232 (или переходнику USB-RS-232) напрямую приведет к необратимому повреждению устройства.

Подключите адаптер USB-UART к компьютеру, соедините контакты адаптера с контактами (штырьками) отладочного порта на контроллере по схеме:

  • GND к GND,
  • TX к RX,
  • RX к TX.

На некоторых переходниках маркировка перепутана — попробуйте соединить TX с TX и RX с RX.

Поддержка переходников USB/UART

Существует большое количество переходников USB/UART, в таблице приводится информация о поддержке в операционных системах переходников с наиболее распространенными чипами. Таблица будет уточняться по мере получения новых данных.

Переходник USB/UART (чип) Linux Windows XP, 7, 8 Windows 10 MacOS X (High Sierra) Android 9 + USB Serial Console
FTDI232 Модуль ядра ftdi_sio требуют драйверов на ОС из коробки требуют драйверов на ОС из коробки Нет информации Из коробки
CP2102 Модуль ядра cp210x Silicon Labs CP210x VCP Driver Silicon Labs CP210x VCP Driver Silicon Labs CP210x VCP Driver Из коробки
CH340/CH341 Модуль ядра ch341 Необходим драйвер CH341SER Из коробки CH341SER_MAC.ZIP Из коробки
PL2303xx Модуль ядра pl2303 необходим драйвер нет информации нет информации нет информации


Драйвера адаптеров

  • Windows: установите драйвер конкретного адаптера, если он не поддерживается операционной системой.
  • Linux: адаптер скорее всего будет сразу поддерживаться ядром, но, возможно, придётся скомпилировать соответствующий модуль.
  • macOS: установите драйвер конкретного адаптера, если он не поддерживается операционной системой.
  • Android: установите драйвер конкретного адаптера, если он не поддерживается операционной системой.

Переходите к настройке работы с последовательным портом.

Настройка работы с последовательным портом

Установка программы для работы с последовательным портом

Для работы с последовательным портом установите на вашем компьютере подходящую утилиту - например, PuTTY:

  • версия для Windows - скачать с официального сайта
  • версия для Linux Debian или Ubuntu - выполните команду apt-get install putty
  • версия для macOS и инструкция по установке: PuTTY for Mac OS X, возможно использование терминального клиента cu, например
cu -s 115200 -l /dev/usbmodem00001

.

Подойдут также другие программы.

Настройки соединения: 115200 8N1 (115200 кбит/с, 8 бит, нет бита чётности, один стоп-бит), root/wirenboard.

Подключение

  1. Запустите приложение от имени администратора:
    • в Windows - щёлкните по значку PuTTY правой кнопкой и выберите Run This Program As An Administrator
    • в Linux - gksu putty

  2. В меню слева выберите последний пункт - Serial. В появившиеся поля справа введите настройки порта:
    • название последовательного порта
      • для Windows - это COM4 (цифра может меняться, см.выше)
      • для Linux - это /dev/ttyUSB0 либо /dev/ttyACM0 (для WB6.4 и выше). Цифра может меняться, см.выше.
    • скорость - 115200
    • количество битов в посылке - 8
    • количество стоп-битов - 1
    • чётность - нет
    • контроль потока - нет

    Putty serial settings.png

  3. В меню слева выберите первый пункт - Session. Справа переключите тип подключения на Serial - должны автоматически заполниться настройки порта. Затем нажмите Open.

    Putty serial open.png

  4. Чтобы проверить, правильно ли вы всё сделали:
    • для Wiren Board 5.8 и старше: нажмите Enter. Будет предложена авторизация.
    • для Wiren Board 5.6 и младше, до версии 2.8 включительно: кнопкой выключите и включите контроллер - на экране должны появиться сообщения о загрузке.
      • запрос логина - введите root и нажмите Enter,
      • запрос пароля - введите wirenboard (вводимые символы не будут отображаться) и нажмите Enter.

  1. Появится приветственное сообщение - вы в консоли контроллера. Для перехода в визуальный файловый менеджер введите mc.

    Putty serial logged in.png