hw.h 5.9 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_PGI_TIMEOUT            1  /* PG Isolation time response 1 sec */
35
#define MEI_HBM_TIMEOUT            1   /* 1 second */
36 37 38 39

/*
 * MEI Version
 */
40
#define HBM_MINOR_VERSION                   1
41 42
#define HBM_MAJOR_VERSION                   1

43 44 45 46 47 48
/*
 * MEI version with PGI support
 */
#define HBM_MINOR_VERSION_PGI               1
#define HBM_MAJOR_VERSION_PGI               1

49 50 51 52 53
/* Host bus message command opcode */
#define MEI_HBM_CMD_OP_MSK                  0x7f
/* Host bus message command RESPONSE */
#define MEI_HBM_CMD_RES_MSK                 0x80

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
/*
 * 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

77
#define MEI_FLOW_CONTROL_CMD                0x08
78

79 80 81 82 83
#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

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
/*
 * 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
 */
104 105 106 107 108 109
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
110 111 112 113 114
};

/*
 * Client Disconnect Status
 */
115 116
enum  mei_cl_disconnect_status {
	MEI_CL_DISCONN_SUCCESS = 0x00
117 118 119 120 121 122 123 124 125
};

/*
 *  MEI BUS Interface Section
 */
struct mei_msg_hdr {
	u32 me_addr:8;
	u32 host_addr:8;
	u32 length:9;
126 127
	u32 reserved:5;
	u32 internal:1;
128 129 130 131 132
	u32 msg_complete:1;
} __packed;


struct mei_bus_message {
133 134
	u8 hbm_cmd;
	u8 data[0];
135 136
} __packed;

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
/**
 * 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;
};

153 154 155 156 157 158
struct hbm_version {
	u8 minor_version;
	u8 major_version;
} __packed;

struct hbm_host_version_request {
159
	u8 hbm_cmd;
160 161 162 163 164
	u8 reserved;
	struct hbm_version host_version;
} __packed;

struct hbm_host_version_response {
165
	u8 hbm_cmd;
166
	u8 host_version_supported;
167 168 169 170
	struct hbm_version me_max_version;
} __packed;

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

struct hbm_host_stop_response {
177
	u8 hbm_cmd;
178 179 180 181
	u8 reserved[3];
} __packed;

struct hbm_me_stop_request {
182
	u8 hbm_cmd;
183 184 185 186 187
	u8 reason;
	u8 reserved[2];
} __packed;

struct hbm_host_enum_request {
188
	u8 hbm_cmd;
189 190 191 192
	u8 reserved[3];
} __packed;

struct hbm_host_enum_response {
193
	u8 hbm_cmd;
194 195 196 197 198 199 200 201 202 203 204 205 206 207
	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 {
208
	u8 hbm_cmd;
209 210 211 212 213 214
	u8 address;
	u8 reserved[2];
} __packed;


struct hbm_props_response {
215
	u8 hbm_cmd;
216 217 218 219 220 221
	u8 address;
	u8 status;
	u8 reserved[1];
	struct mei_client_properties client_properties;
} __packed;

222 223 224 225 226 227 228 229 230 231 232
/**
 * struct hbm_power_gate - power gate request/response
 *
 * @hbm_cmd - bus message command header
 * @reserved[3]
 */
struct hbm_power_gate {
	u8 hbm_cmd;
	u8 reserved[3];
} __packed;

233 234 235 236 237 238 239 240
/**
 * 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
 */
241
struct hbm_client_connect_request {
242
	u8 hbm_cmd;
243 244 245 246 247
	u8 me_addr;
	u8 host_addr;
	u8 reserved;
} __packed;

248 249 250 251 252 253 254 255
/**
 * 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
 */
256
struct hbm_client_connect_response {
257
	u8 hbm_cmd;
258 259 260 261 262 263 264 265 266
	u8 me_addr;
	u8 host_addr;
	u8 status;
} __packed;


#define MEI_FC_MESSAGE_RESERVED_LENGTH           5

struct hbm_flow_control {
267
	u8 hbm_cmd;
268 269 270 271 272 273 274
	u8 me_addr;
	u8 host_addr;
	u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
} __packed;


#endif