xref: /illumos-gate/usr/src/man/man9f/mac_tx_update.9f (revision e2f4f3dab373b605b62ac175115f264a5c417eb6)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2016 Joyent, Inc.
13.\"
14.Dd June 02, 2016
15.Dt MAC_TX_UPDATE 9F
16.Os
17.Sh NAME
18.Nm mac_tx_update
19.Nd indicate that a device can transmit again
20.Sh SYNOPSIS
21.In sys/mac_provider.h
22.Ft void
23.Fo mac_tx_update
24.Fa "mac_handle_t mh"
25.Fc
26.Sh INTERFACE LEVEL
27illumos DDI specific
28.Sh PARAMETERS
29.Bl -tag -width Fa
30.It Fa mh
31The MAC handle obtained from a call to
32.Xr mac_register 9F .
33.El
34.Sh DESCRIPTION
35The
36.Fn mac_tx_update
37function is used by device drivers to indicate that the device
38represented by the handle
39.Fa mh
40can transmit data again.
41It should only be called after the device driver has returned data from its
42.Xr mc_tx 9E
43endpoint.
44For more information on when this should be called, see both
45.Xr mc_tx 9E
46and the
47.Sx Transmitting Data and Back Pressure
48section of
49.Xr mac 9E .
50.Pp
51Device drivers should not hold any of their own locks when calling into
52this function.
53See the
54.Sx MAC Callbacks
55section of
56.Xr mac 9E
57for more information.
58.Sh CONTEXT
59The
60.Fn mac_tx_update
61function may be called from
62.Sy user ,
63.Sy kernel ,
64or
65.Sy interrupt
66context.
67.Sh SEE ALSO
68.Xr mac 9E ,
69.Xr mac_tx 9E ,
70.Xr mac_register 9F
71