xref: /openbmc/linux/drivers/misc/mei/hbm.h (revision 1beeb4b9fbb27432f93ae8fe157228b7b897974a)
10edb23fcSTomas Winkler /*
20edb23fcSTomas Winkler  *
30edb23fcSTomas Winkler  * Intel Management Engine Interface (Intel MEI) Linux driver
40edb23fcSTomas Winkler  * Copyright (c) 2003-2012, Intel Corporation.
50edb23fcSTomas Winkler  *
60edb23fcSTomas Winkler  * This program is free software; you can redistribute it and/or modify it
70edb23fcSTomas Winkler  * under the terms and conditions of the GNU General Public License,
80edb23fcSTomas Winkler  * version 2, as published by the Free Software Foundation.
90edb23fcSTomas Winkler  *
100edb23fcSTomas Winkler  * This program is distributed in the hope it will be useful, but WITHOUT
110edb23fcSTomas Winkler  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
120edb23fcSTomas Winkler  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
130edb23fcSTomas Winkler  * more details.
140edb23fcSTomas Winkler  *
150edb23fcSTomas Winkler  */
160edb23fcSTomas Winkler 
170edb23fcSTomas Winkler #ifndef _MEI_HBM_H_
180edb23fcSTomas Winkler #define _MEI_HBM_H_
190edb23fcSTomas Winkler 
209b0d5efcSTomas Winkler struct mei_device;
219b0d5efcSTomas Winkler struct mei_msg_hdr;
229b0d5efcSTomas Winkler struct mei_cl;
239b0d5efcSTomas Winkler 
249b0d5efcSTomas Winkler /**
259b0d5efcSTomas Winkler  * enum mei_hbm_state - host bus message protocol state
269b0d5efcSTomas Winkler  *
279b0d5efcSTomas Winkler  * @MEI_HBM_IDLE : protocol not started
28cb02efc3SAlexander Usyskin  * @MEI_HBM_STARTING : start request message was sent
29cb02efc3SAlexander Usyskin  * @MEI_HBM_STARTED : start reply message was received
309b0d5efcSTomas Winkler  * @MEI_HBM_ENUM_CLIENTS : enumeration request was sent
319b0d5efcSTomas Winkler  * @MEI_HBM_CLIENT_PROPERTIES : acquiring clients properties
32cb02efc3SAlexander Usyskin  * @MEI_HBM_STOPPED : stopping exchange
339b0d5efcSTomas Winkler  */
349b0d5efcSTomas Winkler enum mei_hbm_state {
359b0d5efcSTomas Winkler 	MEI_HBM_IDLE = 0,
36cb02efc3SAlexander Usyskin 	MEI_HBM_STARTING,
37544f9460STomas Winkler 	MEI_HBM_STARTED,
389b0d5efcSTomas Winkler 	MEI_HBM_ENUM_CLIENTS,
399b0d5efcSTomas Winkler 	MEI_HBM_CLIENT_PROPERTIES,
40544f9460STomas Winkler 	MEI_HBM_STOPPED,
419b0d5efcSTomas Winkler };
429b0d5efcSTomas Winkler 
43*1beeb4b9SAlexander Usyskin const char *mei_hbm_state_str(enum mei_hbm_state state);
44*1beeb4b9SAlexander Usyskin 
45544f9460STomas Winkler int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr);
460edb23fcSTomas Winkler 
470edb23fcSTomas Winkler static inline void mei_hbm_hdr(struct mei_msg_hdr *hdr, size_t length)
480edb23fcSTomas Winkler {
490edb23fcSTomas Winkler 	hdr->host_addr = 0;
500edb23fcSTomas Winkler 	hdr->me_addr = 0;
510edb23fcSTomas Winkler 	hdr->length = length;
520edb23fcSTomas Winkler 	hdr->msg_complete = 1;
530edb23fcSTomas Winkler 	hdr->reserved = 0;
540edb23fcSTomas Winkler }
550edb23fcSTomas Winkler 
5666ae460bSTomas Winkler void mei_hbm_idle(struct mei_device *dev);
5784b3294aSTomas Winkler void mei_hbm_reset(struct mei_device *dev);
589b0d5efcSTomas Winkler int mei_hbm_start_req(struct mei_device *dev);
599b0d5efcSTomas Winkler int mei_hbm_start_wait(struct mei_device *dev);
600edb23fcSTomas Winkler int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl);
610edb23fcSTomas Winkler int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl);
626bb948c9STomas Winkler int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl);
630edb23fcSTomas Winkler int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl);
642c9b48acSTomas Winkler bool mei_hbm_version_is_supported(struct mei_device *dev);
654fcbc99bSTomas Winkler int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd);
660edb23fcSTomas Winkler 
670edb23fcSTomas Winkler #endif /* _MEI_HBM_H_ */
680edb23fcSTomas Winkler 
69