Home | History | Annotate | Download | only in sys
      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 /*
     23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
     24  * Use is subject to license terms.
     25  */
     26 
     27 #ifndef	_SYS_MAC_H
     28 #define	_SYS_MAC_H
     29 
     30 #include <sys/types.h>
     31 #ifdef	_KERNEL
     32 #include <sys/sunddi.h>
     33 #endif
     34 
     35 /*
     36  * MAC Services Module
     37  */
     38 
     39 #ifdef	__cplusplus
     40 extern "C" {
     41 #endif
     42 
     43 /*
     44  * MAC Information (text emitted by modinfo(1m))
     45  */
     46 #define	MAC_INFO	"MAC Services"
     47 
     48 /*
     49  * MAC-Type version identifier.  This is used by mactype_alloc() and
     50  * mactype_register() to verify that incompatible MAC-Type plugins don't
     51  * register.
     52  */
     53 #define	MACTYPE_VERSION	0x1
     54 
     55 /*
     56  * Opaque handle types
     57  */
     58 typedef struct __mac_handle		*mac_handle_t;
     59 typedef struct __mac_resource_handle	*mac_resource_handle_t;
     60 typedef struct __mac_notify_handle	*mac_notify_handle_t;
     61 typedef struct __mac_tx_notify_handle	*mac_tx_notify_handle_t;
     62 typedef	struct __mac_intr_handle	*mac_intr_handle_t;
     63 typedef	struct __mac_ring_handle	*mac_ring_handle_t;
     64 typedef	struct __mac_group_handle	*mac_group_handle_t;
     65 
     66 #define	DATALINK_INVALID_LINKID	0
     67 #define	DATALINK_ALL_LINKID	0
     68 #define	DATALINK_MAX_LINKID	0xffffffff
     69 
     70 typedef enum {
     71 	LINK_STATE_UNKNOWN = -1,
     72 	LINK_STATE_DOWN,
     73 	LINK_STATE_UP
     74 } link_state_t;
     75 
     76 typedef enum {
     77 	LINK_DUPLEX_UNKNOWN = 0,
     78 	LINK_DUPLEX_HALF,
     79 	LINK_DUPLEX_FULL
     80 } link_duplex_t;
     81 
     82 typedef enum {
     83 	LINK_FLOWCTRL_NONE = 0,
     84 	LINK_FLOWCTRL_RX,
     85 	LINK_FLOWCTRL_TX,
     86 	LINK_FLOWCTRL_BI
     87 } link_flowctrl_t;
     88 
     89 typedef enum {
     90 	LINK_TAGMODE_VLANONLY = 0,
     91 	LINK_TAGMODE_NORMAL
     92 } link_tagmode_t;
     93 
     94 /*
     95  * Defines range of uint32 values
     96  */
     97 typedef struct mac_propval_uint32_range_s {
     98 	uint32_t mpur_min;
     99 	uint32_t mpur_max;
    100 } mac_propval_uint32_range_t;
    101 
    102 /*
    103  * Data type of the value
    104  */
    105 typedef enum {
    106 	MAC_PROPVAL_UINT32 = 0x1
    107 } mac_propval_type_t;
    108 
    109 /*
    110  * Captures possible values for a given property. A property can have
    111  * range of values (int32, int64, uint32, uint64, et al) or collection/
    112  * enumeration of values (strings).
    113  * Can be used as a value-result parameter.
    114  *
    115  * See PSARC 2009/235 for more information.
    116  */
    117 typedef struct mac_propval_range_s {
    118 	uint_t mpr_count;			/* count of ranges */
    119 	mac_propval_type_t mpr_type;		/* type of value */
    120 	union {
    121 		mac_propval_uint32_range_t mpr_uint32[1];
    122 	} u;
    123 } mac_propval_range_t;
    124 
    125 #define	range_uint32	u.mpr_uint32
    126 
    127 /*
    128  * Maximum MAC address length
    129  */
    130 #define	MAXMACADDRLEN		20
    131 
    132 typedef enum {
    133 	MAC_LOGTYPE_LINK = 1,
    134 	MAC_LOGTYPE_FLOW
    135 } mac_logtype_t;
    136 
    137 /*
    138  * Encodings for public properties.
    139  * A most significant bit value of 1 indicates private property, intended
    140  * to allow private property implementations to use internal encodings
    141  * if desired.
    142  *
    143  * Note that there are 2 sets of parameters: the *_EN_*
    144  * values are those that the Administrator configures for autonegotiation.
    145  * The _ADV_* values are those that are currently exposed over the wire.
    146  */
    147 #define	MAXLINKPROPNAME		256
    148 #define	MAC_PROP_DEFAULT	0x0001		/* default property value */
    149 
    150 /*
    151  * Indicates the linkprop framework is interested in knowing the list of
    152  * possible property values. When used to obtain possible values for a
    153  * property, one may have to change all the drivers. See PSARC 2009/235.
    154  */
    155 #define	MAC_PROP_POSSIBLE	0x0002		/* possible property values */
    156 
    157 typedef enum {
    158 	MAC_PROP_DUPLEX = 0x00000001,
    159 	MAC_PROP_SPEED,
    160 	MAC_PROP_STATUS,
    161 	MAC_PROP_AUTONEG,
    162 	MAC_PROP_EN_AUTONEG,
    163 	MAC_PROP_MTU,
    164 	MAC_PROP_ZONE,
    165 	MAC_PROP_AUTOPUSH,
    166 	MAC_PROP_FLOWCTRL,
    167 	MAC_PROP_ADV_1000FDX_CAP,
    168 	MAC_PROP_EN_1000FDX_CAP,
    169 	MAC_PROP_ADV_1000HDX_CAP,
    170 	MAC_PROP_EN_1000HDX_CAP,
    171 	MAC_PROP_ADV_100FDX_CAP,
    172 	MAC_PROP_EN_100FDX_CAP,
    173 	MAC_PROP_ADV_100HDX_CAP,
    174 	MAC_PROP_EN_100HDX_CAP,
    175 	MAC_PROP_ADV_10FDX_CAP,
    176 	MAC_PROP_EN_10FDX_CAP,
    177 	MAC_PROP_ADV_10HDX_CAP,
    178 	MAC_PROP_EN_10HDX_CAP,
    179 	MAC_PROP_ADV_100T4_CAP,
    180 	MAC_PROP_EN_100T4_CAP,
    181 	MAC_PROP_IPTUN_HOPLIMIT,
    182 	MAC_PROP_IPTUN_ENCAPLIMIT,
    183 	MAC_PROP_WL_ESSID,
    184 	MAC_PROP_WL_BSSID,
    185 	MAC_PROP_WL_BSSTYPE,
    186 	MAC_PROP_WL_LINKSTATUS,
    187 	MAC_PROP_WL_DESIRED_RATES,
    188 	MAC_PROP_WL_SUPPORTED_RATES,
    189 	MAC_PROP_WL_AUTH_MODE,
    190 	MAC_PROP_WL_ENCRYPTION,
    191 	MAC_PROP_WL_RSSI,
    192 	MAC_PROP_WL_PHY_CONFIG,
    193 	MAC_PROP_WL_CAPABILITY,
    194 	MAC_PROP_WL_WPA,
    195 	MAC_PROP_WL_SCANRESULTS,
    196 	MAC_PROP_WL_POWER_MODE,
    197 	MAC_PROP_WL_RADIO,
    198 	MAC_PROP_WL_ESS_LIST,
    199 	MAC_PROP_WL_KEY_TAB,
    200 	MAC_PROP_WL_CREATE_IBSS,
    201 	MAC_PROP_WL_SETOPTIE,
    202 	MAC_PROP_WL_DELKEY,
    203 	MAC_PROP_WL_KEY,
    204 	MAC_PROP_WL_MLME,
    205 	MAC_PROP_MAXBW,
    206 	MAC_PROP_PRIO,
    207 	MAC_PROP_BIND_CPU,
    208 	MAC_PROP_TAGMODE,
    209 	MAC_PROP_ADV_10GFDX_CAP,
    210 	MAC_PROP_EN_10GFDX_CAP,
    211 	MAC_PROP_PVID,
    212 	MAC_PROP_LLIMIT,
    213 	MAC_PROP_LDECAY,
    214 	MAC_PROP_PROTECT,
    215 	MAC_PROP_PRIVATE = -1
    216 } mac_prop_id_t;
    217 
    218 /*
    219  * Flags to figure out r/w status of legacy ndd props.
    220  */
    221 #define	MAC_PROP_PERM_READ		0x0001
    222 #define	MAC_PROP_PERM_WRITE		0x0010
    223 #define	MAC_PROP_MAP_KSTAT		0x0100
    224 #define	MAC_PROP_PERM_RW		(MAC_PROP_PERM_READ|MAC_PROP_PERM_WRITE)
    225 #define	MAC_PROP_FLAGS_RK		(MAC_PROP_PERM_READ|MAC_PROP_MAP_KSTAT)
    226 
    227 #ifdef	_KERNEL
    228 
    229 /*
    230  * There are three ranges of statistics values.  0 to 1 - MAC_STAT_MIN are
    231  * interface statistics maintained by the mac module.  MAC_STAT_MIN to 1 -
    232  * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and
    233  * maintained by each driver.  MACTYPE_STAT_MIN and above are statistics
    234  * defined by MAC-Type plugins and maintained by each driver.
    235  */
    236 #define	MAC_STAT_MIN		1000
    237 #define	MACTYPE_STAT_MIN	2000
    238 
    239 #define	IS_MAC_STAT(stat)	\
    240 	(stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN)
    241 #define	IS_MACTYPE_STAT(stat)	(stat >= MACTYPE_STAT_MIN)
    242 
    243 /*
    244  * Statistics maintained by the mac module, and possibly populated as link
    245  * statistics.
    246  */
    247 enum mac_mod_stat {
    248 	MAC_STAT_LINK_STATE,
    249 	MAC_STAT_LINK_UP,
    250 	MAC_STAT_PROMISC,
    251 	MAC_STAT_LOWLINK_STATE
    252 };
    253 
    254 /*
    255  * Do not reorder, and add only to the end of this list.
    256  */
    257 enum mac_driver_stat {
    258 	/* MIB-II stats (RFC 1213 and RFC 1573) */
    259 	MAC_STAT_IFSPEED = MAC_STAT_MIN,
    260 	MAC_STAT_MULTIRCV,
    261 	MAC_STAT_BRDCSTRCV,
    262 	MAC_STAT_MULTIXMT,
    263 	MAC_STAT_BRDCSTXMT,
    264 	MAC_STAT_NORCVBUF,
    265 	MAC_STAT_IERRORS,
    266 	MAC_STAT_UNKNOWNS,
    267 	MAC_STAT_NOXMTBUF,
    268 	MAC_STAT_OERRORS,
    269 	MAC_STAT_COLLISIONS,
    270 	MAC_STAT_RBYTES,
    271 	MAC_STAT_IPACKETS,
    272 	MAC_STAT_OBYTES,
    273 	MAC_STAT_OPACKETS,
    274 	MAC_STAT_UNDERFLOWS,
    275 	MAC_STAT_OVERFLOWS
    276 };
    277 
    278 #define	MAC_NSTAT	(MAC_STAT_OVERFLOWS - MAC_STAT_IFSPEED + 1)
    279 
    280 #define	MAC_STAT_ISACOUNTER(_stat) (		\
    281 	    (_stat) == MAC_STAT_MULTIRCV ||	\
    282 	    (_stat) == MAC_STAT_BRDCSTRCV ||	\
    283 	    (_stat) == MAC_STAT_MULTIXMT ||	\
    284 	    (_stat) == MAC_STAT_BRDCSTXMT ||	\
    285 	    (_stat) == MAC_STAT_NORCVBUF ||	\
    286 	    (_stat) == MAC_STAT_IERRORS ||	\
    287 	    (_stat) == MAC_STAT_UNKNOWNS ||	\
    288 	    (_stat) == MAC_STAT_NOXMTBUF ||	\
    289 	    (_stat) == MAC_STAT_OERRORS ||	\
    290 	    (_stat) == MAC_STAT_COLLISIONS ||	\
    291 	    (_stat) == MAC_STAT_RBYTES ||	\
    292 	    (_stat) == MAC_STAT_IPACKETS ||	\
    293 	    (_stat) == MAC_STAT_OBYTES ||	\
    294 	    (_stat) == MAC_STAT_OPACKETS ||	\
    295 	    (_stat) == MAC_STAT_UNDERFLOWS ||	\
    296 	    (_stat) == MAC_STAT_OVERFLOWS)
    297 
    298 /*
    299  * Immutable information. (This may not be modified after registration).
    300  */
    301 typedef struct mac_info_s {
    302 	uint_t		mi_media;
    303 	uint_t		mi_nativemedia;
    304 	uint_t		mi_addr_length;
    305 	uint8_t		*mi_unicst_addr;
    306 	uint8_t		*mi_brdcst_addr;
    307 } mac_info_t;
    308 
    309 /*
    310  * When VNICs are created on top of the NIC, there are two levels
    311  * of MAC layer, a lower MAC, which is the MAC layer at the level of the
    312  * physical NIC, and an upper MAC, which is the MAC layer at the level
    313  * of the VNIC. Each VNIC maps to a MAC client at the lower MAC, and
    314  * the SRS and classification is done at the lower MAC level. The upper
    315  * MAC is therefore for the most part pass-through, and therefore
    316  * special processing needs to be done at the upper MAC layer when
    317  * dealing with a VNIC.
    318  *
    319  * This capability allows the MAC layer to detect when a VNIC is being
    320  * access, and implement the required shortcuts.
    321  */
    322 
    323 typedef void *(*mac_client_handle_fn_t)(void *);
    324 
    325 typedef struct mac_capab_vnic_s {
    326 	void			*mcv_arg;
    327 	mac_client_handle_fn_t	mcv_mac_client_handle;
    328 } mac_capab_vnic_t;
    329 
    330 typedef void (*mac_rename_fn_t)(const char *, void *);
    331 typedef struct mac_capab_aggr_s {
    332 	mac_rename_fn_t mca_rename_fn;
    333 	int (*mca_unicst)(void *, const uint8_t *);
    334 } mac_capab_aggr_t;
    335 
    336 /* Bridge transmit and receive function signatures */
    337 typedef mblk_t *(*mac_bridge_tx_t)(mac_handle_t, mac_ring_handle_t, mblk_t *);
    338 typedef void (*mac_bridge_rx_t)(mac_handle_t, mac_resource_handle_t, mblk_t *);
    339 typedef void (*mac_bridge_ref_t)(mac_handle_t, boolean_t);
    340 typedef link_state_t (*mac_bridge_ls_t)(mac_handle_t, link_state_t);
    341 
    342 /* must change mac_notify_cb_list[] in mac_provider.c if this is changed */
    343 typedef enum {
    344 	MAC_NOTE_LINK,
    345 	MAC_NOTE_UNICST,
    346 	MAC_NOTE_TX,
    347 	MAC_NOTE_DEVPROMISC,
    348 	MAC_NOTE_FASTPATH_FLUSH,
    349 	MAC_NOTE_SDU_SIZE,
    350 	MAC_NOTE_DEST,
    351 	MAC_NOTE_MARGIN,
    352 	MAC_NOTE_CAPAB_CHG,
    353 	MAC_NOTE_LOWLINK,
    354 	MAC_NNOTE	/* must be the last entry */
    355 } mac_notify_type_t;
    356 
    357 typedef void		(*mac_notify_t)(void *, mac_notify_type_t);
    358 typedef void		(*mac_rx_t)(void *, mac_resource_handle_t, mblk_t *,
    359 			    boolean_t);
    360 typedef	mblk_t		*(*mac_receive_t)(void *, int);
    361 
    362 /*
    363  * MAC resource types
    364  */
    365 typedef enum {
    366 	MAC_RX_FIFO = 1
    367 } mac_resource_type_t;
    368 
    369 typedef	int	(*mac_intr_enable_t)(mac_intr_handle_t);
    370 typedef	int	(*mac_intr_disable_t)(mac_intr_handle_t);
    371 
    372 typedef	struct mac_intr_s {
    373 	mac_intr_handle_t	mi_handle;
    374 	mac_intr_enable_t	mi_enable;
    375 	mac_intr_disable_t	mi_disable;
    376 } mac_intr_t;
    377 
    378 typedef struct mac_rx_fifo_s {
    379 	mac_resource_type_t	mrf_type;	/* MAC_RX_FIFO */
    380 	mac_intr_t		mrf_intr;
    381 	mac_receive_t		mrf_receive;
    382 	void			*mrf_rx_arg;
    383 	uint32_t		mrf_flow_priority;
    384 	/*
    385 	 * The CPU this flow is to be processed on. With intrd and future
    386 	 * things, we should know which CPU the flow needs to be processed
    387 	 * and get a squeue assigned on that CPU.
    388 	 */
    389 	uint_t			mrf_cpu_id;
    390 } mac_rx_fifo_t;
    391 
    392 #define	mrf_intr_handle		mrf_intr.mi_handle
    393 #define	mrf_intr_enable		mrf_intr.mi_enable
    394 #define	mrf_intr_disable	mrf_intr.mi_disable
    395 
    396 typedef union mac_resource_u {
    397 	mac_resource_type_t	mr_type;
    398 	mac_rx_fifo_t		mr_fifo;
    399 } mac_resource_t;
    400 
    401 typedef enum {
    402 	MAC_ADDRTYPE_UNICAST,
    403 	MAC_ADDRTYPE_MULTICAST,
    404 	MAC_ADDRTYPE_BROADCAST
    405 } mac_addrtype_t;
    406 
    407 typedef struct mac_header_info_s {
    408 	size_t		mhi_hdrsize;
    409 	size_t		mhi_pktsize;
    410 	const uint8_t	*mhi_daddr;
    411 	const uint8_t	*mhi_saddr;
    412 	uint32_t	mhi_origsap;
    413 	uint32_t	mhi_bindsap;
    414 	mac_addrtype_t	mhi_dsttype;
    415 	uint16_t	mhi_tci;
    416 	boolean_t	mhi_istagged;
    417 	boolean_t	mhi_ispvid;
    418 } mac_header_info_t;
    419 
    420 /*
    421  * Function pointer to match dls client signature. Should be same as
    422  * dls_rx_t to allow a soft ring to bypass DLS layer and call a DLS
    423  * client directly.
    424  */
    425 typedef	void		(*mac_direct_rx_t)(void *, mac_resource_handle_t,
    426 				mblk_t *, mac_header_info_t *);
    427 
    428 typedef mac_resource_handle_t	(*mac_resource_add_t)(void *, mac_resource_t *);
    429 typedef int			(*mac_resource_bind_t)(void *,
    430     mac_resource_handle_t, processorid_t);
    431 typedef void			(*mac_resource_remove_t)(void *, void *);
    432 typedef void			(*mac_resource_quiesce_t)(void *, void *);
    433 typedef void			(*mac_resource_restart_t)(void *, void *);
    434 typedef int			(*mac_resource_modify_t)(void *, void *,
    435 				    mac_resource_t *);
    436 typedef	void			(*mac_change_upcall_t)(void *, mac_direct_rx_t,
    437     void *);
    438 
    439 /*
    440  * MAC-Type plugin interfaces
    441  */
    442 
    443 typedef int		(*mtops_addr_verify_t)(const void *, void *);
    444 typedef boolean_t	(*mtops_sap_verify_t)(uint32_t, uint32_t *, void *);
    445 typedef mblk_t		*(*mtops_header_t)(const void *, const void *,
    446     uint32_t, void *, mblk_t *, size_t);
    447 typedef int		(*mtops_header_info_t)(mblk_t *, void *,
    448     mac_header_info_t *);
    449 typedef boolean_t	(*mtops_pdata_verify_t)(void *, size_t);
    450 typedef	mblk_t		*(*mtops_header_modify_t)(mblk_t *, void *);
    451 typedef void		(*mtops_link_details_t)(char *, size_t, mac_handle_t,
    452     void *);
    453 
    454 typedef struct mactype_ops_s {
    455 	uint_t			mtops_ops;
    456 	/*
    457 	 * mtops_unicst_verify() returns 0 if the given address is a valid
    458 	 * unicast address, or a non-zero errno otherwise.
    459 	 */
    460 	mtops_addr_verify_t	mtops_unicst_verify;
    461 	/*
    462 	 * mtops_multicst_verify() returns 0 if the given address is a
    463 	 * valid multicast address, or a non-zero errno otherwise.  If the
    464 	 * media doesn't support multicast, ENOTSUP should be returned (for
    465 	 * example).
    466 	 */
    467 	mtops_addr_verify_t	mtops_multicst_verify;
    468 	/*
    469 	 * mtops_sap_verify() returns B_TRUE if the given SAP is a valid
    470 	 * SAP value, or B_FALSE otherwise.
    471 	 */
    472 	mtops_sap_verify_t	mtops_sap_verify;
    473 	/*
    474 	 * mtops_header() is used to allocate and construct a MAC header.
    475 	 */
    476 	mtops_header_t		mtops_header;
    477 	/*
    478 	 * mtops_header_info() is used to gather information on a given MAC
    479 	 * header.
    480 	 */
    481 	mtops_header_info_t	mtops_header_info;
    482 	/*
    483 	 * mtops_pdata_verify() is used to verify the validity of MAC
    484 	 * plugin data.  It is called by mac_register() if the driver has
    485 	 * supplied MAC plugin data, and also by mac_pdata_update() when
    486 	 * drivers update the data.
    487 	 */
    488 	mtops_pdata_verify_t	mtops_pdata_verify;
    489 	/*
    490 	 * mtops_header_cook() is an optional callback that converts (or
    491 	 * "cooks") the given raw header (as sent by a raw DLPI consumer)
    492 	 * into one that is appropriate to send down to the MAC driver.
    493 	 * Following the example above, an Ethernet header sent down by a
    494 	 * DLPI consumer would be converted to whatever header the MAC
    495 	 * driver expects.
    496 	 */
    497 	mtops_header_modify_t	mtops_header_cook;
    498 	/*
    499 	 * mtops_header_uncook() is an optional callback that does the
    500 	 * opposite of mtops_header_cook().  It "uncooks" a given MAC
    501 	 * header (as received from the driver) for consumption by raw DLPI
    502 	 * consumers.  For example, for a non-Ethernet plugin that wants
    503 	 * raw DLPI consumers to be fooled into thinking that the device
    504 	 * provides Ethernet access, this callback would modify the given
    505 	 * mblk_t such that the MAC header is converted to an Ethernet
    506 	 * header.
    507 	 */
    508 	mtops_header_modify_t	mtops_header_uncook;
    509 	/*
    510 	 * mtops_link_details() is an optional callback that provides
    511 	 * extended information about the link state.  Its primary purpose
    512 	 * is to provide type-specific support for syslog contents on
    513 	 * link up events.  If no implementation is provided, then a default
    514 	 * implementation will be used.
    515 	 */
    516 	mtops_link_details_t	mtops_link_details;
    517 } mactype_ops_t;
    518 
    519 /*
    520  * mtops_ops exists for the plugin to enumerate the optional callback
    521  * entrypoints it has defined.  This allows the mac module to define
    522  * additional plugin entrypoints in mactype_ops_t without breaking backward
    523  * compatibility with old plugins.
    524  */
    525 #define	MTOPS_PDATA_VERIFY	0x001
    526 #define	MTOPS_HEADER_COOK	0x002
    527 #define	MTOPS_HEADER_UNCOOK	0x004
    528 #define	MTOPS_LINK_DETAILS	0x008
    529 
    530 /*
    531  * Provide mapping for legacy ndd ioctls relevant to that mactype.
    532  * Note that the ndd ioctls are obsolete, and may be removed in a future
    533  * release of Solaris. The ndd ioctls are not typically used in legacy
    534  * ethernet drivers. New datalink drivers of all link-types should use
    535  * dladm(1m) interfaces for administering tunables and not have to provide
    536  * a mapping.
    537  */
    538 typedef struct mac_ndd_mapping_s {
    539 	char		*mp_name;
    540 	union {
    541 		mac_prop_id_t   u_id;
    542 		uint_t		u_kstat;
    543 	} u_mp_id;
    544 	long		mp_minval;
    545 	long		mp_maxval;
    546 	size_t		mp_valsize;
    547 	int		mp_flags;
    548 } mac_ndd_mapping_t;
    549 
    550 #define	mp_prop_id	u_mp_id.u_id
    551 #define	mp_kstat	u_mp_id.u_kstat
    552 
    553 typedef struct mac_stat_info_s {
    554 	uint_t		msi_stat;
    555 	char		*msi_name;
    556 	uint_t		msi_type;	/* as defined in kstat_named_init(9F) */
    557 	uint64_t	msi_default;
    558 } mac_stat_info_t;
    559 
    560 typedef struct mactype_register_s {
    561 	uint_t		mtr_version;	/* set by mactype_alloc() */
    562 	const char	*mtr_ident;
    563 	mactype_ops_t	*mtr_ops;
    564 	uint_t		mtr_mactype;
    565 	uint_t		mtr_nativetype;
    566 	uint_t		mtr_addrlen;
    567 	uint8_t		*mtr_brdcst_addr;
    568 	mac_stat_info_t	*mtr_stats;
    569 	size_t		mtr_statcount;
    570 	mac_ndd_mapping_t *mtr_mapping;
    571 	size_t		mtr_mappingcount;
    572 } mactype_register_t;
    573 
    574 typedef struct mac_prop_s {
    575 	mac_prop_id_t	mp_id;
    576 	char		*mp_name;
    577 	uint_t		mp_flags;
    578 } mac_prop_t;
    579 
    580 /*
    581  * Driver interface functions.
    582  */
    583 extern int			mac_open_by_linkid(datalink_id_t,
    584 				    mac_handle_t *);
    585 extern int			mac_open_by_linkname(const char *,
    586 				    mac_handle_t *);
    587 extern const char		*mac_name(mac_handle_t);
    588 extern minor_t			mac_minor(mac_handle_t);
    589 extern minor_t			mac_minor_hold(boolean_t);
    590 extern void			mac_minor_rele(minor_t);
    591 extern void			mac_sdu_get(mac_handle_t, uint_t *, uint_t *);
    592 extern int			mac_maxsdu_update(mac_handle_t, uint_t);
    593 extern uint_t			mac_addr_len(mac_handle_t);
    594 extern int			mac_type(mac_handle_t);
    595 
    596 extern void 			mac_unicst_update(mac_handle_t,
    597 				    const uint8_t *);
    598 extern void			mac_capab_update(mac_handle_t);
    599 extern int			mac_pdata_update(mac_handle_t, void *,
    600 				    size_t);
    601 extern boolean_t		mac_margin_update(mac_handle_t, uint32_t);
    602 extern void			mac_margin_get(mac_handle_t, uint32_t *);
    603 extern int			mac_margin_remove(mac_handle_t, uint32_t);
    604 extern int			mac_margin_add(mac_handle_t, uint32_t *,
    605 				    boolean_t);
    606 extern int			mac_fastpath_disable(mac_handle_t);
    607 extern void			mac_fastpath_enable(mac_handle_t);
    608 extern void			mac_no_active(mac_handle_t);
    609 
    610 extern mactype_register_t	*mactype_alloc(uint_t);
    611 extern void			mactype_free(mactype_register_t *);
    612 extern int			mactype_register(mactype_register_t *);
    613 extern int			mactype_unregister(const char *);
    614 
    615 extern int			mac_start_logusage(mac_logtype_t, uint_t);
    616 extern void			mac_stop_logusage(mac_logtype_t);
    617 
    618 extern mac_handle_t		mac_get_lower_mac_handle(mac_handle_t);
    619 
    620 /*
    621  * Packet hashing for distribution to multiple ports and rings.
    622  */
    623 
    624 #define	MAC_PKT_HASH_L2		0x01
    625 #define	MAC_PKT_HASH_L3		0x02
    626 #define	MAC_PKT_HASH_L4		0x04
    627 
    628 extern uint64_t			mac_pkt_hash(uint_t, mblk_t *, uint8_t,
    629 				    boolean_t);
    630 
    631 /*
    632  * Bridging linkage
    633  */
    634 extern void			mac_rx_common(mac_handle_t,
    635 				    mac_resource_handle_t, mblk_t *);
    636 extern int			mac_bridge_set(mac_handle_t, mac_handle_t);
    637 extern void			mac_bridge_clear(mac_handle_t, mac_handle_t);
    638 extern void			mac_bridge_vectors(mac_bridge_tx_t,
    639 				    mac_bridge_rx_t, mac_bridge_ref_t,
    640 				    mac_bridge_ls_t);
    641 
    642 /* special case function for TRILL observability */
    643 extern void			mac_trill_snoop(mac_handle_t, mblk_t *);
    644 
    645 #endif	/* _KERNEL */
    646 
    647 #ifdef	__cplusplus
    648 }
    649 #endif
    650 
    651 #endif /* _SYS_MAC_H */
    652