19fff0425STomas Winkler /* SPDX-License-Identifier: GPL-2.0 */ 20edb23fcSTomas Winkler /* 31e55b609STomas Winkler * Copyright (c) 2003-2018, Intel Corporation. All rights reserved. 40edb23fcSTomas Winkler * Intel Management Engine Interface (Intel MEI) Linux driver 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 19*e5cab1f9SAlexander Usyskin * @MEI_HBM_CAP_SETUP : capabilities request message was sent 20c55bf542STomas Winkler * @MEI_HBM_DR_SETUP : dma ring setup request message was sent 219b0d5efcSTomas Winkler * @MEI_HBM_ENUM_CLIENTS : enumeration request was sent 229b0d5efcSTomas Winkler * @MEI_HBM_CLIENT_PROPERTIES : acquiring clients properties 235ebdc364STomas Winkler * @MEI_HBM_STARTED : enumeration was completed 24cb02efc3SAlexander Usyskin * @MEI_HBM_STOPPED : stopping exchange 259b0d5efcSTomas Winkler */ 269b0d5efcSTomas Winkler enum mei_hbm_state { 279b0d5efcSTomas Winkler MEI_HBM_IDLE = 0, 28cb02efc3SAlexander Usyskin MEI_HBM_STARTING, 29*e5cab1f9SAlexander Usyskin MEI_HBM_CAP_SETUP, 30c55bf542STomas Winkler MEI_HBM_DR_SETUP, 319b0d5efcSTomas Winkler MEI_HBM_ENUM_CLIENTS, 329b0d5efcSTomas Winkler MEI_HBM_CLIENT_PROPERTIES, 335ebdc364STomas Winkler MEI_HBM_STARTED, 34544f9460STomas Winkler MEI_HBM_STOPPED, 359b0d5efcSTomas Winkler }; 369b0d5efcSTomas Winkler 371beeb4b9SAlexander Usyskin const char *mei_hbm_state_str(enum mei_hbm_state state); 381beeb4b9SAlexander Usyskin 39544f9460STomas Winkler int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr); 400edb23fcSTomas Winkler 4166ae460bSTomas Winkler void mei_hbm_idle(struct mei_device *dev); 4284b3294aSTomas Winkler void mei_hbm_reset(struct mei_device *dev); 439b0d5efcSTomas Winkler int mei_hbm_start_req(struct mei_device *dev); 449b0d5efcSTomas Winkler int mei_hbm_start_wait(struct mei_device *dev); 450edb23fcSTomas Winkler int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl); 460edb23fcSTomas Winkler int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl); 476bb948c9STomas Winkler int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl); 480edb23fcSTomas Winkler int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl); 492c9b48acSTomas Winkler bool mei_hbm_version_is_supported(struct mei_device *dev); 504fcbc99bSTomas Winkler int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd); 51859ef2ffSAlexander Usyskin void mei_hbm_pg_resume(struct mei_device *dev); 52965ae37aSTomas Winkler int mei_hbm_cl_notify_req(struct mei_device *dev, 53965ae37aSTomas Winkler struct mei_cl *cl, u8 request); 540edb23fcSTomas Winkler 550edb23fcSTomas Winkler #endif /* _MEI_HBM_H_ */ 560edb23fcSTomas Winkler 57