xref: /freebsd/sys/compat/linuxkpi/common/include/linux/etherdevice.h (revision a4618caa43c16e6e672c27dac1943fd833f8bd8f)
1 /*-
2  * Copyright (c) 2015-2016 Mellanox Technologies, Ltd. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice unmodified, this list of conditions, and the following
9  *    disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 #ifndef _LINUXKPI_LINUX_ETHERDEVICE_H_
26 #define	_LINUXKPI_LINUX_ETHERDEVICE_H_
27 
28 #include <linux/types.h>
29 #include <linux/device.h>
30 
31 #include <sys/random.h>
32 #include <sys/libkern.h>
33 
34 #define	ETH_MODULE_SFF_8079		1
35 #define	ETH_MODULE_SFF_8079_LEN		256
36 #define	ETH_MODULE_SFF_8472		2
37 #define	ETH_MODULE_SFF_8472_LEN		512
38 #define	ETH_MODULE_SFF_8636		3
39 #define	ETH_MODULE_SFF_8636_LEN		256
40 #define	ETH_MODULE_SFF_8436		4
41 #define	ETH_MODULE_SFF_8436_LEN		256
42 
43 struct ethtool_eeprom {
44 	u32	offset;
45 	u32	len;
46 };
47 
48 struct ethtool_modinfo {
49 	u32	type;
50 	u32	eeprom_len;
51 };
52 
53 static inline bool
is_zero_ether_addr(const u8 * addr)54 is_zero_ether_addr(const u8 * addr)
55 {
56 	return ((addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]) ==
57 	    0x00);
58 }
59 
60 static inline bool
is_unicast_ether_addr(const u8 * addr)61 is_unicast_ether_addr(const u8 * addr)
62 {
63 	return ((addr[0] & 0x01) == 0x00);
64 }
65 
66 static inline bool
is_multicast_ether_addr(const u8 * addr)67 is_multicast_ether_addr(const u8 * addr)
68 {
69 	return ((addr[0] & 0x01) == 0x01);
70 }
71 
72 static inline bool
is_broadcast_ether_addr(const u8 * addr)73 is_broadcast_ether_addr(const u8 * addr)
74 {
75 	return ((addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
76 	    0xff);
77 }
78 
79 static inline bool
is_valid_ether_addr(const u8 * addr)80 is_valid_ether_addr(const u8 * addr)
81 {
82 	return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
83 }
84 
85 static inline void
ether_addr_copy(u8 * dst,const u8 * src)86 ether_addr_copy(u8 * dst, const u8 * src)
87 {
88 	memcpy(dst, src, 6);
89 }
90 
91 static inline bool
ether_addr_equal_unaligned(const u8 * pa,const u8 * pb)92 ether_addr_equal_unaligned(const u8 *pa, const u8 *pb)
93 {
94 	return (memcmp(pa, pb, 6) == 0);
95 }
96 #define	ether_addr_equal(_pa, _pb)	ether_addr_equal_unaligned(_pa, _pb)
97 
98 static inline bool
ether_addr_equal_64bits(const u8 * pa,const u8 * pb)99 ether_addr_equal_64bits(const u8 *pa, const u8 *pb)
100 {
101 	return (memcmp(pa, pb, 6) == 0);
102 }
103 
104 static inline void
eth_broadcast_addr(u8 * pa)105 eth_broadcast_addr(u8 *pa)
106 {
107 	memset(pa, 0xff, 6);
108 }
109 
110 static inline void
eth_zero_addr(u8 * pa)111 eth_zero_addr(u8 *pa)
112 {
113 	memset(pa, 0, 6);
114 }
115 
116 static inline void
random_ether_addr(u8 * dst)117 random_ether_addr(u8 *dst)
118 {
119 	arc4random_buf(dst, 6);
120 
121 	dst[0] &= 0xfe;
122 	dst[0] |= 0x02;
123 }
124 
125 static inline void
eth_random_addr(u8 * dst)126 eth_random_addr(u8 *dst)
127 {
128 
129 	random_ether_addr(dst);
130 }
131 
132 static inline int
device_get_mac_address(struct device * dev,char * dst)133 device_get_mac_address(struct device *dev, char *dst)
134 {
135 
136 	/* XXX get mac address from FDT? */
137 	return (-ENOENT);
138 }
139 
140 #endif					/* _LINUXKPI_LINUX_ETHERDEVICE_H_ */
141