17c478bd9Sstevel@tonic-gate /* 27c478bd9Sstevel@tonic-gate * CDDL HEADER START 37c478bd9Sstevel@tonic-gate * 47c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5ba2e4443Sseb * Common Development and Distribution License (the "License"). 6ba2e4443Sseb * You may not use this file except in compliance with the License. 77c478bd9Sstevel@tonic-gate * 87c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 97c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 107c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 117c478bd9Sstevel@tonic-gate * and limitations under the License. 127c478bd9Sstevel@tonic-gate * 137c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 147c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 157c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 167c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 177c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 187c478bd9Sstevel@tonic-gate * 197c478bd9Sstevel@tonic-gate * CDDL HEADER END 207c478bd9Sstevel@tonic-gate */ 21da14cebeSEric Cheng 227c478bd9Sstevel@tonic-gate /* 231cfa752fSRamaswamy Tummala * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24*a776d98eSRobert Mustacchi * Copyright (c) 2014, Joyent, Inc. All rights reserved. 257c478bd9Sstevel@tonic-gate */ 267c478bd9Sstevel@tonic-gate 277c478bd9Sstevel@tonic-gate #ifndef _SYS_MAC_H 287c478bd9Sstevel@tonic-gate #define _SYS_MAC_H 297c478bd9Sstevel@tonic-gate 30605445d5Sdg199075 #include <sys/types.h> 3182a2fc47SJames Carlson #ifdef _KERNEL 327c478bd9Sstevel@tonic-gate #include <sys/sunddi.h> 3382a2fc47SJames Carlson #endif 347c478bd9Sstevel@tonic-gate 357c478bd9Sstevel@tonic-gate /* 367c478bd9Sstevel@tonic-gate * MAC Services Module 377c478bd9Sstevel@tonic-gate */ 387c478bd9Sstevel@tonic-gate 397c478bd9Sstevel@tonic-gate #ifdef __cplusplus 407c478bd9Sstevel@tonic-gate extern "C" { 417c478bd9Sstevel@tonic-gate #endif 427c478bd9Sstevel@tonic-gate 437c478bd9Sstevel@tonic-gate /* 447c478bd9Sstevel@tonic-gate * MAC Information (text emitted by modinfo(1m)) 457c478bd9Sstevel@tonic-gate */ 4661af1958SGarrett D'Amore #define MAC_INFO "MAC Services" 47ba2e4443Sseb 48ba2e4443Sseb /* 49ba2e4443Sseb * MAC-Type version identifier. This is used by mactype_alloc() and 50ba2e4443Sseb * mactype_register() to verify that incompatible MAC-Type plugins don't 51ba2e4443Sseb * register. 52ba2e4443Sseb */ 53ba2e4443Sseb #define MACTYPE_VERSION 0x1 54ba2e4443Sseb 55ba2e4443Sseb /* 56da14cebeSEric Cheng * Opaque handle types 577c478bd9Sstevel@tonic-gate */ 58da14cebeSEric Cheng typedef struct __mac_handle *mac_handle_t; 59da14cebeSEric Cheng typedef struct __mac_resource_handle *mac_resource_handle_t; 60da14cebeSEric Cheng typedef struct __mac_notify_handle *mac_notify_handle_t; 61da14cebeSEric Cheng typedef struct __mac_tx_notify_handle *mac_tx_notify_handle_t; 62da14cebeSEric Cheng typedef struct __mac_intr_handle *mac_intr_handle_t; 63da14cebeSEric Cheng typedef struct __mac_ring_handle *mac_ring_handle_t; 64da14cebeSEric Cheng typedef struct __mac_group_handle *mac_group_handle_t; 657c478bd9Sstevel@tonic-gate 66da14cebeSEric Cheng #define DATALINK_INVALID_LINKID 0 67da14cebeSEric Cheng #define DATALINK_ALL_LINKID 0 68da14cebeSEric Cheng #define DATALINK_MAX_LINKID 0xffffffff 69da14cebeSEric Cheng 707c478bd9Sstevel@tonic-gate typedef enum { 717c478bd9Sstevel@tonic-gate LINK_STATE_UNKNOWN = -1, 727c478bd9Sstevel@tonic-gate LINK_STATE_DOWN, 737c478bd9Sstevel@tonic-gate LINK_STATE_UP 747c478bd9Sstevel@tonic-gate } link_state_t; 757c478bd9Sstevel@tonic-gate 767c478bd9Sstevel@tonic-gate typedef enum { 777c478bd9Sstevel@tonic-gate LINK_DUPLEX_UNKNOWN = 0, 787c478bd9Sstevel@tonic-gate LINK_DUPLEX_HALF, 797c478bd9Sstevel@tonic-gate LINK_DUPLEX_FULL 807c478bd9Sstevel@tonic-gate } link_duplex_t; 817c478bd9Sstevel@tonic-gate 82e7801d59Ssowmini typedef enum { 83e7801d59Ssowmini LINK_FLOWCTRL_NONE = 0, 84e7801d59Ssowmini LINK_FLOWCTRL_RX, 85e7801d59Ssowmini LINK_FLOWCTRL_TX, 86e7801d59Ssowmini LINK_FLOWCTRL_BI 87e7801d59Ssowmini } link_flowctrl_t; 88e7801d59Ssowmini 89e75f0919SSebastien Roy typedef enum { 90e75f0919SSebastien Roy LINK_TAGMODE_VLANONLY = 0, 91e75f0919SSebastien Roy LINK_TAGMODE_NORMAL 92e75f0919SSebastien Roy } link_tagmode_t; 93e75f0919SSebastien Roy 94da14cebeSEric Cheng /* 950dc2366fSVenugopal Iyer * Defines range of uint32_t values 96f0f2c3a5SGirish Moodalbail */ 97f0f2c3a5SGirish Moodalbail typedef struct mac_propval_uint32_range_s { 98f0f2c3a5SGirish Moodalbail uint32_t mpur_min; 99f0f2c3a5SGirish Moodalbail uint32_t mpur_max; 100f0f2c3a5SGirish Moodalbail } mac_propval_uint32_range_t; 101f0f2c3a5SGirish Moodalbail 102f0f2c3a5SGirish Moodalbail /* 1030dc2366fSVenugopal Iyer * Data type of property values. 104f0f2c3a5SGirish Moodalbail */ 105f0f2c3a5SGirish Moodalbail typedef enum { 1060dc2366fSVenugopal Iyer MAC_PROPVAL_UINT8, 1070dc2366fSVenugopal Iyer MAC_PROPVAL_UINT32, 1080dc2366fSVenugopal Iyer MAC_PROPVAL_STR 109f0f2c3a5SGirish Moodalbail } mac_propval_type_t; 110f0f2c3a5SGirish Moodalbail 111f0f2c3a5SGirish Moodalbail /* 112f0f2c3a5SGirish Moodalbail * Captures possible values for a given property. A property can have 113f0f2c3a5SGirish Moodalbail * range of values (int32, int64, uint32, uint64, et al) or collection/ 114f0f2c3a5SGirish Moodalbail * enumeration of values (strings). 115f0f2c3a5SGirish Moodalbail * Can be used as a value-result parameter. 116f0f2c3a5SGirish Moodalbail */ 117f0f2c3a5SGirish Moodalbail typedef struct mac_propval_range_s { 118f0f2c3a5SGirish Moodalbail uint_t mpr_count; /* count of ranges */ 119f0f2c3a5SGirish Moodalbail mac_propval_type_t mpr_type; /* type of value */ 120f0f2c3a5SGirish Moodalbail union { 121f0f2c3a5SGirish Moodalbail mac_propval_uint32_range_t mpr_uint32[1]; 122f0f2c3a5SGirish Moodalbail } u; 123f0f2c3a5SGirish Moodalbail } mac_propval_range_t; 124f0f2c3a5SGirish Moodalbail 1250dc2366fSVenugopal Iyer #define mpr_range_uint32 u.mpr_uint32 126f0f2c3a5SGirish Moodalbail 127f0f2c3a5SGirish Moodalbail /* 128da14cebeSEric Cheng * Maximum MAC address length 129da14cebeSEric Cheng */ 130da14cebeSEric Cheng #define MAXMACADDRLEN 20 131da14cebeSEric Cheng 1321a41ca23SJerry Jelinek #define MPT_MAXMACADDR 32 1331a41ca23SJerry Jelinek 1341a41ca23SJerry Jelinek typedef struct mac_secondary_addr_s { 1351a41ca23SJerry Jelinek uint32_t ms_addrcnt; 1361a41ca23SJerry Jelinek uint8_t ms_addrs[MPT_MAXMACADDR][MAXMACADDRLEN]; 1371a41ca23SJerry Jelinek } mac_secondary_addr_t; 1381a41ca23SJerry Jelinek 139da14cebeSEric Cheng typedef enum { 140da14cebeSEric Cheng MAC_LOGTYPE_LINK = 1, 141da14cebeSEric Cheng MAC_LOGTYPE_FLOW 142da14cebeSEric Cheng } mac_logtype_t; 1433fd94f8cSam223141 1440dc2366fSVenugopal Iyer #define MAXLINKPROPNAME 256 /* max property name len */ 1450dc2366fSVenugopal Iyer 1463fd94f8cSam223141 /* 1470dc2366fSVenugopal Iyer * Public properties. 1483fd94f8cSam223141 * 1490dc2366fSVenugopal Iyer * Note that there are 2 sets of parameters: the *_EN_* values are 1500dc2366fSVenugopal Iyer * those that the Administrator configures for autonegotiation. The 1510dc2366fSVenugopal Iyer * _ADV_* values are those that are currently exposed over the wire. 1523fd94f8cSam223141 */ 1533fd94f8cSam223141 typedef enum { 1543fd94f8cSam223141 MAC_PROP_DUPLEX = 0x00000001, 1553fd94f8cSam223141 MAC_PROP_SPEED, 1563fd94f8cSam223141 MAC_PROP_STATUS, 1573fd94f8cSam223141 MAC_PROP_AUTONEG, 1583fd94f8cSam223141 MAC_PROP_EN_AUTONEG, 1593fd94f8cSam223141 MAC_PROP_MTU, 1603bc21d0aSAruna Ramakrishna - Sun Microsystems MAC_PROP_ZONE, 1613bc21d0aSAruna Ramakrishna - Sun Microsystems MAC_PROP_AUTOPUSH, 1623fd94f8cSam223141 MAC_PROP_FLOWCTRL, 1633fd94f8cSam223141 MAC_PROP_ADV_1000FDX_CAP, 1643fd94f8cSam223141 MAC_PROP_EN_1000FDX_CAP, 1653fd94f8cSam223141 MAC_PROP_ADV_1000HDX_CAP, 1663fd94f8cSam223141 MAC_PROP_EN_1000HDX_CAP, 1673fd94f8cSam223141 MAC_PROP_ADV_100FDX_CAP, 1683fd94f8cSam223141 MAC_PROP_EN_100FDX_CAP, 1693fd94f8cSam223141 MAC_PROP_ADV_100HDX_CAP, 1703fd94f8cSam223141 MAC_PROP_EN_100HDX_CAP, 1713fd94f8cSam223141 MAC_PROP_ADV_10FDX_CAP, 1723fd94f8cSam223141 MAC_PROP_EN_10FDX_CAP, 1733fd94f8cSam223141 MAC_PROP_ADV_10HDX_CAP, 1743fd94f8cSam223141 MAC_PROP_EN_10HDX_CAP, 1753fd94f8cSam223141 MAC_PROP_ADV_100T4_CAP, 1763fd94f8cSam223141 MAC_PROP_EN_100T4_CAP, 1772b24ab6bSSebastien Roy MAC_PROP_IPTUN_HOPLIMIT, 1782b24ab6bSSebastien Roy MAC_PROP_IPTUN_ENCAPLIMIT, 179bcb5c89dSSowmini Varadhan MAC_PROP_WL_ESSID, 180bcb5c89dSSowmini Varadhan MAC_PROP_WL_BSSID, 181bcb5c89dSSowmini Varadhan MAC_PROP_WL_BSSTYPE, 182bcb5c89dSSowmini Varadhan MAC_PROP_WL_LINKSTATUS, 183bcb5c89dSSowmini Varadhan MAC_PROP_WL_DESIRED_RATES, 184bcb5c89dSSowmini Varadhan MAC_PROP_WL_SUPPORTED_RATES, 185bcb5c89dSSowmini Varadhan MAC_PROP_WL_AUTH_MODE, 186bcb5c89dSSowmini Varadhan MAC_PROP_WL_ENCRYPTION, 187bcb5c89dSSowmini Varadhan MAC_PROP_WL_RSSI, 188bcb5c89dSSowmini Varadhan MAC_PROP_WL_PHY_CONFIG, 189bcb5c89dSSowmini Varadhan MAC_PROP_WL_CAPABILITY, 190bcb5c89dSSowmini Varadhan MAC_PROP_WL_WPA, 191bcb5c89dSSowmini Varadhan MAC_PROP_WL_SCANRESULTS, 192bcb5c89dSSowmini Varadhan MAC_PROP_WL_POWER_MODE, 193bcb5c89dSSowmini Varadhan MAC_PROP_WL_RADIO, 194bcb5c89dSSowmini Varadhan MAC_PROP_WL_ESS_LIST, 195bcb5c89dSSowmini Varadhan MAC_PROP_WL_KEY_TAB, 196bcb5c89dSSowmini Varadhan MAC_PROP_WL_CREATE_IBSS, 197bcb5c89dSSowmini Varadhan MAC_PROP_WL_SETOPTIE, 198bcb5c89dSSowmini Varadhan MAC_PROP_WL_DELKEY, 199bcb5c89dSSowmini Varadhan MAC_PROP_WL_KEY, 200bcb5c89dSSowmini Varadhan MAC_PROP_WL_MLME, 201e75f0919SSebastien Roy MAC_PROP_TAGMODE, 202aca118b7Slucy wang - Sun Microsystems - Beijing China MAC_PROP_ADV_10GFDX_CAP, 203aca118b7Slucy wang - Sun Microsystems - Beijing China MAC_PROP_EN_10GFDX_CAP, 2044eaa4710SRishi Srivatsavai MAC_PROP_PVID, 2054eaa4710SRishi Srivatsavai MAC_PROP_LLIMIT, 2064eaa4710SRishi Srivatsavai MAC_PROP_LDECAY, 2070dc2366fSVenugopal Iyer MAC_PROP_RESOURCE, 2080dc2366fSVenugopal Iyer MAC_PROP_RESOURCE_EFF, 2090dc2366fSVenugopal Iyer MAC_PROP_RXRINGSRANGE, 2100dc2366fSVenugopal Iyer MAC_PROP_TXRINGSRANGE, 2110dc2366fSVenugopal Iyer MAC_PROP_MAX_TX_RINGS_AVAIL, 2120dc2366fSVenugopal Iyer MAC_PROP_MAX_RX_RINGS_AVAIL, 2130dc2366fSVenugopal Iyer MAC_PROP_MAX_RXHWCLNT_AVAIL, 2140dc2366fSVenugopal Iyer MAC_PROP_MAX_TXHWCLNT_AVAIL, 2151cfa752fSRamaswamy Tummala MAC_PROP_IB_LINKMODE, 2161a41ca23SJerry Jelinek MAC_PROP_SECONDARY_ADDRS, 2173fd94f8cSam223141 MAC_PROP_PRIVATE = -1 2183fd94f8cSam223141 } mac_prop_id_t; 2193fd94f8cSam223141 220843e1988Sjohnlev /* 221afdda45fSVasumathi Sundaram - Sun Microsystems * Flags to figure out r/w status of legacy ndd props. 222afdda45fSVasumathi Sundaram - Sun Microsystems */ 223afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_READ 0x0001 224afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_WRITE 0x0010 225afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_MAP_KSTAT 0x0100 226afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_RW (MAC_PROP_PERM_READ|MAC_PROP_PERM_WRITE) 227afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_FLAGS_RK (MAC_PROP_PERM_READ|MAC_PROP_MAP_KSTAT) 228afdda45fSVasumathi Sundaram - Sun Microsystems 2297c478bd9Sstevel@tonic-gate #ifdef _KERNEL 2307c478bd9Sstevel@tonic-gate 2317c478bd9Sstevel@tonic-gate /* 232ba2e4443Sseb * There are three ranges of statistics values. 0 to 1 - MAC_STAT_MIN are 233ba2e4443Sseb * interface statistics maintained by the mac module. MAC_STAT_MIN to 1 - 234ba2e4443Sseb * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and 235ba2e4443Sseb * maintained by each driver. MACTYPE_STAT_MIN and above are statistics 236ba2e4443Sseb * defined by MAC-Type plugins and maintained by each driver. 2377c478bd9Sstevel@tonic-gate */ 238ba2e4443Sseb #define MAC_STAT_MIN 1000 239ba2e4443Sseb #define MACTYPE_STAT_MIN 2000 240ba2e4443Sseb 241ba2e4443Sseb #define IS_MAC_STAT(stat) \ 242ba2e4443Sseb (stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN) 243ba2e4443Sseb #define IS_MACTYPE_STAT(stat) (stat >= MACTYPE_STAT_MIN) 244ba2e4443Sseb 2459b14cf1dSgd78059 /* 246d62bc4baSyz147064 * Statistics maintained by the mac module, and possibly populated as link 247d62bc4baSyz147064 * statistics. 248d62bc4baSyz147064 */ 249d62bc4baSyz147064 enum mac_mod_stat { 250d62bc4baSyz147064 MAC_STAT_LINK_STATE, 251d62bc4baSyz147064 MAC_STAT_LINK_UP, 2524eaa4710SRishi Srivatsavai MAC_STAT_PROMISC, 2530dc2366fSVenugopal Iyer MAC_STAT_LOWLINK_STATE, 2540dc2366fSVenugopal Iyer MAC_STAT_HDROPS 255d62bc4baSyz147064 }; 256d62bc4baSyz147064 257d62bc4baSyz147064 /* 2589b14cf1dSgd78059 * Do not reorder, and add only to the end of this list. 2599b14cf1dSgd78059 */ 260ba2e4443Sseb enum mac_driver_stat { 261ba2e4443Sseb /* MIB-II stats (RFC 1213 and RFC 1573) */ 262ba2e4443Sseb MAC_STAT_IFSPEED = MAC_STAT_MIN, 2637c478bd9Sstevel@tonic-gate MAC_STAT_MULTIRCV, 2647c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTRCV, 2657c478bd9Sstevel@tonic-gate MAC_STAT_MULTIXMT, 2667c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTXMT, 2677c478bd9Sstevel@tonic-gate MAC_STAT_NORCVBUF, 2687c478bd9Sstevel@tonic-gate MAC_STAT_IERRORS, 2697c478bd9Sstevel@tonic-gate MAC_STAT_UNKNOWNS, 2707c478bd9Sstevel@tonic-gate MAC_STAT_NOXMTBUF, 2717c478bd9Sstevel@tonic-gate MAC_STAT_OERRORS, 2727c478bd9Sstevel@tonic-gate MAC_STAT_COLLISIONS, 2737c478bd9Sstevel@tonic-gate MAC_STAT_RBYTES, 2747c478bd9Sstevel@tonic-gate MAC_STAT_IPACKETS, 2757c478bd9Sstevel@tonic-gate MAC_STAT_OBYTES, 2769b14cf1dSgd78059 MAC_STAT_OPACKETS, 2779b14cf1dSgd78059 MAC_STAT_UNDERFLOWS, 2789b14cf1dSgd78059 MAC_STAT_OVERFLOWS 2797c478bd9Sstevel@tonic-gate }; 2807c478bd9Sstevel@tonic-gate 2819b14cf1dSgd78059 #define MAC_NSTAT (MAC_STAT_OVERFLOWS - MAC_STAT_IFSPEED + 1) 282ba2e4443Sseb 283ba2e4443Sseb #define MAC_STAT_ISACOUNTER(_stat) ( \ 284ba2e4443Sseb (_stat) == MAC_STAT_MULTIRCV || \ 285ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTRCV || \ 286ba2e4443Sseb (_stat) == MAC_STAT_MULTIXMT || \ 287ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTXMT || \ 288ba2e4443Sseb (_stat) == MAC_STAT_NORCVBUF || \ 289ba2e4443Sseb (_stat) == MAC_STAT_IERRORS || \ 290ba2e4443Sseb (_stat) == MAC_STAT_UNKNOWNS || \ 291ba2e4443Sseb (_stat) == MAC_STAT_NOXMTBUF || \ 292ba2e4443Sseb (_stat) == MAC_STAT_OERRORS || \ 293ba2e4443Sseb (_stat) == MAC_STAT_COLLISIONS || \ 294ba2e4443Sseb (_stat) == MAC_STAT_RBYTES || \ 295ba2e4443Sseb (_stat) == MAC_STAT_IPACKETS || \ 296ba2e4443Sseb (_stat) == MAC_STAT_OBYTES || \ 2979b14cf1dSgd78059 (_stat) == MAC_STAT_OPACKETS || \ 2989b14cf1dSgd78059 (_stat) == MAC_STAT_UNDERFLOWS || \ 2999b14cf1dSgd78059 (_stat) == MAC_STAT_OVERFLOWS) 300ba2e4443Sseb 3017c478bd9Sstevel@tonic-gate /* 3027c478bd9Sstevel@tonic-gate * Immutable information. (This may not be modified after registration). 3037c478bd9Sstevel@tonic-gate */ 3047c478bd9Sstevel@tonic-gate typedef struct mac_info_s { 3057c478bd9Sstevel@tonic-gate uint_t mi_media; 3060ba2cbe9Sxc151355 uint_t mi_nativemedia; 3077c478bd9Sstevel@tonic-gate uint_t mi_addr_length; 308ba2e4443Sseb uint8_t *mi_unicst_addr; 309ba2e4443Sseb uint8_t *mi_brdcst_addr; 3107c478bd9Sstevel@tonic-gate } mac_info_t; 3117c478bd9Sstevel@tonic-gate 3127c478bd9Sstevel@tonic-gate /* 313da14cebeSEric Cheng * When VNICs are created on top of the NIC, there are two levels 314da14cebeSEric Cheng * of MAC layer, a lower MAC, which is the MAC layer at the level of the 315da14cebeSEric Cheng * physical NIC, and an upper MAC, which is the MAC layer at the level 316da14cebeSEric Cheng * of the VNIC. Each VNIC maps to a MAC client at the lower MAC, and 317da14cebeSEric Cheng * the SRS and classification is done at the lower MAC level. The upper 318da14cebeSEric Cheng * MAC is therefore for the most part pass-through, and therefore 319da14cebeSEric Cheng * special processing needs to be done at the upper MAC layer when 320da14cebeSEric Cheng * dealing with a VNIC. 321678453a8Sspeer * 322da14cebeSEric Cheng * This capability allows the MAC layer to detect when a VNIC is being 323da14cebeSEric Cheng * access, and implement the required shortcuts. 3241a41ca23SJerry Jelinek * 3251a41ca23SJerry Jelinek * In addition, this capability is used to keep the VNIC's secondary 3261a41ca23SJerry Jelinek * mac_clients in sync when the primary MAC is updated. 327678453a8Sspeer */ 328678453a8Sspeer 329da14cebeSEric Cheng typedef void *(*mac_client_handle_fn_t)(void *); 3301a41ca23SJerry Jelinek typedef void (*mac_client_update_fn_t)(void *); 331678453a8Sspeer 332da14cebeSEric Cheng typedef struct mac_capab_vnic_s { 333da14cebeSEric Cheng void *mcv_arg; 334da14cebeSEric Cheng mac_client_handle_fn_t mcv_mac_client_handle; 3351a41ca23SJerry Jelinek mac_client_update_fn_t mcv_mac_secondary_update; 336da14cebeSEric Cheng } mac_capab_vnic_t; 337678453a8Sspeer 338da14cebeSEric Cheng typedef void (*mac_rename_fn_t)(const char *, void *); 3390dc2366fSVenugopal Iyer typedef mblk_t *(*mac_tx_ring_fn_t)(void *, mblk_t *, uintptr_t, 3400dc2366fSVenugopal Iyer mac_ring_handle_t *); 341da14cebeSEric Cheng typedef struct mac_capab_aggr_s { 342da14cebeSEric Cheng mac_rename_fn_t mca_rename_fn; 343da14cebeSEric Cheng int (*mca_unicst)(void *, const uint8_t *); 3440dc2366fSVenugopal Iyer mac_tx_ring_fn_t mca_find_tx_ring_fn; 3450dc2366fSVenugopal Iyer void *mca_arg; 346da14cebeSEric Cheng } mac_capab_aggr_t; 347678453a8Sspeer 3484eaa4710SRishi Srivatsavai /* Bridge transmit and receive function signatures */ 3494eaa4710SRishi Srivatsavai typedef mblk_t *(*mac_bridge_tx_t)(mac_handle_t, mac_ring_handle_t, mblk_t *); 3504eaa4710SRishi Srivatsavai typedef void (*mac_bridge_rx_t)(mac_handle_t, mac_resource_handle_t, mblk_t *); 3514eaa4710SRishi Srivatsavai typedef void (*mac_bridge_ref_t)(mac_handle_t, boolean_t); 3524eaa4710SRishi Srivatsavai typedef link_state_t (*mac_bridge_ls_t)(mac_handle_t, link_state_t); 3534eaa4710SRishi Srivatsavai 3544eaa4710SRishi Srivatsavai /* must change mac_notify_cb_list[] in mac_provider.c if this is changed */ 3557c478bd9Sstevel@tonic-gate typedef enum { 3567c478bd9Sstevel@tonic-gate MAC_NOTE_LINK, 3577c478bd9Sstevel@tonic-gate MAC_NOTE_UNICST, 3587c478bd9Sstevel@tonic-gate MAC_NOTE_TX, 3597c478bd9Sstevel@tonic-gate MAC_NOTE_DEVPROMISC, 360ba2e4443Sseb MAC_NOTE_FASTPATH_FLUSH, 361e7801d59Ssowmini MAC_NOTE_SDU_SIZE, 3622b24ab6bSSebastien Roy MAC_NOTE_DEST, 363d62bc4baSyz147064 MAC_NOTE_MARGIN, 364da14cebeSEric Cheng MAC_NOTE_CAPAB_CHG, 3654eaa4710SRishi Srivatsavai MAC_NOTE_LOWLINK, 366550b6e40SSowmini Varadhan MAC_NOTE_ALLOWED_IPS, 3677c478bd9Sstevel@tonic-gate MAC_NNOTE /* must be the last entry */ 3687c478bd9Sstevel@tonic-gate } mac_notify_type_t; 3697c478bd9Sstevel@tonic-gate 3707c478bd9Sstevel@tonic-gate typedef void (*mac_notify_t)(void *, mac_notify_type_t); 371da14cebeSEric Cheng typedef void (*mac_rx_t)(void *, mac_resource_handle_t, mblk_t *, 372da14cebeSEric Cheng boolean_t); 373da14cebeSEric Cheng typedef mblk_t *(*mac_receive_t)(void *, int); 3747c478bd9Sstevel@tonic-gate 3757c478bd9Sstevel@tonic-gate /* 3767c478bd9Sstevel@tonic-gate * MAC resource types 3777c478bd9Sstevel@tonic-gate */ 3787c478bd9Sstevel@tonic-gate typedef enum { 3797c478bd9Sstevel@tonic-gate MAC_RX_FIFO = 1 3807c478bd9Sstevel@tonic-gate } mac_resource_type_t; 3817c478bd9Sstevel@tonic-gate 382da14cebeSEric Cheng typedef int (*mac_intr_enable_t)(mac_intr_handle_t); 383da14cebeSEric Cheng typedef int (*mac_intr_disable_t)(mac_intr_handle_t); 384da14cebeSEric Cheng 385da14cebeSEric Cheng typedef struct mac_intr_s { 386da14cebeSEric Cheng mac_intr_handle_t mi_handle; 387da14cebeSEric Cheng mac_intr_enable_t mi_enable; 388da14cebeSEric Cheng mac_intr_disable_t mi_disable; 3890dc2366fSVenugopal Iyer ddi_intr_handle_t mi_ddi_handle; 3900dc2366fSVenugopal Iyer boolean_t mi_ddi_shared; 391da14cebeSEric Cheng } mac_intr_t; 392da14cebeSEric Cheng 3937c478bd9Sstevel@tonic-gate typedef struct mac_rx_fifo_s { 3947c478bd9Sstevel@tonic-gate mac_resource_type_t mrf_type; /* MAC_RX_FIFO */ 395da14cebeSEric Cheng mac_intr_t mrf_intr; 396da14cebeSEric Cheng mac_receive_t mrf_receive; 397da14cebeSEric Cheng void *mrf_rx_arg; 398da14cebeSEric Cheng uint32_t mrf_flow_priority; 399da14cebeSEric Cheng /* 400da14cebeSEric Cheng * The CPU this flow is to be processed on. With intrd and future 401da14cebeSEric Cheng * things, we should know which CPU the flow needs to be processed 402da14cebeSEric Cheng * and get a squeue assigned on that CPU. 403da14cebeSEric Cheng */ 404da14cebeSEric Cheng uint_t mrf_cpu_id; 4057c478bd9Sstevel@tonic-gate } mac_rx_fifo_t; 4067c478bd9Sstevel@tonic-gate 407da14cebeSEric Cheng #define mrf_intr_handle mrf_intr.mi_handle 408da14cebeSEric Cheng #define mrf_intr_enable mrf_intr.mi_enable 409da14cebeSEric Cheng #define mrf_intr_disable mrf_intr.mi_disable 41098b1442aSmeem 4117c478bd9Sstevel@tonic-gate typedef union mac_resource_u { 4127c478bd9Sstevel@tonic-gate mac_resource_type_t mr_type; 4137c478bd9Sstevel@tonic-gate mac_rx_fifo_t mr_fifo; 4147c478bd9Sstevel@tonic-gate } mac_resource_t; 4157c478bd9Sstevel@tonic-gate 416ba2e4443Sseb typedef enum { 417ba2e4443Sseb MAC_ADDRTYPE_UNICAST, 418ba2e4443Sseb MAC_ADDRTYPE_MULTICAST, 419ba2e4443Sseb MAC_ADDRTYPE_BROADCAST 420ba2e4443Sseb } mac_addrtype_t; 421ba2e4443Sseb 422ba2e4443Sseb typedef struct mac_header_info_s { 423ba2e4443Sseb size_t mhi_hdrsize; 424ba2e4443Sseb size_t mhi_pktsize; 425ba2e4443Sseb const uint8_t *mhi_daddr; 426ba2e4443Sseb const uint8_t *mhi_saddr; 427ba2e4443Sseb uint32_t mhi_origsap; 428ba2e4443Sseb uint32_t mhi_bindsap; 429ba2e4443Sseb mac_addrtype_t mhi_dsttype; 430605445d5Sdg199075 uint16_t mhi_tci; 431da14cebeSEric Cheng boolean_t mhi_istagged; 4324eaa4710SRishi Srivatsavai boolean_t mhi_ispvid; 433ba2e4443Sseb } mac_header_info_t; 434ba2e4443Sseb 435ba2e4443Sseb /* 436da14cebeSEric Cheng * Function pointer to match dls client signature. Should be same as 437da14cebeSEric Cheng * dls_rx_t to allow a soft ring to bypass DLS layer and call a DLS 438da14cebeSEric Cheng * client directly. 439da14cebeSEric Cheng */ 440da14cebeSEric Cheng typedef void (*mac_direct_rx_t)(void *, mac_resource_handle_t, 441da14cebeSEric Cheng mblk_t *, mac_header_info_t *); 442da14cebeSEric Cheng 443da14cebeSEric Cheng typedef mac_resource_handle_t (*mac_resource_add_t)(void *, mac_resource_t *); 444da14cebeSEric Cheng typedef int (*mac_resource_bind_t)(void *, 445da14cebeSEric Cheng mac_resource_handle_t, processorid_t); 446da14cebeSEric Cheng typedef void (*mac_resource_remove_t)(void *, void *); 447da14cebeSEric Cheng typedef void (*mac_resource_quiesce_t)(void *, void *); 448da14cebeSEric Cheng typedef void (*mac_resource_restart_t)(void *, void *); 449da14cebeSEric Cheng typedef int (*mac_resource_modify_t)(void *, void *, 450da14cebeSEric Cheng mac_resource_t *); 451da14cebeSEric Cheng typedef void (*mac_change_upcall_t)(void *, mac_direct_rx_t, 452da14cebeSEric Cheng void *); 453da14cebeSEric Cheng 454da14cebeSEric Cheng /* 455ba2e4443Sseb * MAC-Type plugin interfaces 456ba2e4443Sseb */ 457ba2e4443Sseb 458ba2e4443Sseb typedef int (*mtops_addr_verify_t)(const void *, void *); 459ba2e4443Sseb typedef boolean_t (*mtops_sap_verify_t)(uint32_t, uint32_t *, void *); 460ba2e4443Sseb typedef mblk_t *(*mtops_header_t)(const void *, const void *, 461ba2e4443Sseb uint32_t, void *, mblk_t *, size_t); 462ba2e4443Sseb typedef int (*mtops_header_info_t)(mblk_t *, void *, 463ba2e4443Sseb mac_header_info_t *); 464ba2e4443Sseb typedef boolean_t (*mtops_pdata_verify_t)(void *, size_t); 465ba2e4443Sseb typedef mblk_t *(*mtops_header_modify_t)(mblk_t *, void *); 4660d2a8e5eSgd78059 typedef void (*mtops_link_details_t)(char *, size_t, mac_handle_t, 4670d2a8e5eSgd78059 void *); 468ba2e4443Sseb 469ba2e4443Sseb typedef struct mactype_ops_s { 470ba2e4443Sseb uint_t mtops_ops; 471ba2e4443Sseb /* 472ba2e4443Sseb * mtops_unicst_verify() returns 0 if the given address is a valid 473ba2e4443Sseb * unicast address, or a non-zero errno otherwise. 474ba2e4443Sseb */ 475ba2e4443Sseb mtops_addr_verify_t mtops_unicst_verify; 476ba2e4443Sseb /* 477ba2e4443Sseb * mtops_multicst_verify() returns 0 if the given address is a 478ba2e4443Sseb * valid multicast address, or a non-zero errno otherwise. If the 479ba2e4443Sseb * media doesn't support multicast, ENOTSUP should be returned (for 480ba2e4443Sseb * example). 481ba2e4443Sseb */ 482ba2e4443Sseb mtops_addr_verify_t mtops_multicst_verify; 483ba2e4443Sseb /* 484ba2e4443Sseb * mtops_sap_verify() returns B_TRUE if the given SAP is a valid 485ba2e4443Sseb * SAP value, or B_FALSE otherwise. 486ba2e4443Sseb */ 487ba2e4443Sseb mtops_sap_verify_t mtops_sap_verify; 488ba2e4443Sseb /* 489ba2e4443Sseb * mtops_header() is used to allocate and construct a MAC header. 490ba2e4443Sseb */ 491ba2e4443Sseb mtops_header_t mtops_header; 492ba2e4443Sseb /* 493ba2e4443Sseb * mtops_header_info() is used to gather information on a given MAC 494ba2e4443Sseb * header. 495ba2e4443Sseb */ 496ba2e4443Sseb mtops_header_info_t mtops_header_info; 497ba2e4443Sseb /* 498ba2e4443Sseb * mtops_pdata_verify() is used to verify the validity of MAC 499ba2e4443Sseb * plugin data. It is called by mac_register() if the driver has 500ba2e4443Sseb * supplied MAC plugin data, and also by mac_pdata_update() when 501ba2e4443Sseb * drivers update the data. 502ba2e4443Sseb */ 503ba2e4443Sseb mtops_pdata_verify_t mtops_pdata_verify; 504ba2e4443Sseb /* 505ba2e4443Sseb * mtops_header_cook() is an optional callback that converts (or 506ba2e4443Sseb * "cooks") the given raw header (as sent by a raw DLPI consumer) 507ba2e4443Sseb * into one that is appropriate to send down to the MAC driver. 508ba2e4443Sseb * Following the example above, an Ethernet header sent down by a 509ba2e4443Sseb * DLPI consumer would be converted to whatever header the MAC 510ba2e4443Sseb * driver expects. 511ba2e4443Sseb */ 512ba2e4443Sseb mtops_header_modify_t mtops_header_cook; 513ba2e4443Sseb /* 514ba2e4443Sseb * mtops_header_uncook() is an optional callback that does the 515ba2e4443Sseb * opposite of mtops_header_cook(). It "uncooks" a given MAC 516ba2e4443Sseb * header (as received from the driver) for consumption by raw DLPI 517ba2e4443Sseb * consumers. For example, for a non-Ethernet plugin that wants 518ba2e4443Sseb * raw DLPI consumers to be fooled into thinking that the device 519ba2e4443Sseb * provides Ethernet access, this callback would modify the given 520ba2e4443Sseb * mblk_t such that the MAC header is converted to an Ethernet 521ba2e4443Sseb * header. 522ba2e4443Sseb */ 523ba2e4443Sseb mtops_header_modify_t mtops_header_uncook; 5240d2a8e5eSgd78059 /* 5250d2a8e5eSgd78059 * mtops_link_details() is an optional callback that provides 5260d2a8e5eSgd78059 * extended information about the link state. Its primary purpose 5270d2a8e5eSgd78059 * is to provide type-specific support for syslog contents on 5280d2a8e5eSgd78059 * link up events. If no implementation is provided, then a default 5290d2a8e5eSgd78059 * implementation will be used. 5300d2a8e5eSgd78059 */ 5310d2a8e5eSgd78059 mtops_link_details_t mtops_link_details; 532ba2e4443Sseb } mactype_ops_t; 533ba2e4443Sseb 534ba2e4443Sseb /* 535ba2e4443Sseb * mtops_ops exists for the plugin to enumerate the optional callback 536ba2e4443Sseb * entrypoints it has defined. This allows the mac module to define 537ba2e4443Sseb * additional plugin entrypoints in mactype_ops_t without breaking backward 538ba2e4443Sseb * compatibility with old plugins. 539ba2e4443Sseb */ 540ba2e4443Sseb #define MTOPS_PDATA_VERIFY 0x001 541ba2e4443Sseb #define MTOPS_HEADER_COOK 0x002 542ba2e4443Sseb #define MTOPS_HEADER_UNCOOK 0x004 5430d2a8e5eSgd78059 #define MTOPS_LINK_DETAILS 0x008 544ba2e4443Sseb 5454045d941Ssowmini /* 5464045d941Ssowmini * Provide mapping for legacy ndd ioctls relevant to that mactype. 5474045d941Ssowmini * Note that the ndd ioctls are obsolete, and may be removed in a future 5484045d941Ssowmini * release of Solaris. The ndd ioctls are not typically used in legacy 5494045d941Ssowmini * ethernet drivers. New datalink drivers of all link-types should use 5504045d941Ssowmini * dladm(1m) interfaces for administering tunables and not have to provide 5514045d941Ssowmini * a mapping. 5524045d941Ssowmini */ 5534045d941Ssowmini typedef struct mac_ndd_mapping_s { 5544045d941Ssowmini char *mp_name; 5554045d941Ssowmini union { 5564045d941Ssowmini mac_prop_id_t u_id; 5574045d941Ssowmini uint_t u_kstat; 5584045d941Ssowmini } u_mp_id; 5594045d941Ssowmini long mp_minval; 5604045d941Ssowmini long mp_maxval; 5614045d941Ssowmini size_t mp_valsize; 5624045d941Ssowmini int mp_flags; 5634045d941Ssowmini } mac_ndd_mapping_t; 5644045d941Ssowmini 5654045d941Ssowmini #define mp_prop_id u_mp_id.u_id 5664045d941Ssowmini #define mp_kstat u_mp_id.u_kstat 5674045d941Ssowmini 568da14cebeSEric Cheng typedef struct mac_stat_info_s { 569da14cebeSEric Cheng uint_t msi_stat; 570da14cebeSEric Cheng char *msi_name; 571da14cebeSEric Cheng uint_t msi_type; /* as defined in kstat_named_init(9F) */ 572da14cebeSEric Cheng uint64_t msi_default; 573da14cebeSEric Cheng } mac_stat_info_t; 574da14cebeSEric Cheng 575ba2e4443Sseb typedef struct mactype_register_s { 576ba2e4443Sseb uint_t mtr_version; /* set by mactype_alloc() */ 577ba2e4443Sseb const char *mtr_ident; 578ba2e4443Sseb mactype_ops_t *mtr_ops; 579ba2e4443Sseb uint_t mtr_mactype; 5800ba2cbe9Sxc151355 uint_t mtr_nativetype; 581ba2e4443Sseb uint_t mtr_addrlen; 582ba2e4443Sseb uint8_t *mtr_brdcst_addr; 583ba2e4443Sseb mac_stat_info_t *mtr_stats; 584ba2e4443Sseb size_t mtr_statcount; 5854045d941Ssowmini mac_ndd_mapping_t *mtr_mapping; 5864045d941Ssowmini size_t mtr_mappingcount; 587ba2e4443Sseb } mactype_register_t; 588ba2e4443Sseb 5897c478bd9Sstevel@tonic-gate /* 590da14cebeSEric Cheng * Driver interface functions. 5917c478bd9Sstevel@tonic-gate */ 592d62bc4baSyz147064 extern int mac_open_by_linkid(datalink_id_t, 593d62bc4baSyz147064 mac_handle_t *); 594d62bc4baSyz147064 extern int mac_open_by_linkname(const char *, 595d62bc4baSyz147064 mac_handle_t *); 596d62bc4baSyz147064 extern const char *mac_name(mac_handle_t); 597d62bc4baSyz147064 extern minor_t mac_minor(mac_handle_t); 598d62bc4baSyz147064 extern minor_t mac_minor_hold(boolean_t); 599d62bc4baSyz147064 extern void mac_minor_rele(minor_t); 600da14cebeSEric Cheng extern void mac_sdu_get(mac_handle_t, uint_t *, uint_t *); 6011eee170aSErik Nordmark extern void mac_sdu_get2(mac_handle_t, uint_t *, uint_t *, 6021eee170aSErik Nordmark uint_t *); 603da14cebeSEric Cheng extern int mac_maxsdu_update(mac_handle_t, uint_t); 6041eee170aSErik Nordmark extern int mac_maxsdu_update2(mac_handle_t, uint_t, 6051eee170aSErik Nordmark uint_t); 6060a0e9771SDarren Reed extern uint_t mac_addr_len(mac_handle_t); 6070a0e9771SDarren Reed extern int mac_type(mac_handle_t); 608f195a053SDarren Reed extern int mac_nativetype(mac_handle_t); 6097c478bd9Sstevel@tonic-gate 610ba2e4443Sseb extern void mac_unicst_update(mac_handle_t, 611ba2e4443Sseb const uint8_t *); 612da14cebeSEric Cheng extern void mac_capab_update(mac_handle_t); 613ba2e4443Sseb extern int mac_pdata_update(mac_handle_t, void *, 614ba2e4443Sseb size_t); 615d62bc4baSyz147064 extern boolean_t mac_margin_update(mac_handle_t, uint32_t); 616d62bc4baSyz147064 extern void mac_margin_get(mac_handle_t, uint32_t *); 617d62bc4baSyz147064 extern int mac_margin_remove(mac_handle_t, uint32_t); 618d62bc4baSyz147064 extern int mac_margin_add(mac_handle_t, uint32_t *, 619d62bc4baSyz147064 boolean_t); 620*a776d98eSRobert Mustacchi extern int mac_mtu_add(mac_handle_t, uint32_t *, 621*a776d98eSRobert Mustacchi boolean_t); 622*a776d98eSRobert Mustacchi extern int mac_mtu_remove(mac_handle_t, uint32_t); 6235d460eafSCathy Zhou extern int mac_fastpath_disable(mac_handle_t); 6245d460eafSCathy Zhou extern void mac_fastpath_enable(mac_handle_t); 6254eaa4710SRishi Srivatsavai extern void mac_no_active(mac_handle_t); 626d62bc4baSyz147064 627ba2e4443Sseb extern mactype_register_t *mactype_alloc(uint_t); 628ba2e4443Sseb extern void mactype_free(mactype_register_t *); 629ba2e4443Sseb extern int mactype_register(mactype_register_t *); 630ba2e4443Sseb extern int mactype_unregister(const char *); 631da14cebeSEric Cheng 6325d460eafSCathy Zhou extern int mac_start_logusage(mac_logtype_t, uint_t); 633da14cebeSEric Cheng extern void mac_stop_logusage(mac_logtype_t); 634da14cebeSEric Cheng 635da14cebeSEric Cheng extern mac_handle_t mac_get_lower_mac_handle(mac_handle_t); 6360dc2366fSVenugopal Iyer extern boolean_t mac_is_vnic_primary(mac_handle_t); 6377c478bd9Sstevel@tonic-gate 638ae6aa22aSVenugopal Iyer /* 639ae6aa22aSVenugopal Iyer * Packet hashing for distribution to multiple ports and rings. 640ae6aa22aSVenugopal Iyer */ 641ae6aa22aSVenugopal Iyer 642ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L2 0x01 643ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L3 0x02 644ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L4 0x04 645ae6aa22aSVenugopal Iyer 646ae6aa22aSVenugopal Iyer extern uint64_t mac_pkt_hash(uint_t, mblk_t *, uint8_t, 647ae6aa22aSVenugopal Iyer boolean_t); 648ae6aa22aSVenugopal Iyer 6494eaa4710SRishi Srivatsavai /* 6504eaa4710SRishi Srivatsavai * Bridging linkage 6514eaa4710SRishi Srivatsavai */ 6524eaa4710SRishi Srivatsavai extern void mac_rx_common(mac_handle_t, 6534eaa4710SRishi Srivatsavai mac_resource_handle_t, mblk_t *); 6544eaa4710SRishi Srivatsavai extern int mac_bridge_set(mac_handle_t, mac_handle_t); 6554eaa4710SRishi Srivatsavai extern void mac_bridge_clear(mac_handle_t, mac_handle_t); 6564eaa4710SRishi Srivatsavai extern void mac_bridge_vectors(mac_bridge_tx_t, 6574eaa4710SRishi Srivatsavai mac_bridge_rx_t, mac_bridge_ref_t, 6584eaa4710SRishi Srivatsavai mac_bridge_ls_t); 6594eaa4710SRishi Srivatsavai 6604eaa4710SRishi Srivatsavai /* special case function for TRILL observability */ 6614eaa4710SRishi Srivatsavai extern void mac_trill_snoop(mac_handle_t, mblk_t *); 6624eaa4710SRishi Srivatsavai 6637c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 6647c478bd9Sstevel@tonic-gate 6657c478bd9Sstevel@tonic-gate #ifdef __cplusplus 6667c478bd9Sstevel@tonic-gate } 6677c478bd9Sstevel@tonic-gate #endif 6687c478bd9Sstevel@tonic-gate 6697c478bd9Sstevel@tonic-gate #endif /* _SYS_MAC_H */ 670