diff -r c21e7c12dd50 -r 674071846ee3 master/module.c --- a/master/module.c Thu Apr 20 13:19:36 2006 +0000 +++ b/master/module.c Thu Apr 20 13:31:31 2006 +0000 @@ -2,9 +2,9 @@ * * m o d u l e . c * - * EtherCAT-Master-Treiber - * - * Autoren: Wilhelm Hagemeister, Florian Pose + * EtherCAT master driver module. + * + * Author: Florian Pose * * $Id$ * @@ -50,18 +50,14 @@ MODULE_VERSION(COMPILE_INFO); module_param(ec_master_count, int, 1); -MODULE_PARM_DESC(ec_master_count, "Number of EtherCAT master to initialize."); - -/*****************************************************************************/ - -/** - Init-Funktion des EtherCAT-Master-Treibermodules - - Initialisiert soviele Master, wie im Parameter ec_master_count - angegeben wurde (Default ist 1). - - \return 0 wenn alles ok, < 0 bei ungültiger Anzahl Master - oder zu wenig Speicher. +MODULE_PARM_DESC(ec_master_count, "number of EtherCAT masters to initialize"); + +/*****************************************************************************/ + +/** + Module initialization. + Initializes \a ec_master_count masters. + \return 0 on success, else < 0 */ int __init ec_init_module(void) @@ -115,9 +111,8 @@ /*****************************************************************************/ /** - Cleanup-Funktion des EtherCAT-Master-Treibermoduls - - Entfernt alle Master-Instanzen. + Module cleanup. + Clears all master instances. */ void __exit ec_cleanup_module(void) @@ -142,7 +137,7 @@ \returns pointer to master */ -ec_master_t *ec_find_master(unsigned int master_index) +ec_master_t *ec_find_master(unsigned int master_index /**< master index */) { ec_master_t *master; @@ -155,26 +150,19 @@ } /****************************************************************************** - * - * Treiberschnittstelle - * + * Device interface *****************************************************************************/ /** - Registeriert das EtherCAT-Geraet fuer einen EtherCAT-Master. - - \return 0 wenn alles ok, oder < 0 wenn bereits ein Gerät registriert - oder das Geraet nicht geöffnet werden konnte. -*/ - -ec_device_t *ecdev_register(unsigned int master_index, - /**< Index des EtherCAT-Masters */ - struct net_device *net_dev, - /**< net_device des EtherCAT-Gerätes */ - ec_isr_t isr, - /**< Interrupt-Service-Routine */ - struct module *module - /**< Zeiger auf das Modul */ + Registeres an EtherCAT device for a certain master. + \return 0 on success, else < 0 +*/ + +ec_device_t *ecdev_register(unsigned int master_index, /**< master index */ + struct net_device *net_dev, /**< net_device of + the device */ + ec_isr_t isr, /**< interrupt service routine */ + struct module *module /**< pointer to the module */ ) { ec_master_t *master; @@ -218,13 +206,11 @@ /*****************************************************************************/ /** - Hebt die Registrierung eines EtherCAT-Gerätes auf. -*/ - -void ecdev_unregister(unsigned int master_index, - /**< Index des EtherCAT-Masters */ - ec_device_t *device - /**< EtherCAT-Geraet */ + Unregisteres an EtherCAT device. +*/ + +void ecdev_unregister(unsigned int master_index, /**< master index */ + ec_device_t *device /**< EtherCAT device */ ) { ec_master_t *master; @@ -244,12 +230,10 @@ /*****************************************************************************/ /** - Starts the master. -*/ - -int ecdev_start(unsigned int master_index - /**< Index des EtherCAT-Masters */ - ) + Starts the master associated with the device. +*/ + +int ecdev_start(unsigned int master_index /**< master index */) { ec_master_t *master; if (!(master = ec_find_master(master_index))) return -1; @@ -266,12 +250,10 @@ /*****************************************************************************/ /** - Stops the master. -*/ - -void ecdev_stop(unsigned int master_index - /**< Index des EtherCAT-Masters */ - ) + Stops the master associated with the device. +*/ + +void ecdev_stop(unsigned int master_index /**< master index */) { ec_master_t *master; if (!(master = ec_find_master(master_index))) return; @@ -283,21 +265,16 @@ } /****************************************************************************** - * - * Echtzeitschnittstelle - * + * Realtime interface *****************************************************************************/ /** - Reserviert einen bestimmten EtherCAT-Master und das zugehörige Gerät. - - Gibt einen Zeiger auf den reservierten EtherCAT-Master zurueck. - - \return Zeiger auf EtherCAT-Master oder NULL, wenn Parameter ungueltig. + Reserves an EtherCAT master for realtime operation. + \return pointer to reserved master, or NULL on error */ ec_master_t *ecrt_request_master(unsigned int master_index - /**< EtherCAT-Master-Index */ + /**< master index */ ) { ec_master_t *master; @@ -351,10 +328,10 @@ /*****************************************************************************/ /** - Gibt einen zuvor angeforderten EtherCAT-Master wieder frei. -*/ - -void ecrt_release_master(ec_master_t *master /**< EtherCAT-Master */) + Releases a reserved EtherCAT master. +*/ + +void ecrt_release_master(ec_master_t *master /**< EtherCAT master */) { EC_INFO("Releasing master %i...\n", master->index); @@ -378,10 +355,12 @@ /*****************************************************************************/ /** - Gibt Frame-Inhalte zwecks Debugging aus. -*/ - -void ec_print_data(const uint8_t *data, size_t size) + Outputs frame contents for debugging purposes. +*/ + +void ec_print_data(const uint8_t *data, /**< pointer to data */ + size_t size /**< number of bytes to output */ + ) { unsigned int i; @@ -399,12 +378,12 @@ /*****************************************************************************/ /** - Gibt Frame-Inhalte zwecks Debugging aus, differentiell. -*/ - -void ec_print_data_diff(const uint8_t *d1, /**< Daten 1 */ - const uint8_t *d2, /**< Daten 2 */ - size_t size /** Anzahl Bytes */ + Outputs frame contents and differences for debugging purposes. +*/ + +void ec_print_data_diff(const uint8_t *d1, /**< first data */ + const uint8_t *d2, /**< second data */ + size_t size /** number of bytes to output */ ) { unsigned int i; @@ -434,9 +413,3 @@ EXPORT_SYMBOL(ecrt_release_master); /*****************************************************************************/ - -/* Emacs-Konfiguration -;;; Local Variables: *** -;;; c-basic-offset:4 *** -;;; End: *** -*/