Que fait hardware-interface-contract ?
Compétence Codex : extraire les contrats d'interface matérielle à partir de manuels de puces, de schémas et de microprogrammes existants, pour assister le développement de microprogrammes, le débogage de cartes et la révision matérielle.
Description
Cette compétence permet à l'assistant Codex d'analyser automatiquement la documentation technique (manuels de puces, schémas, microprogrammes) et d'extraire les contrats d'interface matérielle, c'est-à-dire les spécifications formelles des interfaces entre les composants matériels. Elle facilite le développement de microprogrammes en fournissant des définitions précises des registres, broches, protocoles et temporisations. Elle est également utile lors du débogage de cartes pour vérifier la conformité des signaux, et lors des révisions matérielles pour assurer la cohérence entre la documentation et l'implémentation.
Utilisation
Prérequis
- Un environnement de développement compatible avec Codex (par exemple, VS Code avec l'extension GitHub Copilot).
- Accès à des documents sources : manuels de puces (PDF), fichiers de schémas (par exemple, KiCad, Altium), ou code source de microprogrammes (C, C++).
Invocation
Dans le chat Codex, fournissez le contexte en mentionnant la compétence et en joignant les fichiers sources. Par exemple :
Utilise la compétence hardware-interface-contract pour extraire les contrats d'interface à partir du manuel de la puce
STM32F407.pdfet du schémamainboard.sch.
La compétence analysera les documents et renverra un contrat structuré, généralement sous forme de tableau ou de définition YAML, listant les interfaces, les broches, les registres et les protocoles associés.
Exemple de sortie
interfaces:
- nom: SPI1
broches:
- nom: SCK
broche: PA5
- nom: MISO
broche: PA6
- nom: MOSI
broche: PA7
- nom: NSS
broche: PA4
protocole: SPI mode 0
registres:
- nom: CR1
adresse: 0x40013000
description: Registre de contrôle 1
- nom: SR
adresse: 0x40013008
description: Registre d'état
Plateformes supportées
- GitHub Copilot Chat (Codex)
- OpenAI Codex (via API)
- Compatible avec tout éditeur supportant Codex (VS Code, Neovim avec plugins)
Notes
- Les documents PDF doivent être lisibles par OCR pour une extraction optimale.
- Les schémas doivent être dans un format vectoriel ou textuel (par exemple, KiCad .kicad_sch, Altium .SchDoc).
- Le code de microprogrammes existants doit être bien structuré (commentaires, définitions de registres) pour une extraction fiable.