Intel MIC Card Driver for X100 family.

	  More information about the Intel MIC family as well as the Linux

	  OS and tools for MIC to use with this driver are available from

	  <http://software.intel.com/en-us/mic-developer>.

comment "Intel MIC Card Driver"

config INTEL_MIC_CARD

	tristate "Intel MIC Card Driver"

	depends on 64BIT

	default N

	help

	  This enables card driver support for the Intel Many Integrated

	  Core (MIC) device family. The card driver communicates shutdown/

	  crash events to the host and allows registration/configuration of

	  virtio devices. Intel MIC X100 devices are currently supported.

	  If you are building a card kernel for an Intel MIC device then

	  say M (recommended) or Y, else say N. If unsure say N.

	  For more information see

	  <http://software.intel.com/en-us/mic-developer>.

# Copyright(c) 2013, Intel Corporation.

#

obj-$(CONFIG_INTEL_MIC_HOST) += host/

obj-$(CONFIG_INTEL_MIC_CARD) += card/

#

# Makefile - Intel MIC Linux driver.

# Copyright(c) 2013, Intel Corporation.

#

ccflags-y += -DINTEL_MIC_CARD

obj-$(CONFIG_INTEL_MIC_CARD) += mic_card.o

mic_card-y += mic_x100.o

mic_card-y += mic_device.o

mic_card-y += mic_debugfs.o

/*

 * Intel MIC Platform Software Stack (MPSS)

 *

 * Copyright(c) 2013 Intel Corporation.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License, version 2, as

 * published by the Free Software Foundation.

 *

 * This program is distributed in the hope that it will be useful, but

 * WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

 * General Public License for more details.

 *

 * The full GNU General Public License is included in this distribution in

 * the file called "COPYING".

 *

 * Disclaimer: The codes contained in these modules may be specific to

 * the Intel Software Development Platform codenamed: Knights Ferry, and

 * the Intel product codenamed: Knights Corner, and are not backward

 * compatible with other Intel products. Additionally, Intel will NOT

 * support the codes or instruction set in future products.

 *

 * Intel MIC Card driver.

 *

 */

#include <linux/debugfs.h>

#include <linux/delay.h>

#include <linux/seq_file.h>

#include <linux/interrupt.h>

#include <linux/device.h>

#include "../common/mic_device.h"

#include "mic_device.h"

/* Debugfs parent dir */

static struct dentry *mic_dbg;

/**

 * mic_intr_test - Send interrupts to host.

 */

static int mic_intr_test(struct seq_file *s, void *unused)

{

	struct mic_driver *mdrv = s->private;

	struct mic_device *mdev = &mdrv->mdev;

	mic_send_intr(mdev, 0);

	msleep(1000);

	mic_send_intr(mdev, 1);

	msleep(1000);

	mic_send_intr(mdev, 2);

	msleep(1000);

	mic_send_intr(mdev, 3);

	msleep(1000);

	return 0;

}

static int mic_intr_test_open(struct inode *inode, struct file *file)

{

	return single_open(file, mic_intr_test, inode->i_private);

}

static int mic_intr_test_release(struct inode *inode, struct file *file)

{

	return single_release(inode, file);

}

static const struct file_operations intr_test_ops = {

	.owner   = THIS_MODULE,

	.open    = mic_intr_test_open,

	.read    = seq_read,

	.llseek  = seq_lseek,

	.release = mic_intr_test_release

};

/**

 * mic_create_card_debug_dir - Initialize MIC debugfs entries.

 */

void __init mic_create_card_debug_dir(struct mic_driver *mdrv)

{

	struct dentry *d;

	if (!mic_dbg)

		return;

	mdrv->dbg_dir = debugfs_create_dir(mdrv->name, mic_dbg);

	if (!mdrv->dbg_dir) {

		dev_err(mdrv->dev, "Cant create dbg_dir %s\n", mdrv->name);

		return;

	}

	d = debugfs_create_file("intr_test", 0444, mdrv->dbg_dir,

		mdrv, &intr_test_ops);

	if (!d) {

		dev_err(mdrv->dev,

			"Cant create dbg intr_test %s\n", mdrv->name);

		return;

	}

}

/**

 * mic_delete_card_debug_dir - Uninitialize MIC debugfs entries.

 */

void mic_delete_card_debug_dir(struct mic_driver *mdrv)

{

	if (!mdrv->dbg_dir)

		return;

	debugfs_remove_recursive(mdrv->dbg_dir);

}

/**

 * mic_init_card_debugfs - Initialize global debugfs entry.

 */

void __init mic_init_card_debugfs(void)

{

	mic_dbg = debugfs_create_dir(KBUILD_MODNAME, NULL);

	if (!mic_dbg)

		pr_err("can't create debugfs dir\n");

}

/**

 * mic_exit_card_debugfs - Uninitialize global debugfs entry

 */

void mic_exit_card_debugfs(void)

{

	debugfs_remove(mic_dbg);

}

/*

 * Intel MIC Platform Software Stack (MPSS)

 *

 * Copyright(c) 2013 Intel Corporation.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License, version 2, as

 * published by the Free Software Foundation.

 *

 * This program is distributed in the hope that it will be useful, but

 * WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

 * General Public License for more details.

 *

 * The full GNU General Public License is included in this distribution in

 * the file called "COPYING".

 *

 * Disclaimer: The codes contained in these modules may be specific to

 * the Intel Software Development Platform codenamed: Knights Ferry, and

 * the Intel product codenamed: Knights Corner, and are not backward

 * compatible with other Intel products. Additionally, Intel will NOT

 * support the codes or instruction set in future products.

 *

 * Intel MIC Card driver.

 *

 */

#include <linux/module.h>

#include <linux/pci.h>

#include <linux/interrupt.h>

#include <linux/reboot.h>

#include <linux/mic_common.h>

#include "../common/mic_device.h"

#include "mic_device.h"

static struct mic_driver *g_drv;

static struct mic_irq *shutdown_cookie;

static void mic_notify_host(u8 state)

{

	struct mic_driver *mdrv = g_drv;

	struct mic_bootparam __iomem *bootparam = mdrv->dp;

	iowrite8(state, &bootparam->shutdown_status);

	dev_dbg(mdrv->dev, "%s %d system_state %d\n",

		__func__, __LINE__, state);

	mic_send_intr(&mdrv->mdev, ioread8(&bootparam->c2h_shutdown_db));

}

static int mic_panic_event(struct notifier_block *this, unsigned long event,

		void *ptr)

{

	struct mic_driver *mdrv = g_drv;

	struct mic_bootparam __iomem *bootparam = mdrv->dp;

	iowrite8(-1, &bootparam->h2c_config_db);

	iowrite8(-1, &bootparam->h2c_shutdown_db);

	mic_notify_host(MIC_CRASHED);

	return NOTIFY_DONE;

}

static struct notifier_block mic_panic = {

	.notifier_call  = mic_panic_event,

};

static irqreturn_t mic_shutdown_isr(int irq, void *data)

{

	struct mic_driver *mdrv = g_drv;

	struct mic_bootparam __iomem *bootparam = mdrv->dp;

	mic_ack_interrupt(&g_drv->mdev);

	if (ioread8(&bootparam->shutdown_card))

		orderly_poweroff(true);

	return IRQ_HANDLED;

}

static int mic_shutdown_init(void)

{

	int rc = 0;

	struct mic_driver *mdrv = g_drv;

	struct mic_bootparam __iomem *bootparam = mdrv->dp;

	int shutdown_db;

	shutdown_db = mic_next_card_db();

	shutdown_cookie = mic_request_card_irq(mic_shutdown_isr,

			"Shutdown", mdrv, shutdown_db);

	if (IS_ERR(shutdown_cookie))

		rc = PTR_ERR(shutdown_cookie);

	else

		iowrite8(shutdown_db, &bootparam->h2c_shutdown_db);

	return rc;

}

static void mic_shutdown_uninit(void)

{

	struct mic_driver *mdrv = g_drv;

	struct mic_bootparam __iomem *bootparam = mdrv->dp;

	iowrite8(-1, &bootparam->h2c_shutdown_db);

	mic_free_card_irq(shutdown_cookie, mdrv);

}

static int __init mic_dp_init(void)

{

	struct mic_driver *mdrv = g_drv;

	struct mic_device *mdev = &mdrv->mdev;

	struct mic_bootparam __iomem *bootparam;

	u64 lo, hi, dp_dma_addr;

	u32 magic;

	lo = mic_read_spad(&mdrv->mdev, MIC_DPLO_SPAD);

	hi = mic_read_spad(&mdrv->mdev, MIC_DPHI_SPAD);

	dp_dma_addr = lo | (hi << 32);

	mdrv->dp = mic_card_map(mdev, dp_dma_addr, MIC_DP_SIZE);

	if (!mdrv->dp) {

		dev_err(mdrv->dev, "Cannot remap Aperture BAR\n");

		return -ENOMEM;

	}

	bootparam = mdrv->dp;

	magic = ioread32(&bootparam->magic);

	if (MIC_MAGIC != magic) {

		dev_err(mdrv->dev, "bootparam magic mismatch 0x%x\n", magic);

		return -EIO;

	}

	return 0;

}

/* Uninitialize the device page */

static void mic_dp_uninit(void)

{

	mic_card_unmap(&g_drv->mdev, g_drv->dp);

}

/**

 * mic_request_card_irq - request an irq.

 *

 * @func: The callback function that handles the interrupt.

 * @name: The ASCII name of the callee requesting the irq.

 * @data: private data that is returned back when calling the

 * function handler.

 * @index: The doorbell index of the requester.

 *

 * returns: The cookie that is transparent to the caller. Passed

 * back when calling mic_free_irq. An appropriate error code

 * is returned on failure. Caller needs to use IS_ERR(return_val)

 * to check for failure and PTR_ERR(return_val) to obtained the

 * error code.

 *

 */

struct mic_irq *mic_request_card_irq(irqreturn_t (*func)(int irq, void *data),

	const char *name, void *data, int index)

{

	int rc = 0;

	unsigned long cookie;

	struct mic_driver *mdrv = g_drv;

	rc  = request_irq(mic_db_to_irq(mdrv, index), func,

		0, name, data);

	if (rc) {

		dev_err(mdrv->dev, "request_irq failed rc = %d\n", rc);

		goto err;

	}

	mdrv->irq_info.irq_usage_count[index]++;

	cookie = index;

	return (struct mic_irq *)cookie;

err:

	return ERR_PTR(rc);

}

/**

 * mic_free_card_irq - free irq.

 *

 * @cookie: cookie obtained during a successful call to mic_request_irq

 * @data: private data specified by the calling function during the

 * mic_request_irq

 *

 * returns: none.

 */

void mic_free_card_irq(struct mic_irq *cookie, void *data)

{

	int index;

	struct mic_driver *mdrv = g_drv;

	index = (unsigned long)cookie & 0xFFFFU;

	free_irq(mic_db_to_irq(mdrv, index), data);

	mdrv->irq_info.irq_usage_count[index]--;

}

/**

 * mic_next_card_db - Get the doorbell with minimum usage count.

 *

 * Returns the irq index.

 */

int mic_next_card_db(void)

{

	int i;

	int index = 0;

	struct mic_driver *mdrv = g_drv;

	for (i = 0; i < mdrv->intr_info.num_intr; i++) {

		if (mdrv->irq_info.irq_usage_count[i] <

			mdrv->irq_info.irq_usage_count[index])

			index = i;

	}

	return index;

}

/**

 * mic_init_irq - Initialize irq information.

 *

 * Returns 0 in success. Appropriate error code on failure.

 */

static int mic_init_irq(void)

{

	struct mic_driver *mdrv = g_drv;

	mdrv->irq_info.irq_usage_count = kzalloc((sizeof(u32) *

			mdrv->intr_info.num_intr),

			GFP_KERNEL);

	if (!mdrv->irq_info.irq_usage_count)

		return -ENOMEM;

	return 0;

}

/**

 * mic_uninit_irq - Uninitialize irq information.

 *

 * None.

 */

static void mic_uninit_irq(void)

{

	struct mic_driver *mdrv = g_drv;

	kfree(mdrv->irq_info.irq_usage_count);

}

/*

 * mic_driver_init - MIC driver initialization tasks.

 *

 * Returns 0 in success. Appropriate error code on failure.

 */

int __init mic_driver_init(struct mic_driver *mdrv)

{

	int rc;

	g_drv = mdrv;

	/*

	 * Unloading the card module is not supported. The MIC card module

	 * handles fundamental operations like host/card initiated shutdowns

	 * and informing the host about card crashes and cannot be unloaded.

	 */

	if (!try_module_get(mdrv->dev->driver->owner)) {

		rc = -ENODEV;

		goto done;

	}

	rc = mic_dp_init();

	if (rc)

		goto put;

	rc = mic_init_irq();

	if (rc)

		goto dp_uninit;

	rc = mic_shutdown_init();

	if (rc)

		goto irq_uninit;

	mic_create_card_debug_dir(mdrv);

	atomic_notifier_chain_register(&panic_notifier_list, &mic_panic);

done:

	return rc;

irq_uninit:

	mic_uninit_irq();

dp_uninit:

	mic_dp_uninit();

put:

	module_put(mdrv->dev->driver->owner);

	return rc;

}

/*

 * mic_driver_uninit - MIC driver uninitialization tasks.

 *

 * Returns None

 */

void mic_driver_uninit(struct mic_driver *mdrv)

{

	mic_delete_card_debug_dir(mdrv);

	/*

	 * Inform the host about the shutdown status i.e. poweroff/restart etc.

	 * The module cannot be unloaded so the only code path to call

	 * mic_devices_uninit(..) is the shutdown callback.

	 */

	mic_notify_host(system_state);

	mic_shutdown_uninit();

	mic_uninit_irq();

	mic_dp_uninit();

	module_put(mdrv->dev->driver->owner);

}