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/poll.h>
22 #include <linux/mei.h>
27 * reference counting base function
29 void mei_me_cl_init(struct mei_me_client *me_cl);
30 void mei_me_cl_put(struct mei_me_client *me_cl);
31 struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl);
33 void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl);
34 void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl);
36 struct mei_me_client *mei_me_cl_by_uuid(struct mei_device *dev,
38 struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
39 struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,
40 const uuid_le *uuid, u8 client_id);
41 void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid);
42 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev,
43 const uuid_le *uuid, u8 id);
44 void mei_me_cl_rm_all(struct mei_device *dev);
47 * mei_me_cl_is_active - check whether me client is active in the fw
51 * Return: true if the me client is active in the firmware
53 static inline bool mei_me_cl_is_active(const struct mei_me_client *me_cl)
55 return !list_empty_careful(&me_cl->list);
59 * mei_me_cl_uuid - return me client protocol name (uuid)
63 * Return: me client protocol name
65 static inline const uuid_le *mei_me_cl_uuid(const struct mei_me_client *me_cl)
67 return &me_cl->props.protocol_name;
71 * mei_me_cl_ver - return me client protocol version
75 * Return: me client protocol version
77 static inline u8 mei_me_cl_ver(const struct mei_me_client *me_cl)
79 return me_cl->props.protocol_version;
85 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, enum mei_cb_file_ops type,
86 const struct file *fp);
87 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
88 int mei_io_cb_alloc_buf(struct mei_cl_cb *cb, size_t length);
92 * mei_io_list_init - Sets up a queue list.
94 * @list: An instance cl callback structure
96 static inline void mei_io_list_init(struct mei_cl_cb *list)
98 INIT_LIST_HEAD(&list->list);
100 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
103 * MEI Host Client Functions
106 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
107 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
110 int mei_cl_link(struct mei_cl *cl);
111 int mei_cl_unlink(struct mei_cl *cl);
113 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev);
115 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl,
116 const struct file *fp);
117 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp);
118 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
119 enum mei_cb_file_ops type,
120 const struct file *fp);
121 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp);
124 * MEI input output function prototype
128 * mei_cl_is_connected - host client is connected
132 * Return: true if the host client is connected
134 static inline bool mei_cl_is_connected(struct mei_cl *cl)
136 return cl->state == MEI_FILE_CONNECTED;
140 * mei_cl_me_id - me client id
144 * Return: me client id or 0 if client is not connected
146 static inline u8 mei_cl_me_id(const struct mei_cl *cl)
148 return cl->me_cl ? cl->me_cl->client_id : 0;
152 * mei_cl_mtu - maximal message that client can send and receive
158 static inline size_t mei_cl_mtu(const struct mei_cl *cl)
160 return cl->me_cl->props.max_msg_length;
164 * mei_cl_is_fixed_address - check whether the me client uses fixed address
168 * Return: true if the client is connected and it has fixed me address
170 static inline bool mei_cl_is_fixed_address(const struct mei_cl *cl)
172 return cl->me_cl && cl->me_cl->props.fixed_address;
176 * mei_cl_is_single_recv_buf- check whether the me client
177 * uses single receiving buffer
181 * Return: true if single_recv_buf == 1; 0 otherwise
183 static inline bool mei_cl_is_single_recv_buf(const struct mei_cl *cl)
185 return cl->me_cl->props.single_recv_buf;
189 * mei_cl_uuid - client's uuid
193 * Return: return uuid of connected me client
195 static inline const uuid_le *mei_cl_uuid(const struct mei_cl *cl)
197 return mei_me_cl_uuid(cl->me_cl);
201 * mei_cl_host_addr - client's host address
205 * Return: 0 for fixed address client, host address for dynamic client
207 static inline u8 mei_cl_host_addr(const struct mei_cl *cl)
209 return mei_cl_is_fixed_address(cl) ? 0 : cl->host_client_id;
212 int mei_cl_disconnect(struct mei_cl *cl);
213 void mei_cl_set_disconnected(struct mei_cl *cl);
214 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
215 struct mei_cl_cb *cmpl_list);
216 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
217 const struct file *file);
218 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
219 struct mei_cl_cb *cmpl_list);
220 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp);
221 int mei_cl_irq_read_msg(struct mei_cl *cl, struct mei_msg_hdr *hdr,
222 struct mei_cl_cb *cmpl_list);
223 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking);
224 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
225 struct mei_cl_cb *cmpl_list);
227 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
229 void mei_host_client_init(struct mei_device *dev);
231 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop);
232 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 request);
233 int mei_cl_notify_request(struct mei_cl *cl,
234 const struct file *file, u8 request);
235 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
236 struct mei_cl_cb *cmpl_list);
237 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev);
238 void mei_cl_notify(struct mei_cl *cl);
240 void mei_cl_all_disconnect(struct mei_device *dev);
242 #define MEI_CL_FMT "cl:host=%02d me=%02d "
243 #define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl)
245 #define cl_dbg(dev, cl, format, arg...) \
246 dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
248 #define cl_warn(dev, cl, format, arg...) \
249 dev_warn((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
251 #define cl_err(dev, cl, format, arg...) \
252 dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
254 #endif /* _MEI_CLIENT_H_ */