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 "hbm.h" 28 29 /* 30 * watch dog definition 31 */ 32 #define MEI_WD_HDR_SIZE 4 33 #define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE 34 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16) 35 36 #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */ 37 #define MEI_WD_MIN_TIMEOUT 120 /* seconds */ 38 #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */ 39 40 #define MEI_WD_STOP_TIMEOUT 10 /* msecs */ 41 42 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0) 43 44 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32)) 45 46 47 /* 48 * AMTHI Client UUID 49 */ 50 extern const uuid_le mei_amthif_guid; 51 52 /* 53 * Watchdog Client UUID 54 */ 55 extern const uuid_le mei_wd_guid; 56 57 /* 58 * Number of Maximum MEI Clients 59 */ 60 #define MEI_CLIENTS_MAX 256 61 62 /* 63 * maximum number of consecutive resets 64 */ 65 #define MEI_MAX_CONSEC_RESET 3 66 67 /* 68 * Number of File descriptors/handles 69 * that can be opened to the driver. 70 * 71 * Limit to 255: 256 Total Clients 72 * minus internal client for MEI Bus Messages 73 */ 74 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1) 75 76 /* 77 * Internal Clients Number 78 */ 79 #define MEI_HOST_CLIENT_ID_ANY (-1) 80 #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */ 81 #define MEI_WD_HOST_CLIENT_ID 1 82 #define MEI_IAMTHIF_HOST_CLIENT_ID 2 83 84 85 /* File state */ 86 enum file_state { 87 MEI_FILE_INITIALIZING = 0, 88 MEI_FILE_CONNECTING, 89 MEI_FILE_CONNECTED, 90 MEI_FILE_DISCONNECTING, 91 MEI_FILE_DISCONNECT_REPLY, 92 MEI_FILE_DISCONNECT_REQUIRED, 93 MEI_FILE_DISCONNECTED, 94 }; 95 96 /* MEI device states */ 97 enum mei_dev_state { 98 MEI_DEV_INITIALIZING = 0, 99 MEI_DEV_INIT_CLIENTS, 100 MEI_DEV_ENABLED, 101 MEI_DEV_RESETTING, 102 MEI_DEV_DISABLED, 103 MEI_DEV_POWER_DOWN, 104 MEI_DEV_POWER_UP 105 }; 106 107 const char *mei_dev_state_str(int state); 108 109 enum iamthif_states { 110 MEI_IAMTHIF_IDLE, 111 MEI_IAMTHIF_WRITING, 112 MEI_IAMTHIF_FLOW_CONTROL, 113 MEI_IAMTHIF_READING, 114 MEI_IAMTHIF_READ_COMPLETE 115 }; 116 117 enum mei_file_transaction_states { 118 MEI_IDLE, 119 MEI_WRITING, 120 MEI_WRITE_COMPLETE, 121 MEI_FLOW_CONTROL, 122 MEI_READING, 123 MEI_READ_COMPLETE 124 }; 125 126 enum mei_wd_states { 127 MEI_WD_IDLE, 128 MEI_WD_RUNNING, 129 MEI_WD_STOPPING, 130 }; 131 132 /** 133 * enum mei_cb_file_ops - file operation associated with the callback 134 * @MEI_FOP_READ: read 135 * @MEI_FOP_WRITE: write 136 * @MEI_FOP_CONNECT: connect 137 * @MEI_FOP_DISCONNECT: disconnect 138 * @MEI_FOP_DISCONNECT_RSP: disconnect response 139 * @MEI_FOP_NOTIFY_START: start notification 140 * @MEI_FOP_NOTIFY_STOP: stop notification 141 */ 142 enum mei_cb_file_ops { 143 MEI_FOP_READ = 0, 144 MEI_FOP_WRITE, 145 MEI_FOP_CONNECT, 146 MEI_FOP_DISCONNECT, 147 MEI_FOP_DISCONNECT_RSP, 148 MEI_FOP_NOTIFY_START, 149 MEI_FOP_NOTIFY_STOP, 150 }; 151 152 /* 153 * Intel MEI message data struct 154 */ 155 struct mei_msg_data { 156 u32 size; 157 unsigned char *data; 158 }; 159 160 /* Maximum number of processed FW status registers */ 161 #define MEI_FW_STATUS_MAX 6 162 /* Minimal buffer for FW status string (8 bytes in dw + space or '\0') */ 163 #define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1)) 164 165 166 /* 167 * struct mei_fw_status - storage of FW status data 168 * 169 * @count: number of actually available elements in array 170 * @status: FW status registers 171 */ 172 struct mei_fw_status { 173 int count; 174 u32 status[MEI_FW_STATUS_MAX]; 175 }; 176 177 /** 178 * struct mei_me_client - representation of me (fw) client 179 * 180 * @list: link in me client list 181 * @refcnt: struct reference count 182 * @props: client properties 183 * @client_id: me client id 184 * @mei_flow_ctrl_creds: flow control credits 185 * @connect_count: number connections to this client 186 * @bus_added: added to bus 187 */ 188 struct mei_me_client { 189 struct list_head list; 190 struct kref refcnt; 191 struct mei_client_properties props; 192 u8 client_id; 193 u8 mei_flow_ctrl_creds; 194 u8 connect_count; 195 u8 bus_added; 196 }; 197 198 199 struct mei_cl; 200 201 /** 202 * struct mei_cl_cb - file operation callback structure 203 * 204 * @list: link in callback queue 205 * @cl: file client who is running this operation 206 * @fop_type: file operation type 207 * @buf: buffer for data associated with the callback 208 * @buf_idx: last read index 209 * @read_time: last read operation time stamp (iamthif) 210 * @file_object: pointer to file structure 211 * @status: io status of the cb 212 * @internal: communication between driver and FW flag 213 * @completed: the transfer or reception has completed 214 */ 215 struct mei_cl_cb { 216 struct list_head list; 217 struct mei_cl *cl; 218 enum mei_cb_file_ops fop_type; 219 struct mei_msg_data buf; 220 unsigned long buf_idx; 221 unsigned long read_time; 222 struct file *file_object; 223 int status; 224 u32 internal:1; 225 u32 completed:1; 226 }; 227 228 /** 229 * struct mei_cl - me client host representation 230 * carried in file->private_data 231 * 232 * @link: link in the clients list 233 * @dev: mei parent device 234 * @state: file operation state 235 * @tx_wait: wait queue for tx completion 236 * @rx_wait: wait queue for rx completion 237 * @wait: wait queue for management operation 238 * @ev_wait: notification wait queue 239 * @ev_async: event async notification 240 * @status: connection status 241 * @me_cl: fw client connected 242 * @host_client_id: host id 243 * @mei_flow_ctrl_creds: transmit flow credentials 244 * @timer_count: watchdog timer for operation completion 245 * @reserved: reserved for alignment 246 * @notify_en: notification - enabled/disabled 247 * @notify_ev: pending notification event 248 * @writing_state: state of the tx 249 * @rd_pending: pending read credits 250 * @rd_completed: completed read 251 * 252 * @cldev: device on the mei client bus 253 */ 254 struct mei_cl { 255 struct list_head link; 256 struct mei_device *dev; 257 enum file_state state; 258 wait_queue_head_t tx_wait; 259 wait_queue_head_t rx_wait; 260 wait_queue_head_t wait; 261 wait_queue_head_t ev_wait; 262 struct fasync_struct *ev_async; 263 int status; 264 struct mei_me_client *me_cl; 265 u8 host_client_id; 266 u8 mei_flow_ctrl_creds; 267 u8 timer_count; 268 u8 reserved; 269 u8 notify_en; 270 u8 notify_ev; 271 enum mei_file_transaction_states writing_state; 272 struct list_head rd_pending; 273 struct list_head rd_completed; 274 275 struct mei_cl_device *cldev; 276 }; 277 278 /** struct mei_hw_ops 279 * 280 * @host_is_ready : query for host readiness 281 282 * @hw_is_ready : query if hw is ready 283 * @hw_reset : reset hw 284 * @hw_start : start hw after reset 285 * @hw_config : configure hw 286 287 * @fw_status : get fw status registers 288 * @pg_state : power gating state of the device 289 * @pg_in_transition : is device now in pg transition 290 * @pg_is_enabled : is power gating enabled 291 292 * @intr_clear : clear pending interrupts 293 * @intr_enable : enable interrupts 294 * @intr_disable : disable interrupts 295 296 * @hbuf_free_slots : query for write buffer empty slots 297 * @hbuf_is_ready : query if write buffer is empty 298 * @hbuf_max_len : query for write buffer max len 299 300 * @write : write a message to FW 301 302 * @rdbuf_full_slots : query how many slots are filled 303 304 * @read_hdr : get first 4 bytes (header) 305 * @read : read a buffer from the FW 306 */ 307 struct mei_hw_ops { 308 309 bool (*host_is_ready)(struct mei_device *dev); 310 311 bool (*hw_is_ready)(struct mei_device *dev); 312 int (*hw_reset)(struct mei_device *dev, bool enable); 313 int (*hw_start)(struct mei_device *dev); 314 void (*hw_config)(struct mei_device *dev); 315 316 317 int (*fw_status)(struct mei_device *dev, struct mei_fw_status *fw_sts); 318 enum mei_pg_state (*pg_state)(struct mei_device *dev); 319 bool (*pg_in_transition)(struct mei_device *dev); 320 bool (*pg_is_enabled)(struct mei_device *dev); 321 322 void (*intr_clear)(struct mei_device *dev); 323 void (*intr_enable)(struct mei_device *dev); 324 void (*intr_disable)(struct mei_device *dev); 325 326 int (*hbuf_free_slots)(struct mei_device *dev); 327 bool (*hbuf_is_ready)(struct mei_device *dev); 328 size_t (*hbuf_max_len)(const struct mei_device *dev); 329 330 int (*write)(struct mei_device *dev, 331 struct mei_msg_hdr *hdr, 332 unsigned char *buf); 333 334 int (*rdbuf_full_slots)(struct mei_device *dev); 335 336 u32 (*read_hdr)(const struct mei_device *dev); 337 int (*read)(struct mei_device *dev, 338 unsigned char *buf, unsigned long len); 339 }; 340 341 /* MEI bus API*/ 342 void mei_cl_bus_rescan(struct mei_device *bus); 343 void mei_cl_dev_fixup(struct mei_cl_device *dev); 344 ssize_t __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length, 345 bool blocking); 346 ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length); 347 void mei_cl_bus_rx_event(struct mei_cl *cl); 348 void mei_cl_bus_notify_event(struct mei_cl *cl); 349 void mei_cl_bus_remove_devices(struct mei_device *bus); 350 int mei_cl_bus_init(void); 351 void mei_cl_bus_exit(void); 352 353 /** 354 * enum mei_pg_event - power gating transition events 355 * 356 * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition 357 * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete 358 * @MEI_PG_EVENT_RECEIVED: the driver received pg event 359 * @MEI_PG_EVENT_INTR_WAIT: the driver is waiting for a pg event interrupt 360 * @MEI_PG_EVENT_INTR_RECEIVED: the driver received pg event interrupt 361 */ 362 enum mei_pg_event { 363 MEI_PG_EVENT_IDLE, 364 MEI_PG_EVENT_WAIT, 365 MEI_PG_EVENT_RECEIVED, 366 MEI_PG_EVENT_INTR_WAIT, 367 MEI_PG_EVENT_INTR_RECEIVED, 368 }; 369 370 /** 371 * enum mei_pg_state - device internal power gating state 372 * 373 * @MEI_PG_OFF: device is not power gated - it is active 374 * @MEI_PG_ON: device is power gated - it is in lower power state 375 */ 376 enum mei_pg_state { 377 MEI_PG_OFF = 0, 378 MEI_PG_ON = 1, 379 }; 380 381 const char *mei_pg_state_str(enum mei_pg_state state); 382 383 /** 384 * struct mei_device - MEI private device struct 385 * 386 * @dev : device on a bus 387 * @cdev : character device 388 * @minor : minor number allocated for device 389 * 390 * @write_list : write pending list 391 * @write_waiting_list : write completion list 392 * @ctrl_wr_list : pending control write list 393 * @ctrl_rd_list : pending control read list 394 * 395 * @file_list : list of opened handles 396 * @open_handle_count: number of opened handles 397 * 398 * @device_lock : big device lock 399 * @timer_work : MEI timer delayed work (timeouts) 400 * 401 * @recvd_hw_ready : hw ready message received flag 402 * 403 * @wait_hw_ready : wait queue for receive HW ready message form FW 404 * @wait_pg : wait queue for receive PG message from FW 405 * @wait_hbm_start : wait queue for receive HBM start message from FW 406 * @wait_stop_wd : wait queue for receive WD stop message from FW 407 * 408 * @reset_count : number of consecutive resets 409 * @dev_state : device state 410 * @hbm_state : state of host bus message protocol 411 * @init_clients_timer : HBM init handshake timeout 412 * 413 * @pg_event : power gating event 414 * @pg_domain : runtime PM domain 415 * 416 * @rd_msg_buf : control messages buffer 417 * @rd_msg_hdr : read message header storage 418 * 419 * @hbuf_depth : depth of hardware host/write buffer is slots 420 * @hbuf_is_ready : query if the host host/write buffer is ready 421 * @wr_msg : the buffer for hbm control messages 422 * 423 * @version : HBM protocol version in use 424 * @hbm_f_pg_supported : hbm feature pgi protocol 425 * @hbm_f_dc_supported : hbm feature dynamic clients 426 * @hbm_f_dot_supported : hbm feature disconnect on timeout 427 * @hbm_f_ev_supported : hbm feature event notification 428 * 429 * @me_clients_rwsem: rw lock over me_clients list 430 * @me_clients : list of FW clients 431 * @me_clients_map : FW clients bit map 432 * @host_clients_map : host clients id pool 433 * @me_client_index : last FW client index in enumeration 434 * 435 * @allow_fixed_address: allow user space to connect a fixed client 436 * 437 * @wd_cl : watchdog client 438 * @wd_state : watchdog client state 439 * @wd_pending : watchdog command is pending 440 * @wd_timeout : watchdog expiration timeout 441 * @wd_data : watchdog message buffer 442 * 443 * @amthif_cmd_list : amthif list for cmd waiting 444 * @amthif_rd_complete_list : amthif list for reading completed cmd data 445 * @iamthif_file_object : file for current amthif operation 446 * @iamthif_cl : amthif host client 447 * @iamthif_current_cb : amthif current operation callback 448 * @iamthif_open_count : number of opened amthif connections 449 * @iamthif_timer : time stamp of current amthif command completion 450 * @iamthif_stall_timer : timer to detect amthif hang 451 * @iamthif_state : amthif processor state 452 * @iamthif_canceled : current amthif command is canceled 453 * 454 * @init_work : work item for the device init 455 * @reset_work : work item for the device reset 456 * 457 * @device_list : mei client bus list 458 * @cl_bus_lock : client bus list lock 459 * 460 * @dbgfs_dir : debugfs mei root directory 461 * 462 * @ops: : hw specific operations 463 * @hw : hw specific data 464 */ 465 struct mei_device { 466 struct device *dev; 467 struct cdev cdev; 468 int minor; 469 470 struct mei_cl_cb write_list; 471 struct mei_cl_cb write_waiting_list; 472 struct mei_cl_cb ctrl_wr_list; 473 struct mei_cl_cb ctrl_rd_list; 474 475 struct list_head file_list; 476 long open_handle_count; 477 478 struct mutex device_lock; 479 struct delayed_work timer_work; 480 481 bool recvd_hw_ready; 482 /* 483 * waiting queue for receive message from FW 484 */ 485 wait_queue_head_t wait_hw_ready; 486 wait_queue_head_t wait_pg; 487 wait_queue_head_t wait_hbm_start; 488 wait_queue_head_t wait_stop_wd; 489 490 /* 491 * mei device states 492 */ 493 unsigned long reset_count; 494 enum mei_dev_state dev_state; 495 enum mei_hbm_state hbm_state; 496 u16 init_clients_timer; 497 498 /* 499 * Power Gating support 500 */ 501 enum mei_pg_event pg_event; 502 #ifdef CONFIG_PM 503 struct dev_pm_domain pg_domain; 504 #endif /* CONFIG_PM */ 505 506 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; 507 u32 rd_msg_hdr; 508 509 /* write buffer */ 510 u8 hbuf_depth; 511 bool hbuf_is_ready; 512 513 /* used for control messages */ 514 struct { 515 struct mei_msg_hdr hdr; 516 unsigned char data[128]; 517 } wr_msg; 518 519 struct hbm_version version; 520 unsigned int hbm_f_pg_supported:1; 521 unsigned int hbm_f_dc_supported:1; 522 unsigned int hbm_f_dot_supported:1; 523 unsigned int hbm_f_ev_supported:1; 524 525 struct rw_semaphore me_clients_rwsem; 526 struct list_head me_clients; 527 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX); 528 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX); 529 unsigned long me_client_index; 530 531 u32 allow_fixed_address; 532 533 struct mei_cl wd_cl; 534 enum mei_wd_states wd_state; 535 bool wd_pending; 536 u16 wd_timeout; 537 unsigned char wd_data[MEI_WD_START_MSG_SIZE]; 538 539 540 /* amthif list for cmd waiting */ 541 struct mei_cl_cb amthif_cmd_list; 542 /* driver managed amthif list for reading completed amthif cmd data */ 543 struct mei_cl_cb amthif_rd_complete_list; 544 struct file *iamthif_file_object; 545 struct mei_cl iamthif_cl; 546 struct mei_cl_cb *iamthif_current_cb; 547 long iamthif_open_count; 548 unsigned long iamthif_timer; 549 u32 iamthif_stall_timer; 550 enum iamthif_states iamthif_state; 551 bool iamthif_canceled; 552 553 struct work_struct init_work; 554 struct work_struct reset_work; 555 556 /* List of bus devices */ 557 struct list_head device_list; 558 struct mutex cl_bus_lock; 559 560 #if IS_ENABLED(CONFIG_DEBUG_FS) 561 struct dentry *dbgfs_dir; 562 #endif /* CONFIG_DEBUG_FS */ 563 564 565 const struct mei_hw_ops *ops; 566 char hw[0] __aligned(sizeof(void *)); 567 }; 568 569 static inline unsigned long mei_secs_to_jiffies(unsigned long sec) 570 { 571 return msecs_to_jiffies(sec * MSEC_PER_SEC); 572 } 573 574 /** 575 * mei_data2slots - get slots - number of (dwords) from a message length 576 * + size of the mei header 577 * 578 * @length: size of the messages in bytes 579 * 580 * Return: number of slots 581 */ 582 static inline u32 mei_data2slots(size_t length) 583 { 584 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4); 585 } 586 587 /** 588 * mei_slots2data - get data in slots - bytes from slots 589 * 590 * @slots: number of available slots 591 * 592 * Return: number of bytes in slots 593 */ 594 static inline u32 mei_slots2data(int slots) 595 { 596 return slots * 4; 597 } 598 599 /* 600 * mei init function prototypes 601 */ 602 void mei_device_init(struct mei_device *dev, 603 struct device *device, 604 const struct mei_hw_ops *hw_ops); 605 int mei_reset(struct mei_device *dev); 606 int mei_start(struct mei_device *dev); 607 int mei_restart(struct mei_device *dev); 608 void mei_stop(struct mei_device *dev); 609 void mei_cancel_work(struct mei_device *dev); 610 611 /* 612 * MEI interrupt functions prototype 613 */ 614 615 void mei_timer(struct work_struct *work); 616 int mei_irq_read_handler(struct mei_device *dev, 617 struct mei_cl_cb *cmpl_list, s32 *slots); 618 619 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); 620 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); 621 622 /* 623 * AMTHIF - AMT Host Interface Functions 624 */ 625 void mei_amthif_reset_params(struct mei_device *dev); 626 627 int mei_amthif_host_init(struct mei_device *dev, struct mei_me_client *me_cl); 628 629 int mei_amthif_read(struct mei_device *dev, struct file *file, 630 char __user *ubuf, size_t length, loff_t *offset); 631 632 unsigned int mei_amthif_poll(struct mei_device *dev, 633 struct file *file, poll_table *wait); 634 635 int mei_amthif_release(struct mei_device *dev, struct file *file); 636 637 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev, 638 struct file *file); 639 640 int mei_amthif_write(struct mei_cl *cl, struct mei_cl_cb *cb); 641 int mei_amthif_run_next_cmd(struct mei_device *dev); 642 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, 643 struct mei_cl_cb *cmpl_list); 644 645 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb); 646 int mei_amthif_irq_read_msg(struct mei_cl *cl, 647 struct mei_msg_hdr *mei_hdr, 648 struct mei_cl_cb *complete_list); 649 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots); 650 651 /* 652 * NFC functions 653 */ 654 int mei_nfc_host_init(struct mei_device *dev, struct mei_me_client *me_cl); 655 void mei_nfc_host_exit(struct mei_device *dev); 656 657 /* 658 * NFC Client UUID 659 */ 660 extern const uuid_le mei_nfc_guid; 661 662 int mei_wd_send(struct mei_device *dev); 663 int mei_wd_stop(struct mei_device *dev); 664 int mei_wd_host_init(struct mei_device *dev, struct mei_me_client *me_cl); 665 /* 666 * mei_watchdog_register - Registering watchdog interface 667 * once we got connection to the WD Client 668 * @dev: mei device 669 */ 670 int mei_watchdog_register(struct mei_device *dev); 671 /* 672 * mei_watchdog_unregister - Unregistering watchdog interface 673 * @dev: mei device 674 */ 675 void mei_watchdog_unregister(struct mei_device *dev); 676 677 /* 678 * Register Access Function 679 */ 680 681 682 static inline void mei_hw_config(struct mei_device *dev) 683 { 684 dev->ops->hw_config(dev); 685 } 686 687 static inline enum mei_pg_state mei_pg_state(struct mei_device *dev) 688 { 689 return dev->ops->pg_state(dev); 690 } 691 692 static inline bool mei_pg_in_transition(struct mei_device *dev) 693 { 694 return dev->ops->pg_in_transition(dev); 695 } 696 697 static inline bool mei_pg_is_enabled(struct mei_device *dev) 698 { 699 return dev->ops->pg_is_enabled(dev); 700 } 701 702 static inline int mei_hw_reset(struct mei_device *dev, bool enable) 703 { 704 return dev->ops->hw_reset(dev, enable); 705 } 706 707 static inline int mei_hw_start(struct mei_device *dev) 708 { 709 return dev->ops->hw_start(dev); 710 } 711 712 static inline void mei_clear_interrupts(struct mei_device *dev) 713 { 714 dev->ops->intr_clear(dev); 715 } 716 717 static inline void mei_enable_interrupts(struct mei_device *dev) 718 { 719 dev->ops->intr_enable(dev); 720 } 721 722 static inline void mei_disable_interrupts(struct mei_device *dev) 723 { 724 dev->ops->intr_disable(dev); 725 } 726 727 static inline bool mei_host_is_ready(struct mei_device *dev) 728 { 729 return dev->ops->host_is_ready(dev); 730 } 731 static inline bool mei_hw_is_ready(struct mei_device *dev) 732 { 733 return dev->ops->hw_is_ready(dev); 734 } 735 736 static inline bool mei_hbuf_is_ready(struct mei_device *dev) 737 { 738 return dev->ops->hbuf_is_ready(dev); 739 } 740 741 static inline int mei_hbuf_empty_slots(struct mei_device *dev) 742 { 743 return dev->ops->hbuf_free_slots(dev); 744 } 745 746 static inline size_t mei_hbuf_max_len(const struct mei_device *dev) 747 { 748 return dev->ops->hbuf_max_len(dev); 749 } 750 751 static inline int mei_write_message(struct mei_device *dev, 752 struct mei_msg_hdr *hdr, 753 unsigned char *buf) 754 { 755 return dev->ops->write(dev, hdr, buf); 756 } 757 758 static inline u32 mei_read_hdr(const struct mei_device *dev) 759 { 760 return dev->ops->read_hdr(dev); 761 } 762 763 static inline void mei_read_slots(struct mei_device *dev, 764 unsigned char *buf, unsigned long len) 765 { 766 dev->ops->read(dev, buf, len); 767 } 768 769 static inline int mei_count_full_read_slots(struct mei_device *dev) 770 { 771 return dev->ops->rdbuf_full_slots(dev); 772 } 773 774 static inline int mei_fw_status(struct mei_device *dev, 775 struct mei_fw_status *fw_status) 776 { 777 return dev->ops->fw_status(dev, fw_status); 778 } 779 780 bool mei_hbuf_acquire(struct mei_device *dev); 781 782 bool mei_write_is_idle(struct mei_device *dev); 783 784 #if IS_ENABLED(CONFIG_DEBUG_FS) 785 int mei_dbgfs_register(struct mei_device *dev, const char *name); 786 void mei_dbgfs_deregister(struct mei_device *dev); 787 #else 788 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name) 789 { 790 return 0; 791 } 792 static inline void mei_dbgfs_deregister(struct mei_device *dev) {} 793 #endif /* CONFIG_DEBUG_FS */ 794 795 int mei_register(struct mei_device *dev, struct device *parent); 796 void mei_deregister(struct mei_device *dev); 797 798 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d" 799 #define MEI_HDR_PRM(hdr) \ 800 (hdr)->host_addr, (hdr)->me_addr, \ 801 (hdr)->length, (hdr)->internal, (hdr)->msg_complete 802 803 ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len); 804 /** 805 * mei_fw_status_str - fetch and convert fw status registers to printable string 806 * 807 * @dev: the device structure 808 * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ 809 * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ 810 * 811 * Return: number of bytes written or < 0 on failure 812 */ 813 static inline ssize_t mei_fw_status_str(struct mei_device *dev, 814 char *buf, size_t len) 815 { 816 struct mei_fw_status fw_status; 817 int ret; 818 819 buf[0] = '\0'; 820 821 ret = mei_fw_status(dev, &fw_status); 822 if (ret) 823 return ret; 824 825 ret = mei_fw_status2str(&fw_status, buf, MEI_FW_STATUS_STR_SZ); 826 827 return ret; 828 } 829 830 831 #endif 832