mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 10:11:27 +01:00
public/io/netif.h: move and amend multicast control documentation
netif.h contains a specification of the XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL}
extra info messages require to manipulate a multicast filter list maintained
by a backend and specifies the xenstore negotiation protocol in a comment
just above the structure defintion, which is easy to miss.
This patch moves the documentation of the xenstore negotiation to be
co-located with the documentation for other features and also amends the
wording to be clearer.
Signed-off-by: Paul Durrant <paul.durrant@citrix.com>
Cc: Ian Campbell <ian.campbell@citrix.com>
Cc: Ian Jackson <ian.jackson@eu.citrix.com>
Cc: Jan Beulich <jbeulich@suse.com>
Cc: Keir Fraser <keir@xen.org>
Cc: Tim Deegan <tim@xen.org>
Acked-by: Wei Liu <wei.liu2@citrix.com>
[ ijc -- added a blank line to the comment ]
This commit is contained in:
1 parent
09e2a619a4
commit
b2700877ad
1 file changed
+15
-8
@@ -135,6 +135,21 @@
|
||||
* present.
|
||||
*/
|
||||
|
||||
/*
|
||||
* "feature-multicast-control" advertises the capability to filter ethernet
|
||||
* multicast packets in the backend. To enable use of this capability the
|
||||
* frontend must set "request-multicast-control" before moving into the
|
||||
* connected state.
|
||||
*
|
||||
* If "request-multicast-control" is set then the backend transmit side should
|
||||
* no longer flood multicast packets to the frontend, it should instead drop any
|
||||
* multicast packet that does not match in a filter list. The list is
|
||||
* amended by the frontend by sending dummy transmit requests containing
|
||||
* XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL} extra-info fragments as specified below.
|
||||
* Once enabled by the frontend, the feature cannot be disabled except by
|
||||
* closing and re-connecting to the backend.
|
||||
*/
|
||||
|
||||
/*
|
||||
* This is the 'wire' format for packets:
|
||||
* Request 1: netif_tx_request_t -- NETTXF_* (any flags)
|
||||
@@ -341,14 +356,6 @@ struct netif_extra_info {
|
||||
|
||||
/*
|
||||
* XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL}:
|
||||
* Backend advertises availability via 'feature-multicast-control'
|
||||
* xenbus node containing value '1'.
|
||||
* Frontend requests this feature by advertising
|
||||
* 'request-multicast-control' xenbus node containing value '1'.
|
||||
* If multicast control is requested then multicast flooding is
|
||||
* disabled and the frontend must explicitly register its interest
|
||||
* in multicast groups using dummy transmit requests containing
|
||||
* MCAST_{ADD,DEL} extra-info fragments.
|
||||
*/
|
||||
struct {
|
||||
uint8_t addr[6]; /* Address to add/remove. */
|
||||
|
||||