]>
git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - drivers/misc/mei/client.h
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>
28 * reference counting base function
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
);
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
);
37 struct mei_me_client
*mei_me_cl_by_uuid(struct mei_device
*dev
,
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
);
48 * mei_me_cl_is_active - check whether me client is active in the fw
52 * Return: true if the me client is active in the firmware
54 static inline bool mei_me_cl_is_active(const struct mei_me_client
*me_cl
)
56 return !list_empty_careful(&me_cl
->list
);
60 * mei_me_cl_uuid - return me client protocol name (uuid)
64 * Return: me client protocol name
66 static inline const uuid_le
*mei_me_cl_uuid(const struct mei_me_client
*me_cl
)
68 return &me_cl
->props
.protocol_name
;
74 struct mei_cl_cb
*mei_io_cb_init(struct mei_cl
*cl
, enum mei_cb_file_ops type
,
76 void mei_io_cb_free(struct mei_cl_cb
*priv_cb
);
77 int mei_io_cb_alloc_buf(struct mei_cl_cb
*cb
, size_t length
);
81 * mei_io_list_init - Sets up a queue list.
83 * @list: An instance cl callback structure
85 static inline void mei_io_list_init(struct mei_cl_cb
*list
)
87 INIT_LIST_HEAD(&list
->list
);
89 void mei_io_list_flush(struct mei_cl_cb
*list
, struct mei_cl
*cl
);
92 * MEI Host Client Functions
95 struct mei_cl
*mei_cl_allocate(struct mei_device
*dev
);
96 void mei_cl_init(struct mei_cl
*cl
, struct mei_device
*dev
);
99 int mei_cl_link(struct mei_cl
*cl
, int id
);
100 int mei_cl_unlink(struct mei_cl
*cl
);
102 struct mei_cl
*mei_cl_alloc_linked(struct mei_device
*dev
, int id
);
104 struct mei_cl_cb
*mei_cl_read_cb(const struct mei_cl
*cl
,
105 const struct file
*fp
);
106 void mei_cl_read_cb_flush(const struct mei_cl
*cl
, const struct file
*fp
);
107 struct mei_cl_cb
*mei_cl_alloc_cb(struct mei_cl
*cl
, size_t length
,
108 enum mei_cb_file_ops type
, struct file
*fp
);
109 int mei_cl_flush_queues(struct mei_cl
*cl
, const struct file
*fp
);
111 int mei_cl_flow_ctrl_creds(struct mei_cl
*cl
);
113 int mei_cl_flow_ctrl_reduce(struct mei_cl
*cl
);
115 * MEI input output function prototype
119 * mei_cl_is_connected - host client is connected
123 * Return: true if the host client is connected
125 static inline bool mei_cl_is_connected(struct mei_cl
*cl
)
127 return cl
->state
== MEI_FILE_CONNECTED
;
131 * mei_cl_me_id - me client id
135 * Return: me client id or 0 if client is not connected
137 static inline u8
mei_cl_me_id(const struct mei_cl
*cl
)
139 return cl
->me_cl
? cl
->me_cl
->client_id
: 0;
143 * mei_cl_mtu - maximal message that client can send and receive
149 static inline size_t mei_cl_mtu(const struct mei_cl
*cl
)
151 return cl
->me_cl
->props
.max_msg_length
;
155 * mei_cl_is_fixed_address - check whether the me client uses fixed address
159 * Return: true if the client is connected and it has fixed me address
161 static inline bool mei_cl_is_fixed_address(const struct mei_cl
*cl
)
163 return cl
->me_cl
&& cl
->me_cl
->props
.fixed_address
;
167 * mei_cl_is_single_recv_buf- check whether the me client
168 * uses single receiving buffer
172 * Return: true if single_recv_buf == 1; 0 otherwise
174 static inline bool mei_cl_is_single_recv_buf(const struct mei_cl
*cl
)
176 return cl
->me_cl
->props
.single_recv_buf
;
180 * mei_cl_uuid - client's uuid
184 * Return: return uuid of connected me client
186 static inline const uuid_le
*mei_cl_uuid(const struct mei_cl
*cl
)
188 return mei_me_cl_uuid(cl
->me_cl
);
192 * mei_cl_host_addr - client's host address
196 * Return: 0 for fixed address client, host address for dynamic client
198 static inline u8
mei_cl_host_addr(const struct mei_cl
*cl
)
200 return mei_cl_is_fixed_address(cl
) ? 0 : cl
->host_client_id
;
203 int mei_cl_disconnect(struct mei_cl
*cl
);
204 void mei_cl_set_disconnected(struct mei_cl
*cl
);
205 int mei_cl_irq_disconnect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
206 struct mei_cl_cb
*cmpl_list
);
207 int mei_cl_connect(struct mei_cl
*cl
, struct mei_me_client
*me_cl
,
209 int mei_cl_irq_connect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
210 struct mei_cl_cb
*cmpl_list
);
211 int mei_cl_read_start(struct mei_cl
*cl
, size_t length
, struct file
*fp
);
212 int mei_cl_irq_read_msg(struct mei_cl
*cl
, struct mei_msg_hdr
*hdr
,
213 struct mei_cl_cb
*cmpl_list
);
214 int mei_cl_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
, bool blocking
);
215 int mei_cl_irq_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
216 struct mei_cl_cb
*cmpl_list
);
218 void mei_cl_complete(struct mei_cl
*cl
, struct mei_cl_cb
*cb
);
220 void mei_host_client_init(struct work_struct
*work
);
222 void mei_cl_all_disconnect(struct mei_device
*dev
);
223 void mei_cl_all_wakeup(struct mei_device
*dev
);
224 void mei_cl_all_write_clear(struct mei_device
*dev
);
226 #define MEI_CL_FMT "cl:host=%02d me=%02d "
227 #define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl)
229 #define cl_dbg(dev, cl, format, arg...) \
230 dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
232 #define cl_err(dev, cl, format, arg...) \
233 dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
235 #endif /* _MEI_CLIENT_H_ */