1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_MAC_H 27 #define _SYS_MAC_H 28 29 #include <sys/types.h> 30 #include <sys/ddi.h> 31 #include <sys/sunddi.h> 32 #include <sys/stream.h> 33 34 /* 35 * MAC Services Module 36 */ 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * MAC Information (text emitted by modinfo(1m)) 44 */ 45 #define MAC_INFO "MAC Services" 46 47 /* 48 * MAC version identifier. This is used by mac_alloc() mac_register() to 49 * verify that incompatible drivers don't register. 50 */ 51 #define MAC_VERSION 0x1 52 53 /* 54 * MAC-Type version identifier. This is used by mactype_alloc() and 55 * mactype_register() to verify that incompatible MAC-Type plugins don't 56 * register. 57 */ 58 #define MACTYPE_VERSION 0x1 59 60 /* 61 * Statistics 62 */ 63 64 #define XCVR_UNDEFINED 0 65 #define XCVR_NONE 1 66 #define XCVR_10 2 67 #define XCVR_100T4 3 68 #define XCVR_100X 4 69 #define XCVR_100T2 5 70 #define XCVR_1000X 6 71 #define XCVR_1000T 7 72 73 typedef enum { 74 LINK_STATE_UNKNOWN = -1, 75 LINK_STATE_DOWN, 76 LINK_STATE_UP 77 } link_state_t; 78 79 typedef enum { 80 LINK_DUPLEX_UNKNOWN = 0, 81 LINK_DUPLEX_HALF, 82 LINK_DUPLEX_FULL 83 } link_duplex_t; 84 85 #define DATALINK_INVALID_LINKID 0 86 #define DATALINK_ALL_LINKID 0 87 #define DATALINK_MAX_LINKID 0xffffffff 88 89 typedef enum { 90 LINK_FLOWCTRL_NONE = 0, 91 LINK_FLOWCTRL_RX, 92 LINK_FLOWCTRL_TX, 93 LINK_FLOWCTRL_BI 94 } link_flowctrl_t; 95 96 typedef uint32_t datalink_id_t; 97 98 /* 99 * Encodings for public properties. 100 * A most significant bit value of 1 indicates private property, intended 101 * to allow private property implementations to use internal encodings 102 * if desired. 103 * 104 * Note that there are 2 sets of parameters: the *_EN_* 105 * values are those that the Administrator configures for autonegotiation. 106 * The _ADV_* values are those that are currently exposed over the wire. 107 */ 108 #define MAXLINKPROPNAME 256 109 #define MAC_PROP_DEFAULT 0x0001 110 typedef enum { 111 MAC_PROP_DUPLEX = 0x00000001, 112 MAC_PROP_SPEED, 113 MAC_PROP_STATUS, 114 MAC_PROP_AUTONEG, 115 MAC_PROP_EN_AUTONEG, 116 MAC_PROP_MTU, 117 MAC_PROP_ZONE, 118 MAC_PROP_AUTOPUSH, 119 MAC_PROP_FLOWCTRL, 120 MAC_PROP_ADV_1000FDX_CAP, 121 MAC_PROP_EN_1000FDX_CAP, 122 MAC_PROP_ADV_1000HDX_CAP, 123 MAC_PROP_EN_1000HDX_CAP, 124 MAC_PROP_ADV_100FDX_CAP, 125 MAC_PROP_EN_100FDX_CAP, 126 MAC_PROP_ADV_100HDX_CAP, 127 MAC_PROP_EN_100HDX_CAP, 128 MAC_PROP_ADV_10FDX_CAP, 129 MAC_PROP_EN_10FDX_CAP, 130 MAC_PROP_ADV_10HDX_CAP, 131 MAC_PROP_EN_10HDX_CAP, 132 MAC_PROP_ADV_100T4_CAP, 133 MAC_PROP_EN_100T4_CAP, 134 MAC_PROP_WL_ESSID, 135 MAC_PROP_WL_BSSID, 136 MAC_PROP_WL_BSSTYPE, 137 MAC_PROP_WL_LINKSTATUS, 138 MAC_PROP_WL_DESIRED_RATES, 139 MAC_PROP_WL_SUPPORTED_RATES, 140 MAC_PROP_WL_AUTH_MODE, 141 MAC_PROP_WL_ENCRYPTION, 142 MAC_PROP_WL_RSSI, 143 MAC_PROP_WL_PHY_CONFIG, 144 MAC_PROP_WL_CAPABILITY, 145 MAC_PROP_WL_WPA, 146 MAC_PROP_WL_SCANRESULTS, 147 MAC_PROP_WL_POWER_MODE, 148 MAC_PROP_WL_RADIO, 149 MAC_PROP_WL_ESS_LIST, 150 MAC_PROP_WL_KEY_TAB, 151 MAC_PROP_WL_CREATE_IBSS, 152 MAC_PROP_WL_SETOPTIE, 153 MAC_PROP_WL_DELKEY, 154 MAC_PROP_WL_KEY, 155 MAC_PROP_WL_MLME, 156 MAC_PROP_PRIVATE = -1 157 } mac_prop_id_t; 158 159 /* 160 * Maximum MAC address length 161 */ 162 #define MAXMACADDRLEN 20 163 164 /* 165 * Flags to figure out r/w status of legacy ndd props. 166 */ 167 #define MAC_PROP_PERM_READ 0x0001 168 #define MAC_PROP_PERM_WRITE 0x0010 169 #define MAC_PROP_MAP_KSTAT 0x0100 170 #define MAC_PROP_PERM_RW (MAC_PROP_PERM_READ|MAC_PROP_PERM_WRITE) 171 #define MAC_PROP_FLAGS_RK (MAC_PROP_PERM_READ|MAC_PROP_MAP_KSTAT) 172 173 #ifdef _KERNEL 174 175 typedef struct mac_stat_info_s { 176 uint_t msi_stat; 177 char *msi_name; 178 uint_t msi_type; /* as defined in kstat_named_init(9F) */ 179 uint64_t msi_default; 180 } mac_stat_info_t; 181 182 /* 183 * There are three ranges of statistics values. 0 to 1 - MAC_STAT_MIN are 184 * interface statistics maintained by the mac module. MAC_STAT_MIN to 1 - 185 * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and 186 * maintained by each driver. MACTYPE_STAT_MIN and above are statistics 187 * defined by MAC-Type plugins and maintained by each driver. 188 */ 189 #define MAC_STAT_MIN 1000 190 #define MACTYPE_STAT_MIN 2000 191 192 #define IS_MAC_STAT(stat) \ 193 (stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN) 194 #define IS_MACTYPE_STAT(stat) (stat >= MACTYPE_STAT_MIN) 195 196 /* 197 * Statistics maintained by the mac module, and possibly populated as link 198 * statistics. 199 */ 200 enum mac_mod_stat { 201 MAC_STAT_LINK_STATE, 202 MAC_STAT_LINK_UP, 203 MAC_STAT_PROMISC 204 }; 205 206 /* 207 * Do not reorder, and add only to the end of this list. 208 */ 209 enum mac_driver_stat { 210 /* MIB-II stats (RFC 1213 and RFC 1573) */ 211 MAC_STAT_IFSPEED = MAC_STAT_MIN, 212 MAC_STAT_MULTIRCV, 213 MAC_STAT_BRDCSTRCV, 214 MAC_STAT_MULTIXMT, 215 MAC_STAT_BRDCSTXMT, 216 MAC_STAT_NORCVBUF, 217 MAC_STAT_IERRORS, 218 MAC_STAT_UNKNOWNS, 219 MAC_STAT_NOXMTBUF, 220 MAC_STAT_OERRORS, 221 MAC_STAT_COLLISIONS, 222 MAC_STAT_RBYTES, 223 MAC_STAT_IPACKETS, 224 MAC_STAT_OBYTES, 225 MAC_STAT_OPACKETS, 226 MAC_STAT_UNDERFLOWS, 227 MAC_STAT_OVERFLOWS 228 }; 229 230 #define MAC_NSTAT (MAC_STAT_OVERFLOWS - MAC_STAT_IFSPEED + 1) 231 232 #define MAC_STAT_ISACOUNTER(_stat) ( \ 233 (_stat) == MAC_STAT_MULTIRCV || \ 234 (_stat) == MAC_STAT_BRDCSTRCV || \ 235 (_stat) == MAC_STAT_MULTIXMT || \ 236 (_stat) == MAC_STAT_BRDCSTXMT || \ 237 (_stat) == MAC_STAT_NORCVBUF || \ 238 (_stat) == MAC_STAT_IERRORS || \ 239 (_stat) == MAC_STAT_UNKNOWNS || \ 240 (_stat) == MAC_STAT_NOXMTBUF || \ 241 (_stat) == MAC_STAT_OERRORS || \ 242 (_stat) == MAC_STAT_COLLISIONS || \ 243 (_stat) == MAC_STAT_RBYTES || \ 244 (_stat) == MAC_STAT_IPACKETS || \ 245 (_stat) == MAC_STAT_OBYTES || \ 246 (_stat) == MAC_STAT_OPACKETS || \ 247 (_stat) == MAC_STAT_UNDERFLOWS || \ 248 (_stat) == MAC_STAT_OVERFLOWS) 249 250 /* 251 * Immutable information. (This may not be modified after registration). 252 */ 253 typedef struct mac_info_s { 254 uint_t mi_media; 255 uint_t mi_nativemedia; 256 uint_t mi_addr_length; 257 uint8_t *mi_unicst_addr; 258 uint8_t *mi_brdcst_addr; 259 } mac_info_t; 260 261 /* 262 * LSO capability 263 */ 264 typedef struct lso_basic_tcp_ipv4_s { 265 t_uscalar_t lso_max; /* maximum payload */ 266 } lso_basic_tcp_ipv4_t; 267 268 /* 269 * Future LSO capabilities can be added at the end of the mac_capab_lso_t. 270 * When such capability is added to the GLDv3 framework, the size of the 271 * mac_capab_lso_t it allocates and passes to the drivers increases. Older 272 * drivers wil access only the (upper) sections of that structure, that is the 273 * sections carrying the capabilities they understand. This ensures the 274 * interface can be safely extended in a binary compatible way. 275 */ 276 typedef struct mac_capab_lso_s { 277 t_uscalar_t lso_flags; 278 lso_basic_tcp_ipv4_t lso_basic_tcp_ipv4; 279 /* Add future lso capabilities here */ 280 } mac_capab_lso_t; 281 282 /* 283 * Information for legacy devices. 284 */ 285 typedef struct mac_capab_legacy_s { 286 /* 287 * Notifications that the legacy device does not support. 288 */ 289 uint32_t ml_unsup_note; 290 /* 291 * dev_t of the legacy device; can be held to force attach. 292 */ 293 dev_t ml_dev; 294 } mac_capab_legacy_t; 295 296 /* 297 * MAC layer capabilities. These capabilities are handled by the drivers' 298 * mc_capab_get() callbacks. Some capabilities require the driver to fill 299 * in a given data structure, and others are simply boolean capabilities. 300 * Note that capability values must be powers of 2 so that consumers and 301 * providers of this interface can keep track of which capabilities they 302 * care about by keeping a bitfield of these things around somewhere. 303 */ 304 typedef enum { 305 MAC_CAPAB_HCKSUM = 0x01, /* data is a uint32_t for the txflags */ 306 MAC_CAPAB_POLL = 0x02, /* boolean only, no data */ 307 MAC_CAPAB_MULTIADDRESS = 0x04, /* data is multiaddress_capab_t */ 308 MAC_CAPAB_LSO = 0x08, /* data is mac_capab_lso_t */ 309 MAC_CAPAB_NO_NATIVEVLAN = 0x10, /* boolean only, no data */ 310 MAC_CAPAB_NO_ZCOPY = 0x20, /* boolean only, no data */ 311 /* add new capabilities here */ 312 MAC_CAPAB_RINGS = 0x100, /* data is mac_capab_rings_t */ 313 MAC_CAPAB_SHARES = 0x200, /* data is mac_capab_share_t */ 314 315 /* The following capabilities are specific to softmac. */ 316 MAC_CAPAB_LEGACY = 0x8000 /* data is mac_capab_legacy_t */ 317 } mac_capab_t; 318 319 typedef int mac_addr_slot_t; 320 321 /* mma_flags values */ 322 #define MMAC_SLOT_USED 0x1 /* address slot used */ 323 #define MMAC_SLOT_UNUSED 0x2 /* free address slot */ 324 #define MMAC_VENDOR_ADDR 0x4 /* address returned is vendor supplied */ 325 326 typedef struct mac_multi_address_s { 327 mac_addr_slot_t mma_slot; /* slot for add/remove/get/set */ 328 uint_t mma_addrlen; 329 uint8_t mma_addr[MAXMACADDRLEN]; 330 uint_t mma_flags; 331 } mac_multi_addr_t; 332 333 typedef int (*maddr_reserve_t)(void *, mac_multi_addr_t *); 334 typedef int (*maddr_add_t)(void *, mac_multi_addr_t *); 335 typedef int (*maddr_remove_t)(void *, mac_addr_slot_t); 336 typedef int (*maddr_modify_t)(void *, mac_multi_addr_t *); 337 typedef int (*maddr_get_t)(void *, mac_multi_addr_t *); 338 339 /* maddr_flag values */ 340 #define MADDR_VENDOR_ADDR 0x01 /* addr returned is vendor supplied */ 341 342 /* multiple mac address: add/remove/set/get mac address */ 343 typedef struct multiaddress_capab_s { 344 int maddr_naddr; /* total addresses */ 345 int maddr_naddrfree; /* free address slots */ 346 uint_t maddr_flag; /* MADDR_VENDOR_ADDR bit can be set */ 347 /* driver entry points */ 348 void *maddr_handle; /* cookie to be used for the calls */ 349 maddr_reserve_t maddr_reserve; /* reserve a factory address */ 350 maddr_add_t maddr_add; /* add a new unicst address */ 351 maddr_remove_t maddr_remove; /* remove an added address */ 352 maddr_modify_t maddr_modify; /* modify an added address */ 353 maddr_get_t maddr_get; /* get address from specified slot */ 354 } multiaddress_capab_t; 355 356 /* 357 * MAC driver entry point types. 358 */ 359 typedef int (*mac_getstat_t)(void *, uint_t, uint64_t *); 360 typedef int (*mac_start_t)(void *); 361 typedef void (*mac_stop_t)(void *); 362 typedef int (*mac_setpromisc_t)(void *, boolean_t); 363 typedef int (*mac_multicst_t)(void *, boolean_t, const uint8_t *); 364 typedef int (*mac_unicst_t)(void *, const uint8_t *); 365 typedef void (*mac_ioctl_t)(void *, queue_t *, mblk_t *); 366 typedef void (*mac_resources_t)(void *); 367 typedef mblk_t *(*mac_tx_t)(void *, mblk_t *); 368 typedef boolean_t (*mac_getcapab_t)(void *, mac_capab_t, void *); 369 typedef int (*mac_open_t)(void *); 370 typedef void (*mac_close_t)(void *); 371 typedef int (*mac_set_prop_t)(void *, const char *, mac_prop_id_t, 372 uint_t, const void *); 373 typedef int (*mac_get_prop_t)(void *, const char *, mac_prop_id_t, 374 uint_t, uint_t, void *, uint_t *); 375 376 /* 377 * Drivers must set all of these callbacks except for mc_resources, 378 * mc_ioctl, and mc_getcapab, which are optional. If any of these optional 379 * callbacks are set, their appropriate flags must be set in mc_callbacks. 380 * Any future additions to this list must also be accompanied by an 381 * associated mc_callbacks flag so that the framework can grow without 382 * affecting the binary compatibility of the interface. 383 */ 384 typedef struct mac_callbacks_s { 385 uint_t mc_callbacks; /* Denotes which callbacks are set */ 386 mac_getstat_t mc_getstat; /* Get the value of a statistic */ 387 mac_start_t mc_start; /* Start the device */ 388 mac_stop_t mc_stop; /* Stop the device */ 389 mac_setpromisc_t mc_setpromisc; /* Enable or disable promiscuous mode */ 390 mac_multicst_t mc_multicst; /* Enable or disable a multicast addr */ 391 mac_unicst_t mc_unicst; /* Set the unicast MAC address */ 392 mac_tx_t mc_tx; /* Transmit a packet */ 393 mac_resources_t mc_resources; /* Get the device resources */ 394 mac_ioctl_t mc_ioctl; /* Process an unknown ioctl */ 395 mac_getcapab_t mc_getcapab; /* Get capability information */ 396 mac_open_t mc_open; /* Open the device */ 397 mac_close_t mc_close; /* Close the device */ 398 mac_set_prop_t mc_setprop; 399 mac_get_prop_t mc_getprop; 400 } mac_callbacks_t; 401 402 typedef struct mac_priv_prop_s { 403 char mpp_name[MAXLINKPROPNAME]; 404 uint_t mpp_flags; 405 } mac_priv_prop_t; 406 407 /* 408 * Multiple Rings capability 409 */ 410 typedef enum { 411 MAC_RING_TYPE_RX = 1, /* Receive ring */ 412 MAC_RING_TYPE_TX = 2 /* Transmit ring */ 413 } mac_ring_type_t; 414 415 /* 416 * Grouping type of a ring group 417 * 418 * MAC_GROUP_TYPE_STATIC: The ring group can not be re-grouped. 419 * MAC_GROUP_TYPE_DYNAMIC: The ring group support dynamic re-grouping 420 */ 421 typedef enum { 422 MAC_GROUP_TYPE_STATIC = 1, /* Static ring group */ 423 MAC_GROUP_TYPE_DYNAMIC = 2 /* Dynamic ring group */ 424 } mac_group_type_t; 425 426 typedef struct __mac_ring_driver *mac_ring_driver_t; 427 typedef struct __mac_ring_handle *mac_ring_handle_t; 428 typedef struct __mac_group_driver *mac_group_driver_t; 429 typedef struct __mac_group_handle *mac_group_handle_t; 430 typedef struct __mac_intr_handle *mac_intr_handle_t; 431 432 typedef struct mac_ring_info_s mac_ring_info_t; 433 typedef struct mac_group_info_s mac_group_info_t; 434 435 typedef int (*mac_intr_enable_t)(mac_intr_handle_t); 436 typedef int (*mac_intr_disable_t)(mac_intr_handle_t); 437 438 typedef struct mac_intr_s { 439 mac_intr_handle_t mi_handle; 440 mac_intr_enable_t mi_enable; 441 mac_intr_disable_t mi_disable; 442 } mac_intr_t; 443 444 typedef void (*mac_get_ring_t)(void *, mac_ring_type_t, const int, const int, 445 mac_ring_info_t *, mac_ring_handle_t); 446 typedef void (*mac_get_group_t)(void *, mac_ring_type_t, const int, 447 mac_group_info_t *, mac_group_handle_t); 448 449 typedef void (*mac_group_add_ring_t)(mac_group_driver_t, 450 mac_ring_driver_t, mac_ring_type_t); 451 typedef void (*mac_group_rem_ring_t)(mac_group_driver_t, 452 mac_ring_driver_t, mac_ring_type_t); 453 454 /* 455 * Multiple Rings Capability 456 */ 457 typedef struct mac_capab_rings_s { 458 mac_ring_type_t mr_type; /* Ring type */ 459 mac_group_type_t mr_group_type; /* Grouping type */ 460 void *mr_handle; /* Group Driver Handle. */ 461 uint_t mr_rnum; /* Number of rings */ 462 uint_t mr_gnum; /* Number of ring groups */ 463 mac_get_ring_t mr_rget; /* Get ring from driver */ 464 mac_get_group_t mr_gget; /* Get ring group from driver */ 465 mac_group_add_ring_t mr_gadd_ring; /* Add ring into a group */ 466 mac_group_rem_ring_t mr_grem_ring; /* Remove ring from a group */ 467 } mac_capab_rings_t; 468 469 /* 470 * Common ring functions and driver interfaces 471 */ 472 typedef int (*mac_ring_start_t)(mac_ring_driver_t); 473 typedef void (*mac_ring_stop_t)(mac_ring_driver_t); 474 475 typedef mblk_t *(*mac_ring_send_t)(void *, mblk_t *); 476 typedef mblk_t *(*mac_ring_poll_t)(void *, int); 477 478 typedef struct mac_ring_info_s { 479 mac_ring_driver_t mr_driver; 480 mac_ring_start_t mr_start; 481 mac_ring_stop_t mr_stop; 482 mac_intr_t mr_intr; 483 union { 484 mac_ring_send_t send; 485 mac_ring_poll_t poll; 486 } mrfunion; 487 } mac_ring_info_s; 488 489 #define mr_send mrfunion.send 490 #define mr_poll mrfunion.poll 491 492 typedef int (*mac_group_start_t)(mac_group_driver_t); 493 typedef void (*mac_group_stop_t)(mac_group_driver_t); 494 typedef int (*mac_add_mac_addr_t)(void *, const uint8_t *); 495 typedef int (*mac_rem_mac_addr_t)(void *, const uint8_t *); 496 497 struct mac_group_info_s { 498 mac_group_driver_t mrg_driver; /* Driver reference */ 499 mac_group_start_t mrg_start; /* Start the group */ 500 mac_group_stop_t mrg_stop; /* Stop the group */ 501 uint_t mrg_count; /* Count of rings */ 502 mac_intr_t mrg_intr; /* Optional per-group intr */ 503 504 /* Only used for rx groups */ 505 mac_add_mac_addr_t mrg_addmac; /* Add a MAC address */ 506 mac_rem_mac_addr_t mrg_remmac; /* Remove a MAC address */ 507 }; 508 509 /* 510 * Share management functions. 511 */ 512 typedef uint64_t mac_share_handle_t; 513 514 /* 515 * Returns a Share handle to the client calling from above. 516 */ 517 typedef int (*mac_alloc_share_t)(void *, uint64_t cookie, 518 uint64_t *rcookie, mac_share_handle_t *); 519 520 /* 521 * Destroys the share previously allocated and unallocates 522 * all share resources (e.g. DMA's assigned to the share). 523 */ 524 typedef void (*mac_free_share_t)(mac_share_handle_t); 525 526 typedef void (*mac_share_query_t)(mac_share_handle_t shdl, 527 mac_ring_type_t type, uint32_t *rmin, uint32_t *rmax, 528 uint64_t *rmap, uint64_t *gnum); 529 530 /* 531 * Basic idea, bind previously created ring groups to shares 532 * for them to be exported (or shared) by another domain. 533 * These interfaces bind/unbind the ring group to a share. The 534 * of doing such causes the resources to be shared with the guest. 535 */ 536 typedef int (*mac_share_add_group_t)(mac_share_handle_t, 537 mac_group_handle_t); 538 typedef int (*mac_share_rem_group_t)(mac_share_handle_t, 539 mac_group_handle_t); 540 541 typedef struct mac_capab_share_s { 542 uint_t ms_snum; /* Number of shares (vr's) */ 543 void *ms_handle; /* Handle to driver. */ 544 mac_alloc_share_t ms_salloc; /* Get a share from driver. */ 545 mac_free_share_t ms_sfree; /* Return a share to driver. */ 546 mac_share_add_group_t ms_sadd; /* Add a group to the share. */ 547 mac_share_rem_group_t ms_sremove; /* Remove group from share. */ 548 mac_share_query_t ms_squery; /* Query share constraints */ 549 } mac_capab_share_t; 550 551 /* 552 * Flags for mc_callbacks. Requiring drivers to set the flags associated 553 * with optional callbacks initialized in the structure allows the mac 554 * module to add optional callbacks in the future without requiring drivers 555 * to recompile. 556 */ 557 #define MC_RESOURCES 0x001 558 #define MC_IOCTL 0x002 559 #define MC_GETCAPAB 0x004 560 #define MC_OPEN 0x008 561 #define MC_CLOSE 0x010 562 #define MC_SETPROP 0x020 563 #define MC_GETPROP 0x040 564 565 #define MAC_MAX_MINOR 1000 566 567 typedef struct mac_register_s { 568 uint_t m_version; /* set by mac_alloc() */ 569 const char *m_type_ident; 570 void *m_driver; /* Driver private data */ 571 dev_info_t *m_dip; 572 uint_t m_instance; 573 uint8_t *m_src_addr; 574 uint8_t *m_dst_addr; 575 mac_callbacks_t *m_callbacks; 576 uint_t m_min_sdu; 577 uint_t m_max_sdu; 578 void *m_pdata; 579 size_t m_pdata_size; 580 uint32_t m_margin; 581 mac_priv_prop_t *m_priv_props; 582 size_t m_priv_prop_count; 583 } mac_register_t; 584 585 586 /* 587 * Opaque handle types. 588 */ 589 typedef struct mac_t *mac_handle_t; 590 typedef struct __mac_notify_handle *mac_notify_handle_t; 591 typedef struct __mac_rx_handle *mac_rx_handle_t; 592 typedef struct __mac_txloop_handle *mac_txloop_handle_t; 593 typedef struct __mac_resource_handle *mac_resource_handle_t; 594 595 /* 596 * MAC interface callback types. 597 */ 598 typedef enum { 599 MAC_NOTE_LINK, 600 MAC_NOTE_PROMISC, 601 MAC_NOTE_UNICST, 602 MAC_NOTE_TX, 603 MAC_NOTE_RESOURCE, 604 MAC_NOTE_DEVPROMISC, 605 MAC_NOTE_FASTPATH_FLUSH, 606 MAC_NOTE_SDU_SIZE, 607 MAC_NOTE_VNIC, 608 MAC_NOTE_MARGIN, 609 MAC_NNOTE /* must be the last entry */ 610 } mac_notify_type_t; 611 612 typedef void (*mac_notify_t)(void *, mac_notify_type_t); 613 typedef void (*mac_rx_t)(void *, mac_resource_handle_t, mblk_t *); 614 typedef void (*mac_txloop_t)(void *, mblk_t *); 615 typedef void (*mac_blank_t)(void *, time_t, uint_t); 616 617 /* 618 * MAC promiscuous types 619 */ 620 typedef enum { 621 MAC_PROMISC = 0x01, /* MAC instance is promiscuous */ 622 MAC_DEVPROMISC = 0x02 /* Device is promiscuous */ 623 } mac_promisc_type_t; 624 625 /* 626 * MAC resource types 627 */ 628 typedef enum { 629 MAC_RX_FIFO = 1 630 } mac_resource_type_t; 631 632 typedef struct mac_rx_fifo_s { 633 mac_resource_type_t mrf_type; /* MAC_RX_FIFO */ 634 mac_blank_t mrf_blank; 635 void *mrf_arg; 636 time_t mrf_normal_blank_time; 637 uint_t mrf_normal_pkt_count; 638 } mac_rx_fifo_t; 639 640 typedef struct mac_txinfo_s { 641 mac_tx_t mt_fn; 642 void *mt_arg; 643 } mac_txinfo_t; 644 645 typedef union mac_resource_u { 646 mac_resource_type_t mr_type; 647 mac_rx_fifo_t mr_fifo; 648 } mac_resource_t; 649 650 typedef mac_resource_handle_t (*mac_resource_add_t)(void *, mac_resource_t *); 651 652 typedef enum { 653 MAC_ADDRTYPE_UNICAST, 654 MAC_ADDRTYPE_MULTICAST, 655 MAC_ADDRTYPE_BROADCAST 656 } mac_addrtype_t; 657 658 typedef struct mac_header_info_s { 659 size_t mhi_hdrsize; 660 size_t mhi_pktsize; 661 const uint8_t *mhi_daddr; 662 const uint8_t *mhi_saddr; 663 uint32_t mhi_origsap; 664 uint32_t mhi_bindsap; 665 mac_addrtype_t mhi_dsttype; 666 uint16_t mhi_tci; 667 uint_t mhi_istagged:1, 668 mhi_prom_looped:1; 669 } mac_header_info_t; 670 671 /* 672 * MAC-Type plugin interfaces 673 */ 674 675 typedef int (*mtops_addr_verify_t)(const void *, void *); 676 typedef boolean_t (*mtops_sap_verify_t)(uint32_t, uint32_t *, void *); 677 typedef mblk_t *(*mtops_header_t)(const void *, const void *, 678 uint32_t, void *, mblk_t *, size_t); 679 typedef int (*mtops_header_info_t)(mblk_t *, void *, 680 mac_header_info_t *); 681 typedef boolean_t (*mtops_pdata_verify_t)(void *, size_t); 682 typedef mblk_t *(*mtops_header_modify_t)(mblk_t *, void *); 683 typedef void (*mtops_link_details_t)(char *, size_t, mac_handle_t, 684 void *); 685 686 typedef struct mactype_ops_s { 687 uint_t mtops_ops; 688 /* 689 * mtops_unicst_verify() returns 0 if the given address is a valid 690 * unicast address, or a non-zero errno otherwise. 691 */ 692 mtops_addr_verify_t mtops_unicst_verify; 693 /* 694 * mtops_multicst_verify() returns 0 if the given address is a 695 * valid multicast address, or a non-zero errno otherwise. If the 696 * media doesn't support multicast, ENOTSUP should be returned (for 697 * example). 698 */ 699 mtops_addr_verify_t mtops_multicst_verify; 700 /* 701 * mtops_sap_verify() returns B_TRUE if the given SAP is a valid 702 * SAP value, or B_FALSE otherwise. 703 */ 704 mtops_sap_verify_t mtops_sap_verify; 705 /* 706 * mtops_header() is used to allocate and construct a MAC header. 707 */ 708 mtops_header_t mtops_header; 709 /* 710 * mtops_header_info() is used to gather information on a given MAC 711 * header. 712 */ 713 mtops_header_info_t mtops_header_info; 714 /* 715 * mtops_pdata_verify() is used to verify the validity of MAC 716 * plugin data. It is called by mac_register() if the driver has 717 * supplied MAC plugin data, and also by mac_pdata_update() when 718 * drivers update the data. 719 */ 720 mtops_pdata_verify_t mtops_pdata_verify; 721 /* 722 * mtops_header_cook() is an optional callback that converts (or 723 * "cooks") the given raw header (as sent by a raw DLPI consumer) 724 * into one that is appropriate to send down to the MAC driver. 725 * Following the example above, an Ethernet header sent down by a 726 * DLPI consumer would be converted to whatever header the MAC 727 * driver expects. 728 */ 729 mtops_header_modify_t mtops_header_cook; 730 /* 731 * mtops_header_uncook() is an optional callback that does the 732 * opposite of mtops_header_cook(). It "uncooks" a given MAC 733 * header (as received from the driver) for consumption by raw DLPI 734 * consumers. For example, for a non-Ethernet plugin that wants 735 * raw DLPI consumers to be fooled into thinking that the device 736 * provides Ethernet access, this callback would modify the given 737 * mblk_t such that the MAC header is converted to an Ethernet 738 * header. 739 */ 740 mtops_header_modify_t mtops_header_uncook; 741 /* 742 * mtops_link_details() is an optional callback that provides 743 * extended information about the link state. Its primary purpose 744 * is to provide type-specific support for syslog contents on 745 * link up events. If no implementation is provided, then a default 746 * implementation will be used. 747 */ 748 mtops_link_details_t mtops_link_details; 749 } mactype_ops_t; 750 751 /* 752 * mtops_ops exists for the plugin to enumerate the optional callback 753 * entrypoints it has defined. This allows the mac module to define 754 * additional plugin entrypoints in mactype_ops_t without breaking backward 755 * compatibility with old plugins. 756 */ 757 #define MTOPS_PDATA_VERIFY 0x001 758 #define MTOPS_HEADER_COOK 0x002 759 #define MTOPS_HEADER_UNCOOK 0x004 760 #define MTOPS_LINK_DETAILS 0x008 761 762 /* 763 * Provide mapping for legacy ndd ioctls relevant to that mactype. 764 * Note that the ndd ioctls are obsolete, and may be removed in a future 765 * release of Solaris. The ndd ioctls are not typically used in legacy 766 * ethernet drivers. New datalink drivers of all link-types should use 767 * dladm(1m) interfaces for administering tunables and not have to provide 768 * a mapping. 769 */ 770 typedef struct mac_ndd_mapping_s { 771 char *mp_name; 772 union { 773 mac_prop_id_t u_id; 774 uint_t u_kstat; 775 } u_mp_id; 776 long mp_minval; 777 long mp_maxval; 778 size_t mp_valsize; 779 int mp_flags; 780 } mac_ndd_mapping_t; 781 782 #define mp_prop_id u_mp_id.u_id 783 #define mp_kstat u_mp_id.u_kstat 784 785 typedef struct mactype_register_s { 786 uint_t mtr_version; /* set by mactype_alloc() */ 787 const char *mtr_ident; 788 mactype_ops_t *mtr_ops; 789 uint_t mtr_mactype; 790 uint_t mtr_nativetype; 791 uint_t mtr_addrlen; 792 uint8_t *mtr_brdcst_addr; 793 mac_stat_info_t *mtr_stats; 794 size_t mtr_statcount; 795 mac_ndd_mapping_t *mtr_mapping; 796 size_t mtr_mappingcount; 797 } mactype_register_t; 798 799 typedef struct mac_prop_s { 800 mac_prop_id_t mp_id; 801 char *mp_name; 802 uint_t mp_flags; 803 } mac_prop_t; 804 805 /* 806 * Client interface functions. 807 */ 808 extern int mac_open(const char *, mac_handle_t *); 809 extern int mac_open_by_linkid(datalink_id_t, 810 mac_handle_t *); 811 extern int mac_open_by_linkname(const char *, 812 mac_handle_t *); 813 extern void mac_close(mac_handle_t); 814 extern const mac_info_t *mac_info(mac_handle_t); 815 extern boolean_t mac_info_get(const char *, mac_info_t *); 816 extern uint64_t mac_stat_get(mac_handle_t, uint_t); 817 extern int mac_start(mac_handle_t); 818 extern void mac_stop(mac_handle_t); 819 extern int mac_promisc_set(mac_handle_t, boolean_t, 820 mac_promisc_type_t); 821 extern boolean_t mac_promisc_get(mac_handle_t, 822 mac_promisc_type_t); 823 extern int mac_multicst_add(mac_handle_t, const uint8_t *); 824 extern int mac_multicst_remove(mac_handle_t, 825 const uint8_t *); 826 extern boolean_t mac_unicst_verify(mac_handle_t, 827 const uint8_t *, uint_t); 828 extern int mac_unicst_set(mac_handle_t, const uint8_t *); 829 extern void mac_unicst_get(mac_handle_t, uint8_t *); 830 extern void mac_dest_get(mac_handle_t, uint8_t *); 831 extern void mac_sdu_get(mac_handle_t, uint_t *, uint_t *); 832 extern void mac_resources(mac_handle_t); 833 extern void mac_ioctl(mac_handle_t, queue_t *, mblk_t *); 834 extern const mac_txinfo_t *mac_tx_get(mac_handle_t); 835 extern const mac_txinfo_t *mac_vnic_tx_get(mac_handle_t); 836 extern link_state_t mac_link_get(mac_handle_t); 837 extern mac_notify_handle_t mac_notify_add(mac_handle_t, mac_notify_t, 838 void *); 839 extern void mac_notify_remove(mac_handle_t, 840 mac_notify_handle_t); 841 extern void mac_notify(mac_handle_t); 842 extern mac_rx_handle_t mac_rx_add(mac_handle_t, mac_rx_t, void *); 843 extern mac_rx_handle_t mac_active_rx_add(mac_handle_t, mac_rx_t, 844 void *); 845 extern void mac_rx_remove(mac_handle_t, mac_rx_handle_t, 846 boolean_t); 847 extern void mac_rx_remove_wait(mac_handle_t); 848 extern mblk_t *mac_txloop(void *, mblk_t *); 849 extern mac_txloop_handle_t mac_txloop_add(mac_handle_t, mac_txloop_t, 850 void *); 851 extern void mac_txloop_remove(mac_handle_t, 852 mac_txloop_handle_t); 853 extern boolean_t mac_active_set(mac_handle_t); 854 extern boolean_t mac_active_shareable_set(mac_handle_t); 855 extern void mac_active_clear(mac_handle_t); 856 extern void mac_active_rx(void *, mac_resource_handle_t, 857 mblk_t *); 858 extern boolean_t mac_vnic_set(mac_handle_t, mac_txinfo_t *, 859 mac_getcapab_t, void *); 860 extern void mac_vnic_clear(mac_handle_t); 861 extern void mac_resource_set(mac_handle_t, 862 mac_resource_add_t, void *); 863 extern dev_info_t *mac_devinfo_get(mac_handle_t); 864 extern const char *mac_name(mac_handle_t); 865 extern minor_t mac_minor(mac_handle_t); 866 extern boolean_t mac_capab_get(mac_handle_t, mac_capab_t, 867 void *); 868 extern boolean_t mac_vnic_capab_get(mac_handle_t, mac_capab_t, 869 void *); 870 extern boolean_t mac_sap_verify(mac_handle_t, uint32_t, 871 uint32_t *); 872 extern mblk_t *mac_header(mac_handle_t, const uint8_t *, 873 uint32_t, mblk_t *, size_t); 874 extern int mac_header_info(mac_handle_t, mblk_t *, 875 mac_header_info_t *); 876 extern mblk_t *mac_header_cook(mac_handle_t, mblk_t *); 877 extern mblk_t *mac_header_uncook(mac_handle_t, mblk_t *); 878 extern minor_t mac_minor_hold(boolean_t); 879 extern void mac_minor_rele(minor_t); 880 881 /* 882 * Driver interface functions. 883 */ 884 extern mac_register_t *mac_alloc(uint_t); 885 extern void mac_free(mac_register_t *); 886 extern int mac_register(mac_register_t *, mac_handle_t *); 887 extern int mac_disable(mac_handle_t); 888 extern int mac_unregister(mac_handle_t); 889 extern void mac_rx(mac_handle_t, mac_resource_handle_t, 890 mblk_t *); 891 extern void mac_link_update(mac_handle_t, link_state_t); 892 extern void mac_unicst_update(mac_handle_t, 893 const uint8_t *); 894 extern void mac_tx_update(mac_handle_t); 895 extern void mac_resource_update(mac_handle_t); 896 extern mac_resource_handle_t mac_resource_add(mac_handle_t, 897 mac_resource_t *); 898 extern int mac_maxsdu_update(mac_handle_t, uint_t); 899 extern int mac_pdata_update(mac_handle_t, void *, 900 size_t); 901 extern void mac_multicst_refresh(mac_handle_t, 902 mac_multicst_t, void *, boolean_t); 903 extern void mac_unicst_refresh(mac_handle_t, mac_unicst_t, 904 void *); 905 extern void mac_promisc_refresh(mac_handle_t, 906 mac_setpromisc_t, void *); 907 extern boolean_t mac_margin_update(mac_handle_t, uint32_t); 908 extern void mac_margin_get(mac_handle_t, uint32_t *); 909 extern int mac_margin_remove(mac_handle_t, uint32_t); 910 extern int mac_margin_add(mac_handle_t, uint32_t *, 911 boolean_t); 912 extern void mac_init_ops(struct dev_ops *, const char *); 913 extern void mac_fini_ops(struct dev_ops *); 914 extern uint32_t mac_no_notification(mac_handle_t); 915 extern boolean_t mac_is_legacy(mac_handle_t); 916 extern int mac_hold_exclusive(mac_handle_t); 917 extern void mac_rele_exclusive(mac_handle_t); 918 919 extern mactype_register_t *mactype_alloc(uint_t); 920 extern void mactype_free(mactype_register_t *); 921 extern int mactype_register(mactype_register_t *); 922 extern int mactype_unregister(const char *); 923 extern int mac_set_prop(mac_handle_t, mac_prop_t *, 924 void *, uint_t); 925 extern int mac_get_prop(mac_handle_t, mac_prop_t *, 926 void *, uint_t, uint_t *); 927 928 #endif /* _KERNEL */ 929 930 #ifdef __cplusplus 931 } 932 #endif 933 934 #endif /* _SYS_MAC_H */ 935