mei_dev.h 20.5 KB
Newer Older
1 2 3
/*
 *
 * Intel Management Engine Interface (Intel MEI) Linux driver
4
 * Copyright (c) 2003-2012, Intel Corporation.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 */

#ifndef _MEI_DEV_H_
#define _MEI_DEV_H_

#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"
T
Tomas Winkler 已提交
27
#include "hbm.h"
28 29 30 31

/*
 * watch dog definition
 */
32 33 34 35 36 37 38 39
#define MEI_WD_HDR_SIZE       4
#define MEI_WD_STOP_MSG_SIZE  MEI_WD_HDR_SIZE
#define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)

#define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
#define MEI_WD_MIN_TIMEOUT       120  /* seconds */
#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
extern const uuid_le mei_amthif_guid;
51 52 53 54 55 56

/*
 * Watchdog Client UUID
 */
extern const uuid_le mei_wd_guid;

57 58 59 60 61
/*
 * Number of Maximum MEI Clients
 */
#define MEI_CLIENTS_MAX 256

62 63 64 65 66
/*
 * maximum number of consecutive resets
 */
#define MEI_MAX_CONSEC_RESET  3

67 68 69 70
/*
 * Number of File descriptors/handles
 * that can be opened to the driver.
 *
71
 * Limit to 255: 256 Total Clients
72
 * minus internal client for MEI Bus Messages
73
 */
74
#define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
75

76 77 78
/*
 * Internal Clients Number
 */
79 80
#define MEI_HOST_CLIENT_ID_ANY        (-1)
#define MEI_HBM_HOST_CLIENT_ID         0 /* not used, just for documentation */
81 82 83
#define MEI_WD_HOST_CLIENT_ID          1
#define MEI_IAMTHIF_HOST_CLIENT_ID     2

84 85 86 87 88 89 90

/* File state */
enum file_state {
	MEI_FILE_INITIALIZING = 0,
	MEI_FILE_CONNECTING,
	MEI_FILE_CONNECTED,
	MEI_FILE_DISCONNECTING,
91 92
	MEI_FILE_DISCONNECT_REPLY,
	MEI_FILE_DISCONNECTED,
93 94 95
};

/* MEI device states */
96 97 98 99
enum mei_dev_state {
	MEI_DEV_INITIALIZING = 0,
	MEI_DEV_INIT_CLIENTS,
	MEI_DEV_ENABLED,
B
Bill Nottingham 已提交
100
	MEI_DEV_RESETTING,
101 102 103
	MEI_DEV_DISABLED,
	MEI_DEV_POWER_DOWN,
	MEI_DEV_POWER_UP
104 105
};

106 107
const char *mei_dev_state_str(int state);

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
enum iamthif_states {
	MEI_IAMTHIF_IDLE,
	MEI_IAMTHIF_WRITING,
	MEI_IAMTHIF_FLOW_CONTROL,
	MEI_IAMTHIF_READING,
	MEI_IAMTHIF_READ_COMPLETE
};

enum mei_file_transaction_states {
	MEI_IDLE,
	MEI_WRITING,
	MEI_WRITE_COMPLETE,
	MEI_FLOW_CONTROL,
	MEI_READING,
	MEI_READ_COMPLETE
};

125 126 127 128 129 130
enum mei_wd_states {
	MEI_WD_IDLE,
	MEI_WD_RUNNING,
	MEI_WD_STOPPING,
};

131 132
/**
 * enum mei_cb_file_ops  - file operation associated with the callback
A
Alexander Usyskin 已提交
133 134 135 136 137
 * @MEI_FOP_READ:       read
 * @MEI_FOP_WRITE:      write
 * @MEI_FOP_CONNECT:    connect
 * @MEI_FOP_DISCONNECT: disconnect
 * @MEI_FOP_DISCONNECT_RSP: disconnect response
138 139 140 141
 */
enum mei_cb_file_ops {
	MEI_FOP_READ = 0,
	MEI_FOP_WRITE,
142
	MEI_FOP_CONNECT,
143
	MEI_FOP_DISCONNECT,
T
Tomas Winkler 已提交
144
	MEI_FOP_DISCONNECT_RSP,
145 146 147 148 149
};

/*
 * Intel MEI message data struct
 */
T
Tomas Winkler 已提交
150
struct mei_msg_data {
151
	u32 size;
152
	unsigned char *data;
153
};
154

155
/* Maximum number of processed FW status registers */
156 157 158 159
#define MEI_FW_STATUS_MAX 6
/* Minimal  buffer for FW status string (8 bytes in dw + space or '\0') */
#define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1))

160 161 162 163

/*
 * struct mei_fw_status - storage of FW status data
 *
164 165
 * @count: number of actually available elements in array
 * @status: FW status registers
166 167 168 169 170 171
 */
struct mei_fw_status {
	int count;
	u32 status[MEI_FW_STATUS_MAX];
};

172 173 174
/**
 * struct mei_me_client - representation of me (fw) client
 *
175
 * @list: link in me client list
176
 * @refcnt: struct reference count
177 178 179
 * @props: client properties
 * @client_id: me client id
 * @mei_flow_ctrl_creds: flow control credits
180 181
 * @connect_count: number connections to this client
 * @reserved: reserved
182 183
 */
struct mei_me_client {
184
	struct list_head list;
185
	struct kref refcnt;
186 187 188
	struct mei_client_properties props;
	u8 client_id;
	u8 mei_flow_ctrl_creds;
189 190
	u8 connect_count;
	u8 reserved;
191 192
};

193

194 195
struct mei_cl;

196
/**
197 198
 * struct mei_cl_cb - file operation callback structure
 *
199 200 201
 * @list: link in callback queue
 * @cl: file client who is running this operation
 * @fop_type: file operation type
202
 * @buf: buffer for data associated with the callback
A
Alexander Usyskin 已提交
203 204 205
 * @buf_idx: last read index
 * @read_time: last read operation time stamp (iamthif)
 * @file_object: pointer to file structure
206
 * @status: io status of the cb
A
Alexander Usyskin 已提交
207
 * @internal: communication between driver and FW flag
208
 * @completed: the transfer or reception has completed
209
 */
210
struct mei_cl_cb {
211
	struct list_head list;
212
	struct mei_cl *cl;
213
	enum mei_cb_file_ops fop_type;
214
	struct mei_msg_data buf;
215
	unsigned long buf_idx;
216 217
	unsigned long read_time;
	struct file *file_object;
218
	int status;
219
	u32 internal:1;
220
	u32 completed:1;
221 222
};

A
Alexander Usyskin 已提交
223 224 225 226 227 228 229 230 231 232 233
/**
 * struct mei_cl - me client host representation
 *    carried in file->private_data
 *
 * @link: link in the clients list
 * @dev: mei parent device
 * @state: file operation state
 * @tx_wait: wait queue for tx completion
 * @rx_wait: wait queue for rx completion
 * @wait:  wait queue for management operation
 * @status: connection status
234
 * @me_cl: fw client connected
A
Alexander Usyskin 已提交
235 236 237
 * @host_client_id: host id
 * @mei_flow_ctrl_creds: transmit flow credentials
 * @timer_count:  watchdog timer for operation completion
238
 * @reserved: reserved for alignment
A
Alexander Usyskin 已提交
239
 * @writing_state: state of the tx
T
Tomas Winkler 已提交
240 241
 * @rd_pending: pending read credits
 * @rd_completed: completed read
A
Alexander Usyskin 已提交
242 243 244 245
 *
 * @device: device on the mei client bus
 * @device_link:  link to bus clients
 */
246 247 248 249 250 251 252 253
struct mei_cl {
	struct list_head link;
	struct mei_device *dev;
	enum file_state state;
	wait_queue_head_t tx_wait;
	wait_queue_head_t rx_wait;
	wait_queue_head_t wait;
	int status;
254
	struct mei_me_client *me_cl;
255 256 257
	u8 host_client_id;
	u8 mei_flow_ctrl_creds;
	u8 timer_count;
258
	u8 reserved;
259
	enum mei_file_transaction_states writing_state;
T
Tomas Winkler 已提交
260 261
	struct list_head rd_pending;
	struct list_head rd_completed;
262 263 264 265

	/* MEI CL bus data */
	struct mei_cl_device *device;
	struct list_head device_link;
266 267
};

268 269
/** struct mei_hw_ops
 *
270
 * @host_is_ready    : query for host readiness
271

272 273 274 275
 * @hw_is_ready      : query if hw is ready
 * @hw_reset         : reset hw
 * @hw_start         : start hw after reset
 * @hw_config        : configure hw
276

277 278 279
 * @fw_status        : get fw status registers
 * @pg_state         : power gating state of the device
 * @pg_is_enabled    : is power gating enabled
280

281 282 283
 * @intr_clear       : clear pending interrupts
 * @intr_enable      : enable interrupts
 * @intr_disable     : disable interrupts
284

285 286 287
 * @hbuf_free_slots  : query for write buffer empty slots
 * @hbuf_is_ready    : query if write buffer is empty
 * @hbuf_max_len     : query for write buffer max len
288

289
 * @write            : write a message to FW
290

291
 * @rdbuf_full_slots : query how many slots are filled
292

293 294
 * @read_hdr         : get first 4 bytes (header)
 * @read             : read a buffer from the FW
295 296 297
 */
struct mei_hw_ops {

298
	bool (*host_is_ready)(struct mei_device *dev);
299

300 301 302 303
	bool (*hw_is_ready)(struct mei_device *dev);
	int (*hw_reset)(struct mei_device *dev, bool enable);
	int (*hw_start)(struct mei_device *dev);
	void (*hw_config)(struct mei_device *dev);
304

305 306

	int (*fw_status)(struct mei_device *dev, struct mei_fw_status *fw_sts);
307
	enum mei_pg_state (*pg_state)(struct mei_device *dev);
308 309
	bool (*pg_is_enabled)(struct mei_device *dev);

310 311 312
	void (*intr_clear)(struct mei_device *dev);
	void (*intr_enable)(struct mei_device *dev);
	void (*intr_disable)(struct mei_device *dev);
313

314 315 316
	int (*hbuf_free_slots)(struct mei_device *dev);
	bool (*hbuf_is_ready)(struct mei_device *dev);
	size_t (*hbuf_max_len)(const struct mei_device *dev);
317 318 319 320 321 322 323 324

	int (*write)(struct mei_device *dev,
		     struct mei_msg_hdr *hdr,
		     unsigned char *buf);

	int (*rdbuf_full_slots)(struct mei_device *dev);

	u32 (*read_hdr)(const struct mei_device *dev);
325
	int (*read)(struct mei_device *dev,
326 327 328
		     unsigned char *buf, unsigned long len);
};

329
/* MEI bus API*/
330

331
struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
332 333
					struct mei_me_client *me_cl,
					struct mei_cl *cl,
334
					char *name);
335 336
void mei_cl_remove_device(struct mei_cl_device *device);

337 338
ssize_t __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length,
			bool blocking);
339
ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
340
void mei_cl_bus_rx_event(struct mei_cl *cl);
341
void mei_cl_bus_remove_devices(struct mei_device *dev);
342 343
int mei_cl_bus_init(void);
void mei_cl_bus_exit(void);
344
struct mei_cl *mei_cl_bus_find_cl_by_uuid(struct mei_device *dev, uuid_le uuid);
345

A
Alexander Usyskin 已提交
346
/**
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
 * enum mei_pg_event - power gating transition events
 *
 * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
 * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
 * @MEI_PG_EVENT_RECEIVED: the driver received pg event
 */
enum mei_pg_event {
	MEI_PG_EVENT_IDLE,
	MEI_PG_EVENT_WAIT,
	MEI_PG_EVENT_RECEIVED,
};

/**
 * enum mei_pg_state - device internal power gating state
 *
 * @MEI_PG_OFF: device is not power gated - it is active
 * @MEI_PG_ON:  device is power gated - it is in lower power state
 */
enum mei_pg_state {
	MEI_PG_OFF = 0,
	MEI_PG_ON =  1,
};

370 371
const char *mei_pg_state_str(enum mei_pg_state state);

372
/**
373
 * struct mei_device -  MEI private device struct
A
Alexander Usyskin 已提交
374
 *
375 376 377
 * @dev         : device on a bus
 * @cdev        : character device
 * @minor       : minor number allocated for device
378
 *
A
Alexander Usyskin 已提交
379 380 381 382
 * @write_list  : write pending list
 * @write_waiting_list : write completion list
 * @ctrl_wr_list : pending control write list
 * @ctrl_rd_list : pending control read list
383
 *
A
Alexander Usyskin 已提交
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
 * @file_list   : list of opened handles
 * @open_handle_count: number of opened handles
 *
 * @device_lock : big device lock
 * @timer_work  : MEI timer delayed work (timeouts)
 *
 * @recvd_hw_ready : hw ready message received flag
 *
 * @wait_hw_ready : wait queue for receive HW ready message form FW
 * @wait_pg     : wait queue for receive PG message from FW
 * @wait_hbm_start : wait queue for receive HBM start message from FW
 * @wait_stop_wd : wait queue for receive WD stop message from FW
 *
 * @reset_count : number of consecutive resets
 * @dev_state   : device state
 * @hbm_state   : state of host bus message protocol
 * @init_clients_timer : HBM init handshake timeout
401
 *
402
 * @pg_event    : power gating event
A
Alexander Usyskin 已提交
403 404 405 406 407
 * @pg_domain   : runtime PM domain
 *
 * @rd_msg_buf  : control messages buffer
 * @rd_msg_hdr  : read message header storage
 *
408 409 410
 * @hbuf_depth  : depth of hardware host/write buffer is slots
 * @hbuf_is_ready : query if the host host/write buffer is ready
 * @wr_msg      : the buffer for hbm control messages
A
Alexander Usyskin 已提交
411 412 413 414
 *
 * @version     : HBM protocol version in use
 * @hbm_f_pg_supported : hbm feature pgi protocol
 *
415
 * @me_clients_rwsem: rw lock over me_clients list
A
Alexander Usyskin 已提交
416 417 418 419 420
 * @me_clients  : list of FW clients
 * @me_clients_map : FW clients bit map
 * @host_clients_map : host clients id pool
 * @me_client_index : last FW client index in enumeration
 *
421 422
 * @allow_fixed_address: allow user space to connect a fixed client
 *
A
Alexander Usyskin 已提交
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
 * @wd_cl       : watchdog client
 * @wd_state    : watchdog client state
 * @wd_pending  : watchdog command is pending
 * @wd_timeout  : watchdog expiration timeout
 * @wd_data     : watchdog message buffer
 *
 * @amthif_cmd_list : amthif list for cmd waiting
 * @amthif_rd_complete_list : amthif list for reading completed cmd data
 * @iamthif_file_object : file for current amthif operation
 * @iamthif_cl  : amthif host client
 * @iamthif_current_cb : amthif current operation callback
 * @iamthif_open_count : number of opened amthif connections
 * @iamthif_timer : time stamp of current amthif command completion
 * @iamthif_stall_timer : timer to detect amthif hang
 * @iamthif_state : amthif processor state
 * @iamthif_canceled : current amthif command is canceled
 *
 * @init_work   : work item for the device init
 * @reset_work  : work item for the device reset
 *
 * @device_list : mei client bus list
 *
 * @dbgfs_dir   : debugfs mei root directory
 *
 * @ops:        : hw specific operations
 * @hw          : hw specific data
449
 */
450
struct mei_device {
451
	struct device *dev;
452 453 454
	struct cdev cdev;
	int minor;

A
Alexander Usyskin 已提交
455 456 457 458
	struct mei_cl_cb write_list;
	struct mei_cl_cb write_waiting_list;
	struct mei_cl_cb ctrl_wr_list;
	struct mei_cl_cb ctrl_rd_list;
459 460

	struct list_head file_list;
461
	long open_handle_count;
462

A
Alexander Usyskin 已提交
463 464
	struct mutex device_lock;
	struct delayed_work timer_work;
T
Tomas Winkler 已提交
465 466

	bool recvd_hw_ready;
467 468 469
	/*
	 * waiting queue for receive message from FW
	 */
T
Tomas Winkler 已提交
470
	wait_queue_head_t wait_hw_ready;
471
	wait_queue_head_t wait_pg;
472
	wait_queue_head_t wait_hbm_start;
473 474 475 476 477
	wait_queue_head_t wait_stop_wd;

	/*
	 * mei device  states
	 */
478
	unsigned long reset_count;
479
	enum mei_dev_state dev_state;
T
Tomas Winkler 已提交
480
	enum mei_hbm_state hbm_state;
481 482
	u16 init_clients_timer;

483 484 485 486
	/*
	 * Power Gating support
	 */
	enum mei_pg_event pg_event;
487
#ifdef CONFIG_PM
488
	struct dev_pm_domain pg_domain;
489
#endif /* CONFIG_PM */
490

A
Alexander Usyskin 已提交
491
	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];
492
	u32 rd_msg_hdr;
493

494 495 496 497
	/* write buffer */
	u8 hbuf_depth;
	bool hbuf_is_ready;

498 499 500 501 502 503
	/* used for control messages */
	struct {
		struct mei_msg_hdr hdr;
		unsigned char data[128];
	} wr_msg;

504
	struct hbm_version version;
505
	unsigned int hbm_f_pg_supported:1;
506

507
	struct rw_semaphore me_clients_rwsem;
508
	struct list_head me_clients;
509 510
	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
511
	unsigned long me_client_index;
512

513 514
	u32 allow_fixed_address;

515
	struct mei_cl wd_cl;
516
	enum mei_wd_states wd_state;
517
	bool wd_pending;
518
	u16 wd_timeout;
519
	unsigned char wd_data[MEI_WD_START_MSG_SIZE];
520 521


522 523 524 525
	/* amthif list for cmd waiting */
	struct mei_cl_cb amthif_cmd_list;
	/* driver managed amthif list for reading completed amthif cmd data */
	struct mei_cl_cb amthif_rd_complete_list;
526 527
	struct file *iamthif_file_object;
	struct mei_cl iamthif_cl;
528
	struct mei_cl_cb *iamthif_current_cb;
T
Tomas Winkler 已提交
529
	long iamthif_open_count;
530 531 532
	unsigned long iamthif_timer;
	u32 iamthif_stall_timer;
	enum iamthif_states iamthif_state;
533
	bool iamthif_canceled;
534 535

	struct work_struct init_work;
536
	struct work_struct reset_work;
537

538 539 540
	/* List of bus devices */
	struct list_head device_list;

T
Tomas Winkler 已提交
541 542 543 544 545
#if IS_ENABLED(CONFIG_DEBUG_FS)
	struct dentry *dbgfs_dir;
#endif /* CONFIG_DEBUG_FS */


546
	const struct mei_hw_ops *ops;
547
	char hw[0] __aligned(sizeof(void *));
548 549
};

550 551 552 553 554
static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
{
	return msecs_to_jiffies(sec * MSEC_PER_SEC);
}

T
Tomas Winkler 已提交
555 556 557
/**
 * mei_data2slots - get slots - number of (dwords) from a message length
 *	+ size of the mei header
A
Alexander Usyskin 已提交
558
 *
559 560 561
 * @length: size of the messages in bytes
 *
 * Return: number of slots
T
Tomas Winkler 已提交
562 563 564 565 566 567
 */
static inline u32 mei_data2slots(size_t length)
{
	return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
}

T
Tomas Winkler 已提交
568
/**
A
Alexander Usyskin 已提交
569 570
 * mei_slots2data - get data in slots - bytes from slots
 *
571
 * @slots: number of available slots
A
Alexander Usyskin 已提交
572
 *
573
 * Return: number of bytes in slots
T
Tomas Winkler 已提交
574 575 576 577 578 579
 */
static inline u32 mei_slots2data(int slots)
{
	return slots * 4;
}

580 581 582
/*
 * mei init function prototypes
 */
583 584 585
void mei_device_init(struct mei_device *dev,
		     struct device *device,
		     const struct mei_hw_ops *hw_ops);
586
int mei_reset(struct mei_device *dev);
587
int mei_start(struct mei_device *dev);
588
int mei_restart(struct mei_device *dev);
589
void mei_stop(struct mei_device *dev);
T
Tomas Winkler 已提交
590
void mei_cancel_work(struct mei_device *dev);
591 592 593

/*
 *  MEI interrupt functions prototype
594
 */
595

596
void mei_timer(struct work_struct *work);
597 598 599 600
int mei_irq_read_handler(struct mei_device *dev,
		struct mei_cl_cb *cmpl_list, s32 *slots);

int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
601
void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
602

603 604 605 606 607
/*
 * AMTHIF - AMT Host Interface Functions
 */
void mei_amthif_reset_params(struct mei_device *dev);

608
int mei_amthif_host_init(struct mei_device *dev, struct mei_me_client *me_cl);
609 610

int mei_amthif_read(struct mei_device *dev, struct file *file,
611 612 613 614
		char __user *ubuf, size_t length, loff_t *offset);

unsigned int mei_amthif_poll(struct mei_device *dev,
		struct file *file, poll_table *wait);
615

616 617
int mei_amthif_release(struct mei_device *dev, struct file *file);

618
struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
619 620
						struct file *file);

621 622
int mei_amthif_write(struct mei_cl *cl, struct mei_cl_cb *cb);
int mei_amthif_run_next_cmd(struct mei_device *dev);
623 624
int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
			struct mei_cl_cb *cmpl_list);
625 626

void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
627
int mei_amthif_irq_read_msg(struct mei_cl *cl,
628 629 630 631
			    struct mei_msg_hdr *mei_hdr,
			    struct mei_cl_cb *complete_list);
int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);

632 633 634
/*
 * NFC functions
 */
635
int mei_nfc_host_init(struct mei_device *dev, struct mei_me_client *me_cl);
T
Tomas Winkler 已提交
636
void mei_nfc_host_exit(struct mei_device *dev);
637 638 639 640 641

/*
 * NFC Client UUID
 */
extern const uuid_le mei_nfc_guid;
642

643 644
int mei_wd_send(struct mei_device *dev);
int mei_wd_stop(struct mei_device *dev);
645
int mei_wd_host_init(struct mei_device *dev, struct mei_me_client *me_cl);
646 647 648
/*
 * mei_watchdog_register  - Registering watchdog interface
 *   once we got connection to the WD Client
649
 * @dev: mei device
650
 */
651
int mei_watchdog_register(struct mei_device *dev);
652 653
/*
 * mei_watchdog_unregister  - Unregistering watchdog interface
654
 * @dev: mei device
655 656 657
 */
void mei_watchdog_unregister(struct mei_device *dev);

658 659 660 661
/*
 * Register Access Function
 */

662

663 664 665 666
static inline void mei_hw_config(struct mei_device *dev)
{
	dev->ops->hw_config(dev);
}
667

668 669 670 671 672
static inline enum mei_pg_state mei_pg_state(struct mei_device *dev)
{
	return dev->ops->pg_state(dev);
}

673 674 675 676 677
static inline bool mei_pg_is_enabled(struct mei_device *dev)
{
	return dev->ops->pg_is_enabled(dev);
}

678
static inline int mei_hw_reset(struct mei_device *dev, bool enable)
679
{
680
	return dev->ops->hw_reset(dev, enable);
681 682
}

683
static inline int mei_hw_start(struct mei_device *dev)
T
Tomas Winkler 已提交
684
{
685
	return dev->ops->hw_start(dev);
T
Tomas Winkler 已提交
686 687
}

688 689 690 691 692 693 694 695 696
static inline void mei_clear_interrupts(struct mei_device *dev)
{
	dev->ops->intr_clear(dev);
}

static inline void mei_enable_interrupts(struct mei_device *dev)
{
	dev->ops->intr_enable(dev);
}
697

698 699 700 701
static inline void mei_disable_interrupts(struct mei_device *dev)
{
	dev->ops->intr_disable(dev);
}
702

703 704 705 706 707 708 709 710
static inline bool mei_host_is_ready(struct mei_device *dev)
{
	return dev->ops->host_is_ready(dev);
}
static inline bool mei_hw_is_ready(struct mei_device *dev)
{
	return dev->ops->hw_is_ready(dev);
}
711

712 713 714 715
static inline bool mei_hbuf_is_ready(struct mei_device *dev)
{
	return dev->ops->hbuf_is_ready(dev);
}
716

717 718 719 720
static inline int mei_hbuf_empty_slots(struct mei_device *dev)
{
	return dev->ops->hbuf_free_slots(dev);
}
721

722 723 724 725
static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
{
	return dev->ops->hbuf_max_len(dev);
}
726

727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
static inline int mei_write_message(struct mei_device *dev,
			struct mei_msg_hdr *hdr,
			unsigned char *buf)
{
	return dev->ops->write(dev, hdr, buf);
}

static inline u32 mei_read_hdr(const struct mei_device *dev)
{
	return dev->ops->read_hdr(dev);
}

static inline void mei_read_slots(struct mei_device *dev,
		     unsigned char *buf, unsigned long len)
{
	dev->ops->read(dev, buf, len);
}

static inline int mei_count_full_read_slots(struct mei_device *dev)
{
	return dev->ops->rdbuf_full_slots(dev);
}
749

750 751 752 753 754
static inline int mei_fw_status(struct mei_device *dev,
				struct mei_fw_status *fw_status)
{
	return dev->ops->fw_status(dev, fw_status);
}
755

756 757
bool mei_hbuf_acquire(struct mei_device *dev);

758 759
bool mei_write_is_idle(struct mei_device *dev);

T
Tomas Winkler 已提交
760 761 762 763 764 765 766 767 768 769 770
#if IS_ENABLED(CONFIG_DEBUG_FS)
int mei_dbgfs_register(struct mei_device *dev, const char *name);
void mei_dbgfs_deregister(struct mei_device *dev);
#else
static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
{
	return 0;
}
static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
#endif /* CONFIG_DEBUG_FS */

771
int mei_register(struct mei_device *dev, struct device *parent);
T
Tomas Winkler 已提交
772
void mei_deregister(struct mei_device *dev);
773

774
#define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
775 776
#define MEI_HDR_PRM(hdr)                  \
	(hdr)->host_addr, (hdr)->me_addr, \
777
	(hdr)->length, (hdr)->internal, (hdr)->msg_complete
778

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len);
/**
 * mei_fw_status_str - fetch and convert fw status registers to printable string
 *
 * @dev: the device structure
 * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ
 * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ
 *
 * Return: number of bytes written or < 0 on failure
 */
static inline ssize_t mei_fw_status_str(struct mei_device *dev,
					char *buf, size_t len)
{
	struct mei_fw_status fw_status;
	int ret;

	buf[0] = '\0';

	ret = mei_fw_status(dev, &fw_status);
	if (ret)
		return ret;

	ret = mei_fw_status2str(&fw_status, buf, MEI_FW_STATUS_STR_SZ);

	return ret;
}


807
#endif