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
17 #ifndef _MEI_CLIENT_H_
18 #define _MEI_CLIENT_H_
20 #include <linux/types.h>
21 #include <linux/watchdog.h>
22 #include <linux/poll.h>
23 #include <linux/mei.h>
27 int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
28 int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
33 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
34 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
35 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
36 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
40 * mei_io_list_init - Sets up a queue list.
42 * @list: An instance cl callback structure
44 static inline void mei_io_list_init(struct mei_cl_cb *list)
46 INIT_LIST_HEAD(&list->list);
48 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
51 * MEI Host Client Functions
54 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
55 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
58 int mei_cl_link(struct mei_cl *cl, int id);
59 int mei_cl_unlink(struct mei_cl *cl);
61 int mei_cl_flush_queues(struct mei_cl *cl);
62 struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl);
65 int mei_cl_flow_ctrl_creds(struct mei_cl *cl);
67 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl);
69 * MEI input output function prototype
71 static inline bool mei_cl_is_connected(struct mei_cl *cl)
74 cl->dev->dev_state == MEI_DEV_ENABLED &&
75 cl->state == MEI_FILE_CONNECTED;
77 static inline bool mei_cl_is_transitioning(struct mei_cl *cl)
79 return MEI_FILE_INITIALIZING == cl->state ||
80 MEI_FILE_DISCONNECTED == cl->state ||
81 MEI_FILE_DISCONNECTING == cl->state;
84 bool mei_cl_is_other_connecting(struct mei_cl *cl);
85 int mei_cl_disconnect(struct mei_cl *cl);
86 int mei_cl_connect(struct mei_cl *cl, struct file *file);
87 int mei_cl_read_start(struct mei_cl *cl, size_t length);
88 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking);
89 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
90 struct mei_cl_cb *cmpl_list);
92 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
94 void mei_host_client_init(struct work_struct *work);
98 void mei_cl_all_disconnect(struct mei_device *dev);
99 void mei_cl_all_wakeup(struct mei_device *dev);
100 void mei_cl_all_write_clear(struct mei_device *dev);
102 #define MEI_CL_FMT "cl:host=%02d me=%02d "
103 #define MEI_CL_PRM(cl) (cl)->host_client_id, (cl)->me_client_id
105 #define cl_dbg(dev, cl, format, arg...) \
106 dev_dbg(&(dev)->pdev->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
108 #define cl_err(dev, cl, format, arg...) \
109 dev_err(&(dev)->pdev->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
111 #endif /* _MEI_CLIENT_H_ */