etherlabmaster: comparison master/device.c

equal deleted inserted replaced

-:6672b86e7b10
+:a0759d0dded4
 } while (0)
 #endif
 /*****************************************************************************/
-/**
+/** Constructor.
-Device constructor.
+*
-\return 0 in case of success, else < 0
+* \return 0 in case of success, else < 0
 */
+int ec_device_init(
-int ec_device_init(ec_device_t *device, /**< EtherCAT device */
+ec_device_t *device, /**< EtherCAT device */
 ec_master_t *master /**< master owning the device */
 )
 {
 unsigned int i;
 struct ethhdr *eth;
 return -1;
 }
 /*****************************************************************************/
-/**
+/** Destuctor.
-EtherCAT device destuctor.
+*/
-*/
+void ec_device_clear(
+ec_device_t *device /**< EtherCAT device */
-void ec_device_clear(ec_device_t *device /**< EtherCAT device */)
+)
 {
 unsigned int i;
 if (device->open) ec_device_close(device);
 for (i = 0; i < EC_TX_RING_SIZE; i++)
 #endif
 }
 /*****************************************************************************/
-/**
+/** Associate with net_device.
-Associate with net_device.
+*/
-*/
+void ec_device_attach(
+ec_device_t *device, /**< EtherCAT device */
-void ec_device_attach(ec_device_t *device, /**< EtherCAT device */
 struct net_device *net_dev, /**< net_device structure */
 ec_pollfunc_t poll, /**< pointer to device's poll function */
 struct module *module /**< the device's module */
 )
 {
 }
 }
 /*****************************************************************************/
-/**
+/** Disconnect from net_device.
-Disconnect from net_device.
+*/
-*/
+void ec_device_detach(
+ec_device_t *device /**< EtherCAT device */
-void ec_device_detach(ec_device_t *device /**< EtherCAT device */)
+)
 {
 unsigned int i;
 device->dev = NULL;
 device->poll = NULL;
 device->tx_skb[i]->dev = NULL;
 }
 /*****************************************************************************/
-/**
+/** Opens the EtherCAT device.
-Opens the EtherCAT device.
+*
-\return 0 in case of success, else < 0
+* \return 0 in case of success, else < 0
 */
+int ec_device_open(
-int ec_device_open(ec_device_t *device /**< EtherCAT device */)
+ec_device_t *device /**< EtherCAT device */
+)
 {
 if (!device->dev) {
 EC_ERR("No net_device to open!\n");
 return -1;
 }
 return device->open ? 0 : -1;
 }
 /*****************************************************************************/
-/**
+/** Stops the EtherCAT device.
-Stops the EtherCAT device.
+*
-\return 0 in case of success, else < 0
+* \return 0 in case of success, else < 0
 */
+int ec_device_close(
-int ec_device_close(ec_device_t *device /**< EtherCAT device */)
+ec_device_t *device /**< EtherCAT device */
+)
 {
 if (!device->dev) {
 EC_ERR("No device to close!\n");
 return -1;
 }
 return !device->open ? 0 : -1;
 }
 /*****************************************************************************/
-/**
+/** Returns a pointer to the device's transmit memory.
-Returns a pointer to the device's transmit memory.
+*
-\return pointer to the TX socket buffer
+* \return pointer to the TX socket buffer
 */
+uint8_t *ec_device_tx_data(
-uint8_t *ec_device_tx_data(ec_device_t *device /**< EtherCAT device */)
+ec_device_t *device /**< EtherCAT device */
+)
 {
 /* cycle through socket buffers, because otherwise there is a race
 * condition, if multiple frames are sent and the DMA is not scheduled in
 * between. */
 device->tx_ring_index++;
 return device->tx_skb[device->tx_ring_index]->data + ETH_HLEN;
 }
 /*****************************************************************************/
-/**
+/** Sends the content of the transmit socket buffer.
-Sends the content of the transmit socket buffer.
+*
-Cuts the socket buffer content to the (now known) size, and calls the
+* Cuts the socket buffer content to the (now known) size, and calls the
-start_xmit() function of the assigned net_device.
+* start_xmit() function of the assigned net_device.
 */
+void ec_device_send(
-void ec_device_send(ec_device_t *device, /**< EtherCAT device */
+ec_device_t *device, /**< EtherCAT device */
 size_t size /**< number of bytes to send */
 )
 {
 struct sk_buff *skb = device->tx_skb[device->tx_ring_index];
 if (unlikely(!device->link_state)) // Link down
 return;
 }
 /*****************************************************************************/
 #ifdef EC_DEBUG_RING
-/**
+/** Appends frame data to the debug ring.
-* Appends frame data to the debug ring.
+*/
-*/
 void ec_device_debug_ring_append(
 ec_device_t *device, /**< EtherCAT device */
 ec_debug_frame_dir_t dir, /**< direction */
 const void *data, /**< frame data */
 size_t size /**< data size */
 device->debug_frame_count++;
 }
 /*****************************************************************************/
-/**
+/** Outputs the debug ring.
-* Outputs the debug ring.
+*/
-*/
 void ec_device_debug_ring_print(
 const ec_device_t *device /**< EtherCAT device */
 )
 {
 int i;
 }
 #endif
 /*****************************************************************************/
-/**
+/** Calls the poll function of the assigned net_device.
-Calls the poll function of the assigned net_device.
+*
-The master itself works without using interrupts. Therefore the processing
+* The master itself works without using interrupts. Therefore the processing
-of received data and status changes of the network device has to be
+* of received data and status changes of the network device has to be
-done by the master calling the ISR "manually".
+* done by the master calling the ISR "manually".
 */
+void ec_device_poll(
-void ec_device_poll(ec_device_t *device /**< EtherCAT device */)
+ec_device_t *device /**< EtherCAT device */
+)
 {
 device->cycles_poll = get_cycles();
 device->jiffies_poll = jiffies;
 #ifdef EC_DEBUG_RING
 do_gettimeofday(&device->timeval_poll);
 /******************************************************************************
 *  Device interface
 *****************************************************************************/
-/**
+/** Withdraws an EtherCAT device from the master.
-Accepts a received frame.
+*
-Forwards the received data to the master. The master will analyze the frame
+* The device is disconnected from the master and all device ressources
-and dispatch the received commands to the sending instances.
+* are freed.
-\ingroup DeviceInterface
+*
-*/
+* \attention Before calling this function, the ecdev_stop() function has
+*            to be called, to be sure that the master does not use the device
-void ecdev_receive(ec_device_t *device, /**< EtherCAT device */
+*            any more.
-const void *data, /**< pointer to received data */
+* \ingroup DeviceInterface
-size_t size /**< number of bytes received */
+*/
-)
+void ecdev_withdraw(ec_device_t *device /**< EtherCAT device */)
+{
+ec_master_t *master = device->master;
+char str[20];
+ec_mac_print(device->dev->dev_addr, str);
+EC_INFO("Master %u releasing main device %s.\n", master->index, str);
+down(&master->device_sem);
+ec_device_detach(device);
+up(&master->device_sem);
+}
+/*****************************************************************************/
+/** Opens the network device and makes the master enter IDLE mode.
+*
+* \return 0 on success, else < 0
+* \ingroup DeviceInterface
+*/
+int ecdev_open(ec_device_t *device /**< EtherCAT device */)
+{
+if (ec_device_open(device)) {
+EC_ERR("Failed to open device!\n");
+return -1;
+}
+if (ec_master_enter_idle_mode(device->master)) {
+EC_ERR("Failed to enter idle mode!\n");
+return -1;
+}
+return 0;
+}
+/*****************************************************************************/
+/** Makes the master leave IDLE mode and closes the network device.
+*
+* \return 0 on success, else < 0
+* \ingroup DeviceInterface
+*/
+void ecdev_close(ec_device_t *device /**< EtherCAT device */)
+{
+ec_master_leave_idle_mode(device->master);
+if (ec_device_close(device))
+EC_WARN("Failed to close device!\n");
+}
+/*****************************************************************************/
+/** Accepts a received frame.
+*
+* Forwards the received data to the master. The master will analyze the frame
+* and dispatch the received commands to the sending instances.
+*
+* \ingroup DeviceInterface
+*/
+void ecdev_receive(
+ec_device_t *device, /**< EtherCAT device */
+const void *data, /**< pointer to received data */
+size_t size /**< number of bytes received */
+)
 {
 const void *ec_data = data + ETH_HLEN;
 size_t ec_size = size - ETH_HLEN;
 device->rx_count++;
 ec_master_receive_datagrams(device->master, ec_data, ec_size);
 }
 /*****************************************************************************/
-/**
+/** Sets a new link state.
-Sets a new link state.
+*
-If the device notifies the master about the link being down, the master
+* If the device notifies the master about the link being down, the master
-will not try to send frames using this device.
+* will not try to send frames using this device.
-\ingroup DeviceInterface
+*
-*/
+* \ingroup DeviceInterface
+*/
-void ecdev_set_link(ec_device_t *device, /**< EtherCAT device */
+void ecdev_set_link(
+ec_device_t *device, /**< EtherCAT device */
 uint8_t state /**< new link state */
 )
 {
 if (unlikely(!device)) {
-EC_WARN("ecdev_link_state: no device!\n");
+EC_WARN("ecdev_set_link(): No device!\n");
 return;
 }
 if (likely(state != device->link_state)) {
 device->link_state = state;
 }
 }
 /*****************************************************************************/
-/**
+/** Reads the link state.
-Reads the link state.
+*
-\ingroup DeviceInterface
+* \ingroup DeviceInterface
 */
+uint8_t ecdev_get_link(
-uint8_t ecdev_get_link(ec_device_t *device /**< EtherCAT device */)
+const ec_device_t *device /**< EtherCAT device */
+)
 {
 if (unlikely(!device)) {
-EC_WARN("ecdev_link_state: no device!\n");
+EC_WARN("ecdev_get_link(): No device!\n");
 return 0;
 }
 return device->link_state;
 }
 /*****************************************************************************/
 /** \cond */
+EXPORT_SYMBOL(ecdev_withdraw);
+EXPORT_SYMBOL(ecdev_open);
+EXPORT_SYMBOL(ecdev_close);
 EXPORT_SYMBOL(ecdev_receive);
 EXPORT_SYMBOL(ecdev_get_link);
 EXPORT_SYMBOL(ecdev_set_link);
 /** \endcond */

changeset 1011	a0759d0dded4
parent 986	a486591ba86b
child 1029	61ffe5f22306