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