1*2db8abf0SDonald Hunter.. SPDX-License-Identifier: BSD-3-Clause
2*2db8abf0SDonald Hunter
3*2db8abf0SDonald Hunter======================================================
4*2db8abf0SDonald HunterNetlink specification support for raw Netlink families
5*2db8abf0SDonald Hunter======================================================
6*2db8abf0SDonald Hunter
7*2db8abf0SDonald HunterThis document describes the additional properties required by raw Netlink
8*2db8abf0SDonald Hunterfamilies such as ``NETLINK_ROUTE`` which use the ``netlink-raw`` protocol
9*2db8abf0SDonald Hunterspecification.
10*2db8abf0SDonald Hunter
11*2db8abf0SDonald HunterSpecification
12*2db8abf0SDonald Hunter=============
13*2db8abf0SDonald Hunter
14*2db8abf0SDonald HunterThe netlink-raw schema extends the :doc:`genetlink-legacy <genetlink-legacy>`
15*2db8abf0SDonald Hunterschema with properties that are needed to specify the protocol numbers and
16*2db8abf0SDonald Huntermulticast IDs used by raw netlink families. See :ref:`classic_netlink` for more
17*2db8abf0SDonald Hunterinformation.
18*2db8abf0SDonald Hunter
19*2db8abf0SDonald HunterGlobals
20*2db8abf0SDonald Hunter-------
21*2db8abf0SDonald Hunter
22*2db8abf0SDonald Hunterprotonum
23*2db8abf0SDonald Hunter~~~~~~~~
24*2db8abf0SDonald Hunter
25*2db8abf0SDonald HunterThe ``protonum`` property is used to specify the protocol number to use when
26*2db8abf0SDonald Hunteropening a netlink socket.
27*2db8abf0SDonald Hunter
28*2db8abf0SDonald Hunter.. code-block:: yaml
29*2db8abf0SDonald Hunter
30*2db8abf0SDonald Hunter  # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
31*2db8abf0SDonald Hunter
32*2db8abf0SDonald Hunter  name: rt-addr
33*2db8abf0SDonald Hunter  protocol: netlink-raw
34*2db8abf0SDonald Hunter  protonum: 0             # part of the NETLINK_ROUTE protocol
35*2db8abf0SDonald Hunter
36*2db8abf0SDonald Hunter
37*2db8abf0SDonald HunterMulticast group properties
38*2db8abf0SDonald Hunter--------------------------
39*2db8abf0SDonald Hunter
40*2db8abf0SDonald Huntervalue
41*2db8abf0SDonald Hunter~~~~~
42*2db8abf0SDonald Hunter
43*2db8abf0SDonald HunterThe ``value`` property is used to specify the group ID to use for multicast
44*2db8abf0SDonald Huntergroup registration.
45*2db8abf0SDonald Hunter
46*2db8abf0SDonald Hunter.. code-block:: yaml
47*2db8abf0SDonald Hunter
48*2db8abf0SDonald Hunter  mcast-groups:
49*2db8abf0SDonald Hunter    list:
50*2db8abf0SDonald Hunter      -
51*2db8abf0SDonald Hunter        name: rtnlgrp-ipv4-ifaddr
52*2db8abf0SDonald Hunter        value: 5
53*2db8abf0SDonald Hunter      -
54*2db8abf0SDonald Hunter        name: rtnlgrp-ipv6-ifaddr
55*2db8abf0SDonald Hunter        value: 9
56*2db8abf0SDonald Hunter      -
57*2db8abf0SDonald Hunter        name: rtnlgrp-mctp-ifaddr
58*2db8abf0SDonald Hunter        value: 34
59