wch-ch56x-lib

Эта библиотека была создана вместе с Hydradancer — новым бэкендом для библиотеки эмуляции USB Facedancer на основе чипа WCH569.

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

Эта библиотека предоставляет драйверы USB3, USB2, HSPI и SerDes, протестированные с помощью бенчмарков и тестов целостности в tests/. Она основана на wch-ch56x-bsp, но её цель — предоставить библиотеку более высокого уровня. Поскольку Hydradancer использовал несколько периферийных устройств одновременно (USB3/HSPI, USB2/HSPI), была реализована очередь прерываний, чтобы не пропускать прерывания при использовании hspi_scheduled, а также статический пул памяти. Хотя тесты в этом репозитории достаточно просты, чтобы выполнять обработку внутри обработчиков прерываний, Hydradancer терял прерывания, и потребовалось откладывать их обработку до пользовательского режима.

Использование этой библиотеки в вашем проекте

В проекте на основе CMake достаточно использовать add_subdirectory(path_to_wch-ch56x-lib) и слинковаться с целью wch-ch56x-lib. Сейчас wch-ch56x-lib является INTERFACE-целью, то есть исходные файлы и заголовки будут компилироваться вместе с вашей целью, а не отдельно.

Доступные опции

• LOG_LEVEL
• LOG_FILTER_IDS
• LOG_TYPE_PRINTF, LOG_TYPE_BUFFER, LOG_TYPE_SERDES
• POOL_BLOCK_SIZE, POOL_BLOCK_NUM
• INTERRUPT_QUEUE_SIZE

Сборка тестов и детали компиляции

Для сборки и прошивки встроенного ПО см. руководство по сборке.

Дополнительную информацию о параметрах компиляции также можно найти там.

Подробнее о компиляции

В этом проекте используются одна или две платы HydraUSB3 на основе микроконтроллера WCH569 RISCV.

Структура проекта

wch-ch56x-lib/
|   ├─  tests/ # test firmwares to test various parts of the library
|   ├─  src/
|   |   ├─wch-ch56x-lib # the source/header files of the lib
|   ├─  tools/
|   ├─  docs/ # additional documentation

Тесты

Дополнительную информацию о различных тестах и способах их использования можно найти в docs/Testing.md

Как внести свой вклад

Если вы столкнулись с ошибками или хотите предложить новые функции, пожалуйста, просмотрите существующие issues и при необходимости создайте новую issue.

Чтобы внести код, рекомендуется проверить существующие issues и сообщить другим участникам через комментарий, что вы работаете над чем-то. Так вы не потратите время зря на функцию, которая не нужна или уже находится в разработке.

После этого, пожалуйста, создайте pull request и укажите ссылку на связанную issue.

Ваш код должен следовать руководству по стилю кодирования.