1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (c) 2012-2022, Intel Corporation. All rights reserved. 4 * Intel Management Engine Interface (Intel MEI) Linux driver 5 */ 6 7 #include <linux/export.h> 8 #include <linux/sched.h> 9 #include <linux/wait.h> 10 #include <linux/delay.h> 11 12 #include <linux/mei.h> 13 14 #include "mei_dev.h" 15 #include "hbm.h" 16 #include "client.h" 17 18 const char *mei_dev_state_str(int state) 19 { 20 #define MEI_DEV_STATE(state) case MEI_DEV_##state: return #state 21 switch (state) { 22 MEI_DEV_STATE(INITIALIZING); 23 MEI_DEV_STATE(INIT_CLIENTS); 24 MEI_DEV_STATE(ENABLED); 25 MEI_DEV_STATE(RESETTING); 26 MEI_DEV_STATE(DISABLED); 27 MEI_DEV_STATE(POWERING_DOWN); 28 MEI_DEV_STATE(POWER_DOWN); 29 MEI_DEV_STATE(POWER_UP); 30 default: 31 return "unknown"; 32 } 33 #undef MEI_DEV_STATE 34 } 35 36 const char *mei_pg_state_str(enum mei_pg_state state) 37 { 38 #define MEI_PG_STATE(state) case MEI_PG_##state: return #state 39 switch (state) { 40 MEI_PG_STATE(OFF); 41 MEI_PG_STATE(ON); 42 default: 43 return "unknown"; 44 } 45 #undef MEI_PG_STATE 46 } 47 48 /** 49 * mei_fw_status2str - convert fw status registers to printable string 50 * 51 * @fw_status: firmware status 52 * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ 53 * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ 54 * 55 * Return: number of bytes written or -EINVAL if buffer is to small 56 */ 57 ssize_t mei_fw_status2str(struct mei_fw_status *fw_status, 58 char *buf, size_t len) 59 { 60 ssize_t cnt = 0; 61 int i; 62 63 buf[0] = '\0'; 64 65 if (len < MEI_FW_STATUS_STR_SZ) 66 return -EINVAL; 67 68 for (i = 0; i < fw_status->count; i++) 69 cnt += scnprintf(buf + cnt, len - cnt, "%08X ", 70 fw_status->status[i]); 71 72 /* drop last space */ 73 buf[cnt] = '\0'; 74 return cnt; 75 } 76 EXPORT_SYMBOL_GPL(mei_fw_status2str); 77 78 /** 79 * mei_cancel_work - Cancel mei background jobs 80 * 81 * @dev: the device structure 82 */ 83 void mei_cancel_work(struct mei_device *dev) 84 { 85 cancel_work_sync(&dev->reset_work); 86 cancel_work_sync(&dev->bus_rescan_work); 87 88 cancel_delayed_work_sync(&dev->timer_work); 89 } 90 EXPORT_SYMBOL_GPL(mei_cancel_work); 91 92 /** 93 * mei_reset - resets host and fw. 94 * 95 * @dev: the device structure 96 * 97 * Return: 0 on success or < 0 if the reset hasn't succeeded 98 */ 99 int mei_reset(struct mei_device *dev) 100 { 101 enum mei_dev_state state = dev->dev_state; 102 bool interrupts_enabled; 103 int ret; 104 105 if (state != MEI_DEV_INITIALIZING && 106 state != MEI_DEV_DISABLED && 107 state != MEI_DEV_POWER_DOWN && 108 state != MEI_DEV_POWER_UP) { 109 char fw_sts_str[MEI_FW_STATUS_STR_SZ]; 110 111 mei_fw_status_str(dev, fw_sts_str, MEI_FW_STATUS_STR_SZ); 112 dev_warn(dev->dev, "unexpected reset: dev_state = %s fw status = %s\n", 113 mei_dev_state_str(state), fw_sts_str); 114 } 115 116 mei_clear_interrupts(dev); 117 118 /* we're already in reset, cancel the init timer 119 * if the reset was called due the hbm protocol error 120 * we need to call it before hw start 121 * so the hbm watchdog won't kick in 122 */ 123 mei_hbm_idle(dev); 124 125 /* enter reset flow */ 126 interrupts_enabled = state != MEI_DEV_POWER_DOWN; 127 mei_set_devstate(dev, MEI_DEV_RESETTING); 128 129 dev->reset_count++; 130 if (dev->reset_count > MEI_MAX_CONSEC_RESET) { 131 dev_err(dev->dev, "reset: reached maximal consecutive resets: disabling the device\n"); 132 mei_set_devstate(dev, MEI_DEV_DISABLED); 133 return -ENODEV; 134 } 135 136 ret = mei_hw_reset(dev, interrupts_enabled); 137 /* fall through and remove the sw state even if hw reset has failed */ 138 139 /* no need to clean up software state in case of power up */ 140 if (state != MEI_DEV_INITIALIZING && state != MEI_DEV_POWER_UP) 141 mei_cl_all_disconnect(dev); 142 143 mei_hbm_reset(dev); 144 145 memset(dev->rd_msg_hdr, 0, sizeof(dev->rd_msg_hdr)); 146 147 if (ret) { 148 dev_err(dev->dev, "hw_reset failed ret = %d\n", ret); 149 return ret; 150 } 151 152 if (state == MEI_DEV_POWER_DOWN) { 153 dev_dbg(dev->dev, "powering down: end of reset\n"); 154 mei_set_devstate(dev, MEI_DEV_DISABLED); 155 return 0; 156 } 157 158 ret = mei_hw_start(dev); 159 if (ret) { 160 char fw_sts_str[MEI_FW_STATUS_STR_SZ]; 161 162 mei_fw_status_str(dev, fw_sts_str, MEI_FW_STATUS_STR_SZ); 163 dev_err(dev->dev, "hw_start failed ret = %d fw status = %s\n", ret, fw_sts_str); 164 return ret; 165 } 166 167 if (dev->dev_state != MEI_DEV_RESETTING) { 168 dev_dbg(dev->dev, "wrong state = %d on link start\n", dev->dev_state); 169 return 0; 170 } 171 172 dev_dbg(dev->dev, "link is established start sending messages.\n"); 173 174 mei_set_devstate(dev, MEI_DEV_INIT_CLIENTS); 175 ret = mei_hbm_start_req(dev); 176 if (ret) { 177 dev_err(dev->dev, "hbm_start failed ret = %d\n", ret); 178 mei_set_devstate(dev, MEI_DEV_RESETTING); 179 return ret; 180 } 181 182 return 0; 183 } 184 EXPORT_SYMBOL_GPL(mei_reset); 185 186 /** 187 * mei_start - initializes host and fw to start work. 188 * 189 * @dev: the device structure 190 * 191 * Return: 0 on success, <0 on failure. 192 */ 193 int mei_start(struct mei_device *dev) 194 { 195 int ret; 196 197 mutex_lock(&dev->device_lock); 198 199 /* acknowledge interrupt and stop interrupts */ 200 mei_clear_interrupts(dev); 201 202 ret = mei_hw_config(dev); 203 if (ret) 204 goto err; 205 206 dev_dbg(dev->dev, "reset in start the mei device.\n"); 207 208 dev->reset_count = 0; 209 do { 210 mei_set_devstate(dev, MEI_DEV_INITIALIZING); 211 ret = mei_reset(dev); 212 213 if (ret == -ENODEV || dev->dev_state == MEI_DEV_DISABLED) { 214 dev_err(dev->dev, "reset failed ret = %d", ret); 215 goto err; 216 } 217 } while (ret); 218 219 if (mei_hbm_start_wait(dev)) { 220 dev_err(dev->dev, "HBM haven't started"); 221 goto err; 222 } 223 224 if (!mei_hbm_version_is_supported(dev)) { 225 dev_dbg(dev->dev, "MEI start failed.\n"); 226 goto err; 227 } 228 229 dev_dbg(dev->dev, "link layer has been established.\n"); 230 231 mutex_unlock(&dev->device_lock); 232 return 0; 233 err: 234 dev_err(dev->dev, "link layer initialization failed.\n"); 235 mei_set_devstate(dev, MEI_DEV_DISABLED); 236 mutex_unlock(&dev->device_lock); 237 return -ENODEV; 238 } 239 EXPORT_SYMBOL_GPL(mei_start); 240 241 /** 242 * mei_restart - restart device after suspend 243 * 244 * @dev: the device structure 245 * 246 * Return: 0 on success or -ENODEV if the restart hasn't succeeded 247 */ 248 int mei_restart(struct mei_device *dev) 249 { 250 int err; 251 252 mutex_lock(&dev->device_lock); 253 254 mei_set_devstate(dev, MEI_DEV_POWER_UP); 255 dev->reset_count = 0; 256 257 err = mei_reset(dev); 258 259 mutex_unlock(&dev->device_lock); 260 261 if (err == -ENODEV || dev->dev_state == MEI_DEV_DISABLED) { 262 dev_err(dev->dev, "device disabled = %d\n", err); 263 return -ENODEV; 264 } 265 266 /* try to start again */ 267 if (err) 268 schedule_work(&dev->reset_work); 269 270 271 return 0; 272 } 273 EXPORT_SYMBOL_GPL(mei_restart); 274 275 static void mei_reset_work(struct work_struct *work) 276 { 277 struct mei_device *dev = 278 container_of(work, struct mei_device, reset_work); 279 int ret; 280 281 mei_clear_interrupts(dev); 282 mei_synchronize_irq(dev); 283 284 mutex_lock(&dev->device_lock); 285 286 ret = mei_reset(dev); 287 288 mutex_unlock(&dev->device_lock); 289 290 if (dev->dev_state == MEI_DEV_DISABLED) { 291 dev_err(dev->dev, "device disabled = %d\n", ret); 292 return; 293 } 294 295 /* retry reset in case of failure */ 296 if (ret) 297 schedule_work(&dev->reset_work); 298 } 299 300 void mei_stop(struct mei_device *dev) 301 { 302 dev_dbg(dev->dev, "stopping the device.\n"); 303 304 mutex_lock(&dev->device_lock); 305 mei_set_devstate(dev, MEI_DEV_POWERING_DOWN); 306 mutex_unlock(&dev->device_lock); 307 mei_cl_bus_remove_devices(dev); 308 mutex_lock(&dev->device_lock); 309 mei_set_devstate(dev, MEI_DEV_POWER_DOWN); 310 mutex_unlock(&dev->device_lock); 311 312 mei_cancel_work(dev); 313 314 mei_clear_interrupts(dev); 315 mei_synchronize_irq(dev); 316 /* to catch HW-initiated reset */ 317 mei_cancel_work(dev); 318 319 mutex_lock(&dev->device_lock); 320 321 mei_reset(dev); 322 /* move device to disabled state unconditionally */ 323 mei_set_devstate(dev, MEI_DEV_DISABLED); 324 325 mutex_unlock(&dev->device_lock); 326 } 327 EXPORT_SYMBOL_GPL(mei_stop); 328 329 /** 330 * mei_write_is_idle - check if the write queues are idle 331 * 332 * @dev: the device structure 333 * 334 * Return: true of there is no pending write 335 */ 336 bool mei_write_is_idle(struct mei_device *dev) 337 { 338 bool idle = (dev->dev_state == MEI_DEV_ENABLED && 339 list_empty(&dev->ctrl_wr_list) && 340 list_empty(&dev->write_list) && 341 list_empty(&dev->write_waiting_list)); 342 343 dev_dbg(dev->dev, "write pg: is idle[%d] state=%s ctrl=%01d write=%01d wwait=%01d\n", 344 idle, 345 mei_dev_state_str(dev->dev_state), 346 list_empty(&dev->ctrl_wr_list), 347 list_empty(&dev->write_list), 348 list_empty(&dev->write_waiting_list)); 349 350 return idle; 351 } 352 EXPORT_SYMBOL_GPL(mei_write_is_idle); 353 354 /** 355 * mei_device_init - initialize mei_device structure 356 * 357 * @dev: the mei device 358 * @device: the device structure 359 * @slow_fw: configure longer timeouts as FW is slow 360 * @hw_ops: hw operations 361 */ 362 void mei_device_init(struct mei_device *dev, 363 struct device *device, 364 bool slow_fw, 365 const struct mei_hw_ops *hw_ops) 366 { 367 /* setup our list array */ 368 INIT_LIST_HEAD(&dev->file_list); 369 INIT_LIST_HEAD(&dev->device_list); 370 INIT_LIST_HEAD(&dev->me_clients); 371 mutex_init(&dev->device_lock); 372 init_rwsem(&dev->me_clients_rwsem); 373 mutex_init(&dev->cl_bus_lock); 374 init_waitqueue_head(&dev->wait_hw_ready); 375 init_waitqueue_head(&dev->wait_pg); 376 init_waitqueue_head(&dev->wait_hbm_start); 377 dev->dev_state = MEI_DEV_INITIALIZING; 378 dev->reset_count = 0; 379 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); 384 dev->tx_queue_limit = MEI_TX_QUEUE_LIMIT_DEFAULT; 385 386 INIT_DELAYED_WORK(&dev->timer_work, mei_timer); 387 INIT_WORK(&dev->reset_work, mei_reset_work); 388 INIT_WORK(&dev->bus_rescan_work, mei_cl_bus_rescan_work); 389 390 bitmap_zero(dev->host_clients_map, MEI_CLIENTS_MAX); 391 dev->open_handle_count = 0; 392 393 dev->pxp_mode = MEI_DEV_PXP_DEFAULT; 394 395 /* 396 * Reserving the first client ID 397 * 0: Reserved for MEI Bus Message communications 398 */ 399 bitmap_set(dev->host_clients_map, 0, 1); 400 401 dev->pg_event = MEI_PG_EVENT_IDLE; 402 dev->ops = hw_ops; 403 dev->dev = device; 404 405 dev->timeouts.hw_ready = mei_secs_to_jiffies(MEI_HW_READY_TIMEOUT); 406 dev->timeouts.connect = MEI_CONNECT_TIMEOUT; 407 dev->timeouts.client_init = MEI_CLIENTS_INIT_TIMEOUT; 408 dev->timeouts.pgi = mei_secs_to_jiffies(MEI_PGI_TIMEOUT); 409 dev->timeouts.d0i3 = mei_secs_to_jiffies(MEI_D0I3_TIMEOUT); 410 if (slow_fw) { 411 dev->timeouts.cl_connect = mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT_SLOW); 412 dev->timeouts.hbm = mei_secs_to_jiffies(MEI_HBM_TIMEOUT_SLOW); 413 dev->timeouts.mkhi_recv = msecs_to_jiffies(MKHI_RCV_TIMEOUT_SLOW); 414 } else { 415 dev->timeouts.cl_connect = mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT); 416 dev->timeouts.hbm = mei_secs_to_jiffies(MEI_HBM_TIMEOUT); 417 dev->timeouts.mkhi_recv = msecs_to_jiffies(MKHI_RCV_TIMEOUT); 418 } 419 } 420 EXPORT_SYMBOL_GPL(mei_device_init); 421 422