Drivers

Treiber

Zentrales Repository für die von Zenith Aerospace entwickelten Treiber mit niedriger Ebene

Ziel • Umgebung • Verwenden eines Treibers • Hinzufügen eines Treibers

Objektiv

Lagern und verwalten Sie entwickelte Treiber.

So benutzt man einen Fahrer

Jeder Fahrer ist in seinem eigenen Ordner organisiert, in dem Sie das .c/.h -Paar finden. Fügen .h einfach die Dateien Ihrem Projekt .c , Core/Inc Core/Src Alle Treiber verwenden jedoch die platform "Framework", sodass Sie auch den gesamten platform in Ihr Projekt kopieren müssen. In STM32Cubeide fügen Sie ihn dem Core/Inc -Ordner hinzu. Alle Fahrer sollten ein Beispiel dafür haben, wie man es benutzt.

Plattform

Das Plattform-Framework ist eine Reihe von Makros- und Header-Bibliotheken, die Treiber anstelle von plattformspezifischen Funktionen verwenden. Beispielsweise ruft eine I2C -Transaktion in einem STM32 -Projekt die ST HAL -Bibliothek auf, dh der Treiber (wie er ist) nur in STM32 -Mikrocontrollern verwendet werden. Die Aufgabe der Plattform besteht darin, zu erkennen, in welchem ​​Mikrocontroller sie zusammengestellt wird, und dann die entsprechende Bibliothek auszuwählen, damit ein auf der Plattform entwickelter Treiber in anderen Mikrocontrollern/Prozessoren verwendet werden kann.

Wie funktioniert es?

Zunächst legt die platform.h -Datei die gemeinsame Schnittstelle zum Treiber, gemeinsamen structs und Funktionssignaturen ein. Anschließend versuchen eine Reihe von Präprozessor-Direktiven zu erraten, welche Art von Projekt dies ist, und enthalten die richtige Plattformimplementierung (nur Bibliothek mit Header) in den arch .

Zu Ihrer Information, wenn die Plattform keine Implementierung finden kann, wird es standardmäßig in einen PC -Debug -Modus eingestuft, in dem nur eine Implementierung verwendet wird, die nur zu STDOut verwendet wird.

Umfeld

Realistisch gesehen verwenden wir das STM32Cubride hauptsächlich, da die meisten Projekte, die wir durchführen, auf dieser Plattform basieren. Mit dem Plattform -Framework sollten Sie jedoch nur einen C -Compiler benötigen.

Hinzufügen eines Fahrers

Richtlinien für Fahrer:

• Sie sollten C verwenden, sofern nicht anders erforderlich
  • Warum: Um die Kompatibilität zu maximieren (ja, es gibt immer noch UCs, die nur C verwenden können)
• Sie sollten eine Dokumentation mit einem Beispiel hinzufügen
  • Warum: Die meisten Benutzer möchten nur korrekte Code kopieren und einfügen
• Sie sollten Plattformfunktionen verwenden, um auf Hardware -Ressourcen zuzugreifen, es sei denn
  • Warum: Maximieren Sie die Kompatibilität, aber die Plattform deckt jedoch nicht alles ab. Im Moment können Sie einen Treiber hinzufügen, der plattformspezifisch ist.

Schritte in einer Liste:

1. Klonen Sie dieses Repository
2. Erstellen Sie einen Ordner mit dem Treibernamen
3. Fügen Sie den .c und .h hinzu
4. Fügen Sie dem Treiberordner eine README.md -Datei hinzu
   1. Fügen Sie auf der Readme den Autor, das Datum und den Zweck der Bibliothek hinzu
   2. Dokumentation hinzufügen: Parameter und Zweck jeder Funktion
   3. Fügen Sie einen Notizenabschnitt für zusätzliche Informationen des IC hinzu
5. (Optional) Fügen Sie einen Ordner mit dem Namen Docs hinzu
   1. Fügen Sie eine externe Dokumentation hinzu, einschließlich Datenblätter, Anwendungshinweise und Registrieren Sie Karten
6. Wenn es ein Github -Problem für den Treiber gibt, fügen Sie eine Nachricht hinzu oder schließen Sie sie.

---

[email protected]