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/mei.h>
  23 #include "hw.h"
  24
  25 /*
  26  * watch dog definition
  27  */
  28 #define MEI_WD_HDR_SIZE       4
  29 #define MEI_WD_STOP_MSG_SIZE  MEI_WD_HDR_SIZE
  30 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
  31
  32 #define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
  33 #define MEI_WD_MIN_TIMEOUT       120  /* seconds */
  34 #define MEI_WD_MAX_TIMEOUT     65535  /* seconds */
  35
  36 #define MEI_WD_STOP_TIMEOUT      10 /* msecs */
  37
  38 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)
  39
  40 #define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))
  41
  42
  43 /*
  44  * AMTHI Client UUID
  45  */
  46 extern const uuid_le mei_amthi_guid;
  47
  48 /*
  49  * Watchdog Client UUID
  50  */
  51 extern const uuid_le mei_wd_guid;
  52
  53 /*
  54  * Watchdog independence state message
  55  */
  56 extern const u8 mei_wd_state_independence_msg[3][4];
  57
  58 /*
  59  * Number of Maximum MEI Clients
  60  */
  61 #define MEI_CLIENTS_MAX 256
  62
  63 /*
  64  * Number of File descriptors/handles
  65  * that can be opened to the driver.
  66  *
  67  * Limit to 253: 256 Total Clients
  68  * minus internal client for MEI Bus Messags
  69  * minus internal client for AMTHI
  70  * minus internal client for Watchdog
  71  */
  72 #define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)
  73
  74
  75 /* File state */
  76 enum file_state {
  77         MEI_FILE_INITIALIZING = 0,
  78         MEI_FILE_CONNECTING,
  79         MEI_FILE_CONNECTED,
  80         MEI_FILE_DISCONNECTING,
  81         MEI_FILE_DISCONNECTED
  82 };
  83
  84 /* MEI device states */
  85 enum mei_dev_state {
  86         MEI_DEV_INITIALIZING = 0,
  87         MEI_DEV_INIT_CLIENTS,
  88         MEI_DEV_ENABLED,
  89         MEI_DEV_RESETING,
  90         MEI_DEV_DISABLED,
  91         MEI_DEV_RECOVERING_FROM_RESET,
  92         MEI_DEV_POWER_DOWN,
  93         MEI_DEV_POWER_UP
  94 };
  95
  96 const char *mei_dev_state_str(int state);
  97
  98 /* init clients states*/
  99 enum mei_init_clients_states {
 100         MEI_START_MESSAGE = 0,
 101         MEI_ENUM_CLIENTS_MESSAGE,
 102         MEI_CLIENT_PROPERTIES_MESSAGE
 103 };
 104
 105 enum iamthif_states {
 106         MEI_IAMTHIF_IDLE,
 107         MEI_IAMTHIF_WRITING,
 108         MEI_IAMTHIF_FLOW_CONTROL,
 109         MEI_IAMTHIF_READING,
 110         MEI_IAMTHIF_READ_COMPLETE
 111 };
 112
 113 enum mei_file_transaction_states {
 114         MEI_IDLE,
 115         MEI_WRITING,
 116         MEI_WRITE_COMPLETE,
 117         MEI_FLOW_CONTROL,
 118         MEI_READING,
 119         MEI_READ_COMPLETE
 120 };
 121
 122 enum mei_wd_states {
 123         MEI_WD_IDLE,
 124         MEI_WD_RUNNING,
 125         MEI_WD_STOPPING,
 126 };
 127
 128 /* MEI CB */
 129 enum mei_cb_major_types {
 130         MEI_READ = 0,
 131         MEI_WRITE,
 132         MEI_IOCTL,
 133         MEI_OPEN,
 134         MEI_CLOSE
 135 };
 136
 137 /*
 138  * Intel MEI message data struct
 139  */
 140 struct mei_message_data {
 141         u32 size;
 142         unsigned char *data;
 143 };
 144
 145
 146 struct mei_cl;
 147
 148 /*
 149  * struct mei_cl_cb - file operation callback structure
 150  *
 151  * @cl - file client who is running this operation
 152  */
 153 struct mei_cl_cb {
 154         struct list_head list;
 155         struct mei_cl *cl;
 156         enum mei_cb_major_types major_file_operations;
 157         struct mei_message_data request_buffer;
 158         struct mei_message_data response_buffer;
 159         unsigned long buf_idx;
 160         unsigned long read_time;
 161         struct file *file_object;
 162 };
 163
 164 /* MEI client instance carried as file->pirvate_data*/
 165 struct mei_cl {
 166         struct list_head link;
 167         struct mei_device *dev;
 168         enum file_state state;
 169         wait_queue_head_t tx_wait;
 170         wait_queue_head_t rx_wait;
 171         wait_queue_head_t wait;
 172         int read_pending;
 173         int status;
 174         /* ID of client connected */
 175         u8 host_client_id;
 176         u8 me_client_id;
 177         u8 mei_flow_ctrl_creds;
 178         u8 timer_count;
 179         enum mei_file_transaction_states reading_state;
 180         enum mei_file_transaction_states writing_state;
 181         int sm_state;
 182         struct mei_cl_cb *read_cb;
 183 };
 184
 185 /**
 186  * struct mei_deive -  MEI private device struct
 187  * @hbuf_depth - depth of host(write) buffer
 188  */
 189 struct mei_device {
 190         struct pci_dev *pdev;   /* pointer to pci device struct */
 191         /*
 192          * lists of queues
 193          */
 194         /* array of pointers to aio lists */
 195         struct mei_cl_cb read_list;             /* driver read queue */
 196         struct mei_cl_cb write_list;            /* driver write queue */
 197         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 198         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 199         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 200
 201         /*
 202          * list of files
 203          */
 204         struct list_head file_list;
 205         long open_handle_count;
 206         /*
 207          * memory of device
 208          */
 209         unsigned int mem_base;
 210         unsigned int mem_length;
 211         void __iomem *mem_addr;
 212         /*
 213          * lock for the device
 214          */
 215         struct mutex device_lock; /* device lock */
 216         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 217         bool recvd_msg;
 218         /*
 219          * hw states of host and fw(ME)
 220          */
 221         u32 host_hw_state;
 222         u32 me_hw_state;
 223         u8  hbuf_depth;
 224         /*
 225          * waiting queue for receive message from FW
 226          */
 227         wait_queue_head_t wait_recvd_msg;
 228         wait_queue_head_t wait_stop_wd;
 229
 230         /*
 231          * mei device  states
 232          */
 233         enum mei_dev_state dev_state;
 234         enum mei_init_clients_states init_clients_state;
 235         u16 init_clients_timer;
 236         bool need_reset;
 237
 238         u32 extra_write_index;
 239         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 240         u32 wr_msg_buf[128];    /* used for control messages */
 241         u32 ext_msg_buf[8];     /* for control responses */
 242         u32 rd_msg_hdr;
 243
 244         struct hbm_version version;
 245
 246         struct mei_me_client *me_clients; /* Note: memory has to be allocated */
 247         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 248         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 249         u8 me_clients_num;
 250         u8 me_client_presentation_num;
 251         u8 me_client_index;
 252         bool mei_host_buffer_is_empty;
 253
 254         struct mei_cl wd_cl;
 255         enum mei_wd_states wd_state;
 256         bool wd_pending;
 257         u16 wd_timeout;
 258         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 259
 260
 261         /* amthif list for cmd waiting */
 262         struct mei_cl_cb amthif_cmd_list;
 263         /* driver managed amthif list for reading completed amthif cmd data */
 264         struct mei_cl_cb amthif_rd_complete_list;
 265         struct file *iamthif_file_object;
 266         struct mei_cl iamthif_cl;
 267         struct mei_cl_cb *iamthif_current_cb;
 268         int iamthif_mtu;
 269         unsigned long iamthif_timer;
 270         u32 iamthif_stall_timer;
 271         unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
 272         u32 iamthif_msg_buf_size;
 273         u32 iamthif_msg_buf_index;
 274         enum iamthif_states iamthif_state;
 275         bool iamthif_flow_control_pending;
 276         bool iamthif_ioctl;
 277         bool iamthif_canceled;
 278 };
 279
 280 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 281 {
 282         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 283 }
 284
 285
 286 /*
 287  * mei init function prototypes
 288  */
 289 struct mei_device *mei_device_init(struct pci_dev *pdev);
 290 void mei_reset(struct mei_device *dev, int interrupts);
 291 int mei_hw_init(struct mei_device *dev);
 292 int mei_task_initialize_clients(void *data);
 293 int mei_initialize_clients(struct mei_device *dev);
 294 int mei_disconnect_host_client(struct mei_device *dev, struct mei_cl *cl);
 295 void mei_remove_client_from_file_list(struct mei_device *dev, u8 host_client_id);
 296 void mei_allocate_me_clients_storage(struct mei_device *dev);
 297
 298
 299 int mei_me_cl_update_filext(struct mei_device *dev, struct mei_cl *cl,
 300                         const uuid_le *cguid, u8 host_client_id);
 301 int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
 302 int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
 303
 304 /*
 305  * MEI IO Functions
 306  */
 307 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
 308 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
 309 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
 310 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
 311
 312
 313 /**
 314  * mei_io_list_init - Sets up a queue list.
 315  *
 316  * @list: An instance cl callback structure
 317  */
 318 static inline void mei_io_list_init(struct mei_cl_cb *list)
 319 {
 320         INIT_LIST_HEAD(&list->list);
 321 }
 322 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
 323
 324 /*
 325  * MEI ME Client Functions
 326  */
 327
 328 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
 329 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
 330 int mei_cl_flush_queues(struct mei_cl *cl);
 331 /**
 332  * mei_cl_cmp_id - tells if file private data have same id
 333  *
 334  * @fe1: private data of 1. file object
 335  * @fe2: private data of 2. file object
 336  *
 337  * returns true  - if ids are the same and not NULL
 338  */
 339 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
 340                                 const struct mei_cl *cl2)
 341 {
 342         return cl1 && cl2 &&
 343                 (cl1->host_client_id == cl2->host_client_id) &&
 344                 (cl1->me_client_id == cl2->me_client_id);
 345 }
 346
 347
 348
 349 /*
 350  * MEI Host Client Functions
 351  */
 352 void mei_host_start_message(struct mei_device *dev);
 353 void mei_host_enum_clients_message(struct mei_device *dev);
 354 int mei_host_client_properties(struct mei_device *dev);
 355
 356 /*
 357  *  MEI interrupt functions prototype
 358  */
 359 irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
 360 irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
 361 void mei_timer(struct work_struct *work);
 362
 363 /*
 364  *  MEI input output function prototype
 365  */
 366 int mei_ioctl_connect_client(struct file *file,
 367                         struct mei_connect_client_data *data);
 368
 369 int mei_start_read(struct mei_device *dev, struct mei_cl *cl);
 370
 371
 372 /*
 373  * AMTHIF - AMT Host Interface Functions
 374  */
 375 void mei_amthif_reset_params(struct mei_device *dev);
 376
 377 void mei_amthif_host_init(struct mei_device *dev);
 378
 379 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
 380
 381 int mei_amthif_read(struct mei_device *dev, struct file *file,
 382               char __user *ubuf, size_t length, loff_t *offset);
 383
 384 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 385                                                 struct file *file);
 386
 387 void mei_amthif_run_next_cmd(struct mei_device *dev);
 388
 389
 390 int mei_amthif_read_message(struct mei_cl_cb *complete_list,
 391                 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
 392
 393 int mei_amthif_irq_process_completed(struct mei_device *dev, s32 *slots,
 394                         struct mei_cl_cb *cb_pos,
 395                         struct mei_cl *cl,
 396                         struct mei_cl_cb *cmpl_list);
 397
 398 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 399 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
 400                 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
 401 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 402
 403 /*
 404  * Register Access Function
 405  */
 406
 407 /**
 408  * mei_reg_read - Reads 32bit data from the mei device
 409  *
 410  * @dev: the device structure
 411  * @offset: offset from which to read the data
 412  *
 413  * returns register value (u32)
 414  */
 415 static inline u32 mei_reg_read(const struct mei_device *dev,
 416                                unsigned long offset)
 417 {
 418         return ioread32(dev->mem_addr + offset);
 419 }
 420
 421 /**
 422  * mei_reg_write - Writes 32bit data to the mei device
 423  *
 424  * @dev: the device structure
 425  * @offset: offset from which to write the data
 426  * @value: register value to write (u32)
 427  */
 428 static inline void mei_reg_write(const struct mei_device *dev,
 429                                  unsigned long offset, u32 value)
 430 {
 431         iowrite32(value, dev->mem_addr + offset);
 432 }
 433
 434 /**
 435  * mei_hcsr_read - Reads 32bit data from the host CSR
 436  *
 437  * @dev: the device structure
 438  *
 439  * returns the byte read.
 440  */
 441 static inline u32 mei_hcsr_read(const struct mei_device *dev)
 442 {
 443         return mei_reg_read(dev, H_CSR);
 444 }
 445
 446 /**
 447  * mei_mecsr_read - Reads 32bit data from the ME CSR
 448  *
 449  * @dev: the device structure
 450  *
 451  * returns ME_CSR_HA register value (u32)
 452  */
 453 static inline u32 mei_mecsr_read(const struct mei_device *dev)
 454 {
 455         return mei_reg_read(dev, ME_CSR_HA);
 456 }
 457
 458 /**
 459  * get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
 460  *
 461  * @dev: the device structure
 462  *
 463  * returns ME_CB_RW register value (u32)
 464  */
 465 static inline u32 mei_mecbrw_read(const struct mei_device *dev)
 466 {
 467         return mei_reg_read(dev, ME_CB_RW);
 468 }
 469
 470
 471 /*
 472  * mei interface function prototypes
 473  */
 474 void mei_hcsr_set(struct mei_device *dev);
 475 void mei_csr_clear_his(struct mei_device *dev);
 476
 477 void mei_enable_interrupts(struct mei_device *dev);
 478 void mei_disable_interrupts(struct mei_device *dev);
 479
 480 #endif