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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2017, Joyent, Inc.
25 * Copyright (c) 2015 Garrett D'Amore <garrett@damore.org>
31 #include <sys/types.h>
33 #include <sys/sunddi.h>
45 * MAC Information (text emitted by modinfo(1m))
47 #define MAC_INFO "MAC Services"
50 * MAC-Type version identifier. This is used by mactype_alloc() and
51 * mactype_register() to verify that incompatible MAC-Type plugins don't
54 #define MACTYPE_VERSION 0x1
59 typedef struct __mac_handle
*mac_handle_t
;
60 typedef struct __mac_resource_handle
*mac_resource_handle_t
;
61 typedef struct __mac_notify_handle
*mac_notify_handle_t
;
62 typedef struct __mac_tx_notify_handle
*mac_tx_notify_handle_t
;
63 typedef struct __mac_intr_handle
*mac_intr_handle_t
;
64 typedef struct __mac_ring_handle
*mac_ring_handle_t
;
65 typedef struct __mac_group_handle
*mac_group_handle_t
;
67 #define DATALINK_INVALID_LINKID 0
68 #define DATALINK_ALL_LINKID 0
69 #define DATALINK_MAX_LINKID 0xffffffff
72 LINK_STATE_UNKNOWN
= -1,
78 LINK_DUPLEX_UNKNOWN
= 0,
84 LINK_FLOWCTRL_NONE
= 0,
91 LINK_TAGMODE_VLANONLY
= 0,
96 * Defines range of uint32_t values
98 typedef struct mac_propval_uint32_range_s
{
101 } mac_propval_uint32_range_t
;
104 * Data type of property values.
110 } mac_propval_type_t
;
113 * Captures possible values for a given property. A property can have
114 * range of values (int32, int64, uint32, uint64, et al) or collection/
115 * enumeration of values (strings).
116 * Can be used as a value-result parameter.
118 typedef struct mac_propval_range_s
{
119 uint_t mpr_count
; /* count of ranges */
120 mac_propval_type_t mpr_type
; /* type of value */
122 mac_propval_uint32_range_t mpr_uint32
[1];
124 } mac_propval_range_t
;
126 #define mpr_range_uint32 u.mpr_uint32
129 * Maximum MAC address length
131 #define MAXMACADDRLEN 20
133 #define MPT_MAXMACADDR 32
135 typedef struct mac_secondary_addr_s
{
137 uint8_t ms_addrs
[MPT_MAXMACADDR
][MAXMACADDRLEN
];
138 } mac_secondary_addr_t
;
141 MAC_LOGTYPE_LINK
= 1,
145 #define MAXLINKPROPNAME 256 /* max property name len */
150 * Note that there are 2 sets of parameters: the *_EN_* values are
151 * those that the Administrator configures for autonegotiation. The
152 * _ADV_* values are those that are currently exposed over the wire.
154 * Please append properties to the end of this list. Do not reorder the list.
157 MAC_PROP_DUPLEX
= 0x00000001,
166 MAC_PROP_ADV_1000FDX_CAP
,
167 MAC_PROP_EN_1000FDX_CAP
,
168 MAC_PROP_ADV_1000HDX_CAP
,
169 MAC_PROP_EN_1000HDX_CAP
,
170 MAC_PROP_ADV_100FDX_CAP
,
171 MAC_PROP_EN_100FDX_CAP
,
172 MAC_PROP_ADV_100HDX_CAP
,
173 MAC_PROP_EN_100HDX_CAP
,
174 MAC_PROP_ADV_10FDX_CAP
,
175 MAC_PROP_EN_10FDX_CAP
,
176 MAC_PROP_ADV_10HDX_CAP
,
177 MAC_PROP_EN_10HDX_CAP
,
178 MAC_PROP_ADV_100T4_CAP
,
179 MAC_PROP_EN_100T4_CAP
,
180 MAC_PROP_IPTUN_HOPLIMIT
,
181 MAC_PROP_IPTUN_ENCAPLIMIT
,
185 MAC_PROP_WL_LINKSTATUS
,
186 MAC_PROP_WL_DESIRED_RATES
,
187 MAC_PROP_WL_SUPPORTED_RATES
,
188 MAC_PROP_WL_AUTH_MODE
,
189 MAC_PROP_WL_ENCRYPTION
,
191 MAC_PROP_WL_PHY_CONFIG
,
192 MAC_PROP_WL_CAPABILITY
,
194 MAC_PROP_WL_SCANRESULTS
,
195 MAC_PROP_WL_POWER_MODE
,
197 MAC_PROP_WL_ESS_LIST
,
199 MAC_PROP_WL_CREATE_IBSS
,
200 MAC_PROP_WL_SETOPTIE
,
205 MAC_PROP_ADV_10GFDX_CAP
,
206 MAC_PROP_EN_10GFDX_CAP
,
211 MAC_PROP_RESOURCE_EFF
,
212 MAC_PROP_RXRINGSRANGE
,
213 MAC_PROP_TXRINGSRANGE
,
214 MAC_PROP_MAX_TX_RINGS_AVAIL
,
215 MAC_PROP_MAX_RX_RINGS_AVAIL
,
216 MAC_PROP_MAX_RXHWCLNT_AVAIL
,
217 MAC_PROP_MAX_TXHWCLNT_AVAIL
,
218 MAC_PROP_IB_LINKMODE
,
219 MAC_PROP_VN_PROMISC_FILTERED
,
220 MAC_PROP_SECONDARY_ADDRS
,
221 MAC_PROP_ADV_40GFDX_CAP
,
222 MAC_PROP_EN_40GFDX_CAP
,
223 MAC_PROP_ADV_100GFDX_CAP
,
224 MAC_PROP_EN_100GFDX_CAP
,
225 MAC_PROP_ADV_2500FDX_CAP
,
226 MAC_PROP_EN_2500FDX_CAP
,
227 MAC_PROP_ADV_5000FDX_CAP
,
228 MAC_PROP_EN_5000FDX_CAP
,
229 MAC_PROP_ADV_25GFDX_CAP
,
230 MAC_PROP_EN_25GFDX_CAP
,
231 MAC_PROP_ADV_50GFDX_CAP
,
232 MAC_PROP_EN_50GFDX_CAP
,
233 MAC_PROP_PRIVATE
= -1
237 * Flags to figure out r/w status of legacy ndd props.
239 #define MAC_PROP_PERM_READ 0x0001
240 #define MAC_PROP_PERM_WRITE 0x0010
241 #define MAC_PROP_MAP_KSTAT 0x0100
242 #define MAC_PROP_PERM_RW (MAC_PROP_PERM_READ|MAC_PROP_PERM_WRITE)
243 #define MAC_PROP_FLAGS_RK (MAC_PROP_PERM_READ|MAC_PROP_MAP_KSTAT)
246 * Valid LED mode bits
248 typedef enum mac_led_mode
{
249 MAC_LED_DEFAULT
= (1 << 0),
250 MAC_LED_OFF
= (1 << 1),
251 MAC_LED_IDENT
= (1 << 2),
252 MAC_LED_ON
= (1 << 3)
259 * There are three ranges of statistics values. 0 to 1 - MAC_STAT_MIN are
260 * interface statistics maintained by the mac module. MAC_STAT_MIN to 1 -
261 * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and
262 * maintained by each driver. MACTYPE_STAT_MIN and above are statistics
263 * defined by MAC-Type plugins and maintained by each driver.
265 #define MAC_STAT_MIN 1000
266 #define MACTYPE_STAT_MIN 2000
268 #define IS_MAC_STAT(stat) \
269 (stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN)
270 #define IS_MACTYPE_STAT(stat) (stat >= MACTYPE_STAT_MIN)
273 * Statistics maintained by the mac module, and possibly populated as link
280 MAC_STAT_LOWLINK_STATE
,
285 * Do not reorder, and add only to the end of this list.
287 enum mac_driver_stat
{
288 /* MIB-II stats (RFC 1213 and RFC 1573) */
289 MAC_STAT_IFSPEED
= MAC_STAT_MIN
,
308 #define MAC_NSTAT (MAC_STAT_OVERFLOWS - MAC_STAT_IFSPEED + 1)
310 #define MAC_STAT_ISACOUNTER(_stat) ( \
311 (_stat) == MAC_STAT_MULTIRCV || \
312 (_stat) == MAC_STAT_BRDCSTRCV || \
313 (_stat) == MAC_STAT_MULTIXMT || \
314 (_stat) == MAC_STAT_BRDCSTXMT || \
315 (_stat) == MAC_STAT_NORCVBUF || \
316 (_stat) == MAC_STAT_IERRORS || \
317 (_stat) == MAC_STAT_UNKNOWNS || \
318 (_stat) == MAC_STAT_NOXMTBUF || \
319 (_stat) == MAC_STAT_OERRORS || \
320 (_stat) == MAC_STAT_COLLISIONS || \
321 (_stat) == MAC_STAT_RBYTES || \
322 (_stat) == MAC_STAT_IPACKETS || \
323 (_stat) == MAC_STAT_OBYTES || \
324 (_stat) == MAC_STAT_OPACKETS || \
325 (_stat) == MAC_STAT_UNDERFLOWS || \
326 (_stat) == MAC_STAT_OVERFLOWS)
329 * Immutable information. (This may not be modified after registration).
331 typedef struct mac_info_s
{
333 uint_t mi_nativemedia
;
334 uint_t mi_addr_length
;
335 uint8_t *mi_unicst_addr
;
336 uint8_t *mi_brdcst_addr
;
340 * When VNICs are created on top of the NIC, there are two levels
341 * of MAC layer, a lower MAC, which is the MAC layer at the level of the
342 * physical NIC, and an upper MAC, which is the MAC layer at the level
343 * of the VNIC. Each VNIC maps to a MAC client at the lower MAC, and
344 * the SRS and classification is done at the lower MAC level. The upper
345 * MAC is therefore for the most part pass-through, and therefore
346 * special processing needs to be done at the upper MAC layer when
347 * dealing with a VNIC.
349 * This capability allows the MAC layer to detect when a VNIC is being
350 * access, and implement the required shortcuts.
352 * In addition, this capability is used to keep the VNIC's secondary
353 * mac_clients in sync when the primary MAC is updated.
356 typedef void *(*mac_client_handle_fn_t
)(void *);
357 typedef void (*mac_client_update_fn_t
)(void *);
359 typedef struct mac_capab_vnic_s
{
361 mac_client_handle_fn_t mcv_mac_client_handle
;
362 mac_client_update_fn_t mcv_mac_secondary_update
;
365 typedef void (*mac_rename_fn_t
)(const char *, void *);
366 typedef mblk_t
*(*mac_tx_ring_fn_t
)(void *, mblk_t
*, uintptr_t,
367 mac_ring_handle_t
*);
368 typedef struct mac_capab_aggr_s
{
369 mac_rename_fn_t mca_rename_fn
;
370 int (*mca_unicst
)(void *, const uint8_t *);
371 mac_tx_ring_fn_t mca_find_tx_ring_fn
;
375 /* Bridge transmit and receive function signatures */
376 typedef mblk_t
*(*mac_bridge_tx_t
)(mac_handle_t
, mac_ring_handle_t
, mblk_t
*);
377 typedef void (*mac_bridge_rx_t
)(mac_handle_t
, mac_resource_handle_t
, mblk_t
*);
378 typedef void (*mac_bridge_ref_t
)(mac_handle_t
, boolean_t
);
379 typedef link_state_t (*mac_bridge_ls_t
)(mac_handle_t
, link_state_t
);
381 /* must change mac_notify_cb_list[] in mac_provider.c if this is changed */
387 MAC_NOTE_FASTPATH_FLUSH
,
393 MAC_NOTE_ALLOWED_IPS
,
394 MAC_NNOTE
/* must be the last entry */
397 typedef void (*mac_notify_t
)(void *, mac_notify_type_t
);
398 typedef void (*mac_rx_t
)(void *, mac_resource_handle_t
, mblk_t
*,
400 typedef mblk_t
*(*mac_receive_t
)(void *, int);
407 } mac_resource_type_t
;
409 typedef int (*mac_intr_enable_t
)(mac_intr_handle_t
);
410 typedef int (*mac_intr_disable_t
)(mac_intr_handle_t
);
412 typedef struct mac_intr_s
{
413 mac_intr_handle_t mi_handle
;
414 mac_intr_enable_t mi_enable
;
415 mac_intr_disable_t mi_disable
;
416 ddi_intr_handle_t mi_ddi_handle
;
417 boolean_t mi_ddi_shared
;
420 typedef struct mac_rx_fifo_s
{
421 mac_resource_type_t mrf_type
; /* MAC_RX_FIFO */
423 mac_receive_t mrf_receive
;
425 uint32_t mrf_flow_priority
;
427 * The CPU this flow is to be processed on. With intrd and future
428 * things, we should know which CPU the flow needs to be processed
429 * and get a squeue assigned on that CPU.
434 #define mrf_intr_handle mrf_intr.mi_handle
435 #define mrf_intr_enable mrf_intr.mi_enable
436 #define mrf_intr_disable mrf_intr.mi_disable
438 typedef union mac_resource_u
{
439 mac_resource_type_t mr_type
;
440 mac_rx_fifo_t mr_fifo
;
444 MAC_ADDRTYPE_UNICAST
,
445 MAC_ADDRTYPE_MULTICAST
,
446 MAC_ADDRTYPE_BROADCAST
449 typedef struct mac_header_info_s
{
452 const uint8_t *mhi_daddr
;
453 const uint8_t *mhi_saddr
;
454 uint32_t mhi_origsap
;
455 uint32_t mhi_bindsap
;
456 mac_addrtype_t mhi_dsttype
;
458 boolean_t mhi_istagged
;
459 boolean_t mhi_ispvid
;
463 * Function pointer to match dls client signature. Should be same as
464 * dls_rx_t to allow a soft ring to bypass DLS layer and call a DLS
467 typedef void (*mac_direct_rx_t
)(void *, mac_resource_handle_t
,
468 mblk_t
*, mac_header_info_t
*);
470 typedef mac_resource_handle_t (*mac_resource_add_t
)(void *, mac_resource_t
*);
471 typedef int (*mac_resource_bind_t
)(void *,
472 mac_resource_handle_t
, processorid_t
);
473 typedef void (*mac_resource_remove_t
)(void *, void *);
474 typedef void (*mac_resource_quiesce_t
)(void *, void *);
475 typedef void (*mac_resource_restart_t
)(void *, void *);
476 typedef int (*mac_resource_modify_t
)(void *, void *,
478 typedef void (*mac_change_upcall_t
)(void *, mac_direct_rx_t
,
482 * MAC-Type plugin interfaces
485 typedef int (*mtops_addr_verify_t
)(const void *, void *);
486 typedef boolean_t (*mtops_sap_verify_t
)(uint32_t, uint32_t *, void *);
487 typedef mblk_t
*(*mtops_header_t
)(const void *, const void *,
488 uint32_t, void *, mblk_t
*, size_t);
489 typedef int (*mtops_header_info_t
)(mblk_t
*, void *,
490 mac_header_info_t
*);
491 typedef boolean_t (*mtops_pdata_verify_t
)(void *, size_t);
492 typedef mblk_t
*(*mtops_header_modify_t
)(mblk_t
*, void *);
493 typedef void (*mtops_link_details_t
)(char *, size_t, mac_handle_t
,
496 typedef struct mactype_ops_s
{
499 * mtops_unicst_verify() returns 0 if the given address is a valid
500 * unicast address, or a non-zero errno otherwise.
502 mtops_addr_verify_t mtops_unicst_verify
;
504 * mtops_multicst_verify() returns 0 if the given address is a
505 * valid multicast address, or a non-zero errno otherwise. If the
506 * media doesn't support multicast, ENOTSUP should be returned (for
509 mtops_addr_verify_t mtops_multicst_verify
;
511 * mtops_sap_verify() returns B_TRUE if the given SAP is a valid
512 * SAP value, or B_FALSE otherwise.
514 mtops_sap_verify_t mtops_sap_verify
;
516 * mtops_header() is used to allocate and construct a MAC header.
518 mtops_header_t mtops_header
;
520 * mtops_header_info() is used to gather information on a given MAC
523 mtops_header_info_t mtops_header_info
;
525 * mtops_pdata_verify() is used to verify the validity of MAC
526 * plugin data. It is called by mac_register() if the driver has
527 * supplied MAC plugin data, and also by mac_pdata_update() when
528 * drivers update the data.
530 mtops_pdata_verify_t mtops_pdata_verify
;
532 * mtops_header_cook() is an optional callback that converts (or
533 * "cooks") the given raw header (as sent by a raw DLPI consumer)
534 * into one that is appropriate to send down to the MAC driver.
535 * Following the example above, an Ethernet header sent down by a
536 * DLPI consumer would be converted to whatever header the MAC
539 mtops_header_modify_t mtops_header_cook
;
541 * mtops_header_uncook() is an optional callback that does the
542 * opposite of mtops_header_cook(). It "uncooks" a given MAC
543 * header (as received from the driver) for consumption by raw DLPI
544 * consumers. For example, for a non-Ethernet plugin that wants
545 * raw DLPI consumers to be fooled into thinking that the device
546 * provides Ethernet access, this callback would modify the given
547 * mblk_t such that the MAC header is converted to an Ethernet
550 mtops_header_modify_t mtops_header_uncook
;
552 * mtops_link_details() is an optional callback that provides
553 * extended information about the link state. Its primary purpose
554 * is to provide type-specific support for syslog contents on
555 * link up events. If no implementation is provided, then a default
556 * implementation will be used.
558 mtops_link_details_t mtops_link_details
;
562 * mtops_ops exists for the plugin to enumerate the optional callback
563 * entrypoints it has defined. This allows the mac module to define
564 * additional plugin entrypoints in mactype_ops_t without breaking backward
565 * compatibility with old plugins.
567 #define MTOPS_PDATA_VERIFY 0x001
568 #define MTOPS_HEADER_COOK 0x002
569 #define MTOPS_HEADER_UNCOOK 0x004
570 #define MTOPS_LINK_DETAILS 0x008
573 * Provide mapping for legacy ndd ioctls relevant to that mactype.
574 * Note that the ndd ioctls are obsolete, and may be removed in a future
575 * release of Solaris. The ndd ioctls are not typically used in legacy
576 * ethernet drivers. New datalink drivers of all link-types should use
577 * dladm(1m) interfaces for administering tunables and not have to provide
580 typedef struct mac_ndd_mapping_s
{
592 #define mp_prop_id u_mp_id.u_id
593 #define mp_kstat u_mp_id.u_kstat
595 typedef struct mac_stat_info_s
{
598 uint_t msi_type
; /* as defined in kstat_named_init(9F) */
599 uint64_t msi_default
;
602 typedef struct mactype_register_s
{
603 uint_t mtr_version
; /* set by mactype_alloc() */
604 const char *mtr_ident
;
605 mactype_ops_t
*mtr_ops
;
607 uint_t mtr_nativetype
;
609 uint8_t *mtr_brdcst_addr
;
610 mac_stat_info_t
*mtr_stats
;
611 size_t mtr_statcount
;
612 mac_ndd_mapping_t
*mtr_mapping
;
613 size_t mtr_mappingcount
;
614 } mactype_register_t
;
617 * Driver interface functions.
619 extern int mac_open_by_linkid(datalink_id_t
,
621 extern int mac_open_by_linkname(const char *,
623 extern const char *mac_name(mac_handle_t
);
624 extern minor_t
mac_minor(mac_handle_t
);
625 extern minor_t
mac_minor_hold(boolean_t
);
626 extern void mac_minor_rele(minor_t
);
627 extern void mac_sdu_get(mac_handle_t
, uint_t
*, uint_t
*);
628 extern void mac_sdu_get2(mac_handle_t
, uint_t
*, uint_t
*,
630 extern int mac_maxsdu_update(mac_handle_t
, uint_t
);
631 extern int mac_maxsdu_update2(mac_handle_t
, uint_t
,
633 extern uint_t
mac_addr_len(mac_handle_t
);
634 extern int mac_type(mac_handle_t
);
635 extern int mac_nativetype(mac_handle_t
);
637 extern void mac_unicst_update(mac_handle_t
,
639 extern void mac_capab_update(mac_handle_t
);
640 extern int mac_pdata_update(mac_handle_t
, void *,
642 extern boolean_t
mac_margin_update(mac_handle_t
, uint32_t);
643 extern void mac_margin_get(mac_handle_t
, uint32_t *);
644 extern int mac_margin_remove(mac_handle_t
, uint32_t);
645 extern int mac_margin_add(mac_handle_t
, uint32_t *,
647 extern int mac_mtu_add(mac_handle_t
, uint32_t *,
649 extern int mac_mtu_remove(mac_handle_t
, uint32_t);
650 extern int mac_fastpath_disable(mac_handle_t
);
651 extern void mac_fastpath_enable(mac_handle_t
);
652 extern void mac_no_active(mac_handle_t
);
654 extern mactype_register_t
*mactype_alloc(uint_t
);
655 extern void mactype_free(mactype_register_t
*);
656 extern int mactype_register(mactype_register_t
*);
657 extern int mactype_unregister(const char *);
659 extern int mac_start_logusage(mac_logtype_t
, uint_t
);
660 extern void mac_stop_logusage(mac_logtype_t
);
662 extern mac_handle_t
mac_get_lower_mac_handle(mac_handle_t
);
663 extern boolean_t
mac_is_vnic_primary(mac_handle_t
);
666 * Packet hashing for distribution to multiple ports and rings.
669 #define MAC_PKT_HASH_L2 0x01
670 #define MAC_PKT_HASH_L3 0x02
671 #define MAC_PKT_HASH_L4 0x04
673 extern uint64_t mac_pkt_hash(uint_t
, mblk_t
*, uint8_t,
679 extern void mac_rx_common(mac_handle_t
,
680 mac_resource_handle_t
, mblk_t
*);
681 extern int mac_bridge_set(mac_handle_t
, mac_handle_t
);
682 extern void mac_bridge_clear(mac_handle_t
, mac_handle_t
);
683 extern void mac_bridge_vectors(mac_bridge_tx_t
,
684 mac_bridge_rx_t
, mac_bridge_ref_t
,
687 /* special case function for TRILL observability */
688 extern void mac_trill_snoop(mac_handle_t
, mblk_t
*);
696 #endif /* _SYS_MAC_H */