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_CLIENT_H_
18 #define _MEI_CLIENT_H_
19
20 #include <linux/types.h>
21 #include <linux/watchdog.h>
22 #include <linux/poll.h>
23 #include <linux/mei.h>
24
25 #include "mei_dev.h"
26
27 /*
28 * reference counting base function
29 */
30 void mei_me_cl_init(struct mei_me_client *me_cl);
31 void mei_me_cl_put(struct mei_me_client *me_cl);
32 struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl);
33
34 void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl);
35 void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl);
36
37 struct mei_me_client *mei_me_cl_by_uuid(struct mei_device *dev,
38 const uuid_le *uuid);
39 struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
40 struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,
41 const uuid_le *uuid, u8 client_id);
42 void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid);
43 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev,
44 const uuid_le *uuid, u8 id);
45 void mei_me_cl_rm_all(struct mei_device *dev);
46
47 /**
48 * mei_me_cl_is_active - check whether me client is active in the fw
49 *
50 * @me_cl: me client
51 *
52 * Return: true if the me client is active in the firmware
53 */
mei_me_cl_is_active(const struct mei_me_client * me_cl)54 static inline bool mei_me_cl_is_active(const struct mei_me_client *me_cl)
55 {
56 return !list_empty_careful(&me_cl->list);
57 }
58
59 /**
60 * mei_me_cl_uuid - return me client protocol name (uuid)
61 *
62 * @me_cl: me client
63 *
64 * Return: me client protocol name
65 */
mei_me_cl_uuid(const struct mei_me_client * me_cl)66 static inline const uuid_le *mei_me_cl_uuid(const struct mei_me_client *me_cl)
67 {
68 return &me_cl->props.protocol_name;
69 }
70
71 /**
72 * mei_me_cl_ver - return me client protocol version
73 *
74 * @me_cl: me client
75 *
76 * Return: me client protocol version
77 */
mei_me_cl_ver(const struct mei_me_client * me_cl)78 static inline u8 mei_me_cl_ver(const struct mei_me_client *me_cl)
79 {
80 return me_cl->props.protocol_version;
81 }
82
83 /*
84 * MEI IO Functions
85 */
86 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, enum mei_cb_file_ops type,
87 struct file *fp);
88 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
89 int mei_io_cb_alloc_buf(struct mei_cl_cb *cb, size_t length);
90
91
92 /**
93 * mei_io_list_init - Sets up a queue list.
94 *
95 * @list: An instance cl callback structure
96 */
mei_io_list_init(struct mei_cl_cb * list)97 static inline void mei_io_list_init(struct mei_cl_cb *list)
98 {
99 INIT_LIST_HEAD(&list->list);
100 }
101 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
102
103 /*
104 * MEI Host Client Functions
105 */
106
107 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
108 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
109
110
111 int mei_cl_link(struct mei_cl *cl, int id);
112 int mei_cl_unlink(struct mei_cl *cl);
113
114 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev, int id);
115
116 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl,
117 const struct file *fp);
118 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp);
119 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
120 enum mei_cb_file_ops type, struct file *fp);
121 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp);
122
123 int mei_cl_flow_ctrl_creds(struct mei_cl *cl);
124
125 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl);
126 /*
127 * MEI input output function prototype
128 */
129
130 /**
131 * mei_cl_is_connected - host client is connected
132 *
133 * @cl: host client
134 *
135 * Return: true if the host client is connected
136 */
mei_cl_is_connected(struct mei_cl * cl)137 static inline bool mei_cl_is_connected(struct mei_cl *cl)
138 {
139 return cl->state == MEI_FILE_CONNECTED;
140 }
141
142 /**
143 * mei_cl_me_id - me client id
144 *
145 * @cl: host client
146 *
147 * Return: me client id or 0 if client is not connected
148 */
mei_cl_me_id(const struct mei_cl * cl)149 static inline u8 mei_cl_me_id(const struct mei_cl *cl)
150 {
151 return cl->me_cl ? cl->me_cl->client_id : 0;
152 }
153
154 /**
155 * mei_cl_mtu - maximal message that client can send and receive
156 *
157 * @cl: host client
158 *
159 * Return: mtu or 0 if client is not connected
160 */
mei_cl_mtu(const struct mei_cl * cl)161 static inline size_t mei_cl_mtu(const struct mei_cl *cl)
162 {
163 return cl->me_cl ? cl->me_cl->props.max_msg_length : 0;
164 }
165
166 /**
167 * mei_cl_is_fixed_address - check whether the me client uses fixed address
168 *
169 * @cl: host client
170 *
171 * Return: true if the client is connected and it has fixed me address
172 */
mei_cl_is_fixed_address(const struct mei_cl * cl)173 static inline bool mei_cl_is_fixed_address(const struct mei_cl *cl)
174 {
175 return cl->me_cl && cl->me_cl->props.fixed_address;
176 }
177
178 /**
179 * mei_cl_is_single_recv_buf- check whether the me client
180 * uses single receiving buffer
181 *
182 * @cl: host client
183 *
184 * Return: true if single_recv_buf == 1; 0 otherwise
185 */
mei_cl_is_single_recv_buf(const struct mei_cl * cl)186 static inline bool mei_cl_is_single_recv_buf(const struct mei_cl *cl)
187 {
188 return cl->me_cl->props.single_recv_buf;
189 }
190
191 /**
192 * mei_cl_uuid - client's uuid
193 *
194 * @cl: host client
195 *
196 * Return: return uuid of connected me client
197 */
mei_cl_uuid(const struct mei_cl * cl)198 static inline const uuid_le *mei_cl_uuid(const struct mei_cl *cl)
199 {
200 return mei_me_cl_uuid(cl->me_cl);
201 }
202
203 /**
204 * mei_cl_host_addr - client's host address
205 *
206 * @cl: host client
207 *
208 * Return: 0 for fixed address client, host address for dynamic client
209 */
mei_cl_host_addr(const struct mei_cl * cl)210 static inline u8 mei_cl_host_addr(const struct mei_cl *cl)
211 {
212 return mei_cl_is_fixed_address(cl) ? 0 : cl->host_client_id;
213 }
214
215 int mei_cl_disconnect(struct mei_cl *cl);
216 void mei_cl_set_disconnected(struct mei_cl *cl);
217 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
218 struct mei_cl_cb *cmpl_list);
219 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
220 struct file *file);
221 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
222 struct mei_cl_cb *cmpl_list);
223 int mei_cl_read_start(struct mei_cl *cl, size_t length, struct file *fp);
224 int mei_cl_irq_read_msg(struct mei_cl *cl, struct mei_msg_hdr *hdr,
225 struct mei_cl_cb *cmpl_list);
226 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking);
227 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
228 struct mei_cl_cb *cmpl_list);
229
230 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
231
232 void mei_host_client_init(struct work_struct *work);
233
234 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop);
235 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 request);
236 int mei_cl_notify_request(struct mei_cl *cl, struct file *file, u8 request);
237 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
238 struct mei_cl_cb *cmpl_list);
239 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev);
240 void mei_cl_notify(struct mei_cl *cl);
241
242 void mei_cl_all_disconnect(struct mei_device *dev);
243 void mei_cl_all_wakeup(struct mei_device *dev);
244 void mei_cl_all_write_clear(struct mei_device *dev);
245
246 #define MEI_CL_FMT "cl:host=%02d me=%02d "
247 #define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl)
248
249 #define cl_dbg(dev, cl, format, arg...) \
250 dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
251
252 #define cl_err(dev, cl, format, arg...) \
253 dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
254
255 #endif /* _MEI_CLIENT_H_ */
256