Как и защо да четем даташити, ако микроконтролерите са вашето хоби

Микроелектрониката е модно увлечение в последните години, благодарение на магическия Arduino. Но ето го и проблемът: при достатъчен интерес, бързо преминаваме покрай DigitalWrite(), а какво да правим след това не е съвсем ясно. Разработчиците на Arduino положиха много усилия, за да намалят прага на влизане в своята екосистема, но извън нея все още се тълпят тъмнината на суровата схемотехника, недостъпна за любителя.

Например, даташити. Изглежда, че в тях има всичко, взимай и използвай. Но авторите им определено не поставят пред себе си задачата да популяризират микроконтролерите; понякога изглежда, че умишлено злоупотребяват с неразбираеми термини и абревиатури при описание на простите неща, за да объркат максимално непосветените. Но не всичко е толкова лошо, при желание тайницата се отваря.

В тази статия ще споделя опит от общуването на хуманитарист с даташитите в хоби цели. Текстът е предназначен за любители, които са израснали от штанишките на Arduino, и предполага известно представление за принципите на работа на микроконтролерите.

Ще започна с традиционното

Мигаем светодиод на Arduino

И веднага код:

void setup() {
DDRB |= (1<<5);
}

void loop() {
PINB = (1<<5);
for (volatile uint32_t k=0; k<100000; k++);
}

„Какво е това? – ще попита опитният читател. – Защо пишеш нещо в входния регистър PINB? Той е само за четене!“ В действителност, документацията на Arduino, както и повечето учебни статии в интернет, твърди, че този регистър е само за четене. И аз самият мислех така, докато не прегледах даташит Atmega328p, подготвяйки тази статия. А там:

Това е сравнително нова функционалност, която не е била налична при Atmega8, за нея не всички знаят или не споменават поради съображения за обратно съвместимост. Но е напълно подходяща за демонстриране на мисълта, че даташитите трябва да се четат, за да се използват всички възможности на чипа, включително и малко известните. И това не е единствената причина.

Защо още да четем даташити

Обикновено ардуините, след като се поиграят с диодите и AnalogWrite-овете, започват да свързват към платката всякакви модули и чипове, за които вече са написани библиотеки. Рано или късно се появява библиотека, която не работи както трябва. Тогава любителят започва да я кове, за да я поправи, а там...

А там се случва нещо категорично неразбираемо, затова се налага да се отправим към Гугъл, да четем многобройни тюториали, да извличаме на части нечий подходящ код и накрая да постигнем целта си. Това дава силно усещане за постижение, но на практика процесът напомня на изобретяването на велосипеда чрез реверс-инженеринг на мотоциклета. Въпреки това, разбирането как работи този велосипед не се увеличава. Знам, защото сам се занимавах с това доста дълго.

Ако вместо това занимание бях прекарал няколко дни в изучаване на документацията на Atmega328, бих спестил огромно количество време. В крайна сметка, това е доста прост микроконтролер.

Така че, важно е да четем даташитите, поне за да имаме представа какво е изобщо микроконтролерът и какво може да прави. И още:

• за да проверяваме и оптимизираме чуждите библиотеки. Често ги пишат също така любители, които изобретяват велосипеда; или обратно, авторите умишлено правят излишна защита от некомпетентност. Нека да е три пъти повече и по-бавно, но поне да сработи;

• за да имаме възможност да използваме в проекта чипове, за които никой не е написал библиотека;

• за да си улесним задачата при миграция от една линия MC на друга;

• за да оптимизираме стария си код, който не можеше да влезе в Ардуино;

• за да се научим да управляваме всеки чип директно чрез неговите регистри, без да се затрудняваме с изучаване на работата на библиотеките му, ако изобщо има такива.

Защо да пишем директно в регистрите, когато имаме HAL и LL?

Глосар
HAL, High Abstraction Layer – библиотека за управление на микроконтролер с високастепени абстракция. Ако е необходимо да се използва интерфейс SPI1, просто го настройваме и активираме, без да се замисляме кои регистри за какво отговарят.
LL, Low Level API – библиотека, съдържаща макроси или структури с адреси на регистри, позволяваща да се достъпва до тях по име. DDRx, PORTx, PINx на Атмега – това е LL.

Споровете относно 'HAL, LL или регистри' регулярно се случват в коментарите на Хабра. Без да претендирам за достъп до астрално знание, просто ще споделя собствения си опит и размисли.

След като горе-долу разбрах Атмегата и прочетох статии за чудесата на STM32, закупих полдюжина различни платки – от Discovery до „Сините Таблетки“ и дори само чипове за моите проекти. Те стояха две години в кутия. Понякога си казвах: „Ето, от тези уикенди ще се науча на STM“, стартирах CubeMX, генерирах настройка за SPI, гледах на получената стена с текст, щедро украсена с авторски права на STM, и решавах, че това е нещо твърде сложно.

Разбира се, че може да се разбере какво е написал CubeMX. Но едновременно е ясно, че запомнянето на всички формулировки, за да мога после да ги пиша на ръка, е нереално. А пък ако случайно забравя в Куба да сложа някаква отметка, от друга страна, е направо проблем.

Две години минаха, аз все още се запасявам с ST MCU Finder за всякакви вкусни, но недостъпни за мен чипове и случайно се натъкнах на страхотна статия, макар и за STM8. И изведнъж осъзнах, че през цялото време съм чукал на отворена врата: регистрите на STM са устроени по същия начин, както при всяко друго МК, и за работа с тях Кубът не е задължителен. Какво, наистина можеше ли?...

HAL и конкретно STM32CubeMX са инструмент за професионални инженери, които работят плътно с чиповете STM32. Основното предимство е високото ниво на абстракция, възможност за бързо преминаване от един микроконтролер на друг и дори от едно ядро на друго, докато остават в рамките на семейството STM32. Любителите рядко се сблъскват с такива задачи – нашият избор на микроконтролери обикновено е ограничен до асортимента на AliExpress, и ние по-често мигрираме между напълно различни чипове – преминаваме от Атмега на STM, от STM на ESP или каквото там ново ни подхвърлят китайските приятели. HAL тук няма да помогне, а изучаването му отнема доста време.

Остава LL – но до регистрите има само една крачка. Лично аз намирам написването на своите макроси с адресите на регистрите за полезно: по-внимателно изучавам датащита, обмислям какво ще ми бъде нужно в бъдеще, а какво със сигурност не, най-добре структурирах програмите си, а и преодоляването на трудностите помага за запомняне.

Освен това, има нюанс с популярния STM32F103 – за него съществуват две несъвместими версии на LL, едната официална от STM, а другата – от Leaf Labs, използвана в проекта STM32duino. Ако пиша open-source библиотека (а точно такава беше задачата ми), трябва или да направя две версии, или да се обращам директно към регистрите.

Накрая, отказът от LL, на мое мнение, опрости миграцията, особено ако се заложи на него още от началото на работата по проекта. Преувеличен пример: ще напишем ардуино-блинк в Atmel Studio без LL:

#include <stdint.h>

#define _REG(addr) (*(volatile uint8_t*)(addr))

#define DDR_B 0x24
#define OUT_B 0x25

int main(void)
{
    volatile uint32_t k;

    _REG(DDR_B) |= (1<<5);

    while(1)
    {
        _REG(OUT_B) |= (1<<5);
        for (k=0; k<50000; k++);
        _REG(OUT_B) &= ~(1<<5);
        for (k=0; k<50000; k++);
    } 
}

За да започне този код да мига с LED на китайската платка с STM8 (от ST Visual Desktop), е достатъчно да сменя два адреса:

#define DDR_B 0x5007
#define OUT_B 0x5005

Да, използвам особеността на свързването на LED на конкретната платка, ще мига много бавно, но все пак ще има!

Какви са видове даташити

В статиите и форумите, както на руски, така и на английски, под „даташити“ се има предвид всяка техническа документация за чиповете, така постъпвам и аз в този текст. Формално те са само един от видовете такава документация:

Datasheet – ТТХ, тактико-технически характеристики. Навсякъде присъства при всеки електронен компонент. Справочна информация, полезно е да я имате под ръка, но не е нужно да я четете внимателно. Въпреки това, по-простите чипове често са ограничени до даташита, за да не се множат излишни документи; в този случай Reference Manual се включва тук.

Reference Manual – всъщност инструкция, голяма книга с 1000+ страници. Подробно описва работата на всичко, което е вградени в чипа. Главният документ за усвояване на микроконтролера. За разлика от datasheet, инструкциите се пишат за широка гама от МК, съдържат много информация за периферия, която не присъства в конкретния модел на чипа.

Programming Manual или Instruction Set Manual – инструкция за уникалните команди на микроконтролера. Предназначена за тези, които програмират на Ассемблер. Авторите на компилаторите активно я използват за оптимизиране на кода, така че в общия случай не ни е необходима. Но е полезно да надникнете тук за общо разбиране, при специфични команди, като изход от прекъсване, а също и при активно използване на дебъгера.

Application Note – полезни съвети за решаване на конкретни задачи, често с примери за код.

Errata Sheet – описание на случаи на нестандартно поведение на чипа с варианти за обход, ако има.

Какво има в даташитите

Непосредствено в Datasheet можем да се нуждаем от следните раздели:

Device Summary – първата страница на даташита накратко разказва за устройството. Много полезна в ситуации, когато сте срещнали чип (видели сте го в магазина, извадили сте го, срещнали сте споменаване) и искате да разберете какво представлява.

General Description – по-подробно описание на възможностите на чиповете от серията.

Pinouts – схеми на свързване за всички възможни корпуси на чипа (на кой крак кой пин).

Pin Description – описание на предназначението и възможностите на всеки пин.

Memory Map – картата на адресите в паметта едва ли ще ни е необходима, но понякога включва и таблица на адресите на регистровите блокове.

Register Map – таблицата на адресите на регистровите блокове обикновено се намира именно в даташита, а в Ref Manual – само адресни отклонения (address offsets).

Electrical Characteristics – в тази секция най-вече ни интересуват absolute maximum ratings, описващи максималните натоварвания на чипа. За разлика от неунищожимата Atmega328p, повечето МК не позволяват да се свързват сериозни натоварвания към пиновете, което е неприятна изненада за ардуинерите.

Package Information – чертежи на наличните корпуси, полезни при проектиране на собствени платки.

Reference Manual структурно се състои от раздели, посветени на конкретни периферни устройства, посочени в техните заглавия. Всяка глава може условно да бъде разделена на три части:

Общ преглед, Въведение, Features – преглед на възможностите на периферията;

Functional Description, Usage Guide или просто основният блок в раздела – подробно текстово описание на принципите на работа на периферията и начините за нейното използване;

Registers – описание на управляващите регистри. В прости случаи като GPIO или SPI това може да е напълно достатъчно, за да започнете да използвате периферията, но често все пак е нужно да се прочетат и предишните части.

Как да четем даташити

Даташитите с непривичност отблъскват с обема си и изобилието от непознати термини. Всъщност, всичко не е толкова страшно, ако знаете няколко трика.

Инсталирайте добра PDF читалка. Даташитите се пишат в славните традиции на печатните инструкции, добре е да се отпечатат, да се отбележат с пластмасови разделители и да се съединят. Хипертекстът в тях се наблюдава в минимални количества. За щастие, поне структурата на документа е оформена с разделители, така че качествена читалка с удобна навигация е много необходима.

Даташитът – не е учебник на Страуструп, в него не трябва да се чете всичко подред. Ако сте се възползвали от предишния съвет – просто намерете нужния раздел в панела с разделителите.

Даташитите, особено Reference Manuals, могат да описват възможностите не на конкретен чип, а на целия набор. Това означава, че половината, а понякога и две трети от информацията не се отнасят до вашия чип. Преди да изучавате регистрите на TIM7, проверете в General Description, дали го имате.

Да знаете английски е достатъчно на базово ниво. Спецификациите наполовина се състоят от термини, непознати на средностатистическия носител на езика, и наполовина – от прости свързващи конструкции. Понякога има чудесни китайски спецификации на китайски английски, където половината също са термини, а другата половина – произволен набор от думи.

Ако срещнете непозната дума, не се опитвайте да я преведете с помощта на англо-руски речник. Ако ви обърква hysteresis, преводът „гистерезис“ няма да ви е от помощ. Използвайте Google, Stack Overflow, Уикипедия, форуми, където нужният термин е обяснен с прости думи и примери.

Най-добрият начин да разберете прочетеното е да проверите на практика. Затова дръжте под ръка отладъчна платка, с която се запознавате, а още по-добре две – за случая, ако нещо неразбрано и видите магическия дим.

Полезно е да имате под ръка спецификация, когато четете чужд туториал или изучавате чужда библиотека. Напълно е възможно в нея да намерите по-оптимално решение на задачата си. И обратното – ако от спецификацията не можете да разберете как точно работи регистърът, потърсете го в Google: най-вероятно някой вече е описал всичко с прости думи или е оставил разбираем код в GitHub.

Глосар

Няколко полезни думи и обозначения, които помагат бързо да се запознае с спецификациите. Това, което ми дойде наум през последните дни, допълнения и корекции са добре дошли.

Електричество
Vcc, Vdd – „плюс“, захранване
Vss, Vee – „минус“, земя
current – ток
voltage – напрежение
to sink current – да работи „земя“ за външно натоварване
to source current – да захранва външно натоварване
high sink/source pin – пин с повишена „толерантност“ към натоварване

IO
H, High – на пина Vcc
L, Low – на пина Vss
High Impedance, Hi-Z, floating – на пина няма нищо, „висока съпротива“, той фактически е невидим за външния свят.
weak pull up, weak pull down – вграден подтегателен/отпускащ резистор, приблизителен аналог 50 кОм (вижте спецификацията). Използва се например, за да не се върти входният пин във въздуха, предизвиквайки фалшиви сработка. Weak – защото лесно може да бъде „прекъснат“.
push pull – изходен режим на пина, в който той превключва между Високо и Ниско – обикновен OUTPUT с Arduino.
open drain – обозначение на изходен режим, в който пинът може да бъде или Ниско, или Висока Импедансия / Плаващ. При това почти винаги това не е "истински" отворен дренаж, има защитни диоди, резистори и др. Това просто обозначава режим земя/нищо.
истински open drain – а това вече е истинският отворен дренаж: пинът директно свързва с земя, ако е отворен, или остава във висящо състояние, ако е затворен. Това значи, че през него при необходимост може да преминава напрежение по-голямо от Vcc, но максимумът все пак се уточнява в даташита в раздел Абсолютни Максимални Рейтинги / Напрежение.

Интерфейси
в серия – свързани последователно
верига – свързване на чипове в редица чрез последователно свързване, увеличавайки броя на изходите.
shift – изместване, обикновено обозначава изместване на битове. Съответно, да вмъкнете и да изведете – приемане и предаване на данни на битово ниво.
задвижка – задвижка, която закрива буфера, докато през него се изместват битовете. Когато предаването приключи, задвижката се отваря, битовете започват да работят.
да вмъкнете дати – да извършите битово предаване, да преместите всички битове на нужните места.
двойна буфер, свърт регистър, предварително заредена регистър – обозначения на история, когато регистърът трябва да може да приема нови данни, но да ги задържа до определен момент. Например, за коректна работа на PWM, параметрите му (дължина на импулса, честота) не трябва да се променят, докато текущият цикъл не приключи, но новите параметри вече могат да бъдат предадени. Следователно, текущите остават в свърт регистър, а новите постъпват в предварително заредена регистър, записани в съответстващия регистър на чипа.

Разнообразие
предделител – предделител на честотата
да установите бит – да зададете бит на 1
да изчистите/нулирате бит – да reset-нете бит на 0 (reset – характеристика на STM даташитите)

Какво следва

Всъщност тук беше планирана практическа част с демонстрация на три проекта на STM32 и STM8, изработени специално за тази статия с помощта на даташитите, с лампички, SPI, таймери, PWM и прекъсвания:

Но текстът стана малко много, затова проектите ще бъдат изпратени в втората част.

Умението да четете даташити ще ви помогне с вашето хоби, но едва ли ще замени живото общуване с колеги по интереси на форуми и в чатове. Затова е необходимо първо да усъвършенствате английския език. И затова, за тези, които стигнат до края, – специален приз: два безплатни урока в Skyeng при първоначалната плащане по кода HABR2.

Източник: habr.com