comp: outil pour créer les modules HAL

component - Un composant est un simple module temps réel, qui se charge avec halcmd loadrt. Un fichier .comp spécifie un seul composant.

instance - Un composant peut avoir plusieurs instances ou aucune. Chaque instance d’un composant est créée égale (elles ont toutes les mêmes pins, les mêmes paramètres, les mêmes fonctions et les mêmes données) mais elle se comporte de manière différente quand leurs pins, leurs paramètres et leur données ont des valeurs différentes.

singleton - Il est possible pour un composant d'être un singleton (composant dont il n’existe qu’une seule instance), dans ce cas, exactement une seule instance est créée. Il est rarement logique d'écrire un composant singleton , à moins qu’il n’y ait qu’un seul objet de ce type dans le système (par exemple, un composant ayant pour but de fournir une pin avec le temps Unix courant, ou un pilote matériel pour le haut parleur interne du PC)

component HALNAME (DOC);

pin PINDIRECTION TYPE HALNAME ([SIZE]|[MAXSIZE : CONDSIZE]) (if CONDITION) (= STARTVALUE) (DOC);

param PARAMDIRECTION TYPE HALNAME ([SIZE]|[MAXSIZE : CONDSIZE]) (if CONDITION) (= STARTVALUE) (DOC);

function HALNAME (fp | nofp) (DOC);

option OPT (VALUE);

variable CTYPE NAME ([SIZE]);

description DOC;

see’also DOC;

license LICENSE;

author AUTHOR;

NAME - Un identifiant C standard.

STARREDNAME - Un identifiant C, précédé ou non d’une *. Cette syntaxe est utilisée pour déclarer les variables qui sont des pointeurs. Noter qu'à cause de la grammaire, il ne doit pas y avoir d’espace entre * et le nom de la variable.

HALNAME - Un identifiant étendu. Lorsqu’ils sont utilisés pour créer un identifiant de HAL, tous les caractères soulignés sont remplacés par des tirets, tous les points et les virgules de fin, sont supprimés, ainsi ce_nom_ est remplacé par ce-nom, si le nom est "", alors le point final est enlevé aussi, ainsi "function" donne un nom de fonction HAL tel que "component.<num>" au lieu de "component.<num>."

if CONDITION - Une expression impliquant la personnalité d’une variable non nulle quand la variable ou le paramètre doit être créé.

SIZE - Un nombre donnant la taille d’un tableau. Les items des tableaux sont numérotés de 0 à SIZE-1.

MAXSIZE : CONDSIZE - Un nombre donnant la taille maximum d’un tableau, suivi d’une expression impliquant la personnalité d’une variable et qui aura toujours une valeur inférieure à MAXSIZE. Quand le tableau est créé sa taille est égale à CONDSIZE.

DOC - Une chaine qui documente l’item. La chaine doit être au format C, entre guillemets, comme:

"Sélectionnez le front désiré: TRUE pour descendant, FALSE pour montant"

"""The effect of this parameter, also known as "the orb of zot",
will require at least two paragraphs to explain.

Hopefully these paragraphs have allowed you to understand "zot"
better."""

\\fIexample\\fB

TYPE - Un des types de HAL: bit, signed (signé), unsigned (non signé) ou float (flottant). Les anciens noms s32 et u32 peuvent encore être utilisés, mais signed et unsigned sont préférables.

PINDIRECTION - Une des ces directions: in, out, ou io . Le composant pourra positionner la valeur d’une pin de sortie, il pourra lire la valeur sur une pin d’entrée et il pourra lire ou positionner la valeur d’une pin io.

PARAMDIRECTION - Une des valeurs suivantes: r ou rw. Le composant pourra positionner la valeur d’un paramètre r et il pourra positionner ou lire la valeur d’un paramètre rw.

STARTVALUE - Spécifie la valeur initiale d’une pin ou d’un paramètre. Si il n’est pas spécifié, alors la valeur par défaut est 0 ou FALSE, selon le type de l’item.

Tous noms commençant par _comp.

comp_id

fperiod

rtapi_app_main

rtapi_app_exit

extra_setup

extra_cleanup

FUNCTION(name) - Cette macro s’utilise au début de la définition d’une fonction temps réel qui aura été précédemment déclarée avec function NAME. function inclus un paramètre period qui est le nombre entier de nanosecondes entre les appels à la fonction.

EXTRA_SETUP() - Cette macro s’utilise au début de la définition de la fonction appelée pour exécuter les réglages complémentaires à cette instance. Une valeur de retour négative Unix errno indique un défaut (par exemple: elle retourne -EBUSY comme défaut à la réservation d’un port d’entrées/sorties), une valeur égale à 0 indique le succès.

EXTRA_CLEANUP() - Cette macro s’utilise au début de la définition de la fonction appelée pour exécuter un nettoyage (cleanup) du composant. Noter que cette fonction doit nettoyer toutes les instances du composant, pas juste un. Les macros pin_name, parameter_name et data ne doivent pas être utilisées ici.

pin_name ou parameter_name - Pour chaque pin, pin_name ou pour chaque paramètre, parameter_name il y a une macro qui permet d’utiliser le nom seul pour faire référence à la pin ou au paramètre. Quand pin_name ou parameter_name sont des tableaux, la macro est de la forme pin_name(idx) ou param_name(idx) dans laquelle idx est l’index dans le tableau de pins. Quand le tableau est de taille variable, il est seulement légal de faire référence aux items par leurs condsize.

Quand un item est conditionnel, il est seulement légal de faire
référence à cet item quand ses conditions sont évaluées à des
valeurs différentes de zéro.

variable_name - Pour chaque variable, il y a une macro variable_name qui permet au nom seul d'être utilisé pour faire référence à la variable. Quand variable_name est un tableau, le style normal de C est utilisé: variable_name[idx]

data- Si l’option data est spécifiée, cette macro permet l’accès à l’instance de la donnée.

fperiod - Le nombre de secondes en virgule flottante entre les appels à cette fonction temps réel.

FOR_ALL_INSTS() {…} - Pour les composants de l’espace utilisateur. Cette macro utilise la variable *struct state inst pour itérer au dessus de toutes les instances définies. Dans le corps de la boucle, les macros pin_name, parameter_name et data travaillent comme elles le font dans les fonctions temps réel.