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 * Intel MIC Host driver.
19 *
20 */
21 #ifndef _MIC_DEVICE_H_
22 #define _MIC_DEVICE_H_
23
24 #include <linux/cdev.h>
25 #include <linux/idr.h>
26 #include <linux/notifier.h>
27 #include <linux/irqreturn.h>
28 #include <linux/dmaengine.h>
29 #include <linux/mic_bus.h>
30
31 #include "mic_intr.h"
32
33 /* The maximum number of MIC devices supported in a single host system. */
34 #define MIC_MAX_NUM_DEVS 256
35
36 /**
37 * enum mic_hw_family - The hardware family to which a device belongs.
38 */
39 enum mic_hw_family {
40 MIC_FAMILY_X100 = 0,
41 MIC_FAMILY_UNKNOWN
42 };
43
44 /**
45 * enum mic_stepping - MIC stepping ids.
46 */
47 enum mic_stepping {
48 MIC_A0_STEP = 0x0,
49 MIC_B0_STEP = 0x10,
50 MIC_B1_STEP = 0x11,
51 MIC_C0_STEP = 0x20,
52 };
53
54 /**
55 * struct mic_device - MIC device information for each card.
56 *
57 * @mmio: MMIO bar information.
58 * @aper: Aperture bar information.
59 * @family: The MIC family to which this device belongs.
60 * @ops: MIC HW specific operations.
61 * @id: The unique device id for this MIC device.
62 * @stepping: Stepping ID.
63 * @attr_group: Pointer to list of sysfs attribute groups.
64 * @sdev: Device for sysfs entries.
65 * @mic_mutex: Mutex for synchronizing access to mic_device.
66 * @intr_ops: HW specific interrupt operations.
67 * @smpt_ops: Hardware specific SMPT operations.
68 * @smpt: MIC SMPT information.
69 * @intr_info: H/W specific interrupt information.
70 * @irq_info: The OS specific irq information
71 * @dbg_dir: debugfs directory of this MIC device.
72 * @cmdline: Kernel command line.
73 * @firmware: Firmware file name.
74 * @ramdisk: Ramdisk file name.
75 * @bootmode: Boot mode i.e. "linux" or "elf" for flash updates.
76 * @bootaddr: MIC boot address.
77 * @reset_trigger_work: Work for triggering reset requests.
78 * @shutdown_work: Work for handling shutdown interrupts.
79 * @state: MIC state.
80 * @shutdown_status: MIC status reported by card for shutdown/crashes.
81 * @state_sysfs: Sysfs dirent for notifying ring 3 about MIC state changes.
82 * @reset_wait: Waitqueue for sleeping while reset completes.
83 * @log_buf_addr: Log buffer address for MIC.
84 * @log_buf_len: Log buffer length address for MIC.
85 * @dp: virtio device page
86 * @dp_dma_addr: virtio device page DMA address.
87 * @shutdown_db: shutdown doorbell.
88 * @shutdown_cookie: shutdown cookie.
89 * @cdev: Character device for MIC.
90 * @vdev_list: list of virtio devices.
91 * @pm_notifier: Handles PM notifications from the OS.
92 * @dma_mbdev: MIC BUS DMA device.
93 * @dma_ch: DMA channel reserved by this driver for use by virtio devices.
94 */
95 struct mic_device {
96 struct mic_mw mmio;
97 struct mic_mw aper;
98 enum mic_hw_family family;
99 struct mic_hw_ops *ops;
100 int id;
101 enum mic_stepping stepping;
102 const struct attribute_group **attr_group;
103 struct device *sdev;
104 struct mutex mic_mutex;
105 struct mic_hw_intr_ops *intr_ops;
106 struct mic_smpt_ops *smpt_ops;
107 struct mic_smpt_info *smpt;
108 struct mic_intr_info *intr_info;
109 struct mic_irq_info irq_info;
110 struct dentry *dbg_dir;
111 char *cmdline;
112 char *firmware;
113 char *ramdisk;
114 char *bootmode;
115 u32 bootaddr;
116 struct work_struct reset_trigger_work;
117 struct work_struct shutdown_work;
118 u8 state;
119 u8 shutdown_status;
120 struct kernfs_node *state_sysfs;
121 struct completion reset_wait;
122 void *log_buf_addr;
123 int *log_buf_len;
124 void *dp;
125 dma_addr_t dp_dma_addr;
126 int shutdown_db;
127 struct mic_irq *shutdown_cookie;
128 struct cdev cdev;
129 struct list_head vdev_list;
130 struct notifier_block pm_notifier;
131 struct mbus_device *dma_mbdev;
132 struct dma_chan *dma_ch;
133 };
134
135 /**
136 * struct mic_hw_ops - MIC HW specific operations.
137 * @aper_bar: Aperture bar resource number.
138 * @mmio_bar: MMIO bar resource number.
139 * @read_spad: Read from scratch pad register.
140 * @write_spad: Write to scratch pad register.
141 * @send_intr: Send an interrupt for a particular doorbell on the card.
142 * @ack_interrupt: Hardware specific operations to ack the h/w on
143 * receipt of an interrupt.
144 * @intr_workarounds: Hardware specific workarounds needed after
145 * handling an interrupt.
146 * @reset: Reset the remote processor.
147 * @reset_fw_ready: Reset firmware ready field.
148 * @is_fw_ready: Check if firmware is ready for OS download.
149 * @send_firmware_intr: Send an interrupt to the card firmware.
150 * @load_mic_fw: Load firmware segments required to boot the card
151 * into card memory. This includes the kernel, command line, ramdisk etc.
152 * @get_postcode: Get post code status from firmware.
153 * @dma_filter: DMA filter function to be used.
154 */
155 struct mic_hw_ops {
156 u8 aper_bar;
157 u8 mmio_bar;
158 u32 (*read_spad)(struct mic_device *mdev, unsigned int idx);
159 void (*write_spad)(struct mic_device *mdev, unsigned int idx, u32 val);
160 void (*send_intr)(struct mic_device *mdev, int doorbell);
161 u32 (*ack_interrupt)(struct mic_device *mdev);
162 void (*intr_workarounds)(struct mic_device *mdev);
163 void (*reset)(struct mic_device *mdev);
164 void (*reset_fw_ready)(struct mic_device *mdev);
165 bool (*is_fw_ready)(struct mic_device *mdev);
166 void (*send_firmware_intr)(struct mic_device *mdev);
167 int (*load_mic_fw)(struct mic_device *mdev, const char *buf);
168 u32 (*get_postcode)(struct mic_device *mdev);
169 bool (*dma_filter)(struct dma_chan *chan, void *param);
170 };
171
172 /**
173 * mic_mmio_read - read from an MMIO register.
174 * @mw: MMIO register base virtual address.
175 * @offset: register offset.
176 *
177 * RETURNS: register value.
178 */
mic_mmio_read(struct mic_mw * mw,u32 offset)179 static inline u32 mic_mmio_read(struct mic_mw *mw, u32 offset)
180 {
181 return ioread32(mw->va + offset);
182 }
183
184 /**
185 * mic_mmio_write - write to an MMIO register.
186 * @mw: MMIO register base virtual address.
187 * @val: the data value to put into the register
188 * @offset: register offset.
189 *
190 * RETURNS: none.
191 */
192 static inline void
mic_mmio_write(struct mic_mw * mw,u32 val,u32 offset)193 mic_mmio_write(struct mic_mw *mw, u32 val, u32 offset)
194 {
195 iowrite32(val, mw->va + offset);
196 }
197
mic_request_dma_chan(struct mic_device * mdev)198 static inline struct dma_chan *mic_request_dma_chan(struct mic_device *mdev)
199 {
200 dma_cap_mask_t mask;
201 struct dma_chan *chan;
202
203 dma_cap_zero(mask);
204 dma_cap_set(DMA_MEMCPY, mask);
205 chan = dma_request_channel(mask, mdev->ops->dma_filter,
206 mdev->sdev->parent);
207 if (chan)
208 return chan;
209 dev_err(mdev->sdev->parent, "%s %d unable to acquire channel\n",
210 __func__, __LINE__);
211 return NULL;
212 }
213
214 void mic_sysfs_init(struct mic_device *mdev);
215 int mic_start(struct mic_device *mdev, const char *buf);
216 void mic_stop(struct mic_device *mdev, bool force);
217 void mic_shutdown(struct mic_device *mdev);
218 void mic_reset_delayed_work(struct work_struct *work);
219 void mic_reset_trigger_work(struct work_struct *work);
220 void mic_shutdown_work(struct work_struct *work);
221 void mic_bootparam_init(struct mic_device *mdev);
222 void mic_set_state(struct mic_device *mdev, u8 state);
223 void mic_set_shutdown_status(struct mic_device *mdev, u8 status);
224 void mic_create_debug_dir(struct mic_device *dev);
225 void mic_delete_debug_dir(struct mic_device *dev);
226 void __init mic_init_debugfs(void);
227 void mic_exit_debugfs(void);
228 void mic_prepare_suspend(struct mic_device *mdev);
229 void mic_complete_resume(struct mic_device *mdev);
230 void mic_suspend(struct mic_device *mdev);
231 #endif
232