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
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.
12 .\" Copyright 2016 Joyent, Inc.
19 .Nd modify device promiscuous mode entry point
21 .In sys/mac_provider.h
23 .Fo prefix_m_setpromisc
25 .Fa "boolean_t enable"
32 A pointer to the driver's private data that was passed in via the
40 A boolean that indicates the desired state of the device's promiscuous
43 promiscuous mode should be enabled on the device. If set to
45 then promiscuous mode should be disabled on the device.
50 entry point is called when the GLDv3 wants to change the device's
51 promiscuous mode. When this entry point is called, the device should
52 manipulate both its unicast and multicast promiscuous mode.
56 is true, then it should make sure that both unicast and multicast
57 promiscuous mode are enabled. When it's set to false, then they should
58 be disabled. In general, devices should always start with promiscuous
59 mode disabled until the framework indicates that it should be enabled.
61 The device driver's private state is available by casting the
63 argument to the function. Note, this entry point may be called in
64 parallel with others and therefore the device driver should employ any
65 necessary locking on that structure.
67 Upon successful completion, the device driver's
69 entry point should return
71 after having set the device's state. Otherwise, it should return a
72 non-zero positive error number to indicate the error that occurred.
74 The device driver may return one of the following errors. While this list
75 is not intended to be exhaustive, it is recommended to use one of these
79 The driver encountered a device or transport error while trying to
80 update the device's state.