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