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 2006 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 v%I%" 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 #ifdef _KERNEL 88 89 typedef struct mac_stat_info_s { 90 uint_t msi_stat; 91 char *msi_name; 92 uint_t msi_type; /* as defined in kstat_named_init(9F) */ 93 uint64_t msi_default; 94 } mac_stat_info_t; 95 96 /* 97 * There are three ranges of statistics values. 0 to 1 - MAC_STAT_MIN are 98 * interface statistics maintained by the mac module. MAC_STAT_MIN to 1 - 99 * MACTYPE_STAT_MIN are common MAC statistics defined by the mac module and 100 * maintained by each driver. MACTYPE_STAT_MIN and above are statistics 101 * defined by MAC-Type plugins and maintained by each driver. 102 */ 103 #define MAC_STAT_MIN 1000 104 #define MACTYPE_STAT_MIN 2000 105 106 #define IS_MAC_STAT(stat) \ 107 (stat >= MAC_STAT_MIN && stat < MACTYPE_STAT_MIN) 108 #define IS_MACTYPE_STAT(stat) (stat >= MACTYPE_STAT_MIN) 109 110 enum mac_driver_stat { 111 /* MIB-II stats (RFC 1213 and RFC 1573) */ 112 MAC_STAT_IFSPEED = MAC_STAT_MIN, 113 MAC_STAT_MULTIRCV, 114 MAC_STAT_BRDCSTRCV, 115 MAC_STAT_MULTIXMT, 116 MAC_STAT_BRDCSTXMT, 117 MAC_STAT_NORCVBUF, 118 MAC_STAT_IERRORS, 119 MAC_STAT_UNKNOWNS, 120 MAC_STAT_NOXMTBUF, 121 MAC_STAT_OERRORS, 122 MAC_STAT_COLLISIONS, 123 MAC_STAT_RBYTES, 124 MAC_STAT_IPACKETS, 125 MAC_STAT_OBYTES, 126 MAC_STAT_OPACKETS 127 }; 128 129 #define MAC_NSTAT (MAC_STAT_OPACKETS - MAC_STAT_IFSPEED + 1) 130 131 #define MAC_STAT_ISACOUNTER(_stat) ( \ 132 (_stat) == MAC_STAT_MULTIRCV || \ 133 (_stat) == MAC_STAT_BRDCSTRCV || \ 134 (_stat) == MAC_STAT_MULTIXMT || \ 135 (_stat) == MAC_STAT_BRDCSTXMT || \ 136 (_stat) == MAC_STAT_NORCVBUF || \ 137 (_stat) == MAC_STAT_IERRORS || \ 138 (_stat) == MAC_STAT_UNKNOWNS || \ 139 (_stat) == MAC_STAT_NOXMTBUF || \ 140 (_stat) == MAC_STAT_OERRORS || \ 141 (_stat) == MAC_STAT_COLLISIONS || \ 142 (_stat) == MAC_STAT_RBYTES || \ 143 (_stat) == MAC_STAT_IPACKETS || \ 144 (_stat) == MAC_STAT_OBYTES || \ 145 (_stat) == MAC_STAT_OPACKETS) 146 147 /* 148 * Maximum MAC address length 149 */ 150 #define MAXMACADDRLEN 20 151 152 /* 153 * Immutable information. (This may not be modified after registration). 154 */ 155 typedef struct mac_info_s { 156 uint_t mi_media; 157 uint_t mi_sdu_min; 158 uint_t mi_sdu_max; 159 uint_t mi_addr_length; 160 uint8_t *mi_unicst_addr; 161 uint8_t *mi_brdcst_addr; 162 } mac_info_t; 163 164 /* 165 * LSO capability 166 */ 167 typedef struct lso_basic_tcp_ipv4_s { 168 t_uscalar_t lso_max; /* maximum payload */ 169 } lso_basic_tcp_ipv4_t; 170 171 /* 172 * Future LSO capabilities can be added at the end of the mac_capab_lso_t. 173 * When such capability is added to the GLDv3 framework, the size of the 174 * mac_capab_lso_t it allocates and passes to the drivers increases. Older 175 * drivers wil access only the (upper) sections of that structure, that is the 176 * sections carrying the capabilities they understand. This ensures the 177 * interface can be safely extended in a binary compatible way. 178 */ 179 typedef struct mac_capab_lso_s { 180 t_uscalar_t lso_flags; 181 lso_basic_tcp_ipv4_t lso_basic_tcp_ipv4; 182 /* Add future lso capabilities here */ 183 } mac_capab_lso_t; 184 185 /* 186 * MAC layer capabilities. These capabilities are handled by the drivers' 187 * mc_capab_get() callbacks. Some capabilities require the driver to fill 188 * in a given data structure, and others are simply boolean capabilities. 189 * Note that capability values must be powers of 2 so that consumers and 190 * providers of this interface can keep track of which capabilities they 191 * care about by keeping a bitfield of these things around somewhere. 192 */ 193 typedef enum { 194 MAC_CAPAB_HCKSUM = 0x01, /* data is a uint32_t for the txflags */ 195 MAC_CAPAB_POLL = 0x02, /* boolean only, no data */ 196 MAC_CAPAB_MULTIADDRESS = 0x04, /* data is multiaddress_capab_t */ 197 MAC_CAPAB_LSO = 0x08 /* data is mac_capab_lso_t */ 198 /* add new capabilities here */ 199 } mac_capab_t; 200 201 typedef int mac_addr_slot_t; 202 203 /* mma_flags values */ 204 #define MMAC_SLOT_USED 0x1 /* address slot used */ 205 #define MMAC_SLOT_UNUSED 0x2 /* free address slot */ 206 #define MMAC_VENDOR_ADDR 0x4 /* address returned is vendor supplied */ 207 208 typedef struct mac_multi_address_s { 209 mac_addr_slot_t mma_slot; /* slot for add/remove/get/set */ 210 uint_t mma_addrlen; 211 uint8_t mma_addr[MAXMACADDRLEN]; 212 uint_t mma_flags; 213 } mac_multi_addr_t; 214 215 typedef int (*maddr_reserve_t)(void *, mac_multi_addr_t *); 216 typedef int (*maddr_add_t)(void *, mac_multi_addr_t *); 217 typedef int (*maddr_remove_t)(void *, mac_addr_slot_t); 218 typedef int (*maddr_modify_t)(void *, mac_multi_addr_t *); 219 typedef int (*maddr_get_t)(void *, mac_multi_addr_t *); 220 221 /* maddr_flag values */ 222 #define MADDR_VENDOR_ADDR 0x01 /* addr returned is vendor supplied */ 223 224 /* multiple mac address: add/remove/set/get mac address */ 225 typedef struct multiaddress_capab_s { 226 int maddr_naddr; /* total addresses */ 227 int maddr_naddrfree; /* free address slots */ 228 uint_t maddr_flag; /* MADDR_VENDOR_ADDR bit can be set */ 229 /* driver entry points */ 230 void *maddr_handle; /* cookie to be used for the calls */ 231 maddr_reserve_t maddr_reserve; /* reserve a factory address */ 232 maddr_add_t maddr_add; /* add a new unicst address */ 233 maddr_remove_t maddr_remove; /* remove an added address */ 234 maddr_modify_t maddr_modify; /* modify an added address */ 235 maddr_get_t maddr_get; /* get address from specified slot */ 236 } multiaddress_capab_t; 237 238 /* 239 * MAC driver entry point types. 240 */ 241 typedef int (*mac_getstat_t)(void *, uint_t, uint64_t *); 242 typedef int (*mac_start_t)(void *); 243 typedef void (*mac_stop_t)(void *); 244 typedef int (*mac_setpromisc_t)(void *, boolean_t); 245 typedef int (*mac_multicst_t)(void *, boolean_t, const uint8_t *); 246 typedef int (*mac_unicst_t)(void *, const uint8_t *); 247 typedef void (*mac_ioctl_t)(void *, queue_t *, mblk_t *); 248 typedef void (*mac_resources_t)(void *); 249 typedef mblk_t *(*mac_tx_t)(void *, mblk_t *); 250 typedef boolean_t (*mac_getcapab_t)(void *, mac_capab_t, void *); 251 252 /* 253 * Drivers must set all of these callbacks except for mc_resources, 254 * mc_ioctl, and mc_getcapab, which are optional. If any of these optional 255 * callbacks are set, their appropriate flags must be set in mc_callbacks. 256 * Any future additions to this list must also be accompanied by an 257 * associated mc_callbacks flag so that the framework can grow without 258 * affecting the binary compatibility of the interface. 259 */ 260 typedef struct mac_callbacks_s { 261 uint_t mc_callbacks; /* Denotes which callbacks are set */ 262 mac_getstat_t mc_getstat; /* Get the value of a statistic */ 263 mac_start_t mc_start; /* Start the device */ 264 mac_stop_t mc_stop; /* Stop the device */ 265 mac_setpromisc_t mc_setpromisc; /* Enable or disable promiscuous mode */ 266 mac_multicst_t mc_multicst; /* Enable or disable a multicast addr */ 267 mac_unicst_t mc_unicst; /* Set the unicast MAC address */ 268 mac_tx_t mc_tx; /* Transmit a packet */ 269 mac_resources_t mc_resources; /* Get the device resources */ 270 mac_ioctl_t mc_ioctl; /* Process an unknown ioctl */ 271 mac_getcapab_t mc_getcapab; /* Get capability information */ 272 } mac_callbacks_t; 273 274 /* 275 * Flags for mc_callbacks. Requiring drivers to set the flags associated 276 * with optional callbacks initialized in the structure allows the mac 277 * module to add optional callbacks in the future without requiring drivers 278 * to recompile. 279 */ 280 #define MC_RESOURCES 0x001 281 #define MC_IOCTL 0x002 282 #define MC_GETCAPAB 0x004 283 284 typedef struct mac_register_s { 285 uint_t m_version; /* set by mac_alloc() */ 286 const char *m_type_ident; 287 void *m_driver; /* Driver private data */ 288 dev_info_t *m_dip; 289 uint_t m_instance; 290 uint8_t *m_src_addr; 291 uint8_t *m_dst_addr; 292 mac_callbacks_t *m_callbacks; 293 uint_t m_min_sdu; 294 uint_t m_max_sdu; 295 void *m_pdata; 296 size_t m_pdata_size; 297 } mac_register_t; 298 299 /* 300 * Opaque handle types. 301 */ 302 typedef struct mac_t *mac_handle_t; 303 typedef struct __mac_notify_handle *mac_notify_handle_t; 304 typedef struct __mac_rx_handle *mac_rx_handle_t; 305 typedef struct __mac_txloop_handle *mac_txloop_handle_t; 306 typedef struct __mac_resource_handle *mac_resource_handle_t; 307 308 /* 309 * MAC interface callback types. 310 */ 311 typedef enum { 312 MAC_NOTE_LINK, 313 MAC_NOTE_PROMISC, 314 MAC_NOTE_UNICST, 315 MAC_NOTE_TX, 316 MAC_NOTE_RESOURCE, 317 MAC_NOTE_DEVPROMISC, 318 MAC_NOTE_FASTPATH_FLUSH, 319 MAC_NNOTE /* must be the last entry */ 320 } mac_notify_type_t; 321 322 typedef void (*mac_notify_t)(void *, mac_notify_type_t); 323 typedef void (*mac_rx_t)(void *, mac_resource_handle_t, mblk_t *); 324 typedef void (*mac_txloop_t)(void *, mblk_t *); 325 typedef void (*mac_blank_t)(void *, time_t, uint_t); 326 327 /* 328 * MAC promiscuous types 329 */ 330 typedef enum { 331 MAC_PROMISC = 0x01, /* MAC instance is promiscuous */ 332 MAC_DEVPROMISC = 0x02 /* Device is promiscuous */ 333 } mac_promisc_type_t; 334 335 /* 336 * MAC resource types 337 */ 338 typedef enum { 339 MAC_RX_FIFO = 1 340 } mac_resource_type_t; 341 342 typedef struct mac_rx_fifo_s { 343 mac_resource_type_t mrf_type; /* MAC_RX_FIFO */ 344 mac_blank_t mrf_blank; 345 void *mrf_arg; 346 time_t mrf_normal_blank_time; 347 uint_t mrf_normal_pkt_count; 348 } mac_rx_fifo_t; 349 350 typedef struct mac_txinfo_s { 351 mac_tx_t mt_fn; 352 void *mt_arg; 353 } mac_txinfo_t; 354 355 typedef union mac_resource_u { 356 mac_resource_type_t mr_type; 357 mac_rx_fifo_t mr_fifo; 358 } mac_resource_t; 359 360 typedef mac_resource_handle_t (*mac_resource_add_t)(void *, mac_resource_t *); 361 362 typedef enum { 363 MAC_ADDRTYPE_UNICAST, 364 MAC_ADDRTYPE_MULTICAST, 365 MAC_ADDRTYPE_BROADCAST 366 } mac_addrtype_t; 367 368 typedef struct mac_header_info_s { 369 size_t mhi_hdrsize; 370 size_t mhi_pktsize; 371 const uint8_t *mhi_daddr; 372 const uint8_t *mhi_saddr; 373 uint32_t mhi_origsap; 374 uint32_t mhi_bindsap; 375 mac_addrtype_t mhi_dsttype; 376 boolean_t mhi_istagged; 377 uint16_t mhi_tci; 378 } mac_header_info_t; 379 380 /* 381 * MAC-Type plugin interfaces 382 */ 383 384 typedef int (*mtops_addr_verify_t)(const void *, void *); 385 typedef boolean_t (*mtops_sap_verify_t)(uint32_t, uint32_t *, void *); 386 typedef mblk_t *(*mtops_header_t)(const void *, const void *, 387 uint32_t, void *, mblk_t *, size_t); 388 typedef int (*mtops_header_info_t)(mblk_t *, void *, 389 mac_header_info_t *); 390 typedef boolean_t (*mtops_pdata_verify_t)(void *, size_t); 391 typedef mblk_t *(*mtops_header_modify_t)(mblk_t *, void *); 392 393 typedef struct mactype_ops_s { 394 uint_t mtops_ops; 395 /* 396 * mtops_unicst_verify() returns 0 if the given address is a valid 397 * unicast address, or a non-zero errno otherwise. 398 */ 399 mtops_addr_verify_t mtops_unicst_verify; 400 /* 401 * mtops_multicst_verify() returns 0 if the given address is a 402 * valid multicast address, or a non-zero errno otherwise. If the 403 * media doesn't support multicast, ENOTSUP should be returned (for 404 * example). 405 */ 406 mtops_addr_verify_t mtops_multicst_verify; 407 /* 408 * mtops_sap_verify() returns B_TRUE if the given SAP is a valid 409 * SAP value, or B_FALSE otherwise. 410 */ 411 mtops_sap_verify_t mtops_sap_verify; 412 /* 413 * mtops_header() is used to allocate and construct a MAC header. 414 */ 415 mtops_header_t mtops_header; 416 /* 417 * mtops_header_info() is used to gather information on a given MAC 418 * header. 419 */ 420 mtops_header_info_t mtops_header_info; 421 /* 422 * mtops_pdata_verify() is used to verify the validity of MAC 423 * plugin data. It is called by mac_register() if the driver has 424 * supplied MAC plugin data, and also by mac_pdata_update() when 425 * drivers update the data. 426 */ 427 mtops_pdata_verify_t mtops_pdata_verify; 428 /* 429 * mtops_header_cook() is an optional callback that converts (or 430 * "cooks") the given raw header (as sent by a raw DLPI consumer) 431 * into one that is appropriate to send down to the MAC driver. 432 * Following the example above, an Ethernet header sent down by a 433 * DLPI consumer would be converted to whatever header the MAC 434 * driver expects. 435 */ 436 mtops_header_modify_t mtops_header_cook; 437 /* 438 * mtops_header_uncook() is an optional callback that does the 439 * opposite of mtops_header_cook(). It "uncooks" a given MAC 440 * header (as received from the driver) for consumption by raw DLPI 441 * consumers. For example, for a non-Ethernet plugin that wants 442 * raw DLPI consumers to be fooled into thinking that the device 443 * provides Ethernet access, this callback would modify the given 444 * mblk_t such that the MAC header is converted to an Ethernet 445 * header. 446 */ 447 mtops_header_modify_t mtops_header_uncook; 448 } mactype_ops_t; 449 450 /* 451 * mtops_ops exists for the plugin to enumerate the optional callback 452 * entrypoints it has defined. This allows the mac module to define 453 * additional plugin entrypoints in mactype_ops_t without breaking backward 454 * compatibility with old plugins. 455 */ 456 #define MTOPS_PDATA_VERIFY 0x001 457 #define MTOPS_HEADER_COOK 0x002 458 #define MTOPS_HEADER_UNCOOK 0x004 459 460 typedef struct mactype_register_s { 461 uint_t mtr_version; /* set by mactype_alloc() */ 462 const char *mtr_ident; 463 mactype_ops_t *mtr_ops; 464 uint_t mtr_mactype; 465 uint_t mtr_addrlen; 466 uint8_t *mtr_brdcst_addr; 467 mac_stat_info_t *mtr_stats; 468 size_t mtr_statcount; 469 } mactype_register_t; 470 471 /* 472 * Client interface functions. 473 */ 474 extern int mac_open(const char *, uint_t, mac_handle_t *); 475 extern void mac_close(mac_handle_t); 476 extern const mac_info_t *mac_info(mac_handle_t); 477 extern boolean_t mac_info_get(const char *, mac_info_t *); 478 extern uint64_t mac_stat_get(mac_handle_t, uint_t); 479 extern int mac_start(mac_handle_t); 480 extern void mac_stop(mac_handle_t); 481 extern int mac_promisc_set(mac_handle_t, boolean_t, 482 mac_promisc_type_t); 483 extern boolean_t mac_promisc_get(mac_handle_t, 484 mac_promisc_type_t); 485 extern int mac_multicst_add(mac_handle_t, const uint8_t *); 486 extern int mac_multicst_remove(mac_handle_t, 487 const uint8_t *); 488 extern boolean_t mac_unicst_verify(mac_handle_t, 489 const uint8_t *, uint_t); 490 extern int mac_unicst_set(mac_handle_t, const uint8_t *); 491 extern void mac_unicst_get(mac_handle_t, uint8_t *); 492 extern void mac_dest_get(mac_handle_t, uint8_t *); 493 extern void mac_resources(mac_handle_t); 494 extern void mac_ioctl(mac_handle_t, queue_t *, mblk_t *); 495 extern const mac_txinfo_t *mac_tx_get(mac_handle_t); 496 extern link_state_t mac_link_get(mac_handle_t); 497 extern mac_notify_handle_t mac_notify_add(mac_handle_t, mac_notify_t, 498 void *); 499 extern void mac_notify_remove(mac_handle_t, 500 mac_notify_handle_t); 501 extern void mac_notify(mac_handle_t); 502 extern mac_rx_handle_t mac_rx_add(mac_handle_t, mac_rx_t, void *); 503 extern void mac_rx_remove(mac_handle_t, mac_rx_handle_t); 504 extern mblk_t *mac_txloop(void *, mblk_t *); 505 extern mac_txloop_handle_t mac_txloop_add(mac_handle_t, mac_txloop_t, 506 void *); 507 extern void mac_txloop_remove(mac_handle_t, 508 mac_txloop_handle_t); 509 extern boolean_t mac_active_set(mac_handle_t); 510 extern void mac_active_clear(mac_handle_t); 511 extern void mac_resource_set(mac_handle_t, 512 mac_resource_add_t, void *); 513 extern dev_info_t *mac_devinfo_get(mac_handle_t); 514 extern boolean_t mac_capab_get(mac_handle_t, mac_capab_t, 515 void *); 516 extern boolean_t mac_sap_verify(mac_handle_t, uint32_t, 517 uint32_t *); 518 extern mblk_t *mac_header(mac_handle_t, const uint8_t *, 519 uint32_t, mblk_t *, size_t); 520 extern int mac_header_info(mac_handle_t, mblk_t *, 521 mac_header_info_t *); 522 extern mblk_t *mac_header_cook(mac_handle_t, mblk_t *); 523 extern mblk_t *mac_header_uncook(mac_handle_t, mblk_t *); 524 525 /* 526 * Driver interface functions. 527 */ 528 extern mac_register_t *mac_alloc(uint_t); 529 extern void mac_free(mac_register_t *); 530 extern int mac_register(mac_register_t *, mac_handle_t *); 531 extern int mac_unregister(mac_handle_t); 532 extern void mac_rx(mac_handle_t, mac_resource_handle_t, 533 mblk_t *); 534 extern void mac_link_update(mac_handle_t, link_state_t); 535 extern void mac_unicst_update(mac_handle_t, 536 const uint8_t *); 537 extern void mac_tx_update(mac_handle_t); 538 extern void mac_resource_update(mac_handle_t); 539 extern mac_resource_handle_t mac_resource_add(mac_handle_t, 540 mac_resource_t *); 541 extern int mac_pdata_update(mac_handle_t, void *, 542 size_t); 543 extern void mac_multicst_refresh(mac_handle_t, 544 mac_multicst_t, void *, boolean_t); 545 extern void mac_unicst_refresh(mac_handle_t, mac_unicst_t, 546 void *); 547 extern void mac_promisc_refresh(mac_handle_t, 548 mac_setpromisc_t, void *); 549 extern void mac_init_ops(struct dev_ops *, const char *); 550 extern void mac_fini_ops(struct dev_ops *); 551 extern mactype_register_t *mactype_alloc(uint_t); 552 extern void mactype_free(mactype_register_t *); 553 extern int mactype_register(mactype_register_t *); 554 extern int mactype_unregister(const char *); 555 556 #endif /* _KERNEL */ 557 558 #ifdef __cplusplus 559 } 560 #endif 561 562 #endif /* _SYS_MAC_H */ 563