AVR Debuggen met Atmel-ICE en MPLAB X IDE onder Linux

Het eerste dat we moeten doen is het installeren van de nodig software, na het downloaden van de IDE en Compiler kunnen we deze installeren.

Compiler

Voordat je de compiler kunt installeren op een 64-bit Linux distribtie moet je eerst de "32-bit compatibility packages" installeren, de compiler is op dit moment nog 32-bit.

Als er een pakket ontbreekt zal het installatie programma daar een foutmelding over geven en aan de hand hiervan kun je kijken wat je precies moet installeren. Let er op dat je achter het pakket :i386 zet, ander zal Debian het 64-bit pakket installeren of melden dat het al geïnstalleerd is.

Open een terminal venser en navigeer naar de directory waar je de installer gedownload hebt (meestal is dat ~/Downloads). De Compiler komt als een .run programma, dus je moet deze enkel uitvoerbaar maken met chmod +x xc8-v2.20-full-install-linux-installer.run (als je een nieuwere versie download, moet je natuurlijk de bestandsnaam aanpassen).

Vervolgens installeren we deze met root previleges: sudo ./xc8-v2.20-full-install-linux-installer.run.

Geef het wachtwoord van de root gebruiker in en volg het installatieprogramma.

Bij de vraag naar het licensietype geef je free (de standaard optie) aan, tenzij je een licensie gekocht hebt natuurlijk.

Bij de Compiler Options heef ik in dat ik wil dat iedere gebruiker van de computer deze compiler kan gebruiken, én dat deze moet toegevoegd worden aan het $PATH, zo kan de compiler vanuit iedere directory aangeroepen worden en moeten we niet steeds het volledige path meegeven als we de compiler of een van zijn tools willen gebruiken vanaf de commandoregel.

Ga verder en wacht tot de compiler geïnstalleerd is.

Op het einde van de installatie krijg je nog een venster met instructies om een eventuele licensie te activeren. Zoals de tekst aangeeft kunnen we omdat we de free versie gebruiken gewoon op next klikken.

Gefeliciteerd! je hebt stap 1 met success doorlopen

De volgende stap is het installeren van MPLAB X IDE:

MPLAB X IDE

MPLAB X IDE komt in een tarball en deze moeten we eerst uitpakken, maak een tijdelijke directory aan en plaats de MPLAB X IDE tarball in deze directory. Geef nu het commando tar xf MPLABX-v5.40-linux-installer.tar in en wacht tot het pakket is uitgepakt.

Voer ook dit programma uit met root previleges: sudo ./MPLABX-v5.40-linux-installer.sh en volg de installatie instructies.

Je kunt gewoon de standaard opties gebruiken, bij proxy stel ik wel in dat ik geen proxy heb, de rest zijn de standaard opties.

Als de installatie met success in afgerond kun je MPLAB X IDE opstarten, helaas staat deze nog niet in het menu, dus moeten we deze de eerste keer manueel vanuit de commandoregel opstarten.

het commando hiervoor is mplab_ide

MPLAB X IDE is nu geïnstalleerd, Microchip stelt voor om enkele plugins te installeren (deze worden ook vermeld in het installtieprogramma op het einde van de installatie), het installatie programma opent op mijn computer geen browser naar deze 3, maar 1 ervan is de XC compiler die we al geïnstalleerd hebben, en de andere 2 kunnen we gemakkelijk installeren via: Tools > Plugins > Available Plugins Als deze geïnstalleerd zijn zal MPLAB X IDE vragen om het programma opnieuw op te starten om de plugins beschikbaar te maken.

Om te testen gaan we een kort programma maken dat een LED zal doen knipperen, dit kunnen we dan wegschrijven naar de microcontroller en vervolgens debuggen:

Het programma:

Begin een nieuw project:

File > New Project

Omdat ik een ATMega 168P gebruik, kies ik voor Microchop Embedded en Standalone Project

Geef bij Select Device eerst aan welke familie van microcontroller je gebruikt, daarna het typenummer van deze controller (ATMega168P in mijn geval) en de programmer/debugger (Atmel-ICE), deze moet aangesloten zijn anders krijg je enkel de 2 opties (no tool, en simulator).

Kies een compiler als je de XC8, XC16, en/of XC32 correct geïnstalleerd hebt staan deze in dit menu en kun je de geschikte compiler kiezen. Ook zie je de mogelijkheid om de AVR compiler te kiezen, de AVR v1.00 compiler stonden al op mijn systeem, en de AVR v5.4.0 is de Atmel/Microchip AVR8 Compiler Toolchain, die ik voor het gemak in mijn $HOME directory heb geplaatst (zoals eerder vermeld is deze optioneel).

Tenslotte moeten we het project nog een naam geven en een directory kiezen voor ons project.

MPLAB X IDE zal nu het project generen en openen

We voegen een sourcecode bestand toe door rechts te klikken op Source Files > new > avr-main.c

MPLAB X IDE zal nu een broncode bestand aanmaken met daarin wat boilerplate code

Nu schrijven we een simpel programma

/*
 * File:   blinkLED.c
 * Author: Patrick Kox
 *
 * Created on 14 July 2020, 12:39
 */


#include <avr/io.h>
#include <util/delay.h>

int
main (void)
{
  DDRB = 0xff;      // Data Direction Register B, alle pinnen instellen voor OUTPUT
  PORTB = 0xff;     // Alle pinnen op DDRB naar HIGH (5 Volt) dit zorgt ervoor dat de LEDs om mijn prototyping board uit gaan
  while (1)         // Eeuwigdurende loop (dit programma stop nooit)
    {
      _delay_ms(1000);  // wacht 100 miliseconden
      PORTB |= (1 << PB1);  // Schrijd een 1 (HIGH/5V) naar PB1 (de 2de pin van DDRB);
      _delay_ms(1000);  // wacht 100 miliseconden
      PORTB &= ~(1 << PB1); // Schrijf een 0 (LOW/0V) naar PB1
    }
  return (0);   // dit is niet nodig omdat de code hier nooit komt, maar bepaalde compiler klagen als dit er niet bij staat.
}

Nu kunnen we het programma wegschrijven naar de AVR en een Debug sessie beginnen.

Hiervoor hebben we de Atmel-ICE nodig

De Atmel-ICE is verkrijgbaar in 3 varianten

1. Atmel-ICE PCBA (dit is enkel de printplaat zonder behuizing of kabels)
2. Atmel-ICE Basic (dit is de printplaat in een behuizing, usb kabel en de flatcable in de afbeelding hierboven met de 6-pin header (dit is voldoende voor een ATMega168P.
3. Atmel-ICE (de volledige kit zoals hierboven is afgebeeld).

De prijs zit tussen de €80 en €180 voor de goedkoopste en de duurste.

Sluit de Atmel-ICE aan, in het geval van de ATMega168P in mijn voorbeeld is dat simpelweg de 6-pin header aansluiten op de ISP aansluiting van de microcontroller.

Schrijf of laad het project in en klik op de knop Make and Program Device Main Project

Bij een microcontroller die enkel debugWire ondersteund (zoals de ATTiny en ATMega168P/328P) krijg je bovenstaande foutmelding, dat komt omdat debugWIRE standaard is uitgeschakeld (and deze is ingeschakeld kun je namelijk geen ISP programmer gebruiken om de microcontroller te programmeren).

Als je JA kiest dan zal de Atmel-ICE omschakelen naar ISP modus en de correcte instellingen uitvoeren.

schakel de AVR kortstondig uit en klik binnen de 10seconden na het inschakelen op de knop OK

Waarschuwing

debugWIRE manueel inschakelen Indien dit niet werkt kijk dan hieronder bij ISP Snelheid om dit op te lossen. Maar ga in geen geval de fuses manueel aanpassen. Microchip heeft hier het volgende over te zeggen: It is recommended that you DO NOT edit the value of the SPIEN bit or DWEN bit. MPLAB X IDE will handle interface changes for you (i.e., programming interface to debug interface and vice versa).

De versie van MPLAB X IDE die ik gebruikt (versie 5.40) heeft een bug waarbij de snelheid (MHz) van de ISP programmer verkeerd staat ingesteld (0.000) en het programma geeft ook aan dat deze tussen de 0.000MHz en 0.000MHz moet zitten. De beste snelheid die je hier moet ingeven weet ik niet maar 0.01MHz blijkt te werken:

Opmerking: Ik heb contact gehad met Microchip Support en zij geven aan dat er er bug zit in de huidige versie (5.40). Zij bieden 2 "workarounds" om dit voorlopig op te lossen

1. Begin het project in MPLAB X IDE versie 5.35 en open het daarna in versie 5.40
2. Bewerk het bestand configurations.xml en stel daar de correcte snelheid in.

   <property key="communication.speed" value="0.125"/>

Beide workarounds moeten voor ieder project harhaalt worden. De oplossing die ik hieronder aangeef werkt ook nog. Enkel de aangegeven snelheid is niet correct. Dit is wat Microship Support hierover zegt

A valid communication (such as 0.125 MHz or 1/4 of the device clock speed) must be entered when selecting the ISP communication protocol.

Als je een nieuw project opstart, moet je ook deze instelling opnieuw doen!

1. Open project properties
2. klik op Atmel-ICE
3. Kies "communication" in het drop-down menu
4. Zet interface op ISP (in debugWIRE modus kun je de snelheid niet aanpassen).
5. Stel de snelheid in op 0.01 (negeer de foutmelding)
6. Zet de interface opnieuw op debugWIRE
7. klik Apply/OK

DebugWIRE uitschakelen²:

MPLAB X IDE zal dit automatisch doen bij het beëindigen van een debug-sessie, is er om de een-of-andere reden iets foutgelopen en kun je de microcontroller niet meer benaderen met de Atmel-ICE of enig andere ISP programmer.

Hiervoor gebruiken we AVRDUDE en een HVPP programmer, de correcte fuse instelling kunnen we opzoeken op https://www.engbedded.com/fusecalc/

Kies de correcte microcontroller, dit is héél belangrijk want iedere MCU heeft zijn eigen fuse settings. de website zal automatisch de standaard (fabrieksinstellingen) nemen dus je moet niks aanpassen op deze pagina. Deze site is natuurlijk niet enkel om standaard instellingen te herstellen, je kunt hier bijvoorbeeld ook de fuses opzoeken die je moet gebruiken om een externe oscillator te gebruiken. In dit geval veranderen we dus niks en gaan naar naar de onderkant van de pagina:

Opmerking: Let op! de fuse instellingen op de afbeelding hierboven zijn niet correct, als je deze vergelijk met de instellingen die ik hieronder aangeef zie je dat de waarde van de High fuse 9F is en de correcte waarde moet DF zijn. Als je de bovenstaande fuse waarden programmeert, kun je hierna geen ISP programmer meer gebruiken en zul ja na een eerste geslaagde debug-sessie de microcontroller niet meer kunnen gebruiken (of zoals eerder vermeld tenzij je deze herstelt met een HVPP).

Klik voor de zekerheid op Apply manual fuse bit settings.

Zoals je ziet zijn de mensen van deze website zo vriendelijk om ons de correcte AVRDUDE parameters te geven zodat we deze enkel moeten kopieren en plakken. doe dit ook! een typefout is snel gemaakt.

Om deze fuse settings te programmeren openen we dus een commandoregel en geven het volgende commando in:

Het Debuggen zelf:

Open het project dat je wil programmeren/debuggen in MPLAB X IDE.

Als alles goed is krijg je na enige tijd (het programma zal eerst gecompileerd en geupload worden) een melding in het output venster dat het programmeren gelukt is:

Bij mijn opstelling werkt het nieuwe programma pas na het uit en terug inschakelen van de spanning. Dit mag je straks als we in debug-modus zijn dus absoluut niet meer doen!.

Om een debug-sessie te starten klikken we op de debug main project knop

Als de debug sessie gestart is toont MPLAB X IDE standaard de output van de Atmel-ICE. Hier staat dezelfde informatie als bij het programmeren. Als je op het tabblad Debugger Console klikt zie je dat de debug sessie met sucess gestart is

Breakpoints:

De taakbalk bovenaan het scherm past zich automatisch aan aan de huidige context, zodra je begin te debuggen worden de volgende knoppen toegevoegd.

Ik heb nog geen breakpoints toegevoegd, dus de LED op mijn proefinstelling blijft gewoon knipperen. Als ik links op het regelnummer klik wordt hier zo'n breakpoint toegevoegd en zal de microcontroller stoppen op dit punt.

In het editor venster kun je de status van de breakpoints volgen. Het breakpoint dat actief is wordt met een groene achtergrong weergegeven en de andere met een rode achtergrond.

Willen we dat het programma verder gaat naar het volgende breakpoint, dan klikken we op de knop continue (F5) en het programma zal verder gaan tot het volgende breakpoint bereikt is.

Debug-sessie stoppen:

Als je klaar bent met debuggen, kun je zoals eerder vermeld niet gewoon de Microcontroller en Atmel-ICE (of andere debugger) loskoppelen.

Ik weet niet of het noodzakelijk is, maar voor de veiligheid verwijder ik alle breakpoints en klik daarna op de knop Finish Debugger Session (SHIFT-F5).