drivers/misc/mei/mei_dev.h

   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 "hw-me-regs.h"
  28 #include "hbm.h"
  29
  30 /*
  31  * watch dog definition
  32  */
  33 #define MEI_WD_HDR_SIZE       4
  34 #define MEI_WD_STOP_MSG_SIZE  MEI_WD_HDR_SIZE
  35 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
  36
  37 #define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
  38 #define MEI_WD_MIN_TIMEOUT       120  /* seconds */
  39 #define MEI_WD_MAX_TIMEOUT     65535  /* seconds */
  40
  41 #define MEI_WD_STOP_TIMEOUT      10 /* msecs */
  42
  43 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)
  44
  45 #define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))
  46
  47
  48 /*
  49  * AMTHI Client UUID
  50  */
  51 extern const uuid_le mei_amthif_guid;
  52
  53 /*
  54  * Watchdog Client UUID
  55  */
  56 extern const uuid_le mei_wd_guid;
  57
  58 /*
  59  * Number of Maximum MEI Clients
  60  */
  61 #define MEI_CLIENTS_MAX 256
  62
  63 /*
  64  * maximum number of consecutive resets
  65  */
  66 #define MEI_MAX_CONSEC_RESET  3
  67
  68 /*
  69  * Number of File descriptors/handles
  70  * that can be opened to the driver.
  71  *
  72  * Limit to 255: 256 Total Clients
  73  * minus internal client for MEI Bus Messages
  74  */
  75 #define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
  76
  77 /*
  78  * Internal Clients Number
  79  */
  80 #define MEI_HOST_CLIENT_ID_ANY        (-1)
  81 #define MEI_HBM_HOST_CLIENT_ID         0 /* not used, just for documentation */
  82 #define MEI_WD_HOST_CLIENT_ID          1
  83 #define MEI_IAMTHIF_HOST_CLIENT_ID     2
  84
  85
  86 /* File state */
  87 enum file_state {
  88         MEI_FILE_INITIALIZING = 0,
  89         MEI_FILE_CONNECTING,
  90         MEI_FILE_CONNECTED,
  91         MEI_FILE_DISCONNECTING,
  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_RSP - disconnect response
 137  * @MEI_FOP_OPEN      - open
 138  * @MEI_FOP_CLOSE     - close
 139  */
 140 enum mei_cb_file_ops {
 141         MEI_FOP_READ = 0,
 142         MEI_FOP_WRITE,
 143         MEI_FOP_CONNECT,
 144         MEI_FOP_DISCONNECT_RSP,
 145         MEI_FOP_OPEN,
 146         MEI_FOP_CLOSE
 147 };
 148
 149 /*
 150  * Intel MEI message data struct
 151  */
 152 struct mei_msg_data {
 153         u32 size;
 154         unsigned char *data;
 155 };
 156
 157 /**
 158  * struct mei_me_client - representation of me (fw) client
 159  *
 160  * @props  - client properties
 161  * @client_id - me client id
 162  * @mei_flow_ctrl_creds - flow control credits
 163  */
 164 struct mei_me_client {
 165         struct mei_client_properties props;
 166         u8 client_id;
 167         u8 mei_flow_ctrl_creds;
 168 };
 169
 170
 171 struct mei_cl;
 172
 173 /**
 174  * struct mei_cl_cb - file operation callback structure
 175  *
 176  * @cl - file client who is running this operation
 177  * @fop_type - file operation type
 178  */
 179 struct mei_cl_cb {
 180         struct list_head list;
 181         struct mei_cl *cl;
 182         enum mei_cb_file_ops fop_type;
 183         struct mei_msg_data request_buffer;
 184         struct mei_msg_data response_buffer;
 185         unsigned long buf_idx;
 186         unsigned long read_time;
 187         struct file *file_object;
 188         u32 internal:1;
 189 };
 190
 191 /* MEI client instance carried as file->private_data*/
 192 struct mei_cl {
 193         struct list_head link;
 194         struct mei_device *dev;
 195         enum file_state state;
 196         wait_queue_head_t tx_wait;
 197         wait_queue_head_t rx_wait;
 198         wait_queue_head_t wait;
 199         int status;
 200         /* ID of client connected */
 201         u8 host_client_id;
 202         u8 me_client_id;
 203         u8 mei_flow_ctrl_creds;
 204         u8 timer_count;
 205         enum mei_file_transaction_states reading_state;
 206         enum mei_file_transaction_states writing_state;
 207         struct mei_cl_cb *read_cb;
 208
 209         /* MEI CL bus data */
 210         struct mei_cl_device *device;
 211         struct list_head device_link;
 212         uuid_le device_uuid;
 213 };
 214
 215 /** struct mei_hw_ops
 216  *
 217  * @host_is_ready    - query for host readiness
 218
 219  * @hw_is_ready      - query if hw is ready
 220  * @hw_reset         - reset hw
 221  * @hw_start         - start hw after reset
 222  * @hw_config        - configure hw
 223
 224  * @intr_clear       - clear pending interrupts
 225  * @intr_enable      - enable interrupts
 226  * @intr_disable     - disable interrupts
 227
 228  * @hbuf_free_slots  - query for write buffer empty slots
 229  * @hbuf_is_ready    - query if write buffer is empty
 230  * @hbuf_max_len     - query for write buffer max len
 231
 232  * @write            - write a message to FW
 233
 234  * @rdbuf_full_slots - query how many slots are filled
 235
 236  * @read_hdr         - get first 4 bytes (header)
 237  * @read             - read a buffer from the FW
 238  */
 239 struct mei_hw_ops {
 240
 241         bool (*host_is_ready) (struct mei_device *dev);
 242
 243         bool (*hw_is_ready) (struct mei_device *dev);
 244         int (*hw_reset) (struct mei_device *dev, bool enable);
 245         int  (*hw_start) (struct mei_device *dev);
 246         void (*hw_config) (struct mei_device *dev);
 247
 248         void (*intr_clear) (struct mei_device *dev);
 249         void (*intr_enable) (struct mei_device *dev);
 250         void (*intr_disable) (struct mei_device *dev);
 251
 252         int (*hbuf_free_slots) (struct mei_device *dev);
 253         bool (*hbuf_is_ready) (struct mei_device *dev);
 254         size_t (*hbuf_max_len) (const struct mei_device *dev);
 255
 256         int (*write)(struct mei_device *dev,
 257                      struct mei_msg_hdr *hdr,
 258                      unsigned char *buf);
 259
 260         int (*rdbuf_full_slots)(struct mei_device *dev);
 261
 262         u32 (*read_hdr)(const struct mei_device *dev);
 263         int (*read) (struct mei_device *dev,
 264                      unsigned char *buf, unsigned long len);
 265 };
 266
 267 /* MEI bus API*/
 268
 269 /**
 270  * struct mei_cl_ops - MEI CL device ops
 271  * This structure allows ME host clients to implement technology
 272  * specific operations.
 273  *
 274  * @enable: Enable an MEI CL device. Some devices require specific
 275  *      HECI commands to initialize completely.
 276  * @disable: Disable an MEI CL device.
 277  * @send: Tx hook for the device. This allows ME host clients to trap
 278  *      the device driver buffers before actually physically
 279  *      pushing it to the ME.
 280  * @recv: Rx hook for the device. This allows ME host clients to trap the
 281  *      ME buffers before forwarding them to the device driver.
 282  */
 283 struct mei_cl_ops {
 284         int (*enable)(struct mei_cl_device *device);
 285         int (*disable)(struct mei_cl_device *device);
 286         int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
 287         int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
 288 };
 289
 290 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
 291                                         uuid_le uuid, char *name,
 292                                         struct mei_cl_ops *ops);
 293 void mei_cl_remove_device(struct mei_cl_device *device);
 294
 295 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
 296 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
 297 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
 298 void mei_cl_bus_rx_event(struct mei_cl *cl);
 299 void mei_cl_bus_remove_devices(struct mei_device *dev);
 300 int mei_cl_bus_init(void);
 301 void mei_cl_bus_exit(void);
 302
 303
 304 /**
 305  * struct mei_cl_device - MEI device handle
 306  * An mei_cl_device pointer is returned from mei_add_device()
 307  * and links MEI bus clients to their actual ME host client pointer.
 308  * Drivers for MEI devices will get an mei_cl_device pointer
 309  * when being probed and shall use it for doing ME bus I/O.
 310  *
 311  * @dev: linux driver model device pointer
 312  * @uuid: me client uuid
 313  * @cl: mei client
 314  * @ops: ME transport ops
 315  * @event_cb: Drivers register this callback to get asynchronous ME
 316  *      events (e.g. Rx buffer pending) notifications.
 317  * @events: Events bitmask sent to the driver.
 318  * @priv_data: client private data
 319  */
 320 struct mei_cl_device {
 321         struct device dev;
 322
 323         struct mei_cl *cl;
 324
 325         const struct mei_cl_ops *ops;
 326
 327         struct work_struct event_work;
 328         mei_cl_event_cb_t event_cb;
 329         void *event_context;
 330         unsigned long events;
 331
 332         void *priv_data;
 333 };
 334
 335 /**
 336  * struct mei_device -  MEI private device struct
 337
 338  * @reset_count - limits the number of consecutive resets
 339  * @hbm_state - state of host bus message protocol
 340  * @mem_addr - mem mapped base register address
 341
 342  * @hbuf_depth - depth of hardware host/write buffer is slots
 343  * @hbuf_is_ready - query if the host host/write buffer is ready
 344  * @wr_msg - the buffer for hbm control messages
 345  */
 346 struct mei_device {
 347         struct pci_dev *pdev;   /* pointer to pci device struct */
 348         /*
 349          * lists of queues
 350          */
 351         /* array of pointers to aio lists */
 352         struct mei_cl_cb read_list;             /* driver read queue */
 353         struct mei_cl_cb write_list;            /* driver write queue */
 354         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 355         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 356         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 357
 358         /*
 359          * list of files
 360          */
 361         struct list_head file_list;
 362         long open_handle_count;
 363
 364         /*
 365          * lock for the device
 366          */
 367         struct mutex device_lock; /* device lock */
 368         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 369
 370         bool recvd_hw_ready;
 371         /*
 372          * waiting queue for receive message from FW
 373          */
 374         wait_queue_head_t wait_hw_ready;
 375         wait_queue_head_t wait_recvd_msg;
 376         wait_queue_head_t wait_stop_wd;
 377
 378         /*
 379          * mei device  states
 380          */
 381         unsigned long reset_count;
 382         enum mei_dev_state dev_state;
 383         enum mei_hbm_state hbm_state;
 384         u16 init_clients_timer;
 385
 386         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 387         u32 rd_msg_hdr;
 388
 389         /* write buffer */
 390         u8 hbuf_depth;
 391         bool hbuf_is_ready;
 392
 393         /* used for control messages */
 394         struct {
 395                 struct mei_msg_hdr hdr;
 396                 unsigned char data[128];
 397         } wr_msg;
 398
 399         struct hbm_version version;
 400
 401         struct mei_me_client *me_clients; /* Note: memory has to be allocated */
 402         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 403         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 404         unsigned long me_clients_num;
 405         unsigned long me_client_presentation_num;
 406         unsigned long me_client_index;
 407
 408         struct mei_cl wd_cl;
 409         enum mei_wd_states wd_state;
 410         bool wd_pending;
 411         u16 wd_timeout;
 412         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 413
 414
 415         /* amthif list for cmd waiting */
 416         struct mei_cl_cb amthif_cmd_list;
 417         /* driver managed amthif list for reading completed amthif cmd data */
 418         struct mei_cl_cb amthif_rd_complete_list;
 419         struct file *iamthif_file_object;
 420         struct mei_cl iamthif_cl;
 421         struct mei_cl_cb *iamthif_current_cb;
 422         long iamthif_open_count;
 423         int iamthif_mtu;
 424         unsigned long iamthif_timer;
 425         u32 iamthif_stall_timer;
 426         unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
 427         u32 iamthif_msg_buf_size;
 428         u32 iamthif_msg_buf_index;
 429         enum iamthif_states iamthif_state;
 430         bool iamthif_flow_control_pending;
 431         bool iamthif_ioctl;
 432         bool iamthif_canceled;
 433
 434         struct work_struct init_work;
 435         struct work_struct reset_work;
 436
 437         /* List of bus devices */
 438         struct list_head device_list;
 439
 440 #if IS_ENABLED(CONFIG_DEBUG_FS)
 441         struct dentry *dbgfs_dir;
 442 #endif /* CONFIG_DEBUG_FS */
 443
 444
 445         const struct mei_hw_ops *ops;
 446         char hw[0] __aligned(sizeof(void *));
 447 };
 448
 449 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 450 {
 451         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 452 }
 453
 454 /**
 455  * mei_data2slots - get slots - number of (dwords) from a message length
 456  *      + size of the mei header
 457  * @length - size of the messages in bytes
 458  * returns  - number of slots
 459  */
 460 static inline u32 mei_data2slots(size_t length)
 461 {
 462         return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
 463 }
 464
 465 /**
 466  * mei_slots2data- get data in slots - bytes from slots
 467  * @slots -  number of available slots
 468  * returns  - number of bytes in slots
 469  */
 470 static inline u32 mei_slots2data(int slots)
 471 {
 472         return slots * 4;
 473 }
 474
 475 /*
 476  * mei init function prototypes
 477  */
 478 void mei_device_init(struct mei_device *dev);
 479 int mei_reset(struct mei_device *dev);
 480 int mei_start(struct mei_device *dev);
 481 int mei_restart(struct mei_device *dev);
 482 void mei_stop(struct mei_device *dev);
 483 void mei_cancel_work(struct mei_device *dev);
 484
 485 /*
 486  *  MEI interrupt functions prototype
 487  */
 488
 489 void mei_timer(struct work_struct *work);
 490 int mei_irq_read_handler(struct mei_device *dev,
 491                 struct mei_cl_cb *cmpl_list, s32 *slots);
 492
 493 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 494 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 495
 496 /*
 497  * AMTHIF - AMT Host Interface Functions
 498  */
 499 void mei_amthif_reset_params(struct mei_device *dev);
 500
 501 int mei_amthif_host_init(struct mei_device *dev);
 502
 503 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
 504
 505 int mei_amthif_read(struct mei_device *dev, struct file *file,
 506                 char __user *ubuf, size_t length, loff_t *offset);
 507
 508 unsigned int mei_amthif_poll(struct mei_device *dev,
 509                 struct file *file, poll_table *wait);
 510
 511 int mei_amthif_release(struct mei_device *dev, struct file *file);
 512
 513 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 514                                                 struct file *file);
 515
 516 void mei_amthif_run_next_cmd(struct mei_device *dev);
 517
 518 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
 519                         struct mei_cl_cb *cmpl_list);
 520
 521 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 522 int mei_amthif_irq_read_msg(struct mei_device *dev,
 523                             struct mei_msg_hdr *mei_hdr,
 524                             struct mei_cl_cb *complete_list);
 525 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 526
 527 /*
 528  * NFC functions
 529  */
 530 int mei_nfc_host_init(struct mei_device *dev);
 531 void mei_nfc_host_exit(struct mei_device *dev);
 532
 533 /*
 534  * NFC Client UUID
 535  */
 536 extern const uuid_le mei_nfc_guid;
 537
 538 int mei_wd_send(struct mei_device *dev);
 539 int mei_wd_stop(struct mei_device *dev);
 540 int mei_wd_host_init(struct mei_device *dev);
 541 /*
 542  * mei_watchdog_register  - Registering watchdog interface
 543  *   once we got connection to the WD Client
 544  * @dev - mei device
 545  */
 546 int mei_watchdog_register(struct mei_device *dev);
 547 /*
 548  * mei_watchdog_unregister  - Unregistering watchdog interface
 549  * @dev - mei device
 550  */
 551 void mei_watchdog_unregister(struct mei_device *dev);
 552
 553 /*
 554  * Register Access Function
 555  */
 556
 557 static inline void mei_hw_config(struct mei_device *dev)
 558 {
 559         dev->ops->hw_config(dev);
 560 }
 561 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
 562 {
 563         return dev->ops->hw_reset(dev, enable);
 564 }
 565
 566 static inline int mei_hw_start(struct mei_device *dev)
 567 {
 568         return dev->ops->hw_start(dev);
 569 }
 570
 571 static inline void mei_clear_interrupts(struct mei_device *dev)
 572 {
 573         dev->ops->intr_clear(dev);
 574 }
 575
 576 static inline void mei_enable_interrupts(struct mei_device *dev)
 577 {
 578         dev->ops->intr_enable(dev);
 579 }
 580
 581 static inline void mei_disable_interrupts(struct mei_device *dev)
 582 {
 583         dev->ops->intr_disable(dev);
 584 }
 585
 586 static inline bool mei_host_is_ready(struct mei_device *dev)
 587 {
 588         return dev->ops->host_is_ready(dev);
 589 }
 590 static inline bool mei_hw_is_ready(struct mei_device *dev)
 591 {
 592         return dev->ops->hw_is_ready(dev);
 593 }
 594
 595 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
 596 {
 597         return dev->ops->hbuf_is_ready(dev);
 598 }
 599
 600 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
 601 {
 602         return dev->ops->hbuf_free_slots(dev);
 603 }
 604
 605 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
 606 {
 607         return dev->ops->hbuf_max_len(dev);
 608 }
 609
 610 static inline int mei_write_message(struct mei_device *dev,
 611                         struct mei_msg_hdr *hdr,
 612                         unsigned char *buf)
 613 {
 614         return dev->ops->write(dev, hdr, buf);
 615 }
 616
 617 static inline u32 mei_read_hdr(const struct mei_device *dev)
 618 {
 619         return dev->ops->read_hdr(dev);
 620 }
 621
 622 static inline void mei_read_slots(struct mei_device *dev,
 623                      unsigned char *buf, unsigned long len)
 624 {
 625         dev->ops->read(dev, buf, len);
 626 }
 627
 628 static inline int mei_count_full_read_slots(struct mei_device *dev)
 629 {
 630         return dev->ops->rdbuf_full_slots(dev);
 631 }
 632
 633 bool mei_hbuf_acquire(struct mei_device *dev);
 634
 635 #if IS_ENABLED(CONFIG_DEBUG_FS)
 636 int mei_dbgfs_register(struct mei_device *dev, const char *name);
 637 void mei_dbgfs_deregister(struct mei_device *dev);
 638 #else
 639 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
 640 {
 641         return 0;
 642 }
 643 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
 644 #endif /* CONFIG_DEBUG_FS */
 645
 646 int mei_register(struct mei_device *dev);
 647 void mei_deregister(struct mei_device *dev);
 648
 649 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
 650 #define MEI_HDR_PRM(hdr)                  \
 651         (hdr)->host_addr, (hdr)->me_addr, \
 652         (hdr)->length, (hdr)->internal, (hdr)->msg_complete
 653
 654 #endif