diff --git a/Makefile b/Makefile index 9d845331..542fe86f 100644 --- a/Makefile +++ b/Makefile @@ -31,9 +31,6 @@ clean: $(MAKE) -C $(KERNELDIR) M=`pwd` clean @rm -rf */.tmp_versions -doc docs: - doxygen Doxyfile - config conf $(CONFIG_FILE): @echo "# EtherCAT Konfigurationsdatei Kernel 2.6" > $(CONFIG_FILE) @echo >> $(CONFIG_FILE) diff --git a/Doxyfile b/master/Doxyfile similarity index 99% rename from Doxyfile rename to master/Doxyfile index c9507dec..75518cce 100644 --- a/Doxyfile +++ b/master/Doxyfile @@ -1,4 +1,4 @@ -################################################################# +################################################################ # # Doxyfile # @@ -41,7 +41,7 @@ PROJECT_NUMBER = 0.1 # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = ../src-docs +OUTPUT_DIRECTORY = doc # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this @@ -347,7 +347,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = drivers +INPUT = . ../include # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -368,7 +368,7 @@ RECURSIVE = NO # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = drivers/drv_8139too.c +EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories # that are symbolic links (a Unix filesystem feature) are excluded from the input. @@ -379,7 +379,7 @@ EXCLUDE_SYMLINKS = NO # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = *.mod.c # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see diff --git a/master/Makefile b/master/Makefile index dd7e00e2..c11b1853 100644 --- a/master/Makefile +++ b/master/Makefile @@ -38,9 +38,15 @@ endif modules: $(MAKE) -C $(KERNELDIR) M=`pwd` modules -clean: +clean: cleandoc $(MAKE) -C $(KERNELDIR) M=`pwd` clean +doc: + doxygen Doxyfile + +cleandoc: + @rm -rf doc + #------------------------------------------------------------------------------ endif diff --git a/master/domain.c b/master/domain.c index 40ce3a00..3d4cfc70 100644 --- a/master/domain.c +++ b/master/domain.c @@ -18,7 +18,7 @@ /** Konstruktor einer EtherCAT-Domäne. - @param pd Zeiger auf die zu initialisierende Domäne + @param dom Zeiger auf die zu initialisierende Domäne */ void ec_domain_init(ec_domain_t *dom) diff --git a/master/master.c b/master/master.c index 04667bde..69601957 100644 --- a/master/master.c +++ b/master/master.c @@ -139,7 +139,6 @@ int ec_master_open(ec_master_t *master) Schliesst das EtherCAT-Geraet, auf dem der Master arbeitet. @param master Der EtherCAT-Master - @param device Das EtherCAT-Geraet */ void ec_master_close(ec_master_t *master) @@ -731,6 +730,10 @@ void ec_output_lost_frames(ec_master_t *master) Registriert einen Slave beim Master. @param master Der EtherCAT-Master + @param bus_index Index des Slaves im EtherCAT-Bus + @param vendor_name String mit dem Herstellernamen + @param product_name String mit dem Produktnamen + @param domain Domäne, in der der Slave sein soll @return 0 bei Erfolg, sonst < 0 */ @@ -816,14 +819,13 @@ ec_slave_t *EtherCAT_rt_register_slave(ec_master_t *master, /*****************************************************************************/ /** - Konfiguriert einen Slave und setzt den Operational-Zustand. + Konfiguriert alle Slaves und setzt den Operational-Zustand. - Führt eine komplette Konfiguration eines Slaves durch, - setzt Sync-Manager und FMMU's, führt die entsprechenden + Führt die komplette Konfiguration und Aktivierunge aller registrierten + Slaves durch. Setzt Sync-Manager und FMMU's, führt die entsprechenden Zustandsübergänge durch, bis der Slave betriebsbereit ist. @param master EtherCAT-Master - @param slave Zu aktivierender Slave @return 0 bei Erfolg, sonst < 0 */ @@ -1030,10 +1032,9 @@ int EtherCAT_rt_activate_slaves(ec_master_t *master) /*****************************************************************************/ /** - Setzt einen Slave zurück in den Init-Zustand. + Setzt alle Slaves zurück in den Init-Zustand. @param master EtherCAT-Master - @param slave Zu deaktivierender Slave @return 0 bei Erfolg, sonst < 0 */ @@ -1059,9 +1060,9 @@ int EtherCAT_rt_deactivate_slaves(ec_master_t *master) /** Sendet und empfängt Prozessdaten der angegebenen Domäne - @param master EtherCAT-Master - domain Domäne - timeout_us Timeout in Mikrosekunden + @param master EtherCAT-Master + @param domain Domäne + @param timeout_us Timeout in Mikrosekunden @return 0 bei Erfolg, sonst < 0 */ diff --git a/master/module.c b/master/module.c index e71700cf..515f54d8 100644 --- a/master/module.c +++ b/master/module.c @@ -151,14 +151,16 @@ void __exit ec_cleanup_module(void) *****************************************************************************/ /** - Setzt das EtherCAT-Geraet, auf dem der Master arbeitet. + Registeriert das EtherCAT-Geraet fuer einen EtherCAT-Master. + @param master_index Index des EtherCAT-Masters + @param dev Das net_device des EtherCAT-Geraetes + @param isr Funktionszeiger auf die Interrupt-Service-Routine + @param module Zeiger auf das Modul (fuer try_module_lock()) - @param master Der EtherCAT-Master - @param device Das EtherCAT-Geraet @return 0, wenn alles o.k., - < 0, wenn bereits ein Geraet registriert - oder das Geraet nicht geoeffnet werden konnte. + < 0, wenn bereits ein Geraet registriert oder das Geraet nicht + geoeffnet werden konnte. */ ec_device_t *EtherCAT_dev_register(unsigned int master_index, @@ -208,10 +210,10 @@ ec_device_t *EtherCAT_dev_register(unsigned int master_index, /*****************************************************************************/ /** - Loescht das EtherCAT-Geraet, auf dem der Master arbeitet. + Entfernt das EtherCAT-Geraet eines EtherCAT-Masters. - @param master Der EtherCAT-Master - @param device Das EtherCAT-Geraet + @param master_index Der Index des EtherCAT-Masters + @param ecd Das EtherCAT-Geraet */ void EtherCAT_dev_unregister(unsigned int master_index, ec_device_t *ecd)