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 /* 23ae6aa22aSVenugopal Iyer * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 247c478bd9Sstevel@tonic-gate * Use is subject to license terms. 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 */ 46da14cebeSEric Cheng #define MAC_INFO "MAC Services v1.20" 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 70da14cebeSEric Cheng #define MAC_MAX_MINOR 1000 71da14cebeSEric Cheng 727c478bd9Sstevel@tonic-gate typedef enum { 737c478bd9Sstevel@tonic-gate LINK_STATE_UNKNOWN = -1, 747c478bd9Sstevel@tonic-gate LINK_STATE_DOWN, 757c478bd9Sstevel@tonic-gate LINK_STATE_UP 767c478bd9Sstevel@tonic-gate } link_state_t; 777c478bd9Sstevel@tonic-gate 787c478bd9Sstevel@tonic-gate typedef enum { 797c478bd9Sstevel@tonic-gate LINK_DUPLEX_UNKNOWN = 0, 807c478bd9Sstevel@tonic-gate LINK_DUPLEX_HALF, 817c478bd9Sstevel@tonic-gate LINK_DUPLEX_FULL 827c478bd9Sstevel@tonic-gate } link_duplex_t; 837c478bd9Sstevel@tonic-gate 84e7801d59Ssowmini typedef enum { 85e7801d59Ssowmini LINK_FLOWCTRL_NONE = 0, 86e7801d59Ssowmini LINK_FLOWCTRL_RX, 87e7801d59Ssowmini LINK_FLOWCTRL_TX, 88e7801d59Ssowmini LINK_FLOWCTRL_BI 89e7801d59Ssowmini } link_flowctrl_t; 90e7801d59Ssowmini 91e75f0919SSebastien Roy typedef enum { 92e75f0919SSebastien Roy LINK_TAGMODE_VLANONLY = 0, 93e75f0919SSebastien Roy LINK_TAGMODE_NORMAL 94e75f0919SSebastien Roy } link_tagmode_t; 95e75f0919SSebastien Roy 96da14cebeSEric Cheng /* 97f0f2c3a5SGirish Moodalbail * Defines range of uint32 values 98f0f2c3a5SGirish Moodalbail */ 99f0f2c3a5SGirish Moodalbail typedef struct mac_propval_uint32_range_s { 100f0f2c3a5SGirish Moodalbail uint32_t mpur_min; 101f0f2c3a5SGirish Moodalbail uint32_t mpur_max; 102f0f2c3a5SGirish Moodalbail } mac_propval_uint32_range_t; 103f0f2c3a5SGirish Moodalbail 104f0f2c3a5SGirish Moodalbail /* 105f0f2c3a5SGirish Moodalbail * Data type of the value 106f0f2c3a5SGirish Moodalbail */ 107f0f2c3a5SGirish Moodalbail typedef enum { 108f0f2c3a5SGirish Moodalbail MAC_PROPVAL_UINT32 = 0x1 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 * See PSARC 2009/235 for more information. 118f0f2c3a5SGirish Moodalbail */ 119f0f2c3a5SGirish Moodalbail typedef struct mac_propval_range_s { 120f0f2c3a5SGirish Moodalbail uint_t mpr_count; /* count of ranges */ 121f0f2c3a5SGirish Moodalbail mac_propval_type_t mpr_type; /* type of value */ 122f0f2c3a5SGirish Moodalbail union { 123f0f2c3a5SGirish Moodalbail mac_propval_uint32_range_t mpr_uint32[1]; 124f0f2c3a5SGirish Moodalbail } u; 125f0f2c3a5SGirish Moodalbail } mac_propval_range_t; 126f0f2c3a5SGirish Moodalbail 127f0f2c3a5SGirish Moodalbail #define range_uint32 u.mpr_uint32 128f0f2c3a5SGirish Moodalbail 129f0f2c3a5SGirish Moodalbail /* 130da14cebeSEric Cheng * Maximum MAC address length 131da14cebeSEric Cheng */ 132da14cebeSEric Cheng #define MAXMACADDRLEN 20 133da14cebeSEric Cheng 134da14cebeSEric Cheng typedef enum { 135da14cebeSEric Cheng MAC_LOGTYPE_LINK = 1, 136da14cebeSEric Cheng MAC_LOGTYPE_FLOW 137da14cebeSEric Cheng } mac_logtype_t; 1383fd94f8cSam223141 1393fd94f8cSam223141 /* 1403fd94f8cSam223141 * Encodings for public properties. 1413fd94f8cSam223141 * A most significant bit value of 1 indicates private property, intended 1423fd94f8cSam223141 * to allow private property implementations to use internal encodings 1433fd94f8cSam223141 * if desired. 1443fd94f8cSam223141 * 1453fd94f8cSam223141 * Note that there are 2 sets of parameters: the *_EN_* 1463fd94f8cSam223141 * values are those that the Administrator configures for autonegotiation. 1473fd94f8cSam223141 * The _ADV_* values are those that are currently exposed over the wire. 1483fd94f8cSam223141 */ 1493fd94f8cSam223141 #define MAXLINKPROPNAME 256 150f0f2c3a5SGirish Moodalbail #define MAC_PROP_DEFAULT 0x0001 /* default property value */ 151f0f2c3a5SGirish Moodalbail 152f0f2c3a5SGirish Moodalbail /* 153f0f2c3a5SGirish Moodalbail * Indicates the linkprop framework is interested in knowing the list of 154f0f2c3a5SGirish Moodalbail * possible property values. When used to obtain possible values for a 155f0f2c3a5SGirish Moodalbail * property, one may have to change all the drivers. See PSARC 2009/235. 156f0f2c3a5SGirish Moodalbail */ 157f0f2c3a5SGirish Moodalbail #define MAC_PROP_POSSIBLE 0x0002 /* possible property values */ 158f0f2c3a5SGirish Moodalbail 1593fd94f8cSam223141 typedef enum { 1603fd94f8cSam223141 MAC_PROP_DUPLEX = 0x00000001, 1613fd94f8cSam223141 MAC_PROP_SPEED, 1623fd94f8cSam223141 MAC_PROP_STATUS, 1633fd94f8cSam223141 MAC_PROP_AUTONEG, 1643fd94f8cSam223141 MAC_PROP_EN_AUTONEG, 1653fd94f8cSam223141 MAC_PROP_MTU, 1663bc21d0aSAruna Ramakrishna - Sun Microsystems MAC_PROP_ZONE, 1673bc21d0aSAruna Ramakrishna - Sun Microsystems MAC_PROP_AUTOPUSH, 1683fd94f8cSam223141 MAC_PROP_FLOWCTRL, 1693fd94f8cSam223141 MAC_PROP_ADV_1000FDX_CAP, 1703fd94f8cSam223141 MAC_PROP_EN_1000FDX_CAP, 1713fd94f8cSam223141 MAC_PROP_ADV_1000HDX_CAP, 1723fd94f8cSam223141 MAC_PROP_EN_1000HDX_CAP, 1733fd94f8cSam223141 MAC_PROP_ADV_100FDX_CAP, 1743fd94f8cSam223141 MAC_PROP_EN_100FDX_CAP, 1753fd94f8cSam223141 MAC_PROP_ADV_100HDX_CAP, 1763fd94f8cSam223141 MAC_PROP_EN_100HDX_CAP, 1773fd94f8cSam223141 MAC_PROP_ADV_10FDX_CAP, 1783fd94f8cSam223141 MAC_PROP_EN_10FDX_CAP, 1793fd94f8cSam223141 MAC_PROP_ADV_10HDX_CAP, 1803fd94f8cSam223141 MAC_PROP_EN_10HDX_CAP, 1813fd94f8cSam223141 MAC_PROP_ADV_100T4_CAP, 1823fd94f8cSam223141 MAC_PROP_EN_100T4_CAP, 183bcb5c89dSSowmini Varadhan MAC_PROP_WL_ESSID, 184bcb5c89dSSowmini Varadhan MAC_PROP_WL_BSSID, 185bcb5c89dSSowmini Varadhan MAC_PROP_WL_BSSTYPE, 186bcb5c89dSSowmini Varadhan MAC_PROP_WL_LINKSTATUS, 187bcb5c89dSSowmini Varadhan MAC_PROP_WL_DESIRED_RATES, 188bcb5c89dSSowmini Varadhan MAC_PROP_WL_SUPPORTED_RATES, 189bcb5c89dSSowmini Varadhan MAC_PROP_WL_AUTH_MODE, 190bcb5c89dSSowmini Varadhan MAC_PROP_WL_ENCRYPTION, 191bcb5c89dSSowmini Varadhan MAC_PROP_WL_RSSI, 192bcb5c89dSSowmini Varadhan MAC_PROP_WL_PHY_CONFIG, 193bcb5c89dSSowmini Varadhan MAC_PROP_WL_CAPABILITY, 194bcb5c89dSSowmini Varadhan MAC_PROP_WL_WPA, 195bcb5c89dSSowmini Varadhan MAC_PROP_WL_SCANRESULTS, 196bcb5c89dSSowmini Varadhan MAC_PROP_WL_POWER_MODE, 197bcb5c89dSSowmini Varadhan MAC_PROP_WL_RADIO, 198bcb5c89dSSowmini Varadhan MAC_PROP_WL_ESS_LIST, 199bcb5c89dSSowmini Varadhan MAC_PROP_WL_KEY_TAB, 200bcb5c89dSSowmini Varadhan MAC_PROP_WL_CREATE_IBSS, 201bcb5c89dSSowmini Varadhan MAC_PROP_WL_SETOPTIE, 202bcb5c89dSSowmini Varadhan MAC_PROP_WL_DELKEY, 203bcb5c89dSSowmini Varadhan MAC_PROP_WL_KEY, 204bcb5c89dSSowmini Varadhan MAC_PROP_WL_MLME, 205da14cebeSEric Cheng MAC_PROP_MAXBW, 206da14cebeSEric Cheng MAC_PROP_PRIO, 207da14cebeSEric Cheng MAC_PROP_BIND_CPU, 208e75f0919SSebastien Roy MAC_PROP_TAGMODE, 209aca118b7Slucy wang - Sun Microsystems - Beijing China MAC_PROP_ADV_10GFDX_CAP, 210aca118b7Slucy wang - Sun Microsystems - Beijing China MAC_PROP_EN_10GFDX_CAP, 211*4eaa4710SRishi Srivatsavai MAC_PROP_PVID, 212*4eaa4710SRishi Srivatsavai MAC_PROP_LLIMIT, 213*4eaa4710SRishi Srivatsavai MAC_PROP_LDECAY, 2143fd94f8cSam223141 MAC_PROP_PRIVATE = -1 2153fd94f8cSam223141 } mac_prop_id_t; 2163fd94f8cSam223141 217843e1988Sjohnlev /* 218afdda45fSVasumathi Sundaram - Sun Microsystems * Flags to figure out r/w status of legacy ndd props. 219afdda45fSVasumathi Sundaram - Sun Microsystems */ 220afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_READ 0x0001 221afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_WRITE 0x0010 222afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_MAP_KSTAT 0x0100 223afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_RW (MAC_PROP_PERM_READ|MAC_PROP_PERM_WRITE) 224afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_FLAGS_RK (MAC_PROP_PERM_READ|MAC_PROP_MAP_KSTAT) 225afdda45fSVasumathi Sundaram - Sun Microsystems 2267c478bd9Sstevel@tonic-gate #ifdef _KERNEL 2277c478bd9Sstevel@tonic-gate 2287c478bd9Sstevel@tonic-gate /* 229ba2e4443Sseb * There are three ranges of statistics values. 0 to 1 - MAC_STAT_MIN are 230ba2e4443Sseb * interface statistics maintained by the mac module. MAC_STAT_MIN to 1 - 231ba2e4443Sseb * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and 232ba2e4443Sseb * maintained by each driver. MACTYPE_STAT_MIN and above are statistics 233ba2e4443Sseb * defined by MAC-Type plugins and maintained by each driver. 2347c478bd9Sstevel@tonic-gate */ 235ba2e4443Sseb #define MAC_STAT_MIN 1000 236ba2e4443Sseb #define MACTYPE_STAT_MIN 2000 237ba2e4443Sseb 238ba2e4443Sseb #define IS_MAC_STAT(stat) \ 239ba2e4443Sseb (stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN) 240ba2e4443Sseb #define IS_MACTYPE_STAT(stat) (stat >= MACTYPE_STAT_MIN) 241ba2e4443Sseb 2429b14cf1dSgd78059 /* 243d62bc4baSyz147064 * Statistics maintained by the mac module, and possibly populated as link 244d62bc4baSyz147064 * statistics. 245d62bc4baSyz147064 */ 246d62bc4baSyz147064 enum mac_mod_stat { 247d62bc4baSyz147064 MAC_STAT_LINK_STATE, 248d62bc4baSyz147064 MAC_STAT_LINK_UP, 249*4eaa4710SRishi Srivatsavai MAC_STAT_PROMISC, 250*4eaa4710SRishi Srivatsavai MAC_STAT_LOWLINK_STATE 251d62bc4baSyz147064 }; 252d62bc4baSyz147064 253d62bc4baSyz147064 /* 2549b14cf1dSgd78059 * Do not reorder, and add only to the end of this list. 2559b14cf1dSgd78059 */ 256ba2e4443Sseb enum mac_driver_stat { 257ba2e4443Sseb /* MIB-II stats (RFC 1213 and RFC 1573) */ 258ba2e4443Sseb MAC_STAT_IFSPEED = MAC_STAT_MIN, 2597c478bd9Sstevel@tonic-gate MAC_STAT_MULTIRCV, 2607c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTRCV, 2617c478bd9Sstevel@tonic-gate MAC_STAT_MULTIXMT, 2627c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTXMT, 2637c478bd9Sstevel@tonic-gate MAC_STAT_NORCVBUF, 2647c478bd9Sstevel@tonic-gate MAC_STAT_IERRORS, 2657c478bd9Sstevel@tonic-gate MAC_STAT_UNKNOWNS, 2667c478bd9Sstevel@tonic-gate MAC_STAT_NOXMTBUF, 2677c478bd9Sstevel@tonic-gate MAC_STAT_OERRORS, 2687c478bd9Sstevel@tonic-gate MAC_STAT_COLLISIONS, 2697c478bd9Sstevel@tonic-gate MAC_STAT_RBYTES, 2707c478bd9Sstevel@tonic-gate MAC_STAT_IPACKETS, 2717c478bd9Sstevel@tonic-gate MAC_STAT_OBYTES, 2729b14cf1dSgd78059 MAC_STAT_OPACKETS, 2739b14cf1dSgd78059 MAC_STAT_UNDERFLOWS, 2749b14cf1dSgd78059 MAC_STAT_OVERFLOWS 2757c478bd9Sstevel@tonic-gate }; 2767c478bd9Sstevel@tonic-gate 2779b14cf1dSgd78059 #define MAC_NSTAT (MAC_STAT_OVERFLOWS - MAC_STAT_IFSPEED + 1) 278ba2e4443Sseb 279ba2e4443Sseb #define MAC_STAT_ISACOUNTER(_stat) ( \ 280ba2e4443Sseb (_stat) == MAC_STAT_MULTIRCV || \ 281ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTRCV || \ 282ba2e4443Sseb (_stat) == MAC_STAT_MULTIXMT || \ 283ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTXMT || \ 284ba2e4443Sseb (_stat) == MAC_STAT_NORCVBUF || \ 285ba2e4443Sseb (_stat) == MAC_STAT_IERRORS || \ 286ba2e4443Sseb (_stat) == MAC_STAT_UNKNOWNS || \ 287ba2e4443Sseb (_stat) == MAC_STAT_NOXMTBUF || \ 288ba2e4443Sseb (_stat) == MAC_STAT_OERRORS || \ 289ba2e4443Sseb (_stat) == MAC_STAT_COLLISIONS || \ 290ba2e4443Sseb (_stat) == MAC_STAT_RBYTES || \ 291ba2e4443Sseb (_stat) == MAC_STAT_IPACKETS || \ 292ba2e4443Sseb (_stat) == MAC_STAT_OBYTES || \ 2939b14cf1dSgd78059 (_stat) == MAC_STAT_OPACKETS || \ 2949b14cf1dSgd78059 (_stat) == MAC_STAT_UNDERFLOWS || \ 2959b14cf1dSgd78059 (_stat) == MAC_STAT_OVERFLOWS) 296ba2e4443Sseb 2977c478bd9Sstevel@tonic-gate /* 2987c478bd9Sstevel@tonic-gate * Immutable information. (This may not be modified after registration). 2997c478bd9Sstevel@tonic-gate */ 3007c478bd9Sstevel@tonic-gate typedef struct mac_info_s { 3017c478bd9Sstevel@tonic-gate uint_t mi_media; 3020ba2cbe9Sxc151355 uint_t mi_nativemedia; 3037c478bd9Sstevel@tonic-gate uint_t mi_addr_length; 304ba2e4443Sseb uint8_t *mi_unicst_addr; 305ba2e4443Sseb uint8_t *mi_brdcst_addr; 3067c478bd9Sstevel@tonic-gate } mac_info_t; 3077c478bd9Sstevel@tonic-gate 3087c478bd9Sstevel@tonic-gate /* 309da14cebeSEric Cheng * When VNICs are created on top of the NIC, there are two levels 310da14cebeSEric Cheng * of MAC layer, a lower MAC, which is the MAC layer at the level of the 311da14cebeSEric Cheng * physical NIC, and an upper MAC, which is the MAC layer at the level 312da14cebeSEric Cheng * of the VNIC. Each VNIC maps to a MAC client at the lower MAC, and 313da14cebeSEric Cheng * the SRS and classification is done at the lower MAC level. The upper 314da14cebeSEric Cheng * MAC is therefore for the most part pass-through, and therefore 315da14cebeSEric Cheng * special processing needs to be done at the upper MAC layer when 316da14cebeSEric Cheng * dealing with a VNIC. 317678453a8Sspeer * 318da14cebeSEric Cheng * This capability allows the MAC layer to detect when a VNIC is being 319da14cebeSEric Cheng * access, and implement the required shortcuts. 320678453a8Sspeer */ 321678453a8Sspeer 322da14cebeSEric Cheng typedef void *(*mac_client_handle_fn_t)(void *); 323678453a8Sspeer 324da14cebeSEric Cheng typedef struct mac_capab_vnic_s { 325da14cebeSEric Cheng void *mcv_arg; 326da14cebeSEric Cheng mac_client_handle_fn_t mcv_mac_client_handle; 327da14cebeSEric Cheng } mac_capab_vnic_t; 328678453a8Sspeer 329da14cebeSEric Cheng typedef void (*mac_rename_fn_t)(const char *, void *); 330da14cebeSEric Cheng typedef struct mac_capab_aggr_s { 331da14cebeSEric Cheng mac_rename_fn_t mca_rename_fn; 332da14cebeSEric Cheng int (*mca_unicst)(void *, const uint8_t *); 333da14cebeSEric Cheng } mac_capab_aggr_t; 334678453a8Sspeer 335*4eaa4710SRishi Srivatsavai /* Bridge transmit and receive function signatures */ 336*4eaa4710SRishi Srivatsavai typedef mblk_t *(*mac_bridge_tx_t)(mac_handle_t, mac_ring_handle_t, mblk_t *); 337*4eaa4710SRishi Srivatsavai typedef void (*mac_bridge_rx_t)(mac_handle_t, mac_resource_handle_t, mblk_t *); 338*4eaa4710SRishi Srivatsavai typedef void (*mac_bridge_ref_t)(mac_handle_t, boolean_t); 339*4eaa4710SRishi Srivatsavai typedef link_state_t (*mac_bridge_ls_t)(mac_handle_t, link_state_t); 340*4eaa4710SRishi Srivatsavai 341*4eaa4710SRishi Srivatsavai /* must change mac_notify_cb_list[] in mac_provider.c if this is changed */ 3427c478bd9Sstevel@tonic-gate typedef enum { 3437c478bd9Sstevel@tonic-gate MAC_NOTE_LINK, 3447c478bd9Sstevel@tonic-gate MAC_NOTE_UNICST, 3457c478bd9Sstevel@tonic-gate MAC_NOTE_TX, 3467c478bd9Sstevel@tonic-gate MAC_NOTE_DEVPROMISC, 347ba2e4443Sseb MAC_NOTE_FASTPATH_FLUSH, 348e7801d59Ssowmini MAC_NOTE_SDU_SIZE, 349d62bc4baSyz147064 MAC_NOTE_MARGIN, 350da14cebeSEric Cheng MAC_NOTE_CAPAB_CHG, 351*4eaa4710SRishi Srivatsavai MAC_NOTE_LOWLINK, 3527c478bd9Sstevel@tonic-gate MAC_NNOTE /* must be the last entry */ 3537c478bd9Sstevel@tonic-gate } mac_notify_type_t; 3547c478bd9Sstevel@tonic-gate 3557c478bd9Sstevel@tonic-gate typedef void (*mac_notify_t)(void *, mac_notify_type_t); 356da14cebeSEric Cheng typedef void (*mac_rx_t)(void *, mac_resource_handle_t, mblk_t *, 357da14cebeSEric Cheng boolean_t); 358da14cebeSEric Cheng typedef mblk_t *(*mac_receive_t)(void *, int); 3597c478bd9Sstevel@tonic-gate 3607c478bd9Sstevel@tonic-gate /* 3617c478bd9Sstevel@tonic-gate * MAC resource types 3627c478bd9Sstevel@tonic-gate */ 3637c478bd9Sstevel@tonic-gate typedef enum { 3647c478bd9Sstevel@tonic-gate MAC_RX_FIFO = 1 3657c478bd9Sstevel@tonic-gate } mac_resource_type_t; 3667c478bd9Sstevel@tonic-gate 367da14cebeSEric Cheng typedef int (*mac_intr_enable_t)(mac_intr_handle_t); 368da14cebeSEric Cheng typedef int (*mac_intr_disable_t)(mac_intr_handle_t); 369da14cebeSEric Cheng 370da14cebeSEric Cheng typedef struct mac_intr_s { 371da14cebeSEric Cheng mac_intr_handle_t mi_handle; 372da14cebeSEric Cheng mac_intr_enable_t mi_enable; 373da14cebeSEric Cheng mac_intr_disable_t mi_disable; 374da14cebeSEric Cheng } mac_intr_t; 375da14cebeSEric Cheng 3767c478bd9Sstevel@tonic-gate typedef struct mac_rx_fifo_s { 3777c478bd9Sstevel@tonic-gate mac_resource_type_t mrf_type; /* MAC_RX_FIFO */ 378da14cebeSEric Cheng mac_intr_t mrf_intr; 379da14cebeSEric Cheng mac_receive_t mrf_receive; 380da14cebeSEric Cheng void *mrf_rx_arg; 381da14cebeSEric Cheng uint32_t mrf_flow_priority; 382da14cebeSEric Cheng /* 383da14cebeSEric Cheng * The CPU this flow is to be processed on. With intrd and future 384da14cebeSEric Cheng * things, we should know which CPU the flow needs to be processed 385da14cebeSEric Cheng * and get a squeue assigned on that CPU. 386da14cebeSEric Cheng */ 387da14cebeSEric Cheng uint_t mrf_cpu_id; 3887c478bd9Sstevel@tonic-gate } mac_rx_fifo_t; 3897c478bd9Sstevel@tonic-gate 390da14cebeSEric Cheng #define mrf_intr_handle mrf_intr.mi_handle 391da14cebeSEric Cheng #define mrf_intr_enable mrf_intr.mi_enable 392da14cebeSEric Cheng #define mrf_intr_disable mrf_intr.mi_disable 39398b1442aSmeem 3947c478bd9Sstevel@tonic-gate typedef union mac_resource_u { 3957c478bd9Sstevel@tonic-gate mac_resource_type_t mr_type; 3967c478bd9Sstevel@tonic-gate mac_rx_fifo_t mr_fifo; 3977c478bd9Sstevel@tonic-gate } mac_resource_t; 3987c478bd9Sstevel@tonic-gate 399ba2e4443Sseb typedef enum { 400ba2e4443Sseb MAC_ADDRTYPE_UNICAST, 401ba2e4443Sseb MAC_ADDRTYPE_MULTICAST, 402ba2e4443Sseb MAC_ADDRTYPE_BROADCAST 403ba2e4443Sseb } mac_addrtype_t; 404ba2e4443Sseb 405ba2e4443Sseb typedef struct mac_header_info_s { 406ba2e4443Sseb size_t mhi_hdrsize; 407ba2e4443Sseb size_t mhi_pktsize; 408ba2e4443Sseb const uint8_t *mhi_daddr; 409ba2e4443Sseb const uint8_t *mhi_saddr; 410ba2e4443Sseb uint32_t mhi_origsap; 411ba2e4443Sseb uint32_t mhi_bindsap; 412ba2e4443Sseb mac_addrtype_t mhi_dsttype; 413605445d5Sdg199075 uint16_t mhi_tci; 414da14cebeSEric Cheng boolean_t mhi_istagged; 415*4eaa4710SRishi Srivatsavai boolean_t mhi_ispvid; 416ba2e4443Sseb } mac_header_info_t; 417ba2e4443Sseb 418ba2e4443Sseb /* 419da14cebeSEric Cheng * Function pointer to match dls client signature. Should be same as 420da14cebeSEric Cheng * dls_rx_t to allow a soft ring to bypass DLS layer and call a DLS 421da14cebeSEric Cheng * client directly. 422da14cebeSEric Cheng */ 423da14cebeSEric Cheng typedef void (*mac_direct_rx_t)(void *, mac_resource_handle_t, 424da14cebeSEric Cheng mblk_t *, mac_header_info_t *); 425da14cebeSEric Cheng 426da14cebeSEric Cheng typedef mac_resource_handle_t (*mac_resource_add_t)(void *, mac_resource_t *); 427da14cebeSEric Cheng typedef int (*mac_resource_bind_t)(void *, 428da14cebeSEric Cheng mac_resource_handle_t, processorid_t); 429da14cebeSEric Cheng typedef void (*mac_resource_remove_t)(void *, void *); 430da14cebeSEric Cheng typedef void (*mac_resource_quiesce_t)(void *, void *); 431da14cebeSEric Cheng typedef void (*mac_resource_restart_t)(void *, void *); 432da14cebeSEric Cheng typedef int (*mac_resource_modify_t)(void *, void *, 433da14cebeSEric Cheng mac_resource_t *); 434da14cebeSEric Cheng typedef void (*mac_change_upcall_t)(void *, mac_direct_rx_t, 435da14cebeSEric Cheng void *); 436da14cebeSEric Cheng 437da14cebeSEric Cheng /* 438ba2e4443Sseb * MAC-Type plugin interfaces 439ba2e4443Sseb */ 440ba2e4443Sseb 441ba2e4443Sseb typedef int (*mtops_addr_verify_t)(const void *, void *); 442ba2e4443Sseb typedef boolean_t (*mtops_sap_verify_t)(uint32_t, uint32_t *, void *); 443ba2e4443Sseb typedef mblk_t *(*mtops_header_t)(const void *, const void *, 444ba2e4443Sseb uint32_t, void *, mblk_t *, size_t); 445ba2e4443Sseb typedef int (*mtops_header_info_t)(mblk_t *, void *, 446ba2e4443Sseb mac_header_info_t *); 447ba2e4443Sseb typedef boolean_t (*mtops_pdata_verify_t)(void *, size_t); 448ba2e4443Sseb typedef mblk_t *(*mtops_header_modify_t)(mblk_t *, void *); 4490d2a8e5eSgd78059 typedef void (*mtops_link_details_t)(char *, size_t, mac_handle_t, 4500d2a8e5eSgd78059 void *); 451ba2e4443Sseb 452ba2e4443Sseb typedef struct mactype_ops_s { 453ba2e4443Sseb uint_t mtops_ops; 454ba2e4443Sseb /* 455ba2e4443Sseb * mtops_unicst_verify() returns 0 if the given address is a valid 456ba2e4443Sseb * unicast address, or a non-zero errno otherwise. 457ba2e4443Sseb */ 458ba2e4443Sseb mtops_addr_verify_t mtops_unicst_verify; 459ba2e4443Sseb /* 460ba2e4443Sseb * mtops_multicst_verify() returns 0 if the given address is a 461ba2e4443Sseb * valid multicast address, or a non-zero errno otherwise. If the 462ba2e4443Sseb * media doesn't support multicast, ENOTSUP should be returned (for 463ba2e4443Sseb * example). 464ba2e4443Sseb */ 465ba2e4443Sseb mtops_addr_verify_t mtops_multicst_verify; 466ba2e4443Sseb /* 467ba2e4443Sseb * mtops_sap_verify() returns B_TRUE if the given SAP is a valid 468ba2e4443Sseb * SAP value, or B_FALSE otherwise. 469ba2e4443Sseb */ 470ba2e4443Sseb mtops_sap_verify_t mtops_sap_verify; 471ba2e4443Sseb /* 472ba2e4443Sseb * mtops_header() is used to allocate and construct a MAC header. 473ba2e4443Sseb */ 474ba2e4443Sseb mtops_header_t mtops_header; 475ba2e4443Sseb /* 476ba2e4443Sseb * mtops_header_info() is used to gather information on a given MAC 477ba2e4443Sseb * header. 478ba2e4443Sseb */ 479ba2e4443Sseb mtops_header_info_t mtops_header_info; 480ba2e4443Sseb /* 481ba2e4443Sseb * mtops_pdata_verify() is used to verify the validity of MAC 482ba2e4443Sseb * plugin data. It is called by mac_register() if the driver has 483ba2e4443Sseb * supplied MAC plugin data, and also by mac_pdata_update() when 484ba2e4443Sseb * drivers update the data. 485ba2e4443Sseb */ 486ba2e4443Sseb mtops_pdata_verify_t mtops_pdata_verify; 487ba2e4443Sseb /* 488ba2e4443Sseb * mtops_header_cook() is an optional callback that converts (or 489ba2e4443Sseb * "cooks") the given raw header (as sent by a raw DLPI consumer) 490ba2e4443Sseb * into one that is appropriate to send down to the MAC driver. 491ba2e4443Sseb * Following the example above, an Ethernet header sent down by a 492ba2e4443Sseb * DLPI consumer would be converted to whatever header the MAC 493ba2e4443Sseb * driver expects. 494ba2e4443Sseb */ 495ba2e4443Sseb mtops_header_modify_t mtops_header_cook; 496ba2e4443Sseb /* 497ba2e4443Sseb * mtops_header_uncook() is an optional callback that does the 498ba2e4443Sseb * opposite of mtops_header_cook(). It "uncooks" a given MAC 499ba2e4443Sseb * header (as received from the driver) for consumption by raw DLPI 500ba2e4443Sseb * consumers. For example, for a non-Ethernet plugin that wants 501ba2e4443Sseb * raw DLPI consumers to be fooled into thinking that the device 502ba2e4443Sseb * provides Ethernet access, this callback would modify the given 503ba2e4443Sseb * mblk_t such that the MAC header is converted to an Ethernet 504ba2e4443Sseb * header. 505ba2e4443Sseb */ 506ba2e4443Sseb mtops_header_modify_t mtops_header_uncook; 5070d2a8e5eSgd78059 /* 5080d2a8e5eSgd78059 * mtops_link_details() is an optional callback that provides 5090d2a8e5eSgd78059 * extended information about the link state. Its primary purpose 5100d2a8e5eSgd78059 * is to provide type-specific support for syslog contents on 5110d2a8e5eSgd78059 * link up events. If no implementation is provided, then a default 5120d2a8e5eSgd78059 * implementation will be used. 5130d2a8e5eSgd78059 */ 5140d2a8e5eSgd78059 mtops_link_details_t mtops_link_details; 515ba2e4443Sseb } mactype_ops_t; 516ba2e4443Sseb 517ba2e4443Sseb /* 518ba2e4443Sseb * mtops_ops exists for the plugin to enumerate the optional callback 519ba2e4443Sseb * entrypoints it has defined. This allows the mac module to define 520ba2e4443Sseb * additional plugin entrypoints in mactype_ops_t without breaking backward 521ba2e4443Sseb * compatibility with old plugins. 522ba2e4443Sseb */ 523ba2e4443Sseb #define MTOPS_PDATA_VERIFY 0x001 524ba2e4443Sseb #define MTOPS_HEADER_COOK 0x002 525ba2e4443Sseb #define MTOPS_HEADER_UNCOOK 0x004 5260d2a8e5eSgd78059 #define MTOPS_LINK_DETAILS 0x008 527ba2e4443Sseb 5284045d941Ssowmini /* 5294045d941Ssowmini * Provide mapping for legacy ndd ioctls relevant to that mactype. 5304045d941Ssowmini * Note that the ndd ioctls are obsolete, and may be removed in a future 5314045d941Ssowmini * release of Solaris. The ndd ioctls are not typically used in legacy 5324045d941Ssowmini * ethernet drivers. New datalink drivers of all link-types should use 5334045d941Ssowmini * dladm(1m) interfaces for administering tunables and not have to provide 5344045d941Ssowmini * a mapping. 5354045d941Ssowmini */ 5364045d941Ssowmini typedef struct mac_ndd_mapping_s { 5374045d941Ssowmini char *mp_name; 5384045d941Ssowmini union { 5394045d941Ssowmini mac_prop_id_t u_id; 5404045d941Ssowmini uint_t u_kstat; 5414045d941Ssowmini } u_mp_id; 5424045d941Ssowmini long mp_minval; 5434045d941Ssowmini long mp_maxval; 5444045d941Ssowmini size_t mp_valsize; 5454045d941Ssowmini int mp_flags; 5464045d941Ssowmini } mac_ndd_mapping_t; 5474045d941Ssowmini 5484045d941Ssowmini #define mp_prop_id u_mp_id.u_id 5494045d941Ssowmini #define mp_kstat u_mp_id.u_kstat 5504045d941Ssowmini 551da14cebeSEric Cheng typedef struct mac_stat_info_s { 552da14cebeSEric Cheng uint_t msi_stat; 553da14cebeSEric Cheng char *msi_name; 554da14cebeSEric Cheng uint_t msi_type; /* as defined in kstat_named_init(9F) */ 555da14cebeSEric Cheng uint64_t msi_default; 556da14cebeSEric Cheng } mac_stat_info_t; 557da14cebeSEric Cheng 558ba2e4443Sseb typedef struct mactype_register_s { 559ba2e4443Sseb uint_t mtr_version; /* set by mactype_alloc() */ 560ba2e4443Sseb const char *mtr_ident; 561ba2e4443Sseb mactype_ops_t *mtr_ops; 562ba2e4443Sseb uint_t mtr_mactype; 5630ba2cbe9Sxc151355 uint_t mtr_nativetype; 564ba2e4443Sseb uint_t mtr_addrlen; 565ba2e4443Sseb uint8_t *mtr_brdcst_addr; 566ba2e4443Sseb mac_stat_info_t *mtr_stats; 567ba2e4443Sseb size_t mtr_statcount; 5684045d941Ssowmini mac_ndd_mapping_t *mtr_mapping; 5694045d941Ssowmini size_t mtr_mappingcount; 570ba2e4443Sseb } mactype_register_t; 571ba2e4443Sseb 572e7801d59Ssowmini typedef struct mac_prop_s { 573e7801d59Ssowmini mac_prop_id_t mp_id; 574e7801d59Ssowmini char *mp_name; 5754045d941Ssowmini uint_t mp_flags; 576e7801d59Ssowmini } mac_prop_t; 577e7801d59Ssowmini 5787c478bd9Sstevel@tonic-gate /* 579da14cebeSEric Cheng * Driver interface functions. 5807c478bd9Sstevel@tonic-gate */ 581d62bc4baSyz147064 extern int mac_open_by_linkid(datalink_id_t, 582d62bc4baSyz147064 mac_handle_t *); 583d62bc4baSyz147064 extern int mac_open_by_linkname(const char *, 584d62bc4baSyz147064 mac_handle_t *); 585d62bc4baSyz147064 extern const char *mac_name(mac_handle_t); 586d62bc4baSyz147064 extern minor_t mac_minor(mac_handle_t); 587d62bc4baSyz147064 extern minor_t mac_minor_hold(boolean_t); 588d62bc4baSyz147064 extern void mac_minor_rele(minor_t); 589da14cebeSEric Cheng extern void mac_sdu_get(mac_handle_t, uint_t *, uint_t *); 590da14cebeSEric Cheng extern int mac_maxsdu_update(mac_handle_t, uint_t); 5917c478bd9Sstevel@tonic-gate 592ba2e4443Sseb extern void mac_unicst_update(mac_handle_t, 593ba2e4443Sseb const uint8_t *); 594da14cebeSEric Cheng extern void mac_capab_update(mac_handle_t); 595ba2e4443Sseb extern int mac_pdata_update(mac_handle_t, void *, 596ba2e4443Sseb size_t); 597d62bc4baSyz147064 extern boolean_t mac_margin_update(mac_handle_t, uint32_t); 598d62bc4baSyz147064 extern void mac_margin_get(mac_handle_t, uint32_t *); 599d62bc4baSyz147064 extern int mac_margin_remove(mac_handle_t, uint32_t); 600d62bc4baSyz147064 extern int mac_margin_add(mac_handle_t, uint32_t *, 601d62bc4baSyz147064 boolean_t); 6025d460eafSCathy Zhou extern int mac_fastpath_disable(mac_handle_t); 6035d460eafSCathy Zhou extern void mac_fastpath_enable(mac_handle_t); 604*4eaa4710SRishi Srivatsavai extern void mac_no_active(mac_handle_t); 605d62bc4baSyz147064 606ba2e4443Sseb extern mactype_register_t *mactype_alloc(uint_t); 607ba2e4443Sseb extern void mactype_free(mactype_register_t *); 608ba2e4443Sseb extern int mactype_register(mactype_register_t *); 609ba2e4443Sseb extern int mactype_unregister(const char *); 610da14cebeSEric Cheng 6115d460eafSCathy Zhou extern int mac_start_logusage(mac_logtype_t, uint_t); 612da14cebeSEric Cheng extern void mac_stop_logusage(mac_logtype_t); 613da14cebeSEric Cheng 614da14cebeSEric Cheng extern mac_handle_t mac_get_lower_mac_handle(mac_handle_t); 6157c478bd9Sstevel@tonic-gate 616ae6aa22aSVenugopal Iyer /* 617ae6aa22aSVenugopal Iyer * Packet hashing for distribution to multiple ports and rings. 618ae6aa22aSVenugopal Iyer */ 619ae6aa22aSVenugopal Iyer 620ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L2 0x01 621ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L3 0x02 622ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L4 0x04 623ae6aa22aSVenugopal Iyer 624ae6aa22aSVenugopal Iyer extern uint64_t mac_pkt_hash(uint_t, mblk_t *, uint8_t, 625ae6aa22aSVenugopal Iyer boolean_t); 626ae6aa22aSVenugopal Iyer 627*4eaa4710SRishi Srivatsavai /* 628*4eaa4710SRishi Srivatsavai * Bridging linkage 629*4eaa4710SRishi Srivatsavai */ 630*4eaa4710SRishi Srivatsavai extern void mac_rx_common(mac_handle_t, 631*4eaa4710SRishi Srivatsavai mac_resource_handle_t, mblk_t *); 632*4eaa4710SRishi Srivatsavai extern int mac_bridge_set(mac_handle_t, mac_handle_t); 633*4eaa4710SRishi Srivatsavai extern void mac_bridge_clear(mac_handle_t, mac_handle_t); 634*4eaa4710SRishi Srivatsavai extern void mac_bridge_vectors(mac_bridge_tx_t, 635*4eaa4710SRishi Srivatsavai mac_bridge_rx_t, mac_bridge_ref_t, 636*4eaa4710SRishi Srivatsavai mac_bridge_ls_t); 637*4eaa4710SRishi Srivatsavai 638*4eaa4710SRishi Srivatsavai /* special case function for TRILL observability */ 639*4eaa4710SRishi Srivatsavai extern void mac_trill_snoop(mac_handle_t, mblk_t *); 640*4eaa4710SRishi Srivatsavai 6417c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 6427c478bd9Sstevel@tonic-gate 6437c478bd9Sstevel@tonic-gate #ifdef __cplusplus 6447c478bd9Sstevel@tonic-gate } 6457c478bd9Sstevel@tonic-gate #endif 6467c478bd9Sstevel@tonic-gate 6477c478bd9Sstevel@tonic-gate #endif /* _SYS_MAC_H */ 648