3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
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.
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
20 #include <linux/types.h>
21 #include <linux/watchdog.h>
22 #include <linux/poll.h>
23 #include <linux/mei.h>
29 * watch dog definition
31 #define MEI_WD_HDR_SIZE 4
32 #define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE
33 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
35 #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
36 #define MEI_WD_MIN_TIMEOUT 120 /* seconds */
37 #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
39 #define MEI_WD_STOP_TIMEOUT 10 /* msecs */
41 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
43 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
49 extern const uuid_le mei_amthi_guid;
52 * Watchdog Client UUID
54 extern const uuid_le mei_wd_guid;
57 * Watchdog independence state message
59 extern const u8 mei_wd_state_independence_msg[3][4];
62 * Number of Maximum MEI Clients
64 #define MEI_CLIENTS_MAX 256
67 * Number of File descriptors/handles
68 * that can be opened to the driver.
70 * Limit to 253: 256 Total Clients
71 * minus internal client for MEI Bus Messags
72 * minus internal client for AMTHI
73 * minus internal client for Watchdog
75 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)
78 * Internal Clients Number
80 #define MEI_WD_HOST_CLIENT_ID 1
81 #define MEI_IAMTHIF_HOST_CLIENT_ID 2
86 MEI_FILE_INITIALIZING = 0,
89 MEI_FILE_DISCONNECTING,
93 /* MEI device states */
95 MEI_DEV_INITIALIZING = 0,
100 MEI_DEV_RECOVERING_FROM_RESET,
105 const char *mei_dev_state_str(int state);
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
114 enum iamthif_states {
117 MEI_IAMTHIF_FLOW_CONTROL,
119 MEI_IAMTHIF_READ_COMPLETE
122 enum mei_file_transaction_states {
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
145 enum mei_cb_file_ops {
154 * Intel MEI message data struct
156 struct mei_message_data {
162 * struct mei_me_client - representation of me (fw) client
164 * @props - client properties
165 * @client_id - me client id
166 * @mei_flow_ctrl_creds - flow control credits
168 struct mei_me_client {
169 struct mei_client_properties props;
171 u8 mei_flow_ctrl_creds;
178 * struct mei_cl_cb - file operation callback structure
180 * @cl - file client who is running this operation
181 * @fop_type - file operation type
184 struct list_head list;
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;
194 /* MEI client instance carried as file->pirvate_data*/
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;
204 /* ID of client connected */
207 u8 mei_flow_ctrl_creds;
209 enum mei_file_transaction_states reading_state;
210 enum mei_file_transaction_states writing_state;
212 struct mei_cl_cb *read_cb;
216 * struct mei_device - MEI private device struct
217 * @mem_addr - mem mapped base register address
218 * @hbuf_depth - depth of host(write) buffer
219 * @wr_ext_msg - buffer for hbm control responses (set in read cycle)
222 struct pci_dev *pdev; /* pointer to pci device struct */
226 /* array of pointers to aio lists */
227 struct mei_cl_cb read_list; /* driver read queue */
228 struct mei_cl_cb write_list; /* driver write queue */
229 struct mei_cl_cb write_waiting_list; /* write waiting queue */
230 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
231 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
236 struct list_head file_list;
237 long open_handle_count;
239 void __iomem *mem_addr;
241 * lock for the device
243 struct mutex device_lock; /* device lock */
244 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
247 * hw states of host and fw(ME)
253 * waiting queue for receive message from FW
255 wait_queue_head_t wait_recvd_msg;
256 wait_queue_head_t wait_stop_wd;
261 enum mei_dev_state dev_state;
262 enum mei_init_clients_states init_clients_state;
263 u16 init_clients_timer;
266 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
269 /* used for control messages */
271 struct mei_msg_hdr hdr;
272 unsigned char data[128];
276 struct mei_msg_hdr hdr;
277 unsigned char data[4]; /* All HBM messages are 4 bytes */
278 } wr_ext_msg; /* for control responses */
280 struct hbm_version version;
282 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
283 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
284 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
286 u8 me_client_presentation_num;
288 bool mei_host_buffer_is_empty;
291 enum mei_wd_states wd_state;
294 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
297 /* amthif list for cmd waiting */
298 struct mei_cl_cb amthif_cmd_list;
299 /* driver managed amthif list for reading completed amthif cmd data */
300 struct mei_cl_cb amthif_rd_complete_list;
301 struct file *iamthif_file_object;
302 struct mei_cl iamthif_cl;
303 struct mei_cl_cb *iamthif_current_cb;
305 unsigned long iamthif_timer;
306 u32 iamthif_stall_timer;
307 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
308 u32 iamthif_msg_buf_size;
309 u32 iamthif_msg_buf_index;
310 enum iamthif_states iamthif_state;
311 bool iamthif_flow_control_pending;
313 bool iamthif_canceled;
315 struct work_struct init_work;
318 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
320 return msecs_to_jiffies(sec * MSEC_PER_SEC);
325 * mei init function prototypes
327 struct mei_device *mei_device_init(struct pci_dev *pdev);
328 void mei_reset(struct mei_device *dev, int interrupts);
329 int mei_hw_init(struct mei_device *dev);
330 int mei_task_initialize_clients(void *data);
331 int mei_initialize_clients(struct mei_device *dev);
332 int mei_disconnect_host_client(struct mei_device *dev, struct mei_cl *cl);
333 void mei_allocate_me_clients_storage(struct mei_device *dev);
336 int mei_me_cl_link(struct mei_device *dev, struct mei_cl *cl,
337 const uuid_le *cguid, u8 host_client_id);
338 void mei_me_cl_unlink(struct mei_device *dev, struct mei_cl *cl);
339 int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
340 int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
345 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
346 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
347 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
348 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
352 * mei_io_list_init - Sets up a queue list.
354 * @list: An instance cl callback structure
356 static inline void mei_io_list_init(struct mei_cl_cb *list)
358 INIT_LIST_HEAD(&list->list);
360 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
363 * MEI ME Client Functions
366 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
367 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
368 int mei_cl_flush_queues(struct mei_cl *cl);
370 * mei_cl_cmp_id - tells if file private data have same id
372 * @fe1: private data of 1. file object
373 * @fe2: private data of 2. file object
375 * returns true - if ids are the same and not NULL
377 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
378 const struct mei_cl *cl2)
381 (cl1->host_client_id == cl2->host_client_id) &&
382 (cl1->me_client_id == cl2->me_client_id);
387 * MEI interrupt functions prototype
389 irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
390 irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
391 void mei_timer(struct work_struct *work);
394 * MEI input output function prototype
396 int mei_ioctl_connect_client(struct file *file,
397 struct mei_connect_client_data *data);
399 int mei_start_read(struct mei_device *dev, struct mei_cl *cl);
402 * AMTHIF - AMT Host Interface Functions
404 void mei_amthif_reset_params(struct mei_device *dev);
406 void mei_amthif_host_init(struct mei_device *dev);
408 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
410 int mei_amthif_read(struct mei_device *dev, struct file *file,
411 char __user *ubuf, size_t length, loff_t *offset);
413 unsigned int mei_amthif_poll(struct mei_device *dev,
414 struct file *file, poll_table *wait);
416 int mei_amthif_release(struct mei_device *dev, struct file *file);
418 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
421 void mei_amthif_run_next_cmd(struct mei_device *dev);
424 int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
425 struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list);
427 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
428 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
429 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
430 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
433 * Register Access Function
436 u32 mei_hcsr_read(const struct mei_device *dev);
437 u32 mei_mecsr_read(const struct mei_device *dev);
438 u32 mei_mecbrw_read(const struct mei_device *dev);
440 void mei_hcsr_set(struct mei_device *dev);
441 void mei_csr_clear_his(struct mei_device *dev);
443 void mei_clear_interrupts(struct mei_device *dev);
444 void mei_enable_interrupts(struct mei_device *dev);
445 void mei_disable_interrupts(struct mei_device *dev);
449 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
450 #define MEI_HDR_PRM(hdr) \
451 (hdr)->host_addr, (hdr)->me_addr, \
452 (hdr)->length, (hdr)->msg_complete