1 /* 2 * 3 * Intel Management Engine Interface (Intel MEI) Linux driver 4 * Copyright (c) 2003-2012, Intel Corporation. 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 17 #ifndef _MEI_DEV_H_ 18 #define _MEI_DEV_H_ 19 20 #include <linux/types.h> 21 #include <linux/watchdog.h> 22 #include <linux/poll.h> 23 #include <linux/mei.h> 24 #include <linux/mei_cl_bus.h> 25 26 #include "hw.h" 27 #include "hw-me-regs.h" 28 #include "hbm.h" 29 30 /* 31 * watch dog definition 32 */ 33 #define MEI_WD_HDR_SIZE 4 34 #define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE 35 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16) 36 37 #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */ 38 #define MEI_WD_MIN_TIMEOUT 120 /* seconds */ 39 #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */ 40 41 #define MEI_WD_STOP_TIMEOUT 10 /* msecs */ 42 43 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0) 44 45 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32)) 46 47 48 /* 49 * AMTHI Client UUID 50 */ 51 extern const uuid_le mei_amthif_guid; 52 53 /* 54 * Watchdog Client UUID 55 */ 56 extern const uuid_le mei_wd_guid; 57 58 /* 59 * Number of Maximum MEI Clients 60 */ 61 #define MEI_CLIENTS_MAX 256 62 63 /* 64 * Number of File descriptors/handles 65 * that can be opened to the driver. 66 * 67 * Limit to 255: 256 Total Clients 68 * minus internal client for MEI Bus Messags 69 */ 70 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1) 71 72 /* 73 * Internal Clients Number 74 */ 75 #define MEI_HOST_CLIENT_ID_ANY (-1) 76 #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */ 77 #define MEI_WD_HOST_CLIENT_ID 1 78 #define MEI_IAMTHIF_HOST_CLIENT_ID 2 79 80 81 /* File state */ 82 enum file_state { 83 MEI_FILE_INITIALIZING = 0, 84 MEI_FILE_CONNECTING, 85 MEI_FILE_CONNECTED, 86 MEI_FILE_DISCONNECTING, 87 MEI_FILE_DISCONNECTED 88 }; 89 90 /* MEI device states */ 91 enum mei_dev_state { 92 MEI_DEV_INITIALIZING = 0, 93 MEI_DEV_INIT_CLIENTS, 94 MEI_DEV_ENABLED, 95 MEI_DEV_RESETTING, 96 MEI_DEV_DISABLED, 97 MEI_DEV_POWER_DOWN, 98 MEI_DEV_POWER_UP 99 }; 100 101 const char *mei_dev_state_str(int state); 102 103 enum iamthif_states { 104 MEI_IAMTHIF_IDLE, 105 MEI_IAMTHIF_WRITING, 106 MEI_IAMTHIF_FLOW_CONTROL, 107 MEI_IAMTHIF_READING, 108 MEI_IAMTHIF_READ_COMPLETE 109 }; 110 111 enum mei_file_transaction_states { 112 MEI_IDLE, 113 MEI_WRITING, 114 MEI_WRITE_COMPLETE, 115 MEI_FLOW_CONTROL, 116 MEI_READING, 117 MEI_READ_COMPLETE 118 }; 119 120 enum mei_wd_states { 121 MEI_WD_IDLE, 122 MEI_WD_RUNNING, 123 MEI_WD_STOPPING, 124 }; 125 126 /** 127 * enum mei_cb_file_ops - file operation associated with the callback 128 * @MEI_FOP_READ - read 129 * @MEI_FOP_WRITE - write 130 * @MEI_FOP_IOCTL - ioctl 131 * @MEI_FOP_OPEN - open 132 * @MEI_FOP_CLOSE - close 133 */ 134 enum mei_cb_file_ops { 135 MEI_FOP_READ = 0, 136 MEI_FOP_WRITE, 137 MEI_FOP_IOCTL, 138 MEI_FOP_OPEN, 139 MEI_FOP_CLOSE 140 }; 141 142 /* 143 * Intel MEI message data struct 144 */ 145 struct mei_msg_data { 146 u32 size; 147 unsigned char *data; 148 }; 149 150 /** 151 * struct mei_me_client - representation of me (fw) client 152 * 153 * @props - client properties 154 * @client_id - me client id 155 * @mei_flow_ctrl_creds - flow control credits 156 */ 157 struct mei_me_client { 158 struct mei_client_properties props; 159 u8 client_id; 160 u8 mei_flow_ctrl_creds; 161 }; 162 163 164 struct mei_cl; 165 166 /** 167 * struct mei_cl_cb - file operation callback structure 168 * 169 * @cl - file client who is running this operation 170 * @fop_type - file operation type 171 */ 172 struct mei_cl_cb { 173 struct list_head list; 174 struct mei_cl *cl; 175 enum mei_cb_file_ops fop_type; 176 struct mei_msg_data request_buffer; 177 struct mei_msg_data response_buffer; 178 unsigned long buf_idx; 179 unsigned long read_time; 180 struct file *file_object; 181 u32 internal:1; 182 }; 183 184 /* MEI client instance carried as file->pirvate_data*/ 185 struct mei_cl { 186 struct list_head link; 187 struct mei_device *dev; 188 enum file_state state; 189 wait_queue_head_t tx_wait; 190 wait_queue_head_t rx_wait; 191 wait_queue_head_t wait; 192 int status; 193 /* ID of client connected */ 194 u8 host_client_id; 195 u8 me_client_id; 196 u8 mei_flow_ctrl_creds; 197 u8 timer_count; 198 enum mei_file_transaction_states reading_state; 199 enum mei_file_transaction_states writing_state; 200 struct mei_cl_cb *read_cb; 201 202 /* MEI CL bus data */ 203 struct mei_cl_device *device; 204 struct list_head device_link; 205 uuid_le device_uuid; 206 }; 207 208 /** struct mei_hw_ops 209 * 210 * @host_is_ready - query for host readiness 211 212 * @hw_is_ready - query if hw is ready 213 * @hw_reset - reset hw 214 * @hw_start - start hw after reset 215 * @hw_config - configure hw 216 217 * @intr_clear - clear pending interrupts 218 * @intr_enable - enable interrupts 219 * @intr_disable - disable interrupts 220 221 * @hbuf_free_slots - query for write buffer empty slots 222 * @hbuf_is_ready - query if write buffer is empty 223 * @hbuf_max_len - query for write buffer max len 224 225 * @write - write a message to FW 226 227 * @rdbuf_full_slots - query how many slots are filled 228 229 * @read_hdr - get first 4 bytes (header) 230 * @read - read a buffer from the FW 231 */ 232 struct mei_hw_ops { 233 234 bool (*host_is_ready) (struct mei_device *dev); 235 236 bool (*hw_is_ready) (struct mei_device *dev); 237 int (*hw_reset) (struct mei_device *dev, bool enable); 238 int (*hw_start) (struct mei_device *dev); 239 void (*hw_config) (struct mei_device *dev); 240 241 void (*intr_clear) (struct mei_device *dev); 242 void (*intr_enable) (struct mei_device *dev); 243 void (*intr_disable) (struct mei_device *dev); 244 245 int (*hbuf_free_slots) (struct mei_device *dev); 246 bool (*hbuf_is_ready) (struct mei_device *dev); 247 size_t (*hbuf_max_len) (const struct mei_device *dev); 248 249 int (*write)(struct mei_device *dev, 250 struct mei_msg_hdr *hdr, 251 unsigned char *buf); 252 253 int (*rdbuf_full_slots)(struct mei_device *dev); 254 255 u32 (*read_hdr)(const struct mei_device *dev); 256 int (*read) (struct mei_device *dev, 257 unsigned char *buf, unsigned long len); 258 }; 259 260 /* MEI bus API*/ 261 262 /** 263 * struct mei_cl_ops - MEI CL device ops 264 * This structure allows ME host clients to implement technology 265 * specific operations. 266 * 267 * @enable: Enable an MEI CL device. Some devices require specific 268 * HECI commands to initialize completely. 269 * @disable: Disable an MEI CL device. 270 * @send: Tx hook for the device. This allows ME host clients to trap 271 * the device driver buffers before actually physically 272 * pushing it to the ME. 273 * @recv: Rx hook for the device. This allows ME host clients to trap the 274 * ME buffers before forwarding them to the device driver. 275 */ 276 struct mei_cl_ops { 277 int (*enable)(struct mei_cl_device *device); 278 int (*disable)(struct mei_cl_device *device); 279 int (*send)(struct mei_cl_device *device, u8 *buf, size_t length); 280 int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length); 281 }; 282 283 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev, 284 uuid_le uuid, char *name, 285 struct mei_cl_ops *ops); 286 void mei_cl_remove_device(struct mei_cl_device *device); 287 288 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length); 289 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length); 290 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length); 291 void mei_cl_bus_rx_event(struct mei_cl *cl); 292 int mei_cl_bus_init(void); 293 void mei_cl_bus_exit(void); 294 295 296 /** 297 * struct mei_cl_device - MEI device handle 298 * An mei_cl_device pointer is returned from mei_add_device() 299 * and links MEI bus clients to their actual ME host client pointer. 300 * Drivers for MEI devices will get an mei_cl_device pointer 301 * when being probed and shall use it for doing ME bus I/O. 302 * 303 * @dev: linux driver model device pointer 304 * @uuid: me client uuid 305 * @cl: mei client 306 * @ops: ME transport ops 307 * @event_cb: Drivers register this callback to get asynchronous ME 308 * events (e.g. Rx buffer pending) notifications. 309 * @events: Events bitmask sent to the driver. 310 * @priv_data: client private data 311 */ 312 struct mei_cl_device { 313 struct device dev; 314 315 struct mei_cl *cl; 316 317 const struct mei_cl_ops *ops; 318 319 struct work_struct event_work; 320 mei_cl_event_cb_t event_cb; 321 void *event_context; 322 unsigned long events; 323 324 void *priv_data; 325 }; 326 327 /** 328 * struct mei_device - MEI private device struct 329 330 * @hbm_state - state of host bus message protocol 331 * @mem_addr - mem mapped base register address 332 333 * @hbuf_depth - depth of hardware host/write buffer is slots 334 * @hbuf_is_ready - query if the host host/write buffer is ready 335 * @wr_msg - the buffer for hbm control messages 336 * @wr_ext_msg - the buffer for hbm control responses (set in read cycle) 337 */ 338 struct mei_device { 339 struct pci_dev *pdev; /* pointer to pci device struct */ 340 /* 341 * lists of queues 342 */ 343 /* array of pointers to aio lists */ 344 struct mei_cl_cb read_list; /* driver read queue */ 345 struct mei_cl_cb write_list; /* driver write queue */ 346 struct mei_cl_cb write_waiting_list; /* write waiting queue */ 347 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */ 348 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */ 349 350 /* 351 * list of files 352 */ 353 struct list_head file_list; 354 long open_handle_count; 355 356 /* 357 * lock for the device 358 */ 359 struct mutex device_lock; /* device lock */ 360 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */ 361 362 bool recvd_hw_ready; 363 /* 364 * waiting queue for receive message from FW 365 */ 366 wait_queue_head_t wait_hw_ready; 367 wait_queue_head_t wait_recvd_msg; 368 wait_queue_head_t wait_stop_wd; 369 370 /* 371 * mei device states 372 */ 373 enum mei_dev_state dev_state; 374 enum mei_hbm_state hbm_state; 375 u16 init_clients_timer; 376 377 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */ 378 u32 rd_msg_hdr; 379 380 /* write buffer */ 381 u8 hbuf_depth; 382 bool hbuf_is_ready; 383 384 /* used for control messages */ 385 struct { 386 struct mei_msg_hdr hdr; 387 unsigned char data[128]; 388 } wr_msg; 389 390 struct { 391 struct mei_msg_hdr hdr; 392 unsigned char data[4]; /* All HBM messages are 4 bytes */ 393 } wr_ext_msg; /* for control responses */ 394 395 struct hbm_version version; 396 397 struct mei_me_client *me_clients; /* Note: memory has to be allocated */ 398 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX); 399 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX); 400 unsigned long me_clients_num; 401 unsigned long me_client_presentation_num; 402 unsigned long me_client_index; 403 404 struct mei_cl wd_cl; 405 enum mei_wd_states wd_state; 406 bool wd_pending; 407 u16 wd_timeout; 408 unsigned char wd_data[MEI_WD_START_MSG_SIZE]; 409 410 411 /* amthif list for cmd waiting */ 412 struct mei_cl_cb amthif_cmd_list; 413 /* driver managed amthif list for reading completed amthif cmd data */ 414 struct mei_cl_cb amthif_rd_complete_list; 415 struct file *iamthif_file_object; 416 struct mei_cl iamthif_cl; 417 struct mei_cl_cb *iamthif_current_cb; 418 long iamthif_open_count; 419 int iamthif_mtu; 420 unsigned long iamthif_timer; 421 u32 iamthif_stall_timer; 422 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */ 423 u32 iamthif_msg_buf_size; 424 u32 iamthif_msg_buf_index; 425 enum iamthif_states iamthif_state; 426 bool iamthif_flow_control_pending; 427 bool iamthif_ioctl; 428 bool iamthif_canceled; 429 430 struct work_struct init_work; 431 432 /* List of bus devices */ 433 struct list_head device_list; 434 435 #if IS_ENABLED(CONFIG_DEBUG_FS) 436 struct dentry *dbgfs_dir; 437 #endif /* CONFIG_DEBUG_FS */ 438 439 440 const struct mei_hw_ops *ops; 441 char hw[0] __aligned(sizeof(void *)); 442 }; 443 444 static inline unsigned long mei_secs_to_jiffies(unsigned long sec) 445 { 446 return msecs_to_jiffies(sec * MSEC_PER_SEC); 447 } 448 449 /** 450 * mei_data2slots - get slots - number of (dwords) from a message length 451 * + size of the mei header 452 * @length - size of the messages in bytes 453 * returns - number of slots 454 */ 455 static inline u32 mei_data2slots(size_t length) 456 { 457 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4); 458 } 459 460 /** 461 * mei_slots2data- get data in slots - bytes from slots 462 * @slots - number of available slots 463 * returns - number of bytes in slots 464 */ 465 static inline u32 mei_slots2data(int slots) 466 { 467 return slots * 4; 468 } 469 470 /* 471 * mei init function prototypes 472 */ 473 void mei_device_init(struct mei_device *dev); 474 void mei_reset(struct mei_device *dev, int interrupts); 475 int mei_start(struct mei_device *dev); 476 void mei_stop(struct mei_device *dev); 477 void mei_cancel_work(struct mei_device *dev); 478 479 /* 480 * MEI interrupt functions prototype 481 */ 482 483 void mei_timer(struct work_struct *work); 484 int mei_irq_read_handler(struct mei_device *dev, 485 struct mei_cl_cb *cmpl_list, s32 *slots); 486 487 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); 488 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); 489 490 /* 491 * AMTHIF - AMT Host Interface Functions 492 */ 493 void mei_amthif_reset_params(struct mei_device *dev); 494 495 int mei_amthif_host_init(struct mei_device *dev); 496 497 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb); 498 499 int mei_amthif_read(struct mei_device *dev, struct file *file, 500 char __user *ubuf, size_t length, loff_t *offset); 501 502 unsigned int mei_amthif_poll(struct mei_device *dev, 503 struct file *file, poll_table *wait); 504 505 int mei_amthif_release(struct mei_device *dev, struct file *file); 506 507 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev, 508 struct file *file); 509 510 void mei_amthif_run_next_cmd(struct mei_device *dev); 511 512 int mei_amthif_irq_write_complete(struct mei_cl *cl, struct mei_cl_cb *cb, 513 s32 *slots, struct mei_cl_cb *cmpl_list); 514 515 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb); 516 int mei_amthif_irq_read_msg(struct mei_device *dev, 517 struct mei_msg_hdr *mei_hdr, 518 struct mei_cl_cb *complete_list); 519 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots); 520 521 /* 522 * NFC functions 523 */ 524 int mei_nfc_host_init(struct mei_device *dev); 525 void mei_nfc_host_exit(struct mei_device *dev); 526 527 /* 528 * NFC Client UUID 529 */ 530 extern const uuid_le mei_nfc_guid; 531 532 int mei_wd_send(struct mei_device *dev); 533 int mei_wd_stop(struct mei_device *dev); 534 int mei_wd_host_init(struct mei_device *dev); 535 /* 536 * mei_watchdog_register - Registering watchdog interface 537 * once we got connection to the WD Client 538 * @dev - mei device 539 */ 540 void mei_watchdog_register(struct mei_device *dev); 541 /* 542 * mei_watchdog_unregister - Unregistering watchdog interface 543 * @dev - mei device 544 */ 545 void mei_watchdog_unregister(struct mei_device *dev); 546 547 /* 548 * Register Access Function 549 */ 550 551 static inline void mei_hw_config(struct mei_device *dev) 552 { 553 dev->ops->hw_config(dev); 554 } 555 static inline int mei_hw_reset(struct mei_device *dev, bool enable) 556 { 557 return dev->ops->hw_reset(dev, enable); 558 } 559 560 static inline int mei_hw_start(struct mei_device *dev) 561 { 562 return dev->ops->hw_start(dev); 563 } 564 565 static inline void mei_clear_interrupts(struct mei_device *dev) 566 { 567 dev->ops->intr_clear(dev); 568 } 569 570 static inline void mei_enable_interrupts(struct mei_device *dev) 571 { 572 dev->ops->intr_enable(dev); 573 } 574 575 static inline void mei_disable_interrupts(struct mei_device *dev) 576 { 577 dev->ops->intr_disable(dev); 578 } 579 580 static inline bool mei_host_is_ready(struct mei_device *dev) 581 { 582 return dev->ops->host_is_ready(dev); 583 } 584 static inline bool mei_hw_is_ready(struct mei_device *dev) 585 { 586 return dev->ops->hw_is_ready(dev); 587 } 588 589 static inline bool mei_hbuf_is_ready(struct mei_device *dev) 590 { 591 return dev->ops->hbuf_is_ready(dev); 592 } 593 594 static inline int mei_hbuf_empty_slots(struct mei_device *dev) 595 { 596 return dev->ops->hbuf_free_slots(dev); 597 } 598 599 static inline size_t mei_hbuf_max_len(const struct mei_device *dev) 600 { 601 return dev->ops->hbuf_max_len(dev); 602 } 603 604 static inline int mei_write_message(struct mei_device *dev, 605 struct mei_msg_hdr *hdr, 606 unsigned char *buf) 607 { 608 return dev->ops->write(dev, hdr, buf); 609 } 610 611 static inline u32 mei_read_hdr(const struct mei_device *dev) 612 { 613 return dev->ops->read_hdr(dev); 614 } 615 616 static inline void mei_read_slots(struct mei_device *dev, 617 unsigned char *buf, unsigned long len) 618 { 619 dev->ops->read(dev, buf, len); 620 } 621 622 static inline int mei_count_full_read_slots(struct mei_device *dev) 623 { 624 return dev->ops->rdbuf_full_slots(dev); 625 } 626 627 #if IS_ENABLED(CONFIG_DEBUG_FS) 628 int mei_dbgfs_register(struct mei_device *dev, const char *name); 629 void mei_dbgfs_deregister(struct mei_device *dev); 630 #else 631 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name) 632 { 633 return 0; 634 } 635 static inline void mei_dbgfs_deregister(struct mei_device *dev) {} 636 #endif /* CONFIG_DEBUG_FS */ 637 638 int mei_register(struct mei_device *dev); 639 void mei_deregister(struct mei_device *dev); 640 641 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d" 642 #define MEI_HDR_PRM(hdr) \ 643 (hdr)->host_addr, (hdr)->me_addr, \ 644 (hdr)->length, (hdr)->internal, (hdr)->msg_complete 645 646 #endif 647