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
  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  * Watchdog independence state message
  59  */
  60 extern const u8 mei_wd_state_independence_msg[3][4];
  61
  62 /*
  63  * Number of Maximum MEI Clients
  64  */
  65 #define MEI_CLIENTS_MAX 256
  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 Messags
  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_RESETING,
 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 /* init clients states*/
 108 enum mei_init_clients_states {
 109         MEI_START_MESSAGE = 0,
 110         MEI_ENUM_CLIENTS_MESSAGE,
 111         MEI_CLIENT_PROPERTIES_MESSAGE
 112 };
 113
 114 enum iamthif_states {
 115         MEI_IAMTHIF_IDLE,
 116         MEI_IAMTHIF_WRITING,
 117         MEI_IAMTHIF_FLOW_CONTROL,
 118         MEI_IAMTHIF_READING,
 119         MEI_IAMTHIF_READ_COMPLETE
 120 };
 121
 122 enum mei_file_transaction_states {
 123         MEI_IDLE,
 124         MEI_WRITING,
 125         MEI_WRITE_COMPLETE,
 126         MEI_FLOW_CONTROL,
 127         MEI_READING,
 128         MEI_READ_COMPLETE
 129 };
 130
 131 enum mei_wd_states {
 132         MEI_WD_IDLE,
 133         MEI_WD_RUNNING,
 134         MEI_WD_STOPPING,
 135 };
 136
 137 /**
 138  * enum mei_cb_file_ops  - file operation associated with the callback
 139  * @MEI_FOP_READ   - read
 140  * @MEI_FOP_WRITE  - write
 141  * @MEI_FOP_IOCTL  - ioctl
 142  * @MEI_FOP_OPEN   - open
 143  * @MEI_FOP_CLOSE  - close
 144  */
 145 enum mei_cb_file_ops {
 146         MEI_FOP_READ = 0,
 147         MEI_FOP_WRITE,
 148         MEI_FOP_IOCTL,
 149         MEI_FOP_OPEN,
 150         MEI_FOP_CLOSE
 151 };
 152
 153 /*
 154  * Intel MEI message data struct
 155  */
 156 struct mei_message_data {
 157         u32 size;
 158         unsigned char *data;
 159 };
 160
 161 /**
 162  * struct mei_me_client - representation of me (fw) client
 163  *
 164  * @props  - client properties
 165  * @client_id - me client id
 166  * @mei_flow_ctrl_creds - flow control credits
 167  */
 168 struct mei_me_client {
 169         struct mei_client_properties props;
 170         u8 client_id;
 171         u8 mei_flow_ctrl_creds;
 172 };
 173
 174
 175 struct mei_cl;
 176
 177 /**
 178  * struct mei_cl_cb - file operation callback structure
 179  *
 180  * @cl - file client who is running this operation
 181  * @fop_type - file operation type
 182  */
 183 struct mei_cl_cb {
 184         struct list_head list;
 185         struct mei_cl *cl;
 186         enum mei_cb_file_ops fop_type;
 187         struct mei_message_data request_buffer;
 188         struct mei_message_data response_buffer;
 189         unsigned long buf_idx;
 190         unsigned long read_time;
 191         struct file *file_object;
 192 };
 193
 194 /* MEI client instance carried as file->pirvate_data*/
 195 struct mei_cl {
 196         struct list_head link;
 197         struct mei_device *dev;
 198         enum file_state state;
 199         wait_queue_head_t tx_wait;
 200         wait_queue_head_t rx_wait;
 201         wait_queue_head_t wait;
 202         int status;
 203         /* ID of client connected */
 204         u8 host_client_id;
 205         u8 me_client_id;
 206         u8 mei_flow_ctrl_creds;
 207         u8 timer_count;
 208         enum mei_file_transaction_states reading_state;
 209         enum mei_file_transaction_states writing_state;
 210         int sm_state;
 211         struct mei_cl_cb *read_cb;
 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         void (*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 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
 268                                   uuid_le uuid, char *name);
 269 void mei_cl_remove_device(struct mei_cl_device *device);
 270
 271 /**
 272  * struct mei_cl_device - MEI device handle
 273  * An mei_cl_device pointer is returned from mei_add_device()
 274  * and links MEI bus clients to their actual ME host client pointer.
 275  * Drivers for MEI devices will get an mei_cl_device pointer
 276  * when being probed and shall use it for doing ME bus I/O.
 277  *
 278  * @dev: linux driver model device pointer
 279  * @uuid: me client uuid
 280  * @cl: mei client
 281  * @priv_data: client private data
 282  */
 283 struct mei_cl_device {
 284         struct device dev;
 285
 286         struct mei_cl *cl;
 287
 288         void *priv_data;
 289 };
 290
 291 /**
 292  * struct mei_device -  MEI private device struct
 293
 294  * @mem_addr - mem mapped base register address
 295
 296  * @hbuf_depth - depth of hardware host/write buffer is slots
 297  * @hbuf_is_ready - query if the host host/write buffer is ready
 298  * @wr_msg - the buffer for hbm control messages
 299  * @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
 300  */
 301 struct mei_device {
 302         struct pci_dev *pdev;   /* pointer to pci device struct */
 303         /*
 304          * lists of queues
 305          */
 306         /* array of pointers to aio lists */
 307         struct mei_cl_cb read_list;             /* driver read queue */
 308         struct mei_cl_cb write_list;            /* driver write queue */
 309         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 310         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 311         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 312
 313         /*
 314          * list of files
 315          */
 316         struct list_head file_list;
 317         long open_handle_count;
 318
 319         /*
 320          * lock for the device
 321          */
 322         struct mutex device_lock; /* device lock */
 323         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 324
 325         bool recvd_hw_ready;
 326         bool recvd_msg;
 327
 328         /*
 329          * waiting queue for receive message from FW
 330          */
 331         wait_queue_head_t wait_hw_ready;
 332         wait_queue_head_t wait_recvd_msg;
 333         wait_queue_head_t wait_stop_wd;
 334
 335         /*
 336          * mei device  states
 337          */
 338         enum mei_dev_state dev_state;
 339         enum mei_init_clients_states init_clients_state;
 340         u16 init_clients_timer;
 341
 342         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 343         u32 rd_msg_hdr;
 344
 345         /* write buffer */
 346         u8 hbuf_depth;
 347         bool hbuf_is_ready;
 348
 349         /* used for control messages */
 350         struct {
 351                 struct mei_msg_hdr hdr;
 352                 unsigned char data[128];
 353         } wr_msg;
 354
 355         struct {
 356                 struct mei_msg_hdr hdr;
 357                 unsigned char data[4];  /* All HBM messages are 4 bytes */
 358         } wr_ext_msg;           /* for control responses */
 359
 360         struct hbm_version version;
 361
 362         struct mei_me_client *me_clients; /* Note: memory has to be allocated */
 363         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 364         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 365         u8 me_clients_num;
 366         u8 me_client_presentation_num;
 367         u8 me_client_index;
 368
 369         struct mei_cl wd_cl;
 370         enum mei_wd_states wd_state;
 371         bool wd_pending;
 372         u16 wd_timeout;
 373         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 374
 375
 376         /* amthif list for cmd waiting */
 377         struct mei_cl_cb amthif_cmd_list;
 378         /* driver managed amthif list for reading completed amthif cmd data */
 379         struct mei_cl_cb amthif_rd_complete_list;
 380         struct file *iamthif_file_object;
 381         struct mei_cl iamthif_cl;
 382         struct mei_cl_cb *iamthif_current_cb;
 383         int iamthif_mtu;
 384         unsigned long iamthif_timer;
 385         u32 iamthif_stall_timer;
 386         unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
 387         u32 iamthif_msg_buf_size;
 388         u32 iamthif_msg_buf_index;
 389         enum iamthif_states iamthif_state;
 390         bool iamthif_flow_control_pending;
 391         bool iamthif_ioctl;
 392         bool iamthif_canceled;
 393
 394         struct work_struct init_work;
 395
 396         const struct mei_hw_ops *ops;
 397         char hw[0] __aligned(sizeof(void *));
 398 };
 399
 400 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 401 {
 402         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 403 }
 404
 405 /**
 406  * mei_data2slots - get slots - number of (dwords) from a message length
 407  *      + size of the mei header
 408  * @length - size of the messages in bytes
 409  * returns  - number of slots
 410  */
 411 static inline u32 mei_data2slots(size_t length)
 412 {
 413         return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
 414 }
 415
 416
 417 /*
 418  * mei init function prototypes
 419  */
 420 void mei_device_init(struct mei_device *dev);
 421 void mei_reset(struct mei_device *dev, int interrupts);
 422 int mei_start(struct mei_device *dev);
 423 void mei_stop(struct mei_device *dev);
 424
 425 /*
 426  *  MEI interrupt functions prototype
 427  */
 428
 429 void mei_timer(struct work_struct *work);
 430 int mei_irq_read_handler(struct mei_device *dev,
 431                 struct mei_cl_cb *cmpl_list, s32 *slots);
 432
 433 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 434 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 435
 436 /*
 437  * AMTHIF - AMT Host Interface Functions
 438  */
 439 void mei_amthif_reset_params(struct mei_device *dev);
 440
 441 int mei_amthif_host_init(struct mei_device *dev);
 442
 443 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
 444
 445 int mei_amthif_read(struct mei_device *dev, struct file *file,
 446                 char __user *ubuf, size_t length, loff_t *offset);
 447
 448 unsigned int mei_amthif_poll(struct mei_device *dev,
 449                 struct file *file, poll_table *wait);
 450
 451 int mei_amthif_release(struct mei_device *dev, struct file *file);
 452
 453 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 454                                                 struct file *file);
 455
 456 void mei_amthif_run_next_cmd(struct mei_device *dev);
 457
 458
 459 int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
 460                         struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list);
 461
 462 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 463 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
 464                 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
 465 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 466
 467
 468 int mei_wd_send(struct mei_device *dev);
 469 int mei_wd_stop(struct mei_device *dev);
 470 int mei_wd_host_init(struct mei_device *dev);
 471 /*
 472  * mei_watchdog_register  - Registering watchdog interface
 473  *   once we got connection to the WD Client
 474  * @dev - mei device
 475  */
 476 void mei_watchdog_register(struct mei_device *dev);
 477 /*
 478  * mei_watchdog_unregister  - Unregistering watchdog interface
 479  * @dev - mei device
 480  */
 481 void mei_watchdog_unregister(struct mei_device *dev);
 482
 483 /*
 484  * Register Access Function
 485  */
 486
 487 static inline void mei_hw_config(struct mei_device *dev)
 488 {
 489         dev->ops->hw_config(dev);
 490 }
 491 static inline void mei_hw_reset(struct mei_device *dev, bool enable)
 492 {
 493         dev->ops->hw_reset(dev, enable);
 494 }
 495
 496 static inline void mei_hw_start(struct mei_device *dev)
 497 {
 498         dev->ops->hw_start(dev);
 499 }
 500
 501 static inline void mei_clear_interrupts(struct mei_device *dev)
 502 {
 503         dev->ops->intr_clear(dev);
 504 }
 505
 506 static inline void mei_enable_interrupts(struct mei_device *dev)
 507 {
 508         dev->ops->intr_enable(dev);
 509 }
 510
 511 static inline void mei_disable_interrupts(struct mei_device *dev)
 512 {
 513         dev->ops->intr_disable(dev);
 514 }
 515
 516 static inline bool mei_host_is_ready(struct mei_device *dev)
 517 {
 518         return dev->ops->host_is_ready(dev);
 519 }
 520 static inline bool mei_hw_is_ready(struct mei_device *dev)
 521 {
 522         return dev->ops->hw_is_ready(dev);
 523 }
 524
 525 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
 526 {
 527         return dev->ops->hbuf_is_ready(dev);
 528 }
 529
 530 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
 531 {
 532         return dev->ops->hbuf_free_slots(dev);
 533 }
 534
 535 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
 536 {
 537         return dev->ops->hbuf_max_len(dev);
 538 }
 539
 540 static inline int mei_write_message(struct mei_device *dev,
 541                         struct mei_msg_hdr *hdr,
 542                         unsigned char *buf)
 543 {
 544         return dev->ops->write(dev, hdr, buf);
 545 }
 546
 547 static inline u32 mei_read_hdr(const struct mei_device *dev)
 548 {
 549         return dev->ops->read_hdr(dev);
 550 }
 551
 552 static inline void mei_read_slots(struct mei_device *dev,
 553                      unsigned char *buf, unsigned long len)
 554 {
 555         dev->ops->read(dev, buf, len);
 556 }
 557
 558 static inline int mei_count_full_read_slots(struct mei_device *dev)
 559 {
 560         return dev->ops->rdbuf_full_slots(dev);
 561 }
 562
 563 int mei_register(struct device *dev);
 564 void mei_deregister(void);
 565
 566 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
 567 #define MEI_HDR_PRM(hdr)                  \
 568         (hdr)->host_addr, (hdr)->me_addr, \
 569         (hdr)->length, (hdr)->msg_complete
 570
 571 #endif