2 * Intel MIC Platform Software Stack (MPSS)
4 * Copyright(c) 2013 Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2, as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * The full GNU General Public License is included in this distribution in
16 * the file called "COPYING".
18 * Disclaimer: The codes contained in these modules may be specific to
19 * the Intel Software Development Platform codenamed: Knights Ferry, and
20 * the Intel product codenamed: Knights Corner, and are not backward
21 * compatible with other Intel products. Additionally, Intel will NOT
22 * support the codes or instruction set in future products.
24 * Intel MIC Card driver.
27 #include <linux/module.h>
28 #include <linux/pci.h>
29 #include <linux/platform_device.h>
31 #include "../common/mic_dev.h"
32 #include "mic_device.h"
35 static const char mic_driver_name[] = "mic";
37 static struct mic_driver g_drv;
40 * mic_read_spad - read from the scratchpad register
41 * @mdev: pointer to mic_device instance
42 * @idx: index to scratchpad register, 0 based
44 * This function allows reading of the 32bit scratchpad register.
46 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
48 u32 mic_read_spad(struct mic_device *mdev, unsigned int idx)
50 return mic_mmio_read(&mdev->mmio,
51 MIC_X100_SBOX_BASE_ADDRESS +
52 MIC_X100_SBOX_SPAD0 + idx * 4);
56 * __mic_send_intr - Send interrupt to Host.
57 * @mdev: pointer to mic_device instance
58 * @doorbell: Doorbell number.
60 void mic_send_intr(struct mic_device *mdev, int doorbell)
62 struct mic_mw *mw = &mdev->mmio;
64 if (doorbell > MIC_X100_MAX_DOORBELL_IDX)
66 /* Ensure that the interrupt is ordered w.r.t previous stores. */
68 mic_mmio_write(mw, MIC_X100_SBOX_SDBIC0_DBREQ_BIT,
69 MIC_X100_SBOX_BASE_ADDRESS +
70 (MIC_X100_SBOX_SDBIC0 + (4 * doorbell)));
74 * mic_ack_interrupt - Device specific interrupt handling.
75 * @mdev: pointer to mic_device instance
77 * Returns: bitmask of doorbell events triggered.
79 u32 mic_ack_interrupt(struct mic_device *mdev)
84 static inline int mic_get_sbox_irq(int db)
86 return MIC_X100_IRQ_BASE + db;
89 static inline int mic_get_rdmasr_irq(int index)
91 return MIC_X100_RDMASR_IRQ_BASE + index;
95 * mic_hw_intr_init - Initialize h/w specific interrupt
97 * @mdrv: pointer to mic_driver
99 void mic_hw_intr_init(struct mic_driver *mdrv)
101 mdrv->intr_info.num_intr = MIC_X100_NUM_SBOX_IRQ +
102 MIC_X100_NUM_RDMASR_IRQ;
106 * mic_db_to_irq - Retrieve irq number corresponding to a doorbell.
107 * @mdrv: pointer to mic_driver
108 * @db: The doorbell obtained for which the irq is needed. Doorbell
109 * may correspond to an sbox doorbell or an rdmasr index.
111 * Returns the irq corresponding to the doorbell.
113 int mic_db_to_irq(struct mic_driver *mdrv, int db)
116 if (db < MIC_X100_NUM_SBOX_IRQ) {
117 return mic_get_sbox_irq(db);
119 rdmasr_index = db - MIC_X100_NUM_SBOX_IRQ +
120 MIC_X100_RDMASR_IRQ_BASE;
121 return mic_get_rdmasr_irq(rdmasr_index);
126 * mic_card_map - Allocate virtual address for a remote memory region.
127 * @mdev: pointer to mic_device instance.
128 * @addr: Remote DMA address.
129 * @size: Size of the region.
131 * Returns: Virtual address backing the remote memory region.
134 mic_card_map(struct mic_device *mdev, dma_addr_t addr, size_t size)
136 return ioremap(addr, size);
140 * mic_card_unmap - Unmap the virtual address for a remote memory region.
141 * @mdev: pointer to mic_device instance.
142 * @addr: Virtual address for remote memory region.
146 void mic_card_unmap(struct mic_device *mdev, void __iomem *addr)
151 static inline struct mic_driver *mbdev_to_mdrv(struct mbus_device *mbdev)
153 return dev_get_drvdata(mbdev->dev.parent);
156 static struct mic_irq *
157 _mic_request_threaded_irq(struct mbus_device *mbdev,
158 irq_handler_t handler, irq_handler_t thread_fn,
159 const char *name, void *data, int intr_src)
162 unsigned int irq = intr_src;
163 unsigned long cookie = irq;
165 rc = request_threaded_irq(irq, handler, thread_fn, 0, name, data);
167 dev_err(mbdev_to_mdrv(mbdev)->dev,
168 "request_threaded_irq failed rc = %d\n", rc);
171 return (struct mic_irq *)cookie;
174 static void _mic_free_irq(struct mbus_device *mbdev,
175 struct mic_irq *cookie, void *data)
177 unsigned long irq = (unsigned long)cookie;
181 static void _mic_ack_interrupt(struct mbus_device *mbdev, int num)
183 mic_ack_interrupt(&mbdev_to_mdrv(mbdev)->mdev);
186 static struct mbus_hw_ops mbus_hw_ops = {
187 .request_threaded_irq = _mic_request_threaded_irq,
188 .free_irq = _mic_free_irq,
189 .ack_interrupt = _mic_ack_interrupt,
192 static int __init mic_probe(struct platform_device *pdev)
194 struct mic_driver *mdrv = &g_drv;
195 struct mic_device *mdev = &mdrv->mdev;
198 mdrv->dev = &pdev->dev;
199 snprintf(mdrv->name, sizeof(mic_driver_name), mic_driver_name);
201 mdev->mmio.pa = MIC_X100_MMIO_BASE;
202 mdev->mmio.len = MIC_X100_MMIO_LEN;
203 mdev->mmio.va = devm_ioremap(&pdev->dev, MIC_X100_MMIO_BASE,
205 if (!mdev->mmio.va) {
206 dev_err(&pdev->dev, "Cannot remap MMIO BAR\n");
210 mic_hw_intr_init(mdrv);
211 platform_set_drvdata(pdev, mdrv);
212 mdrv->dma_mbdev = mbus_register_device(mdrv->dev, MBUS_DEV_DMA_MIC,
215 if (IS_ERR(mdrv->dma_mbdev)) {
216 rc = PTR_ERR(mdrv->dma_mbdev);
217 dev_err(&pdev->dev, "mbus_add_device failed rc %d\n", rc);
220 rc = mic_driver_init(mdrv);
222 dev_err(&pdev->dev, "mic_driver_init failed rc %d\n", rc);
228 mbus_unregister_device(mdrv->dma_mbdev);
232 static int mic_remove(struct platform_device *pdev)
234 struct mic_driver *mdrv = &g_drv;
236 mic_driver_uninit(mdrv);
237 mbus_unregister_device(mdrv->dma_mbdev);
241 static void mic_platform_shutdown(struct platform_device *pdev)
246 static struct platform_device mic_platform_dev = {
247 .name = mic_driver_name,
252 static struct platform_driver __refdata mic_platform_driver = {
254 .remove = mic_remove,
255 .shutdown = mic_platform_shutdown,
257 .name = mic_driver_name,
258 .owner = THIS_MODULE,
262 static int __init mic_init(void)
265 struct cpuinfo_x86 *c = &cpu_data(0);
267 if (!(c->x86 == 11 && c->x86_model == 1)) {
269 pr_err("%s not running on X100 ret %d\n", __func__, ret);
273 mic_init_card_debugfs();
274 ret = platform_device_register(&mic_platform_dev);
276 pr_err("platform_device_register ret %d\n", ret);
277 goto cleanup_debugfs;
279 ret = platform_driver_register(&mic_platform_driver);
281 pr_err("platform_driver_register ret %d\n", ret);
282 goto device_unregister;
287 platform_device_unregister(&mic_platform_dev);
289 mic_exit_card_debugfs();
294 static void __exit mic_exit(void)
296 platform_driver_unregister(&mic_platform_driver);
297 platform_device_unregister(&mic_platform_dev);
298 mic_exit_card_debugfs();
301 module_init(mic_init);
302 module_exit(mic_exit);
304 MODULE_AUTHOR("Intel Corporation");
305 MODULE_DESCRIPTION("Intel(R) MIC X100 Card driver");
306 MODULE_LICENSE("GPL v2");