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