mei: hbm: setup dma ring
[muen/linux.git] / drivers / misc / mei / hbm.h
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_STARTING : start request message was sent
29  * @MEI_HBM_DR_SETUP : dma ring setup request message was sent
30  * @MEI_HBM_ENUM_CLIENTS : enumeration request was sent
31  * @MEI_HBM_CLIENT_PROPERTIES : acquiring clients properties
32  * @MEI_HBM_STARTED : enumeration was completed
33  * @MEI_HBM_STOPPED : stopping exchange
34  */
35 enum mei_hbm_state {
36         MEI_HBM_IDLE = 0,
37         MEI_HBM_STARTING,
38         MEI_HBM_DR_SETUP,
39         MEI_HBM_ENUM_CLIENTS,
40         MEI_HBM_CLIENT_PROPERTIES,
41         MEI_HBM_STARTED,
42         MEI_HBM_STOPPED,
43 };
44
45 const char *mei_hbm_state_str(enum mei_hbm_state state);
46
47 int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr);
48
49 void mei_hbm_idle(struct mei_device *dev);
50 void mei_hbm_reset(struct mei_device *dev);
51 int mei_hbm_start_req(struct mei_device *dev);
52 int mei_hbm_start_wait(struct mei_device *dev);
53 int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl);
54 int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl);
55 int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl);
56 int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl);
57 bool mei_hbm_version_is_supported(struct mei_device *dev);
58 int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd);
59 void mei_hbm_pg_resume(struct mei_device *dev);
60 int mei_hbm_cl_notify_req(struct mei_device *dev,
61                           struct mei_cl *cl, u8 request);
62
63 #endif /* _MEI_HBM_H_ */
64