etherlabmaster: comparison master/ethernet.c

equal deleted inserted replaced

-:dac749e74956
+:1c67e19f24b8
 int ec_eoedev_tx(struct sk_buff *, struct net_device *);
 struct net_device_stats *ec_eoedev_stats(struct net_device *);
 /*****************************************************************************/
-/**
+/** EoE constructor.
-* EoE constructor.
+*
 * Initializes the EoE handler, creates a net_device and registers it.
 */
 int ec_eoe_init(
 ec_eoe_t *eoe, /**< EoE handler */
 ec_slave_t *slave /**< EtherCAT slave */
 )
 {
 return ret;
 }
 /*****************************************************************************/
-/**
+/** EoE destructor.
-EoE destructor.
+*
-Unregisteres the net_device and frees allocated memory.
+* Unregisteres the net_device and frees allocated memory.
 */
 void ec_eoe_clear(ec_eoe_t *eoe /**< EoE handler */)
 {
 unregister_netdev(eoe->dev); // possibly calls close callback
 free_netdev(eoe->dev);
 ec_datagram_clear(&eoe->datagram);
 }
 /*****************************************************************************/
-/**
+/** Empties the transmit queue.
-Empties the transmit queue.
+*/
-*/
 void ec_eoe_flush(ec_eoe_t *eoe /**< EoE handler */)
 {
 ec_eoe_frame_t *frame, *next;
 spin_lock_bh(&eoe->tx_queue_lock);
 spin_unlock_bh(&eoe->tx_queue_lock);
 }
 /*****************************************************************************/
-/**
+/** Sends a frame or the next fragment.
-Sends a frame or the next fragment.
+*/
-*/
 int ec_eoe_send(ec_eoe_t *eoe /**< EoE handler */)
 {
 size_t remaining_size, current_size, complete_offset;
 unsigned int last_fragment;
 uint8_t *data;
 return 0;
 }
 /*****************************************************************************/
-/**
+/** Runs the EoE state machine.
-Runs the EoE state machine.
+*/
-*/
 void ec_eoe_run(ec_eoe_t *eoe /**< EoE handler */)
 {
 if (!eoe->opened)
 return;
 ec_datagram_output_stats(&eoe->datagram);
 }
 /*****************************************************************************/
-/**
+/** Queues the datagram, if necessary.
-* Queues the datagram, if necessary.
+*/
-*/
 void ec_eoe_queue(ec_eoe_t *eoe /**< EoE handler */)
 {
 if (eoe->queue_datagram) {
 ec_master_queue_datagram(eoe->slave->master, &eoe->datagram);
 eoe->queue_datagram = 0;
 }
 }
 /*****************************************************************************/
-/**
+/** Returns the state of the device.
-Returns the state of the device.
+*
-\return 1 if the device is "up", 0 if it is "down"
+* \return 1 if the device is "up", 0 if it is "down"
 */
 int ec_eoe_is_open(const ec_eoe_t *eoe /**< EoE handler */)
 {
 return eoe->opened;
 }
 /******************************************************************************
 *  STATE PROCESSING FUNCTIONS
 *****************************************************************************/
-/**
+/** State: RX_START.
-State: RX_START.
+*
-Starts a new receiving sequence by queueing a datagram that checks the
+* Starts a new receiving sequence by queueing a datagram that checks the
-slave's mailbox for a new EoE datagram.
+* slave's mailbox for a new EoE datagram.
 */
 void ec_eoe_state_rx_start(ec_eoe_t *eoe /**< EoE handler */)
 {
 if (eoe->slave->error_flag || !eoe->slave->master->main_device.link_state)
 return;
 eoe->state = ec_eoe_state_rx_check;
 }
 /*****************************************************************************/
-/**
+/** State: RX_CHECK.
-State: RX_CHECK.
+*
-Processes the checking datagram sent in RX_START and issues a receive
+* Processes the checking datagram sent in RX_START and issues a receive
-datagram, if new data is available.
+* datagram, if new data is available.
 */
 void ec_eoe_state_rx_check(ec_eoe_t *eoe /**< EoE handler */)
 {
 if (eoe->datagram.state != EC_DATAGRAM_RECEIVED) {
 eoe->stats.rx_errors++;
 #if EOE_DEBUG_LEVEL >= 1
 eoe->state = ec_eoe_state_rx_fetch;
 }
 /*****************************************************************************/
-/**
+/** State: RX_FETCH.
-State: RX_FETCH.
+*
-Checks if the requested data of RX_CHECK was received and processes the
+* Checks if the requested data of RX_CHECK was received and processes the EoE
-EoE datagram.
+* datagram.
 */
 void ec_eoe_state_rx_fetch(ec_eoe_t *eoe /**< EoE handler */)
 {
 size_t rec_size, data_size;
 uint8_t *data, frame_type, last_fragment, time_appended, mbox_prot;
 uint8_t frame_number, fragment_offset, fragment_number;
 }
 }
 /*****************************************************************************/
-/**
+/** State: TX START.
-State: TX START.
+*
-Starts a new transmit sequence. If no data is available, a new receive
+* Starts a new transmit sequence. If no data is available, a new receive
-sequence is started instead.
+* sequence is started instead.
 */
 void ec_eoe_state_tx_start(ec_eoe_t *eoe /**< EoE handler */)
 {
 #if EOE_DEBUG_LEVEL >= 2
 unsigned int wakeup = 0;
 #endif
 eoe->state = ec_eoe_state_tx_sent;
 }
 /*****************************************************************************/
-/**
+/** State: TX SENT.
-State: TX SENT.
+*
-Checks is the previous transmit datagram succeded and sends the next
+* Checks is the previous transmit datagram succeded and sends the next
-fragment, if necessary.
+* fragment, if necessary.
 */
 void ec_eoe_state_tx_sent(ec_eoe_t *eoe /**< EoE handler */)
 {
 if (eoe->datagram.state != EC_DATAGRAM_RECEIVED) {
 if (eoe->tries) {
 eoe->tries--; // try again
 /******************************************************************************
 *  NET_DEVICE functions
 *****************************************************************************/
-/**
+/** Opens the virtual network device.
-Opens the virtual network device.
+*/
-*/
 int ec_eoedev_open(struct net_device *dev /**< EoE net_device */)
 {
 ec_eoe_t *eoe = *((ec_eoe_t **) netdev_priv(dev));
 ec_eoe_flush(eoe);
 eoe->opened = 1;
 return 0;
 }
 /*****************************************************************************/
-/**
+/** Stops the virtual network device.
-Stops the virtual network device.
+*/
-*/
 int ec_eoedev_stop(struct net_device *dev /**< EoE net_device */)
 {
 ec_eoe_t *eoe = *((ec_eoe_t **) netdev_priv(dev));
 netif_stop_queue(dev);
 eoe->tx_queue_active = 0;
 return 0;
 }
 /*****************************************************************************/
-/**
+/** Transmits data via the virtual network device.
-Transmits data via the virtual network device.
+*/
-*/
 int ec_eoedev_tx(struct sk_buff *skb, /**< transmit socket buffer */
 struct net_device *dev /**< EoE net_device */
 )
 {
 ec_eoe_t *eoe = *((ec_eoe_t **) netdev_priv(dev));
 return 0;
 }
 /*****************************************************************************/
-/**
+/** Gets statistics about the virtual network device.
-Gets statistics about the virtual network device.
+*/
-*/
+struct net_device_stats *ec_eoedev_stats(
+struct net_device *dev /**< EoE net_device */
-struct net_device_stats *ec_eoedev_stats(struct net_device *dev
+)
-/**< EoE net_device */)
 {
 ec_eoe_t *eoe = *((ec_eoe_t **) netdev_priv(dev));
 return &eoe->stats;
 }

changeset 1487	1c67e19f24b8
parent 1486	dac749e74956
child 1488	3fb343e3fac0