]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/misc/mei/init.c
Merge branches 'acpi-ec', 'acpi-irq' and 'acpi-quirks'
[mirror_ubuntu-artful-kernel.git] / drivers / misc / mei / init.c
CommitLineData
91f01c6d
OW
1/*
2 *
3 * Intel Management Engine Interface (Intel MEI) Linux driver
733ba91c 4 * Copyright (c) 2003-2012, Intel Corporation.
91f01c6d
OW
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 */
16
40e0b67b 17#include <linux/export.h>
91f01c6d
OW
18#include <linux/sched.h>
19#include <linux/wait.h>
20#include <linux/delay.h>
21
47a73801
TW
22#include <linux/mei.h>
23
91f01c6d 24#include "mei_dev.h"
aafae7ec 25#include "hbm.h"
90e0b5f1 26#include "client.h"
91f01c6d 27
b210d750
TW
28const char *mei_dev_state_str(int state)
29{
30#define MEI_DEV_STATE(state) case MEI_DEV_##state: return #state
31 switch (state) {
32 MEI_DEV_STATE(INITIALIZING);
33 MEI_DEV_STATE(INIT_CLIENTS);
34 MEI_DEV_STATE(ENABLED);
0cfee51c 35 MEI_DEV_STATE(RESETTING);
b210d750 36 MEI_DEV_STATE(DISABLED);
b210d750
TW
37 MEI_DEV_STATE(POWER_DOWN);
38 MEI_DEV_STATE(POWER_UP);
39 default:
8b513d0c 40 return "unknown";
b210d750
TW
41 }
42#undef MEI_DEV_STATE
43}
44
1beeb4b9
AU
45const char *mei_pg_state_str(enum mei_pg_state state)
46{
47#define MEI_PG_STATE(state) case MEI_PG_##state: return #state
48 switch (state) {
49 MEI_PG_STATE(OFF);
50 MEI_PG_STATE(ON);
51 default:
52 return "unknown";
53 }
54#undef MEI_PG_STATE
55}
56
edca5ea3
AU
57/**
58 * mei_fw_status2str - convert fw status registers to printable string
59 *
60 * @fw_status: firmware status
61 * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ
62 * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ
63 *
64 * Return: number of bytes written or -EINVAL if buffer is to small
65 */
66ssize_t mei_fw_status2str(struct mei_fw_status *fw_status,
67 char *buf, size_t len)
68{
69 ssize_t cnt = 0;
70 int i;
71
72 buf[0] = '\0';
73
74 if (len < MEI_FW_STATUS_STR_SZ)
75 return -EINVAL;
76
77 for (i = 0; i < fw_status->count; i++)
78 cnt += scnprintf(buf + cnt, len - cnt, "%08X ",
79 fw_status->status[i]);
80
81 /* drop last space */
82 buf[cnt] = '\0';
83 return cnt;
84}
85EXPORT_SYMBOL_GPL(mei_fw_status2str);
91f01c6d 86
544f9460 87/**
a8605ea2 88 * mei_cancel_work - Cancel mei background jobs
544f9460
TW
89 *
90 * @dev: the device structure
91 */
dc844b0d
TW
92void mei_cancel_work(struct mei_device *dev)
93{
544f9460 94 cancel_work_sync(&dev->reset_work);
a816a00e 95 cancel_work_sync(&dev->bus_rescan_work);
dc844b0d 96
1892fc2e 97 cancel_delayed_work_sync(&dev->timer_work);
dc844b0d
TW
98}
99EXPORT_SYMBOL_GPL(mei_cancel_work);
100
91f01c6d
OW
101/**
102 * mei_reset - resets host and fw.
103 *
104 * @dev: the device structure
ce23139c
AU
105 *
106 * Return: 0 on success or < 0 if the reset hasn't succeeded
91f01c6d 107 */
33ec0826 108int mei_reset(struct mei_device *dev)
91f01c6d 109{
33ec0826
TW
110 enum mei_dev_state state = dev->dev_state;
111 bool interrupts_enabled;
c20c68d5 112 int ret;
91f01c6d 113
33ec0826
TW
114 if (state != MEI_DEV_INITIALIZING &&
115 state != MEI_DEV_DISABLED &&
116 state != MEI_DEV_POWER_DOWN &&
04dd3661 117 state != MEI_DEV_POWER_UP) {
edca5ea3 118 char fw_sts_str[MEI_FW_STATUS_STR_SZ];
92db1555 119
edca5ea3
AU
120 mei_fw_status_str(dev, fw_sts_str, MEI_FW_STATUS_STR_SZ);
121 dev_warn(dev->dev, "unexpected reset: dev_state = %s fw status = %s\n",
122 mei_dev_state_str(state), fw_sts_str);
04dd3661 123 }
f931f4f3 124
4a8efd4a
TW
125 mei_clear_interrupts(dev);
126
66ae460b
TW
127 /* we're already in reset, cancel the init timer
128 * if the reset was called due the hbm protocol error
129 * we need to call it before hw start
130 * so the hbm watchdog won't kick in
131 */
132 mei_hbm_idle(dev);
133
33ec0826
TW
134 /* enter reset flow */
135 interrupts_enabled = state != MEI_DEV_POWER_DOWN;
136 dev->dev_state = MEI_DEV_RESETTING;
91f01c6d 137
6adb8efb
TW
138 dev->reset_count++;
139 if (dev->reset_count > MEI_MAX_CONSEC_RESET) {
2bf94cab 140 dev_err(dev->dev, "reset: reached maximal consecutive resets: disabling the device\n");
6adb8efb
TW
141 dev->dev_state = MEI_DEV_DISABLED;
142 return -ENODEV;
143 }
144
33ec0826
TW
145 ret = mei_hw_reset(dev, interrupts_enabled);
146 /* fall through and remove the sw state even if hw reset has failed */
91f01c6d 147
33ec0826 148 /* no need to clean up software state in case of power up */
394a77d0 149 if (state != MEI_DEV_INITIALIZING && state != MEI_DEV_POWER_UP)
074b4c01
TW
150 mei_cl_all_disconnect(dev);
151
84b3294a 152 mei_hbm_reset(dev);
4a704575 153
91f01c6d 154 dev->rd_msg_hdr = 0;
91f01c6d 155
33ec0826 156 if (ret) {
2bf94cab 157 dev_err(dev->dev, "hw_reset failed ret = %d\n", ret);
33ec0826
TW
158 return ret;
159 }
160
161 if (state == MEI_DEV_POWER_DOWN) {
2bf94cab 162 dev_dbg(dev->dev, "powering down: end of reset\n");
33ec0826
TW
163 dev->dev_state = MEI_DEV_DISABLED;
164 return 0;
aafae7ec
TW
165 }
166
9049f793
TW
167 ret = mei_hw_start(dev);
168 if (ret) {
2bf94cab 169 dev_err(dev->dev, "hw_start failed ret = %d\n", ret);
33ec0826 170 return ret;
9049f793 171 }
aafae7ec 172
2bf94cab 173 dev_dbg(dev->dev, "link is established start sending messages.\n");
aafae7ec
TW
174
175 dev->dev_state = MEI_DEV_INIT_CLIENTS;
544f9460
TW
176 ret = mei_hbm_start_req(dev);
177 if (ret) {
2bf94cab 178 dev_err(dev->dev, "hbm_start failed ret = %d\n", ret);
7d93e58d 179 dev->dev_state = MEI_DEV_RESETTING;
33ec0826 180 return ret;
544f9460 181 }
33ec0826
TW
182
183 return 0;
91f01c6d 184}
40e0b67b 185EXPORT_SYMBOL_GPL(mei_reset);
91f01c6d 186
33ec0826
TW
187/**
188 * mei_start - initializes host and fw to start work.
189 *
190 * @dev: the device structure
191 *
a8605ea2 192 * Return: 0 on success, <0 on failure.
33ec0826
TW
193 */
194int mei_start(struct mei_device *dev)
195{
7d93e58d 196 int ret;
92db1555 197
33ec0826
TW
198 mutex_lock(&dev->device_lock);
199
200 /* acknowledge interrupt and stop interrupts */
201 mei_clear_interrupts(dev);
202
203 mei_hw_config(dev);
204
2bf94cab 205 dev_dbg(dev->dev, "reset in start the mei device.\n");
33ec0826 206
6adb8efb 207 dev->reset_count = 0;
7d93e58d
TW
208 do {
209 dev->dev_state = MEI_DEV_INITIALIZING;
210 ret = mei_reset(dev);
211
212 if (ret == -ENODEV || dev->dev_state == MEI_DEV_DISABLED) {
2bf94cab 213 dev_err(dev->dev, "reset failed ret = %d", ret);
7d93e58d
TW
214 goto err;
215 }
216 } while (ret);
33ec0826 217
33ec0826 218 if (mei_hbm_start_wait(dev)) {
2bf94cab 219 dev_err(dev->dev, "HBM haven't started");
33ec0826
TW
220 goto err;
221 }
222
223 if (!mei_host_is_ready(dev)) {
2bf94cab 224 dev_err(dev->dev, "host is not ready.\n");
33ec0826
TW
225 goto err;
226 }
227
228 if (!mei_hw_is_ready(dev)) {
2bf94cab 229 dev_err(dev->dev, "ME is not ready.\n");
33ec0826
TW
230 goto err;
231 }
232
233 if (!mei_hbm_version_is_supported(dev)) {
2bf94cab 234 dev_dbg(dev->dev, "MEI start failed.\n");
33ec0826
TW
235 goto err;
236 }
237
2bf94cab 238 dev_dbg(dev->dev, "link layer has been established.\n");
33ec0826
TW
239
240 mutex_unlock(&dev->device_lock);
241 return 0;
242err:
2bf94cab 243 dev_err(dev->dev, "link layer initialization failed.\n");
33ec0826
TW
244 dev->dev_state = MEI_DEV_DISABLED;
245 mutex_unlock(&dev->device_lock);
246 return -ENODEV;
247}
248EXPORT_SYMBOL_GPL(mei_start);
249
250/**
251 * mei_restart - restart device after suspend
252 *
253 * @dev: the device structure
254 *
a8605ea2 255 * Return: 0 on success or -ENODEV if the restart hasn't succeeded
33ec0826
TW
256 */
257int mei_restart(struct mei_device *dev)
258{
259 int err;
260
261 mutex_lock(&dev->device_lock);
262
33ec0826 263 dev->dev_state = MEI_DEV_POWER_UP;
6adb8efb 264 dev->reset_count = 0;
33ec0826
TW
265
266 err = mei_reset(dev);
267
268 mutex_unlock(&dev->device_lock);
269
7d93e58d 270 if (err == -ENODEV || dev->dev_state == MEI_DEV_DISABLED) {
2bf94cab 271 dev_err(dev->dev, "device disabled = %d\n", err);
33ec0826 272 return -ENODEV;
7d93e58d
TW
273 }
274
275 /* try to start again */
276 if (err)
277 schedule_work(&dev->reset_work);
278
33ec0826
TW
279
280 return 0;
281}
282EXPORT_SYMBOL_GPL(mei_restart);
283
544f9460
TW
284static void mei_reset_work(struct work_struct *work)
285{
286 struct mei_device *dev =
287 container_of(work, struct mei_device, reset_work);
7d93e58d 288 int ret;
544f9460 289
a733ded5
TW
290 mei_clear_interrupts(dev);
291 mei_synchronize_irq(dev);
292
544f9460
TW
293 mutex_lock(&dev->device_lock);
294
7d93e58d 295 ret = mei_reset(dev);
544f9460
TW
296
297 mutex_unlock(&dev->device_lock);
33ec0826 298
7d93e58d 299 if (dev->dev_state == MEI_DEV_DISABLED) {
2bf94cab 300 dev_err(dev->dev, "device disabled = %d\n", ret);
7d93e58d
TW
301 return;
302 }
303
304 /* retry reset in case of failure */
305 if (ret)
306 schedule_work(&dev->reset_work);
544f9460
TW
307}
308
7cb035d9
TW
309void mei_stop(struct mei_device *dev)
310{
2bf94cab 311 dev_dbg(dev->dev, "stopping the device.\n");
7cb035d9 312
6009595a 313 mei_cl_bus_remove_devices(dev);
7cb035d9 314
97ccf63f
TW
315 mei_cancel_work(dev);
316
a733ded5
TW
317 mei_clear_interrupts(dev);
318 mei_synchronize_irq(dev);
319
dc844b0d 320 mutex_lock(&dev->device_lock);
7cb035d9 321
7cb035d9 322 dev->dev_state = MEI_DEV_POWER_DOWN;
33ec0826 323 mei_reset(dev);
6c15a851
AU
324 /* move device to disabled state unconditionally */
325 dev->dev_state = MEI_DEV_DISABLED;
7cb035d9
TW
326
327 mutex_unlock(&dev->device_lock);
7cb035d9 328}
40e0b67b 329EXPORT_SYMBOL_GPL(mei_stop);
91f01c6d 330
a532bbed
TW
331/**
332 * mei_write_is_idle - check if the write queues are idle
333 *
334 * @dev: the device structure
335 *
a8605ea2 336 * Return: true of there is no pending write
a532bbed
TW
337 */
338bool mei_write_is_idle(struct mei_device *dev)
339{
340 bool idle = (dev->dev_state == MEI_DEV_ENABLED &&
962ff7bc
AU
341 list_empty(&dev->ctrl_wr_list) &&
342 list_empty(&dev->write_list) &&
343 list_empty(&dev->write_waiting_list));
c1174c0e 344
41c95b04 345 dev_dbg(dev->dev, "write pg: is idle[%d] state=%s ctrl=%01d write=%01d wwait=%01d\n",
a532bbed
TW
346 idle,
347 mei_dev_state_str(dev->dev_state),
962ff7bc
AU
348 list_empty(&dev->ctrl_wr_list),
349 list_empty(&dev->write_list),
350 list_empty(&dev->write_waiting_list));
a532bbed
TW
351
352 return idle;
353}
354EXPORT_SYMBOL_GPL(mei_write_is_idle);
91f01c6d 355
3a7e9b6c
TW
356/**
357 * mei_device_init -- initialize mei_device structure
358 *
359 * @dev: the mei device
360 * @device: the device structure
361 * @hw_ops: hw operations
362 */
363void mei_device_init(struct mei_device *dev,
364 struct device *device,
365 const struct mei_hw_ops *hw_ops)
544f9460
TW
366{
367 /* setup our list array */
368 INIT_LIST_HEAD(&dev->file_list);
369 INIT_LIST_HEAD(&dev->device_list);
5ca2d388 370 INIT_LIST_HEAD(&dev->me_clients);
544f9460 371 mutex_init(&dev->device_lock);
b7d88514 372 init_rwsem(&dev->me_clients_rwsem);
0ff0a8d8 373 mutex_init(&dev->cl_bus_lock);
544f9460 374 init_waitqueue_head(&dev->wait_hw_ready);
4fcbc99b 375 init_waitqueue_head(&dev->wait_pg);
cb02efc3 376 init_waitqueue_head(&dev->wait_hbm_start);
544f9460 377 dev->dev_state = MEI_DEV_INITIALIZING;
6adb8efb 378 dev->reset_count = 0;
544f9460 379
962ff7bc
AU
380 INIT_LIST_HEAD(&dev->write_list);
381 INIT_LIST_HEAD(&dev->write_waiting_list);
382 INIT_LIST_HEAD(&dev->ctrl_wr_list);
383 INIT_LIST_HEAD(&dev->ctrl_rd_list);
544f9460
TW
384
385 INIT_DELAYED_WORK(&dev->timer_work, mei_timer);
544f9460 386 INIT_WORK(&dev->reset_work, mei_reset_work);
a816a00e 387 INIT_WORK(&dev->bus_rescan_work, mei_cl_bus_rescan_work);
544f9460 388
544f9460
TW
389 bitmap_zero(dev->host_clients_map, MEI_CLIENTS_MAX);
390 dev->open_handle_count = 0;
391
392 /*
393 * Reserving the first client ID
394 * 0: Reserved for MEI Bus Message communications
395 */
396 bitmap_set(dev->host_clients_map, 0, 1);
964a2331
TW
397
398 dev->pg_event = MEI_PG_EVENT_IDLE;
3a7e9b6c
TW
399 dev->ops = hw_ops;
400 dev->dev = device;
544f9460
TW
401}
402EXPORT_SYMBOL_GPL(mei_device_init);
403