xref: /linux/drivers/misc/mei/hbm.h (revision 3932b9ca55b0be314a36d3e84faff3e823c081f5)
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_HBM_H_
18 #define _MEI_HBM_H_
19 
20 struct mei_device;
21 struct mei_msg_hdr;
22 struct mei_cl;
23 
24 /**
25  * enum mei_hbm_state - host bus message protocol state
26  *
27  * @MEI_HBM_IDLE : protocol not started
28  * @MEI_HBM_START : start request message was sent
29  * @MEI_HBM_ENUM_CLIENTS : enumeration request was sent
30  * @MEI_HBM_CLIENT_PROPERTIES : acquiring clients properties
31  */
32 enum mei_hbm_state {
33 	MEI_HBM_IDLE = 0,
34 	MEI_HBM_START,
35 	MEI_HBM_STARTED,
36 	MEI_HBM_ENUM_CLIENTS,
37 	MEI_HBM_CLIENT_PROPERTIES,
38 	MEI_HBM_STOPPED,
39 };
40 
41 int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr);
42 
43 static inline void mei_hbm_hdr(struct mei_msg_hdr *hdr, size_t length)
44 {
45 	hdr->host_addr = 0;
46 	hdr->me_addr = 0;
47 	hdr->length = length;
48 	hdr->msg_complete = 1;
49 	hdr->reserved = 0;
50 }
51 
52 void mei_hbm_idle(struct mei_device *dev);
53 void mei_hbm_reset(struct mei_device *dev);
54 int mei_hbm_start_req(struct mei_device *dev);
55 int mei_hbm_start_wait(struct mei_device *dev);
56 int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl);
57 int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl);
58 int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl);
59 int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl);
60 bool mei_hbm_version_is_supported(struct mei_device *dev);
61 int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd);
62 
63 #endif /* _MEI_HBM_H_ */
64 
65