Разработка устройства USB - как начать работу с библиотеками AVR USB (V-USB) и libusb
Написал microsin   
25.09.2008

Сначала немного общих слов о пакете (библиотеке) AVR USB (новое название V-USB) компании Objective Development, и библиотеке libusb.

AVR USB (V-USB) - пакет, содержащий библиотеку подпрограмм (и примеры её использования), которая позволяет с помощью микроконтроллеров семейства AVR (призводитель Atmel) делать низкоскоростные (low-speed, стандарт USB 1.0) USB-устройства. В этих устройствах протокол USB реализован программно - в firmware, прошиваемом в микроконтроллер. Кроме того, пакет AVR-USB содержит пример программ для хоста (компьютер, к которому подключаются USB-устройства), которые реализуют обмен данными с разработанными устройствами USB. Библиотека V-USB разработана компанией Objective Development и доступна как для свободного, так и для коммерческого использования (в зависимости от выбранной Вами лицензии).

Программы для хоста используют, в свою очередь, другую библиотеку - libusb [13]. Будем для простоты называть программы, прошиваемые в микроконтроллер термином firmware, а программы, которые работают на компьютере и общаются с разрабатываемыми нами устройствами USB - термином ПО хоста. Итак, процесс работы с пакетом AVR-USB (V-USB) и библиотекой libusb на платформе Windows по шагам.

1. Для просмотра и редактирования файлов Makefile и исходников нужно обзавестись хорошим текстовым редактором, поддерживающим окончания строк в стиле Unix (для тех, кто в танке - в Windows принято заканчивать строки в текстовых файлах как 0x0D, 0x0A, а в Unix более экономно - 0x0A). Я рекомендую скачать notepad2 - все просто и без затей, программа даже не требует установки, см. [14]. Там же описано, как прикрутить notepad2 заместо стандартного notepad.

2. Скачиваем пакет драйвера AVR-USB со странички http://obdev.com/products/avrusb/download.html. Версия пакета представлена в формате avrusb-YYYYMMDD.zip. Скачивайте самую последнюю версию. 24 сентября 2008 года я скачал avrusb-20080418.zip размером в 424594 байт.

3. Распакуйте в любое место папку, содержащуюся в архиве. В моем архиве была папка avrusb-20080418, я её распаковал в папку c:\avrprj.

4. В папке c:\avrprj\avrusb-20080513\examples\ находятся примеры firmware и ПО хоста. Всего там 5 папок, каждая из которых хранит отдельный проект:
custom-class - пример firmware и ПО хоста, показывающую работу с разработанным USB-устройством типа custom class.
hid-custom-rq - пример firmware и ПО хоста, показывающую работу с USB-устройством HID-класса путем отправки ему управляющих запросов (control request). Демонстрируется обмен данными в обоих направлениях.
hid-data - пример firmware и ПО хоста, также показывающую работу с устройством HID. Демонстрируется обмен данными в обоих направлениях.
hid-mouse - пример firmware, реализующего HID устройство типа мышь.
usbtool - пример ПО хоста - универсальная программа, работающая с USB-устройствами.

Для компиляции firmware и ПО хоста нужны специальные программные пакеты, установку и использование которых рассмотрим далее.

5. Начнем с firmware. Понадобится либо avr-gcc, либо IAR Embedded Workbench for AVR. В этой статье я рассматриваю установку и работу с avr-gcc. Пакет avr-gcc на платформе Windows входит в состав пакета WinAVR. Скачиваем этот пакет - идем по адресу http://winavr.sourceforge.net/, находим там ссылку на пакет (ссылка для закачки поведет на http://sourceforge.net/), скачиваем. Я скачал WinAVR-20080610-install.exe размером 23433168 байт - обычный инсталлятор. После завершения скачки запускаем его. Выбор языка установки ни на что не влияет, я выбрал русский. Инсталлятор предлагает выбрать папку для установки, я согласился на предлагаемую по умолчанию папку C:\WinAVR-20080610. Далее запросит установить снять галочки - выбрать состав устанавливаемых компонентов (Install Files, Add Directories to PATH (Recommended), Install Programmers Notepad) - я оставил все компоненты выбранными, как и предлагалось. После установки в переменную окружения Path пропишутся пути C:\WinAVR-20080610\bin и C:\WinAVR-20080610\utils\bin. Второй путь важен для работы утилиты make. Чтобы изменения для переменной Path вступили в силу для окружения пользователя, нужно перелогиниться (по крайней мере у меня так было под w2k), либо перезапустить экземпляр командного интерпретатора cmd (чтобы обновились для него переменные окружения).

6. Откомпилируем firmware из папки c:\avrprj\avrusb-20080418\examples\hid-custom-rq\firmware\. Запустим cmd, перейдем в эту папку (cd c:\avrprj\avrusb-20080418\examples\hid-custom-rq\firmware). Введем команду make, которая откроет файл Makefile в текущей папке и выполнит имеющиеся там команды (см. статью "Как устроен Makefile..."). Makefile в текущей папке сделан так, что если ввести просто make без параметров, то выведется подсказка:
C:\avrprj\avrusb-20080418\examples\hid-custom-rq\firmware>make
This Makefile has no default rule. Use one of the following:
make hex ....... to build main.hex
make program ... to flash fuses and firmware
make fuse ...... to flash the fuses
make flash ..... to flash the firmware (use this on metaboard)
make clean ..... to delete objects and hex file

Для компиляции firmware нужно ввести make hex, что и сделаем:
c:\avrprj\avrusb-20080418\examples\hid-custom-rq\firmware>make hex
cp -r ../../../usbdrv .
avr-gcc -Wall -Os -DF_CPU=16000000 -Iusbdrv -I. -DDEBUG_LEVEL=0 -mmcu=atm-ga168 -c usbdrv/usbdrv.c -o usbdrv/usbdrv.o
avr-gcc -Wall -Os -DF_CPU=16000000 -Iusbdrv -I. -DDEBUG_LEVEL=0 -mmcu=atm-ga168 -x assembler-with-cpp -c usbdrv/usbdrvasm.s -o usbdrv/usbdrvasm.o
avr-gcc -Wall -Os -DF_CPU=16000000 -Iusbdrv -I. -DDEBUG_LEVEL=0 -mmcu=atm-ga168 -c usbdrv/oddebug.c -o usbdrv/oddebug.o
avr-gcc -Wall -Os -DF_CPU=16000000 -Iusbdrv -I. -DDEBUG_LEVEL=0 -mmcu=atm-ga168 -c main.c -o main.o
avr-gcc -Wall -Os -DF_CPU=16000000 -Iusbdrv -I. -DDEBUG_LEVEL=0 -mmcu=atm-ga168 -o main.elf usbdrv/usbdrv.o usbdrv/usbdrvasm.o usbdrv/oddebug.o main.o
rm -f main.hex main.eep.hex
avr-objcopy -j .text -j .data -O ihex main.elf main.hex
avr-size main.hex
text data bss dec hex filename
0 1694 0 1694 69e main.hex

В результате в текущей папке получим файл main.hex, который и является прошивкой для микроконтроллера. Если у Вас подключен программатор avrdude (Makefile настроен на него), то для программирования кристалла просто введите make program.

Я здесь не рассматриваю, каким образом выбирается тактовая частота для микроконтроллера или его тип - это делается путем редактирования содержимого Makefile. Все хорошо расписано как в комментариях Makefile, исходного кода, а также в файлах readme.txt - на английском языке. Переведенный на русский язык пакет AVR-USB скачайте здесь - http://microsin.ru/Download.cnt/avr/avr-usb-russian.rar.

7. Теперь займемся ПО хоста. Для его компиляции нам понадобится gcc.exe, который есть в составе пакета MinGW (где скачать - см. Ссылки). Пакет MinGW - это набор портированных с Unix утилит командной строки. Я скачал MinGW-5.1.4.exe, файл размером в 140095 байт. Это хитрый инсталлятор, который при установке скачивает из интернета все необходимое. При запуске он запросит выбрать "Download and install" или "Download only", выбираем "Download and install". Далее спросит, какой пакет устанавливать - Previous, Current или Candidate. Выбираем то, что предлагается по умолчанию - Current. Далее запросят выбрать устанавливаемые компоненты. По умолчанию предлагается только "MinGW base tools", но я еще поставил галочку на всякий случай на "g++ compiler". Утилиту Make выбирать не стал, поскольку она у меня уже работает (поставилась из пакета WinAVR). Далее предложат выбрать папку для установки - C:\MinGW, соглашаемся. Далее предложат выбрать место для ярлыков, потом начнется процесс загрузки. Грузилось у меня долго, около часа, на скорости примерно 22 кбайт/сек (если верить информации инсталлятора). Грузится все в текущую папку, откуда запускали MinGW-5.1.4.exe. После установки gcc.exe оказывается в папке c:\MinGW\bin\, но в переменной Path этот путь не прописан, надо добавить вручную (надеюсь, не надо объяснять, как?).

path-tuning01.PNG path-tuning02.PNG

8. Теперь надо установить библиотеку libusb. См. ссылку на закачку релизов [13]. Найдите там ссылку для скачки наподобие libusb-win32-filter-bin-0.1.12.1.exe (цифры версии могут быть другие, выбирайте самую свежую версию). Это установщик бинарников библиотеки (бинарники позволяют работать любым приложениям Windows, использующим LibUSB), а также мастер-инсталлятор драйвера фильтра). Ставим, установщик предлагает по умолчанию в папку "C:\Program Files\LibUSB-Win32", соглашаемся. После установки, создания ярлычков инсталлятор предложит запустить тест-программу ("C:\Program Files\LibUSB-Win32\bin\testlibusb-win.exe"), которая может показать все USB устройства, с которыми можно работать через библиотеку libusb (в принципе, это все устройства USB, которые распознаны системой и имеют установленный драйвер). Программа очень полезная, может пригодиться в дальнейшем для просмотра информации об USB-устройствах. Она показывает все USB-устройства, которые корректно определены в Windows и имеют драйвера (на скриншоте ниже видны два USB-устройства - флешка Kingston DataTraveler 2.0 и debugWIRE эмулятор ATMEL JTAGICE mkII).

testlibusb-win01.PNG

Опишу установку драйверов поподробнее, потому что иногда у пользователей библиотеки бывают с этим проблемы, особенно когда они подключают новое USB-устройство к компьютеру, с другими VID и PID (даже если на нем уже ранее была установлена библиотека libusb). Проблема заключается в том, что новому устройству USB (с новыми VID и PID) требуется новый так называемый драйвер фильтра (filter driver). В процессе установки libusb-win32-devel-filter-X.X.X.X как раз и будет предложено установить драйвер фильтра на все обнаруженные USB устройства, а Ваша задача выбрать именно то устройство, которое нужно, и установить драйвер фильтра именно на него. Итак, скачиваем libusb-win32-devel-filter, например libusb-win32-devel-filter-1.2.2.0.exe, и запускаем. На запрос подтверждения запуска (если нельзя проверить издателя) щелкните на кнопку "Выполнить":

libusb-win32-devel-filter-001.PNG

На приветсвии визарда установки библиотеки LibUSB-Win32 тупо жмем Next:

libusb-win32-devel-filter-002.PNG

На запрос подтверждения принятия лицензии выбираем как обычно "I accept the agreement" и жмем Next:

libusb-win32-devel-filter-003.PNG

На окошке "важной информации" тупо жмем Next:

libusb-win32-devel-filter-004.PNG

Дальше предложат поменять путь и название папки, в которую будет установлена библиотека. Ничего менять не надо, тупо жмем Next:

libusb-win32-devel-filter-005.PNG

Дальше предложат поменять путь и название папки, в которой будут лежать ярлычки. Ничего менять не надо, тупо жмем Next:

libusb-win32-devel-filter-006.PNG

На этом установка библиотеки LibUSB завершена. Если оставить галочку "Launch filter installer wizard" и нажать кнопку Finish, то запустится мастер установки драйвера фильтра на найденные USB-устройства. Это важный шаг, который я решил вынести в отдельный раздел 8a.

libusb-win32-devel-filter-007.PNG

Теперь должны нормально компилироваться примеры ПО хоста командной строки, предназначенные для GCC. Если компиляция идет с ошибками, то возможно, что у Вас в папке C:\Program Files\LibUSB-Win32\ не хватает папок include и lib. Можете скачать установленный каталог LibUSB-Win32 полностью по ссылке [9].

8a. Установка драйвера фильтра. Как я уже упоминал, программы ПО хоста, написанные с использованием библиотеки libusb, на платформе Windows общаются с устройствами USB через так называемый драйвер фильтра. Если драйвер фильтра USB-устройства не установлен, то при попытке обращения к USB-устройству Вы можете получить сообщения типа "Could not find USB device "hardctrl-HID" with vid=0x16c0 pid=0x5df" (в этом примере отображены параметры "hardctrl-HID", vid=0x16c0, pid=0x5df, задаваемые в файле usbconfig.h, макросы USB_CFG_DEVICE_NAME, USB_CFG_VENDOR_ID, USB_CFG_DEVICE_ID соответсвенно). Проблема устраняется установкой драйвера фильтра на устройство. Визард установки драйвера фильтра запускается в процессе установки библиотеки libusb (процесс описан на предыдущем шаге), но можно также запустить визард драйвера фильтра (Filter Wizard) и отдельно из меню запуска программ:

libusb-win32-devel-filter-012.PNG

После запуска фильтра появится окно, где выбирается необходимое действие - установить драйвер фильтра на USB-устройство, удалить ранее установленный на USB-устройство драйвер фильтра, удалить все установленные драйвера фильтра со всех USB-устройств. В случае проблем с доступом к USB-устройству нам нужно установить драйвер фильтра, поэтому выбираем 1-й пункт, "Install a device filter":

libusb-win32-devel-filter-008.PNG

Далее появится окошко, в котором визард отобразит все найденные USB-устройства, на которые можно установить драйвер фильтра библиотеки libusb. Нужно по значениям VID и PID найти в списке наше проблемное USB-устройство, выбрать его и нажать кнопку Install.

libusb-win32-devel-filter-009.PNG

Далее произойдет быстрая процедура установки драйвера фильтра:

libusb-win32-devel-filter-010.PNG

По окончании установки драйвера фильтра получим соответствующее сообщение. Теперь проблем с обращением к USB-устройству через библиотеку libusb не будет.

libusb-win32-devel-filter-011.PNG

9. Попробуем откомпилировать c:\avrprj\avrusb-20080418\examples\hid-custom-rq\commandline (это ПО хоста, которое может управлять нашим устройством USB). Сначала отредактируем файл c:\asm\avrusb-20080513\examples\hid-custom-rq\commandline\Makefile. Эти 2 строки надо закоментировать (коментарий начинается с символа # в начале строки):

#USBFLAGS = `libusb-config --cflags`
#USBLIBS = `libusb-config --libs`
далее, нужно изменить пути до файлов библиотеки. Было так:
USBFLAGS = -I/usr/local/include
USBLIBS = -L/usr/local/lib -lusb
теперь должно быть так (не спрашивайте меня, почему. Это мне стоило нескольких часов "плясок с бубном"):
#USBFLAGS = -I/usr/local/include
USBFLAGS = -I"c:/Program Files/LibUSB-Win32/include"
#USBLIBS = -L/usr/local/lib -lusb
USBLIBS = -L"c:/Program Files/LibUSB-Win32/lib/gcc" -lusb
Все, теперь можно компилировать. Как обычно, запускаем cmd и переходим в нашу папку (cd c:\avrprj\avrusb-20080418\examples\hid-custom-rq\commandline). Вводим make, без параметров:
c:\avrprj\avrusb-20080418\examples\hid-custom-rq\commandline>make
gcc -I"c:/Program Files/LibUSB-Win32/include" -O -g -Wall -c opendevice.c
gcc -I"c:/Program Files/LibUSB-Win32/include" -O -g -Wall -c set-led.c
gcc -o set-led opendevice.o set-led.o -L"c:/Program Files/LibUSB-Win32/lib/gcc" -lusb

Процесс компиляции закончен, в текущей папке появятся объектные файлы (расширение *.o) и исполняемый файл set-led.exe - этот исполняемый файл и есть та программа, которая работает с разрабатываемым USB-устройством.

10. Теперь нужно собрать USB устройство по одной из схем в папке c:\avrprj\avrusb-20080418\circuits\. Можно купить готовую плату, см. http://microsin.ru/content/view/605/44/.

11. Теперь нужно прошить программу в микроконтроллер (прошивку c:\avrprj\avrusb-20080418\examples\hid-custom-rq\firmware\main.hex). Как это делать, рассказывать не буду, в Интернете полно информации по теме. Ищите по ключевым словам ISP, avrdude, PonyProg, ITAJICE mkII.

12. Подключите Ваше устройство к компьютеру. Если Вы его собрали и прошили правильно, то появится сообщение, что обнаружено новое устройство LEDCtlHID:
insert-LEDCtlHID1.jpg

а потом еще одно, USB Human Interface Device:
insert-LEDCtlHID2.jpg

Если посмотреть в Диспетчере Устройств, то в папке Human Interface Devices появится 2 новых устройства:
insert-LEDCtlHID3.jpg

Если посмотреть свойства USB Human Interface Device, то мы увидим имя LEDCtlHID, которое было задано в макросе USB_CFG_DEVICE_NAME (файл c:\avrprj\avrusb-20080513\examples\hid-custom-rq\firmware\usbconfig.h):
insert-LEDCtlHID4.jpg

Никакие драйвера нам не потребовались - наше устройство USB принадлежит к классу HID!

13. Теперь попробуем поуправлять устройством. Сначала запустим set-led.exe без параметров, выведется подсказка:
c:\avrprj\avrusb-20080418\examples\hid-custom-rq\commandline>set-led.exe
usage:
set-led.exe on ....... turn on LED
set-led.exe off ...... turn off LED
set-led.exe status ... ask current status of LED
Теперь мы можем командой "set-led.exe on" зажечь светодиод на макетной плате, а командой "set-led.exe off" его погасить. Наше устройство работает!

Все упоминавшееся в статье программное обеспечение можно скачать здесь - avr-usb-tools.rar на href="http://depositfiles.com/files/7y6setdxw.

На этом все! Остается только изучать пробовать примеры один за другим (примеры описаны на шаге 4), изучать их код, а еще лучше на основе примера сделать собственное USB-устройство и программу для него.

[Устранение проблем]

1. Устройство hid-data работает, а hid-custom-rq - нет. Утилита управления светодиодом set-led.exe выдает сообщение об ошибке "Could not find USB device "LEDCtlHID" with vid=0x16c0 pid=0x5df". При этом Диспетчер устройств показывает наличие подключенного устройства "USB HID-coвмecтимoe ycтpoйcтвo" LEDCtlHID (как и должно быть), а утилита TestLibUsb - это устройство не показывает. Причина - у Вас не установлена библиотека libusb, либо её установка была испорчена (например, так произошло у меня после заражения вирусом - Касперский все вылечил, но при этом кое-что поломал). Устранить просто - установите библиотеку libusb (повторите шаг 8).

2. ПО хоста не запускается с ошибкой "Пpилoжeнию нe yдaлocь зaпycтитьcя, пocкoлькy libusb0.dll нe был нaйдeн. Пoвтopнaя ycтaнoвкa пpилoжeния мoжeт иcпpaвить этy пpoблeмy". Причина - в папке %SystemRoot%\system32\ отсутствует файл libusb0.dll. Устранить просто - нужно скопировать этот файл с другого компьютера, где установлена библиотека libusb, либо переустановить библиотеку libusb.

3. Часто встречающаяся проблема у начинающих работать с библиотекой V-USB - использование прерываний. Желательно таких ситуаций избегать, оставлять одно прерывание INT0, которое работает для V-USB, и использовать код только основной программы. Если все же нужно организовать еще один другой обработчик прерывания, то это надо делать максимально осторожно. В этом случае наилучшим выходом будет написание обрабочика на ассемблере.

4. Новички часто пытаются неумело подсунуть примеры из пакета avr-usb-russian.rar в AVRStudio, и у них ничего не получается - проект не компилируется, вылезают ошибки. На самом деле все примеры avr-usb-russian.rar предназначены для компилирования из командной строки командами make.

5. Забывают также перед сборкой проекта (make, make hex) делать очистку - make clean. Команда make clean удаляет все объектные файлы, что гарантирует корректную компиляцию во всех случаях - и при изменении настроек makefile, и при изменении исходников.

6. В файле makefile лежат важные настройки проекта firmware - тип микроконтроллера (DEVICE), его тактовая частота (F_CPU). Иногда частота кварца на микроконтроллере не соответствует переменной F_CPU, и USB-устройство из-за этого не работает. Необходимо также помнить, что допустима частота кварца из ряда 12, 15, 16, 16.5, 20 МГц, другие кварцы работать не будут.

7. Важны также настройки в файле usbconfig.h - в нем определены все параметры USB-устройства, например указаны используемые ножки для сигналов D+ и D-. Назначение каждой опции подробно задокументировано. Файл usbconfig.h является общим для firmware (папка firmware) и ПО хоста (папка commandline).

8. Решение многих проблем описано в статье AVR-USB-MEGA16, V-USB, FAQ: переписка по вопросам программирования.

[Ссылки]

1. Макетные платы с интерфейсом USB
2. Простой пример управления портами P1..P22 макетки AVR-USB-MEGA16
3. Автомат управления освещением ledlight на макетке AVR-USB-MEGA16 (параметры автомата, хранящиеся в EEPROM, настраиваются консольной программой через интерфейс USB)
4. Как использовать библиотеку libusb в Visual Studio на языке C (пример управления светодиодом макетки AVR-USB-MEGA16)
5. Как использовать библиотеку libusb в Visual Studio на языке C# (пример использования AVR-USB-MEGA16 для получения входных данных)
6. AVR USB (библиотека V-USB): переписка по вопросам программирования.
7. Пакет MinGW.
8. V-USB и libusb: обмен с устройством USB HID с помощью управляющих сообщений (USB control messages).
9. Установленная библиотека LibUSB-Win32.
10. AVR-USB-MEGA16, V-USB, FAQ: переписка по вопросам программирования.
11. V-USB + libusb + Python = быстрый старт (как начать программировать для USB с использованием Python на Linux и Windows).
12. AVR-USB-MEGA16: управление устройством USB из GCC, Visual Studio CPP, VB6, Python, Delphi.
13. Ссылки на закачку релизов библиотеки libusb.
14. Notepad2.

Последнее обновление ( 01.08.2012 )