1/* SPDX-License-Identifier: GPL-2.0 */
 2/*
 3 * Copyright (c) 2003-2018, Intel Corporation. All rights reserved.
 4 * Intel Management Engine Interface (Intel MEI) Linux driver
 5 */
 6
 7#ifndef _MEI_HBM_H_
 8#define _MEI_HBM_H_
 9
10struct mei_device;
11struct mei_msg_hdr;
12struct mei_cl;
13
14/**
15 * enum mei_hbm_state - host bus message protocol state
16 *
17 * @MEI_HBM_IDLE : protocol not started
18 * @MEI_HBM_STARTING : start request message was sent
19 * @MEI_HBM_DR_SETUP : dma ring setup request message was sent
20 * @MEI_HBM_ENUM_CLIENTS : enumeration request was sent
21 * @MEI_HBM_CLIENT_PROPERTIES : acquiring clients properties
22 * @MEI_HBM_STARTED : enumeration was completed
23 * @MEI_HBM_STOPPED : stopping exchange
24 */
25enum mei_hbm_state {
26	MEI_HBM_IDLE = 0,
27	MEI_HBM_STARTING,
28	MEI_HBM_DR_SETUP,
29	MEI_HBM_ENUM_CLIENTS,
30	MEI_HBM_CLIENT_PROPERTIES,
31	MEI_HBM_STARTED,
32	MEI_HBM_STOPPED,
33};
34
35const char *mei_hbm_state_str(enum mei_hbm_state state);
36
37int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr);
38
39void mei_hbm_idle(struct mei_device *dev);
40void mei_hbm_reset(struct mei_device *dev);
41int mei_hbm_start_req(struct mei_device *dev);
42int mei_hbm_start_wait(struct mei_device *dev);
43int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl);
44int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl);
45int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl);
46int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl);
47bool mei_hbm_version_is_supported(struct mei_device *dev);
48int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd);
49void mei_hbm_pg_resume(struct mei_device *dev);
50int mei_hbm_cl_notify_req(struct mei_device *dev,
51			  struct mei_cl *cl, u8 request);
52
53#endif /* _MEI_HBM_H_ */
54