Drivers

Conducteurs

Référentiel centralisé pour les pilotes de bas niveau développés par Zenith Aerospace

Objectif • Environnement • Comment utiliser un pilote • Ajout d'un pilote

Objectif

Stocker et gérer les pilotes développés.

Comment utiliser un pilote

Chaque pilote est organisé dans son propre dossier, où vous trouverez la paire .c/.h . Ajoutez simplement les fichiers à votre projet, par exemple dans un projet STM32Cubeide, ajoutez le fichier .c au dossier Core/Src et le .h au Core/Inc Cependant, tous les pilotes utilisent le «framework» platform , vous devez également copier l'ensemble du dossier platform sur votre projet, dans STM32Cubeide, ajoutez-le dans le dossier Core/Inc Tous les pilotes doivent avoir un exemple de la façon de l'utiliser.

Plate-forme

Le cadre de plate-forme est un ensemble de macros et de bibliothèques d'en-tête uniquement que les pilotes utilisent au lieu de fonctions spécifiques à la plate-forme. Par exemple, une transaction I2C dans un projet STM32 appelle la bibliothèque St Hal, ce qui signifie que le pilote (tel qu'il est) ne peut être utilisé que dans les microcontrôleurs STM32. Le travail de la plate-forme consiste à détecter dans quel microcontrôleur dans lequel il est compilé, puis à choisir la bibliothèque appropriée, afin qu'un pilote développé sur la plate-forme puisse être utilisé dans d'autres microcontrôleurs / processeurs.

Comment ça marche?

Le fichier platform.h met d'abord l'interface commune au pilote, structs communes et les signatures de fonction. Ensuite, un tas de directives de préprocesseur essaient de deviner quel type de projet il s'agit et d'inclure la bonne implémentation de la plate-forme (bibliothèque d'en-tête uniquement) dans le dossier arch .

FYI, si la plate-forme ne peut pas trouver une implémentation, il est par défaut d'un mode de débogage PC, où une implémentation qui imprime simplement à stdout est utilisée.

Environnement

De façon réaliste, nous utilisons principalement le STM32cubeide, car la plupart des projets que nous réalisons sont basés sur cette plate-forme. Mais avec le cadre de plate-forme, vous devriez juste avoir besoin d'un compilateur C.

Ajout d'un chauffeur

Lignes directrices pour les conducteurs:

• Vous devez utiliser C sauf contrainte contraire
  • Pourquoi: pour maximiser la compatibilité (oui il y a encore des UC qui ne peuvent utiliser que c)
• Vous devez ajouter de la documentation avec un exemple
  • Pourquoi: La plupart des utilisateurs veulent simplement copier et coller le code correct
• Vous devez utiliser des fonctions de plate-forme pour accéder aux ressources matérielles, sauf si nécessaire
  • Pourquoi: maximiser la compatibilité, mais la plate-forme ne couvre pas tout, donc, pour l'instant, vous pouvez ajouter un pilote spécifique à la plate-forme.

Étapes d'une liste:

1. Cloner ce référentiel
2. Créer un dossier avec le nom du pilote
3. Ajouter le .c et .h
4. Ajoutez un fichier README.md dans le dossier du pilote
   1. Sur le Readme, ajoutez l'auteur, la date et le but de la bibliothèque
   2. Ajouter une documentation: paramètres et objectif de chaque fonction
   3. Ajoutez une section de notes pour toute information supplémentaire du CI
5. (Facultatif) Ajouter un dossier appelé Docs
   1. Ajouter toute documentation externe, y compris les fiches techniques, les notes d'application et les cartes d'enregistrement
6. S'il y a un problème GitHub pour le pilote, ajoutez un message ou fermez-le.

---

[email protected]