Conventions générales

Le matériel avec lequel le pilote est sensé travailler. Il s’agit le plus souvent d’une carte d’interface d’un certain type, mais il existe d’autres possibilités.

Il est possible d’installer plusieurs cartes servo, ports parallèles ou autre périphérique matériel dans un ordinateur. Le numéro du périphérique identifie un périphérique spécifique. Les numéros de périphériques commencent à 0 et s’incrémentent.
[Certains matériels utilisent des cavaliers ou d’autres dispositifs pour définir une identification spécifique à chacun. Idéalement, le pilote fournit une manière à l’utilisateur de dire, le device-num 0 est spécifique au périphérique qui a l’ID XXX, ses sous-ensembles porterons tous un numéro commençant par 0. Mais à l’heure actuelle, certains pilotes utilisent l’ID directement comme numéro de périphérique. Ce qui signifie qu’il est possible d’avoir un périphérique Numéro 2, sans en avoir en Numéro 0. C’est un bug qui devrait disparaître en version 2.1.]

La plupart des périphériques fournissent plus d’un type d’I/O. Même le simple port parallèle a, à la fois plusieurs entrées et plusieurs sorties numériques. Les cartes commerciales plus complexes peuvent avoir des entrées et des sorties numériques, des compteurs de codeurs, des générateurs d’impulsions de pas ou de PWM, des convertisseurs numérique/analogique, analogique/numérique et d’autres possibilités plus spécifiques. Le I/O type est utilisé pour identifier le type d’I/O avec lequel la pin ou le paramètre est associé. Idéalement, les pilotes qui implémentent les mêmes type d’I/O, même sur des dispositifs très différents, devraient fournir un jeu de pins et de paramètres cohérents et de comportements identiques. Par exemple, toutes les entrées numériques doivent se comporter de la même manière quand elles sont vues de l’intérieur de HAL, indépendamment du périphérique.

Quasiment tous les périphériques d’I/O ont plusieurs canaux, le numéro de canal chan-num identifie un de ceux ci. Comme les numéros de périphériques device-num, les numéros de canaux, chan-num, commencent à zéro et s’incrémentent.
[Une exception à la règle du numéro de canal commençant à zéro est le port parallèle. Ses HAL pins sont numérotées avec le numéro de la broche correspondante du connecteur DB-25. C’est plus pratique pour le câblage, mais non cohérent avec les autres pilotes. Il y a débat pour savoir si c’est un bogue ou une fonctionnalité.]
Si plusieurs périphériques sont installés, les numéro de canaux des périphériques supplémentaires recommencent à zéro. Comme il est possible d’avoir un numéro de canal supérieur à 9, les numéros de canaux doivent avoir deux chiffres, avec un zéro en tête pour les nombres inférieur à 10 pour préserver l’ordre des tris. Certains modules ont des pins et/ou des paramètres qui affectent plusieurs canaux. Par exemple un générateur de PWM peut avoir quatre canaux avec quatre entrées duty-cycle indépendantes, mais un seul paramètre frequency qui contrôle les quatres canaux (à cause de limitations matérielles). Le paramètre frequency doit utiliser les numéros de canaux de 00-03.

Un canal individuel d’I/O peut avoir une seule HAL pin associée avec lui, mais la plupart en ont plus. Par exemple, une entrée numérique a deux pins, une qui est l'état de la broche physique, l’autre qui est la même chose mais inversée. Cela permet au configurateur de choisir entre les deux états de l’entrée, active haute ou active basse. Pour la plupart des types d' entrée/sortie, il existe un jeu standard de broches et de paramètres, (appelé l'interface canonique) que le pilote doit implémenter. Les interfaces canoniques sont décrites dans ce chapitre qui leur est dédié.

Le même que celui utilisé pour les pins et les paramètres.

Le périphérique spécifique auquel la fonction aura accès.

Optionnel. Une fonction peut accéder à toutes les d’entrées/sorties d’une carte ou, elle peut accéder seulement à un certain type. Par exemple, il peut y avoir des fonctions indépendantes pour lire les compteurs de codeurs et lire les entrées/sorties numériques. Si de telles fonctions indépendantes existent, le champ <io-type> identifie le type d’I/O auxquelles elles auront accès. Si une simple fonction lit toutes les entrés/sorties fournies par la carte, <io-type> n’est pas utilisé.
[Note aux programmeurs de pilotes: ne PAS implémenter des fonctions séparées pour différents types d’I/O à moins qu’elles ne soient interruptibles et puissent marcher dans des threads indépendants. Si l’interruption de la lecture d’un codeur pour lire des entrées numériques, puis reprendre la lecture du codeur peut poser problème, alors implémentez une fonction unique qui fera tout.]

Optionnel. Utilisé seulement si l’entrée/sortie <io-type> est cassée dans des groupes et est accédée par différentes fonctions.

Indique si la fonction lit le matériel ou lui écrit.

État de l’entrée matérielle.

État inversé de l’entrée matérielle.

Lire le matériel et ajuster les HAL pins in et in-not.

Valeur à écrire (éventuellement inversée) sur une sortie matérielle.

Si TRUE, out est inversée avant écriture sur la sortie matérielle.

Lit out et invert et ajuste la sortie en conséquence.

Lecture du matériel, avec mise à l'échelle ajustée par les paramètres scale et offset. Value = ((lecture entrée, en unités dépendantes du matériel) x scale) - offset

La tension d’entrée (ou l’intensité) sera multipliée par scale avant d'être placée dans value.

Sera soustrait à la tension d’entrée (ou l’intensité) après que la mise à l'échelle par scale ait été appliquée.

Valeur du bit le moins significatif (LSB). C’est effectivement, la granularité de lecture en entrée.

Valeur présente sur l’entrée quand aucune tension n’est appliquée sur la pin.

Lit les valeurs de ce canal d’entrée analogique. Peut être utilisé pour lire un canal individuellement, ou pour lire tous les canaux à la fois.

La valeur à écrire. La valeur réelle sur la sortie matérielle dépends de la mise à l'échelle des paramètres d’offset.

Si fausse, la sortie matérielle passera à 0, indépendamment de la pin value.

Sera ajouté à value avant l’actualisation du matériel.

Doit être défini de sorte qu’une entrée avec 1 dans value produira 1V

(optionnel) Quand la valeur en sortie matérielle est calculée, si value + offset est plus grande que high_limit, alors high_limit lui sera substitué.

(optionnel) Quand la valeur en sortie matérielle est calculée, si value + offset est plus petite que low_limit, alors low_limit lui sera substitué.

(optionnel) La valeur du bit le moins significatif (LSB), en Volts (ou mA, pour les sorties courant)

(optionnel) La tension actuelle (ou l’intensité) présente sur la sortie quand 0 est écrit sur le matériel.

Ecrit la valeur calculée sur la sortie matérielle. Si enable est FALSE, la sortie passera à 0, indépendamment des valeurs de value, scale et offset . La signification de 0 dépend du matériel. Par exemple, un convertisseur A/D 12 bits peut vouloir écrire 0x1FF (milieu d'échelle) alors que le convertisseur D/A reçoit 0 Volt de la broche matérielle. Si enable est TRUE, l'échelle, l’offset et la valeur sont traités et (scale _ value) + offset sont envoyés à la sortie du DAC . Si enable est FALSE, la sortie passe à 0.