hw.h 5.3 KB
Newer Older
1 2 3
/*
 *
 * Intel Management Engine Interface (Intel MEI) Linux driver
4
 * Copyright (c) 2003-2012, Intel Corporation.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * 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>

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

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

31 32
#define MEI_IAMTHIF_STALL_TIMER    12  /* HPS */
#define MEI_IAMTHIF_READ_TIMER     10  /* HPS */
33

34
#define MEI_HBM_TIMEOUT            1   /* 1 second */
35 36 37 38 39 40 41

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

42 43 44 45 46
/* Host bus message command opcode */
#define MEI_HBM_CMD_OP_MSK                  0x7f
/* Host bus message command RESPONSE */
#define MEI_HBM_CMD_RES_MSK                 0x80

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/*
 * 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

70
#define MEI_FLOW_CONTROL_CMD                0x08
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91

/*
 * 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
};

/*
 * Client Connect Status
 * used by hbm_client_connect_response.status
 */
92 93 94 95 96 97
enum mei_cl_connect_status {
	MEI_CL_CONN_SUCCESS          = 0x00,
	MEI_CL_CONN_NOT_FOUND        = 0x01,
	MEI_CL_CONN_ALREADY_STARTED  = 0x02,
	MEI_CL_CONN_OUT_OF_RESOURCES = 0x03,
	MEI_CL_CONN_MESSAGE_SMALL    = 0x04
98 99 100 101 102
};

/*
 * Client Disconnect Status
 */
103 104
enum  mei_cl_disconnect_status {
	MEI_CL_DISCONN_SUCCESS = 0x00
105 106 107 108 109 110 111 112 113
};

/*
 *  MEI BUS Interface Section
 */
struct mei_msg_hdr {
	u32 me_addr:8;
	u32 host_addr:8;
	u32 length:9;
114 115
	u32 reserved:5;
	u32 internal:1;
116 117 118 119 120
	u32 msg_complete:1;
} __packed;


struct mei_bus_message {
121 122
	u8 hbm_cmd;
	u8 data[0];
123 124
} __packed;

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
/**
 * 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
 */
struct mei_hbm_cl_cmd {
	u8 hbm_cmd;
	u8 me_addr;
	u8 host_addr;
	u8 data;
};

141 142 143 144 145 146
struct hbm_version {
	u8 minor_version;
	u8 major_version;
} __packed;

struct hbm_host_version_request {
147
	u8 hbm_cmd;
148 149 150 151 152
	u8 reserved;
	struct hbm_version host_version;
} __packed;

struct hbm_host_version_response {
153
	u8 hbm_cmd;
154
	u8 host_version_supported;
155 156 157 158
	struct hbm_version me_max_version;
} __packed;

struct hbm_host_stop_request {
159
	u8 hbm_cmd;
160 161 162 163 164
	u8 reason;
	u8 reserved[2];
} __packed;

struct hbm_host_stop_response {
165
	u8 hbm_cmd;
166 167 168 169
	u8 reserved[3];
} __packed;

struct hbm_me_stop_request {
170
	u8 hbm_cmd;
171 172 173 174 175
	u8 reason;
	u8 reserved[2];
} __packed;

struct hbm_host_enum_request {
176
	u8 hbm_cmd;
177 178 179 180
	u8 reserved[3];
} __packed;

struct hbm_host_enum_response {
181
	u8 hbm_cmd;
182 183 184 185 186 187 188 189 190 191 192 193 194 195
	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 {
196
	u8 hbm_cmd;
197 198 199 200 201 202
	u8 address;
	u8 reserved[2];
} __packed;


struct hbm_props_response {
203
	u8 hbm_cmd;
204 205 206 207 208 209
	u8 address;
	u8 status;
	u8 reserved[1];
	struct mei_client_properties client_properties;
} __packed;

210 211 212 213 214 215 216 217
/**
 * 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
 */
218
struct hbm_client_connect_request {
219
	u8 hbm_cmd;
220 221 222 223 224
	u8 me_addr;
	u8 host_addr;
	u8 reserved;
} __packed;

225 226 227 228 229 230 231 232
/**
 * 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
 */
233
struct hbm_client_connect_response {
234
	u8 hbm_cmd;
235 236 237 238 239 240 241 242 243
	u8 me_addr;
	u8 host_addr;
	u8 status;
} __packed;


#define MEI_FC_MESSAGE_RESERVED_LENGTH           5

struct hbm_flow_control {
244
	u8 hbm_cmd;
245 246 247 248 249 250 251
	u8 me_addr;
	u8 host_addr;
	u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
} __packed;


#endif