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