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