xref: /illumos-gate/usr/src/uts/common/io/mac/plugins/mac_ether.c (revision aca118b711d5dc86653e0b3c1a122a6b93a0112d)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*
27  * Ethernet MAC plugin for the Nemo mac module
28  */
29 
30 #include <sys/types.h>
31 #include <sys/modctl.h>
32 #include <sys/dlpi.h>
33 #include <sys/dld_impl.h>
34 #include <sys/mac_ether.h>
35 #include <sys/ethernet.h>
36 #include <sys/byteorder.h>
37 #include <sys/strsun.h>
38 #include <inet/common.h>
39 
40 static uint8_t	ether_brdcst[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
41 
42 static mac_stat_info_t ether_stats[] = {
43 	/* RFC1643 stats */
44 	{ ETHER_STAT_ALIGN_ERRORS, "align_errors", KSTAT_DATA_UINT32,	0 },
45 	{ ETHER_STAT_FCS_ERRORS, "fcs_errors", KSTAT_DATA_UINT32,	0 },
46 	{ ETHER_STAT_FIRST_COLLISIONS, "first_collisions", KSTAT_DATA_UINT32,
47 	    0 },
48 	{ ETHER_STAT_MULTI_COLLISIONS, "multi_collisions", KSTAT_DATA_UINT32,
49 	    0 },
50 	{ ETHER_STAT_SQE_ERRORS, "sqe_errors", KSTAT_DATA_UINT32,	0},
51 	{ ETHER_STAT_DEFER_XMTS, "defer_xmts", KSTAT_DATA_UINT32,	0},
52 	{ ETHER_STAT_TX_LATE_COLLISIONS, "tx_late_collisions",
53 	    KSTAT_DATA_UINT32, 0 },
54 	{ ETHER_STAT_EX_COLLISIONS, "ex_collisions", KSTAT_DATA_UINT32,	0 },
55 	{ ETHER_STAT_MACXMT_ERRORS, "macxmt_errors", KSTAT_DATA_UINT32,	0 },
56 	{ ETHER_STAT_CARRIER_ERRORS, "carrier_errors", KSTAT_DATA_UINT32, 0 },
57 	{ ETHER_STAT_TOOLONG_ERRORS, "toolong_errors", KSTAT_DATA_UINT32, 0 },
58 	{ ETHER_STAT_MACRCV_ERRORS, "macrcv_errors", KSTAT_DATA_UINT32, 0 },
59 	{ ETHER_STAT_TOOSHORT_ERRORS, "runt_errors", KSTAT_DATA_UINT32,	0 },
60 	{ ETHER_STAT_JABBER_ERRORS, "jabber_errors", KSTAT_DATA_UINT32,	0 },
61 
62 	/* Statistics described in the ieee802.3(5) man page */
63 	{ ETHER_STAT_XCVR_ADDR, "xcvr_addr", KSTAT_DATA_UINT32,		0 },
64 	{ ETHER_STAT_XCVR_ID, "xcvr_id", KSTAT_DATA_UINT32, 		0 },
65 	{ ETHER_STAT_XCVR_INUSE, "xcvr_inuse", KSTAT_DATA_UINT32,	0 },
66 	{ ETHER_STAT_CAP_10GFDX, "cap_10gfdx", KSTAT_DATA_UINT32,	0 },
67 	{ ETHER_STAT_CAP_1000FDX, "cap_1000fdx", KSTAT_DATA_UINT32,	0 },
68 	{ ETHER_STAT_CAP_1000HDX, "cap_1000hdx", KSTAT_DATA_UINT32,	0 },
69 	{ ETHER_STAT_CAP_100T4, "cap_100T4", KSTAT_DATA_UINT32,		0 },
70 	{ ETHER_STAT_CAP_100FDX, "cap_100fdx", KSTAT_DATA_UINT32,	0 },
71 	{ ETHER_STAT_CAP_100HDX, "cap_100hdx", KSTAT_DATA_UINT32,	0 },
72 	{ ETHER_STAT_CAP_10FDX, "cap_10fdx", KSTAT_DATA_UINT32,		0 },
73 	{ ETHER_STAT_CAP_10HDX, "cap_10hdx", KSTAT_DATA_UINT32,		0 },
74 	{ ETHER_STAT_CAP_ASMPAUSE, "cap_asmpause", KSTAT_DATA_UINT32,	0 },
75 	{ ETHER_STAT_CAP_PAUSE, "cap_pause", KSTAT_DATA_UINT32,		0 },
76 	{ ETHER_STAT_CAP_AUTONEG, "cap_autoneg", KSTAT_DATA_UINT32,	0 },
77 	{ ETHER_STAT_CAP_REMFAULT, "cap_rem_fault", KSTAT_DATA_UINT32,	0 },
78 	{ ETHER_STAT_ADV_CAP_10GFDX, "adv_cap_10gfdx", KSTAT_DATA_UINT32, 0 },
79 	{ ETHER_STAT_ADV_CAP_1000FDX, "adv_cap_1000fdx", KSTAT_DATA_UINT32, 0 },
80 	{ ETHER_STAT_ADV_CAP_1000HDX, "adv_cap_1000hdx", KSTAT_DATA_UINT32, 0 },
81 	{ ETHER_STAT_ADV_CAP_100T4, "adv_cap_100T4", KSTAT_DATA_UINT32,	0 },
82 	{ ETHER_STAT_ADV_CAP_100FDX, "adv_cap_100fdx", KSTAT_DATA_UINT32, 0},
83 	{ ETHER_STAT_ADV_CAP_100HDX, "adv_cap_100hdx", KSTAT_DATA_UINT32, 0},
84 	{ ETHER_STAT_ADV_CAP_10FDX, "adv_cap_10fdx", KSTAT_DATA_UINT32,	0 },
85 	{ ETHER_STAT_ADV_CAP_10HDX, "adv_cap_10hdx", KSTAT_DATA_UINT32,	0 },
86 	{ ETHER_STAT_ADV_CAP_ASMPAUSE, "adv_cap_asmpause", KSTAT_DATA_UINT32,
87 	    0 },
88 	{ ETHER_STAT_ADV_CAP_PAUSE, "adv_cap_pause", KSTAT_DATA_UINT32,	0 },
89 	{ ETHER_STAT_ADV_CAP_AUTONEG, "adv_cap_autoneg", KSTAT_DATA_UINT32, 0 },
90 	{ ETHER_STAT_ADV_REMFAULT, "adv_rem_fault", KSTAT_DATA_UINT32,	0 },
91 	{ ETHER_STAT_LP_CAP_10GFDX, "lp_cap_10gfdx", KSTAT_DATA_UINT32, 0 },
92 	{ ETHER_STAT_LP_CAP_1000FDX, "lp_cap_1000fdx", KSTAT_DATA_UINT32, 0 },
93 	{ ETHER_STAT_LP_CAP_1000HDX, "lp_cap_1000hdx", KSTAT_DATA_UINT32, 0 },
94 	{ ETHER_STAT_LP_CAP_100T4, "lp_cap_100T4", KSTAT_DATA_UINT32,	0 },
95 	{ ETHER_STAT_LP_CAP_100FDX, "lp_cap_100fdx", KSTAT_DATA_UINT32,	0 },
96 	{ ETHER_STAT_LP_CAP_100HDX, "lp_cap_100hdx", KSTAT_DATA_UINT32,	0 },
97 	{ ETHER_STAT_LP_CAP_10FDX, "lp_cap_10fdx", KSTAT_DATA_UINT32,	0 },
98 	{ ETHER_STAT_LP_CAP_10HDX, "lp_cap_10hdx", KSTAT_DATA_UINT32,	0 },
99 	{ ETHER_STAT_LP_CAP_ASMPAUSE, "lp_cap_asmpause", KSTAT_DATA_UINT32, 0 },
100 	{ ETHER_STAT_LP_CAP_PAUSE, "lp_cap_pause", KSTAT_DATA_UINT32,	0 },
101 	{ ETHER_STAT_LP_CAP_AUTONEG, "lp_cap_autoneg", KSTAT_DATA_UINT32, 0 },
102 	{ ETHER_STAT_LP_REMFAULT, "lp_rem_fault", KSTAT_DATA_UINT32,	0 },
103 	{ ETHER_STAT_LINK_ASMPAUSE, "link_asmpause", KSTAT_DATA_UINT32,	0 },
104 	{ ETHER_STAT_LINK_PAUSE, "link_pause", KSTAT_DATA_UINT32,	0 },
105 	{ ETHER_STAT_LINK_AUTONEG, "link_autoneg", KSTAT_DATA_UINT32,	0 },
106 	{ ETHER_STAT_LINK_DUPLEX, "link_duplex", KSTAT_DATA_UINT32,	0 }
107 };
108 
109 static struct modlmisc mac_ether_modlmisc = {
110 	&mod_miscops,
111 	"Ethernet MAC plugin"
112 };
113 
114 static struct modlinkage mac_ether_modlinkage = {
115 	MODREV_1,
116 	&mac_ether_modlmisc,
117 	NULL
118 };
119 
120 static mactype_ops_t mac_ether_type_ops;
121 
122 static mac_ndd_mapping_t  mac_ether_mapping[] = {
123 	{"adv_autoneg_cap",	MAC_PROP_AUTONEG, 0, 1,
124 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
125 
126 	{"adv_10gfdx_cap",	MAC_PROP_EN_10GFDX_CAP, 0, 1,
127 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
128 
129 	{"adv_1000fdx_cap",	MAC_PROP_EN_1000FDX_CAP, 0, 1,
130 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
131 
132 	{"adv_1000hdx_cap",	MAC_PROP_EN_1000HDX_CAP, 0, 1,
133 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
134 
135 	{"adv_100fdx_cap",	MAC_PROP_EN_100FDX_CAP, 0, 1,
136 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
137 
138 	{"adv_100hdx_cap",	MAC_PROP_EN_100HDX_CAP, 0, 1,
139 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
140 
141 	{"adv_10fdx_cap",	MAC_PROP_EN_10FDX_CAP, 0, 1,
142 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
143 
144 	{"adv_10hdx_cap",	MAC_PROP_EN_10HDX_CAP, 0, 1,
145 	    sizeof (uint8_t), MAC_PROP_PERM_RW},
146 
147 	{"adv_100T4_cap",	MAC_PROP_EN_100T4_CAP, 0, 1,
148 	    sizeof (uint8_t), MAC_PROP_PERM_READ},
149 
150 	{"link_status",		MAC_STAT_LINK_UP, 0, 1,
151 	    sizeof (long), MAC_PROP_FLAGS_RK},
152 
153 	{"link_speed",		MAC_PROP_SPEED, 0, LONG_MAX,
154 	    sizeof (uint64_t), MAC_PROP_PERM_READ},
155 
156 	{"link_duplex",		MAC_PROP_DUPLEX, 0, 2,
157 	    sizeof (link_duplex_t), MAC_PROP_PERM_READ},
158 
159 	{"autoneg_cap",		ETHER_STAT_CAP_AUTONEG, 0, 1,
160 	    sizeof (long), MAC_PROP_FLAGS_RK},
161 
162 	{"pause_cap",		ETHER_STAT_CAP_PAUSE, 0, 1,
163 	    sizeof (long), MAC_PROP_FLAGS_RK},
164 
165 	{"asym_pause_cap",	ETHER_STAT_CAP_ASMPAUSE, 0, 1,
166 	    sizeof (long), MAC_PROP_FLAGS_RK},
167 
168 	{"10gfdx_cap",		ETHER_STAT_CAP_10GFDX, 0, 1,
169 	    sizeof (long), MAC_PROP_FLAGS_RK},
170 
171 	{"1000fdx_cap",		ETHER_STAT_CAP_1000FDX, 0, 1,
172 	    sizeof (long), MAC_PROP_FLAGS_RK},
173 
174 	{"1000hdx_cap",		ETHER_STAT_CAP_1000HDX, 0, 1,
175 	    sizeof (long), MAC_PROP_FLAGS_RK},
176 
177 	{"100T4_cap",		ETHER_STAT_CAP_100T4, 0, 1,
178 	    sizeof (long), MAC_PROP_FLAGS_RK},
179 
180 	{"100fdx_cap",		ETHER_STAT_CAP_100FDX, 0, 1,
181 	    sizeof (long), MAC_PROP_FLAGS_RK},
182 
183 	{"100hdx_cap",		ETHER_STAT_CAP_100HDX, 0, 1,
184 	    sizeof (long), MAC_PROP_FLAGS_RK},
185 
186 	{"10fdx_cap",		ETHER_STAT_CAP_10FDX, 0, 1,
187 	    sizeof (long), MAC_PROP_FLAGS_RK},
188 
189 	{"10hdx_cap",		ETHER_STAT_CAP_10HDX, 0, 1,
190 	    sizeof (long), MAC_PROP_FLAGS_RK},
191 
192 	{"lp_autoneg_cap",	ETHER_STAT_LP_CAP_AUTONEG, 0, 1,
193 	    sizeof (long), MAC_PROP_FLAGS_RK},
194 
195 	{"lp_pause_cap",	ETHER_STAT_LP_CAP_PAUSE, 0, 1,
196 	    sizeof (long), MAC_PROP_FLAGS_RK},
197 
198 	{"lp_asym_pause_cap",	ETHER_STAT_LP_CAP_ASMPAUSE, 0, 1,
199 	    sizeof (long), MAC_PROP_FLAGS_RK},
200 
201 	{"lp_10gfdx_cap",	ETHER_STAT_LP_CAP_10GFDX, 0, 1,
202 	    sizeof (long), MAC_PROP_FLAGS_RK},
203 
204 	{"lp_1000hdx_cap",	ETHER_STAT_LP_CAP_1000HDX, 0, 1,
205 	    sizeof (long), MAC_PROP_FLAGS_RK},
206 
207 	{"lp_1000fdx_cap",	ETHER_STAT_LP_CAP_1000FDX, 0, 1,
208 	    sizeof (long), MAC_PROP_FLAGS_RK},
209 
210 	{"lp_100T4_cap",	ETHER_STAT_LP_CAP_100T4, 0, 1,
211 	    sizeof (long), MAC_PROP_FLAGS_RK},
212 
213 	{"lp_100fdx_cap",	ETHER_STAT_LP_CAP_100FDX, 0, 1,
214 	    sizeof (long), MAC_PROP_FLAGS_RK},
215 
216 	{"lp_100hdx_cap",	ETHER_STAT_LP_CAP_100HDX, 0, 1,
217 	    sizeof (long), MAC_PROP_FLAGS_RK},
218 
219 	{"lp_10fdx_cap",	ETHER_STAT_LP_CAP_10FDX, 0, 1,
220 	    sizeof (long), MAC_PROP_FLAGS_RK},
221 
222 	{"lp_10hdx_cap",	ETHER_STAT_LP_CAP_10HDX, 0, 1,
223 	    sizeof (long), MAC_PROP_FLAGS_RK},
224 
225 	{"link_autoneg",	ETHER_STAT_LINK_AUTONEG, 0, 1,
226 	    sizeof (long), MAC_PROP_FLAGS_RK}
227 
228 };
229 
230 
231 int
232 _init(void)
233 {
234 	mactype_register_t *mtrp;
235 	int	err;
236 
237 	if ((mtrp = mactype_alloc(MACTYPE_VERSION)) == NULL)
238 		return (ENOTSUP);
239 	mtrp->mtr_ident = MAC_PLUGIN_IDENT_ETHER;
240 	mtrp->mtr_ops = &mac_ether_type_ops;
241 	mtrp->mtr_mactype = DL_ETHER;
242 	mtrp->mtr_nativetype = DL_ETHER;
243 	mtrp->mtr_addrlen = ETHERADDRL;
244 	mtrp->mtr_brdcst_addr = ether_brdcst;
245 	mtrp->mtr_stats = ether_stats;
246 	mtrp->mtr_statcount = A_CNT(ether_stats);
247 	mtrp->mtr_mapping = mac_ether_mapping;
248 	mtrp->mtr_mappingcount = A_CNT(mac_ether_mapping);
249 	if ((err = mactype_register(mtrp)) == 0) {
250 		if ((err = mod_install(&mac_ether_modlinkage)) != 0)
251 			(void) mactype_unregister(MAC_PLUGIN_IDENT_ETHER);
252 	}
253 	mactype_free(mtrp);
254 	return (err);
255 }
256 
257 int
258 _fini(void)
259 {
260 	int	err;
261 
262 	if ((err = mactype_unregister(MAC_PLUGIN_IDENT_ETHER)) != 0)
263 		return (err);
264 	return (mod_remove(&mac_ether_modlinkage));
265 }
266 
267 int
268 _info(struct modinfo *modinfop)
269 {
270 	return (mod_info(&mac_ether_modlinkage, modinfop));
271 }
272 
273 /*
274  * MAC Type plugin operations
275  */
276 
277 /* ARGSUSED */
278 int
279 mac_ether_unicst_verify(const void *addr, void *mac_pdata)
280 {
281 	/* If it's not a group address, then it's a valid unicast address. */
282 	return (((((uint8_t *)addr)[0] & 0x01) != 0) ? EINVAL : 0);
283 }
284 
285 /* ARGSUSED */
286 int
287 mac_ether_multicst_verify(const void *addr, void *mac_pdata)
288 {
289 	/* The address must be a group address. */
290 	if ((((uint8_t *)addr)[0] & 0x01) == 0)
291 		return (EINVAL);
292 	/* The address must not be the media broadcast address. */
293 	if (bcmp(addr, ether_brdcst, ETHERADDRL) == 0)
294 		return (EINVAL);
295 	return (0);
296 }
297 
298 /*
299  * Check the legality of an Ethernet SAP value. The following values are
300  * allowed, as specified by PSARC 2003/150:
301  *
302  * 0..ETHERMTU (1500)					802 semantics
303  * ETHERTYPE_802_MIN (1536)..ETHERTYPE_MAX (65535)	ethertype semantics
304  *
305  * Note that SAP values less than or equal to ETHERMTU (1500) represent LLC
306  * channels. (See PSARC 2003/150).  We strictly use SAP 0 to represent LLC
307  * channels.
308  */
309 /* ARGSUSED */
310 boolean_t
311 mac_ether_sap_verify(uint32_t sap, uint32_t *bind_sap, void *mac_pdata)
312 {
313 	if (sap >= ETHERTYPE_802_MIN && sap <= ETHERTYPE_MAX) {
314 		if (bind_sap != NULL)
315 			*bind_sap = sap;
316 		return (B_TRUE);
317 	}
318 
319 	if (sap <= ETHERMTU) {
320 		if (bind_sap != NULL)
321 			*bind_sap = DLS_SAP_LLC;
322 		return (B_TRUE);
323 	}
324 	return (B_FALSE);
325 }
326 
327 /* ARGSUSED */
328 mblk_t *
329 mac_ether_header(const void *saddr, const void *daddr, uint32_t sap,
330     void *mac_pdata, mblk_t *payload, size_t extra_len)
331 {
332 	struct ether_header	*ehp;
333 	mblk_t			*mp;
334 	uint32_t		bind_sap;
335 
336 	if (!mac_ether_sap_verify(sap, &bind_sap, NULL))
337 		return (NULL);
338 
339 	mp = allocb(sizeof (struct ether_header) + extra_len, BPRI_HI);
340 	if (mp == NULL)
341 		return (NULL);
342 
343 	ehp = (void *)mp->b_rptr;
344 	bcopy(daddr, &(ehp->ether_dhost), ETHERADDRL);
345 	bcopy(saddr, &(ehp->ether_shost), ETHERADDRL);
346 
347 	/*
348 	 * sap <= ETHERMTU indicates that LLC is being used.  If that's the
349 	 * case, then the ether_type needs to be set to the payload length.
350 	 */
351 	if ((bind_sap == DLS_SAP_LLC) && (payload != NULL))
352 		sap = msgdsize(payload);
353 	ehp->ether_type = htons(sap);
354 
355 	mp->b_wptr += sizeof (struct ether_header);
356 	return (mp);
357 }
358 
359 /* ARGSUSED */
360 int
361 mac_ether_header_info(mblk_t *mp, void *mac_pdata, mac_header_info_t *hdr_info)
362 {
363 	struct ether_header	*ehp;
364 	uint16_t		ether_type;
365 
366 	if (MBLKL(mp) < sizeof (struct ether_header))
367 		return (EINVAL);
368 
369 	ehp = (void *)mp->b_rptr;
370 	ether_type = ntohs(ehp->ether_type);
371 
372 	hdr_info->mhi_hdrsize = sizeof (struct ether_header);
373 	hdr_info->mhi_daddr = (const uint8_t *)&(ehp->ether_dhost);
374 	hdr_info->mhi_saddr = (const uint8_t *)&(ehp->ether_shost);
375 	hdr_info->mhi_origsap = ether_type;
376 	hdr_info->mhi_bindsap = (ether_type > ETHERMTU) ?
377 	    ether_type : DLS_SAP_LLC;
378 	hdr_info->mhi_pktsize = (hdr_info->mhi_bindsap == DLS_SAP_LLC) ?
379 	    hdr_info->mhi_hdrsize + ether_type : 0;
380 
381 	if (mac_ether_unicst_verify(hdr_info->mhi_daddr, NULL) == 0)
382 		hdr_info->mhi_dsttype = MAC_ADDRTYPE_UNICAST;
383 	else if (mac_ether_multicst_verify(hdr_info->mhi_daddr, NULL) == 0)
384 		hdr_info->mhi_dsttype = MAC_ADDRTYPE_MULTICAST;
385 	else
386 		hdr_info->mhi_dsttype = MAC_ADDRTYPE_BROADCAST;
387 
388 	return (0);
389 }
390 
391 /*ARGSUSED3*/
392 void
393 mac_ether_link_details(char *buf, size_t sz, mac_handle_t mh, void *mac_pdata)
394 {
395 	link_duplex_t	duplex;
396 	uint64_t	speed;
397 
398 	duplex = mac_stat_get(mh, ETHER_STAT_LINK_DUPLEX);
399 	speed = mac_stat_get(mh, MAC_STAT_IFSPEED);
400 
401 	/* convert to Mbps */
402 	speed /= 1000000;
403 
404 	buf[0] = 0;
405 	(void) snprintf(buf, sz, "%u Mbps, %s duplex", (uint32_t)speed,
406 	    duplex == LINK_DUPLEX_FULL ? "full" :
407 	    duplex == LINK_DUPLEX_HALF ? "half" : "unknown");
408 }
409 
410 static mactype_ops_t mac_ether_type_ops = {
411 	MTOPS_LINK_DETAILS,
412 	mac_ether_unicst_verify,
413 	mac_ether_multicst_verify,
414 	mac_ether_sap_verify,
415 	mac_ether_header,
416 	mac_ether_header_info,
417 	NULL, 	/* pdata_verify */
418 	NULL,	/* header_cook */
419 	NULL,	/* header_uncook */
420 	mac_ether_link_details
421 };
422