common/sys/mac_impl.h

	mac_impl.h revision e7801d59e8ceda0cde8ebdfdddd7582ee2ea96ef
/*
 * 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 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _SYS_MAC_IMPL_H
#define _SYS_MAC_IMPL_H

#pragma ident   "%Z%%M% %I% %E% SMI"

#include <sys/mac.h>
#include <net/if.h>

#ifdef  __cplusplus
extern "C" {
#endif

typedef struct mac_multicst_addr_s  mac_multicst_addr_t;

struct mac_multicst_addr_s {
    mac_multicst_addr_t *mma_nextp;
    uint_t          mma_ref;
    uint8_t         mma_addr[MAXMACADDRLEN];
};

typedef struct mac_margin_req_s mac_margin_req_t;

struct mac_margin_req_s {
    mac_margin_req_t    *mmr_nextp;
    uint_t          mmr_ref;
    uint32_t        mmr_margin;
};

typedef struct mac_notify_fn_s      mac_notify_fn_t;

struct mac_notify_fn_s {
    mac_notify_fn_t     *mnf_nextp;
    mac_notify_t        mnf_fn;
    void            *mnf_arg;
};

typedef struct mac_rx_fn_s      mac_rx_fn_t;

struct mac_rx_fn_s {
    mac_rx_fn_t     *mrf_nextp;
    mac_rx_t        mrf_fn;
    void            *mrf_arg;
    boolean_t       mrf_inuse;
    boolean_t       mrf_active;
};

typedef struct mac_txloop_fn_s      mac_txloop_fn_t;

struct mac_txloop_fn_s {
    mac_txloop_fn_t     *mtf_nextp;
    mac_txloop_t        mtf_fn;
    void            *mtf_arg;
};

typedef struct mactype_s {
    const char  *mt_ident;
    uint32_t    mt_ref;
    uint_t      mt_type;
    uint_t      mt_nativetype;
    size_t      mt_addr_length;
    uint8_t     *mt_brdcst_addr;
    mactype_ops_t   mt_ops;
    mac_stat_info_t *mt_stats;  /* array of mac_stat_info_t elements */
    size_t      mt_statcount;   /* number of elements in mt_stats */
} mactype_t;


#define MAC_VNIC_TXINFO_REFHOLD(mvt) {              \
    mutex_enter(&(mvt)->mv_lock);               \
    (mvt)->mv_refs++;                   \
    mutex_exit(&(mvt)->mv_lock);                \
}

#define MAC_VNIC_TXINFO_REFRELE(mvt) {              \
    mutex_enter(&(mvt)->mv_lock);               \
    if (--(mvt)->mv_refs == 0 && (mvt)->mv_clearing) {  \
        (mvt)->mv_clearing = B_FALSE;           \
        cv_signal(&(mvt)->mv_cv);               \
    }                           \
    mutex_exit(&(mvt)->mv_lock);                \
}

typedef struct mac_vnic_tx_s {
    mac_txinfo_t    mv_txinfo;  /* provided by VNIC */
    uint32_t    mv_refs;
    kmutex_t    mv_lock;
    kcondvar_t  mv_cv;
    boolean_t   mv_clearing;
} mac_vnic_tx_t;

/*
 * Each registered MAC is associated with a mac_t structure.
 */
typedef struct mac_impl_s {
    /*
     * The following fields are set in mac_register() and will not be
     * changed until mac_unregister(). No lock is needed to access them.
     */
    char            mi_name[LIFNAMSIZ];
    void            *mi_driver; /* Driver private data */
    mac_info_t      mi_info;
    mactype_t       *mi_type;
    void            *mi_pdata;
    size_t          mi_pdata_size;
    mac_callbacks_t     *mi_callbacks;
    dev_info_t      *mi_dip;
    minor_t         mi_minor;
    dev_t           mi_phy_dev;
    kstat_t         *mi_ksp;
    uint_t          mi_kstat_count;
    mac_txinfo_t        mi_txinfo;
    mac_txinfo_t        mi_txloopinfo;

    krwlock_t       mi_gen_lock;
    uint32_t        mi_oref;
    uint32_t        mi_ref;
    boolean_t       mi_disabled;
    boolean_t       mi_exclusive;

    krwlock_t       mi_state_lock;
    uint_t          mi_active;

    krwlock_t       mi_data_lock;
    link_state_t        mi_linkstate;
    link_state_t        mi_lastlinkstate;
    uint_t          mi_promisc;
    uint_t          mi_devpromisc;
    uint8_t         mi_addr[MAXMACADDRLEN];
    uint8_t         mi_dstaddr[MAXMACADDRLEN];
    uint_t          mi_sdu_min;
    uint_t          mi_sdu_max;
    mac_multicst_addr_t *mi_mmap;

    krwlock_t       mi_notify_lock;
    uint32_t        mi_notify_bits;
    kmutex_t        mi_notify_bits_lock;
    kthread_t       *mi_notify_thread;
    mac_notify_fn_t     *mi_mnfp;
    kcondvar_t      mi_notify_cv;

    krwlock_t       mi_rx_lock;
    mac_rx_fn_t     *mi_mrfp;
    krwlock_t       mi_tx_lock;
    mac_txloop_fn_t     *mi_mtfp;

    krwlock_t       mi_resource_lock;
    mac_resource_add_t  mi_resource_add;
    void            *mi_resource_add_arg;

    kmutex_t        mi_activelink_lock;
    boolean_t       mi_activelink;

    uint32_t        mi_rx_ref;  /* #threads in mac_rx() */
    uint32_t        mi_rx_removed;  /* #callbacks marked */
                        /* for removal */
    kmutex_t        mi_lock;
    kcondvar_t      mi_rx_cv;
    boolean_t       mi_shareable;
    boolean_t       mi_vnic_present;
    mac_vnic_tx_t       *mi_vnic_tx;
    mac_txinfo_t        mi_vnic_txinfo;
    mac_txinfo_t        mi_vnic_txloopinfo;
    mac_getcapab_t      mi_vnic_getcapab_fn;
    void            *mi_vnic_getcapab_arg;

    boolean_t       mi_legacy;
    uint32_t        mi_unsup_note;
    uint32_t        mi_margin;

    /*
     * List of margin value requests added by mac clients. This list is
     * sorted: the first one has the greatest value.
     */
    mac_margin_req_t    *mi_mmrp;
} mac_impl_t;

#define mi_getstat  mi_callbacks->mc_getstat
#define mi_start    mi_callbacks->mc_start
#define mi_stop     mi_callbacks->mc_stop
#define mi_open     mi_callbacks->mc_open
#define mi_close    mi_callbacks->mc_close
#define mi_setpromisc   mi_callbacks->mc_setpromisc
#define mi_multicst mi_callbacks->mc_multicst
#define mi_unicst   mi_callbacks->mc_unicst
#define mi_resources    mi_callbacks->mc_resources
#define mi_tx       mi_callbacks->mc_tx
#define mi_ioctl    mi_callbacks->mc_ioctl
#define mi_getcapab mi_callbacks->mc_getcapab

extern void mac_init(void);
extern int  mac_fini(void);

extern void mac_stat_create(mac_impl_t *);
extern void mac_stat_destroy(mac_impl_t *);
extern uint64_t mac_stat_default(mac_impl_t *, uint_t);

#ifdef  __cplusplus
}
#endif

#endif  /* _SYS_MAC_IMPL_H */