xref: /netbsd-src/share/man/man4/xennet.4 (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1.\"	$NetBSD: xennet.4,v 1.3 2014/03/18 18:20:39 riastradh Exp $
2.\"
3.\" Copyright (c) 2011 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jean-Yves Migeon <jym@NetBSD.org>.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd January 8, 2011
31.Dt XENNET 4 xen
32.Os
33.Sh NAME
34.Nm xennet
35.Nd Xen frontend paravirtualized network interface
36.Sh SYNOPSIS
37.Cd "xennet* at xenbus?"
38.Sh DESCRIPTION
39The
40.Nm
41interface forms the frontend part of the paravirtualized drivers
42used by
43.Tn Xen
44guest domains to have network connectivity.
45.Pp
46When the host domain is
47.Nx ,
48the endpoint of the
49.Nm
50interface is a
51.Xr xvif 4
52interface.
53In the XenStore,
54.Nm xvif
55and
56.Nm xennet
57are identified by
58.Dq vif
59(virtual interface)
60entries.
61.Pp
62Conceptually, frontends and backends drivers are
63similar to two Ethernet cards connected via a crossover cable.
64.Sh DIAGNOSTICS
65.Bl -diag
66.It "xennet%d: can't read mac address, err %d"
67The MAC address for this interface could not be read from XenStore.
68.It "xennet%d: %s is not a valid mac address"
69The MAC address specified in the configuration file of the newly
70created guest domain is invalid.
71.It "xennet%d: using event channel %d"
72The
73.Tn Xen
74event channel (virtual interrupt) ID
75associated to this
76.Nm .
77.It "xennet%d: using RX copy mode"
78The
79.Nm
80and its associated endpoint use copy mode for communication: packets
81are copied from one domain's memory to another.
82.It "xennet%d: using RX flip mode"
83The
84.Nm
85and its associated endpoint use flip mode for communication: packets
86are passed by remapping memory pages between domains.
87.El
88.Sh SEE ALSO
89.Xr ifmedia 4 ,
90.Xr xenbus 4 ,
91.Xr xvif 4 ,
92.Xr ifconfig 8
93.Sh HISTORY
94The
95.Nm
96driver first appeared in
97.Nx 3.0 .
98.Sh AUTHORS
99.An -nosplit
100The
101.Nm
102driver was written by
103.An Manuel Bouyer Aq Mt bouyer@NetBSD.org
104and
105.An Christian Limpach Aq Mt chris@pin.lu .
106