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