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