xref: /illumos-gate/usr/src/man/man9f/mac_maxsdu_update.9f (revision b31ca922c7346747131aed07c0c171ec2f573aac)
152d2369aSRobert Mustacchi.\"
252d2369aSRobert Mustacchi.\" This file and its contents are supplied under the terms of the
352d2369aSRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
452d2369aSRobert Mustacchi.\" You may only use this file in accordance with the terms of version
552d2369aSRobert Mustacchi.\" 1.0 of the CDDL.
652d2369aSRobert Mustacchi.\"
752d2369aSRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
852d2369aSRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
952d2369aSRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1052d2369aSRobert Mustacchi.\"
1152d2369aSRobert Mustacchi.\"
1252d2369aSRobert Mustacchi.\" Copyright 2016 Joyent, Inc.
1352d2369aSRobert Mustacchi.\"
1452d2369aSRobert Mustacchi.Dd June 02, 2016
1552d2369aSRobert Mustacchi.Dt MAC_MAXSDU_UPDATE 9F
1652d2369aSRobert Mustacchi.Os
1752d2369aSRobert Mustacchi.Sh NAME
1852d2369aSRobert Mustacchi.Nm mac_maxsdu_update
1952d2369aSRobert Mustacchi.Nd indicate that a device's maximum data size has changed
2052d2369aSRobert Mustacchi.Sh SYNOPSIS
2152d2369aSRobert Mustacchi.In sys/mac_provider.h
2252d2369aSRobert Mustacchi.Ft int
2352d2369aSRobert Mustacchi.Fo mac_maxsdu_update
2452d2369aSRobert Mustacchi.Fa "mac_handle_t mh"
2552d2369aSRobert Mustacchi.Fa "uint_t sdu"
2652d2369aSRobert Mustacchi.Fc
2752d2369aSRobert Mustacchi.Sh INTERFACE LEVEL
2852d2369aSRobert Mustacchiillumos DDI specific
2952d2369aSRobert Mustacchi.Sh PARAMETERS
3052d2369aSRobert Mustacchi.Bl -tag -width Fa
3152d2369aSRobert Mustacchi.It Fa mh
3252d2369aSRobert MustacchiThe MAC handle obtained from a call to
3352d2369aSRobert Mustacchi.Xr mac_register 9F .
3452d2369aSRobert Mustacchi.It Fa sdu
3552d2369aSRobert MustacchiAn integer representing the maximum size data payload.
3652d2369aSRobert Mustacchi.El
3752d2369aSRobert Mustacchi.Sh DESCRIPTION
3852d2369aSRobert MustacchiThe
3952d2369aSRobert Mustacchi.Fn mac_maxsdu_update
4052d2369aSRobert Mustacchifunction is used to inform the MAC layer that the device represented by
4152d2369aSRobert Mustacchithe handle
4252d2369aSRobert Mustacchi.Fa mh
4352d2369aSRobert Mustacchihas changed the largest size frame that it can transmit, also known as
4472d3dbb9SYuri Pankovits Send Data Unit (SDU).
4572d3dbb9SYuri PankovThis should be called when the device's MTU has been requested to be changed
4672d3dbb9SYuri Pankovwhen a driver's
47*b31ca922SChris Fraire.Xr mc_setprop 9E
4852d2369aSRobert Mustacchientry point has been called with the property
4952d2369aSRobert Mustacchi.Sy MAC_PROP_MTU
5052d2369aSRobert Mustacchior some other device-related event occurring.
5152d2369aSRobert Mustacchi.Pp
5252d2369aSRobert MustacchiThe
5352d2369aSRobert Mustacchi.Fa sdu
5452d2369aSRobert Mustacchirepresents the size of the largest payload ignoring the size of its own
5572d3dbb9SYuri Pankovheaders or any margin.
5672d3dbb9SYuri PankovFor example, for an Ethernet-based device, this size should not include the
5772d3dbb9SYuri PankovEthernet header or any VLAN tags.
5852d2369aSRobert Mustacchi.Pp
5952d2369aSRobert MustacchiThrough VNICs and other virtual data links, many different devices may
6072d3dbb9SYuri Pankovbe using a single physical device and have their own MTUs.
6172d3dbb9SYuri PankovThe system takes care of those concerns and will not ask a device driver to
6272d3dbb9SYuri Pankovupdate the MTU without verifying this.
6352d2369aSRobert Mustacchi.Sh RETURN VALUES
6452d2369aSRobert MustacchiUpon successful completion, the
6552d2369aSRobert Mustacchi.Fn mac_maxsdu_update
6652d2369aSRobert Mustacchifunction returns
6752d2369aSRobert Mustacchi.Sy 0 .
6852d2369aSRobert MustacchiOtherwise, a non-negative error is returned.
6952d2369aSRobert Mustacchi.Sh EXAMPLES
7052d2369aSRobert MustacchiFor an example of how a device driver should use the
7152d2369aSRobert Mustacchi.Fn mac_maxsdu_update
7252d2369aSRobert Mustacchifunction, see the
7352d2369aSRobert Mustacchi.Sx EXAMPLES
7452d2369aSRobert Mustacchisection in
75*b31ca922SChris Fraire.Xr mc_setprop 9E .
7652d2369aSRobert Mustacchi.Sh ERRORS
7752d2369aSRobert MustacchiThe
7852d2369aSRobert Mustacchi.Fn max_maxsdu_update
7952d2369aSRobert Mustacchifunction may fail if:
8052d2369aSRobert Mustacchi.Bl -tag -width Er
8152d2369aSRobert Mustacchi.It Er EINVAL
8252d2369aSRobert MustacchiThe specified
8352d2369aSRobert Mustacchi.Fa sdu
8452d2369aSRobert Mustacchiis lower than the minimum SDU of the device.
8552d2369aSRobert Mustacchi.El
8652d2369aSRobert Mustacchi.Sh SEE ALSO
8752d2369aSRobert Mustacchi.Xr mac 9E ,
88*b31ca922SChris Fraire.Xr mc_setprop 9E ,
8952d2369aSRobert Mustacchi.Xr mac_register 9F
90