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. 247c478bd9Sstevel@tonic-gate */ 257c478bd9Sstevel@tonic-gate 267c478bd9Sstevel@tonic-gate #ifndef _SYS_MAC_H 277c478bd9Sstevel@tonic-gate #define _SYS_MAC_H 287c478bd9Sstevel@tonic-gate 29605445d5Sdg199075 #include <sys/types.h> 3082a2fc47SJames Carlson #ifdef _KERNEL 317c478bd9Sstevel@tonic-gate #include <sys/sunddi.h> 3282a2fc47SJames Carlson #endif 337c478bd9Sstevel@tonic-gate 347c478bd9Sstevel@tonic-gate /* 357c478bd9Sstevel@tonic-gate * MAC Services Module 367c478bd9Sstevel@tonic-gate */ 377c478bd9Sstevel@tonic-gate 387c478bd9Sstevel@tonic-gate #ifdef __cplusplus 397c478bd9Sstevel@tonic-gate extern "C" { 407c478bd9Sstevel@tonic-gate #endif 417c478bd9Sstevel@tonic-gate 427c478bd9Sstevel@tonic-gate /* 437c478bd9Sstevel@tonic-gate * MAC Information (text emitted by modinfo(1m)) 447c478bd9Sstevel@tonic-gate */ 4561af1958SGarrett D'Amore #define MAC_INFO "MAC Services" 46ba2e4443Sseb 47ba2e4443Sseb /* 48ba2e4443Sseb * MAC-Type version identifier. This is used by mactype_alloc() and 49ba2e4443Sseb * mactype_register() to verify that incompatible MAC-Type plugins don't 50ba2e4443Sseb * register. 51ba2e4443Sseb */ 52ba2e4443Sseb #define MACTYPE_VERSION 0x1 53ba2e4443Sseb 54ba2e4443Sseb /* 55da14cebeSEric Cheng * Opaque handle types 567c478bd9Sstevel@tonic-gate */ 57da14cebeSEric Cheng typedef struct __mac_handle *mac_handle_t; 58da14cebeSEric Cheng typedef struct __mac_resource_handle *mac_resource_handle_t; 59da14cebeSEric Cheng typedef struct __mac_notify_handle *mac_notify_handle_t; 60da14cebeSEric Cheng typedef struct __mac_tx_notify_handle *mac_tx_notify_handle_t; 61da14cebeSEric Cheng typedef struct __mac_intr_handle *mac_intr_handle_t; 62da14cebeSEric Cheng typedef struct __mac_ring_handle *mac_ring_handle_t; 63da14cebeSEric Cheng typedef struct __mac_group_handle *mac_group_handle_t; 647c478bd9Sstevel@tonic-gate 65da14cebeSEric Cheng #define DATALINK_INVALID_LINKID 0 66da14cebeSEric Cheng #define DATALINK_ALL_LINKID 0 67da14cebeSEric Cheng #define DATALINK_MAX_LINKID 0xffffffff 68da14cebeSEric Cheng 697c478bd9Sstevel@tonic-gate typedef enum { 707c478bd9Sstevel@tonic-gate LINK_STATE_UNKNOWN = -1, 717c478bd9Sstevel@tonic-gate LINK_STATE_DOWN, 727c478bd9Sstevel@tonic-gate LINK_STATE_UP 737c478bd9Sstevel@tonic-gate } link_state_t; 747c478bd9Sstevel@tonic-gate 757c478bd9Sstevel@tonic-gate typedef enum { 767c478bd9Sstevel@tonic-gate LINK_DUPLEX_UNKNOWN = 0, 777c478bd9Sstevel@tonic-gate LINK_DUPLEX_HALF, 787c478bd9Sstevel@tonic-gate LINK_DUPLEX_FULL 797c478bd9Sstevel@tonic-gate } link_duplex_t; 807c478bd9Sstevel@tonic-gate 81e7801d59Ssowmini typedef enum { 82e7801d59Ssowmini LINK_FLOWCTRL_NONE = 0, 83e7801d59Ssowmini LINK_FLOWCTRL_RX, 84e7801d59Ssowmini LINK_FLOWCTRL_TX, 85e7801d59Ssowmini LINK_FLOWCTRL_BI 86e7801d59Ssowmini } link_flowctrl_t; 87e7801d59Ssowmini 88e75f0919SSebastien Roy typedef enum { 89e75f0919SSebastien Roy LINK_TAGMODE_VLANONLY = 0, 90e75f0919SSebastien Roy LINK_TAGMODE_NORMAL 91e75f0919SSebastien Roy } link_tagmode_t; 92e75f0919SSebastien Roy 93da14cebeSEric Cheng /* 940dc2366fSVenugopal Iyer * Defines range of uint32_t values 95f0f2c3a5SGirish Moodalbail */ 96f0f2c3a5SGirish Moodalbail typedef struct mac_propval_uint32_range_s { 97f0f2c3a5SGirish Moodalbail uint32_t mpur_min; 98f0f2c3a5SGirish Moodalbail uint32_t mpur_max; 99f0f2c3a5SGirish Moodalbail } mac_propval_uint32_range_t; 100f0f2c3a5SGirish Moodalbail 101f0f2c3a5SGirish Moodalbail /* 1020dc2366fSVenugopal Iyer * Data type of property values. 103f0f2c3a5SGirish Moodalbail */ 104f0f2c3a5SGirish Moodalbail typedef enum { 1050dc2366fSVenugopal Iyer MAC_PROPVAL_UINT8, 1060dc2366fSVenugopal Iyer MAC_PROPVAL_UINT32, 1070dc2366fSVenugopal Iyer MAC_PROPVAL_STR 108f0f2c3a5SGirish Moodalbail } mac_propval_type_t; 109f0f2c3a5SGirish Moodalbail 110f0f2c3a5SGirish Moodalbail /* 111f0f2c3a5SGirish Moodalbail * Captures possible values for a given property. A property can have 112f0f2c3a5SGirish Moodalbail * range of values (int32, int64, uint32, uint64, et al) or collection/ 113f0f2c3a5SGirish Moodalbail * enumeration of values (strings). 114f0f2c3a5SGirish Moodalbail * Can be used as a value-result parameter. 115f0f2c3a5SGirish Moodalbail */ 116f0f2c3a5SGirish Moodalbail typedef struct mac_propval_range_s { 117f0f2c3a5SGirish Moodalbail uint_t mpr_count; /* count of ranges */ 118f0f2c3a5SGirish Moodalbail mac_propval_type_t mpr_type; /* type of value */ 119f0f2c3a5SGirish Moodalbail union { 120f0f2c3a5SGirish Moodalbail mac_propval_uint32_range_t mpr_uint32[1]; 121f0f2c3a5SGirish Moodalbail } u; 122f0f2c3a5SGirish Moodalbail } mac_propval_range_t; 123f0f2c3a5SGirish Moodalbail 1240dc2366fSVenugopal Iyer #define mpr_range_uint32 u.mpr_uint32 125f0f2c3a5SGirish Moodalbail 126f0f2c3a5SGirish Moodalbail /* 127da14cebeSEric Cheng * Maximum MAC address length 128da14cebeSEric Cheng */ 129da14cebeSEric Cheng #define MAXMACADDRLEN 20 130da14cebeSEric Cheng 131da14cebeSEric Cheng typedef enum { 132da14cebeSEric Cheng MAC_LOGTYPE_LINK = 1, 133da14cebeSEric Cheng MAC_LOGTYPE_FLOW 134da14cebeSEric Cheng } mac_logtype_t; 1353fd94f8cSam223141 1360dc2366fSVenugopal Iyer #define MAXLINKPROPNAME 256 /* max property name len */ 1370dc2366fSVenugopal Iyer 1383fd94f8cSam223141 /* 1390dc2366fSVenugopal Iyer * Public properties. 1403fd94f8cSam223141 * 1410dc2366fSVenugopal Iyer * Note that there are 2 sets of parameters: the *_EN_* values are 1420dc2366fSVenugopal Iyer * those that the Administrator configures for autonegotiation. The 1430dc2366fSVenugopal Iyer * _ADV_* values are those that are currently exposed over the wire. 1443fd94f8cSam223141 */ 1453fd94f8cSam223141 typedef enum { 1463fd94f8cSam223141 MAC_PROP_DUPLEX = 0x00000001, 1473fd94f8cSam223141 MAC_PROP_SPEED, 1483fd94f8cSam223141 MAC_PROP_STATUS, 1493fd94f8cSam223141 MAC_PROP_AUTONEG, 1503fd94f8cSam223141 MAC_PROP_EN_AUTONEG, 1513fd94f8cSam223141 MAC_PROP_MTU, 1523bc21d0aSAruna Ramakrishna - Sun Microsystems MAC_PROP_ZONE, 1533bc21d0aSAruna Ramakrishna - Sun Microsystems MAC_PROP_AUTOPUSH, 1543fd94f8cSam223141 MAC_PROP_FLOWCTRL, 1553fd94f8cSam223141 MAC_PROP_ADV_1000FDX_CAP, 1563fd94f8cSam223141 MAC_PROP_EN_1000FDX_CAP, 1573fd94f8cSam223141 MAC_PROP_ADV_1000HDX_CAP, 1583fd94f8cSam223141 MAC_PROP_EN_1000HDX_CAP, 1593fd94f8cSam223141 MAC_PROP_ADV_100FDX_CAP, 1603fd94f8cSam223141 MAC_PROP_EN_100FDX_CAP, 1613fd94f8cSam223141 MAC_PROP_ADV_100HDX_CAP, 1623fd94f8cSam223141 MAC_PROP_EN_100HDX_CAP, 1633fd94f8cSam223141 MAC_PROP_ADV_10FDX_CAP, 1643fd94f8cSam223141 MAC_PROP_EN_10FDX_CAP, 1653fd94f8cSam223141 MAC_PROP_ADV_10HDX_CAP, 1663fd94f8cSam223141 MAC_PROP_EN_10HDX_CAP, 1673fd94f8cSam223141 MAC_PROP_ADV_100T4_CAP, 1683fd94f8cSam223141 MAC_PROP_EN_100T4_CAP, 1692b24ab6bSSebastien Roy MAC_PROP_IPTUN_HOPLIMIT, 1702b24ab6bSSebastien Roy MAC_PROP_IPTUN_ENCAPLIMIT, 171bcb5c89dSSowmini Varadhan MAC_PROP_WL_ESSID, 172bcb5c89dSSowmini Varadhan MAC_PROP_WL_BSSID, 173bcb5c89dSSowmini Varadhan MAC_PROP_WL_BSSTYPE, 174bcb5c89dSSowmini Varadhan MAC_PROP_WL_LINKSTATUS, 175bcb5c89dSSowmini Varadhan MAC_PROP_WL_DESIRED_RATES, 176bcb5c89dSSowmini Varadhan MAC_PROP_WL_SUPPORTED_RATES, 177bcb5c89dSSowmini Varadhan MAC_PROP_WL_AUTH_MODE, 178bcb5c89dSSowmini Varadhan MAC_PROP_WL_ENCRYPTION, 179bcb5c89dSSowmini Varadhan MAC_PROP_WL_RSSI, 180bcb5c89dSSowmini Varadhan MAC_PROP_WL_PHY_CONFIG, 181bcb5c89dSSowmini Varadhan MAC_PROP_WL_CAPABILITY, 182bcb5c89dSSowmini Varadhan MAC_PROP_WL_WPA, 183bcb5c89dSSowmini Varadhan MAC_PROP_WL_SCANRESULTS, 184bcb5c89dSSowmini Varadhan MAC_PROP_WL_POWER_MODE, 185bcb5c89dSSowmini Varadhan MAC_PROP_WL_RADIO, 186bcb5c89dSSowmini Varadhan MAC_PROP_WL_ESS_LIST, 187bcb5c89dSSowmini Varadhan MAC_PROP_WL_KEY_TAB, 188bcb5c89dSSowmini Varadhan MAC_PROP_WL_CREATE_IBSS, 189bcb5c89dSSowmini Varadhan MAC_PROP_WL_SETOPTIE, 190bcb5c89dSSowmini Varadhan MAC_PROP_WL_DELKEY, 191bcb5c89dSSowmini Varadhan MAC_PROP_WL_KEY, 192bcb5c89dSSowmini Varadhan MAC_PROP_WL_MLME, 193e75f0919SSebastien Roy MAC_PROP_TAGMODE, 194aca118b7Slucy wang - Sun Microsystems - Beijing China MAC_PROP_ADV_10GFDX_CAP, 195aca118b7Slucy wang - Sun Microsystems - Beijing China MAC_PROP_EN_10GFDX_CAP, 1964eaa4710SRishi Srivatsavai MAC_PROP_PVID, 1974eaa4710SRishi Srivatsavai MAC_PROP_LLIMIT, 1984eaa4710SRishi Srivatsavai MAC_PROP_LDECAY, 1990dc2366fSVenugopal Iyer MAC_PROP_RESOURCE, 2000dc2366fSVenugopal Iyer MAC_PROP_RESOURCE_EFF, 2010dc2366fSVenugopal Iyer MAC_PROP_RXRINGSRANGE, 2020dc2366fSVenugopal Iyer MAC_PROP_TXRINGSRANGE, 2030dc2366fSVenugopal Iyer MAC_PROP_MAX_TX_RINGS_AVAIL, 2040dc2366fSVenugopal Iyer MAC_PROP_MAX_RX_RINGS_AVAIL, 2050dc2366fSVenugopal Iyer MAC_PROP_MAX_RXHWCLNT_AVAIL, 2060dc2366fSVenugopal Iyer MAC_PROP_MAX_TXHWCLNT_AVAIL, 2071cfa752fSRamaswamy Tummala MAC_PROP_IB_LINKMODE, 2083fd94f8cSam223141 MAC_PROP_PRIVATE = -1 2093fd94f8cSam223141 } mac_prop_id_t; 2103fd94f8cSam223141 211843e1988Sjohnlev /* 212afdda45fSVasumathi Sundaram - Sun Microsystems * Flags to figure out r/w status of legacy ndd props. 213afdda45fSVasumathi Sundaram - Sun Microsystems */ 214afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_READ 0x0001 215afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_WRITE 0x0010 216afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_MAP_KSTAT 0x0100 217afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_PERM_RW (MAC_PROP_PERM_READ|MAC_PROP_PERM_WRITE) 218afdda45fSVasumathi Sundaram - Sun Microsystems #define MAC_PROP_FLAGS_RK (MAC_PROP_PERM_READ|MAC_PROP_MAP_KSTAT) 219afdda45fSVasumathi Sundaram - Sun Microsystems 2207c478bd9Sstevel@tonic-gate #ifdef _KERNEL 2217c478bd9Sstevel@tonic-gate 2227c478bd9Sstevel@tonic-gate /* 223ba2e4443Sseb * There are three ranges of statistics values. 0 to 1 - MAC_STAT_MIN are 224ba2e4443Sseb * interface statistics maintained by the mac module. MAC_STAT_MIN to 1 - 225ba2e4443Sseb * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and 226ba2e4443Sseb * maintained by each driver. MACTYPE_STAT_MIN and above are statistics 227ba2e4443Sseb * defined by MAC-Type plugins and maintained by each driver. 2287c478bd9Sstevel@tonic-gate */ 229ba2e4443Sseb #define MAC_STAT_MIN 1000 230ba2e4443Sseb #define MACTYPE_STAT_MIN 2000 231ba2e4443Sseb 232ba2e4443Sseb #define IS_MAC_STAT(stat) \ 233ba2e4443Sseb (stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN) 234ba2e4443Sseb #define IS_MACTYPE_STAT(stat) (stat >= MACTYPE_STAT_MIN) 235ba2e4443Sseb 2369b14cf1dSgd78059 /* 237d62bc4baSyz147064 * Statistics maintained by the mac module, and possibly populated as link 238d62bc4baSyz147064 * statistics. 239d62bc4baSyz147064 */ 240d62bc4baSyz147064 enum mac_mod_stat { 241d62bc4baSyz147064 MAC_STAT_LINK_STATE, 242d62bc4baSyz147064 MAC_STAT_LINK_UP, 2434eaa4710SRishi Srivatsavai MAC_STAT_PROMISC, 2440dc2366fSVenugopal Iyer MAC_STAT_LOWLINK_STATE, 2450dc2366fSVenugopal Iyer MAC_STAT_HDROPS 246d62bc4baSyz147064 }; 247d62bc4baSyz147064 248d62bc4baSyz147064 /* 2499b14cf1dSgd78059 * Do not reorder, and add only to the end of this list. 2509b14cf1dSgd78059 */ 251ba2e4443Sseb enum mac_driver_stat { 252ba2e4443Sseb /* MIB-II stats (RFC 1213 and RFC 1573) */ 253ba2e4443Sseb MAC_STAT_IFSPEED = MAC_STAT_MIN, 2547c478bd9Sstevel@tonic-gate MAC_STAT_MULTIRCV, 2557c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTRCV, 2567c478bd9Sstevel@tonic-gate MAC_STAT_MULTIXMT, 2577c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTXMT, 2587c478bd9Sstevel@tonic-gate MAC_STAT_NORCVBUF, 2597c478bd9Sstevel@tonic-gate MAC_STAT_IERRORS, 2607c478bd9Sstevel@tonic-gate MAC_STAT_UNKNOWNS, 2617c478bd9Sstevel@tonic-gate MAC_STAT_NOXMTBUF, 2627c478bd9Sstevel@tonic-gate MAC_STAT_OERRORS, 2637c478bd9Sstevel@tonic-gate MAC_STAT_COLLISIONS, 2647c478bd9Sstevel@tonic-gate MAC_STAT_RBYTES, 2657c478bd9Sstevel@tonic-gate MAC_STAT_IPACKETS, 2667c478bd9Sstevel@tonic-gate MAC_STAT_OBYTES, 2679b14cf1dSgd78059 MAC_STAT_OPACKETS, 2689b14cf1dSgd78059 MAC_STAT_UNDERFLOWS, 2699b14cf1dSgd78059 MAC_STAT_OVERFLOWS 2707c478bd9Sstevel@tonic-gate }; 2717c478bd9Sstevel@tonic-gate 2729b14cf1dSgd78059 #define MAC_NSTAT (MAC_STAT_OVERFLOWS - MAC_STAT_IFSPEED + 1) 273ba2e4443Sseb 274ba2e4443Sseb #define MAC_STAT_ISACOUNTER(_stat) ( \ 275ba2e4443Sseb (_stat) == MAC_STAT_MULTIRCV || \ 276ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTRCV || \ 277ba2e4443Sseb (_stat) == MAC_STAT_MULTIXMT || \ 278ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTXMT || \ 279ba2e4443Sseb (_stat) == MAC_STAT_NORCVBUF || \ 280ba2e4443Sseb (_stat) == MAC_STAT_IERRORS || \ 281ba2e4443Sseb (_stat) == MAC_STAT_UNKNOWNS || \ 282ba2e4443Sseb (_stat) == MAC_STAT_NOXMTBUF || \ 283ba2e4443Sseb (_stat) == MAC_STAT_OERRORS || \ 284ba2e4443Sseb (_stat) == MAC_STAT_COLLISIONS || \ 285ba2e4443Sseb (_stat) == MAC_STAT_RBYTES || \ 286ba2e4443Sseb (_stat) == MAC_STAT_IPACKETS || \ 287ba2e4443Sseb (_stat) == MAC_STAT_OBYTES || \ 2889b14cf1dSgd78059 (_stat) == MAC_STAT_OPACKETS || \ 2899b14cf1dSgd78059 (_stat) == MAC_STAT_UNDERFLOWS || \ 2909b14cf1dSgd78059 (_stat) == MAC_STAT_OVERFLOWS) 291ba2e4443Sseb 2927c478bd9Sstevel@tonic-gate /* 2937c478bd9Sstevel@tonic-gate * Immutable information. (This may not be modified after registration). 2947c478bd9Sstevel@tonic-gate */ 2957c478bd9Sstevel@tonic-gate typedef struct mac_info_s { 2967c478bd9Sstevel@tonic-gate uint_t mi_media; 2970ba2cbe9Sxc151355 uint_t mi_nativemedia; 2987c478bd9Sstevel@tonic-gate uint_t mi_addr_length; 299ba2e4443Sseb uint8_t *mi_unicst_addr; 300ba2e4443Sseb uint8_t *mi_brdcst_addr; 3017c478bd9Sstevel@tonic-gate } mac_info_t; 3027c478bd9Sstevel@tonic-gate 3037c478bd9Sstevel@tonic-gate /* 304da14cebeSEric Cheng * When VNICs are created on top of the NIC, there are two levels 305da14cebeSEric Cheng * of MAC layer, a lower MAC, which is the MAC layer at the level of the 306da14cebeSEric Cheng * physical NIC, and an upper MAC, which is the MAC layer at the level 307da14cebeSEric Cheng * of the VNIC. Each VNIC maps to a MAC client at the lower MAC, and 308da14cebeSEric Cheng * the SRS and classification is done at the lower MAC level. The upper 309da14cebeSEric Cheng * MAC is therefore for the most part pass-through, and therefore 310da14cebeSEric Cheng * special processing needs to be done at the upper MAC layer when 311da14cebeSEric Cheng * dealing with a VNIC. 312678453a8Sspeer * 313da14cebeSEric Cheng * This capability allows the MAC layer to detect when a VNIC is being 314da14cebeSEric Cheng * access, and implement the required shortcuts. 315678453a8Sspeer */ 316678453a8Sspeer 317da14cebeSEric Cheng typedef void *(*mac_client_handle_fn_t)(void *); 318678453a8Sspeer 319da14cebeSEric Cheng typedef struct mac_capab_vnic_s { 320da14cebeSEric Cheng void *mcv_arg; 321da14cebeSEric Cheng mac_client_handle_fn_t mcv_mac_client_handle; 322da14cebeSEric Cheng } mac_capab_vnic_t; 323678453a8Sspeer 324da14cebeSEric Cheng typedef void (*mac_rename_fn_t)(const char *, void *); 3250dc2366fSVenugopal Iyer typedef mblk_t *(*mac_tx_ring_fn_t)(void *, mblk_t *, uintptr_t, 3260dc2366fSVenugopal Iyer mac_ring_handle_t *); 327da14cebeSEric Cheng typedef struct mac_capab_aggr_s { 328da14cebeSEric Cheng mac_rename_fn_t mca_rename_fn; 329da14cebeSEric Cheng int (*mca_unicst)(void *, const uint8_t *); 3300dc2366fSVenugopal Iyer mac_tx_ring_fn_t mca_find_tx_ring_fn; 3310dc2366fSVenugopal Iyer void *mca_arg; 332da14cebeSEric Cheng } mac_capab_aggr_t; 333678453a8Sspeer 3344eaa4710SRishi Srivatsavai /* Bridge transmit and receive function signatures */ 3354eaa4710SRishi Srivatsavai typedef mblk_t *(*mac_bridge_tx_t)(mac_handle_t, mac_ring_handle_t, mblk_t *); 3364eaa4710SRishi Srivatsavai typedef void (*mac_bridge_rx_t)(mac_handle_t, mac_resource_handle_t, mblk_t *); 3374eaa4710SRishi Srivatsavai typedef void (*mac_bridge_ref_t)(mac_handle_t, boolean_t); 3384eaa4710SRishi Srivatsavai typedef link_state_t (*mac_bridge_ls_t)(mac_handle_t, link_state_t); 3394eaa4710SRishi Srivatsavai 3404eaa4710SRishi Srivatsavai /* must change mac_notify_cb_list[] in mac_provider.c if this is changed */ 3417c478bd9Sstevel@tonic-gate typedef enum { 3427c478bd9Sstevel@tonic-gate MAC_NOTE_LINK, 3437c478bd9Sstevel@tonic-gate MAC_NOTE_UNICST, 3447c478bd9Sstevel@tonic-gate MAC_NOTE_TX, 3457c478bd9Sstevel@tonic-gate MAC_NOTE_DEVPROMISC, 346ba2e4443Sseb MAC_NOTE_FASTPATH_FLUSH, 347e7801d59Ssowmini MAC_NOTE_SDU_SIZE, 3482b24ab6bSSebastien Roy MAC_NOTE_DEST, 349d62bc4baSyz147064 MAC_NOTE_MARGIN, 350da14cebeSEric Cheng MAC_NOTE_CAPAB_CHG, 3514eaa4710SRishi Srivatsavai MAC_NOTE_LOWLINK, 352550b6e40SSowmini Varadhan MAC_NOTE_ALLOWED_IPS, 3537c478bd9Sstevel@tonic-gate MAC_NNOTE /* must be the last entry */ 3547c478bd9Sstevel@tonic-gate } mac_notify_type_t; 3557c478bd9Sstevel@tonic-gate 3567c478bd9Sstevel@tonic-gate typedef void (*mac_notify_t)(void *, mac_notify_type_t); 357da14cebeSEric Cheng typedef void (*mac_rx_t)(void *, mac_resource_handle_t, mblk_t *, 358da14cebeSEric Cheng boolean_t); 359da14cebeSEric Cheng typedef mblk_t *(*mac_receive_t)(void *, int); 3607c478bd9Sstevel@tonic-gate 3617c478bd9Sstevel@tonic-gate /* 3627c478bd9Sstevel@tonic-gate * MAC resource types 3637c478bd9Sstevel@tonic-gate */ 3647c478bd9Sstevel@tonic-gate typedef enum { 3657c478bd9Sstevel@tonic-gate MAC_RX_FIFO = 1 3667c478bd9Sstevel@tonic-gate } mac_resource_type_t; 3677c478bd9Sstevel@tonic-gate 368da14cebeSEric Cheng typedef int (*mac_intr_enable_t)(mac_intr_handle_t); 369da14cebeSEric Cheng typedef int (*mac_intr_disable_t)(mac_intr_handle_t); 370da14cebeSEric Cheng 371da14cebeSEric Cheng typedef struct mac_intr_s { 372da14cebeSEric Cheng mac_intr_handle_t mi_handle; 373da14cebeSEric Cheng mac_intr_enable_t mi_enable; 374da14cebeSEric Cheng mac_intr_disable_t mi_disable; 3750dc2366fSVenugopal Iyer ddi_intr_handle_t mi_ddi_handle; 3760dc2366fSVenugopal Iyer boolean_t mi_ddi_shared; 377da14cebeSEric Cheng } mac_intr_t; 378da14cebeSEric Cheng 3797c478bd9Sstevel@tonic-gate typedef struct mac_rx_fifo_s { 3807c478bd9Sstevel@tonic-gate mac_resource_type_t mrf_type; /* MAC_RX_FIFO */ 381da14cebeSEric Cheng mac_intr_t mrf_intr; 382da14cebeSEric Cheng mac_receive_t mrf_receive; 383da14cebeSEric Cheng void *mrf_rx_arg; 384da14cebeSEric Cheng uint32_t mrf_flow_priority; 385da14cebeSEric Cheng /* 386da14cebeSEric Cheng * The CPU this flow is to be processed on. With intrd and future 387da14cebeSEric Cheng * things, we should know which CPU the flow needs to be processed 388da14cebeSEric Cheng * and get a squeue assigned on that CPU. 389da14cebeSEric Cheng */ 390da14cebeSEric Cheng uint_t mrf_cpu_id; 3917c478bd9Sstevel@tonic-gate } mac_rx_fifo_t; 3927c478bd9Sstevel@tonic-gate 393da14cebeSEric Cheng #define mrf_intr_handle mrf_intr.mi_handle 394da14cebeSEric Cheng #define mrf_intr_enable mrf_intr.mi_enable 395da14cebeSEric Cheng #define mrf_intr_disable mrf_intr.mi_disable 39698b1442aSmeem 3977c478bd9Sstevel@tonic-gate typedef union mac_resource_u { 3987c478bd9Sstevel@tonic-gate mac_resource_type_t mr_type; 3997c478bd9Sstevel@tonic-gate mac_rx_fifo_t mr_fifo; 4007c478bd9Sstevel@tonic-gate } mac_resource_t; 4017c478bd9Sstevel@tonic-gate 402ba2e4443Sseb typedef enum { 403ba2e4443Sseb MAC_ADDRTYPE_UNICAST, 404ba2e4443Sseb MAC_ADDRTYPE_MULTICAST, 405ba2e4443Sseb MAC_ADDRTYPE_BROADCAST 406ba2e4443Sseb } mac_addrtype_t; 407ba2e4443Sseb 408ba2e4443Sseb typedef struct mac_header_info_s { 409ba2e4443Sseb size_t mhi_hdrsize; 410ba2e4443Sseb size_t mhi_pktsize; 411ba2e4443Sseb const uint8_t *mhi_daddr; 412ba2e4443Sseb const uint8_t *mhi_saddr; 413ba2e4443Sseb uint32_t mhi_origsap; 414ba2e4443Sseb uint32_t mhi_bindsap; 415ba2e4443Sseb mac_addrtype_t mhi_dsttype; 416605445d5Sdg199075 uint16_t mhi_tci; 417da14cebeSEric Cheng boolean_t mhi_istagged; 4184eaa4710SRishi Srivatsavai boolean_t mhi_ispvid; 419ba2e4443Sseb } mac_header_info_t; 420ba2e4443Sseb 421ba2e4443Sseb /* 422da14cebeSEric Cheng * Function pointer to match dls client signature. Should be same as 423da14cebeSEric Cheng * dls_rx_t to allow a soft ring to bypass DLS layer and call a DLS 424da14cebeSEric Cheng * client directly. 425da14cebeSEric Cheng */ 426da14cebeSEric Cheng typedef void (*mac_direct_rx_t)(void *, mac_resource_handle_t, 427da14cebeSEric Cheng mblk_t *, mac_header_info_t *); 428da14cebeSEric Cheng 429da14cebeSEric Cheng typedef mac_resource_handle_t (*mac_resource_add_t)(void *, mac_resource_t *); 430da14cebeSEric Cheng typedef int (*mac_resource_bind_t)(void *, 431da14cebeSEric Cheng mac_resource_handle_t, processorid_t); 432da14cebeSEric Cheng typedef void (*mac_resource_remove_t)(void *, void *); 433da14cebeSEric Cheng typedef void (*mac_resource_quiesce_t)(void *, void *); 434da14cebeSEric Cheng typedef void (*mac_resource_restart_t)(void *, void *); 435da14cebeSEric Cheng typedef int (*mac_resource_modify_t)(void *, void *, 436da14cebeSEric Cheng mac_resource_t *); 437da14cebeSEric Cheng typedef void (*mac_change_upcall_t)(void *, mac_direct_rx_t, 438da14cebeSEric Cheng void *); 439da14cebeSEric Cheng 440da14cebeSEric Cheng /* 441ba2e4443Sseb * MAC-Type plugin interfaces 442ba2e4443Sseb */ 443ba2e4443Sseb 444ba2e4443Sseb typedef int (*mtops_addr_verify_t)(const void *, void *); 445ba2e4443Sseb typedef boolean_t (*mtops_sap_verify_t)(uint32_t, uint32_t *, void *); 446ba2e4443Sseb typedef mblk_t *(*mtops_header_t)(const void *, const void *, 447ba2e4443Sseb uint32_t, void *, mblk_t *, size_t); 448ba2e4443Sseb typedef int (*mtops_header_info_t)(mblk_t *, void *, 449ba2e4443Sseb mac_header_info_t *); 450ba2e4443Sseb typedef boolean_t (*mtops_pdata_verify_t)(void *, size_t); 451ba2e4443Sseb typedef mblk_t *(*mtops_header_modify_t)(mblk_t *, void *); 4520d2a8e5eSgd78059 typedef void (*mtops_link_details_t)(char *, size_t, mac_handle_t, 4530d2a8e5eSgd78059 void *); 454ba2e4443Sseb 455ba2e4443Sseb typedef struct mactype_ops_s { 456ba2e4443Sseb uint_t mtops_ops; 457ba2e4443Sseb /* 458ba2e4443Sseb * mtops_unicst_verify() returns 0 if the given address is a valid 459ba2e4443Sseb * unicast address, or a non-zero errno otherwise. 460ba2e4443Sseb */ 461ba2e4443Sseb mtops_addr_verify_t mtops_unicst_verify; 462ba2e4443Sseb /* 463ba2e4443Sseb * mtops_multicst_verify() returns 0 if the given address is a 464ba2e4443Sseb * valid multicast address, or a non-zero errno otherwise. If the 465ba2e4443Sseb * media doesn't support multicast, ENOTSUP should be returned (for 466ba2e4443Sseb * example). 467ba2e4443Sseb */ 468ba2e4443Sseb mtops_addr_verify_t mtops_multicst_verify; 469ba2e4443Sseb /* 470ba2e4443Sseb * mtops_sap_verify() returns B_TRUE if the given SAP is a valid 471ba2e4443Sseb * SAP value, or B_FALSE otherwise. 472ba2e4443Sseb */ 473ba2e4443Sseb mtops_sap_verify_t mtops_sap_verify; 474ba2e4443Sseb /* 475ba2e4443Sseb * mtops_header() is used to allocate and construct a MAC header. 476ba2e4443Sseb */ 477ba2e4443Sseb mtops_header_t mtops_header; 478ba2e4443Sseb /* 479ba2e4443Sseb * mtops_header_info() is used to gather information on a given MAC 480ba2e4443Sseb * header. 481ba2e4443Sseb */ 482ba2e4443Sseb mtops_header_info_t mtops_header_info; 483ba2e4443Sseb /* 484ba2e4443Sseb * mtops_pdata_verify() is used to verify the validity of MAC 485ba2e4443Sseb * plugin data. It is called by mac_register() if the driver has 486ba2e4443Sseb * supplied MAC plugin data, and also by mac_pdata_update() when 487ba2e4443Sseb * drivers update the data. 488ba2e4443Sseb */ 489ba2e4443Sseb mtops_pdata_verify_t mtops_pdata_verify; 490ba2e4443Sseb /* 491ba2e4443Sseb * mtops_header_cook() is an optional callback that converts (or 492ba2e4443Sseb * "cooks") the given raw header (as sent by a raw DLPI consumer) 493ba2e4443Sseb * into one that is appropriate to send down to the MAC driver. 494ba2e4443Sseb * Following the example above, an Ethernet header sent down by a 495ba2e4443Sseb * DLPI consumer would be converted to whatever header the MAC 496ba2e4443Sseb * driver expects. 497ba2e4443Sseb */ 498ba2e4443Sseb mtops_header_modify_t mtops_header_cook; 499ba2e4443Sseb /* 500ba2e4443Sseb * mtops_header_uncook() is an optional callback that does the 501ba2e4443Sseb * opposite of mtops_header_cook(). It "uncooks" a given MAC 502ba2e4443Sseb * header (as received from the driver) for consumption by raw DLPI 503ba2e4443Sseb * consumers. For example, for a non-Ethernet plugin that wants 504ba2e4443Sseb * raw DLPI consumers to be fooled into thinking that the device 505ba2e4443Sseb * provides Ethernet access, this callback would modify the given 506ba2e4443Sseb * mblk_t such that the MAC header is converted to an Ethernet 507ba2e4443Sseb * header. 508ba2e4443Sseb */ 509ba2e4443Sseb mtops_header_modify_t mtops_header_uncook; 5100d2a8e5eSgd78059 /* 5110d2a8e5eSgd78059 * mtops_link_details() is an optional callback that provides 5120d2a8e5eSgd78059 * extended information about the link state. Its primary purpose 5130d2a8e5eSgd78059 * is to provide type-specific support for syslog contents on 5140d2a8e5eSgd78059 * link up events. If no implementation is provided, then a default 5150d2a8e5eSgd78059 * implementation will be used. 5160d2a8e5eSgd78059 */ 5170d2a8e5eSgd78059 mtops_link_details_t mtops_link_details; 518ba2e4443Sseb } mactype_ops_t; 519ba2e4443Sseb 520ba2e4443Sseb /* 521ba2e4443Sseb * mtops_ops exists for the plugin to enumerate the optional callback 522ba2e4443Sseb * entrypoints it has defined. This allows the mac module to define 523ba2e4443Sseb * additional plugin entrypoints in mactype_ops_t without breaking backward 524ba2e4443Sseb * compatibility with old plugins. 525ba2e4443Sseb */ 526ba2e4443Sseb #define MTOPS_PDATA_VERIFY 0x001 527ba2e4443Sseb #define MTOPS_HEADER_COOK 0x002 528ba2e4443Sseb #define MTOPS_HEADER_UNCOOK 0x004 5290d2a8e5eSgd78059 #define MTOPS_LINK_DETAILS 0x008 530ba2e4443Sseb 5314045d941Ssowmini /* 5324045d941Ssowmini * Provide mapping for legacy ndd ioctls relevant to that mactype. 5334045d941Ssowmini * Note that the ndd ioctls are obsolete, and may be removed in a future 5344045d941Ssowmini * release of Solaris. The ndd ioctls are not typically used in legacy 5354045d941Ssowmini * ethernet drivers. New datalink drivers of all link-types should use 5364045d941Ssowmini * dladm(1m) interfaces for administering tunables and not have to provide 5374045d941Ssowmini * a mapping. 5384045d941Ssowmini */ 5394045d941Ssowmini typedef struct mac_ndd_mapping_s { 5404045d941Ssowmini char *mp_name; 5414045d941Ssowmini union { 5424045d941Ssowmini mac_prop_id_t u_id; 5434045d941Ssowmini uint_t u_kstat; 5444045d941Ssowmini } u_mp_id; 5454045d941Ssowmini long mp_minval; 5464045d941Ssowmini long mp_maxval; 5474045d941Ssowmini size_t mp_valsize; 5484045d941Ssowmini int mp_flags; 5494045d941Ssowmini } mac_ndd_mapping_t; 5504045d941Ssowmini 5514045d941Ssowmini #define mp_prop_id u_mp_id.u_id 5524045d941Ssowmini #define mp_kstat u_mp_id.u_kstat 5534045d941Ssowmini 554da14cebeSEric Cheng typedef struct mac_stat_info_s { 555da14cebeSEric Cheng uint_t msi_stat; 556da14cebeSEric Cheng char *msi_name; 557da14cebeSEric Cheng uint_t msi_type; /* as defined in kstat_named_init(9F) */ 558da14cebeSEric Cheng uint64_t msi_default; 559da14cebeSEric Cheng } mac_stat_info_t; 560da14cebeSEric Cheng 561ba2e4443Sseb typedef struct mactype_register_s { 562ba2e4443Sseb uint_t mtr_version; /* set by mactype_alloc() */ 563ba2e4443Sseb const char *mtr_ident; 564ba2e4443Sseb mactype_ops_t *mtr_ops; 565ba2e4443Sseb uint_t mtr_mactype; 5660ba2cbe9Sxc151355 uint_t mtr_nativetype; 567ba2e4443Sseb uint_t mtr_addrlen; 568ba2e4443Sseb uint8_t *mtr_brdcst_addr; 569ba2e4443Sseb mac_stat_info_t *mtr_stats; 570ba2e4443Sseb size_t mtr_statcount; 5714045d941Ssowmini mac_ndd_mapping_t *mtr_mapping; 5724045d941Ssowmini size_t mtr_mappingcount; 573ba2e4443Sseb } mactype_register_t; 574ba2e4443Sseb 5757c478bd9Sstevel@tonic-gate /* 576da14cebeSEric Cheng * Driver interface functions. 5777c478bd9Sstevel@tonic-gate */ 578d62bc4baSyz147064 extern int mac_open_by_linkid(datalink_id_t, 579d62bc4baSyz147064 mac_handle_t *); 580d62bc4baSyz147064 extern int mac_open_by_linkname(const char *, 581d62bc4baSyz147064 mac_handle_t *); 582d62bc4baSyz147064 extern const char *mac_name(mac_handle_t); 583d62bc4baSyz147064 extern minor_t mac_minor(mac_handle_t); 584d62bc4baSyz147064 extern minor_t mac_minor_hold(boolean_t); 585d62bc4baSyz147064 extern void mac_minor_rele(minor_t); 586da14cebeSEric Cheng extern void mac_sdu_get(mac_handle_t, uint_t *, uint_t *); 587*1eee170aSErik Nordmark extern void mac_sdu_get2(mac_handle_t, uint_t *, uint_t *, 588*1eee170aSErik Nordmark uint_t *); 589da14cebeSEric Cheng extern int mac_maxsdu_update(mac_handle_t, uint_t); 590*1eee170aSErik Nordmark extern int mac_maxsdu_update2(mac_handle_t, uint_t, 591*1eee170aSErik Nordmark uint_t); 5920a0e9771SDarren Reed extern uint_t mac_addr_len(mac_handle_t); 5930a0e9771SDarren Reed extern int mac_type(mac_handle_t); 594f195a053SDarren Reed extern int mac_nativetype(mac_handle_t); 5957c478bd9Sstevel@tonic-gate 596ba2e4443Sseb extern void mac_unicst_update(mac_handle_t, 597ba2e4443Sseb const uint8_t *); 598da14cebeSEric Cheng extern void mac_capab_update(mac_handle_t); 599ba2e4443Sseb extern int mac_pdata_update(mac_handle_t, void *, 600ba2e4443Sseb size_t); 601d62bc4baSyz147064 extern boolean_t mac_margin_update(mac_handle_t, uint32_t); 602d62bc4baSyz147064 extern void mac_margin_get(mac_handle_t, uint32_t *); 603d62bc4baSyz147064 extern int mac_margin_remove(mac_handle_t, uint32_t); 604d62bc4baSyz147064 extern int mac_margin_add(mac_handle_t, uint32_t *, 605d62bc4baSyz147064 boolean_t); 6065d460eafSCathy Zhou extern int mac_fastpath_disable(mac_handle_t); 6075d460eafSCathy Zhou extern void mac_fastpath_enable(mac_handle_t); 6084eaa4710SRishi Srivatsavai extern void mac_no_active(mac_handle_t); 609d62bc4baSyz147064 610ba2e4443Sseb extern mactype_register_t *mactype_alloc(uint_t); 611ba2e4443Sseb extern void mactype_free(mactype_register_t *); 612ba2e4443Sseb extern int mactype_register(mactype_register_t *); 613ba2e4443Sseb extern int mactype_unregister(const char *); 614da14cebeSEric Cheng 6155d460eafSCathy Zhou extern int mac_start_logusage(mac_logtype_t, uint_t); 616da14cebeSEric Cheng extern void mac_stop_logusage(mac_logtype_t); 617da14cebeSEric Cheng 618da14cebeSEric Cheng extern mac_handle_t mac_get_lower_mac_handle(mac_handle_t); 6190dc2366fSVenugopal Iyer extern boolean_t mac_is_vnic_primary(mac_handle_t); 6207c478bd9Sstevel@tonic-gate 621ae6aa22aSVenugopal Iyer /* 622ae6aa22aSVenugopal Iyer * Packet hashing for distribution to multiple ports and rings. 623ae6aa22aSVenugopal Iyer */ 624ae6aa22aSVenugopal Iyer 625ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L2 0x01 626ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L3 0x02 627ae6aa22aSVenugopal Iyer #define MAC_PKT_HASH_L4 0x04 628ae6aa22aSVenugopal Iyer 629ae6aa22aSVenugopal Iyer extern uint64_t mac_pkt_hash(uint_t, mblk_t *, uint8_t, 630ae6aa22aSVenugopal Iyer boolean_t); 631ae6aa22aSVenugopal Iyer 6324eaa4710SRishi Srivatsavai /* 6334eaa4710SRishi Srivatsavai * Bridging linkage 6344eaa4710SRishi Srivatsavai */ 6354eaa4710SRishi Srivatsavai extern void mac_rx_common(mac_handle_t, 6364eaa4710SRishi Srivatsavai mac_resource_handle_t, mblk_t *); 6374eaa4710SRishi Srivatsavai extern int mac_bridge_set(mac_handle_t, mac_handle_t); 6384eaa4710SRishi Srivatsavai extern void mac_bridge_clear(mac_handle_t, mac_handle_t); 6394eaa4710SRishi Srivatsavai extern void mac_bridge_vectors(mac_bridge_tx_t, 6404eaa4710SRishi Srivatsavai mac_bridge_rx_t, mac_bridge_ref_t, 6414eaa4710SRishi Srivatsavai mac_bridge_ls_t); 6424eaa4710SRishi Srivatsavai 6434eaa4710SRishi Srivatsavai /* special case function for TRILL observability */ 6444eaa4710SRishi Srivatsavai extern void mac_trill_snoop(mac_handle_t, mblk_t *); 6454eaa4710SRishi Srivatsavai 6467c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 6477c478bd9Sstevel@tonic-gate 6487c478bd9Sstevel@tonic-gate #ifdef __cplusplus 6497c478bd9Sstevel@tonic-gate } 6507c478bd9Sstevel@tonic-gate #endif 6517c478bd9Sstevel@tonic-gate 6527c478bd9Sstevel@tonic-gate #endif /* _SYS_MAC_H */ 653