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 void mei_allocate_me_clients_storage(struct mei_device
*dev
);
337 * MEI interrupt functions prototype
339 irqreturn_t
mei_interrupt_quick_handler(int irq
, void *dev_id
);
340 irqreturn_t
mei_interrupt_thread_handler(int irq
, void *dev_id
);
341 void mei_timer(struct work_struct
*work
);
344 * MEI input output function prototype
346 int mei_ioctl_connect_client(struct file
*file
,
347 struct mei_connect_client_data
*data
);
349 * AMTHIF - AMT Host Interface Functions
351 void mei_amthif_reset_params(struct mei_device
*dev
);
353 void mei_amthif_host_init(struct mei_device
*dev
);
355 int mei_amthif_write(struct mei_device
*dev
, struct mei_cl_cb
*priv_cb
);
357 int mei_amthif_read(struct mei_device
*dev
, struct file
*file
,
358 char __user
*ubuf
, size_t length
, loff_t
*offset
);
360 unsigned int mei_amthif_poll(struct mei_device
*dev
,
361 struct file
*file
, poll_table
*wait
);
363 int mei_amthif_release(struct mei_device
*dev
, struct file
*file
);
365 struct mei_cl_cb
*mei_amthif_find_read_list_entry(struct mei_device
*dev
,
368 void mei_amthif_run_next_cmd(struct mei_device
*dev
);
371 int mei_amthif_irq_write_complete(struct mei_device
*dev
, s32
*slots
,
372 struct mei_cl_cb
*cb
, struct mei_cl_cb
*cmpl_list
);
374 void mei_amthif_complete(struct mei_device
*dev
, struct mei_cl_cb
*cb
);
375 int mei_amthif_irq_read_message(struct mei_cl_cb
*complete_list
,
376 struct mei_device
*dev
, struct mei_msg_hdr
*mei_hdr
);
377 int mei_amthif_irq_read(struct mei_device
*dev
, s32
*slots
);
380 * Register Access Function
383 u32
mei_hcsr_read(const struct mei_device
*dev
);
384 u32
mei_mecsr_read(const struct mei_device
*dev
);
385 u32
mei_mecbrw_read(const struct mei_device
*dev
);
387 void mei_hcsr_set(struct mei_device
*dev
);
388 void mei_csr_clear_his(struct mei_device
*dev
);
390 void mei_clear_interrupts(struct mei_device
*dev
);
391 void mei_enable_interrupts(struct mei_device
*dev
);
392 void mei_disable_interrupts(struct mei_device
*dev
);
396 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
397 #define MEI_HDR_PRM(hdr) \
398 (hdr)->host_addr, (hdr)->me_addr, \
399 (hdr)->length, (hdr)->msg_complete