xref: /illumos-gate/usr/src/uts/common/io/xge/drv/xge.c (revision da14cebe)

/*
 * 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.
 */

/*
 *  Copyright (c) 2002-2005 Neterion, Inc.
 *  All right Reserved.
 *
 *  FileName :    xge.c
 *
 *  Description:  Xge main Solaris specific initialization & routines
 *		  for upper layer driver
 *
 */
#include "xgell.h"

static int xge_attach(dev_info_t *dev_info, ddi_attach_cmd_t cmd);
static int xge_detach(dev_info_t *dev_info, ddi_detach_cmd_t cmd);
static int xge_quiesce(dev_info_t *dev_info);

DDI_DEFINE_STREAM_OPS(xge_ops, nulldev, nulldev, xge_attach, xge_detach,
    nodev, NULL, D_MP, NULL, xge_quiesce);

/* Standard Module linkage initialization for a Streams driver */
extern struct mod_ops mod_driverops;

static struct modldrv modldrv = {
	&mod_driverops,		/* Type of module.  This one is a driver */
	XGELL_DESC,		/* short description */
	&xge_ops		/* driver specific ops */
};

static struct modlinkage modlinkage = {
	MODREV_1, {(void *)&modldrv, NULL}
};

/* Xge device attributes */
ddi_device_acc_attr_t xge_dev_attr = {
	DDI_DEVICE_ATTR_V0,
	DDI_NEVERSWAP_ACC,
	DDI_STRICTORDER_ACC
};
ddi_device_acc_attr_t *p_xge_dev_attr = &xge_dev_attr;

/*
 * xgell_callback_crit_err
 *
 * This function called by HAL on Serious Error event. XGE_HAL_EVENT_SERR.
 * Upper layer must analyze it based on %type.
 */
static void
xge_callback_crit_err(void *userdata, xge_hal_event_e type, u64 serr_data)
{
	(void) xgell_onerr_reset(userdata);
}

/*
 * xge_xpak_alarm_log
 * This function called by HAL on XPAK alarms. Upper layer must log the msg
 * based on the xpak alarm type
 */
static void
xge_xpak_alarm_log(void *userdata, xge_hal_xpak_alarm_type_e type)
{
	switch (type) {
	case XGE_HAL_XPAK_ALARM_EXCESS_TEMP:
		xge_debug_osdep(XGE_ERR, "%s", "Take Xframe NIC out of "
		    "service. Excessive temperatures may result in "
		    "premature transceiver failure \n");

		break;
	case XGE_HAL_XPAK_ALARM_EXCESS_BIAS_CURRENT:
		xge_debug_osdep(XGE_ERR, "%s", "Take Xframe NIC out of "
		    "service Excessive bias currents may indicate "
		    "imminent laser diode failure \n");

		break;
	case XGE_HAL_XPAK_ALARM_EXCESS_LASER_OUTPUT:
		xge_debug_osdep(XGE_ERR, "%s", "Take Xframe NIC out of "
		    "service Excessive laser output power may saturate "
		    "far-end receiver\n");

		break;
	default:
		xge_debug_osdep(XGE_ERR, "%s", "Undefined Xpak Alarm");
		break;
	}

}

/*
 * xge_driver_init_hal
 *
 * To initialize HAL portion of driver.
 */
static xge_hal_status_e
xge_driver_init_hal(void)
{
	static xge_hal_driver_config_t driver_config;
	xge_hal_uld_cbs_t uld_callbacks;

	driver_config.queue_size_initial = 1;
	driver_config.queue_size_max = 4;

	uld_callbacks.link_up = xgell_callback_link_up;
	uld_callbacks.link_down = xgell_callback_link_down;
	uld_callbacks.crit_err = xge_callback_crit_err;
	uld_callbacks.event = NULL;
	uld_callbacks.event_queued = NULL;
	uld_callbacks.before_device_poll = NULL;
	uld_callbacks.after_device_poll = NULL;
	uld_callbacks.sched_timer = NULL;
	uld_callbacks.xpak_alarm_log = xge_xpak_alarm_log;

	return (xge_hal_driver_initialize(&driver_config, &uld_callbacks));

}

/*
 * _init
 *
 * Solaris standard _init function for a device driver
 */
int
_init(void)
{
	int ret = 0;
	xge_hal_status_e status;

	status = xge_driver_init_hal();
	if (status != XGE_HAL_OK) {
		xge_debug_osdep(XGE_ERR, "can't initialize the driver (%d)",
		    status);
		return (EINVAL);
	}

	xge_hal_driver_debug_module_mask_set(0xffffffff);
	xge_hal_driver_debug_level_set(XGE_TRACE);

	mac_init_ops(&xge_ops, "xge");
	if ((ret = mod_install(&modlinkage)) != 0) {
		xge_hal_driver_terminate();
		mac_fini_ops(&xge_ops);
		xge_debug_osdep(XGE_ERR, "%s",
		    "Unable to install the driver");
		return (ret);
	}

	return (0);
}

/*
 * _fini
 *
 * Solaris standard _fini function for device driver
 */
int
_fini(void)
{
	int ret;

	ret = mod_remove(&modlinkage);
	if (ret == 0) {
		xge_hal_driver_terminate();
		mac_fini_ops(&xge_ops);
	}

	return (ret);
}

/*
 * _info
 *
 * Solaris standard _info function for device driver
 */
int
_info(struct modinfo *pModinfo)
{
	return (mod_info(&modlinkage, pModinfo));
}

/*
 * xge_isr
 * @arg: pointer to device private strucutre(hldev)
 *
 * This is the ISR scheduled by the OS to indicate to the
 * driver that the receive/transmit operation is completed.
 */
/* ARGSUSED */
static uint_t
xge_isr(caddr_t arg0, caddr_t arg1)
{
	xge_hal_status_e status;
	xge_hal_device_t *hldev = (xge_hal_device_t *)arg0;
	xgelldev_t *lldev = xge_hal_device_private(hldev);

	if (!lldev->is_initialized) {
		return (DDI_INTR_UNCLAIMED);
	}

	status = xge_hal_device_handle_irq(hldev);

	return ((status == XGE_HAL_ERR_WRONG_IRQ) ?
	    DDI_INTR_UNCLAIMED : DDI_INTR_CLAIMED);
}

/*
 * Interrupt handler for transmit when MSI-X interrupt mechasnism is used
 */
/* ARGSUSED */
static uint_t
xge_fifo_msix_isr(caddr_t arg0, caddr_t arg1)
{
	int got_tx;
	xge_hal_channel_t *channel = (xge_hal_channel_t *)arg0;
	xgelldev_t *lldev = xge_hal_device_private(channel->devh);

	if (!lldev->is_initialized) {
		return (DDI_INTR_UNCLAIMED);
	}
	(void) xge_hal_device_poll_tx_channel(channel, &got_tx);

	return (DDI_INTR_CLAIMED);
}

/*
 * Interrupt handler for receive when MSI-X interrupt mechasnism is used
 */
/* ARGSUSED */
static uint_t
xge_ring_msix_isr(caddr_t arg0, caddr_t arg1)
{
	int got_rx;
	xge_hal_channel_t *channel = (xge_hal_channel_t *)arg0;
	xgelldev_t *lldev = xge_hal_device_private(channel->devh);

	if (!lldev->is_initialized) {
		return (DDI_INTR_UNCLAIMED);
	}
	(void) xge_hal_device_poll_rx_channel(channel, &got_rx);

	return (DDI_INTR_CLAIMED);
}

/*
 * Configure single ring
 */
static void
xge_ring_config(dev_info_t *dev_info, xge_hal_device_config_t *device_config,
    int index)
{
	char msg[MSG_SIZE];

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_configured", index);
	device_config->ring.queue[index].configured =
	    ddi_prop_get_int(DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS,
	    msg, index < XGELL_RX_RING_NUM_MAX ? 1 : 0);

	/* no point to configure it further if unconfigured */
	if (!device_config->ring.queue[index].configured)
		return;

#if defined(__sparc)
	device_config->ring.queue[index].no_snoop_bits = 1;
#endif

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_max", index);
	device_config->ring.queue[index].max =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_USE_HARDCODE);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_initial", index);
	device_config->ring.queue[index].initial =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_USE_HARDCODE);

	if (device_config->ring.queue[index].initial ==
	    XGE_HAL_DEFAULT_USE_HARDCODE) {
		device_config->ring.queue[index].initial =
		    device_config->ring.queue[index].max =
		    XGE_HAL_DEFAULT_RING_QUEUE_BLOCKS;
	}

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_buffer_mode", index);
	device_config->ring.queue[index].buffer_mode =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_RING_QUEUE_BUFFER_MODE_DEFAULT);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_dram_size_mb", index);
	device_config->ring.queue[index].dram_size_mb =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_USE_HARDCODE);

	(void) xge_os_snprintf(msg, MSG_SIZE,
	    "ring%d_backoff_interval_us", index);
	device_config->ring.queue[index].backoff_interval_us =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_BACKOFF_INTERVAL_US);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_max_frm_len", index);
	device_config->ring.queue[index].max_frm_len =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_RING_USE_MTU);


	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_priority", index);
	device_config->ring.queue[index].priority =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RING_PRIORITY);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_urange_a", index);
	device_config->ring.queue[index].rti.urange_a =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RX_URANGE_A);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_ufc_a", index);
	device_config->ring.queue[index].rti.ufc_a =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RX_UFC_A);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_urange_b", index);
	device_config->ring.queue[index].rti.urange_b =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RX_URANGE_B);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_ufc_b", index);
	device_config->ring.queue[index].rti.ufc_b =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    device_config->mtu > XGE_HAL_DEFAULT_MTU ?
	    XGE_HAL_DEFAULT_RX_UFC_B_J:
	    XGE_HAL_DEFAULT_RX_UFC_B_N);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_urange_c", index);
	device_config->ring.queue[index].rti.urange_c =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RX_URANGE_C);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_ufc_c", index);
	device_config->ring.queue[index].rti.ufc_c =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    device_config->mtu > XGE_HAL_DEFAULT_MTU ?
	    XGE_HAL_DEFAULT_RX_UFC_C_J:
	    XGE_HAL_DEFAULT_RX_UFC_C_N);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_ufc_d", index);
	device_config->ring.queue[index].rti.ufc_d =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RX_UFC_D);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_timer_val", index);
	device_config->ring.queue[index].rti.timer_val_us =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RX_TIMER_VAL);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_timer_ac_en", index);
	device_config->ring.queue[index].rti.timer_ac_en =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_RX_TIMER_AC_EN);

	(void) xge_os_snprintf(msg, MSG_SIZE, "ring%d_indicate_max_pkts",
	    index);
	device_config->ring.queue[index].indicate_max_pkts =
	    ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    (device_config->bimodal_interrupts ?
	    XGE_HAL_DEFAULT_INDICATE_MAX_PKTS_B :
	    XGE_HAL_DEFAULT_INDICATE_MAX_PKTS_N));

	/*
	 * Enable RTH steering if needed HERE!!!!
	 */
	if (device_config->rth_en == XGE_HAL_RTH_ENABLE)
		device_config->ring.queue[index].rth_en = 1;
}

/*
 * Configure single fifo
 */
static void
xge_fifo_config(dev_info_t *dev_info, xge_hal_device_config_t *device_config,
    int index)
{
	char msg[MSG_SIZE];

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_configured", index);
	device_config->fifo.queue[index].configured =
	    ddi_prop_get_int(DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS,
	    msg, index < XGELL_TX_RING_NUM_MAX ? 1 : 0);

	/* no point to configure it further */
	if (!device_config->fifo.queue[index].configured)
		return;

#if defined(__sparc)
	device_config->fifo.queue[index].no_snoop_bits = 1;
#endif

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_max", index);
	device_config->fifo.queue[index].max = ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_USE_HARDCODE);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_initial", index);
	device_config->fifo.queue[index].initial =
	    ddi_prop_get_int(DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_USE_HARDCODE);

#if 0
	if (device_config->fifo.queue[index].initial ==
	    XGE_HAL_DEFAULT_USE_HARDCODE) {
		if (device_config->mtu > XGE_HAL_DEFAULT_MTU) {
			device_config->fifo.queue[index].initial =
			    device_config->fifo.queue[index].max =
			    XGE_HAL_DEFAULT_FIFO_QUEUE_LENGTH_J;
		} else {
			device_config->fifo.queue[index].initial =
			    device_config->fifo.queue[index].max =
			    XGE_HAL_DEFAULT_FIFO_QUEUE_LENGTH_N;
		}
	}
#else
	if (device_config->fifo.queue[index].initial ==
	    XGE_HAL_DEFAULT_USE_HARDCODE) {
		device_config->fifo.queue[index].max =
		    device_config->fifo.queue[index].initial =
		    XGE_HAL_DEFAULT_FIFO_QUEUE_LENGTH_A;
	}
#endif

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_intr", index);
	device_config->fifo.queue[index].intr = ddi_prop_get_int(DDI_DEV_T_ANY,
	    dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_FIFO_QUEUE_INTR);

	/*
	 * TTI 0 configuration
	 */
	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_enable", index);
	device_config->fifo.queue[index].tti[index].enabled = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg, 1);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_urange_a", index);
	device_config->fifo.queue[index].tti[index].urange_a = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_URANGE_A);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_ufc_a", index);
	device_config->fifo.queue[index].tti[index].ufc_a = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_UFC_A);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_urange_b", index);
	device_config->fifo.queue[index].tti[index].urange_b = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_URANGE_B);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_ufc_b", index);
	device_config->fifo.queue[index].tti[index].ufc_b = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_UFC_B);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_urange_c", index);
	device_config->fifo.queue[index].tti[index].urange_c = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_URANGE_C);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_ufc_c", index);
	device_config->fifo.queue[index].tti[index].ufc_c = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_UFC_C);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_ufc_d", index);
	device_config->fifo.queue[index].tti[index].ufc_d = ddi_prop_get_int(
	    DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_UFC_D);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_timer_ac_en", index);
	device_config->fifo.queue[index].tti[index].timer_ac_en =
	    ddi_prop_get_int(DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_TIMER_AC_EN);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_timer_val", index);
	device_config->fifo.queue[index].tti[index].timer_val_us =
	    ddi_prop_get_int(DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_TIMER_VAL);

	(void) xge_os_snprintf(msg, MSG_SIZE, "fifo%d_tti_timer_ci_en", index);
	device_config->fifo.queue[index].tti[index].timer_ci_en =
	    ddi_prop_get_int(DDI_DEV_T_ANY, dev_info, DDI_PROP_DONTPASS, msg,
	    XGE_HAL_DEFAULT_TX_TIMER_CI_EN);
}

/*
 * xge_configuration_init
 * @device_config: pointer to xge_hal_device_config_t
 *
 * This function will lookup properties from .conf file to init
 * the configuration data structure. If a property is not in .conf
 * file, the default value should be set.
 */
static void
xge_configuration_init(dev_info_t *dev_info,
    xge_hal_device_config_t *device_config, xgell_config_t *xgell_config)
{
	int i, rings_configured = 0, fifos_configured = 0;

	/*
	 * Initialize link layer configuration first
	 */
	xgell_config->rx_dma_lowat = ddi_prop_get_int(DDI_DEV_T_ANY, dev_info,
	    DDI_PROP_DONTPASS, "rx_dma_lowat", XGELL_RX_DMA_LOWAT);
	xgell_config->rx_pkt_burst = ddi_prop_get_int(DDI_DEV_T_ANY,