Commit e1bd1dc2 authored by Ben Hutchings's avatar Ben Hutchings
Browse files

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.

Signed-off-by: default avatarBen Hutchings <bhutchings@solarflare.com>
parent 018c5bba

include/uapi/linux/net_tstamp.h

+5 −5
Original line number Original line Diff line number Diff line
@@ -30,13 +30,13 @@ enum { 
 *

 *

 * @flags:	no flags defined right now, must be zero

 * @flags:	no flags defined right now, must be zero

 * @tx_type:	one of HWTSTAMP_TX_*

 * @tx_type:	one of HWTSTAMP_TX_*

 * @rx_type:	one of one of HWTSTAMP_FILTER_*

 * @rx_filter:	one of HWTSTAMP_FILTER_*

 *

 *

 * %SIOCSHWTSTAMP expects a &struct ifreq with a ifr_data pointer to

 * %SIOCSHWTSTAMP expects a &struct ifreq with a ifr_data pointer to

 * this structure. dev_ifsioc() in the kernel takes care of the

 * this structure.  If the driver or hardware does not support the

 * translation between 32 bit userspace and 64 bit kernel. The

 * requested @rx_filter value, the driver may use a more general

 * structure is intentionally chosen so that it has the same layout on

 * filter mode.  In this case @rx_filter will indicate the actual mode

 * 32 and 64 bit systems, don't break this!

 * on return.

 */

 */

struct hwtstamp_config {

struct hwtstamp_config {

	int flags;

	int flags;