/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License (the "License"). * You may not use this file except in compliance with the License. * * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE * or http://www.opensolaris.org/os/licensing. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at usr/src/OPENSOLARIS.LICENSE. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END */ /* * Copyright 2009 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. */ #ifndef _SYS_MAC_PROVIDER_H #define _SYS_MAC_PROVIDER_H #include #include #include #include #include #include /* * MAC Provider Interface */ #ifdef __cplusplus extern "C" { #endif /* * MAC version identifier. This is used by mac_alloc() mac_register() to * verify that incompatible drivers don't register. */ #define MAC_VERSION 0x1 #define MAC_VERSION_V1 0x1 /* * Possible values for ETHER_STAT_XCVR_INUSE statistic. */ #define XCVR_UNDEFINED 0 #define XCVR_NONE 1 #define XCVR_10 2 #define XCVR_100T4 3 #define XCVR_100X 4 #define XCVR_100T2 5 #define XCVR_1000X 6 #define XCVR_1000T 7 #ifdef _KERNEL /* * Definitions for MAC Drivers Capabilities */ /* * MAC layer capabilities. These capabilities are handled by the drivers' * mc_capab_get() callbacks. Some capabilities require the driver to fill * in a given data structure, and others are simply boolean capabilities. * Note that capability values must be powers of 2 so that consumers and * providers of this interface can keep track of which capabilities they * care about by keeping a bitfield of these things around somewhere. */ typedef enum { MAC_CAPAB_HCKSUM = 0x0100, /* data is a uint32_t */ MAC_CAPAB_LSO = 0x0200, /* data is mac_capab_lso_t */ } mac_capab_t; /* * LSO capability */ typedef struct lso_basic_tcp_ipv4_s { t_uscalar_t lso_max; /* maximum payload */ } lso_basic_tcp_ipv4_t; /* * Currently supported flags for LSO. */ #define LSO_TX_BASIC_TCP_IPV4 0x01 /* TCP LSO capability */ /* * Future LSO capabilities can be added at the end of the mac_capab_lso_t. * When such capability is added to the GLDv3 framework, the size of the * mac_capab_lso_t it allocates and passes to the drivers increases. Older * drivers wil access only the (upper) sections of that structure, that is the * sections carrying the capabilities they understand. This ensures the * interface can be safely extended in a binary compatible way. */ typedef struct mac_capab_lso_s { t_uscalar_t lso_flags; lso_basic_tcp_ipv4_t lso_basic_tcp_ipv4; /* Add future lso capabilities here */ } mac_capab_lso_t; typedef struct __mac_prop_info_handle *mac_prop_info_handle_t; /* * MAC driver entry point types. */ typedef int (*mac_getstat_t)(void *, uint_t, uint64_t *); typedef int (*mac_start_t)(void *); typedef void (*mac_stop_t)(void *); typedef int (*mac_setpromisc_t)(void *, boolean_t); typedef int (*mac_multicst_t)(void *, boolean_t, const uint8_t *); typedef int (*mac_unicst_t)(void *, const uint8_t *); typedef void (*mac_ioctl_t)(void *, queue_t *, mblk_t *); typedef void (*mac_resources_t)(void *); typedef mblk_t *(*mac_tx_t)(void *, mblk_t *); typedef boolean_t (*mac_getcapab_t)(void *, mac_capab_t, void *); typedef int (*mac_open_t)(void *); typedef void (*mac_close_t)(void *); typedef int (*mac_set_prop_t)(void *, const char *, mac_prop_id_t, uint_t, const void *); typedef int (*mac_get_prop_t)(void *, const char *, mac_prop_id_t, uint_t, void *); typedef void (*mac_prop_info_t)(void *, const char *, mac_prop_id_t, mac_prop_info_handle_t); /* * Driver callbacks. The following capabilities are optional, and if * implemented by the driver, must have a corresponding MC_ flag set * in the mc_callbacks field. * * Any future additions to this list must also be accompanied by an * associated mc_callbacks flag so that the framework can grow without * affecting the binary compatibility of the interface. */ typedef struct mac_callbacks_s { uint_t mc_callbacks; /* Denotes which callbacks are set */ mac_getstat_t mc_getstat; /* Get the value of a statistic */ mac_start_t mc_start; /* Start the device */ mac_stop_t mc_stop; /* Stop the device */ mac_setpromisc_t mc_setpromisc; /* Enable or disable promiscuous mode */ mac_multicst_t mc_multicst; /* Enable or disable a multicast addr */ mac_unicst_t mc_unicst; /* Set the unicast MAC address */ mac_tx_t mc_tx; /* Transmit a packet */ mac_ioctl_t mc_ioctl; /* Process an unknown ioctl */ void *mc_reserved1; /* Set to NULL */ mac_getcapab_t mc_getcapab; /* Get capability information */ mac_open_t mc_open; /* Open the device */ mac_close_t mc_close; /* Close the device */ mac_set_prop_t mc_setprop; mac_get_prop_t mc_getprop; mac_prop_info_t mc_propinfo; } mac_callbacks_t; /* * Flags for mc_callbacks. Requiring drivers to set the flags associated * with optional callbacks initialized in the structure allows the mac * module to add optional callbacks in the future without requiring drivers * to recompile. */ #define MC_IOCTL 0x0001 #define MC_GETCAPAB 0x0002 #define MC_OPEN 0x0004 #define MC_CLOSE 0x0008 #define MC_SETPROP 0x0010 #define MC_GETPROP 0x0020 #define MC_PROPINFO 0x0040 #define MC_PROPERTIES (MC_SETPROP | MC_GETPROP | MC_PROPINFO) /* * MAC registration interface */ typedef struct mac_register_s { uint_t m_version; /* set by mac_alloc() */ const char *m_type_ident; void *m_driver; /* Driver private data */ dev_info_t *m_dip; uint_t m_instance; uint8_t *m_src_addr; uint8_t *m_dst_addr; mac_callbacks_t *m_callbacks; uint_t m_min_sdu; uint_t m_max_sdu; void *m_pdata; size_t m_pdata_size; uint32_t m_margin; char **m_priv_props; } mac_register_t; /* * Driver interface functions. */ extern mac_register_t *mac_alloc(uint_t); extern void mac_free(mac_register_t *); extern int mac_register(mac_register_t *, mac_handle_t *); extern int mac_unregister(mac_handle_t); extern void mac_rx(mac_handle_t, mac_resource_handle_t, mblk_t *); extern void mac_link_update(mac_handle_t, link_state_t); extern void mac_tx_update(mac_handle_t); extern void mac_init_ops(struct dev_ops *, const char *); extern void mac_fini_ops(struct dev_ops *); extern int mac_group_add_ring(mac_group_handle_t, int); extern void mac_group_rem_ring(mac_group_handle_t, mac_ring_handle_t); extern void mac_prop_info_set_default_uint8( mac_prop_info_handle_t, uint8_t); extern void mac_prop_info_set_default_str( mac_prop_info_handle_t, const char *); extern void mac_prop_info_set_default_link_flowctrl( mac_prop_info_handle_t, link_flowctrl_t); extern void mac_prop_info_set_range_uint32( mac_prop_info_handle_t, uint32_t, uint32_t); extern void mac_prop_info_set_perm(mac_prop_info_handle_t, uint8_t); extern void mac_hcksum_get(mblk_t *, uint32_t *, uint32_t *, uint32_t *, uint32_t *); extern void mac_hcksum_set(mblk_t *, uint32_t, uint32_t, uint32_t, uint32_t); extern void mac_lso_get(mblk_t *, uint32_t *, uint32_t *); #endif /* _KERNEL */ #ifdef __cplusplus } #endif #endif /* _SYS_MAC_PROVIDER_H */