Je viens de publier sur GitHub un petit projet nommé Spi-tools, regroupant deux utilitaires pour communiquer sous Linux en utilisant le protocole SPI. Ce projet a été écrit pour illustrer le fonctionnement d’un lien SPI entre un microprocesseur sous Linux (Raspberry Pi en l’occurrence) et un microcontrôleur (T.I. MSP430), mais il doit pouvoir s’appliquer à la plupart des besoins de configuration et communication en SPI sous Linux.

Interface Spidev

Ces deux outils fonctionnent en utilisant l’interface Spidev du noyau Linux. Pour la charger il est donc nécessaire de charger dans le kernel le module spidev.ko, généralement précédé du module permettant de piloter le contrôleur SPI du système.

Par exemple, sur un Raspberry Pi, on fera:

$ sudo modprobe spi-bcm2708
$ sudo modprobe spidev

À partir de ce moment, des fichiers spéciaux apparaissent dans /dev pour représenter les interfaces SPI disponibles. Voici le résultat sur un Raspberry Pi.

$ ls -l /dev/spi*
crw-rw---T 1 root spi 153, 0 Aug 11 20:26 /dev/spidev0.0
crw-rw---T 1 root spi 153, 1 Aug 11 20:26 /dev/spidev0.1
$

Compilation du projet

La compilation de ces petits outils ne nécessite aucune bibliothèque ou utilitaire particuliers.

$ git clone https://github.com/cpb-/spi-tools.git
Cloning into 'spi-tools'...
remote: Counting objects: 43, done.
remote: Compressing objects: 100% (29/29), done.
remote: Total 43 (delta 20), reused 34 (delta 13)
Unpacking objects: 100% (43/43), done.
$ cd ../spi-tools/
$ make 
cc -Wall -DVERSION=\"0.1-3-g0408c9d\"    spi-config.c   -o spi-config
cc -Wall -DVERSION=\"0.1-3-g0408c9d\"    spi-pipe.c   -o spi-pipe
$

Configuration

Le premier outil permet de configurer en ligne de commande les paramètres d’une liaison SPI. Si nous l’invoquons sans argument, il nous indique comment obtenir de l’aide.

$ ./spi-config 
./spi-config: no device specified (use option -h for help).
$ ./spi-config -h
usage: ./spi-config options...
  options:
    -d --device=  use the given spi-dev character device.
    -q --query         print the current configuration.
    -m --mode=[0-3]    use the selected spi mode.
             0: low iddle level, sample on leading edge
             1: low iddle level, sample on trailing edge
             2: high iddle level, sample on leading edge
             3: high iddle level, sample on trailing edge
    -l --lsb={0,1}     LSB first (1) or MSB first (0)
    -b --bits=[7...]   bits per word
    -s --speed=   set the speed in Hz
    -h --help          this screen
    -v --version       display the version number
$

On utilisera donc l’option -d pour préciser l’interface SPI concernée. L’option -q nous permet de voir la configuration courante.

$ ./spi-config -d /dev/spidev0.0 -q
/dev/spidev0.0: mode=0, lsb=0, bits=8, speed=500000
$

Nous pourrons donc fixer le mode SPI pour s’adapter à un composant externe, le sens et la taille des mots échangés, ainsi que la vitesse de communication en Hz.

$ ./spi-config -d /dev/spidev0.0 -s 10000000
$ ./spi-config -d /dev/spidev0.0 -q
/dev/spidev0.0: mode=0, lsb=0, bits=8, speed=10000000
$

Communication

Un avantage du SPI est la possibilité de dialoguer en mode full-duplex, le maître recevant dans un registre de réception les données émises par l’esclave alors que lui-même transmet son message. Ce système est donc très rapide. Associé au débit élevé (habituellement plusieurs MHz) que l’on peut employer, il permet des communications très efficaces.

Il est néanmoins difficile à utiliser depuis l’espace utilisateur en employant les appels système read() et write() classiques. Le noyau met donc à notre disposition une commande ioctl() à laquelle on fournit deux buffers, l’un contenant les données à envoyer, l’autre destiné à la réception.

Le programme spi-pipe offre une interface pour cet appel système ioctl() en prenant en charge la gestion des buffers. Comme son nom l’indique, on l’emploie depuis la ligne de commande en lui fournissant les données à envoyer sur son entrée standard et en récupérant simultanément sur sa sortie standard les données reçues.

Comme le programme précédent, il présente une aide en ligne sur les quelques options proposées.

$ ./spi-pipe
./spi-pipe: no device specified (use option -h for help).
$ ./spi-pipe -h
usage: ./spi-pipe options...
  options:
    -d --device=    use the given spi-dev character device.
    -b --blocksize= transfer blocks size in byte
    -h --help            this screen
    -v --version         display the version number
$

Si on veut simplement envoyer octet par octet des données produites par la commande-1 vers un esclave SPI, on pourra utiliser une syntaxe comme

$ commande-1 | ./spi-dev -d /dev/spidev0.0 > /dev/null

Pour lire des données envoyées par un esclave et les traiter avec la commande-2:

$ ./spi-dev -d /dev/spidev0.0 </dev/zero  | commande-2

Enfin, on peut intercaler la commande dans un pipeline ainsi :

$ commande-1 | ./spi-pipe -d /dev/spidev0.0 | commande-2

Conclusion

Ce petit projet simple me sert à mettre au point et vérifier le comportement d’une bibliothèque de communication plus évoluée dont je reparlerai ici. Tous les retours (bugs, suggestions, etc.) sont les bienvenus.