drivers/misc/mic/card/mic_device.h

   1 /*
   2  * Intel MIC Platform Software Stack (MPSS)
   3  *
   4  * Copyright(c) 2013 Intel Corporation.
   5  *
   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.
   9  *
  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.
  14  *
  15  * The full GNU General Public License is included in this distribution in
  16  * the file called "COPYING".
  17  *
  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.
  23  *
  24  * Intel MIC Card driver.
  25  *
  26  */
  27 #ifndef _MIC_CARD_DEVICE_H_
  28 #define _MIC_CARD_DEVICE_H_
  29
  30 #include <linux/workqueue.h>
  31 #include <linux/io.h>
  32 #include <linux/irqreturn.h>
  33 #include <linux/interrupt.h>
  34
  35 /**
  36  * struct mic_intr_info - Contains h/w specific interrupt sources info
  37  *
  38  * @num_intr: The number of irqs available
  39  */
  40 struct mic_intr_info {
  41         u32 num_intr;
  42 };
  43
  44 /**
  45  * struct mic_irq_info - OS specific irq information
  46  *
  47  * @irq_usage_count: usage count array tracking the number of sources
  48  * assigned for each irq.
  49  */
  50 struct mic_irq_info {
  51         int *irq_usage_count;
  52 };
  53
  54 /**
  55  * struct mic_device -  MIC device information.
  56  *
  57  * @mmio: MMIO bar information.
  58  */
  59 struct mic_device {
  60         struct mic_mw mmio;
  61 };
  62
  63 /**
  64  * struct mic_driver - MIC card driver information.
  65  *
  66  * @name: Name for MIC driver.
  67  * @dbg_dir: debugfs directory of this MIC device.
  68  * @dev: The device backing this MIC.
  69  * @dp: The pointer to the virtio device page.
  70  * @mdev: MIC device information for the host.
  71  * @hotplug_work: Hot plug work for adding/removing virtio devices.
  72  * @irq_info: The OS specific irq information
  73  * @intr_info: H/W specific interrupt information.
  74  */
  75 struct mic_driver {
  76         char name[20];
  77         struct dentry *dbg_dir;
  78         struct device *dev;
  79         void __iomem *dp;
  80         struct mic_device mdev;
  81         struct work_struct hotplug_work;
  82         struct mic_irq_info irq_info;
  83         struct mic_intr_info intr_info;
  84 };
  85
  86 /**
  87  * struct mic_irq - opaque pointer used as cookie
  88  */
  89 struct mic_irq;
  90
  91 /**
  92  * mic_mmio_read - read from an MMIO register.
  93  * @mw: MMIO register base virtual address.
  94  * @offset: register offset.
  95  *
  96  * RETURNS: register value.
  97  */
  98 static inline u32 mic_mmio_read(struct mic_mw *mw, u32 offset)
  99 {
 100         return ioread32(mw->va + offset);
 101 }
 102
 103 /**
 104  * mic_mmio_write - write to an MMIO register.
 105  * @mw: MMIO register base virtual address.
 106  * @val: the data value to put into the register
 107  * @offset: register offset.
 108  *
 109  * RETURNS: none.
 110  */
 111 static inline void
 112 mic_mmio_write(struct mic_mw *mw, u32 val, u32 offset)
 113 {
 114         iowrite32(val, mw->va + offset);
 115 }
 116
 117 int mic_driver_init(struct mic_driver *mdrv);
 118 void mic_driver_uninit(struct mic_driver *mdrv);
 119 int mic_next_card_db(void);
 120 struct mic_irq *mic_request_card_irq(irq_handler_t handler,
 121         irq_handler_t thread_fn, const char *name, void *data, int intr_src);
 122 void mic_free_card_irq(struct mic_irq *cookie, void *data);
 123 u32 mic_read_spad(struct mic_device *mdev, unsigned int idx);
 124 void mic_send_intr(struct mic_device *mdev, int doorbell);
 125 int mic_db_to_irq(struct mic_driver *mdrv, int db);
 126 u32 mic_ack_interrupt(struct mic_device *mdev);
 127 void mic_hw_intr_init(struct mic_driver *mdrv);
 128 void __iomem *
 129 mic_card_map(struct mic_device *mdev, dma_addr_t addr, size_t size);
 130 void mic_card_unmap(struct mic_device *mdev, void __iomem *addr);
 131 void __init mic_create_card_debug_dir(struct mic_driver *mdrv);
 132 void mic_delete_card_debug_dir(struct mic_driver *mdrv);
 133 void __init mic_init_card_debugfs(void);
 134 void mic_exit_card_debugfs(void);
 135 #endif