net_tstamp: Improve kernel-doc for struct hwtstamp_config

Fix the name of the rx_filter field. Remove text about 32/64-bit compatibility; this works just the same as for most socket ioctls and as the structure is not allowed to grow there is no need to remind anyone how to maintain it. Add explanation about drivers changing the filter mode.

Ben Hutchings committed 13 years ago

Commit e1bd1dc1 parent 018c5bb1 file · +5 −5Browse files

Showing the changes to include/uapi/linux (1 of 1 file). Show all

Unified · Split

include/uapi/linux/net_tstamp.h+5−5

@@ -30,13 +30,13 @@ enum { · 29 unmodified lines
30	*	30	*
31	* @flags: no flags defined right now, must be zero	31	* @flags: no flags defined right now, must be zero
32	* @tx_type: one of HWTSTAMP_TX_*	32	* @tx_type: one of HWTSTAMP_TX_*
33	* @rx_type: one of one of HWTSTAMP_FILTER_*	33	* @rx_filter: one of HWTSTAMP_FILTER_*
34	*	34	*
35	* %SIOCSHWTSTAMP expects a &struct ifreq with a ifr_data pointer to	35	* %SIOCSHWTSTAMP expects a &struct ifreq with a ifr_data pointer to
36	* this structure. dev_ifsioc() in the kernel takes care of the	36	* this structure. If the driver or hardware does not support the
37	* translation between 32 bit userspace and 64 bit kernel. The	37	* requested @rx_filter value, the driver may use a more general
38	* structure is intentionally chosen so that it has the same layout on	38	* filter mode. In this case @rx_filter will indicate the actual mode
39	* 32 and 64 bit systems, don't break this!	39	* on return.
40	*/	40	*/
41	struct hwtstamp_config {	41	struct hwtstamp_config {
42	int flags;	42	int flags;