Commit efaa7474 authored by Sam Ravnborg's avatar Sam Ravnborg

docbook: Recognize sis900 functions

Adapted comments to follow what kernel-doc (docbook) understands
parent 7ec25fab
...@@ -211,7 +211,7 @@ static void sis900_auto_negotiate(struct net_device *net_dev, int phy_addr); ...@@ -211,7 +211,7 @@ static void sis900_auto_negotiate(struct net_device *net_dev, int phy_addr);
static void sis900_set_mode (long ioaddr, int speed, int duplex); static void sis900_set_mode (long ioaddr, int speed, int duplex);
/** /**
* sis900_get_mac_addr: - Get MAC address for stand alone SiS900 model * sis900_get_mac_addr - Get MAC address for stand alone SiS900 model
* @pci_dev: the sis900 pci device * @pci_dev: the sis900 pci device
* @net_dev: the net device to get address for * @net_dev: the net device to get address for
* *
...@@ -241,7 +241,7 @@ static int __devinit sis900_get_mac_addr(struct pci_dev * pci_dev, struct net_de ...@@ -241,7 +241,7 @@ static int __devinit sis900_get_mac_addr(struct pci_dev * pci_dev, struct net_de
} }
/** /**
* sis630e_get_mac_addr: - Get MAC address for SiS630E model * sis630e_get_mac_addr - Get MAC address for SiS630E model
* @pci_dev: the sis900 pci device * @pci_dev: the sis900 pci device
* @net_dev: the net device to get address for * @net_dev: the net device to get address for
* *
...@@ -274,7 +274,7 @@ static int __devinit sis630e_get_mac_addr(struct pci_dev * pci_dev, struct net_d ...@@ -274,7 +274,7 @@ static int __devinit sis630e_get_mac_addr(struct pci_dev * pci_dev, struct net_d
/** /**
* sis635_get_mac_addr: - Get MAC address for SIS635 model * sis635_get_mac_addr - Get MAC address for SIS635 model
* @pci_dev: the sis900 pci device * @pci_dev: the sis900 pci device
* @net_dev: the net device to get address for * @net_dev: the net device to get address for
* *
...@@ -310,7 +310,7 @@ static int __devinit sis635_get_mac_addr(struct pci_dev * pci_dev, struct net_de ...@@ -310,7 +310,7 @@ static int __devinit sis635_get_mac_addr(struct pci_dev * pci_dev, struct net_de
} }
/** /**
* sis96x_get_mac_addr: - Get MAC address for SiS962 or SiS963 model * sis96x_get_mac_addr - Get MAC address for SiS962 or SiS963 model
* @pci_dev: the sis900 pci device * @pci_dev: the sis900 pci device
* @net_dev: the net device to get address for * @net_dev: the net device to get address for
* *
...@@ -352,7 +352,7 @@ static int __devinit sis96x_get_mac_addr(struct pci_dev * pci_dev, struct net_de ...@@ -352,7 +352,7 @@ static int __devinit sis96x_get_mac_addr(struct pci_dev * pci_dev, struct net_de
} }
/** /**
* sis900_probe: - Probe for sis900 device * sis900_probe - Probe for sis900 device
* @pci_dev: the sis900 pci device * @pci_dev: the sis900 pci device
* @pci_id: the pci device ID * @pci_id: the pci device ID
* *
...@@ -498,7 +498,7 @@ static int __devinit sis900_probe (struct pci_dev *pci_dev, const struct pci_dev ...@@ -498,7 +498,7 @@ static int __devinit sis900_probe (struct pci_dev *pci_dev, const struct pci_dev
} }
/** /**
* sis900_mii_probe: - Probe MII PHY for sis900 * sis900_mii_probe - Probe MII PHY for sis900
* @net_dev: the net device to probe for * @net_dev: the net device to probe for
* *
* Search for total of 32 possible mii phy addresses. * Search for total of 32 possible mii phy addresses.
...@@ -618,7 +618,7 @@ static int __init sis900_mii_probe (struct net_device * net_dev) ...@@ -618,7 +618,7 @@ static int __init sis900_mii_probe (struct net_device * net_dev)
} }
/** /**
* sis900_default_phy: - Select default PHY for sis900 mac. * sis900_default_phy - Select default PHY for sis900 mac.
* @net_dev: the net device to probe for * @net_dev: the net device to probe for
* *
* Select first detected PHY with link as default. * Select first detected PHY with link as default.
...@@ -671,7 +671,7 @@ static u16 sis900_default_phy(struct net_device * net_dev) ...@@ -671,7 +671,7 @@ static u16 sis900_default_phy(struct net_device * net_dev)
/** /**
* sis900_set_capability: - set the media capability of network adapter. * sis900_set_capability - set the media capability of network adapter.
* @net_dev : the net device to probe for * @net_dev : the net device to probe for
* @phy : default PHY * @phy : default PHY
* *
...@@ -701,7 +701,7 @@ static void sis900_set_capability( struct net_device *net_dev , struct mii_phy * ...@@ -701,7 +701,7 @@ static void sis900_set_capability( struct net_device *net_dev , struct mii_phy *
#define eeprom_delay() inl(ee_addr) #define eeprom_delay() inl(ee_addr)
/** /**
* read_eeprom: - Read Serial EEPROM * read_eeprom - Read Serial EEPROM
* @ioaddr: base i/o address * @ioaddr: base i/o address
* @location: the EEPROM location to read * @location: the EEPROM location to read
* *
...@@ -776,7 +776,7 @@ static void mdio_reset(long mdio_addr) ...@@ -776,7 +776,7 @@ static void mdio_reset(long mdio_addr)
} }
/** /**
* mdio_read: - read MII PHY register * mdio_read - read MII PHY register
* @net_dev: the net device to read * @net_dev: the net device to read
* @phy_id: the phy address to read * @phy_id: the phy address to read
* @location: the phy regiester id to read * @location: the phy regiester id to read
...@@ -818,7 +818,7 @@ static u16 mdio_read(struct net_device *net_dev, int phy_id, int location) ...@@ -818,7 +818,7 @@ static u16 mdio_read(struct net_device *net_dev, int phy_id, int location)
} }
/** /**
* mdio_write: - write MII PHY register * mdio_write - write MII PHY register
* @net_dev: the net device to write * @net_dev: the net device to write
* @phy_id: the phy address to write * @phy_id: the phy address to write
* @location: the phy regiester id to write * @location: the phy regiester id to write
...@@ -872,7 +872,7 @@ static void mdio_write(struct net_device *net_dev, int phy_id, int location, int ...@@ -872,7 +872,7 @@ static void mdio_write(struct net_device *net_dev, int phy_id, int location, int
/** /**
* sis900_reset_phy: - reset sis900 mii phy. * sis900_reset_phy - reset sis900 mii phy.
* @net_dev: the net device to write * @net_dev: the net device to write
* @phy_addr: default phy address * @phy_addr: default phy address
* *
...@@ -895,7 +895,7 @@ static u16 sis900_reset_phy(struct net_device *net_dev, int phy_addr) ...@@ -895,7 +895,7 @@ static u16 sis900_reset_phy(struct net_device *net_dev, int phy_addr)
} }
/** /**
* sis900_open: - open sis900 device * sis900_open - open sis900 device
* @net_dev: the net device to open * @net_dev: the net device to open
* *
* Do some initialization and start net interface. * Do some initialization and start net interface.
...@@ -952,7 +952,7 @@ sis900_open(struct net_device *net_dev) ...@@ -952,7 +952,7 @@ sis900_open(struct net_device *net_dev)
} }
/** /**
* sis900_init_rxfilter: - Initialize the Rx filter * sis900_init_rxfilter - Initialize the Rx filter
* @net_dev: the net device to initialize for * @net_dev: the net device to initialize for
* *
* Set receive filter address to our MAC address * Set receive filter address to our MAC address
...@@ -990,7 +990,7 @@ sis900_init_rxfilter (struct net_device * net_dev) ...@@ -990,7 +990,7 @@ sis900_init_rxfilter (struct net_device * net_dev)
} }
/** /**
* sis900_init_tx_ring: - Initialize the Tx descriptor ring * sis900_init_tx_ring - Initialize the Tx descriptor ring
* @net_dev: the net device to initialize for * @net_dev: the net device to initialize for
* *
* Initialize the Tx descriptor ring, * Initialize the Tx descriptor ring,
...@@ -1023,7 +1023,7 @@ sis900_init_tx_ring(struct net_device *net_dev) ...@@ -1023,7 +1023,7 @@ sis900_init_tx_ring(struct net_device *net_dev)
} }
/** /**
* sis900_init_rx_ring: - Initialize the Rx descriptor ring * sis900_init_rx_ring - Initialize the Rx descriptor ring
* @net_dev: the net device to initialize for * @net_dev: the net device to initialize for
* *
* Initialize the Rx descriptor ring, * Initialize the Rx descriptor ring,
...@@ -1077,7 +1077,7 @@ sis900_init_rx_ring(struct net_device *net_dev) ...@@ -1077,7 +1077,7 @@ sis900_init_rx_ring(struct net_device *net_dev)
} }
/** /**
* sis630_set_eq: - set phy equalizer value for 630 LAN * sis630_set_eq - set phy equalizer value for 630 LAN
* @net_dev: the net device to set equalizer value * @net_dev: the net device to set equalizer value
* @revision: 630 LAN revision number * @revision: 630 LAN revision number
* *
...@@ -1165,7 +1165,7 @@ static void sis630_set_eq(struct net_device *net_dev, u8 revision) ...@@ -1165,7 +1165,7 @@ static void sis630_set_eq(struct net_device *net_dev, u8 revision)
} }
/** /**
* sis900_timer: - sis900 timer routine * sis900_timer - sis900 timer routine
* @data: pointer to sis900 net device * @data: pointer to sis900 net device
* *
* On each timer ticks we check two things, * On each timer ticks we check two things,
...@@ -1235,7 +1235,7 @@ static void sis900_timer(unsigned long data) ...@@ -1235,7 +1235,7 @@ static void sis900_timer(unsigned long data)
} }
/** /**
* sis900_check_mode: - check the media mode for sis900 * sis900_check_mode - check the media mode for sis900
* @net_dev: the net device to be checked * @net_dev: the net device to be checked
* @mii_phy: the mii phy * @mii_phy: the mii phy
* *
...@@ -1266,7 +1266,7 @@ static void sis900_check_mode (struct net_device *net_dev, struct mii_phy *mii_p ...@@ -1266,7 +1266,7 @@ static void sis900_check_mode (struct net_device *net_dev, struct mii_phy *mii_p
} }
/** /**
* sis900_set_mode: - Set the media mode of mac register. * sis900_set_mode - Set the media mode of mac register.
* @ioaddr: the address of the device * @ioaddr: the address of the device
* @speed : the transmit speed to be determined * @speed : the transmit speed to be determined
* @duplex: the duplex mode to be determined * @duplex: the duplex mode to be determined
...@@ -1310,7 +1310,7 @@ static void sis900_set_mode (long ioaddr, int speed, int duplex) ...@@ -1310,7 +1310,7 @@ static void sis900_set_mode (long ioaddr, int speed, int duplex)
} }
/** /**
* sis900_auto_negotiate: Set the Auto-Negotiation Enable/Reset bit. * sis900_auto_negotiate - Set the Auto-Negotiation Enable/Reset bit.
* @net_dev: the net device to read mode for * @net_dev: the net device to read mode for
* @phy_addr: mii phy address * @phy_addr: mii phy address
* *
...@@ -1344,7 +1344,7 @@ static void sis900_auto_negotiate(struct net_device *net_dev, int phy_addr) ...@@ -1344,7 +1344,7 @@ static void sis900_auto_negotiate(struct net_device *net_dev, int phy_addr)
/** /**
* sis900_read_mode: - read media mode for sis900 internal phy * sis900_read_mode - read media mode for sis900 internal phy
* @net_dev: the net device to read mode for * @net_dev: the net device to read mode for
* @speed : the transmit speed to be determined * @speed : the transmit speed to be determined
* @duplex : the duplex mode to be determined * @duplex : the duplex mode to be determined
...@@ -1401,7 +1401,7 @@ static void sis900_read_mode(struct net_device *net_dev, int *speed, int *duplex ...@@ -1401,7 +1401,7 @@ static void sis900_read_mode(struct net_device *net_dev, int *speed, int *duplex
} }
/** /**
* sis900_tx_timeout: - sis900 transmit timeout routine * sis900_tx_timeout - sis900 transmit timeout routine
* @net_dev: the net device to transmit * @net_dev: the net device to transmit
* *
* print transmit timeout status * print transmit timeout status
...@@ -1456,7 +1456,7 @@ static void sis900_tx_timeout(struct net_device *net_dev) ...@@ -1456,7 +1456,7 @@ static void sis900_tx_timeout(struct net_device *net_dev)
} }
/** /**
* sis900_start_xmit: - sis900 start transmit routine * sis900_start_xmit - sis900 start transmit routine
* @skb: socket buffer pointer to put the data being transmitted * @skb: socket buffer pointer to put the data being transmitted
* @net_dev: the net device to transmit with * @net_dev: the net device to transmit with
* *
...@@ -1526,7 +1526,7 @@ sis900_start_xmit(struct sk_buff *skb, struct net_device *net_dev) ...@@ -1526,7 +1526,7 @@ sis900_start_xmit(struct sk_buff *skb, struct net_device *net_dev)
} }
/** /**
* sis900_interrupt: - sis900 interrupt handler * sis900_interrupt - sis900 interrupt handler
* @irq: the irq number * @irq: the irq number
* @dev_instance: the client data object * @dev_instance: the client data object
* @regs: snapshot of processor context * @regs: snapshot of processor context
...@@ -1587,7 +1587,7 @@ static irqreturn_t sis900_interrupt(int irq, void *dev_instance, struct pt_regs ...@@ -1587,7 +1587,7 @@ static irqreturn_t sis900_interrupt(int irq, void *dev_instance, struct pt_regs
} }
/** /**
* sis900_rx: - sis900 receive routine * sis900_rx - sis900 receive routine
* @net_dev: the net device which receives data * @net_dev: the net device which receives data
* *
* Process receive interrupt events, * Process receive interrupt events,
...@@ -1726,7 +1726,7 @@ static int sis900_rx(struct net_device *net_dev) ...@@ -1726,7 +1726,7 @@ static int sis900_rx(struct net_device *net_dev)
} }
/** /**
* sis900_finish_xmit: - finish up transmission of packets * sis900_finish_xmit - finish up transmission of packets
* @net_dev: the net device to be transmitted on * @net_dev: the net device to be transmitted on
* *
* Check for error condition and free socket buffer etc * Check for error condition and free socket buffer etc
...@@ -1796,7 +1796,7 @@ static void sis900_finish_xmit (struct net_device *net_dev) ...@@ -1796,7 +1796,7 @@ static void sis900_finish_xmit (struct net_device *net_dev)
} }
/** /**
* sis900_close: - close sis900 device * sis900_close - close sis900 device
* @net_dev: the net device to be closed * @net_dev: the net device to be closed
* *
* Disable interrupts, stop the Tx and Rx Status Machine * Disable interrupts, stop the Tx and Rx Status Machine
...@@ -1852,7 +1852,7 @@ sis900_close(struct net_device *net_dev) ...@@ -1852,7 +1852,7 @@ sis900_close(struct net_device *net_dev)
} }
/** /**
* netdev_ethtool_ioctl: - For the basic support of ethtool * netdev_ethtool_ioctl - For the basic support of ethtool
* @net_dev: the net device to command for * @net_dev: the net device to command for
* @useraddr: start address of interface request * @useraddr: start address of interface request
* *
...@@ -1886,7 +1886,7 @@ static int netdev_ethtool_ioctl (struct net_device *net_dev, void *useraddr) ...@@ -1886,7 +1886,7 @@ static int netdev_ethtool_ioctl (struct net_device *net_dev, void *useraddr)
} }
/** /**
* mii_ioctl: - process MII i/o control command * mii_ioctl - process MII i/o control command
* @net_dev: the net device to command for * @net_dev: the net device to command for
* @rq: parameter for command * @rq: parameter for command
* @cmd: the i/o command * @cmd: the i/o command
...@@ -1922,7 +1922,7 @@ static int mii_ioctl(struct net_device *net_dev, struct ifreq *rq, int cmd) ...@@ -1922,7 +1922,7 @@ static int mii_ioctl(struct net_device *net_dev, struct ifreq *rq, int cmd)
} }
/** /**
* sis900_get_stats: - Get sis900 read/write statistics * sis900_get_stats - Get sis900 read/write statistics
* @net_dev: the net device to get statistics for * @net_dev: the net device to get statistics for
* *
* get tx/rx statistics for sis900 * get tx/rx statistics for sis900
...@@ -1937,7 +1937,7 @@ sis900_get_stats(struct net_device *net_dev) ...@@ -1937,7 +1937,7 @@ sis900_get_stats(struct net_device *net_dev)
} }
/** /**
* sis900_set_config: - Set media type by net_device.set_config * sis900_set_config - Set media type by net_device.set_config
* @dev: the net device for media type change * @dev: the net device for media type change
* @map: ifmap passed by ifconfig * @map: ifmap passed by ifconfig
* *
...@@ -2034,7 +2034,7 @@ static int sis900_set_config(struct net_device *dev, struct ifmap *map) ...@@ -2034,7 +2034,7 @@ static int sis900_set_config(struct net_device *dev, struct ifmap *map)
} }
/** /**
* sis900_mcast_bitnr: - compute hashtable index * sis900_mcast_bitnr - compute hashtable index
* @addr: multicast address * @addr: multicast address
* @revision: revision id of chip * @revision: revision id of chip
* *
...@@ -2057,7 +2057,7 @@ static inline u16 sis900_mcast_bitnr(u8 *addr, u8 revision) ...@@ -2057,7 +2057,7 @@ static inline u16 sis900_mcast_bitnr(u8 *addr, u8 revision)
} }
/** /**
* set_rx_mode: - Set SiS900 receive mode * set_rx_mode - Set SiS900 receive mode
* @net_dev: the net device to be set * @net_dev: the net device to be set
* *
* Set SiS900 receive mode for promiscuous, multicast, or broadcast mode. * Set SiS900 receive mode for promiscuous, multicast, or broadcast mode.
...@@ -2131,7 +2131,7 @@ static void set_rx_mode(struct net_device *net_dev) ...@@ -2131,7 +2131,7 @@ static void set_rx_mode(struct net_device *net_dev)
} }
/** /**
* sis900_reset: - Reset sis900 MAC * sis900_reset - Reset sis900 MAC
* @net_dev: the net device to reset * @net_dev: the net device to reset
* *
* reset sis900 MAC and wait until finished * reset sis900 MAC and wait until finished
...@@ -2166,7 +2166,7 @@ static void sis900_reset(struct net_device *net_dev) ...@@ -2166,7 +2166,7 @@ static void sis900_reset(struct net_device *net_dev)
} }
/** /**
* sis900_remove: - Remove sis900 device * sis900_remove - Remove sis900 device
* @pci_dev: the pci device to be removed * @pci_dev: the pci device to be removed
* *
* remove and release SiS900 net device * remove and release SiS900 net device
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment