xref: /openbmc/linux/drivers/misc/mei/hbm.h (revision 9fff0425aab086c10b29ce50d440afde7d31a740)
1*9fff0425STomas Winkler /* SPDX-License-Identifier: GPL-2.0 */
20edb23fcSTomas Winkler /*
30edb23fcSTomas Winkler  * Intel Management Engine Interface (Intel MEI) Linux driver
40edb23fcSTomas Winkler  * Copyright (c) 2003-2012, Intel Corporation.
50edb23fcSTomas Winkler  */
60edb23fcSTomas Winkler 
70edb23fcSTomas Winkler #ifndef _MEI_HBM_H_
80edb23fcSTomas Winkler #define _MEI_HBM_H_
90edb23fcSTomas Winkler 
109b0d5efcSTomas Winkler struct mei_device;
119b0d5efcSTomas Winkler struct mei_msg_hdr;
129b0d5efcSTomas Winkler struct mei_cl;
139b0d5efcSTomas Winkler 
149b0d5efcSTomas Winkler /**
159b0d5efcSTomas Winkler  * enum mei_hbm_state - host bus message protocol state
169b0d5efcSTomas Winkler  *
179b0d5efcSTomas Winkler  * @MEI_HBM_IDLE : protocol not started
18cb02efc3SAlexander Usyskin  * @MEI_HBM_STARTING : start request message was sent
19c55bf542STomas Winkler  * @MEI_HBM_DR_SETUP : dma ring setup request message was sent
209b0d5efcSTomas Winkler  * @MEI_HBM_ENUM_CLIENTS : enumeration request was sent
219b0d5efcSTomas Winkler  * @MEI_HBM_CLIENT_PROPERTIES : acquiring clients properties
225ebdc364STomas Winkler  * @MEI_HBM_STARTED : enumeration was completed
23cb02efc3SAlexander Usyskin  * @MEI_HBM_STOPPED : stopping exchange
249b0d5efcSTomas Winkler  */
259b0d5efcSTomas Winkler enum mei_hbm_state {
269b0d5efcSTomas Winkler 	MEI_HBM_IDLE = 0,
27cb02efc3SAlexander Usyskin 	MEI_HBM_STARTING,
28c55bf542STomas Winkler 	MEI_HBM_DR_SETUP,
299b0d5efcSTomas Winkler 	MEI_HBM_ENUM_CLIENTS,
309b0d5efcSTomas Winkler 	MEI_HBM_CLIENT_PROPERTIES,
315ebdc364STomas Winkler 	MEI_HBM_STARTED,
32544f9460STomas Winkler 	MEI_HBM_STOPPED,
339b0d5efcSTomas Winkler };
349b0d5efcSTomas Winkler 
351beeb4b9SAlexander Usyskin const char *mei_hbm_state_str(enum mei_hbm_state state);
361beeb4b9SAlexander Usyskin 
37544f9460STomas Winkler int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr);
380edb23fcSTomas Winkler 
3966ae460bSTomas Winkler void mei_hbm_idle(struct mei_device *dev);
4084b3294aSTomas Winkler void mei_hbm_reset(struct mei_device *dev);
419b0d5efcSTomas Winkler int mei_hbm_start_req(struct mei_device *dev);
429b0d5efcSTomas Winkler int mei_hbm_start_wait(struct mei_device *dev);
430edb23fcSTomas Winkler int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl);
440edb23fcSTomas Winkler int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl);
456bb948c9STomas Winkler int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl);
460edb23fcSTomas Winkler int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl);
472c9b48acSTomas Winkler bool mei_hbm_version_is_supported(struct mei_device *dev);
484fcbc99bSTomas Winkler int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd);
49859ef2ffSAlexander Usyskin void mei_hbm_pg_resume(struct mei_device *dev);
50965ae37aSTomas Winkler int mei_hbm_cl_notify_req(struct mei_device *dev,
51965ae37aSTomas Winkler 			  struct mei_cl *cl, u8 request);
520edb23fcSTomas Winkler 
530edb23fcSTomas Winkler #endif /* _MEI_HBM_H_ */
540edb23fcSTomas Winkler 
55