1/*
2 * Copyright (c) 2013 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above
11 *    copyright notice, this list of conditions and the following
12 *    disclaimer in the documentation and/or other materials provided
13 *    with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
18 * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD: stable/11/sys/net/ieee_oui.h 346783 2019-04-27 04:39:41Z kevans $
29 *
30 * Author: George V. Neville-Neil
31 *
32 */
33
34/* Organizationally Unique Identifier assigned by IEEE 14 Nov 2013 */
35#define OUI_FREEBSD_BASE 0x589cfc000000
36#define OUI_FREEBSD(nic) (OUI_FREEBSD_BASE | (nic))
37
38/*
39 * OUIs are most often used to uniquely identify network interfaces
40 * and occupy the first 3 bytes of both destination and source MAC
41 * addresses.  The following allocations exist so that various
42 * software systems associated with FreeBSD can have unique IDs in the
43 * absence of hardware.  The use of OUIs for this purpose is not fully
44 * fleshed out but is now in common use in virtualization technology.
45 *
46 * Allocations from this range are expected to be made using COMMON
47 * SENSE by developers.  Do NOT take a large range just because
48 * they're currently wide open.  Take the smallest useful range for
49 * your system.  We have (2^24 - 2) available addresses (see Reserved
50 * Values below) but that is far from infinite.
51 *
52 * In the event of a conflict arbitration of allocation in this file
53 * is subject to core@ approval.
54 *
55 * Applications are differentiated based on the high order bit(s) of
56 * the remaining three bytes.  Our first allocation has all 0s, the
57 * next allocation has the highest bit set.  Allocating in this way
58 * gives us 254 allocations of 64K addresses.  Address blocks can be
59 * concatenated if necessary.
60 *
61 * Reserved Values: 0x000000 and 0xffffff are reserved and MUST NOT BE
62 * allocated for any reason.
63 */
64
65/* Allocate 20 bits to bhyve */
66#define OUI_FREEBSD_BHYVE_LOW	OUI_FREEBSD(0x000001)
67#define OUI_FREEBSD_BHYVE_HIGH	OUI_FREEBSD(0x0fffff)
68
69/*
70 * Allocate 16 bits for a pool to give to various interfaces that need a
71 * generated address, but don't quite need to slice off a whole section of
72 * the OUI (e.g. cloned interfaces, one-off NICs of various vendors).
73 *
74 * ether_gen_addr should be used to generate an address from this pool.
75 */
76#define	OUI_FREEBSD_GENERATED_MASK	0x10ffff
77#define	OUI_FREEBSD_GENERATED_LOW	OUI_FREEBSD(0x100000)
78#define	OUI_FREEBSD_GENERATED_HIGH	OUI_FREEBSD(OU_FREEBSD_GENERATED_MASK)
79