Hallo! Wie macht Ihr die Dokumentation eines IP-Cores? Was kommt in das Dokument alles rein? Es geht hier nicht einfach um eine Übersicht, sondern um eine komplette Beschreibung für einen Kunden. Gibt es irgendwo ein gutes Beispiel und was sind eure Erfahrungen? Wie dämmt ihr den Umfang ein? Über einen komplexen IP-Core kann man sich ja auf über 50 Seiten auslassen ;-/ was will der Kunde wirklich lesen und was ist unnötig? Ich danke für eure konstruktiven Vorschläge! Gruß, Atze
>was will der Kunde wirklich lesen und was ist unnötig?
Ist es nicht am besten den Kunden direkt zu fragen?
Wenn man möchte kann man auch über 500 Seiten schreiben. Was bekommt denn der Kunde? Wenn er nur eine Netzliste bekommt und nichts an dem Core verändern kann wäre folgendes sinnvoll: - grobe Funktionsbeschreibung, funktionales Blockschaltbild - Interfaces - Timingbeziehung zwischen den Eingangssignalen (was muß wann den Pegel wechseln usw.) - evtl. Registerbeschreibung - Beispielanwendung/-konfiguration - GANZ WICHTIG: Sachen die man mit dem Core nicht machen darf Wenn der Kunde Quellcode bekommt...dann würde ich ihn auch fragen. Ansonsten schau doch mal bei OpenCores nach. Da gibt es doch bestimmt auch ein paar Beispiele für gelungene Dokumentation
Hans schrieb: > Ansonsten schau doch mal bei OpenCores nach. Da gibt es doch bestimmt > auch ein paar Beispiele für gelungene Dokumentation Naja. Leider eher nicht. Ich fand die Doku von Gaisler ganz gut: grip.pdf Bei A, L und X dürfte man auch zu Beispielen fündig werden. Duke
Hallo! Erstmal Danke für die Tipps! Der Kunde bekommt nur die Netzliste und ganz wenig (hoffentlich selbsterklärenden) VHDL-Code mit Instanzierungen und die UCF-Files (Pins, Placement, Timing). Wo finde ich denn das oben erwähnte grip.zip von Gaisler? Viele Grüße!
Ex-Schüler schrieb: > Ist es nicht am besten den Kunden direkt zu fragen? meistens nicht ;-) Kunden sind etwas ganz spezielles...
Duke Scarring schrieb: > http://lmgtfy.com/?q=grip.pdf "Enable javascript to use LMGTFY" ;-) danke für den Hinweis, 834 Seiten sind schon "Hardcore" ;-) Aber die Struktur ist hilfreich. DANKE!
Ich finde die Beschreibungen der IP-Cores von Xilinx sehr vorbildlich. Du kannst dich ja daran orientieren.
ja, das habe ich zu allererst auch gedacht, ich will aber noch Meinungen einholen, wie man eine Doku für einen etwas komplexeren Core macht. Die Xilinx-Cores sind ja ehr "kleine" Funktionseinheiten (verglichen mit dem was ich vor habe)... Gruß @ all!
Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.