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 */ 217c478bd9Sstevel@tonic-gate /* 22*d62bc4baSyz147064 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 237c478bd9Sstevel@tonic-gate * Use is subject to license terms. 247c478bd9Sstevel@tonic-gate */ 257c478bd9Sstevel@tonic-gate 267c478bd9Sstevel@tonic-gate #ifndef _SYS_MAC_H 277c478bd9Sstevel@tonic-gate #define _SYS_MAC_H 287c478bd9Sstevel@tonic-gate 297c478bd9Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI" 307c478bd9Sstevel@tonic-gate 31605445d5Sdg199075 #include <sys/types.h> 327c478bd9Sstevel@tonic-gate #include <sys/ddi.h> 337c478bd9Sstevel@tonic-gate #include <sys/sunddi.h> 347c478bd9Sstevel@tonic-gate #include <sys/stream.h> 357c478bd9Sstevel@tonic-gate 367c478bd9Sstevel@tonic-gate /* 377c478bd9Sstevel@tonic-gate * MAC Services Module 387c478bd9Sstevel@tonic-gate */ 397c478bd9Sstevel@tonic-gate 407c478bd9Sstevel@tonic-gate #ifdef __cplusplus 417c478bd9Sstevel@tonic-gate extern "C" { 427c478bd9Sstevel@tonic-gate #endif 437c478bd9Sstevel@tonic-gate 447c478bd9Sstevel@tonic-gate /* 457c478bd9Sstevel@tonic-gate * MAC Information (text emitted by modinfo(1m)) 467c478bd9Sstevel@tonic-gate */ 477c478bd9Sstevel@tonic-gate #define MAC_INFO "MAC Services v%I%" 487c478bd9Sstevel@tonic-gate 497c478bd9Sstevel@tonic-gate /* 50ba2e4443Sseb * MAC version identifier. This is used by mac_alloc() mac_register() to 51ba2e4443Sseb * verify that incompatible drivers don't register. 52ba2e4443Sseb */ 53ba2e4443Sseb #define MAC_VERSION 0x1 54ba2e4443Sseb 55ba2e4443Sseb /* 56ba2e4443Sseb * MAC-Type version identifier. This is used by mactype_alloc() and 57ba2e4443Sseb * mactype_register() to verify that incompatible MAC-Type plugins don't 58ba2e4443Sseb * register. 59ba2e4443Sseb */ 60ba2e4443Sseb #define MACTYPE_VERSION 0x1 61ba2e4443Sseb 62ba2e4443Sseb /* 637c478bd9Sstevel@tonic-gate * Statistics 647c478bd9Sstevel@tonic-gate */ 657c478bd9Sstevel@tonic-gate 667c478bd9Sstevel@tonic-gate #define XCVR_UNDEFINED 0 677c478bd9Sstevel@tonic-gate #define XCVR_NONE 1 687c478bd9Sstevel@tonic-gate #define XCVR_10 2 697c478bd9Sstevel@tonic-gate #define XCVR_100T4 3 707c478bd9Sstevel@tonic-gate #define XCVR_100X 4 717c478bd9Sstevel@tonic-gate #define XCVR_100T2 5 727c478bd9Sstevel@tonic-gate #define XCVR_1000X 6 737c478bd9Sstevel@tonic-gate #define XCVR_1000T 7 747c478bd9Sstevel@tonic-gate 757c478bd9Sstevel@tonic-gate typedef enum { 767c478bd9Sstevel@tonic-gate LINK_STATE_UNKNOWN = -1, 777c478bd9Sstevel@tonic-gate LINK_STATE_DOWN, 787c478bd9Sstevel@tonic-gate LINK_STATE_UP 797c478bd9Sstevel@tonic-gate } link_state_t; 807c478bd9Sstevel@tonic-gate 817c478bd9Sstevel@tonic-gate typedef enum { 827c478bd9Sstevel@tonic-gate LINK_DUPLEX_UNKNOWN = 0, 837c478bd9Sstevel@tonic-gate LINK_DUPLEX_HALF, 847c478bd9Sstevel@tonic-gate LINK_DUPLEX_FULL 857c478bd9Sstevel@tonic-gate } link_duplex_t; 867c478bd9Sstevel@tonic-gate 87*d62bc4baSyz147064 typedef uint32_t datalink_id_t; 88*d62bc4baSyz147064 #define DATALINK_INVALID_LINKID 0 89*d62bc4baSyz147064 #define DATALINK_ALL_LINKID 0 90*d62bc4baSyz147064 #define DATALINK_MAX_LINKID 0xffffffff 91*d62bc4baSyz147064 92843e1988Sjohnlev /* 93843e1988Sjohnlev * Maximum MAC address length 94843e1988Sjohnlev */ 95843e1988Sjohnlev #define MAXMACADDRLEN 20 96843e1988Sjohnlev 977c478bd9Sstevel@tonic-gate #ifdef _KERNEL 987c478bd9Sstevel@tonic-gate 99ba2e4443Sseb typedef struct mac_stat_info_s { 100ba2e4443Sseb uint_t msi_stat; 101ba2e4443Sseb char *msi_name; 102ba2e4443Sseb uint_t msi_type; /* as defined in kstat_named_init(9F) */ 103ba2e4443Sseb uint64_t msi_default; 104ba2e4443Sseb } mac_stat_info_t; 105ba2e4443Sseb 1067c478bd9Sstevel@tonic-gate /* 107ba2e4443Sseb * There are three ranges of statistics values. 0 to 1 - MAC_STAT_MIN are 108ba2e4443Sseb * interface statistics maintained by the mac module. MAC_STAT_MIN to 1 - 109ba2e4443Sseb * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and 110ba2e4443Sseb * maintained by each driver. MACTYPE_STAT_MIN and above are statistics 111ba2e4443Sseb * defined by MAC-Type plugins and maintained by each driver. 1127c478bd9Sstevel@tonic-gate */ 113ba2e4443Sseb #define MAC_STAT_MIN 1000 114ba2e4443Sseb #define MACTYPE_STAT_MIN 2000 115ba2e4443Sseb 116ba2e4443Sseb #define IS_MAC_STAT(stat) \ 117ba2e4443Sseb (stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN) 118ba2e4443Sseb #define IS_MACTYPE_STAT(stat) (stat >= MACTYPE_STAT_MIN) 119ba2e4443Sseb 1209b14cf1dSgd78059 /* 121*d62bc4baSyz147064 * Statistics maintained by the mac module, and possibly populated as link 122*d62bc4baSyz147064 * statistics. 123*d62bc4baSyz147064 */ 124*d62bc4baSyz147064 enum mac_mod_stat { 125*d62bc4baSyz147064 MAC_STAT_LINK_STATE, 126*d62bc4baSyz147064 MAC_STAT_LINK_UP, 127*d62bc4baSyz147064 MAC_STAT_PROMISC 128*d62bc4baSyz147064 }; 129*d62bc4baSyz147064 130*d62bc4baSyz147064 /* 1319b14cf1dSgd78059 * Do not reorder, and add only to the end of this list. 1329b14cf1dSgd78059 */ 133ba2e4443Sseb enum mac_driver_stat { 134ba2e4443Sseb /* MIB-II stats (RFC 1213 and RFC 1573) */ 135ba2e4443Sseb MAC_STAT_IFSPEED = MAC_STAT_MIN, 1367c478bd9Sstevel@tonic-gate MAC_STAT_MULTIRCV, 1377c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTRCV, 1387c478bd9Sstevel@tonic-gate MAC_STAT_MULTIXMT, 1397c478bd9Sstevel@tonic-gate MAC_STAT_BRDCSTXMT, 1407c478bd9Sstevel@tonic-gate MAC_STAT_NORCVBUF, 1417c478bd9Sstevel@tonic-gate MAC_STAT_IERRORS, 1427c478bd9Sstevel@tonic-gate MAC_STAT_UNKNOWNS, 1437c478bd9Sstevel@tonic-gate MAC_STAT_NOXMTBUF, 1447c478bd9Sstevel@tonic-gate MAC_STAT_OERRORS, 1457c478bd9Sstevel@tonic-gate MAC_STAT_COLLISIONS, 1467c478bd9Sstevel@tonic-gate MAC_STAT_RBYTES, 1477c478bd9Sstevel@tonic-gate MAC_STAT_IPACKETS, 1487c478bd9Sstevel@tonic-gate MAC_STAT_OBYTES, 1499b14cf1dSgd78059 MAC_STAT_OPACKETS, 1509b14cf1dSgd78059 MAC_STAT_UNDERFLOWS, 1519b14cf1dSgd78059 MAC_STAT_OVERFLOWS 1527c478bd9Sstevel@tonic-gate }; 1537c478bd9Sstevel@tonic-gate 1549b14cf1dSgd78059 #define MAC_NSTAT (MAC_STAT_OVERFLOWS - MAC_STAT_IFSPEED + 1) 155ba2e4443Sseb 156ba2e4443Sseb #define MAC_STAT_ISACOUNTER(_stat) ( \ 157ba2e4443Sseb (_stat) == MAC_STAT_MULTIRCV || \ 158ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTRCV || \ 159ba2e4443Sseb (_stat) == MAC_STAT_MULTIXMT || \ 160ba2e4443Sseb (_stat) == MAC_STAT_BRDCSTXMT || \ 161ba2e4443Sseb (_stat) == MAC_STAT_NORCVBUF || \ 162ba2e4443Sseb (_stat) == MAC_STAT_IERRORS || \ 163ba2e4443Sseb (_stat) == MAC_STAT_UNKNOWNS || \ 164ba2e4443Sseb (_stat) == MAC_STAT_NOXMTBUF || \ 165ba2e4443Sseb (_stat) == MAC_STAT_OERRORS || \ 166ba2e4443Sseb (_stat) == MAC_STAT_COLLISIONS || \ 167ba2e4443Sseb (_stat) == MAC_STAT_RBYTES || \ 168ba2e4443Sseb (_stat) == MAC_STAT_IPACKETS || \ 169ba2e4443Sseb (_stat) == MAC_STAT_OBYTES || \ 1709b14cf1dSgd78059 (_stat) == MAC_STAT_OPACKETS || \ 1719b14cf1dSgd78059 (_stat) == MAC_STAT_UNDERFLOWS || \ 1729b14cf1dSgd78059 (_stat) == MAC_STAT_OVERFLOWS) 173ba2e4443Sseb 1747c478bd9Sstevel@tonic-gate /* 1757c478bd9Sstevel@tonic-gate * Immutable information. (This may not be modified after registration). 1767c478bd9Sstevel@tonic-gate */ 1777c478bd9Sstevel@tonic-gate typedef struct mac_info_s { 1787c478bd9Sstevel@tonic-gate uint_t mi_media; 1790ba2cbe9Sxc151355 uint_t mi_nativemedia; 1807c478bd9Sstevel@tonic-gate uint_t mi_sdu_min; 1817c478bd9Sstevel@tonic-gate uint_t mi_sdu_max; 1827c478bd9Sstevel@tonic-gate uint_t mi_addr_length; 183ba2e4443Sseb uint8_t *mi_unicst_addr; 184ba2e4443Sseb uint8_t *mi_brdcst_addr; 1857c478bd9Sstevel@tonic-gate } mac_info_t; 1867c478bd9Sstevel@tonic-gate 1877c478bd9Sstevel@tonic-gate /* 1888347601bSyl150051 * LSO capability 1898347601bSyl150051 */ 1908347601bSyl150051 typedef struct lso_basic_tcp_ipv4_s { 1918347601bSyl150051 t_uscalar_t lso_max; /* maximum payload */ 1928347601bSyl150051 } lso_basic_tcp_ipv4_t; 1938347601bSyl150051 1948347601bSyl150051 /* 1958347601bSyl150051 * Future LSO capabilities can be added at the end of the mac_capab_lso_t. 1968347601bSyl150051 * When such capability is added to the GLDv3 framework, the size of the 1978347601bSyl150051 * mac_capab_lso_t it allocates and passes to the drivers increases. Older 1988347601bSyl150051 * drivers wil access only the (upper) sections of that structure, that is the 1998347601bSyl150051 * sections carrying the capabilities they understand. This ensures the 2008347601bSyl150051 * interface can be safely extended in a binary compatible way. 2018347601bSyl150051 */ 2028347601bSyl150051 typedef struct mac_capab_lso_s { 2038347601bSyl150051 t_uscalar_t lso_flags; 2048347601bSyl150051 lso_basic_tcp_ipv4_t lso_basic_tcp_ipv4; 2058347601bSyl150051 /* Add future lso capabilities here */ 2068347601bSyl150051 } mac_capab_lso_t; 2078347601bSyl150051 2088347601bSyl150051 /* 209*d62bc4baSyz147064 * Information for legacy devices. 210*d62bc4baSyz147064 */ 211*d62bc4baSyz147064 typedef struct mac_capab_legacy_s { 212*d62bc4baSyz147064 /* 213*d62bc4baSyz147064 * Notifications that the legacy device does not support. 214*d62bc4baSyz147064 */ 215*d62bc4baSyz147064 uint32_t ml_unsup_note; 216*d62bc4baSyz147064 /* 217*d62bc4baSyz147064 * dev_t of the legacy device; can be held to force attach. 218*d62bc4baSyz147064 */ 219*d62bc4baSyz147064 dev_t ml_dev; 220*d62bc4baSyz147064 } mac_capab_legacy_t; 221*d62bc4baSyz147064 222*d62bc4baSyz147064 /* 223ba2e4443Sseb * MAC layer capabilities. These capabilities are handled by the drivers' 224ba2e4443Sseb * mc_capab_get() callbacks. Some capabilities require the driver to fill 225ba2e4443Sseb * in a given data structure, and others are simply boolean capabilities. 226ba2e4443Sseb * Note that capability values must be powers of 2 so that consumers and 227ba2e4443Sseb * providers of this interface can keep track of which capabilities they 228ba2e4443Sseb * care about by keeping a bitfield of these things around somewhere. 2297c478bd9Sstevel@tonic-gate */ 230ba2e4443Sseb typedef enum { 231ba2e4443Sseb MAC_CAPAB_HCKSUM = 0x01, /* data is a uint32_t for the txflags */ 232ed8845d8Skrgopi MAC_CAPAB_POLL = 0x02, /* boolean only, no data */ 2338347601bSyl150051 MAC_CAPAB_MULTIADDRESS = 0x04, /* data is multiaddress_capab_t */ 234*d62bc4baSyz147064 MAC_CAPAB_LSO = 0x08, /* data is mac_capab_lso_t */ 235*d62bc4baSyz147064 MAC_CAPAB_NO_NATIVEVLAN = 0x10, /* boolean only, no data */ 236*d62bc4baSyz147064 MAC_CAPAB_NO_ZCOPY = 0x20, /* boolean only, no data */ 237ba2e4443Sseb /* add new capabilities here */ 238*d62bc4baSyz147064 239*d62bc4baSyz147064 /* The following capabilities are specific to softmac. */ 240*d62bc4baSyz147064 MAC_CAPAB_LEGACY = 0x8001, /* data is mac_capab_legacy_t */ 241ba2e4443Sseb } mac_capab_t; 2427c478bd9Sstevel@tonic-gate 243ed8845d8Skrgopi typedef int mac_addr_slot_t; 244ed8845d8Skrgopi 245ed8845d8Skrgopi /* mma_flags values */ 246ed8845d8Skrgopi #define MMAC_SLOT_USED 0x1 /* address slot used */ 247ed8845d8Skrgopi #define MMAC_SLOT_UNUSED 0x2 /* free address slot */ 248ed8845d8Skrgopi #define MMAC_VENDOR_ADDR 0x4 /* address returned is vendor supplied */ 249ed8845d8Skrgopi 250ed8845d8Skrgopi typedef struct mac_multi_address_s { 251ed8845d8Skrgopi mac_addr_slot_t mma_slot; /* slot for add/remove/get/set */ 252ed8845d8Skrgopi uint_t mma_addrlen; 253ed8845d8Skrgopi uint8_t mma_addr[MAXMACADDRLEN]; 254ed8845d8Skrgopi uint_t mma_flags; 255ed8845d8Skrgopi } mac_multi_addr_t; 256ed8845d8Skrgopi 257ed8845d8Skrgopi typedef int (*maddr_reserve_t)(void *, mac_multi_addr_t *); 258ed8845d8Skrgopi typedef int (*maddr_add_t)(void *, mac_multi_addr_t *); 259ed8845d8Skrgopi typedef int (*maddr_remove_t)(void *, mac_addr_slot_t); 260ed8845d8Skrgopi typedef int (*maddr_modify_t)(void *, mac_multi_addr_t *); 261ed8845d8Skrgopi typedef int (*maddr_get_t)(void *, mac_multi_addr_t *); 262ed8845d8Skrgopi 263ed8845d8Skrgopi /* maddr_flag values */ 264ed8845d8Skrgopi #define MADDR_VENDOR_ADDR 0x01 /* addr returned is vendor supplied */ 265ed8845d8Skrgopi 266ed8845d8Skrgopi /* multiple mac address: add/remove/set/get mac address */ 267ed8845d8Skrgopi typedef struct multiaddress_capab_s { 268ed8845d8Skrgopi int maddr_naddr; /* total addresses */ 269ed8845d8Skrgopi int maddr_naddrfree; /* free address slots */ 270ed8845d8Skrgopi uint_t maddr_flag; /* MADDR_VENDOR_ADDR bit can be set */ 271ed8845d8Skrgopi /* driver entry points */ 272ed8845d8Skrgopi void *maddr_handle; /* cookie to be used for the calls */ 273ed8845d8Skrgopi maddr_reserve_t maddr_reserve; /* reserve a factory address */ 274ed8845d8Skrgopi maddr_add_t maddr_add; /* add a new unicst address */ 275ed8845d8Skrgopi maddr_remove_t maddr_remove; /* remove an added address */ 276ed8845d8Skrgopi maddr_modify_t maddr_modify; /* modify an added address */ 277ed8845d8Skrgopi maddr_get_t maddr_get; /* get address from specified slot */ 278ed8845d8Skrgopi } multiaddress_capab_t; 279ed8845d8Skrgopi 2807c478bd9Sstevel@tonic-gate /* 2817c478bd9Sstevel@tonic-gate * MAC driver entry point types. 2827c478bd9Sstevel@tonic-gate */ 283ba2e4443Sseb typedef int (*mac_getstat_t)(void *, uint_t, uint64_t *); 2847c478bd9Sstevel@tonic-gate typedef int (*mac_start_t)(void *); 2857c478bd9Sstevel@tonic-gate typedef void (*mac_stop_t)(void *); 286ba2e4443Sseb typedef int (*mac_setpromisc_t)(void *, boolean_t); 2877c478bd9Sstevel@tonic-gate typedef int (*mac_multicst_t)(void *, boolean_t, const uint8_t *); 2887c478bd9Sstevel@tonic-gate typedef int (*mac_unicst_t)(void *, const uint8_t *); 2897c478bd9Sstevel@tonic-gate typedef void (*mac_ioctl_t)(void *, queue_t *, mblk_t *); 290ba2e4443Sseb typedef void (*mac_resources_t)(void *); 2917c478bd9Sstevel@tonic-gate typedef mblk_t *(*mac_tx_t)(void *, mblk_t *); 292ba2e4443Sseb typedef boolean_t (*mac_getcapab_t)(void *, mac_capab_t, void *); 293*d62bc4baSyz147064 typedef int (*mac_open_t)(void *); 294*d62bc4baSyz147064 typedef void (*mac_close_t)(void *); 2957c478bd9Sstevel@tonic-gate 2967c478bd9Sstevel@tonic-gate /* 297ba2e4443Sseb * Drivers must set all of these callbacks except for mc_resources, 298ba2e4443Sseb * mc_ioctl, and mc_getcapab, which are optional. If any of these optional 299ba2e4443Sseb * callbacks are set, their appropriate flags must be set in mc_callbacks. 300ba2e4443Sseb * Any future additions to this list must also be accompanied by an 301ba2e4443Sseb * associated mc_callbacks flag so that the framework can grow without 302ba2e4443Sseb * affecting the binary compatibility of the interface. 3037c478bd9Sstevel@tonic-gate */ 304ba2e4443Sseb typedef struct mac_callbacks_s { 305ba2e4443Sseb uint_t mc_callbacks; /* Denotes which callbacks are set */ 306ba2e4443Sseb mac_getstat_t mc_getstat; /* Get the value of a statistic */ 307ba2e4443Sseb mac_start_t mc_start; /* Start the device */ 308ba2e4443Sseb mac_stop_t mc_stop; /* Stop the device */ 309ba2e4443Sseb mac_setpromisc_t mc_setpromisc; /* Enable or disable promiscuous mode */ 310ba2e4443Sseb mac_multicst_t mc_multicst; /* Enable or disable a multicast addr */ 311ba2e4443Sseb mac_unicst_t mc_unicst; /* Set the unicast MAC address */ 312ba2e4443Sseb mac_tx_t mc_tx; /* Transmit a packet */ 313ba2e4443Sseb mac_resources_t mc_resources; /* Get the device resources */ 314ba2e4443Sseb mac_ioctl_t mc_ioctl; /* Process an unknown ioctl */ 315ba2e4443Sseb mac_getcapab_t mc_getcapab; /* Get capability information */ 316*d62bc4baSyz147064 mac_open_t mc_open; /* Open the device */ 317*d62bc4baSyz147064 mac_close_t mc_close; /* Close the device */ 318ba2e4443Sseb } mac_callbacks_t; 3197c478bd9Sstevel@tonic-gate 3207c478bd9Sstevel@tonic-gate /* 321ba2e4443Sseb * Flags for mc_callbacks. Requiring drivers to set the flags associated 322ba2e4443Sseb * with optional callbacks initialized in the structure allows the mac 323ba2e4443Sseb * module to add optional callbacks in the future without requiring drivers 324ba2e4443Sseb * to recompile. 3257c478bd9Sstevel@tonic-gate */ 326ba2e4443Sseb #define MC_RESOURCES 0x001 327ba2e4443Sseb #define MC_IOCTL 0x002 328ba2e4443Sseb #define MC_GETCAPAB 0x004 329*d62bc4baSyz147064 #define MC_OPEN 0x008 330*d62bc4baSyz147064 #define MC_CLOSE 0x010 331*d62bc4baSyz147064 332*d62bc4baSyz147064 #define MAC_MAX_MINOR 1000 3337c478bd9Sstevel@tonic-gate 334ba2e4443Sseb typedef struct mac_register_s { 335ba2e4443Sseb uint_t m_version; /* set by mac_alloc() */ 336ba2e4443Sseb const char *m_type_ident; 3377c478bd9Sstevel@tonic-gate void *m_driver; /* Driver private data */ 3387c478bd9Sstevel@tonic-gate dev_info_t *m_dip; 339ba2e4443Sseb uint_t m_instance; 340ba2e4443Sseb uint8_t *m_src_addr; 341ba2e4443Sseb uint8_t *m_dst_addr; 342ba2e4443Sseb mac_callbacks_t *m_callbacks; 343ba2e4443Sseb uint_t m_min_sdu; 344ba2e4443Sseb uint_t m_max_sdu; 345ba2e4443Sseb void *m_pdata; 346ba2e4443Sseb size_t m_pdata_size; 347*d62bc4baSyz147064 uint32_t m_margin; 348ba2e4443Sseb } mac_register_t; 3497c478bd9Sstevel@tonic-gate 3507c478bd9Sstevel@tonic-gate /* 3517c478bd9Sstevel@tonic-gate * Opaque handle types. 3527c478bd9Sstevel@tonic-gate */ 353ba2e4443Sseb typedef struct mac_t *mac_handle_t; 3547c478bd9Sstevel@tonic-gate typedef struct __mac_notify_handle *mac_notify_handle_t; 3557c478bd9Sstevel@tonic-gate typedef struct __mac_rx_handle *mac_rx_handle_t; 3567c478bd9Sstevel@tonic-gate typedef struct __mac_txloop_handle *mac_txloop_handle_t; 3577c478bd9Sstevel@tonic-gate typedef struct __mac_resource_handle *mac_resource_handle_t; 3587c478bd9Sstevel@tonic-gate 3597c478bd9Sstevel@tonic-gate /* 3607c478bd9Sstevel@tonic-gate * MAC interface callback types. 3617c478bd9Sstevel@tonic-gate */ 3627c478bd9Sstevel@tonic-gate typedef enum { 3637c478bd9Sstevel@tonic-gate MAC_NOTE_LINK, 3647c478bd9Sstevel@tonic-gate MAC_NOTE_PROMISC, 3657c478bd9Sstevel@tonic-gate MAC_NOTE_UNICST, 3667c478bd9Sstevel@tonic-gate MAC_NOTE_TX, 3677c478bd9Sstevel@tonic-gate MAC_NOTE_RESOURCE, 3687c478bd9Sstevel@tonic-gate MAC_NOTE_DEVPROMISC, 369ba2e4443Sseb MAC_NOTE_FASTPATH_FLUSH, 370843e1988Sjohnlev MAC_NOTE_VNIC, 371*d62bc4baSyz147064 MAC_NOTE_MARGIN, 3727c478bd9Sstevel@tonic-gate MAC_NNOTE /* must be the last entry */ 3737c478bd9Sstevel@tonic-gate } mac_notify_type_t; 3747c478bd9Sstevel@tonic-gate 3757c478bd9Sstevel@tonic-gate typedef void (*mac_notify_t)(void *, mac_notify_type_t); 3767c478bd9Sstevel@tonic-gate typedef void (*mac_rx_t)(void *, mac_resource_handle_t, mblk_t *); 3777c478bd9Sstevel@tonic-gate typedef void (*mac_txloop_t)(void *, mblk_t *); 3787c478bd9Sstevel@tonic-gate typedef void (*mac_blank_t)(void *, time_t, uint_t); 3797c478bd9Sstevel@tonic-gate 3807c478bd9Sstevel@tonic-gate /* 3817c478bd9Sstevel@tonic-gate * MAC promiscuous types 3827c478bd9Sstevel@tonic-gate */ 3837c478bd9Sstevel@tonic-gate typedef enum { 3847c478bd9Sstevel@tonic-gate MAC_PROMISC = 0x01, /* MAC instance is promiscuous */ 3857c478bd9Sstevel@tonic-gate MAC_DEVPROMISC = 0x02 /* Device is promiscuous */ 3867c478bd9Sstevel@tonic-gate } mac_promisc_type_t; 3877c478bd9Sstevel@tonic-gate 3887c478bd9Sstevel@tonic-gate /* 3897c478bd9Sstevel@tonic-gate * MAC resource types 3907c478bd9Sstevel@tonic-gate */ 3917c478bd9Sstevel@tonic-gate typedef enum { 3927c478bd9Sstevel@tonic-gate MAC_RX_FIFO = 1 3937c478bd9Sstevel@tonic-gate } mac_resource_type_t; 3947c478bd9Sstevel@tonic-gate 3957c478bd9Sstevel@tonic-gate typedef struct mac_rx_fifo_s { 3967c478bd9Sstevel@tonic-gate mac_resource_type_t mrf_type; /* MAC_RX_FIFO */ 3977c478bd9Sstevel@tonic-gate mac_blank_t mrf_blank; 3987c478bd9Sstevel@tonic-gate void *mrf_arg; 3997c478bd9Sstevel@tonic-gate time_t mrf_normal_blank_time; 4007c478bd9Sstevel@tonic-gate uint_t mrf_normal_pkt_count; 4017c478bd9Sstevel@tonic-gate } mac_rx_fifo_t; 4027c478bd9Sstevel@tonic-gate 40398b1442aSmeem typedef struct mac_txinfo_s { 40498b1442aSmeem mac_tx_t mt_fn; 40598b1442aSmeem void *mt_arg; 40698b1442aSmeem } mac_txinfo_t; 40798b1442aSmeem 4087c478bd9Sstevel@tonic-gate typedef union mac_resource_u { 4097c478bd9Sstevel@tonic-gate mac_resource_type_t mr_type; 4107c478bd9Sstevel@tonic-gate mac_rx_fifo_t mr_fifo; 4117c478bd9Sstevel@tonic-gate } mac_resource_t; 4127c478bd9Sstevel@tonic-gate 4137c478bd9Sstevel@tonic-gate typedef mac_resource_handle_t (*mac_resource_add_t)(void *, mac_resource_t *); 4147c478bd9Sstevel@tonic-gate 415ba2e4443Sseb typedef enum { 416ba2e4443Sseb MAC_ADDRTYPE_UNICAST, 417ba2e4443Sseb MAC_ADDRTYPE_MULTICAST, 418ba2e4443Sseb MAC_ADDRTYPE_BROADCAST 419ba2e4443Sseb } mac_addrtype_t; 420ba2e4443Sseb 421ba2e4443Sseb typedef struct mac_header_info_s { 422ba2e4443Sseb size_t mhi_hdrsize; 423ba2e4443Sseb size_t mhi_pktsize; 424ba2e4443Sseb const uint8_t *mhi_daddr; 425ba2e4443Sseb const uint8_t *mhi_saddr; 426ba2e4443Sseb uint32_t mhi_origsap; 427ba2e4443Sseb uint32_t mhi_bindsap; 428ba2e4443Sseb mac_addrtype_t mhi_dsttype; 429605445d5Sdg199075 uint16_t mhi_tci; 430*d62bc4baSyz147064 uint_t mhi_istagged:1, 431*d62bc4baSyz147064 mhi_prom_looped:1; 432ba2e4443Sseb } mac_header_info_t; 433ba2e4443Sseb 434ba2e4443Sseb /* 435ba2e4443Sseb * MAC-Type plugin interfaces 436ba2e4443Sseb */ 437ba2e4443Sseb 438ba2e4443Sseb typedef int (*mtops_addr_verify_t)(const void *, void *); 439ba2e4443Sseb typedef boolean_t (*mtops_sap_verify_t)(uint32_t, uint32_t *, void *); 440ba2e4443Sseb typedef mblk_t *(*mtops_header_t)(const void *, const void *, 441ba2e4443Sseb uint32_t, void *, mblk_t *, size_t); 442ba2e4443Sseb typedef int (*mtops_header_info_t)(mblk_t *, void *, 443ba2e4443Sseb mac_header_info_t *); 444ba2e4443Sseb typedef boolean_t (*mtops_pdata_verify_t)(void *, size_t); 445ba2e4443Sseb typedef mblk_t *(*mtops_header_modify_t)(mblk_t *, void *); 4460d2a8e5eSgd78059 typedef void (*mtops_link_details_t)(char *, size_t, mac_handle_t, 4470d2a8e5eSgd78059 void *); 448ba2e4443Sseb 449ba2e4443Sseb typedef struct mactype_ops_s { 450ba2e4443Sseb uint_t mtops_ops; 451ba2e4443Sseb /* 452ba2e4443Sseb * mtops_unicst_verify() returns 0 if the given address is a valid 453ba2e4443Sseb * unicast address, or a non-zero errno otherwise. 454ba2e4443Sseb */ 455ba2e4443Sseb mtops_addr_verify_t mtops_unicst_verify; 456ba2e4443Sseb /* 457ba2e4443Sseb * mtops_multicst_verify() returns 0 if the given address is a 458ba2e4443Sseb * valid multicast address, or a non-zero errno otherwise. If the 459ba2e4443Sseb * media doesn't support multicast, ENOTSUP should be returned (for 460ba2e4443Sseb * example). 461ba2e4443Sseb */ 462ba2e4443Sseb mtops_addr_verify_t mtops_multicst_verify; 463ba2e4443Sseb /* 464ba2e4443Sseb * mtops_sap_verify() returns B_TRUE if the given SAP is a valid 465ba2e4443Sseb * SAP value, or B_FALSE otherwise. 466ba2e4443Sseb */ 467ba2e4443Sseb mtops_sap_verify_t mtops_sap_verify; 468ba2e4443Sseb /* 469ba2e4443Sseb * mtops_header() is used to allocate and construct a MAC header. 470ba2e4443Sseb */ 471ba2e4443Sseb mtops_header_t mtops_header; 472ba2e4443Sseb /* 473ba2e4443Sseb * mtops_header_info() is used to gather information on a given MAC 474ba2e4443Sseb * header. 475ba2e4443Sseb */ 476ba2e4443Sseb mtops_header_info_t mtops_header_info; 477ba2e4443Sseb /* 478ba2e4443Sseb * mtops_pdata_verify() is used to verify the validity of MAC 479ba2e4443Sseb * plugin data. It is called by mac_register() if the driver has 480ba2e4443Sseb * supplied MAC plugin data, and also by mac_pdata_update() when 481ba2e4443Sseb * drivers update the data. 482ba2e4443Sseb */ 483ba2e4443Sseb mtops_pdata_verify_t mtops_pdata_verify; 484ba2e4443Sseb /* 485ba2e4443Sseb * mtops_header_cook() is an optional callback that converts (or 486ba2e4443Sseb * "cooks") the given raw header (as sent by a raw DLPI consumer) 487ba2e4443Sseb * into one that is appropriate to send down to the MAC driver. 488ba2e4443Sseb * Following the example above, an Ethernet header sent down by a 489ba2e4443Sseb * DLPI consumer would be converted to whatever header the MAC 490ba2e4443Sseb * driver expects. 491ba2e4443Sseb */ 492ba2e4443Sseb mtops_header_modify_t mtops_header_cook; 493ba2e4443Sseb /* 494ba2e4443Sseb * mtops_header_uncook() is an optional callback that does the 495ba2e4443Sseb * opposite of mtops_header_cook(). It "uncooks" a given MAC 496ba2e4443Sseb * header (as received from the driver) for consumption by raw DLPI 497ba2e4443Sseb * consumers. For example, for a non-Ethernet plugin that wants 498ba2e4443Sseb * raw DLPI consumers to be fooled into thinking that the device 499ba2e4443Sseb * provides Ethernet access, this callback would modify the given 500ba2e4443Sseb * mblk_t such that the MAC header is converted to an Ethernet 501ba2e4443Sseb * header. 502ba2e4443Sseb */ 503ba2e4443Sseb mtops_header_modify_t mtops_header_uncook; 5040d2a8e5eSgd78059 /* 5050d2a8e5eSgd78059 * mtops_link_details() is an optional callback that provides 5060d2a8e5eSgd78059 * extended information about the link state. Its primary purpose 5070d2a8e5eSgd78059 * is to provide type-specific support for syslog contents on 5080d2a8e5eSgd78059 * link up events. If no implementation is provided, then a default 5090d2a8e5eSgd78059 * implementation will be used. 5100d2a8e5eSgd78059 */ 5110d2a8e5eSgd78059 mtops_link_details_t mtops_link_details; 512ba2e4443Sseb } mactype_ops_t; 513ba2e4443Sseb 514ba2e4443Sseb /* 515ba2e4443Sseb * mtops_ops exists for the plugin to enumerate the optional callback 516ba2e4443Sseb * entrypoints it has defined. This allows the mac module to define 517ba2e4443Sseb * additional plugin entrypoints in mactype_ops_t without breaking backward 518ba2e4443Sseb * compatibility with old plugins. 519ba2e4443Sseb */ 520ba2e4443Sseb #define MTOPS_PDATA_VERIFY 0x001 521ba2e4443Sseb #define MTOPS_HEADER_COOK 0x002 522ba2e4443Sseb #define MTOPS_HEADER_UNCOOK 0x004 5230d2a8e5eSgd78059 #define MTOPS_LINK_DETAILS 0x008 524ba2e4443Sseb 525ba2e4443Sseb typedef struct mactype_register_s { 526ba2e4443Sseb uint_t mtr_version; /* set by mactype_alloc() */ 527ba2e4443Sseb const char *mtr_ident; 528ba2e4443Sseb mactype_ops_t *mtr_ops; 529ba2e4443Sseb uint_t mtr_mactype; 5300ba2cbe9Sxc151355 uint_t mtr_nativetype; 531ba2e4443Sseb uint_t mtr_addrlen; 532ba2e4443Sseb uint8_t *mtr_brdcst_addr; 533ba2e4443Sseb mac_stat_info_t *mtr_stats; 534ba2e4443Sseb size_t mtr_statcount; 535ba2e4443Sseb } mactype_register_t; 536ba2e4443Sseb 5377c478bd9Sstevel@tonic-gate /* 5387c478bd9Sstevel@tonic-gate * Client interface functions. 5397c478bd9Sstevel@tonic-gate */ 540a08fa175Syz147064 extern int mac_open(const char *, mac_handle_t *); 541*d62bc4baSyz147064 extern int mac_open_by_linkid(datalink_id_t, 542*d62bc4baSyz147064 mac_handle_t *); 543*d62bc4baSyz147064 extern int mac_open_by_linkname(const char *, 544*d62bc4baSyz147064 mac_handle_t *); 5457c478bd9Sstevel@tonic-gate extern void mac_close(mac_handle_t); 5467c478bd9Sstevel@tonic-gate extern const mac_info_t *mac_info(mac_handle_t); 547210db224Sericheng extern boolean_t mac_info_get(const char *, mac_info_t *); 548ba2e4443Sseb extern uint64_t mac_stat_get(mac_handle_t, uint_t); 5497c478bd9Sstevel@tonic-gate extern int mac_start(mac_handle_t); 5507c478bd9Sstevel@tonic-gate extern void mac_stop(mac_handle_t); 5517c478bd9Sstevel@tonic-gate extern int mac_promisc_set(mac_handle_t, boolean_t, 5527c478bd9Sstevel@tonic-gate mac_promisc_type_t); 5537c478bd9Sstevel@tonic-gate extern boolean_t mac_promisc_get(mac_handle_t, 5547c478bd9Sstevel@tonic-gate mac_promisc_type_t); 5557c478bd9Sstevel@tonic-gate extern int mac_multicst_add(mac_handle_t, const uint8_t *); 5567c478bd9Sstevel@tonic-gate extern int mac_multicst_remove(mac_handle_t, 5577c478bd9Sstevel@tonic-gate const uint8_t *); 558ed8845d8Skrgopi extern boolean_t mac_unicst_verify(mac_handle_t, 559ed8845d8Skrgopi const uint8_t *, uint_t); 5607c478bd9Sstevel@tonic-gate extern int mac_unicst_set(mac_handle_t, const uint8_t *); 5617c478bd9Sstevel@tonic-gate extern void mac_unicst_get(mac_handle_t, uint8_t *); 562ba2e4443Sseb extern void mac_dest_get(mac_handle_t, uint8_t *); 5637c478bd9Sstevel@tonic-gate extern void mac_resources(mac_handle_t); 5647c478bd9Sstevel@tonic-gate extern void mac_ioctl(mac_handle_t, queue_t *, mblk_t *); 56598b1442aSmeem extern const mac_txinfo_t *mac_tx_get(mac_handle_t); 566843e1988Sjohnlev extern const mac_txinfo_t *mac_vnic_tx_get(mac_handle_t); 5677c478bd9Sstevel@tonic-gate extern link_state_t mac_link_get(mac_handle_t); 5687c478bd9Sstevel@tonic-gate extern mac_notify_handle_t mac_notify_add(mac_handle_t, mac_notify_t, 5697c478bd9Sstevel@tonic-gate void *); 5707c478bd9Sstevel@tonic-gate extern void mac_notify_remove(mac_handle_t, 5717c478bd9Sstevel@tonic-gate mac_notify_handle_t); 5727c478bd9Sstevel@tonic-gate extern void mac_notify(mac_handle_t); 5737c478bd9Sstevel@tonic-gate extern mac_rx_handle_t mac_rx_add(mac_handle_t, mac_rx_t, void *); 574843e1988Sjohnlev extern mac_rx_handle_t mac_active_rx_add(mac_handle_t, mac_rx_t, 575843e1988Sjohnlev void *); 5761f8aaf0dSethindra extern void mac_rx_remove(mac_handle_t, mac_rx_handle_t, 5771f8aaf0dSethindra boolean_t); 5781f8aaf0dSethindra extern void mac_rx_remove_wait(mac_handle_t); 5797c478bd9Sstevel@tonic-gate extern mblk_t *mac_txloop(void *, mblk_t *); 5807c478bd9Sstevel@tonic-gate extern mac_txloop_handle_t mac_txloop_add(mac_handle_t, mac_txloop_t, 5817c478bd9Sstevel@tonic-gate void *); 5827c478bd9Sstevel@tonic-gate extern void mac_txloop_remove(mac_handle_t, 5837c478bd9Sstevel@tonic-gate mac_txloop_handle_t); 5847c478bd9Sstevel@tonic-gate extern boolean_t mac_active_set(mac_handle_t); 585843e1988Sjohnlev extern boolean_t mac_active_shareable_set(mac_handle_t); 5867c478bd9Sstevel@tonic-gate extern void mac_active_clear(mac_handle_t); 587843e1988Sjohnlev extern void mac_active_rx(void *, mac_resource_handle_t, 588843e1988Sjohnlev mblk_t *); 589843e1988Sjohnlev extern boolean_t mac_vnic_set(mac_handle_t, mac_txinfo_t *, 590843e1988Sjohnlev mac_getcapab_t, void *); 591843e1988Sjohnlev extern void mac_vnic_clear(mac_handle_t); 5927c478bd9Sstevel@tonic-gate extern void mac_resource_set(mac_handle_t, 5937c478bd9Sstevel@tonic-gate mac_resource_add_t, void *); 594210db224Sericheng extern dev_info_t *mac_devinfo_get(mac_handle_t); 595*d62bc4baSyz147064 extern const char *mac_name(mac_handle_t); 596*d62bc4baSyz147064 extern minor_t mac_minor(mac_handle_t); 597ba2e4443Sseb extern boolean_t mac_capab_get(mac_handle_t, mac_capab_t, 598ba2e4443Sseb void *); 599843e1988Sjohnlev extern boolean_t mac_vnic_capab_get(mac_handle_t, mac_capab_t, 600843e1988Sjohnlev void *); 601ba2e4443Sseb extern boolean_t mac_sap_verify(mac_handle_t, uint32_t, 602ba2e4443Sseb uint32_t *); 603ba2e4443Sseb extern mblk_t *mac_header(mac_handle_t, const uint8_t *, 604ba2e4443Sseb uint32_t, mblk_t *, size_t); 605ba2e4443Sseb extern int mac_header_info(mac_handle_t, mblk_t *, 606ba2e4443Sseb mac_header_info_t *); 607ba2e4443Sseb extern mblk_t *mac_header_cook(mac_handle_t, mblk_t *); 608ba2e4443Sseb extern mblk_t *mac_header_uncook(mac_handle_t, mblk_t *); 609*d62bc4baSyz147064 extern minor_t mac_minor_hold(boolean_t); 610*d62bc4baSyz147064 extern void mac_minor_rele(minor_t); 6117c478bd9Sstevel@tonic-gate 6127c478bd9Sstevel@tonic-gate /* 6137c478bd9Sstevel@tonic-gate * Driver interface functions. 6147c478bd9Sstevel@tonic-gate */ 615ba2e4443Sseb extern mac_register_t *mac_alloc(uint_t); 616ba2e4443Sseb extern void mac_free(mac_register_t *); 617ba2e4443Sseb extern int mac_register(mac_register_t *, mac_handle_t *); 618843e1988Sjohnlev extern int mac_disable(mac_handle_t); 619ba2e4443Sseb extern int mac_unregister(mac_handle_t); 620ba2e4443Sseb extern void mac_rx(mac_handle_t, mac_resource_handle_t, 6217c478bd9Sstevel@tonic-gate mblk_t *); 622ba2e4443Sseb extern void mac_link_update(mac_handle_t, link_state_t); 623ba2e4443Sseb extern void mac_unicst_update(mac_handle_t, 624ba2e4443Sseb const uint8_t *); 625ba2e4443Sseb extern void mac_tx_update(mac_handle_t); 626ba2e4443Sseb extern void mac_resource_update(mac_handle_t); 627ba2e4443Sseb extern mac_resource_handle_t mac_resource_add(mac_handle_t, 628ba2e4443Sseb mac_resource_t *); 629ba2e4443Sseb extern int mac_pdata_update(mac_handle_t, void *, 630ba2e4443Sseb size_t); 631ba2e4443Sseb extern void mac_multicst_refresh(mac_handle_t, 632ba2e4443Sseb mac_multicst_t, void *, boolean_t); 633ba2e4443Sseb extern void mac_unicst_refresh(mac_handle_t, mac_unicst_t, 6347c478bd9Sstevel@tonic-gate void *); 635ba2e4443Sseb extern void mac_promisc_refresh(mac_handle_t, 636ba2e4443Sseb mac_setpromisc_t, void *); 637*d62bc4baSyz147064 extern boolean_t mac_margin_update(mac_handle_t, uint32_t); 638*d62bc4baSyz147064 extern void mac_margin_get(mac_handle_t, uint32_t *); 639*d62bc4baSyz147064 extern int mac_margin_remove(mac_handle_t, uint32_t); 640*d62bc4baSyz147064 extern int mac_margin_add(mac_handle_t, uint32_t *, 641*d62bc4baSyz147064 boolean_t); 642210db224Sericheng extern void mac_init_ops(struct dev_ops *, const char *); 643210db224Sericheng extern void mac_fini_ops(struct dev_ops *); 644*d62bc4baSyz147064 extern uint32_t mac_no_notification(mac_handle_t); 645*d62bc4baSyz147064 extern boolean_t mac_is_legacy(mac_handle_t); 646*d62bc4baSyz147064 extern int mac_hold_exclusive(mac_handle_t); 647*d62bc4baSyz147064 extern void mac_rele_exclusive(mac_handle_t); 648*d62bc4baSyz147064 649ba2e4443Sseb extern mactype_register_t *mactype_alloc(uint_t); 650ba2e4443Sseb extern void mactype_free(mactype_register_t *); 651ba2e4443Sseb extern int mactype_register(mactype_register_t *); 652ba2e4443Sseb extern int mactype_unregister(const char *); 6537c478bd9Sstevel@tonic-gate 6547c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 6557c478bd9Sstevel@tonic-gate 6567c478bd9Sstevel@tonic-gate #ifdef __cplusplus 6577c478bd9Sstevel@tonic-gate } 6587c478bd9Sstevel@tonic-gate #endif 6597c478bd9Sstevel@tonic-gate 6607c478bd9Sstevel@tonic-gate #endif /* _SYS_MAC_H */ 661