Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: update ppp_generic.rst to document new ioctls

Add documentation of the newly-added PPPIOCBRIDGECHAN and
PPPIOCUNBRIDGECHAN ioctls.

Signed-off-by: Tom Parkin <tparkin@katalix.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Tom Parkin and committed by
David S. Miller
563b603b 4cf476ce

+16
+16
Documentation/networking/ppp_generic.rst
··· 314 314 it is connected to. It will return an EINVAL error if the channel 315 315 is not connected to an interface. 316 316 317 + * PPPIOCBRIDGECHAN bridges a channel with another. The argument should 318 + point to an int containing the channel number of the channel to bridge 319 + to. Once two channels are bridged, frames presented to one channel by 320 + ppp_input() are passed to the bridge instance for onward transmission. 321 + This allows frames to be switched from one channel into another: for 322 + example, to pass PPPoE frames into a PPPoL2TP session. Since channel 323 + bridging interrupts the normal ppp_input() path, a given channel may 324 + not be part of a bridge at the same time as being part of a unit. 325 + This ioctl will return an EALREADY error if the channel is already 326 + part of a bridge or unit, or ENXIO if the requested channel does not 327 + exist. 328 + 329 + * PPPIOCUNBRIDGECHAN performs the inverse of PPPIOCBRIDGECHAN, unbridging 330 + a channel pair. This ioctl will return an EINVAL error if the channel 331 + does not form part of a bridge. 332 + 317 333 * All other ioctl commands are passed to the channel ioctl() function. 318 334 319 335 The ioctl calls that are available on an instance that is attached to