Mikrocontroller.net - Benutzerbeiträge [de]

Libraries

2011-08-19T20:32:46Z

178.191.213.106: /* Bestehende Libraries */

Dies soll ein Beitrag zum Erstellen und Benutzen von Libraries mit den Tools rund um GCC werden. Da das Erstellen von Libraries relativ plattformunabhängig ist, werde ich die 'native-tools', sprich gcc, ar, ld etc. ohne Target-Prefix (avr-/arm-elf-/...) erwähnen.
Wenn ihr Verbesserungen und/oder Korrekturen kennt, dann fügt sie doch bitte gleich in den Artikel ein.

= Was ist eine 'Library' =

Eine Library (Bibliothek) ist eine Ansammlung von Funktionen, die bereits in kompilierter Form vorliegen.
Sie besteht aus zwei Teilen: dem Archiv und dem Interface in Form von Headern.
Ohne Header ist eine Library nicht verwendbar, da die Deklarationen (und damit das Interface) fehlen.
Es gibt verschiedene Arten von Libraries: statische, dynamische und 'shared'.

In diesem Artikel soll vorerst nur auf statische Libraries für den C-Compiler eingegangen werden.
In der Regel enden sie auf die Dateinamenerweiterung '.a'.

= Bestehende Libraries =
* [http://www.amelek.gda.pl/avr/libc/avr-libc-reference.html AVR libc function reference] Beschreibung der in AVR-GCC enthaltenden Bilbiotheken
* [http://www.procyonengineering.com/embedded/avr/avrlib/ Procyon AVRlib] AVRlib is a library of easy-to-use C functions for a variety of common and uncommon tasks using AVR processors

= Organisation =

Beim Erstellen einer Library sind einige Punkte zu beachten:

* strikte/saubere Trennung von Codedefinition und -Deklaration bei Schnittstellen
* eindeutige Namensgebung bei Sourcefiles (bsp.: 'up()' gehört nicht in 'down.c')
* Optionale Funktionen in eigene Sourcefiles auslagern (Linker!)
* ...

Damit der Linker später möglichst kleine Binaries erzeugen kann, sollten alle Funktionen, die nicht unmittelbar verheiratet sind, in eigene Sourcefiles ausgelagert werden.
Der Linker kann später nur die Objekte aus dem Binary rauslassen, wenn auch wirklich keine der Funktionen in diesen Objekten verwendet wird!

Beispiel:

libmylibfunc1.c

<c>
#include "mylib.h"

int
libmylibfunc1(unsigned char cParam)
{
int rVal = 0;

rVal = (int)((unsigned int) cParam);
return rVal;
}
</c>

libmylibfuncs.c

<c>
#include "mylib.h"

void
libmylibfunc2(void)
{
for(;;)
;
}

void
libmylibfunc3(void)
{
printf("called...\n");
libmylibfunc2();
}
</c>

mylib.h

<c>
int libmylibfunc1(unsigned char);
void libmylibfunc2(void);
void libmylibfunc3(void);
</c>

Bei diesem Beispiel kann der Linker, je nach Verwendung, entscheiden, ob 'libmylibfunc1', 'libmylibfunc2' _und_ 'libmylibfunc3' oder keine der Funktionen im späteren Binary existieren.
Wird 'libmylibfunc1' als einzige verwendet, so ist auch nur diese Funktion im späteren Binary vorhanden.
Wird aber nur eine der beiden Funktionen aus libmylibfuncs.c verwendet, sind später _beide_ im Binary vorhanden! Das liegt daran, daß der Linker nur auf Objektebene selektieren kann.

= Compileraufruf =

Da eine Library lediglich kompiliert und assembliert, aber nicht gelinkt werden soll, muss das beim Compileraufruf berücksichtigt werden. Der Kommandozeilenschalter dafür ist '-c'.

$ gcc -c -ggdb -O2 -o libmylibfunc1.o libmylibfunc1.c

= Archiv erstellen =

Das Archivierungsprogramm 'ar' wird dazu verwendet, um die kompilierten Objektfiles zu einer Library zusammen zu fügen.

$ ar -rcs libmylib.a libmylibfunc1.o libmylibfuncs.o

Den Inhalt der frisch erzeugten Library kann man sich Beispielsweise mit 'nm' anzeigen lassen:

$ nm -s libmylib.a

= Fertige Library =

Es existieren jetzt zwei Dateien, die zum Export der Library benötigt werden:

# 'mylib.h', in der das Interface "Dokumentiert" ist.
# 'libmylib.a', die Library selber, in Kompilierter Form.

= Verwenden =

Hat man die Library jetzt in seinem Projektordner vorliegen, dann kann man (Beispielsweise) die Funktionen im Sourcecode verwenden:

main.c

<pre>
#include "mylib.h"

int
main(void)
{
return libmylibfunc1('A');
}
</pre>

Kompilieren und linken mit:

$ gcc -ggdb -O2 -o projekt.elf main.c -Wl,-Map=projekt.map,--cref -L. -lmylib

Erklärungen:

-Wl,...
* Dieser Kommandozeilenschalter sagt gcc, daß alles nachfolgende an den Linker weitergereicht werden soll. Bei jedem Komma beginnt eine neue Option.
-L.
* ...erweitert den Librarysuchpfad um das aktuelle Verzeichnis
-lmylib
* ...sagt dem Linker, daß er die Library 'libmylib.a' beim Linken verwenden soll (alle Libraries haben das Prefix 'lib', welches hier nicht angegeben werden darf!)

In der Datei 'projekt.map' kann man sich jetzt Beispielsweise anschauen, welche Objektfiles der libmylib.a wirklich hinzugefügt wurden.
In unserem Beispiel ist lediglich das Objektfile 'libmylibfunc1.o' vorhanden. Wenn ihr jetzt ausprobieren wollt, was mit 'libmylibfuncs.o' passiert, dann müsst ihr im 'main.c' lediglich eine der Funktionen aus 'libmylibfuncs.c' verwenden und das 'projekt.elf' neu übersetzen.

[[Kategorie:C]]

AVR-GCC

2011-08-19T20:32:04Z

178.191.213.106: /* Bibliotheken / Libraries */

AVR-GCC ist ein kostenloser [[C]]-Cross-[[Compiler]] für [[AVR]]-[[Mikrocontroller]].

AVR-GCC kann von der Leistungsfähigkeit her mit kommerziellen [[Compiler]]n gut mithalten. Sogar C++-Programme sind möglich, in der aktuellen Fassung wird C++ jedoch nur eingeschränkt unterstützt (Stand 6/2007).

== Bestandteile ==

Die Toolchain (Werkzeugsammlung) besteht aus mehreren Kommandozeilen-Programmen, die sich auf einfache Weise in einen Editor oder eine Entwicklungsumgebung einbinden lassen (typischerweise als Aufrufe von make mit Parameter, vgl. [[AVR-GCC-Tutorial]]).

Die Bestandteile im einzelnen:
* Binutils: Assembler, Linker und weitere Hilfsprogramme.
* GCC: Der eigentliche C(++)-Compiler.
* AVR-LIBC: Die C-Standardbibliothek mit AVR-spezifischen Headerdateien und Funktionen.
* ([[AVRDUDE]]: universelle AVR-Programmiersoftware, kein eigentlicher Teil der Toolchain, aber oft verwendet)

== Installation ==

=== Linux/Unix ===

Wenn keine aktuelle AVR-GCC-Version als Paket für die verwendete Distribution zur Verfügung steht, dann können sich [[Unix]]/[[Linux]]-Nutzer den Sourcecode herunterladen und selbst kompilieren. Schritt-für-Schritt-Anleitungen gibt es [http://www.nongnu.org/avr-libc/user-manual/install_tools.html hier] und [http://www.roboternetz.de/wissen/index.php/Avr-gcc_und_avrdude_installieren hier].

Das [http://www.femtoos.org FemtoOS]-Paket beinhaltet Scripte zum automatischen Herunterladen und Bauen einer aktuellen AVR-GCC Version.

Empfehlenswert ist auch [http://cdk4avr.sf.net CDK4AVR], das die entsprechenden tools als einfach installierbare Linux-Pakete bereitstellt (distributionsunabhängig als .tar.gz). Leider ist das Projekt schon etwas älter, im [http://www.mikrocontroller.net/topic/130972 Forum] findet sich ein Beitrag, aktuellere Sourcen mit den entsprechenden Patches zu versehen und zu kompilieren. Patches zu den Binutils und GCC Sourcen sind unumgänglich, da die offiziellen Sourcen aufgrund des Umfangs an Prozessortargets den aktuellsten Entwicklungen hinterherhinken und damit bereits bekannte Fehler eventuell noch nicht behoben sind. Weitere Tipps zur AVR Programmierung unter Linux stehen im Artikel [[AVR und Linux]].

=== Mac OS X ===
Die beste fertige Toolchain ist das [http://www.obdev.at/crosspack/ Crosspack]. Dieses enthält auch die avr-libc, avrdude und avarice. Leider gab es bei Mac OS 10.5.6 eine tiefgreifende Änderung beim fork()-Systemcall, der bewirkt, dass avarice mit JTAGICE mkII und Dragon nicht funktioniert. Geräte mit Serial-USB-Konvertern (AVRISP clones etc) funktionieren dagegen problemlos.

Wer die Toolchain von Hand bauen möchte kann das natürlich auch tun, dazu einfach den unter "Linux/Unix" verlinkten Anleitungen folgen. Unter [[Mac OS X]] muss man dazu zuerst die [http://developer.apple.com/Tools/ Apple Developer Tools] installieren.

Teile der Toolchain (avr-libc und avrdude) kann man mit dem Paketsystem [http://www.macports.org/ MacPorts] installieren. Die Compiler-Toolchain kann man dann installieren, indem man folgenden Befehl im Terminal eingibt:

sudo port install avr-libc

Das Programmiertool avrdude bekommt man genauso:

sudo port install avrdude

Weblinks:

* [http://tinkerlog.com/2007/09/29/programming-avr-with-a-macbook/ Programming AVR with a MacBook] (engl.)
* [http://www.ladyada.net/library/avrdevtut/setup-mac.html AVR Tutorial from Lady Ada] (engl.)
* [http://www.obdev.at/crosspack/ Crosspack]
* [http://www.digithink.com/OSX-AVR OSX-AVR (nicht mehr aktuell)]
* [http://www.definefalsetrue.com/index.php/Mac-OS-X/bootfeedx.html BootFeedX Bootloaderfrontend]

=== Windows ===

Für MS-Windows gibt es das fertig kompilierte Softwarepaket [[WinAVR]].

== Entwicklungsumgebungen ==

Win32:
* [[AVR-Studio]]: ab Version 4.12 mit WinAVR-Unterstützung, integrierter Simulator, Debugger, rudimentäre Projektverwaltung
* Programmers-Notepad: wird bei [[WinAVR]] mitgeliefert, ein guter Editor mit einer rudimentären Projektverwaltung
* [http://www.myavr.info/download/benutzerhandbuch_sisy_avr.pdf SiSy-AVR]: ein CASE-Tool mit WinAVR-Unterstützung, das eine Entwicklungsumgebung bereitstellt.

Platformunabhängig:
* [http://www.eclipse.org/ Eclipse] mit CDT und dem [http://avr-eclipse.sourceforge.net/index.html AVR Eclipse Plugin]
* [[Code::Blocks]]: vielseitige, freie Entwicklungsumgebung für Windows und Linux
* [http://www.netbeans.org/ Netbeans] in der C++ - Version mit [[WinAVR]] oder [[avr-gcc]] als Toolchain

== Bibliotheken / Libraries ==

Die [http://www.nongnu.org/avr-libc/ avr-libc] ist die gebräuchliche "Laufzeitbibliothek" zum avr-gcc C-Compiler, welche den Zugriff auf die AVR-Hardware erheblich erleichtert. Die offizielle Dokumentation zur avr-libc mit vielen Hinweisen auch zum Compiler avr-gcc und verschiedener Tools (z. B. [[AVRDUDE]]) findet man [http://www.nongnu.org/avr-libc/user-manual/index.html hier].

Auch die [http://www.procyonengineering.com/embedded/avr/avrlib/ Procyon AVRlib] enthält nützlichen Code z. B. für UART, LCD,.... Bei der Procyon AVRlib ist die Lizenz zu beachten (in Kurzform: man muss dritten auf Verlangen den gesamten Quellcode der Firmware zur Verfügung stellen, falls Teile der Procyon Bibliothek genutzt werden).

Zum Zugriff auf interne Funktionen oder externe Peripherie existieren einige fertige Komponenten. Z.B. "Projects"-Bereich von [http://www.avrfreaks.net/ avrfreaks.net] (Anmeldung erforderlich (kostenlos)).

Die Erstellung eigener Bibliotheken ist im Artikel [[Libraries]] erklärt.

== Tipps & Tricks ==

Eine (hoffentlich wachsende) Liste mit einigen Hinweisen:

* Keine "antiken" Versionen verwenden. Für MS-Windows-Nutzer: aktuelles WinAVR installieren. Für Linux/Unix-Nutzer: letzte stabile Version selbst kompilieren oder aus "Distribution-Packages" installieren (z. B. [http://cdk4avr.sourceforge.net/ cdk4avr]).

* Bei Problemen zuerst in die '''[http://www.nongnu.org/avr-libc/user-manual/index.html Anleitung] der avr-libc''' schauen. Insbesondere die FAQ lesen.

* Sicherstellen, dass der MCU-Parameter (zum Compiler/Linker, meist im Makefile defniert) mit dem Zielprozessor übereinstimmt.

* [[AVR-GCC-Tutorial]] in diesem Wiki lesen.

* Im Zweifel '''nicht INTERRUPT(...) sondern SIGNAL(...)''' nutzen. In neueren Versionen der avr-libc wurde '''ISR''' als Ersatz für SIGNAL eingeführt und sollte genutzt werden (SIGNAL und INTERRUPT werden langfristig entfallen). Darauf achten, dass die Vektor- bzw. Signal-Namen ("Parameter") zu ISR bzw. SIGNAL (und INTERRUPT wenn denn unbedingt erforderlich) richtig geschrieben sind. Die Namen sind in der in der entsprechenden Header-Datei (ioxxx.h) für den Controller und der avr-libc-Dokumenation aufgelistet. Im Zweifel den erzeugten Interrupt-Vektor im Assembler-Listing prüfen, es darf '''kein''' SIG_''xxx'' oder xxx_vect mehr zu sehen sein, sondern _vector_''N'' (wobei ''N'' eine Zahl ist). Neuere Versionen der avr-gcc zeigen eine Warnung, falls etwas falsch geschrieben wurde, ältere Versionen nicht.

* '''Zugriff auf Daten(-Tabellen) im Programmspeicher''' (Flash) erfolgt über Program-Space-Funktionen (pgm_read*). Lediglich die Definition einer Variablen/eines Feldes mit dem PROGMEM Attribut zu versehen, reicht (im Gegensatz zu Codevision, IAR, Imagecraft) nicht aus.

* Nicht alle AVRs werden vollständig von der avr-libc bzw. dem Compiler unterstützt. Bei Problemen hilft oft ein Blick in den erzeugten Assembler-Code. Die Anzahl der unterstützen Controller steigt jedoch mit Version zu Version von binutils, avr-libc und avrdude. Evtl. reicht einfach ein Update auf neuere Software-Versionen (z. B. im jeweils aktuellen WinAVR-Packet).

* '''inp(), outp(), sbi() und cbi()''' werden in der aktuellen Bibliotheksversion nicht offiziell unterstützt (man muss eine spezielle Header-Datei einbinden(deprecated.h). Es wird schon seit längerem empfohlen, diese Makros nicht mehr zu nutzen. Einige Anleitungen sind in diesem Punkt veraltet. Mit halbwegs aktuellen avr-gcc/avr-libc-Versionen kann einfach z. B. DDRB=0xfe bzw. foo=PINB geschrieben werden. Mit PORTB |= _BV(1) setzt man PORTB.1, mit PORTB &= ~_BV(1) löscht man es wieder, mit PORTB ^= _BV(1) kann man es umschalten (_BV(x) entspricht dabei (1<<x)). Die ersten beiden Varianten erzeugen bei eingeschalteter Optimierung und passenden Parametern (wie hier im Beispiel Register im "unteren" Speicherbereich) die SBI bzw. CBI Prozessorbefehle.

* Mit dem Tool '''avr-nm''' erhält man eine Übersicht über die Platzausnutzung in der erzeugten ELF-Datei bzw. dem damit gefüllten AVR. Das Tool wird per Kommandozeile mit
::<pre>avr-nm --size-sort --print-size -r -td <your_ELF_file></pre>
:aufgerufen. Alle Symbole mit einem "T" (globale Funktionen), "t" (lokale Funktionen) und letztlich auch mit einem "D" oder "d" (globale bzw. lokale Daten mit Initialisierungswerten im ROM) betreffen das FLASH-ROM. "B" und "b" brauchen ausschließlich RAM (werden beim Start mit 0 initialisiert). Die erste Spalte ist die Adresse des Symbols, die zweite ist die Größe . (vgl. [http://www.mikrocontroller.net/topic/59960#467920 Forenbeitrag] von Jörg Wunsch)

* Mit dem Tool '''avr-size''' erhält man eine Übersicht über den Platzbedarf in den text, data und bss Sektionen innerhalb der ELF Binärdatei. Die Sektionen text und data benötigen Platz im FLASH-ROM und die Sektionen data und bss benötigen zur Laufzeit Platz im SRAM.

== Siehe auch ==
* [[AVR-GCC-Tutorial]]
* [[AVR-GCC-Codeoptimierung]]
* [[GCC: unbenutzte Funktionen entfernen]]
* [http://www.roboternetz.de/wissen/index.php/Avr-gcc/Interna AVR-GCC Interna]

== Weblinks ==
* [http://winavr.sourceforge.net/install_config_WinAVR.pdf Tutorial von C. O'Flynn und E. Weddington] Einstieg in die Nutzung des avr-gcc unter MS-Windows mit WinAVR (englisch)
* [http://www.linuxfocus.org/Deutsch/November2004/article352.shtml AVR-GCC und Linux]
* [http://www.mikrocontroller.net/forum/list-2-1.html GCC-Forum auf mikrocontroller.net]

[[Category:AVR]]
[[Category:Compiler]]
[[Kategorie:avr-gcc| ]]