В этой статье приведен перевод даташита Atmel AVR4023, посвященного внутреннему устройству протокола DFU FLIP.

[Особенности протокола FLIP]

• Делает возможным программирование микроконтроллеров, уже установленных в систему, через интерфейс USB.
• Возможности протокола:
   - Чтение информации о программируемом микроконтроллере.
   - Чтение/запись конфигурации микроконтроллера.
   - Чтение/запись внутренней памяти микроконтроллера (FLASH, EEPROM).
   - Чтение/запись внешней памяти микроконтроллера.
   - Управление защитой памяти.
   - Запуск приложения (программы firmware, записанной в память микроконтроллера).
• Atmel® USB DFU:
   - Совместимость со стандартом USB часть 9.
   - Нужна одна конечная точка управления USB (USB control endpoint).  

Для чего нужен и используется протокол FLIP? Все очень просто - это удобное средство программировать микроконтроллеры AVR с интерфейсом USB. Так что можно сделать свое устройство USB, не покупая при этом программатор. Достаточно иметь под рукой компьютер с установленным программным обеспечением FLIP и подключение через интерфейс USB. Кроме того, это удобный инструмент для обновления программного обеспечения (firmware) - чтобы обновить программу, можно даже не разбирать готовое устройство.

[1 Введение]

Для выполнения обновления firmware компания Atmel разработала гибкую систему программирования микроконтроллеров, уже встроенных в систему (FLexible In-system Programmer, FLIP). Это программное обеспечение позволяет программировать память микроконтроллера по командам от USB хоста (компьютера). При этом нет необходимости разбирать готовое изделие, извлекать оттуда микроконтроллер, и не нужно применять никакую дополнительную внешнюю аппаратуру для программирования (не нужен программатор).
   
Atmel предоставляет бутлоадеры USB для микроконтроллеров AVR^® (включая серии AVR XMEGA^® и UC3), которые имеют в составе чипа аппаратный интерфейс USB. Эти бутлоадеры используют проприетарный протокол USB DFU, который описывается в этом апноуте. Бутлоадер FLIP поставляется конечному потребителю уже загруженным в память чипа на заводе Atmel. При этом тратится некоторая часть памяти программ (около 2 килобайт в старших адресах FLASH). Бутлоадеры Atmel поставляются в двоичном виде, без исходного кода. Однако благодаря тому, что спецификация протокола FLIP открыта, существуют открытые альтернативные версии бутлоадеров FLIP (с открытым исходным кодом), например в библиотеке LUFA [1].

Для активации бутлоадера в устройстве применяется специальная процедура, описанная в документации на бутлоадер. Обычно это замыкание определенной ножки микроконтроллера на землю при включении питания (например, для микроконтроллера AT90USB162 это ножка 13, порт PD7) или сбросе.

По традиции DFU называют протоколом FLIP (что создает некоторую путаницу), однако к DFU относятся все функции программирования от хоста, включая FLIP, BatchISP или все дальнейшие интеграции протоколов в AVR Studio.
   
[2 Термины и аббревиатуры]

DFU Device Firmware Upgrade - обновление программного обеспечения устройства на микроконтроллере.
FLIP FLexible In-system Programmer - гибкое программирование микроконтроллера "прямо в системе", т. е. в готовом изделии.
Firmware выполняемое программное обеспечение микроконтроллера, которое сохранено в перезаписываемой, энергонезависимой памяти микроконтроллера (в нашем случае это AVR, работающий как устройство USB).
FS USB Full Speed - полная скорость по стандарту USB (около 12 мегабит/сек).
Upgrade перезапись кода firmware в микроконтроллере (в нашем случае это AVR, работающий как устройство USB). Новое firmware может быть предназначено для замены старого, которое имеется в устройстве.
Download выгрузка, передача информации от хоста к устройству.
Upload выгрузка, передача информации от устройства к хосту.
IN передача пакета USB от устройства к хосту.
OUT передача пакета USB от хоста к устройству.
ZLP USB Zero Length Packet - пакет нулевой длины, специальный пакет, используемый для квитирования в протоколе USB.
ISP программирование микроконтроллера "прямо в системе", т. е. в готовом изделии.

[3 Область применения FLIP]

Этот документ относится к микроконтроллерам AVR, имеющим в составе чипа аппаратный интерфейс USB, а также к микроконтроллерам AVR XMEGA и серии AVR UC3.

• Atmel megaAVR Series2, Series3, Series4.
 Это микроконтроллеры AT90USB82, AT90USB162, AT90USB646, AT90USB647, AT90USB1286,  AT90USB1287, ATmega8U2, ATmega16U2, ATmega32U2, ATmega16U4, ATmega32U4.
• Atmel AVR XMEGA. 
  Это микроконтроллеры ATxmega64A1U, ATxmega128A1U, ATxmega64A3U, ATxmega128A3U, ATxmega192A3U, ATxmega256A3U, ATxmega256A3BU, ATxmega16A4U, ATxmega32A4U, ATxmega64A4U, ATxmega128A4U, ATxmega64B1, ATxmega128B1, ATxmega64B3, ATxmega128B3, ATxmega64C3, ATxmega128C3, ATxmega192C3, ATxmega256C3, ATxmega384C3, ATxmega16C4, ATxmega32C4.
• Atmel AVR UC3 Device series.
  Это микроконтроллеры ATUC64L3U, ATUC128L3U, ATUC256L3U, ATUC64L4U, ATUC128L4U, ATUC256L4U. 
• Atmel 8051 USB.
  Это микроконтроллеры AT83C5134, AT83C5135, AT83C5136, AT89C5130A-M, AT89C5131A-L, AT89C5131A-M, AT89C5132. 

С помощью протокола FLIP могут программироваться и некоторые другие микроконтроллеры, через другие интерфейсы, не USB - через CAN и USART. Процедура программирования подробна описана в даташите на соответствующий бутлоадер, применяемый для конкретного микроконтроллера.

[4 Литература и связанные ресурсы]

• Atmel FLIP.
• Atmel AVR Software Framework.
• AVR32784: AVR UC3 USB DFU Bootloader.
• Atmel AVR1916: USB DFU Boot Loader for XMEGA.

[5 Общий обзор окружения протокола FLIP]

Специальное ПО хоста (это могут быть FLIP, BatchISP, или будущие расширения Atmel AVR Studio) получает команды пользователя для выполнения операций с памятью, и переводит эти команды в соответствующие запросы протокола USB, основанного на DFU. На запросы отвечает бутлоадер USB, записанный в память FLASH микроконтроллера. Бутлоадер обрабатывает протокол USB и выполняет нужные операции чтения/записи с памятью микроконтроллера (FLASH, EEPROM, а также иногда это может быть и внешняя память).

Рис. 5-1. Системное рабочее окружение, в котором работает FLIP DFU.

Для программирования микроконтроллеров имеется специальная бесплатная утилита Atmel Flip, написанная на JAVA.

В этой статье подробно рассматривается именно протокол USB FLIP. Статья разделена на 2 секции:

• Atmel USB DFU Class (секция 6).
• Atmel FLIP Protocol (секция 7).

[6 Atmel USB DFU Class]

6.1 Что такое Atmel USB DFU Class

Device Firmware Upgrade (DFU) является классом USB, который позволяет обновлять firmware, встроенное в микроконтроллер устройства USB. Atmel USB DFU является реализацией класса вендора (vendor class implementation), основанное на части официального стандарта USB DFU, однако она не полностью реализует стандартный USB DFU class.

Для обмена данными с хостом USB DFU FLIP использует только одну конечную точку управления (control endpoint, конечная точка с номером 0), и только запрос настройки (setup request). Далее будут показаны использующиеся дескрипторы USB и управляющие запросы USB (control requests).

6.2 Набор используемых дескрипторов USB

Устройство USB DFU FLIP предоставляет хосту набор дескрипторов, которые содержат:

• Дескриптор устройства (device descriptor).
• Один дескриптор конфигурации (configuration descriptor).
• Один дескриптор интерфейса (interface descriptor).

Таблица 6-1. USB Device Descriptor.

USB configuration descriptor идентичен стандартному дескриптору конфигурации, описанному в спецификации USB версии 1.0 с тем исключением, что поле bNumInterfaces должно содержать значение 01h.

Таблица 6-2. USB Interface Descriptor.

6.3 Специальные запросы настройки (specific setup requests)

В дополнение к стандартным запросам USB, для поддержки операций обновления обрабатываются 4 специальных запроса, относящиеся к классу (class-specific requests):

Таблица 6-3. Class-specific requests.

6.3.1 Device status (состояние устройства USB)

Информация о статусе используется для упрощения синхронизации между ПО хоста и устройством USB. Статус предоставляет информацию о выполнении предыдущего запроса. Устройство USB DFU FLIP отвечает на запрос DFU_GETSTATUS с полезной нагрузкой пакета, описанной в таблице 6-4.

Таблица 6-4. Пакет статуса устройства.

Возможные значения полей пакета bStatus и bState описаны в таблице 6-5.

Таблица 6-5. Значения статуса и состояния.

Каждый раз, когда устройство USB детектирует ошибку и сообщает о ней хосту (в статусе индикации ошибки в ответ на запрос DFU_GETSTATUS), устройство входит в состояние dfuERROR. После сообщения о любой ошибке устройство не может покинуть состояние dfuERROR, пока не получит запрос DFU_CLRSTATUS. После получения запроса DFU_CLRSTATUS устройство устанавливает статус в значение IDLE mode (режим ожидания).

6.3.2 Command request (командный запрос)

Запросы setup request DFU_DNLOAD и DFU_UPLOAD используют 4 типа команд:

• Одиночная команда FLIP.
• Пустая команда (используется только для того, чтобы проверить команду запуска приложения пользователя, firmware).
• Команда FLIP для загрузки полезных данных (data payload to download).
• Команда FLIP для выгрузки полезных данных (data payload to upload).

Рис. 6-1. Одиночная команда FLIP.

Рис. 6-2. Empty command (пустая команда).

Рис. 6-3. Команда FLIP для загрузки данных FLIP (download).

Рис. 6-4. Команда FLIP для выгрузки данных FLIP (upload).

[7 Протокол FLIP]

Протокол Atmel FLIP очень простой, и может использовать другие физические линки для связи, не только USB.

7.1 Общий обзор протокола FLIP

В команде имеется код группы, идентификатор команды, и также 4 байта, используемые для добавления аргумента в команду, см. таблицу 7-1.

Таблица 7-1. Структура команды FLIP.

Имеются 4 группы (таблица 7-2), описанные в последующих секциях. Для каждой команды описана структура команды FLIP, после отправки команды возможно наличие дополнительных данных для загрузки (download), или выгрузки (upload), или статуса.

Таблица 7-2. Группы команды FLIP.

7.2 Группа выбора

Перед любой операцией чтения или программирования памяти, необходимо выбрать целевую память, а также смещение страницы внутри этой памяти. Это достигается отправкой команд SELECT_MEMORY_UNIT и SELECT_MEMORY_PAGE.

7.2.1 Selecting memory unit (выбор типа памяти).

Таблица 7-3. Select memory unit command.

Таблица 7-4. Memory unit available (доступные типы памяти).

Таблица 7-5. Select memory unit status (выбор статуса юнита памяти).

7.2.2 Selecting memory page (выбор страницы памяти)

Таблица 7-6. Команда выбора страницы памяти.

Таблица 7-7. Select memory page status (выбор статуса страницы памяти).

7.3 Download group (группа загрузки)

Группа команд загрузки включает в себя одну команду, которая используется для программирования выбранной памяти.

7.3.1 Program start (запуск программирования)

BatchISP и FLIP имеют внутренние буферы ISP (один буфер на память устройства). Запись в память всегда осуществляется из содержимого буфера. Содержимое буфера обычно не имеет значения для пользователя протокола FLIP. Команда Program Start передает буфер ISP из FLIP в выбранную память.

Таблица 7-8. Команда Program Start.

Примечание: (1) Data Payload Prefix (префикс данных полезной нагрузки, т. е. передаваемых данных для программирования).

Чтобы соответствовать записываемой единице памяти (размеру страницы), могут быть добавлены X ничего не значащих байт перед первым байтом для программирования. Число X вычисляется для выравнивания начала firmware с записываемой памятью.

Внимание: в настоящий момент приложение FLIP делит внутренний буфер так, чтобы размер полезной нагрузки (включая префикс) не превышал 2 килобайта.

Таблица 7-9. Статус Program Start.

Внимание: если произойдет ошибка статуса, то передача полезных данных для загрузки должна быть остановлена (stall) на уровне протокола USB.

7.4 Upload group (группа выгрузки)

Эта группа команд позволяет прочитать содержимое выбранной памяти, а также проверить её на чистоту (blank state).

7.4.1 Read memory (чтение памяти)

BatchISP и FLIP имеют внутренние буферы ISP (один буфер на память устройства). Чтение памяти обновляет содержимое буфера данными, прочитанными из памяти. Во время операции проверки (verify) целевая память читается и её содержимое сравнивается с содержимым буфера.

Таблица 7-10. Команда чтения памяти.

Внимание: в настоящий момент приложение FLIP делит команду Read Memory так, чтобы размер полезной нагрузки не превышал 1 килобайт.

Таблица 7-11. Статус команды Read Memory.

Внимание: если произойдут ошибки STATUS_MEM_UNKNOW или STATUS_OUTOFRANGE, то должен быть остановлен (stall) ZLP запроса DOWNLOAD. Если произойдет ошибка STATUS_MEM_PROTECTED, то следующий запрос UPLOAD должен быть остановлен (stall) на уровне протокола USB.

7.4.2 Blank check memory (проверка, что память очищена)

Во время проверки памяти на чистоту её содержимое сравнивается с FFh.

Таблица 7-12. Команда Blank check memory.

Таблица 7-13. Статус команды Blank check.

Внимание: если произойдут ошибки STATUS_MEM_UNKNOW или STATUS_OUTOFRANGE, то должен быть остановлен (stall) ZLP запроса DOWNLOAD.

7.5 Excec group (группа выполнения)

Эта группа команд позволяет полностью очистить память firmware микроконтроллера (FLASH), либо запустить на выполнение код приложения пользователя - firmware.

7.5.1 Chip erase (очистка памяти микроконтроллера)

Команда Chip erase полностью очищает всю память FLASH (за исключением секции бутлоадера FLIP).

Таблица 7-14. Команда Chip erase.

Таблица 7-15. Статус команды Chip erase.

7.5.2 Запуск приложения пользователя (firmware)

Команда Start Application сбрасывает устройство, и приложение пользователя запускается на выполнение.

Таблица 7-16. Команда Start Application.

Таблица 7-17. Статус команды Start Application.

Внимание: для завершения команды Start Application должна быть отправлена пустая команда (empty FLIP command), см. рисунок 6-2.

[Ссылки]

1. LUFA - бесплатная библиотека USB для микроконтроллеров Atmel AVR.