]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - drivers/misc/mei/init.c
Merge branch 'x86/boot' into x86/mm, to avoid conflict
[mirror_ubuntu-focal-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
TW
148 /* no need to clean up software state in case of power up */
149 if (state != MEI_DEV_INITIALIZING &&
150 state != MEI_DEV_POWER_UP) {
91f01c6d 151
b950ac1d 152 /* remove all waiting requests */
074b4c01
TW
153 mei_cl_all_disconnect(dev);
154
91f01c6d 155 /* remove entry if already in list */
fdd9b865 156 dev_dbg(dev->dev, "remove iamthif from the file list.\n");
90e0b5f1 157 mei_cl_unlink(&dev->iamthif_cl);
19838fb8 158 mei_amthif_reset_params(dev);
91f01c6d
OW
159 }
160
84b3294a 161 mei_hbm_reset(dev);
4a704575 162
91f01c6d 163 dev->rd_msg_hdr = 0;
91f01c6d 164
33ec0826 165 if (ret) {
2bf94cab 166 dev_err(dev->dev, "hw_reset failed ret = %d\n", ret);
33ec0826
TW
167 return ret;
168 }
169
170 if (state == MEI_DEV_POWER_DOWN) {
2bf94cab 171 dev_dbg(dev->dev, "powering down: end of reset\n");
33ec0826
TW
172 dev->dev_state = MEI_DEV_DISABLED;
173 return 0;
aafae7ec
TW
174 }
175
9049f793
TW
176 ret = mei_hw_start(dev);
177 if (ret) {
2bf94cab 178 dev_err(dev->dev, "hw_start failed ret = %d\n", ret);
33ec0826 179 return ret;
9049f793 180 }
aafae7ec 181
2bf94cab 182 dev_dbg(dev->dev, "link is established start sending messages.\n");
aafae7ec
TW
183
184 dev->dev_state = MEI_DEV_INIT_CLIENTS;
544f9460
TW
185 ret = mei_hbm_start_req(dev);
186 if (ret) {
2bf94cab 187 dev_err(dev->dev, "hbm_start failed ret = %d\n", ret);
7d93e58d 188 dev->dev_state = MEI_DEV_RESETTING;
33ec0826 189 return ret;
544f9460 190 }
33ec0826
TW
191
192 return 0;
91f01c6d 193}
40e0b67b 194EXPORT_SYMBOL_GPL(mei_reset);
91f01c6d 195
33ec0826
TW
196/**
197 * mei_start - initializes host and fw to start work.
198 *
199 * @dev: the device structure
200 *
a8605ea2 201 * Return: 0 on success, <0 on failure.
33ec0826
TW
202 */
203int mei_start(struct mei_device *dev)
204{
7d93e58d 205 int ret;
92db1555 206
33ec0826
TW
207 mutex_lock(&dev->device_lock);
208
209 /* acknowledge interrupt and stop interrupts */
210 mei_clear_interrupts(dev);
211
212 mei_hw_config(dev);
213
2bf94cab 214 dev_dbg(dev->dev, "reset in start the mei device.\n");
33ec0826 215
6adb8efb 216 dev->reset_count = 0;
7d93e58d
TW
217 do {
218 dev->dev_state = MEI_DEV_INITIALIZING;
219 ret = mei_reset(dev);
220
221 if (ret == -ENODEV || dev->dev_state == MEI_DEV_DISABLED) {
2bf94cab 222 dev_err(dev->dev, "reset failed ret = %d", ret);
7d93e58d
TW
223 goto err;
224 }
225 } while (ret);
33ec0826 226
7d93e58d 227 /* we cannot start the device w/o hbm start message completed */
33ec0826 228 if (dev->dev_state == MEI_DEV_DISABLED) {
2bf94cab 229 dev_err(dev->dev, "reset failed");
33ec0826
TW
230 goto err;
231 }
232
233 if (mei_hbm_start_wait(dev)) {
2bf94cab 234 dev_err(dev->dev, "HBM haven't started");
33ec0826
TW
235 goto err;
236 }
237
238 if (!mei_host_is_ready(dev)) {
2bf94cab 239 dev_err(dev->dev, "host is not ready.\n");
33ec0826
TW
240 goto err;
241 }
242
243 if (!mei_hw_is_ready(dev)) {
2bf94cab 244 dev_err(dev->dev, "ME is not ready.\n");
33ec0826
TW
245 goto err;
246 }
247
248 if (!mei_hbm_version_is_supported(dev)) {
2bf94cab 249 dev_dbg(dev->dev, "MEI start failed.\n");
33ec0826
TW
250 goto err;
251 }
252
2bf94cab 253 dev_dbg(dev->dev, "link layer has been established.\n");
33ec0826
TW
254
255 mutex_unlock(&dev->device_lock);
256 return 0;
257err:
2bf94cab 258 dev_err(dev->dev, "link layer initialization failed.\n");
33ec0826
TW
259 dev->dev_state = MEI_DEV_DISABLED;
260 mutex_unlock(&dev->device_lock);
261 return -ENODEV;
262}
263EXPORT_SYMBOL_GPL(mei_start);
264
265/**
266 * mei_restart - restart device after suspend
267 *
268 * @dev: the device structure
269 *
a8605ea2 270 * Return: 0 on success or -ENODEV if the restart hasn't succeeded
33ec0826
TW
271 */
272int mei_restart(struct mei_device *dev)
273{
274 int err;
275
276 mutex_lock(&dev->device_lock);
277
33ec0826 278 dev->dev_state = MEI_DEV_POWER_UP;
6adb8efb 279 dev->reset_count = 0;
33ec0826
TW
280
281 err = mei_reset(dev);
282
283 mutex_unlock(&dev->device_lock);
284
7d93e58d 285 if (err == -ENODEV || dev->dev_state == MEI_DEV_DISABLED) {
2bf94cab 286 dev_err(dev->dev, "device disabled = %d\n", err);
33ec0826 287 return -ENODEV;
7d93e58d
TW
288 }
289
290 /* try to start again */
291 if (err)
292 schedule_work(&dev->reset_work);
293
33ec0826
TW
294
295 return 0;
296}
297EXPORT_SYMBOL_GPL(mei_restart);
298
544f9460
TW
299static void mei_reset_work(struct work_struct *work)
300{
301 struct mei_device *dev =
302 container_of(work, struct mei_device, reset_work);
7d93e58d 303 int ret;
544f9460 304
a733ded5
TW
305 mei_clear_interrupts(dev);
306 mei_synchronize_irq(dev);
307
544f9460
TW
308 mutex_lock(&dev->device_lock);
309
7d93e58d 310 ret = mei_reset(dev);
544f9460
TW
311
312 mutex_unlock(&dev->device_lock);
33ec0826 313
7d93e58d 314 if (dev->dev_state == MEI_DEV_DISABLED) {
2bf94cab 315 dev_err(dev->dev, "device disabled = %d\n", ret);
7d93e58d
TW
316 return;
317 }
318
319 /* retry reset in case of failure */
320 if (ret)
321 schedule_work(&dev->reset_work);
544f9460
TW
322}
323
7cb035d9
TW
324void mei_stop(struct mei_device *dev)
325{
2bf94cab 326 dev_dbg(dev->dev, "stopping the device.\n");
7cb035d9 327
6009595a 328 mei_cl_bus_remove_devices(dev);
7cb035d9 329
97ccf63f
TW
330 mei_cancel_work(dev);
331
a733ded5
TW
332 mei_clear_interrupts(dev);
333 mei_synchronize_irq(dev);
334
dc844b0d 335 mutex_lock(&dev->device_lock);
7cb035d9 336
7cb035d9 337 dev->dev_state = MEI_DEV_POWER_DOWN;
33ec0826 338 mei_reset(dev);
6c15a851
AU
339 /* move device to disabled state unconditionally */
340 dev->dev_state = MEI_DEV_DISABLED;
7cb035d9
TW
341
342 mutex_unlock(&dev->device_lock);
7cb035d9 343}
40e0b67b 344EXPORT_SYMBOL_GPL(mei_stop);
91f01c6d 345
a532bbed
TW
346/**
347 * mei_write_is_idle - check if the write queues are idle
348 *
349 * @dev: the device structure
350 *
a8605ea2 351 * Return: true of there is no pending write
a532bbed
TW
352 */
353bool mei_write_is_idle(struct mei_device *dev)
354{
355 bool idle = (dev->dev_state == MEI_DEV_ENABLED &&
962ff7bc
AU
356 list_empty(&dev->ctrl_wr_list) &&
357 list_empty(&dev->write_list) &&
358 list_empty(&dev->write_waiting_list));
c1174c0e 359
41c95b04 360 dev_dbg(dev->dev, "write pg: is idle[%d] state=%s ctrl=%01d write=%01d wwait=%01d\n",
a532bbed
TW
361 idle,
362 mei_dev_state_str(dev->dev_state),
962ff7bc
AU
363 list_empty(&dev->ctrl_wr_list),
364 list_empty(&dev->write_list),
365 list_empty(&dev->write_waiting_list));
a532bbed
TW
366
367 return idle;
368}
369EXPORT_SYMBOL_GPL(mei_write_is_idle);
91f01c6d 370
3a7e9b6c
TW
371/**
372 * mei_device_init -- initialize mei_device structure
373 *
374 * @dev: the mei device
375 * @device: the device structure
376 * @hw_ops: hw operations
377 */
378void mei_device_init(struct mei_device *dev,
379 struct device *device,
380 const struct mei_hw_ops *hw_ops)
544f9460
TW
381{
382 /* setup our list array */
383 INIT_LIST_HEAD(&dev->file_list);
384 INIT_LIST_HEAD(&dev->device_list);
5ca2d388 385 INIT_LIST_HEAD(&dev->me_clients);
544f9460 386 mutex_init(&dev->device_lock);
b7d88514 387 init_rwsem(&dev->me_clients_rwsem);
0ff0a8d8 388 mutex_init(&dev->cl_bus_lock);
544f9460 389 init_waitqueue_head(&dev->wait_hw_ready);
4fcbc99b 390 init_waitqueue_head(&dev->wait_pg);
cb02efc3 391 init_waitqueue_head(&dev->wait_hbm_start);
544f9460 392 dev->dev_state = MEI_DEV_INITIALIZING;
6adb8efb 393 dev->reset_count = 0;
544f9460 394
962ff7bc
AU
395 INIT_LIST_HEAD(&dev->write_list);
396 INIT_LIST_HEAD(&dev->write_waiting_list);
397 INIT_LIST_HEAD(&dev->ctrl_wr_list);
398 INIT_LIST_HEAD(&dev->ctrl_rd_list);
544f9460
TW
399
400 INIT_DELAYED_WORK(&dev->timer_work, mei_timer);
544f9460 401 INIT_WORK(&dev->reset_work, mei_reset_work);
a816a00e 402 INIT_WORK(&dev->bus_rescan_work, mei_cl_bus_rescan_work);
544f9460 403
544f9460 404 INIT_LIST_HEAD(&dev->iamthif_cl.link);
962ff7bc 405 INIT_LIST_HEAD(&dev->amthif_cmd_list);
544f9460
TW
406
407 bitmap_zero(dev->host_clients_map, MEI_CLIENTS_MAX);
408 dev->open_handle_count = 0;
409
410 /*
411 * Reserving the first client ID
412 * 0: Reserved for MEI Bus Message communications
413 */
414 bitmap_set(dev->host_clients_map, 0, 1);
964a2331
TW
415
416 dev->pg_event = MEI_PG_EVENT_IDLE;
3a7e9b6c
TW
417 dev->ops = hw_ops;
418 dev->dev = device;
544f9460
TW
419}
420EXPORT_SYMBOL_GPL(mei_device_init);
421