Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
fpga:vhdllibrary:start [2013-12-11 09:27] tinnerfpga:vhdllibrary:start [2013-12-13 10:02] (aktuell) zueger1
Zeile 20: Zeile 20:
   * Im doc-Ordner können Dokumentationsdateien die zusätzlich zur .info Datei benötigt werden abgelegt werden.   * Im doc-Ordner können Dokumentationsdateien die zusätzlich zur .info Datei benötigt werden abgelegt werden.
   * Die Projektordner müssen folgendermassen bennant werden: Name der Entwicklungsumgebung unterstrich Name des FPGAs z.B. quartus_cyclone_4. Dabei ist darauf zu achten keine von der Entwicklungsumgebung generierten Dateien mit einzuchecken.     * Die Projektordner müssen folgendermassen bennant werden: Name der Entwicklungsumgebung unterstrich Name des FPGAs z.B. quartus_cyclone_4. Dabei ist darauf zu achten keine von der Entwicklungsumgebung generierten Dateien mit einzuchecken.  
 +  * Alle Ordner bzw. Dateinamen dürfen **keine** Leerzeichen und auch **keine** Umlaute (ä,ö,ü) enthalten.
  
 === Beispiel fqd === === Beispiel fqd ===
Zeile 50: Zeile 51:
 Für jeden Block muss eine .info Datei angelegt werden. Sie enthält Informationen über die jeweilige Komponente. Sie wird auch verwendet um den Wiki Eintag zu generieren. Es ist darauf zu achten, diese Datei stehts aktuell zu halten.  Für jeden Block muss eine .info Datei angelegt werden. Sie enthält Informationen über die jeweilige Komponente. Sie wird auch verwendet um den Wiki Eintag zu generieren. Es ist darauf zu achten, diese Datei stehts aktuell zu halten. 
 Für jede Komponente müssen in der .info Datei folgende Parameter angegeben werden:  Für jede Komponente müssen in der .info Datei folgende Parameter angegeben werden: 
-  * Designer +  * name (designator) 
-  * Version +  * description (string) 
-  * Description +  * version (designator) 
-  * Used Sub-Blocks  +  * sources (name of the source files)(designator) 
-  * Needed Files +  * testbench (name of the testbench files)(designator) 
-  * Testbench +  * usedSubBlocks (Name of the used subblock)(designator)  
-  * Lizenz  +  * license (string) 
-  * State (Under Construction, Testing, Released) +  * state (UnderConstruction, Testing, Released)  
 +  * reviewedBy (string)
 Optional können noch weitere Informationen abgelegt werden:  Optional können noch weitere Informationen abgelegt werden: 
-  * Synthesis Results +  * synthesisResults (string) 
-  * Usage +  * usage (string) 
-  * Known Bugs +  * knownBugs (string) 
-  * Modified by +  * modifiedBy (string) 
-  * TBD  +
  
-=== Beispiel: i2c.info === +Alle Paramter die mit designator gekenzeichnet sind dürfen nicht zwischen Anführungszeichen geschrieben werden. Ein Beispiel ist [[https://svn.ntb.ch/projects/vhdl-library/functionalBlocks/fqd/trunk/fqd.info|hier]] zu finden 
-<file> +
-name =        "i2c"; +
-description = "This block is following the 1982 Philips i2c Bus interface +
-               standard to transmit 16 Bit read or write data to one of 116 +
-               slaves at 100 kHz."; +
-version =     0.1.0; +
-date =        2013-11-01; +
-designer =    "Laszlo Arato"; +
-source =      i2c_driver.m.vhd; +
-testbench =   i2c_driver.tb.vhd; +
-dev-state =   tested +
-bugs =        "Function of acknowledge bits not testet."; +
-license =     "Apache License 2.0"; +
-comments =    "Used at the NTB in the Course 'EuR-III Digitale Systeme'"; +
-</file>+
  
 ==== Simulation ==== ==== Simulation ====
Zeile 92: Zeile 78:
 ==== Tags ==== ==== Tags ====
  
-Sobald eine Komponente einen gewissen Stand erreicht hat bzw. spätestens wenn sie in irgend einem Projekt ausgeliefert wird muss im SVN ein Tag erstellt werden. Davor wird eine neue Version vergeben. +Sobald eine Komponente einen gewissen Stand erreicht hat bzw. spätestens wenn sie in irgend einem Projekt ausgeliefert wird muss im SVN ein Tag erstellt werden. Davor wird eine neue Version vergeben. 
 + 
 +==== Header ==== 
 + 
 +<code> 
 +------------------------------------------------------------------------------- 
 +--     ____  _____          __    __    ________    _______ 
 +--    |    | \    \        |   \ |  |  |__    __|  |   __ 
 +--    |____|  \____\          \|  |      |      |__>  )  
 +--     ____   ____          |\ \  |      |       __ 
 +--    |    | |    |        |  | \        |      |__> 
 +--    |____| |____|        |__|  \__|     |__|     |_______/ 
 +-- 
 +--    NTB University of Applied Sciences in Technology 
 +-- 
 +--    Campus Buchs - Werdenbergstrasse 4 - 9471 Buchs - Switzerland 
 +--    Campus Waldau - Schoenauweg 4 - 9013 St. Gallen - Switzerland 
 +-- 
 +--    Web http://www.ntb.ch        Tel. +41 81 755 33 11 
 +-- 
 +------------------------------------------------------------------------------- 
 +-- Copyright 2013 NTB University of Applied Sciences in Technology 
 +------------------------------------------------------------------------------- 
 +-- Licensed under the Apache License, Version 2.0 (the "License"); 
 +-- you may not use this file except in compliance with the License. 
 +-- You may obtain a copy of the License at 
 +--  
 +-- http://www.apache.org/licenses/LICENSE-2.0 
 +--    
 +-- Unless required by applicable law or agreed to in writing, software 
 +-- distributed under the License is distributed on an "AS IS" BASIS, 
 +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 +-- See the License for the specific language governing permissions and 
 +-- limitations under the License. 
 +------------------------------------------------------------------------------- 
 +</code> 
 + 
 + 
 +---- 
 + 
 +[[overview]]