AVR Interrupt Routinen mit C++

von Christian M.

Dieser Artikel nimmt am Artikelwettbewerb 2012/2013 teil.

Einen Mikrocontroller mit C++ zu programmieren, scheitert oft daran, die Interrupt-Routinen in die Klassenhierarchie zu integrieren. Ohne saubere Objektorientierung verliert C++ jedoch schnell an Wert. Zum Beispiel Frameworks um die Hardware zu abstrahieren, sind mit den Interrupt Makros der avr-libc zwar machbar, jedoch mit reinem C++ weit flexibler. Deshalb soll dieser Artikel einen Einblick in die Möglichkeiten des GNU C++ Compilers geben, der einige Stellschrauben besitzt, mit denen sich Interrupts trotz aller Probleme in Klassen, mit Zugriff auf nicht statische Membervariablen, integrieren lassen.

Probleme

name mangling

In C++ gibt es Namensräume, daher werden nicht nur die Methodennamen für die Symbolnamen benutzt, sondern unter anderem auch die Klassennamen mit eingebracht. Die Schattenseite dieses Features ist allerdings, dass die Interrupt-Makros der avr-libc nicht mehr genutzt werden können. Das Makro ISR() ist eines davon. Es wird vom Präprozessor über einige weitere Makros zur mit extern "C" deklarierten Funktion __vector_n() aufgelöst; n steht für die Interruptnummer. Da extern "C" in Klassen nicht zulässig ist, kann der daraus resultierende Quellcode nicht compiliert werden.

Zugriff auf nicht statische Membervariablen

Da Methoden als ersten impliziten Parameter den this-Zeiger ihres Objekts erhalten, Interrupt-Handler allerdings keine Parameter haben können - ohne Aufruf können keine Parameter übergeben werden - müssen gezwungermaßen statische Methoden verwendet werden. Statische Methoden haben allerdings nur auf statische Variablen Zugriff. Dies ermöglicht jedoch nur eine suboptimale Objektorientierung. Als Beispiel soll eine Timer-Klasse dienen: Wollte man je ein Objekt für zwei verschiedene Timer erstellen, bräuchte man für jedes eine statische Variable.

Lösungen

das asm Schlüsselwort

Mit dem Schlüsselwort asm kann nicht nur inline Assembler programmiert werden, es kann auch dazu verwendet werden, Symbolnamen zu bestimmen. Somit ergibt sich die Möglichkeit, das name mangling zu steuern. Weist man zum Beispiel einer statischen Methode den Symbolnamen __vector_1 zu, so gehört sie weiterhin zur Klasse; es wird nur der Symbolname geändert. Da die avr-libc eine Interruptvektortabelle anlegt, in der ein Sprungbefehl zu __vector_1 für den ersten Interrupt steht, wird die Methode auch im Interruptfall aufgerufen.

befreundete Klassen

Zu den pragmatischeren Teilen der Sprache C++ gehört das Schlüsselwort friend, da es einer fremden Klasse Zugriff auf private Teile einer anderen Klasse gibt. Um mithilfe von friend einer Interrupt Routine Zugriff auf nicht statische Membervariablen zu geben, kann beispielsweise eine geschachtelte befreundete Klasse angelegt werden, die neben der Interrupt Routine eine statische Zeigervariable auf ein Objekt der äußeren Klasse enthält. Wird mithilfe einer weiteren statischen Methode dieser Klasse der this Zeiger eines Objekts der äußeren Klasse gespeichert, kann durch die Interrupt Methode auf alle Member der äußeren Klasse zugegriffen werden.

Implementierungen

Um die beiden folgenden Beispiele kompilieren zu können sollten die folgenden Headerdateien eingebunden werden; stdint.h wegen der Verwendung von uint32_t, interrupt.h wegen sei() und io.h wegen der Registermakros.

#include <stdint.h>
#include <avr/interrupt.h>
#include <avr/io.h>

Die Warnung die beim kompilieren des ersten Beispiels auftritt (beim zweiten in ähnlicher Form) kann ignoriert werden, denn es wird bereits nach Durchlauf des Präprozessors geprüft ob alle Funktionen mit dem __signal__-Attribut mit __vector_ beginnen. Der __asm__-Befehl wird allerdings erst nach dem Kompilieren wirksam.

warning: 'serviceRoutine' appears to be a misspelled signal handler

Interrupt Routine in einer geschachtelten Klasse

Eine einfache Implementierung am Beispiel des Timer2 Overflow-Interrupts auf einem AVR ATmega32 könnte wie folgt aussehen:

Mit __asm__("__vector_5") wird der Symbolname der Methode serviceRoutine() zum Namen des Interrupt Vektors für den Timer2 Overflow-Interrupt. Das Attribut __signal__ teilt dem Compiler mit, dass es sich hier um eine Interrupt-Routine handelt, und alle Register gesichert und wiederhergestellt werden müssen. Mithilfe von __used__ wird verhindert, dass der Code wegoptimiert wird, denn es gibt nirgends im C++-Teil des Codes einen konkreten Aufruf der Methode. Damit die serviceRoutine() auch außerhalb der Timer-Übersetzungseinheit sichtbar ist, sollte __externally_visible__ dem Quellcode hinzugefügt werden. Anstelle von __signal__ kann auch __interrupt__ verwendet werden, um den Interrupt sofort nach Eintritt in die Handler-Methode wieder zu verlassen, anstatt erst nach deren Ende.

class timer {
	volatile uint32_t i;

	class timerInterrupt {
		static timer *ownerTimer;
		static void serviceRoutine() __asm__("__vector_5") __attribute__((__signal__, __used__, __externally_visible__));

		public:
			static void record(timer *ownerTimer);
	};

	friend timerInterrupt;

	public:
		timer();
};

Die Initialisierung der Zeigervariable ownerTimer auf Null sollte nicht vergessen werden, da es ansonsten zu Linkerfehlern kommen kann.

timer *timer::timerInterrupt::ownerTimer = 0;

Die folgende Methode wird gebraucht um ein timer-Objekt für die Interrupt-Routine zu registrieren.

void timer::timerInterrupt::record(timer *t) {
	ownerTimer = t;
}

Dies ist die Interrupt-Routine. Um keinen Speicherzugriffsfehler zu erzeugen, falls der Interrupt auftritt bevor ownerTimer auf ein Objekt der äußeren Klasse zeigt, wird der Zeiger gegen Null geprüft. Zur Demonstration, dass der Zugriff möglich ist, wird i vom Objekt der timer-Klasse erhöht.

void timer::timerInterrupt::serviceRoutine() {
	if(ownerTimer != 0)
		++ownerTimer->i;
}

Im Konstruktor der timer-Klasse wird zuerst der this-Zeiger der inneren Klasse bekannt gemacht. Dann wird der Prescaler von Timer2 auf 1024 eingestellt, und somit der Timer gestartet. In der dritten Zeile wird der Overflow-Interrupt aktiviert um danach Interrupts global zu aktivieren.

timer::timer() : i(0) {
	timerInterrupt::record(this);
        TCCR2 |= (1 << CS20) | (1 << CS21) | (1 << CS22);
        TIMSK |= 1 << TOIE2;
	sei();
}

mit Interrupt Elternklasse

Eine Interrupt-Elternklasse erhöht die Flexibilität des Interrupt-Handlings enorm, allerdings auf Kosten des RAM und Flash Speichers.

Die abstrakte Klasse interrupt enthält ein statisches Array von Zeigern auf die interrupt-Kindklassen. Die Methode serviceRoutine() sollte in den Kindklassen überladen werden. Dann folgen 20 Interrupt-Handler jeweils einer für jeden Interrupt des AVR ATmega32. Die record()-Methode nimmt nun auch die Interrupt-Nummer als Parameter. Als Nummer können die Makros aus der Headerdatei iom32.h verwendet werden.

class interrupt {
  static interrupt *owner[20];

  virtual void serviceRoutine() = 0;
  static void handler1() __asm__("__vector_1") __attribute__((__signal__, __used__, __externally_visible__));
  static void handler2() __asm__("__vector_2") __attribute__((__signal__, __used__, __externally_visible__));

  .
  .
  .

  static void handler20() __asm__("__vector_20") __attribute__((__signal__, __used__, __externally_visible__));

  public:
    static void record(int interruptNumber, interrupt *i);
};

Das owner-Array wird - auch hier der Vollständigkeit des Codes halber - auf Null initialisiert.

interrupt *interrupt::owner[] = {0};

Die Interrupt-Handler rufen, nachdem überprüft wurde ob ein Objekt einer Kindklasse registriert worden ist, dessen Service-Routine auf.

void interrupt::handler1() {
	if(owner[0])
		owner[0]->serviceRoutine();
}

void interrupt::handler2() {
	if(owner[1])
		owner[1]->serviceRoutine();
}

.
.
.

void interrupt::handler20()  {
	if(owner[19])
		owner[19]->serviceRoutine();
}

Die Methode record() speichert den Zeiger auf die Kindklasse an die entsprechende Interruptnummer im owner-Array.

void interrupt::record(int interruptNumber,
		       interrupt *i) {
	owner[interruptNumber - 1] = i;
}

Um einen Linker-Fehler zu vermeiden, sollte ein Handler für aufgerufene, nicht definierte, rein virtuelle Methoden von Hand erstellt werden. Dies, da es für AVR keine Standard-C++-Bibliothek gibt.

extern "C" void __cxa_pure_virtual() {
	for(;;)
		;
}

In der timer-Klasse ist die Klasse timerInterrupt enthalten, welche von der obigen interrupt-Klasse abgeleitet ist. Ihre Zeigervariable ownerTimer soll auf ein Objekt der timer-Klasse zeigen. Die Methode serviceRoutine() wird im Interrupt-Fall vom Interrupt-Handler der Elternklasse aufgerufen. Da von der timerInterrupt-Klasse ein Objekt erstellt wird, gibt es einen Konstruktor der als Parameter die Interrupt-Nummer sowie einen Zeiger auf die äußere Klasse erwartet. Der Konstruktor der timer-Klasse erwartet als ersten Parameter das Timer-Counter-Control-Register des zu konfigurierenden Timers. Als zweites sollte der in dieses Register einzutragende Wert angegeben werden. Die nächsten beiden Parameter widmen sich in der selben Art und Weise dem Timer-Interrupt-Mask Register. Zuletzt ist die Nummer des Timer-Overflow-Interrupts anzugeben.

class timer {
	volatile uint32_t i;

	class timerInterrupt : public interrupt {
		timer *ownerTimer;
		void serviceRoutine();

		public:
			timerInterrupt(int interruptNumber,
				       timer *ownerTimer);
	} nestedTimerInterrupt;

	friend timerInterrupt;

	public:
		timer(volatile uint8_t &timerCounterControlRegister,
		      uint8_t tccrNewState,
		      volatile uint8_t &timerInterruptMaskRegister,
		      uint8_t timskNewState,
		      int interruptNumber);
};

Der Konstruktor der Klasse timerInterrupt sichert einen Zeiger auf das Objekt mit dem die Interrupt-Service-Routine arbeiten soll. Beim Aufruf der record()-Methode seiner Elternklasse gibt er den this-Zeiger seines Objekts weiter.

timer::timerInterrupt::timerInterrupt(int interruptNumber,
				      timer *ownerTimer) : ownerTimer(ownerTimer) {
	record(interruptNumber, this);
}

Die Methode serviceRoutine() wird vom eigentlichen Interrupt-Handler der interrupt-Klasse aufgerufen. In sie sollten die Aufgaben des Interrupts geschrieben werden. Im Beispiel wird die Membervariable i des im Konstruktor bestimmten timer-Objekts erhöht.

void timer::timerInterrupt::serviceRoutine() {
	++ownerTimer->i;
}

Der Konstruktor der timer-Klasse initialisiert i auf Null und gibt die ihm mitgeteilte Interrupt-Nummer sowie den this-Zeiger seines Objekts an den Konstruktor der timerInterrupt-Klasse weiter. Er beschreibt zudem die beiden Timer-Register mit den ihm übergebenen Werten. Zudem aktiviert er Interrupts global.

timer::timer(volatile uint8_t &tccr,
	     uint8_t tccrNewState,
	     volatile uint8_t &timsk,
	     uint8_t timskNewState,
	     int interruptNumber) : i(0),
				    nestedTimerInterrupt(interruptNumber,
							 this) {
        tccr = tccrNewState;
        timsk = timskNewState;
        sei();
}

Ein beispielhafter Aufruf in main() könnte etwa so aussehen. Hier werden Timer0 und Timer2 mit Prescaler-Werten von 1024 initialisiert.

int main() {
	timer timer0(TCCR0,
		     TCCR0 | (1 << CS00) & ~(1 << CS01) | (1 << CS02),
		     TIMSK,
		     TIMSK | (1 << TOIE0),
		     TIMER0_OVF_vect_num);

	timer timer2(TCCR2,
		     TCCR2 | (1 << CS20) | (1 << CS21) | (1 << CS22),
		     TIMSK,
		     TIMSK | (1 << TOIE2),
		     TIMER2_OVF_vect_num);

	for(;;)
		;

	return 0;
}

ein pragmatischer Ansatz im Hinblick auf den Flash-Speicherverbrauch

Die Größe des produzierten Binärcodes beträgt bei der zuerst vorgestellten Methode um die 0,3kB. In der Implementierung mit Elternklasse steigt diese --- aufgrund der vielen ungenutzten, aber als __used__ gekennzeichneten Interrupt Handler --- auf ca. 2,2kB an. Um den Speicherverbrauch im Flash-Speicher händisch zu senken, bietet es sich daher an nicht benötigte Interrupt-Handler auszukommentieren. Mit dieser zwar etwas unschönen, jedoch pragmatischen, Methode lässt sich die Codegröße wieder auf ca. 0,5kB reduzieren.

Die Angaben der Codegrößen beziehen sich auf ein Testprogramm in welchem nur ein timer-Objekt erzeugt wurde und dann eine Endlosschleife folgte. Kompiliert wurde mit Optimierung auf Codegröße.