etherlabmaster: comparison master/slave.c

equal deleted inserted replaced

-:f8a1e9f364a3
+:b9a6e2c22745
 *  s l a v e . c
 *
 *  EtherCAT slave methods.
 *
 *  $Id$
+*
+*  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
+*
+*  This file is part of the IgH EtherCAT Master.
+*
+*  The IgH EtherCAT Master is free software; you can redistribute it
+*  and/or modify it under the terms of the GNU General Public License
+*  as published by the Free Software Foundation; version 2 of the License.
+*
+*  The IgH EtherCAT Master is distributed in the hope that it will be
+*  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*  GNU General Public License for more details.
+*
+*  You should have received a copy of the GNU General Public License
+*  along with the IgH EtherCAT Master; if not, write to the Free Software
+*  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *****************************************************************************/
 #include <linux/module.h>
 #include <linux/delay.h>
 /*****************************************************************************/
 /**
 Slave constructor.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_init(ec_slave_t *slave, /**< EtherCAT slave */
 ec_master_t *master, /**< EtherCAT master */
 uint16_t ring_position, /**< ring position */
 /*****************************************************************************/
 /**
 Slave destructor.
+\ingroup Slave
 */
 void ec_slave_clear(struct kobject *kobj /**< kobject of the slave */)
 {
 ec_slave_t *slave;
 /*****************************************************************************/
 /**
 Reads all necessary information from a slave.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_fetch(ec_slave_t *slave /**< EtherCAT slave */)
 {
 ec_command_t *command;
 /*****************************************************************************/
 /**
 Reads 16 bit from the slave information interface (SII).
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_sii_read16(ec_slave_t *slave,
 /**< EtherCAT slave */
 uint16_t offset,
 /*****************************************************************************/
 /**
 Reads 32 bit from the slave information interface (SII).
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_sii_read32(ec_slave_t *slave,
 /**< EtherCAT slave */
 uint16_t offset,
 /*****************************************************************************/
 /**
 Writes 16 bit of data to the slave information interface (SII).
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_sii_write16(ec_slave_t *slave,
 /**< EtherCAT slave */
 uint16_t offset,
 /*****************************************************************************/
 /**
 Fetches data from slave's EEPROM.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_fetch_categories(ec_slave_t *slave /**< EtherCAT slave */)
 {
 uint16_t word_offset, cat_type, word_count;
 /*****************************************************************************/
 /**
 Fetches data from a STRING category.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_fetch_strings(ec_slave_t *slave, /**< EtherCAT slave */
 const uint8_t *data /**< category data */
 )
 /*****************************************************************************/
 /**
 Fetches data from a GENERAL category.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_fetch_general(ec_slave_t *slave, /**< EtherCAT slave */
 const uint8_t *data /**< category data */
 )
 /*****************************************************************************/
 /**
 Fetches data from a SYNC MANAGER category.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_fetch_sync(ec_slave_t *slave, /**< EtherCAT slave */
 const uint8_t *data, /**< category data */
 size_t word_count /**< number of words */
 /*****************************************************************************/
 /**
 Fetches data from a [RT]XPDO category.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_fetch_pdo(ec_slave_t *slave, /**< EtherCAT slave */
 const uint8_t *data, /**< category data */
 size_t word_count, /**< number of words */
 /*****************************************************************************/
 /**
 Searches the string list for an index and allocates a new string.
 \return 0 in case of success, else < 0
-*/
+\ingroup Slave
+\todo documentation
-int ec_slave_locate_string(ec_slave_t *slave, unsigned int index, char **ptr)
+*/
+int ec_slave_locate_string(ec_slave_t *slave, /**< EtherCAT slave */
+unsigned int index, /**< string index */
+char **ptr /**< Address of the string pointer */
+)
 {
 ec_eeprom_string_t *string;
 char *err_string;
 // Erst alten Speicher freigeben
 /*****************************************************************************/
 /**
 Acknowledges an error after a state transition.
+\ingroup Slave
 */
 void ec_slave_state_ack(ec_slave_t *slave, /**< EtherCAT slave */
 uint8_t state /**< previous state */
 )
 /*****************************************************************************/
 /**
 Reads the AL status code of a slave and displays it.
 If the AL status code is not supported, or if no error occurred (both
-resulting in code=0), nothing is displayed.
+resulting in code = 0), nothing is displayed.
+\ingroup Slave
 */
 void ec_slave_read_al_status_code(ec_slave_t *slave /**< EtherCAT slave */)
 {
 ec_command_t *command;
 /*****************************************************************************/
 /**
 Does a state transition.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_state_change(ec_slave_t *slave, /**< EtherCAT slave */
 uint8_t state /**< new state */
 )
 of the corresponding sync manager is covered. Seperate FMMUs arce configured
 for each domain.
 If the FMMU configuration is already prepared, the function returns with
 success.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_prepare_fmmu(ec_slave_t *slave, /**< EtherCAT slave */
 const ec_domain_t *domain, /**< domain */
 const ec_sync_t *sync  /**< sync manager */
 Outputs all information about a certain slave.
 Verbosity:
 - 0: Only slave types and addresses
 - 1: with EEPROM information
 - >1: with SDO dictionaries
+\ingroup Slave
 */
 void ec_slave_print(const ec_slave_t *slave, /**< EtherCAT slave */
 unsigned int verbosity /**< verbosity level */
 )
 /*****************************************************************************/
 /**
 Outputs the values of the CRC faoult counters and resets them.
 \return 0 in case of success, else < 0
+\ingroup Slave
 */
 int ec_slave_check_crc(ec_slave_t *slave /**< EtherCAT slave */)
 {
 ec_command_t *command;
 /*****************************************************************************/
 /**
 Writes the "configured station alias" to the slave's EEPROM.
 \return 0 in case of success, else < 0
-*/
+\ingroup Slave
+*/
-int ecrt_slave_write_alias(ec_slave_t *slave, /** EtherCAT slave */
-uint16_t alias /** new alias */
+int ecrt_slave_write_alias(ec_slave_t *slave, /**< EtherCAT slave */
+uint16_t alias /**< new alias */
 )
 {
 return ec_slave_sii_write16(slave, 0x0004, alias);
 }
 /*****************************************************************************/
 /**
 Formats attribute data for SysFS read access.
 \return number of bytes to read
+\ingroup Slave
 */
 ssize_t ec_show_slave_attribute(struct kobject *kobj, /**< slave's kobject */
 struct attribute *attr, /**< attribute */
 char *buffer /**< memory to store data */

changeset 197	b9a6e2c22745
parent 195	674071846ee3
child 199	04ecf40fc2e9