softmac_impl.h revision bd670b35a010421b6e1a5536c34453a827007c81
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * CDDL HEADER START
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * The contents of this file are subject to the terms of the
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * Common Development and Distribution License (the "License").
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * You may not use this file except in compliance with the License.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * See the License for the specific language governing permissions
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * and limitations under the License.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * When distributing Covered Code, include this CDDL HEADER in each
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * If applicable, add the following below this CDDL HEADER, with the
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * fields enclosed by brackets "[]" replaced with your own identifying
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * information: Portions Copyright [yyyy] [name of copyright owner]
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * CDDL HEADER END
6504182088d3042177dc001b147152e7c07756d5Cathy Zhou * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * Use is subject to license terms.
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern "C" {
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhoutypedef void (*softmac_rx_t)(void *, mac_resource_handle_t, mblk_t *,
d62bc4badc1c1f1549c961cfb8b420e650e1272byztypedef struct softmac_lower_s {
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * When a control message is processed, either sl_pending_prim or
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * sl_pending_ioctl will be set. They will be cleared when the
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * acknowledgement of the specific control message is received
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * from the underlying legacy driver.
da14cebe459d3275048785f25bd869cb09b5307fEric Chengtypedef enum {
da14cebe459d3275048785f25bd869cb09b5307fEric Chengtypedef enum {
d62bc4badc1c1f1549c961cfb8b420e650e1272byztypedef struct softmac_dev_s {
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * smac_flag values.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * The softmac structure allows all minor nodes (at most two, style-1 and
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * style-2) for the same device to be processed. A softmac_dev_t will be
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * created for each minor node.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * We try to "register" the mac after all the softmac_dev_t's are processed so
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * that even if DLPI operations fail (because of driver bugs) for one minor
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * node, the other minor node can still be used to register the mac.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * (Specifically, an incorrect xxx_getinfo() implementation will cause style-2
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * minor node mac registration to fail.)
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Locking description:
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * WO: write once, valid the life time.
d62bc4badc1c1f1549c961cfb8b420e650e1272byztypedef struct softmac {
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * The smac_hold_cnt field increases when softmac_hold_device() is
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * called to force the dls_vlan_t of the device to be created. The
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * device pre-detach fails if this counter is not 0.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * Number of minor nodes whose post-attach routine has succeeded.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * This should be the same as the numbers of softmac_dev_t.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * Note that it does not imply SOFTMAC_ATTACH_DONE as the taskq might
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * be still ongoing.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * Number of softmac_dev_t left when pre-detach fails. This is used
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * to indicate whether postattach is called because of a failed
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * pre-detach.
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng * Thread handles the DL_NOTIFY_IND message from the lower stream.
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng * Head and tail of the DL_NOTIFY_IND messsages.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * The remaining fields are used to register the MAC for a legacy
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * device. They are set in softmac_mac_register() and do not change.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * One can access them when mac_register() is done without locks.
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * media type is needed for create <link name, linkid> mapping, so
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * it is set for GLDv3 device as well
d62bc4badc1c1f1549c961cfb8b420e650e1272byz /* DLPI style of the underlying device */
d62bc4badc1c1f1549c961cfb8b420e650e1272byz /* Notifications the underlying driver can support. */
d62bc4badc1c1f1549c961cfb8b420e650e1272byz * Capabilities of the underlying driver.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Lower stream structure, accessed by the MAC provider API. The GLDv3
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * framework assures it's validity.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Set by xxx_active_set() when aggregation is created.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Numbers of the bounded streams in the fast-path mode.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * numbers of clients that request to disable fastpath.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou uint32_t smac_fp_disable_clients; /* smac_fp_mutex */
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou boolean_t smac_fastpath_admin_disabled; /* smac_fp_mutex */
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * stream list over this softmac.
d62bc4badc1c1f1549c961cfb8b420e650e1272byztypedef struct smac_ioc_start_s {
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * The su_mode of a non-IP/ARP stream is UNKNOWN, and the su_mode of an IP/ARP
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * stream is either SLOWPATH or FASTPATH.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou (softmac)->smac_fastpath_admin_disabled) ? SOFTMAC_SLOWPATH : \
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Locking description:
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * WO: Set once and valid for life;
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * SL: Serialized by the control path (softmac_wput_nondata_task())
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhoutypedef struct softmac_upper_s {
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * List of upper streams that has pending DLPI messages to be processed.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou list_node_t su_taskq_list_node; /* softmac_taskq_lock */
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * non-NULL for IP/ARP streams in the fast-path mode
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * List of all IP/ARP upperstreams on the same softmac (including
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * the ones in both data-path modes).
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * List of datapath switch requests.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Place holder of RX callbacks used to handles data messages comes
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * from the dedicated-lower-stream associated with the IP/ARP stream.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Another RX callback is softmac_drop_rxinfo, which is a global
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou softmac_lower_rxinfo_t su_direct_rxinfo; /* WO */
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Used to serialize the DLPI operation and fastpath<->slowpath
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * switching over operation.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Used for fastpath data path.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Number of softmac_srv() operation in fastpath processing.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * SOFTMAC_SLOWPATH or SOFTMAC_FASTPATH
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Whether this stream is already scheduled in softmac_taskq_list.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou boolean_t su_taskq_scheduled; /* softmac_taskq_lock */
79eeb64527c881659e23b60088c32ae3736a7a2cCathy Zhou * The DLD_CAPAB_DIRECT related notify callback.
79eeb64527c881659e23b60088c32ae3736a7a2cCathy Zhou mac_tx_notify_t su_tx_notify_func; /* su_mutex */
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou (sup)->su_pending_head = (sup)->su_pending_tail = (mp); \
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou if (((sup)->su_pending_head = (*(mpp))->b_next) == NULL)\
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * A macro to check whether the write-queue of the lower stream is full
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * and packets need to be enqueued.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * Because softmac is pushed right above the underlying device and
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * _I_INSERT/_I_REMOVE is not processed in the lower stream, it is
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou * safe to directly access the q_next pointer.
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhou (!((q)->q_next->q_nfsrv->q_flag & QFULL) || canput((q)->q_next))
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern int softmac_send_bind_req(softmac_lower_t *, uint_t);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern int softmac_send_unbind_req(softmac_lower_t *);
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern int softmac_send_notify_req(softmac_lower_t *, uint32_t);
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern int softmac_send_promisc_req(softmac_lower_t *, t_uscalar_t,
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern void softmac_rput_process_notdata(queue_t *, softmac_upper_t *,
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern void softmac_rput_process_data(softmac_lower_t *, mblk_t *);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern int softmac_output(softmac_lower_t *, mblk_t *, t_uscalar_t,
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern int softmac_mexchange_error_ack(mblk_t **, t_uscalar_t,
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern int softmac_m_multicst(void *, boolean_t, const uint8_t *);
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern int softmac_proto_tx(softmac_lower_t *, mblk_t *, mblk_t **);
d62bc4badc1c1f1549c961cfb8b420e650e1272byzextern void softmac_ioctl_tx(softmac_lower_t *, mblk_t *, mblk_t **);
da14cebe459d3275048785f25bd869cb09b5307fEric Chengextern void softmac_notify_thread(void *);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern int softmac_lower_setup(softmac_t *, softmac_upper_t *,
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern void softmac_active_clear(void *);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern int softmac_fastpath_disable(void *);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern void softmac_fastpath_enable(void *);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern int softmac_datapath_switch(softmac_t *, boolean_t, boolean_t);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern void softmac_wput_data(softmac_upper_t *, mblk_t *);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern void softmac_wput_nondata(softmac_upper_t *, mblk_t *);
5d460eafffba936e81c4dd5ebe0f59b238f09121Cathy Zhouextern void softmac_upperstream_close(softmac_upper_t *);
d62bc4badc1c1f1549c961cfb8b420e650e1272byz#endif /* _SYS_SOFTMAC_IMPL_H */