Перейти к основному содержимому
примечание

АО «БАЙКАЛ ЭЛЕКТРОНИКС», ИНН: 7707767484
АО «БАЙКАЛ ЭЛЕКТРОНИКС» оставляет за собой право вносить любые изменения в настоящий документ без дополнительного уведомления.

Рекомендации по применению редактора Visual Studio Code

Скачать PDF ⬇️ AppNote-VSCode_v1.pdf

Введение​

В документе представлены рекомендации по применению редактора Visual Studio Code для разработки и отладки программного обеспечения Микроконтроллера BE-U1000 (далее – МК) под ОС Windows.

Редактор Visual Studio Code с рядом настроек и расширений, позволяет создавать программы для МК, структурировать код программ и данные компилировать и исполнять программы, просматривать значения переменных, взаимодействовать с МК и отлаживать программы, используя точки останова и режим пошагового исполнения.

Для ознакомления с общей информацией о МК см. документы:

  • «BE-U1000. Краткое описание» и «BE-U1000. Руководство пользователя». «BE-U1000. Техническая спецификация» и «BE-U1000. Reference Manual».

Минимальные требования для разработки программ МК в Visual Studio Code:

  • Частота процессора 1.6 ГГц и выше

  • Объем оперативной памяти 4 Гб и выше

  • Объем свободного дискового пространства 100 Мб

  • Наличие свободного разъема USB 2.0 и выше

  • ОС Windows 8 или выше

  • Visual Studio Code v.1.79.2 или выше

  • SDK MCU для Windows ver.2.3.0 или новее (далее - SDK)

Представленные материалы рассчитаны на взаимодействие с платой МК EVU-BA-2.5.

Условные обозначения, термины и сокращения​

В документе используются условные обозначения, сокращения и термины, указанные в таблице ниже.

Таблица 1 – Условные обозначения, термины и сокращения
ОбозначениеРасшифровка
DFUПротокол обновления прошивки через USB-интерфейс микроконтроллера BE-U1000
eFlashВстроенная флэш-память МК. Содержит две области – Main и NVR.
JTAGJoint Test Action Group – стандартизированный аппаратный интерфейс (IEEE 1149.1), предназначенный для тестирования и отладки электронных устройств
MakefileСборочный скрипт с инструкциями по сборке и компиляции программы
SDKКомплект средств разработки – Набор утилит, API, инструментов, библиотек, примеров кода и документации, для разработки программного обеспечения микроконтроллера BE-U1000
TCMTightly Coupled Memory (тесно связанная память) — память типа SRAM на МК
BE-U1000, расположенная рядом с ядром для более быстрого доступа
Visual Studio CodeБесплатный редактор и расширяемая среда программирования от компании Microsoft
Бутстрап
Bootstrap
Конфигурационный вывод — Вывод МК, предназначенный для выбора режима работы при начальной загрузке
МК
MCU
Микроконтроллер BE-U1000
ПлатаОтладочная плата EVU-BA-2.5 с установленным на ней микроконтроллером BE-U1000
Рабочее пространство
Workspace
Папка или совокупность нескольких папок, объединяющих код программ, утилиты, библиотеки и служебные файлы, с которыми взаимодействует разработчик
Расширение
Extension
Плагин — Программный модуль или пакет кода, добавляющий новые возможности Visual Studio Code
ТерминалКомандная строка (консоль) внутри редактора, позволяющая запускать файлы и команды и следить за их выполнением, не переключаясь в консоль ОС
Точка останова
Breakpoint
Преднамеренное прерывание выполнения программы, устанавливаемое разработчиком на определенной строке кода.
Позволяет изучить состояние программы, проверить значения переменных и пошагово выполнять код для поиска ошибок.

Установка SDK​

Распаковка и настройка переменных среды​

SDK представляет из себя комплект утилит, библиотек, модулей и примеров кода, необходимых для программирования МК.

SDK для МК Baikal BE-U1000 под Windows можно скачать бесплатно с сайта https://mcu.baikalelectronics.ru/, как это показано на рисунке 1, в формате одного архива. Рекомендуется распаковать SDK в корневой каталог рабочего диска (например, в папку C:\SDK\), чтобы символический путь к файлам пакета был короче, так как дерево папок SDK может содержать очень длинные имена файлов и пути, превышающие ограничения Windows.

Иллюстрация

Рисунок 1 – Архив SDK на сайте «Байкал Электроникс»

Переход в терминал в Windows осуществляется через нажатие комбинации клавиш <Win>+<R> и вызов cmd.

Для корректного функционирования SDK и утилиты Makefile в окне терминала перейти в папку [SDK_Path]\Tools\toolchain\xpack-windows-build-tools и запустить файл установки переменных среды add_to_path.bat

В качестве альтернативы исполнения bat-файла можно добавить в системную переменную среды Path путь: [SDK_Path]\Tools\toolchain\xpack-windows-build-tools\bin.

Установка драйвера USB для взаимодействия через адаптер USB-JTAG​

В этом руководстве описан способ взаимодействия с платой EVU-BA-2.5 через разъем JTAG, используя адаптер USB-JTAG. Для взаимодействия SDK с МК через JTAG установить драйвер. Эту операцию можно выполнить с помощью программы Zadig-2.9. Это программное обеспечение входит в состав SDK и находится в папке [SDK_Path]\Tools, как это показано на рисунке 2 – Расположение файла программы Zadig-2.9 в каталоге SDK.

Установку программы выполнить самостоятельно или с помощью меню Visual Studio Code, как это описано в Разделе 5.

Иллюстрация

Рисунок 2 – Расположение файла программы Zadig-2.9 в каталоге SDK

Для настройки драйверов в системе с помощью программы Zadig микроконтроллер должен быть подключен к ПК через USB-разъем JTAG/UART0, как показано на рисунке 3 – Разъем для подключения в режиме JTAG/UART0, а перемычки на плате должны быть выставлены в положения: «JTAG» и «питание USB», как это показано на рисунке 4 – Положение перемычек на плате.

Иллюстрация

Рисунок 3 – Разъем для подключения в режиме JTAG/UART0

Иллюстрация Иллюстрация Иллюстрация

Рисунок 4 – Положение перемычек на плате

После запуска программы Zadig на экран выводится окно, показанное на рисунке 5 – Интерфейс программы Zadig непосредственно после запуска.

Иллюстрация

Рисунок 5 – Интерфейс программы Zadig непосредственно после запуска

В интерфейсе программы Zadig, в разделе Options (Опции), включить отображение всех доступных устройств, как показано на рисунке 6 – Опция отображения всех устройств.

Иллюстрация

Рисунок 6 – Опция отображения всех устройств

Далее, в списке устройств (1) необходимо выбрать JTAG, как это показано на рисунке 7 – Выбор устройств, так же обозначенный Interface 1, а UART соответствует Interface 0. В такой ситуации используется адаптер USB-to-JTAG, расположенный на плате и внешний по отношению к самому контроллеру.

Иллюстрация

Рисунок 7 – Выбор устройств

После выбора интерфейса устройства в поле (2) ниже нужно выбрать драйвер WinUSB и нажать на расположенную ниже кнопку Install Driver (3), как показано на рисунке 8 – Установка драйвера.

Иллюстрация

Рисунок 8 – Установка драйвера

При успешной установке драйвера будет выведено сообщение о завершении операции, показанное на рисунке 9 – Успешная замена драйвера. В поле названия драйвера будет указано WinUSB.

Иллюстрация

Рисунок 9 – Успешная замена драйвера

Установка Visual Studio Code​

Установка редактора Visual Studio Code и его расширений​

Редактор Visual Studio Code доступен для загрузки с сайта разработчика https://code.visualstudio.com/download. Установка проходит почти полностью в автоматическом режиме, без участия пользователя. В зависимости от типа дистрибутива, может потребоваться выбрать опции размещения иконки вызова и автоматического запуска редактирования для определенных типов файлов. Никаких настроек, влияющих на работу программы, на этом этапе производить не требуется.

Типичный вид графического пользовательского интерфейса Visual Studio Code​

Общий вид интерфейса Visual Studio Code по умолчанию показан на рисунке 10 – Общий вид интерфейса Visual Studio Code по умолчанию.

Иллюстрация

Рисунок 10 – Общий вид интерфейса Visual Studio Code по умолчанию

(1) – Редактор кода программы пользователя (Editor). Переключение между разными файлами в редакторе осуществляется в горизонтальной строке меню над текстом кода, с помощью закладок.

(2) – Нижняя сервисная панель (Panel) чаще всего используется как окно терминала Visual Studio Code (по умолчанию может отсутствовать, вызывается комбинацией клавиш <Ctrl>+< ` >. Может использоваться в управлении процессами отладки, запуска программ на МК и процессов загрузки образов программ в память МК и т.п. Так же панель имеет вкладки:

  • Проблемы (Problems) – в ней отображаются ошибки в коде и прочие ошибки;

  • Вывод (Output) — в эту вкладку выводится информация по сборке и работе IDE;

  • Консоль отладки (Debug console) – в этой вкладке можно управлять отладкой;

  • Терминал (Terminal) – кроме функционала собственно терминала, в этой вкладке отображаются

  • служебные фоновые процессы;

Также, в этой панели могут отображаться вкладки различных установленных расширений.

(3) – Панель действий с пиктограммами для выбора функций левого сервисного окна (Activity bar).

(4) – Левая сервисная панель, функции которой определяются выбранной пиктограммой в поле (3). Обычно в процессе работы эта панель используется для обзора рабочего пространства, в котором отображено дерево подключенных каталогов файлов, задействованных в проекте. В режиме отладки на этой панели отображаются текущие значения выбранных переменных, точки останова, значения ячеек памяти, стек и регистры, как это показано на рисунке 11 – Вид сервисного окна в режиме отладки.

Иллюстрация

Рисунок 11 – Вид сервисного окна в режиме отладки

Расширения Visual Studio Code​

Для расширения функций Visual Studio Code для определенного вида задач используются т.н. программные расширения. Просмотреть установленные программные расширения, найти программные расширения или добавить новые можно выбрав пиктограмму расширений в поле интерфейса (3), как это показано на рисунке 10 – Общий вид интерфейса Visual Studio Code по умолчанию. Расширения могут устанавливаться через Visual Studio Code из встроенного Магазина приложений (Extensions Market, <Ctrl>+<Shift>+<X>) или через VSIX-файл.

Рекомендуется установить программное расширение С/С++ от Microsoft (ms-vscode.cpptools). После установки этого расширения Visual Studio Code превратится в полноценную среду разработки на языках программирования C и C++. Опционально рекомендуется установить расширения Makefile Tools (ms-vscode.makefile-tools) и Peripheral Viewer (mcu-debug.peripheral-viewer). На рисунке 12 – Расширения для работы с C/C++ эти плагины показаны в библиотеке Visual Studio Code.

Иллюстрация

Рисунок 12 – Расширения для работы с C/C++

На ваше усмотрение, можно так же поставить расширение ms-ceintl.vscode-language-pack-ru от Microsoft, которое переводит язык интерфейса Visual Studio Code на русский язык. Далее, мы указываем названия элементов среды Visual Studio Code на английском языке, с русским переводом.

Конфигурация Visual Studio Code для работы с MCU SDK​

В структуре файлов SDK находится папка C:/SDK/Tools/IDE/.vscode. В ней размещаются файлы .json с настройками среды Visual Studio Code, как это показано на рисункеРисунок 13 – Файлы папки vscode. Далее, эту папку скопировать в свою рабочую папку проекта, например: C:/WORK/.vscode.