I2C

Channel9 : libreria NFC per tutte le piattaforme Windows Embedded su Coding4Fun

2548.Cattura_thumb_20B302B0

Questa volta Creg Duncan ha dovuto dare più spiegazioni del solito per giustificare la prima presenza molto assidua sul blog Coding4Fun !

“Today’s Hardware Friday post is another project from our Friend of the Blog, Paolo Patierno (yeah, yeah, I know, it seems like I’m posting his stuff all the time, but hey, it’s cool stuff) !”

Sono contento che i miei “piccoli” progetti open source riscuotano un discreto successo e questa volta è toccato alla libreria uNFC che implementa il supporto al chip NFC PN532 della NXP per tutte le piattaforme Windows Embedded (dal .Net Micro Framework a Windows Embedded 8 passando per Windows Embedded Compact).

A proposito…questa libreria domani sarà protagonista alla Microsoft Embedded Conference a Napoli in una demo di Smart Home & Smart Factory System !

Come sempre….è un piacere esserci !!

🙂

uNFC library : NFC con le piattaforme Windows Embedded

Dopo i due articoli precedenti che descrivevano il bus SPI ed I2C ed il loro utilizzo nel .Net Micro Framework, è giunto finalmente il momento di vederne un’applicazione pratica con il mio ultimo progetto disponibile su CodePlex : uNFC – NFC library for .Net platforms !

Introduzione : supporto software ed hardware

Questa libreria permette di utilizzare un chip NFC collegato al nostro PC (via seriale) oppure ad un qualsiasi sistema embedded che sia basato su Windows Embedded Compact / Windows Embedded Standard o .Net Micro Framework.

Essa supporta tutti le piattaforme .Net Framework disponibili :

  • .Net Framework 4.0 per PC con Windows 7/8 oppure sistemi embedded basati su Windows Embedded Standard 7 e Windows Embedded 8 Standard;
  • .Net Compact Framework 3.5 / 3.9 per sistemi embedded basati su Windows Embedded Compact 7 e Windows Embedded Compact 2013;
  • .Net Micro Framework 4.2 e 4.3 per sistemi embedded come le board Netduino e .Net Gadgeteer;

Per quanto riguarda l’hardware, essa attualmente supporta il chip NFC PN532 della NXP ma definisce un “piccolo framework” grazie al quale è possibile sviluppare un managed driver per un chip differente senza modificare tutti i livelli superiori che si interfacciano con l’applicazione utente. Il supporto al chip PN532 è garantito con tutti e tre i possibili canali di comunicazione previsti per esso : I2C, SPI ed HSU.

Tipicamente il canale HSU (High Speed UART) viene utilizzato per il collegamento alla porta seriale di un PC o di un sistema basato su Windows Embedded Compact. Le connessioni I2C ed SPI rappresentano le soluzioni migliori nel caso di board basate su .Net Micro Framework.

Lo sviluppo ed il testing è stato effettuato mediante la breakout board RFID/NFC della Elecfreaks e disponibile al seguente link, così come il datasheet ufficiale di riferimento del chip NXP PN532 è disponibile qui. Per il collegamento ad un PC è ovviamente necessario un convertitore USB – Seriale TTL (come questi della FTDI) con i relativi driver, in modo da interfacciarsi al lettore sempre attraverso una porta seriale (in questo caso virtuale).

8664.NFC-Module_thumb_16FC890B

Architettura software

Il managed driver per il chip PN532 è implementato dalla classe PN532 che ha un riferimento ad un’istanza del layer di comunicazione che deve implementare l’interfaccia IPN532CommunicationLayer. In questo modo, abbiamo la possibilità di scegliere il canale da utilizzare fornendo l’istanza di una classe concreta che implementa questa interfaccia al costruttore della classe PN532. Le classe disponibili sono le seguenti :

  • PN532CommunicationI2C : canale I2C;
  • PN532CommunicationSPI : canale SPI;
  • PN532CommunicationHSU : canale HSU;

Il lettore basato su questo chip è implementato attraverso la classe NfcPN532Reader che ha un riferimento all’istanza della PN532. Questo classe implementa l’interfaccia INfcReader. Ciò vuol dire che se vogliamo utilizzare un altro chip, dobbiamo seguire questi passi :

  • Realizzare una classe per il driver (come la PN532);
  • Realizzare una classe relativa al lettore che ha un riferimento al driver suddetto ed implementa l’interfaccia INfcReader;

L’esistenza di più classi nell’implementazione per il chip PN532 è strettamente legata al fatto che quest’ultimo disponga di più canali di comunicazione per l’interfacciamento.

5554.ClassDiagram1_thumb_1D435F99

In primo luogo va creata un’istanza di una delle classi relative al canale di comunicazione e ciascuna di esse è strettamente legata alla board sulla quale stiamo lavorando. Successivamente tale istanza va fornita al costruttore della classe PN532 e quest’ultima va passata al costruttore della classe del lettore NfcPN532Reader.

L’interfaccia INfcReader, che essa implementa, espone :

  • il metodo Open() per l’inizializzazione del lettore, specificando il tipo di tag NFC che ci aspettiamo di poter riconoscere;
  • il metodo Close() per chiudere la connessione al lettore;
  • il metodo WriteRead() per scrivere e leggere verso/da il lettore;
  • l’evento TadDetected che viene sollevato quando un tag è riconosciuto dal lettore;
  • l’evento TagLost che viene sollevato quando il lettore perder la connessione con il tag riconosciuto;

Utilizzando gli ultimi due eventi, è possibile registrare un event handler per ciascuno di essi in modo da poter gestire il riconoscimento di un tag da parte del lettore e la disconnessione del tag stesso.

5047.IMG_20140104_093307_thumb_3566C9F4

Di seguito, un esempio di applicazione per la board Netduino Plus sulla quale possiamo utilizzare tutti i canali di comunicazione disponibili nel PN532 ma è ovviamente possibile istanziare ed utilizzare un solo canale alla volta (nella foto in alto oltre al Netduino Plus ed alla board dell’NFC, c’è anche un analizzatore logico usato durante lo sviluppo).

static private INfcReader nfc;

public static void Main()
{
 // write your code here

 // HSU Communication layer
 // MOSI/SDA (TX) --> DIGITAL 0 (RX COM1)
 // SCL/RX (RX) --> DIGITAL 1 (TX COM1)
 IPN532CommunicationLayer commLayer = new PN532CommunicationHSU(SerialPorts.COM1);

 // SPI Communication layer
 // SCK --> DIGITAL 13
 // MISO --> DIGITAL 12
 // MOSI/SDA --> DIGITAL 11
 // SCL/RX -> DIGITAL 10
 // IRQ --> DIGITAL 8
 //IPN532CommunicationLayer commLayer = new PN532CommunicationSPI(SPI.SPI_module.SPI1, Pins.GPIO_PIN_D10, Pins.GPIO_PIN_D8);

 // I2C Communication layer
 // MOSI/SDA --> ANALOG 4 (SDA)
 // SCL/RS --> ANALOG 5 (SCL)
 // IRQ --> DIGITAL 8
 //IPN532CommunicationLayer commLayer = new PN532CommunicationI2C(Pins.GPIO_PIN_D8);

 nfc = new NfcPN532Reader(commLayer);
 nfc.TagDetected += nfc_TagDetected;
 nfc.TagLost += nfc_TagLost;
 nfc.Open(NfcTagType.MifareUltralight);

 InterruptPort button = new InterruptPort(Pins.ONBOARD_SW1, true, Port.ResistorMode.Disabled, Port.InterruptMode.InterruptEdgeHigh);
 button.OnInterrupt += button_OnInterrupt;

 Thread.Sleep(Timeout.Infinite);
}

static void button_OnInterrupt(uint data1, uint data2, DateTime time)
{
 nfc.Close();
}

In entrambi gli eventi, l’istanza NfcTagEventArgs espone alcune informazioni sul tag riconosciuto (il tipo) ed un riferimento alla connessione al tag. Tale connessione è rappresentata da un’istanza di una classe che deriva dalla classe astratta NfcTagConnection. Attualmente sono disponibili le classi NfcMifareTagConnection e NfcMifareUITagConnection per la gestione rispettivamente del tag Mifare Classic e Mifare Ultralight.

La classe astratta ha a disposizione :

  • la property ID, ossia l’NFC ID del tag;
  • un riferimento all’interfaccia INfcReader che punterà all’istanza NfcPN532Reader utilizzata per attivare il lettore. Attraverso questa istanza, l’oggetto relativo alla connection è in grado di utilizzare il metodo WriteRead() visto prima per scrivere e leggere verso/da il lettore;

0576.ClassDiagram2_thumb_6DA5410C

Tornando all’esempio precedente, attraverso i due event handler possiamo mostrare l’ID del tag riconosciuto e magari effettuare delle operazioni di lettura scrittura sulla base del tipo riconosciuto grazie al corrispondente oggetto NfcTagConnection.

L’esempio mostra che è necessaria una distinzione tra i tipi di tag (anche se entrambi Mifare), in quanto il Mifare Classic prevede un’operazione di autenticazione sul blocco a cui accedere (blocco 8 nell’esempio) che non è prevista dal Mifare Ultralight; i due tag sono diversi anche in termini di struttura della memoria interna.

static void nfc_TagLost(object sender, NfcTagEventArgs e)
{
 Debug.Print("LOST " + HexToString(e.Connection.ID));
}

static void nfc_TagDetected(object sender, NfcTagEventArgs e)
{
 Debug.Print("DETECTED " + HexToString(e.Connection.ID));

 byte[] data;

 switch (e.NfcTagType)
 {
 case NfcTagType.MifareClassic1k:

 NfcMifareTagConnection mifareConn = (NfcMifareTagConnection)e.Connection;
 mifareConn.Authenticate(MifareKeyAuth.KeyA, 0x08, new byte[] { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF });
 mifareConn.Read(0x08);

 data = new byte[16];
 for (byte i = 0; i < data.Length; i++)
 dataIdea = i;

 mifareConn.Write(0x08, data);

 mifareConn.Read(0x08);
 break;

 case NfcTagType.MifareUltralight:

 NfcMifareUlTagConnection mifareUlConn = (NfcMifareUlTagConnection)e.Connection;

 for (byte i = 0; i < 16; i++)
 {
 byte[] read = mifareUlConn.Read(i);
 }

 mifareUlConn.Read(0x08);

 data = new byte[4];
 for (byte i = 0; i < data.Length; i++)
 dataIdea = i;

 mifareUlConn.Write(0x08, data);

 mifareUlConn.Read(0x08);
 break;

 default:
 break;
 }
}

Conclusioni

Il progetto è appena all’inizio e spero di avere numerosi feedback da coloro che lo utilizzeranno per poterlo migliorare. La possibilità di realizzare un driver per un chip NFC differente ed integrarlo nell’architettura senza alterare i livelli superiori, può essere un punto di forza.

La lettura e la scrittura dei tag NFC è di tipo “raw” e non c’è supporto per NDEF (NFC Data Exchange Format) ma non c’è da preoccuparsi ! Il team di Mopius mi ha aggiunto come developer al progetto NDEF Library ed il mio obiettivo è quello di realizzarne il porting anche su .Net Micro Framework.

.Net Micro Framework : usiamo il bus I2C !

Alla pari dell’SPI, analizzato in un articolo precedente, l’I2C (Inter-Integrated Circuit) è un bus di comunicazione sincrono utilizzato per la connessione e lo scambio dati tra un microprocessore e le periferiche esterne; sviluppato dalla Philips, oggi NXP, è diventato uno standard “de facto”.

Descrizione del bus

l’I2C è anche noto come bus two-wire in quanto è caratterizzato a tutti gli effetti da due soli “fili” :

  • SDA (Serial Data Line) : linea per il trasferimento dati;
  • SCL (Serial CLock) : clock per il sincronismo nello scambio dati;

Le linee suddette sono sempre caratterizzate da una resistenza di pull-up che ha il compito di mantenere il segnale “alto” (1 logico) in condizioni di idle mentre i componenti interconnessi (master e slave) hanno il compito di abbassarne il livello per trasferire uno 0 logico e di rilasciarlo per riportarlo in idle e trasferire un 1 logico; questo comportamento è tipico delle linee open-drain.

7506.425px-I2C_svg_thumb_0C0994EE

Analogamente all’SPI, è possibile avere più slave connessi al bus ed un unico master con cui comunicare; la differenza principale è che non esiste un segnale di SS (Slave Select) ma il master seleziona lo slave con cui comunicare attraverso un indirizzamento. Infatti, il master trasmette l’indirizzo dello slave sulla linea SDA prima di iniziare il trasferimento dei dati veri e propri; tale indirizzo è tipicamente a 7 bit (fino a 128 slave) ma è prevista un’estensione fino a 10 bit (fino a 1024 slave).

Una caratteristiche fondamentale dell’I2C è che permette la presenza di più master sul bus a differenza dell’SPI (modalità multi master).

Il protocollo di comunicazione

Il protocollo di comunicazione è caratterizzato dai seguenti passi :

  1. START Condition : il master abbassa l’SDA tenendo ancora alto l’SCL per indicare la condizione di START allo slave e quindi l’inizio di una trasmissione;
  2. Indirizzamento : il master invia un byte (MSB first) sul bus, in cui i primi 7 bit rappresentano l’indirizzo dello slave con cui comunicare e l’ultimo bit indica il tipo di operazione da voler effettuare (0 = write, 1, = read);
  3. Slave acknowledge : se sul bus esiste uno slave con tale indirizzo, esso risponde con un bit di ACK (0 logico);
  4. Comunicazione : a questo punto, il master può inviare e/o ricevere dati dallo slave in maniera sincrona grazie al movimento dell’SCL. Per ogni byte scambiato è sempre previsto un ACK dalla controparte;
  5. STOP Condition : il master alza l’SCL tenendo ancora basso l’SDA per indicare la STOP condition allo slave e quindi il termine della trasmissione;

4762.798px-I2C_data_transfer_svg_thumb_763FAC90

Il clock è sempre pilotato dal master ma in alcuni casi lo slave può mantenerne il valore basso per introdurre del delay ed evitare che il master gli invii altri dati (magari ha bisogno di più tempo per elaborare i dati già ricevuti) : questa funzionalità si chiama “clock stretching”.

.Net Micro Framework : le classi per utilizzare il bus

Il .Net Micro Framework semplifica notevolmente l’utilizzo del bus I2C mediante la classe I2CDevice (namespace Microsoft.SPOT.Hardware, assembly Microsoft.SPOT.Hardware.dll), il cui costruttore prevede un parametro del tipo I2CDevice.Configuration per poter essere opportunamente configurata; tale configurazione permette di impostare :

  • Address : indirizzo dello slave con cui comunicare;
  • ClockRateKhz : frequenza del clock;

Tutti i parametri di configurazione suddetti sono sempre strettamente legati al device con il quale si intende comunicare e vanno ricercati all’interno del datasheet.

I2CDevice.Configuration config =
      new I2CDevice.Configuration(I2C_ADDRESS, I2C_CLOCK_RATE_KHZ);

I2CDevice i2c = new I2CDevice(config);

La classe I2CDevice mette a disposizione un unico metodo Execute() per poter effettuare una o più “transazioni” sul bus che rappresentano le operazioni di lettura e scrittura con lo slave. Tale metodo prevede in ingresso un array di oggetti I2CDevice.I2CTransaction ed un timeout. La classe I2CDevice.I2CTransaction è la classe base per la classe I2CDevice.I2CReadTransaction, nel caso di una transazione di lettura, e per la classe I2CDevice.I2CWriteTransaction, nel caso di una transazione di scrittura.

La creazione di un’istanza per ciascuna delle due classi suddette può essere effettuata attraverso i due seguenti metodi statici della classe I2CDevice :

  • CreateReadTransaction() : crea un’istanza della classe I2CDevice.I2CReadTransaction associando ad essa l’array di byte ricevuto in ingresso come buffer per la ricezione dati dallo slave (inizialmente vuoto);
  • CreateWriteTransaction() : crea un’istanza della classe I2CDevice.I2CWriteTransaction associando ad essa l’array di byte ricevuto in ingresso come buffer contenente i dati da trasmettere allo slave;

In definitiva, la procedura d’uso dell’I2C prevede di creare un array di “transazioni” di lettura e/o scrittura (ovviamente anche mixate) ed eseguire queste transazioni in un solo colpo, ritrovandosi i dati trasmessi allo slave ed i buffer di ricezione con i dati richiesti.

Immaginiamo di aver un componente I2C caratterizzato da una serie di registri interni e di voler leggere il contenuto di uno di essi. Questo tipo di comunicazione è caratterizzata da due “transazioni” I2C; la prima di scrittura per poter inviare allo slave l’indirizzo del registro da leggere (attenzione !! non parliamo dell’indirizzo dello slave stesso che viene inviato in precedenza) e la seconda di lettura per poterne leggere il contenuto.

byte[] write = { REG_ADDRESS };
byte[] read = new byte[1];

// create I2C write and read transaction
I2CDevice.I2CTransaction[] i2cTx = new I2CDevice.I2CTransaction[2];
i2cTx[0] = I2CDevice.CreateWriteTransaction(write);
i2cTx[1] = I2CDevice.CreateReadTransaction(read);

// execution
i2c.Execute(i2cTx, I2C_TIMEOUT);

Uno sguardo verso il basso : lo strato di HAL

Anche nel caso dell’I2C (come già visto per l’SPI), ciascun OEM deve implementare uno strato HAL (e PAL) che faccia da “ponte” tra la parte CLR (fino al codice managed ad alto livello) ed il particolare hardware sottostante.

Prendiamo come riferimento la board Netduino (generazione 1) che ha come microcontrollore un Atmel AT91. Scaricando i sorgenti del firmware (sono open source) dal sito ufficiale, possiamo individuare l’implementazione in codice managed C# della classe I2CDevice (Framework\Core\Native_Hardware\I2C.cs) all’interno della quale viene invocato il metodo GetI2CPins() sull’istanza corrente dell’HardwareProvider.

public I2CDevice(Configuration config)
{
 this.Config = config;

 HardwareProvider hwProvider = HardwareProvider.HwProvider;

 if (hwProvider != null)
 {
 Cpu.Pin scl;
 Cpu.Pin sda;

 hwProvider.GetI2CPins(out scl, out sda);

 if (scl != Cpu.Pin.GPIO_NONE)
 {
 Port.ReservePin(scl, true);
 }

 if (sda != Cpu.Pin.GPIO_NONE)
 {
 Port.ReservePin(sda, true);
 }
 }

 Initialize();

 m_disposed = false;
}

Dopo una serie di invocazioni a cascata attraverso il CLR fino all’implementazione dell’HAL, sarà invocato il metodo GetPins() sulla classe AT91_I2C_Driver(DeviceCode\Targets\Native\AT91\DeviceCode\AT91_I2C\AT91__I2C.cpp) che ritorna gli identificativi dei pin del processore associati alla porta I2C.

void AT91_I2C_Driver::GetPins(GPIO_PIN& scl, GPIO_PIN& sda)
{
 NATIVE_PROFILE_HAL_PROCESSOR_I2C();

 scl = AT91_TWI_SCL;
 sda = AT91_TWI_SDA;
}

Nel caso della board Netduino (generazione 2) che ha un processore STM32, la funzione di lettura dei pin I2C è I2C_Internal_GetPins() (DeviceCode\Targets\Native\STM32\DeviceCode\STM32_I2C\STM32_i2c_functions.cpp).

void I2C_Internal_GetPins(GPIO_PIN& scl, GPIO_PIN& sda)
{
 scl = I2Cx_SCL_Pin;
 sda = I2Cx_SDA_Pin;
}

Conclusione

Il bus I2C a differenza dell’SPI non è ovviamente full duplex essendo caratterizzato da una sola linea dati ed è anche più lento in termini di velocità. Il vantaggio principale è quello di non avere la complessità di un segnale di selezione dello slave e di poter lavorare in modalità multi master.

Il .Net Micro Framework permette di utilizzare questo bus con estrema semplicità con una sola classe ed il concetto di “transazioni” lettura/scrittura I2C in modo da eseguire la comunicazione in un solo “colpo”.

Molto presto vedrete un esempio reale di applicazione di questo bus (come per il bus SPI) con un managed driver che ho sviluppato per un chip NFC della NXP !