ethtool: allow custom interval for physical identification
[linux-2.6-block.git] / include / linux / ethtool.h
index ad22a68c2e5d9a1f843cb767141e7961aba48745..9de31274341d9929629fe999d31b7a304c5a14fc 100644 (file)
@@ -798,8 +798,10 @@ bool ethtool_invalid_flags(struct net_device *dev, u32 data, u32 supported);
  *     attached to it.  The implementation may update the indicator
  *     asynchronously or synchronously, but in either case it must return
  *     quickly.  It is initially called with the argument %ETHTOOL_ID_ACTIVE,
- *     and must either activate asynchronous updates or return -%EINVAL.
- *     If it returns -%EINVAL then it will be called again at intervals with
+ *     and must either activate asynchronous updates and return zero, return
+ *     a negative error or return a positive frequency for synchronous
+ *     indication (e.g. 1 for one on/off cycle per second).  If it returns
+ *     a frequency then it will be called again at intervals with the
  *     argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
  *     the indicator accordingly.  Finally, it is called with the argument
  *     %ETHTOOL_ID_INACTIVE and must deactivate the indicator.  Returns a