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