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