etherdevice.h revision 273135 
1/*-
2 * Copyright (c) 2007 Cisco Systems, Inc.  All rights reserved.
3 * Copyright (c) 2014 Mellanox Technologies, Ltd. All rights reserved.
4 *
5 * This software is available to you under a choice of one of two
6 * licenses.  You may choose to be licensed under the terms of the GNU
7 * General Public License (GPL) Version 2, available from the file
8 * COPYING in the main directory of this source tree, or the
9 * OpenIB.org BSD license below:
10 *
11 *     Redistribution and use in source and binary forms, with or
12 *     without modification, are permitted provided that the following
13 *     conditions are met:
14 *
15 *	- Redistributions of source code must retain the above
16 *	  copyright notice, this list of conditions and the following
17 *	  disclaimer.
18 *
19 *	- Redistributions in binary form must reproduce the above
20 *	  copyright notice, this list of conditions and the following
21 *	  disclaimer in the documentation and/or other materials
22 *	  provided with the distribution.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 * SOFTWARE.
32 */
33
34
35#ifndef _LINUX_ETHERDEVICE
36#define _LINUX_ETHERDEVICE
37
38#include <linux/types.h>
39
40/**
41 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
42 * @addr: Pointer to a six-byte array containing the Ethernet address
43 *
44 * Return true if the address is all zeroes.
45 */
46static inline bool is_zero_ether_addr(const u8 *addr)
47{
48        return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
49}
50
51
52
53/**
54 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
55 * @addr: Pointer to a six-byte array containing the Ethernet address
56 *
57 * Return true if the address is a multicast address.
58 * By definition the broadcast address is also a multicast address.
59 */
60static inline bool is_multicast_ether_addr(const u8 *addr)
61{
62        return (0x01 & addr[0]);
63}
64
65/**
66 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
67 * @addr: Pointer to a six-byte array containing the Ethernet address
68 *
69 * Return true if the address is the broadcast address.
70 */
71static inline bool is_broadcast_ether_addr(const u8 *addr)
72{
73        return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
74}
75
76/**
77 * is_valid_ether_addr - Determine if the given Ethernet address is valid
78 * @addr: Pointer to a six-byte array containing the Ethernet address
79 *
80 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
81 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
82 *
83 * Return true if the address is valid.
84 **/
85static inline bool is_valid_ether_addr(const u8 *addr)
86{
87        /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
88        ** explicitly check for it here. */
89        return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
90}
91
92
93
94#endif /* _LINUX_ETHERDEVICE */
95