[linux-2.6-block.git] / drivers / misc / mei / hw.h

/*
 *
 * Intel Management Engine Interface (Intel MEI) Linux driver
 * Copyright (c) 2003-2012, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 */

#ifndef _MEI_HW_TYPES_H_
#define _MEI_HW_TYPES_H_

#include <linux/uuid.h>

/*
 * Timeouts in Seconds
 */
#define MEI_HW_READY_TIMEOUT        2  /* Timeout on ready message */
#define MEI_CONNECT_TIMEOUT         3  /* HPS: at least 2 seconds */

#define MEI_CL_CONNECT_TIMEOUT     15  /* HPS: Client Connect Timeout */
#define MEI_CLIENTS_INIT_TIMEOUT   15  /* HPS: Clients Enumeration Timeout */

#define MEI_IAMTHIF_STALL_TIMER    12  /* HPS */
#define MEI_IAMTHIF_READ_TIMER     10  /* HPS */

#define MEI_PGI_TIMEOUT             1  /* PG Isolation time response 1 sec */
#define MEI_D0I3_TIMEOUT            5  /* D0i3 set/unset max response time */
#define MEI_HBM_TIMEOUT             1  /* 1 second */

/*
 * MEI Version
 */
#define HBM_MINOR_VERSION                   0
#define HBM_MAJOR_VERSION                   2

/*
 * MEI version with PGI support
 */
#define HBM_MINOR_VERSION_PGI               1
#define HBM_MAJOR_VERSION_PGI               1

/*
 * MEI version with Dynamic clients support
 */
#define HBM_MINOR_VERSION_DC               0
#define HBM_MAJOR_VERSION_DC               2

/*
 * MEI version with disconnect on connection timeout support
 */
#define HBM_MINOR_VERSION_DOT              0
#define HBM_MAJOR_VERSION_DOT              2

/*
 * MEI version with notifcation support
 */
#define HBM_MINOR_VERSION_EV               0
#define HBM_MAJOR_VERSION_EV               2

/* Host bus message command opcode */
#define MEI_HBM_CMD_OP_MSK                  0x7f
/* Host bus message command RESPONSE */
#define MEI_HBM_CMD_RES_MSK                 0x80

/*
 * MEI Bus Message Command IDs
 */
#define HOST_START_REQ_CMD                  0x01
#define HOST_START_RES_CMD                  0x81

#define HOST_STOP_REQ_CMD                   0x02
#define HOST_STOP_RES_CMD                   0x82

#define ME_STOP_REQ_CMD                     0x03

#define HOST_ENUM_REQ_CMD                   0x04
#define HOST_ENUM_RES_CMD                   0x84

#define HOST_CLIENT_PROPERTIES_REQ_CMD      0x05
#define HOST_CLIENT_PROPERTIES_RES_CMD      0x85

#define CLIENT_CONNECT_REQ_CMD              0x06
#define CLIENT_CONNECT_RES_CMD              0x86

#define CLIENT_DISCONNECT_REQ_CMD           0x07
#define CLIENT_DISCONNECT_RES_CMD           0x87

#define MEI_FLOW_CONTROL_CMD                0x08

#define MEI_PG_ISOLATION_ENTRY_REQ_CMD      0x0a
#define MEI_PG_ISOLATION_ENTRY_RES_CMD      0x8a
#define MEI_PG_ISOLATION_EXIT_REQ_CMD       0x0b
#define MEI_PG_ISOLATION_EXIT_RES_CMD       0x8b

#define MEI_HBM_ADD_CLIENT_REQ_CMD          0x0f
#define MEI_HBM_ADD_CLIENT_RES_CMD          0x8f

#define MEI_HBM_NOTIFY_REQ_CMD              0x10
#define MEI_HBM_NOTIFY_RES_CMD              0x90
#define MEI_HBM_NOTIFICATION_CMD            0x11

/*
 * MEI Stop Reason
 * used by hbm_host_stop_request.reason
 */
enum mei_stop_reason_types {
	DRIVER_STOP_REQUEST = 0x00,
	DEVICE_D1_ENTRY = 0x01,
	DEVICE_D2_ENTRY = 0x02,
	DEVICE_D3_ENTRY = 0x03,
	SYSTEM_S1_ENTRY = 0x04,
	SYSTEM_S2_ENTRY = 0x05,
	SYSTEM_S3_ENTRY = 0x06,
	SYSTEM_S4_ENTRY = 0x07,
	SYSTEM_S5_ENTRY = 0x08
};


/**
 * enum mei_hbm_status  - mei host bus messages return values
 *
 * @MEI_HBMS_SUCCESS           : status success
 * @MEI_HBMS_CLIENT_NOT_FOUND  : client not found
 * @MEI_HBMS_ALREADY_EXISTS    : connection already established
 * @MEI_HBMS_REJECTED          : connection is rejected
 * @MEI_HBMS_INVALID_PARAMETER : invalid parameter
 * @MEI_HBMS_NOT_ALLOWED       : operation not allowed
 * @MEI_HBMS_ALREADY_STARTED   : system is already started
 * @MEI_HBMS_NOT_STARTED       : system not started
 *
 * @MEI_HBMS_MAX               : sentinel
 */
enum mei_hbm_status {
	MEI_HBMS_SUCCESS           = 0,
	MEI_HBMS_CLIENT_NOT_FOUND  = 1,
	MEI_HBMS_ALREADY_EXISTS    = 2,
	MEI_HBMS_REJECTED          = 3,
	MEI_HBMS_INVALID_PARAMETER = 4,
	MEI_HBMS_NOT_ALLOWED       = 5,
	MEI_HBMS_ALREADY_STARTED   = 6,
	MEI_HBMS_NOT_STARTED       = 7,

	MEI_HBMS_MAX
};


/*
 * Client Connect Status
 * used by hbm_client_connect_response.status
 */
enum mei_cl_connect_status {
	MEI_CL_CONN_SUCCESS          = MEI_HBMS_SUCCESS,
	MEI_CL_CONN_NOT_FOUND        = MEI_HBMS_CLIENT_NOT_FOUND,
	MEI_CL_CONN_ALREADY_STARTED  = MEI_HBMS_ALREADY_EXISTS,
	MEI_CL_CONN_OUT_OF_RESOURCES = MEI_HBMS_REJECTED,
	MEI_CL_CONN_MESSAGE_SMALL    = MEI_HBMS_INVALID_PARAMETER,
	MEI_CL_CONN_NOT_ALLOWED      = MEI_HBMS_NOT_ALLOWED,
};

/*
 * Client Disconnect Status
 */
enum  mei_cl_disconnect_status {
	MEI_CL_DISCONN_SUCCESS = MEI_HBMS_SUCCESS
};

/*
 *  MEI BUS Interface Section
 */
struct mei_msg_hdr {
	u32 me_addr:8;
	u32 host_addr:8;
	u32 length:9;
	u32 reserved:5;
	u32 internal:1;
	u32 msg_complete:1;
} __packed;


struct mei_bus_message {
	u8 hbm_cmd;
	u8 data[0];
} __packed;

/**
 * struct hbm_cl_cmd - client specific host bus command
 *	CONNECT, DISCONNECT, and FlOW CONTROL
 *
 * @hbm_cmd: bus message command header
 * @me_addr: address of the client in ME
 * @host_addr: address of the client in the driver
 * @data: generic data
 */
struct mei_hbm_cl_cmd {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 data;
};

struct hbm_version {
	u8 minor_version;
	u8 major_version;
} __packed;

struct hbm_host_version_request {
	u8 hbm_cmd;
	u8 reserved;
	struct hbm_version host_version;
} __packed;

struct hbm_host_version_response {
	u8 hbm_cmd;
	u8 host_version_supported;
	struct hbm_version me_max_version;
} __packed;

struct hbm_host_stop_request {
	u8 hbm_cmd;
	u8 reason;
	u8 reserved[2];
} __packed;

struct hbm_host_stop_response {
	u8 hbm_cmd;
	u8 reserved[3];
} __packed;

struct hbm_me_stop_request {
	u8 hbm_cmd;
	u8 reason;
	u8 reserved[2];
} __packed;

/**
 * struct hbm_host_enum_request -  enumeration request from host to fw
 *
 * @hbm_cmd: bus message command header
 * @allow_add: allow dynamic clients add HBM version >= 2.0
 * @reserved: reserved
 */
struct hbm_host_enum_request {
	u8 hbm_cmd;
	u8 allow_add;
	u8 reserved[2];
} __packed;

struct hbm_host_enum_response {
	u8 hbm_cmd;
	u8 reserved[3];
	u8 valid_addresses[32];
} __packed;

struct mei_client_properties {
	uuid_le protocol_name;
	u8 protocol_version;
	u8 max_number_of_connections;
	u8 fixed_address;
	u8 single_recv_buf;
	u32 max_msg_length;
} __packed;

struct hbm_props_request {
	u8 hbm_cmd;
	u8 me_addr;
	u8 reserved[2];
} __packed;

struct hbm_props_response {
	u8 hbm_cmd;
	u8 me_addr;
	u8 status;
	u8 reserved[1];
	struct mei_client_properties client_properties;
} __packed;

/**
 * struct hbm_add_client_request - request to add a client
 *     might be sent by fw after enumeration has already completed
 *
 * @hbm_cmd: bus message command header
 * @me_addr: address of the client in ME
 * @reserved: reserved
 * @client_properties: client properties
 */
struct hbm_add_client_request {
	u8 hbm_cmd;
	u8 me_addr;
	u8 reserved[2];
	struct mei_client_properties client_properties;
} __packed;

/**
 * struct hbm_add_client_response - response to add a client
 *     sent by the host to report client addition status to fw
 *
 * @hbm_cmd: bus message command header
 * @me_addr: address of the client in ME
 * @status: if HBMS_SUCCESS then the client can now accept connections.
 * @reserved: reserved
 */
struct hbm_add_client_response {
	u8 hbm_cmd;
	u8 me_addr;
	u8 status;
	u8 reserved[1];
} __packed;

/**
 * struct hbm_power_gate - power gate request/response
 *
 * @hbm_cmd: bus message command header
 * @reserved: reserved
 */
struct hbm_power_gate {
	u8 hbm_cmd;
	u8 reserved[3];
} __packed;

/**
 * struct hbm_client_connect_request - connect/disconnect request
 *
 * @hbm_cmd: bus message command header
 * @me_addr: address of the client in ME
 * @host_addr: address of the client in the driver
 * @reserved: reserved
 */
struct hbm_client_connect_request {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 reserved;
} __packed;

/**
 * struct hbm_client_connect_response - connect/disconnect response
 *
 * @hbm_cmd: bus message command header
 * @me_addr: address of the client in ME
 * @host_addr: address of the client in the driver
 * @status: status of the request
 */
struct hbm_client_connect_response {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 status;
} __packed;


#define MEI_FC_MESSAGE_RESERVED_LENGTH           5

struct hbm_flow_control {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
} __packed;

#define MEI_HBM_NOTIFICATION_START 1
#define MEI_HBM_NOTIFICATION_STOP  0
/**
 * struct hbm_notification_request - start/stop notification request
 *
 * @hbm_cmd: bus message command header
 * @me_addr: address of the client in ME
 * @host_addr: address of the client in the driver
 * @start:  start = 1 or stop = 0 asynchronous notifications
 */
struct hbm_notification_request {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 start;
} __packed;

/**
 * struct hbm_notification_response - start/stop notification response
 *
 * @hbm_cmd: bus message command header
 * @me_addr: address of the client in ME
 * @host_addr: - address of the client in the driver
 * @status: (mei_hbm_status) response status for the request
 *  - MEI_HBMS_SUCCESS: successful stop/start
 *  - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
 *  - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
 *                         started notification.
 *  - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
 *                         asynchronous notifications are currently disabled.
 *
 * @start:  start = 1 or stop = 0 asynchronous notifications
 * @reserved: reserved
 */
struct hbm_notification_response {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 status;
	u8 start;
	u8 reserved[3];
} __packed;

/**
 * struct hbm_notification - notification event
 *
 * @hbm_cmd: bus message command header
 * @me_addr:  address of the client in ME
 * @host_addr:  address of the client in the driver
 * @reserved: reserved for alignment
 */
struct hbm_notification {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 reserved[1];
} __packed;

#endif
Commit	Line	Data
5a6003f2 OW	1	/*
	2	*
	3	* Intel Management Engine Interface (Intel MEI) Linux driver
733ba91c	4	* Copyright (c) 2003-2012, Intel Corporation.
5a6003f2 OW	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_HW_TYPES_H_
	18	#define _MEI_HW_TYPES_H_
	19
	20	#include <linux/uuid.h>
	21
	22	/*
3870c320	23	* Timeouts in Seconds
5a6003f2	24	*/
7d93e58d	25	#define MEI_HW_READY_TIMEOUT 2 /* Timeout on ready message */
3870c320	26	#define MEI_CONNECT_TIMEOUT 3 /* HPS: at least 2 seconds */
5a6003f2	27
3870c320 TW	28	#define MEI_CL_CONNECT_TIMEOUT 15 /* HPS: Client Connect Timeout */
3870c320 TW	29	#define MEI_CLIENTS_INIT_TIMEOUT 15 /* HPS: Clients Enumeration Timeout */
5a6003f2	30
3870c320 TW	31	#define MEI_IAMTHIF_STALL_TIMER 12 /* HPS */
3870c320 TW	32	#define MEI_IAMTHIF_READ_TIMER 10 /* HPS */
5a6003f2	33
859ef2ff AU	34	#define MEI_PGI_TIMEOUT 1 /* PG Isolation time response 1 sec */
	35	#define MEI_D0I3_TIMEOUT 5 /* D0i3 set/unset max response time */
	36	#define MEI_HBM_TIMEOUT 1 /* 1 second */
5a6003f2 OW	37
	38	/*
	39	* MEI Version
	40	*/
155718cf TW	41	#define HBM_MINOR_VERSION 0
155718cf TW	42	#define HBM_MAJOR_VERSION 2
5a6003f2	43
ee7e5afd TW	44	/*
	45	* MEI version with PGI support
	46	*/
	47	#define HBM_MINOR_VERSION_PGI 1
	48	#define HBM_MAJOR_VERSION_PGI 1
	49
70ef835c TW	50	/*
	51	* MEI version with Dynamic clients support
	52	*/
	53	#define HBM_MINOR_VERSION_DC 0
	54	#define HBM_MAJOR_VERSION_DC 2
	55
18901357 AU	56	/*
	57	* MEI version with disconnect on connection timeout support
	58	*/
	59	#define HBM_MINOR_VERSION_DOT 0
	60	#define HBM_MAJOR_VERSION_DOT 2
	61
4d99877d TW	62	/*
	63	* MEI version with notifcation support
	64	*/
	65	#define HBM_MINOR_VERSION_EV 0
	66	#define HBM_MAJOR_VERSION_EV 2
	67
1ca7e782 TW	68	/* Host bus message command opcode */
	69	#define MEI_HBM_CMD_OP_MSK 0x7f
	70	/* Host bus message command RESPONSE */
	71	#define MEI_HBM_CMD_RES_MSK 0x80
	72
5a6003f2 OW	73	/*
	74	* MEI Bus Message Command IDs
	75	*/
	76	#define HOST_START_REQ_CMD 0x01
	77	#define HOST_START_RES_CMD 0x81
	78
	79	#define HOST_STOP_REQ_CMD 0x02
	80	#define HOST_STOP_RES_CMD 0x82
	81
	82	#define ME_STOP_REQ_CMD 0x03
	83
	84	#define HOST_ENUM_REQ_CMD 0x04
	85	#define HOST_ENUM_RES_CMD 0x84
	86
	87	#define HOST_CLIENT_PROPERTIES_REQ_CMD 0x05
	88	#define HOST_CLIENT_PROPERTIES_RES_CMD 0x85
	89
	90	#define CLIENT_CONNECT_REQ_CMD 0x06
	91	#define CLIENT_CONNECT_RES_CMD 0x86
	92
	93	#define CLIENT_DISCONNECT_REQ_CMD 0x07
	94	#define CLIENT_DISCONNECT_RES_CMD 0x87
	95
1ca7e782	96	#define MEI_FLOW_CONTROL_CMD 0x08
5a6003f2	97
4fcbc99b TW	98	#define MEI_PG_ISOLATION_ENTRY_REQ_CMD 0x0a
	99	#define MEI_PG_ISOLATION_ENTRY_RES_CMD 0x8a
	100	#define MEI_PG_ISOLATION_EXIT_REQ_CMD 0x0b
	101	#define MEI_PG_ISOLATION_EXIT_RES_CMD 0x8b
	102
70ef835c TW	103	#define MEI_HBM_ADD_CLIENT_REQ_CMD 0x0f
70ef835c TW	104	#define MEI_HBM_ADD_CLIENT_RES_CMD 0x8f
d3c1c809 TW	105
	106	#define MEI_HBM_NOTIFY_REQ_CMD 0x10
	107	#define MEI_HBM_NOTIFY_RES_CMD 0x90
	108	#define MEI_HBM_NOTIFICATION_CMD 0x11
	109
5a6003f2 OW	110	/*
	111	* MEI Stop Reason
	112	* used by hbm_host_stop_request.reason
	113	*/
	114	enum mei_stop_reason_types {
	115	DRIVER_STOP_REQUEST = 0x00,
	116	DEVICE_D1_ENTRY = 0x01,
	117	DEVICE_D2_ENTRY = 0x02,
	118	DEVICE_D3_ENTRY = 0x03,
	119	SYSTEM_S1_ENTRY = 0x04,
	120	SYSTEM_S2_ENTRY = 0x05,
	121	SYSTEM_S3_ENTRY = 0x06,
	122	SYSTEM_S4_ENTRY = 0x07,
	123	SYSTEM_S5_ENTRY = 0x08
	124	};
	125
89778d6e TW	126
89778d6e TW	127	/**
a8605ea2	128	* enum mei_hbm_status - mei host bus messages return values
89778d6e	129	*
a8605ea2 AU	130	* @MEI_HBMS_SUCCESS : status success
	131	* @MEI_HBMS_CLIENT_NOT_FOUND : client not found
	132	* @MEI_HBMS_ALREADY_EXISTS : connection already established
	133	* @MEI_HBMS_REJECTED : connection is rejected
	134	* @MEI_HBMS_INVALID_PARAMETER : invalid parameter
	135	* @MEI_HBMS_NOT_ALLOWED : operation not allowed
	136	* @MEI_HBMS_ALREADY_STARTED : system is already started
	137	* @MEI_HBMS_NOT_STARTED : system not started
ce23139c AU	138	*
ce23139c AU	139	* @MEI_HBMS_MAX : sentinel
89778d6e TW	140	*/
	141	enum mei_hbm_status {
	142	MEI_HBMS_SUCCESS = 0,
	143	MEI_HBMS_CLIENT_NOT_FOUND = 1,
	144	MEI_HBMS_ALREADY_EXISTS = 2,
	145	MEI_HBMS_REJECTED = 3,
	146	MEI_HBMS_INVALID_PARAMETER = 4,
	147	MEI_HBMS_NOT_ALLOWED = 5,
	148	MEI_HBMS_ALREADY_STARTED = 6,
	149	MEI_HBMS_NOT_STARTED = 7,
	150
	151	MEI_HBMS_MAX
	152	};
	153
	154
5a6003f2 OW	155	/*
	156	* Client Connect Status
	157	* used by hbm_client_connect_response.status
	158	*/
285e2996	159	enum mei_cl_connect_status {
89778d6e TW	160	MEI_CL_CONN_SUCCESS = MEI_HBMS_SUCCESS,
	161	MEI_CL_CONN_NOT_FOUND = MEI_HBMS_CLIENT_NOT_FOUND,
	162	MEI_CL_CONN_ALREADY_STARTED = MEI_HBMS_ALREADY_EXISTS,
	163	MEI_CL_CONN_OUT_OF_RESOURCES = MEI_HBMS_REJECTED,
	164	MEI_CL_CONN_MESSAGE_SMALL = MEI_HBMS_INVALID_PARAMETER,
71e117f2	165	MEI_CL_CONN_NOT_ALLOWED = MEI_HBMS_NOT_ALLOWED,
5a6003f2 OW	166	};
	167
	168	/*
	169	* Client Disconnect Status
	170	*/
285e2996	171	enum mei_cl_disconnect_status {
89778d6e	172	MEI_CL_DISCONN_SUCCESS = MEI_HBMS_SUCCESS
5a6003f2 OW	173	};
	174
	175	/*
	176	* MEI BUS Interface Section
	177	*/
	178	struct mei_msg_hdr {
	179	u32 me_addr:8;
	180	u32 host_addr:8;
	181	u32 length:9;
479327fc TW	182	u32 reserved:5;
479327fc TW	183	u32 internal:1;
5a6003f2 OW	184	u32 msg_complete:1;
	185	} __packed;
	186
	187
5a6003f2	188	struct mei_bus_message {
1ca7e782 TW	189	u8 hbm_cmd;
1ca7e782 TW	190	u8 data[0];
5a6003f2 OW	191	} __packed;
5a6003f2 OW	192
cd51ed64 TW	193	/**
	194	* struct hbm_cl_cmd - client specific host bus command
	195	* CONNECT, DISCONNECT, and FlOW CONTROL
	196	*
a8605ea2 AU	197	* @hbm_cmd: bus message command header
	198	* @me_addr: address of the client in ME
	199	* @host_addr: address of the client in the driver
	200	* @data: generic data
cd51ed64 TW	201	*/
	202	struct mei_hbm_cl_cmd {
	203	u8 hbm_cmd;
	204	u8 me_addr;
	205	u8 host_addr;
	206	u8 data;
	207	};
	208
5a6003f2 OW	209	struct hbm_version {
	210	u8 minor_version;
	211	u8 major_version;
	212	} __packed;
	213
	214	struct hbm_host_version_request {
1ca7e782	215	u8 hbm_cmd;
5a6003f2 OW	216	u8 reserved;
	217	struct hbm_version host_version;
	218	} __packed;
	219
	220	struct hbm_host_version_response {
1ca7e782	221	u8 hbm_cmd;
4b00706c	222	u8 host_version_supported;
5a6003f2 OW	223	struct hbm_version me_max_version;
	224	} __packed;
	225
	226	struct hbm_host_stop_request {
1ca7e782	227	u8 hbm_cmd;
5a6003f2 OW	228	u8 reason;
	229	u8 reserved[2];
	230	} __packed;
	231
	232	struct hbm_host_stop_response {
1ca7e782	233	u8 hbm_cmd;
5a6003f2 OW	234	u8 reserved[3];
	235	} __packed;
	236
	237	struct hbm_me_stop_request {
1ca7e782	238	u8 hbm_cmd;
5a6003f2 OW	239	u8 reason;
	240	u8 reserved[2];
	241	} __packed;
	242
70ef835c TW	243	/**
	244	* struct hbm_host_enum_request - enumeration request from host to fw
	245	*
	246	* @hbm_cmd: bus message command header
	247	* @allow_add: allow dynamic clients add HBM version >= 2.0
	248	* @reserved: reserved
	249	*/
5a6003f2	250	struct hbm_host_enum_request {
1ca7e782	251	u8 hbm_cmd;
70ef835c TW	252	u8 allow_add;
70ef835c TW	253	u8 reserved[2];
5a6003f2 OW	254	} __packed;
	255
	256	struct hbm_host_enum_response {
1ca7e782	257	u8 hbm_cmd;
5a6003f2 OW	258	u8 reserved[3];
	259	u8 valid_addresses[32];
	260	} __packed;
	261
	262	struct mei_client_properties {
	263	uuid_le protocol_name;
	264	u8 protocol_version;
	265	u8 max_number_of_connections;
	266	u8 fixed_address;
	267	u8 single_recv_buf;
	268	u32 max_msg_length;
	269	} __packed;
	270
	271	struct hbm_props_request {
1ca7e782	272	u8 hbm_cmd;
3438c1f3	273	u8 me_addr;
5a6003f2 OW	274	u8 reserved[2];
	275	} __packed;
	276
5a6003f2	277	struct hbm_props_response {
1ca7e782	278	u8 hbm_cmd;
3438c1f3	279	u8 me_addr;
5a6003f2 OW	280	u8 status;
	281	u8 reserved[1];
	282	struct mei_client_properties client_properties;
	283	} __packed;
	284
70ef835c TW	285	/**
	286	* struct hbm_add_client_request - request to add a client
	287	* might be sent by fw after enumeration has already completed
	288	*
	289	* @hbm_cmd: bus message command header
	290	* @me_addr: address of the client in ME
	291	* @reserved: reserved
	292	* @client_properties: client properties
	293	*/
	294	struct hbm_add_client_request {
	295	u8 hbm_cmd;
	296	u8 me_addr;
	297	u8 reserved[2];
	298	struct mei_client_properties client_properties;
	299	} __packed;
	300
	301	/**
	302	* struct hbm_add_client_response - response to add a client
	303	* sent by the host to report client addition status to fw
	304	*
	305	* @hbm_cmd: bus message command header
	306	* @me_addr: address of the client in ME
	307	* @status: if HBMS_SUCCESS then the client can now accept connections.
	308	* @reserved: reserved
	309	*/
	310	struct hbm_add_client_response {
	311	u8 hbm_cmd;
	312	u8 me_addr;
	313	u8 status;
	314	u8 reserved[1];
	315	} __packed;
	316
4fcbc99b TW	317	/**
	318	* struct hbm_power_gate - power gate request/response
	319	*
a8605ea2 AU	320	* @hbm_cmd: bus message command header
a8605ea2 AU	321	* @reserved: reserved
4fcbc99b TW	322	*/
	323	struct hbm_power_gate {
	324	u8 hbm_cmd;
	325	u8 reserved[3];
	326	} __packed;
	327
aeba4a06 TW	328	/**
	329	* struct hbm_client_connect_request - connect/disconnect request
	330	*
a8605ea2 AU	331	* @hbm_cmd: bus message command header
	332	* @me_addr: address of the client in ME
	333	* @host_addr: address of the client in the driver
	334	* @reserved: reserved
aeba4a06	335	*/
5a6003f2	336	struct hbm_client_connect_request {
1ca7e782	337	u8 hbm_cmd;
5a6003f2 OW	338	u8 me_addr;
	339	u8 host_addr;
	340	u8 reserved;
	341	} __packed;
	342
aeba4a06 TW	343	/**
	344	* struct hbm_client_connect_response - connect/disconnect response
	345	*
a8605ea2 AU	346	* @hbm_cmd: bus message command header
	347	* @me_addr: address of the client in ME
	348	* @host_addr: address of the client in the driver
	349	* @status: status of the request
aeba4a06	350	*/
5a6003f2	351	struct hbm_client_connect_response {
1ca7e782	352	u8 hbm_cmd;
5a6003f2 OW	353	u8 me_addr;
	354	u8 host_addr;
	355	u8 status;
	356	} __packed;
	357
5a6003f2 OW	358
	359	#define MEI_FC_MESSAGE_RESERVED_LENGTH 5
	360
	361	struct hbm_flow_control {
1ca7e782	362	u8 hbm_cmd;
5a6003f2 OW	363	u8 me_addr;
	364	u8 host_addr;
	365	u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
	366	} __packed;
	367
d3c1c809 TW	368	#define MEI_HBM_NOTIFICATION_START 1
	369	#define MEI_HBM_NOTIFICATION_STOP 0
	370	/**
	371	* struct hbm_notification_request - start/stop notification request
	372	*
	373	* @hbm_cmd: bus message command header
	374	* @me_addr: address of the client in ME
	375	* @host_addr: address of the client in the driver
	376	* @start: start = 1 or stop = 0 asynchronous notifications
	377	*/
	378	struct hbm_notification_request {
	379	u8 hbm_cmd;
	380	u8 me_addr;
	381	u8 host_addr;
	382	u8 start;
	383	} __packed;
	384
	385	/**
	386	* struct hbm_notification_response - start/stop notification response
	387	*
	388	* @hbm_cmd: bus message command header
	389	* @me_addr: address of the client in ME
	390	* @host_addr: - address of the client in the driver
	391	* @status: (mei_hbm_status) response status for the request
	392	* - MEI_HBMS_SUCCESS: successful stop/start
	393	* - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
	394	* - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
	395	* started notification.
	396	* - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
	397	* asynchronous notifications are currently disabled.
	398	*
	399	* @start: start = 1 or stop = 0 asynchronous notifications
	400	* @reserved: reserved
	401	*/
	402	struct hbm_notification_response {
	403	u8 hbm_cmd;
	404	u8 me_addr;
	405	u8 host_addr;
	406	u8 status;
	407	u8 start;
	408	u8 reserved[3];
	409	} __packed;
	410
	411	/**
	412	* struct hbm_notification - notification event
	413	*
	414	* @hbm_cmd: bus message command header
	415	* @me_addr: address of the client in ME
	416	* @host_addr: address of the client in the driver
	417	* @reserved: reserved for alignment
	418	*/
	419	struct hbm_notification {
	420	u8 hbm_cmd;
	421	u8 me_addr;
	422	u8 host_addr;
	423	u8 reserved[1];
	424	} __packed;
5a6003f2 OW	425
5a6003f2 OW	426	#endif