Электроника для начинающих / [Из песочницы] Знакомство с TCP стеком для микроконтроллеров фирмы Microchip

Предположим, у нас возникла необходимость в создании устройства с возможностью подключения к сети Ethernet. Вариантов имеется довольно много, но все их можно разделить на 3 вида.
•Преобразователь RS-232—Ethernet, представляющий собой обычно виртуальный COM-порт на стороне сервера, преобразующий поток данных RS-232 в IP-пакеты, и отсылающий их на некое устройство, которое занимается обратным раскодированием и отдает контроллеру снова RS-232. Пример подобного устройства: Tibbo EM100. Достоинства такого решения—простота программирования. Не нужно вникать в тонкости протоколов. Подключаемое устройство может вообще быть не в курсе, что данные ему приходят не напрямую с последовательного порта, а из Интернета. Недостатки у такого решения тоже имеются—не получится использовать протоколы более высоких уровней, такие, как SNMP, HTTP и прочие, т.е. о WEB-интерфейсе можно забыть.
•Некое продвинутое устройство, «чёрный ящик», который обладает своим процессором, памятью, стеком протоколов, сам занимается обработкой Ethernet-пакетов, и наружу отдаёт опять же RS-232 или SPI. Примеры таких решений: Lantronix XPort, представляющий собой законченный ультракомпактный встраиваемый сервер размером чуть больше разъёма RG-45:
микросхема WIZNET W5100, и основанный на ней Arduino Ethernet Shield:
Тут у разработчика уже больше свободы, например, можно поднять на этом контроллере WEB-сервер или Telnet, и через них управлять встраиваемым устройством. Из недостатков можно отметить невысокую гибкость (можно использовать только те протоколы, которые заложили разработчики) и высокую стоимость, зачастую превышающую стоимость управляемого устройства.
•Взять контроль в свои руки, подключив к контроллеру драйвер физического уровня (PHY), такой как микросхема ENC28J60 стандарта 10 Base-T, микросхема ENC624J600 стандарта 10/100 Base-T от всё той-же фирмы Microchip, или взять контроллер семейства PIC18FXXJXX со встроенным PHY, и программно реализовать все необходимые протоколы. Стек протоколов можно написать самому (не слишком тривиальная задача), или воспользоваться уже готовым стеком (существует довольно большой выбор TCP стеков для микроконтроллеров различных производителей разной степени бесплатности и качества). В этой статье вашему вниманию будет предложен краткий обзор TCP стека фирмы Microchip, предназначеный для применения на микроконтроллерах этой фирмы.
Итак, путь ясен, время определиться с инструментами.
Нам понадобятся:

•Один из поддерживаемых этих стеком контроллеров. Если будем использовать внешнюю микросхему PHY, то практически любой МК производства Microchip, семейств PIC18 (8бит), PIC24 (16бит), и PIC32 (32бит). Если хотим обойтись без внешнего PHY, берём что-нибудь из семейства PIC18F67J60.
•TCP/IP стек Microchip. Cтек входит в состав Microchip Application Libraries (далее MAL). Библиотека бесплатная, поддерживает довольно широкий ряд контроллеров Microchip, и помимо TCP стека содержит так-же стек USB, библиотеку для работы с тач-скринами, смарт-картами и т.п. Последнюю версию библиотеки можно взять тут.
•Среда разработки. Бесплатные MPLab 8 (слегка устаревшая, но проверенная годами), или MPLab-X (вышедшая с Beta-стадии пару месяцев назад, основанная на Netbeans, перспективная, но пока не слишком стабильная среда разработки).
•Компилятор. Официально поддерживаются C18, C30, и C32. Ознакомительную 60-и дневную версию можно скачать с сайта. Через 60 дней ознакомительная версия остаётся функциональной, но выключает режим оптимизации, в связи с чем код может потребовать больше места в ROM.
•Программатор и (или) внутрисхемный отладчик. Рекомендую ICD3 или PICKIT3 (ICD2 тоже работает, но не поддерживается средой Mplab-X, и более медленная).
Вместо пайки своей платы, можно воспользоваться одним из многочисленных отладочных комплектов, как производства фирмы Microchip (которые всем хороши, кроме своей цены и трудностью покупки в России):

PICDEM.net2

PIC18 Explorer с дочерней платой PICTail

Explorer 16 c дочерней платой PICTail+

PIC32 Starter Kit с платой расширения IO Expansion Board и PICTail+ (в этом случае не понадобится внешний отладчик, т.к. в PIC32 Starter Kit он уже встроен)

PIC32 Ethernet Starter Kit

Существуют и альтернативные решения от фирм Olimex (ENC28J60-H):
и «Тритон» (TRT-Ethernet):
Если мы решили сразу делать свою плату:

Можно задействовать как контроллер со встроенным PHY (PIC18F87J60)
либо контроллер с внешним PHY (ENC28J60), подключенным по шине SPI (в данном примере ENC28J60):
(блок Level shift logic для согласования уровней нужен только в случае, если используется МК с 5-и вольтовым питанием, т.к. на выходах ENC28J60 уровни 3.3В).
Кроме того, нужно подключить питание (в т.ч. аналоговых модулей, даже если они не будут использоваться) и линию сброса.
Из внешней обвязки понадобится только трансформатор (например, PULSE H1012), разъём RJ-45 (существуют разъёмы RJ-45 сразу со встроенным трансформатором и светодиодами), да десяток резисторов. Для тактирования контроллера обязателен кварц на 25 МГц (при этом внутренняя частота МК может быть поднята до 40МГц при помощи PLL).
Обратите внимание, что во внешнем PHY контроллере ENC624J600 уже содержится прошитый MAC-адрес, тогда как в ENC28J60 и PIC18F87J60 его нет, и нужно либо использовать покупную микросхему, содержащую MAC, либо устанавливать его програмно.
Так же на этом этапе надо определиться, где будут храниться файлы для WEB-сервера и SNMP mib-ы. Вариантов несколько: или непосредственно в памяти программ контроллера (а при среднем размере стека с набором необходимых модулей ~33кб и контроллером с внутренней ROM 128кб мы получим ~95кб места для файлов), или использовать внешнюю микросхему EEPROM (стек поддерживает 25LC1024), FLASH (серия SST25), SD-карту или даже USB-диск (понадобится PIC32 с USB на борту).
Итак, с «железом» определились, посмотрим теперь, что же может предложить нам эта библиотека?
Поддерживаемый функционал:

•Протоколы: ARP, IP, ICMP, UDP, TCP, DHCP, SNMP, SMTP, HTTP, FTP, TFTP
•Поддержка TCP и UDP
•Поддержка SSL
•Поддержка NetBIOS
•Поддержка DNS
Стек поддерживаемых протоколов:

При всём при этом, стек занимает не так много памяти. Так, реальный проект, содержащий WEB-сервер, DHCP и DNS-клиент, мост Ethernet─Serial, сервер TFTP и SNMP, клиент SMTP, потребует порядка 33 килобайта памяти программ (ROM) и 2 килобайта памяти данных (RAM), при том, что типичный размер памяти PIC18F67J60 составляет 128кб.
Производительность стека:

Как видно, скорости не поражают воображение, однако не стоит забывать, что хостить на подобном устройстве «Facebook» вряд-ли кому-либо придёт в голову. А страница размером 30кБ с AJAX и парой небольших картинок загрузится менее чем за секунду (по локальной сети).
Дистрибутив MAL содержит ряд примеров, наиболее интересные из которых:
•TCPIP Internet Bootloader App — пример, реализующий обновление прошивки контроллера по протоколу TFTP.
•TCPIP Internet Radio App -играет mp3 поток с указанного сайта (используется внешняя микросхема-декодер mp3).
•TCPIP WebVend App – эмулятор торгового автомата с Web-интерфейсом (демонстрируется работа запросов GETPOST, Ajax)
Собираем проект

Всё это интересно, но пора бы уже собрать собственное приложение. Пусть это будет пример «Demo App» (из каталога Microchip Solutions v2011-12-05TCPIPDemo App). Переходим в эту папку, и видим кучу «сишных» файлов, вперемешку с файлами проектов от MPLAB (*.mcp, *.mcw). Ищем файл проекта, подходящий для нашей отладочной платы. Скажем, если у плата у нас называется «Ethernet Starter Kit», открываем проект C32-PIC32_ETH_SK_ETH795. Если плата пользовательская, можно создать проект с нуля, или открыть наиболее похожий проект и модифицировать под себя. Например, если плата будет с PIC18F67J60 со встроенным PHY, берём проект C18-PICDN2_ETH97, и дорабатываем напильником. Доработка заключается в следующем: Лезем в Project->Build options->Project->С18, и меняем C18-PICDN2_ETH97 на «YOUR_BOARD»:
Создаем файл HWP YOUR_BOARD.h на основе наиболее похожего. В этом файле прописаны номера портов для модулей, использующих какую-либо периферию. Скажем, модуль SPI_EEPROM.c берёт оттуда имена портов SPI для обмена данными с внешним EEPROM:#define EEPROM_CS_TRIS (TRISCbits.TRISC0)
#define EEPROM_CS_IO (LATCbits.LATC0)
#define EEPROM_SCK_TRIS (TRISCbits.TRISC3)
#define EEPROM_SDI_TRIS (TRISCbits.TRISC4)
#define EEPROM_SDO_TRIS (TRISCbits.TRISC5)
Если в нашей пользовательской плане порты отличаются, устраняем несоответствие.
Такая избыточная сложность демонстрационных проектов связана с желанием фирмы-производителя сделать так, чтоб пример можно было запустить на максимально-возможном числе разнообразного «железа». В дальнейшем, при написании своего проекта «с чистого листа» всё это можно будет вычистить и получить простую и понятную структуру.
Второй интересный файл, это TCPConfig.h, который, в зависимости от выбранного типа отладочной платы, вызывает файл с параметрами IP-протокола. Для пользовательской платы с PIC18F87J60 этот файл будет называться TCPIP ETH97.h
В нём включаются и отключаются различные модули стека./* Application Level Module Selection
* Uncomment or comment the following lines to enable or
* disabled the following high-level application modules.
*/
#define STACK_USE_UART // Application demo using UART for IP address display and stack configuration
#define STACK_USE_UART2TCP_BRIDGE // UART to TCP Bridge application example
//#define STACK_USE_IP_GLEANING
Выбирается тип внешней памяти для хранения файлов:
#define MPFS_USE_EEPROM
//#define MPFS_USE_SPI_FLASH
Устанавливается IP-адрес по умолчанию:
#define MY_DEFAULT_IP_ADDR_BYTE1
Настраивается размер буферов, и многое другое. Можно так-же не править этот файл вручную, а воспользоваться визардом, поставляющимся вместе со стеком:
Итак, будем считать, что порты и параметры TCP сконфигурированы, IP-адрес установлен, запускаем компиляцию. Если всё прошло успешно, получаем прошивку и шьём ее в МК, отладчиком или программатором. Запускаем, проверяем пинг на прописанный в файле TCPIP ETH97.h адрес. Если пинга нет, проверяем, горит ли светодиод Link, не получила ли плата другой ip-адрес по DHCP. Для проверки можно выключить режим автоматического получения ip-адреса, закомментировав строчки #define STACK_USE_DHCP_CLIENT и #define STACK_USE_IP_GLEANING. Получив наконец пинг, пробуем ввести адрес платы в браузере. Видим такое сообщение:
Естественно, ведь мы ещё не загрузили никаких файлов на наш WEB-сервер. Исправляем этот недочёт. Для этого нам понадобится утилита «Microchip MPFS generator».
Утилита преобразует указанную папку с файлами в файл-образ, пригодный для загрузки на встраиваемый сервер. В качестве Source Directory ей надо указать каталог с файлами для загрузки. Формат же зависит от того, где мы собираемся хранить эти файлы. Если в качестве места для хранения файлов мы указали внутреннюю ROM контроллера, указываем формат C18/C32 Image, и получаем на выходе файл MPFSImg2.c, внутри которого будет объявлен большой массив двоичных данных. Этот файл нужно добавить к проекту, и перекомпилировать его.
Если же для хранения файлов используется внешняя микросхема FLASH или EEPROM, выбираем формат BIN Image. Полученный на выходе файл MPFSImg2.bin загружаем либо через форму загрузки на сервере, либо включив соответствующую опцию в MPFS generator. Загружаем, обновляем страницу, и видим…
Web-страница, открытая со встраиваемого сервера
Пара слов о том, как это работает

Статический текст выводится непосредственно в файле HTML.
Чтобы отобразить на web-странице сервера динамическую переменную, достаточно заключить её тильдами, в виде ~variable~, а в коде файла CustomHTPPApp.c создать функцию, вида HTTPPrint_variable()
Переменные на Ajax создаются похожим образом, только динамическая переменная создается в отдельном XML файле, в виде:
~var1~, а в коде HTML-страницы вызывается функция их обновления: document.getElementById('var1').innerHTML = getXMLValue(xmlData, 'var1');
Стек не использует какую либо ОС, и работает по принципу кооперативной многозадачности (впрочем, при желании можно прикрутить и ОС, см. AN1264). Выглядит это так:
В main() крутится бесконечный цикл, из которого вызываются функции, обслуживающие стек (StackTask и StackApplications) и пользовательские функции (в данном примере это user_task(), но может быть что угодно).do
{
StackTask();
StackApplications();
user_task();
CLRWDT(); //сторожевой таймер
}while(1);
При этом нужно стараться, чтоб пользовательская функция не выполнялась слишком долго. К примеру, если в этой функции сработает «тупая» задержка вида while(delay); то функции стека не смогут обработать входящие Ethernet пакеты, и на время этой задержки связь с устройством пропадёт. Для организации различных таймаутов, необходимых для нормальной работы IP протокола, стек использует аппаратный таймер МК (timer0 или timer1), работающий по прерыванию (по переполнению таймера вызывается функция TickUpdate).
Помимо реализации WEB-интерфейса и отправки SNMP trap-ов, довольно удобно использовать Telnet для вывода отладочной информации вместо традиционного в таких случаях порта RS-232.
Заключение

Тема Ethernet весьма обширна, и в одной статье рассказать обо всём невозможно. Для заинтересовавшихся предлагаю ознакомиться с сайтом Microchip Ethernet Design Center,
а так-же с циклом статей Подключение микроконтроллера к локальной сети