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