1 /* 2 * 3 * Intel Management Engine Interface (Intel MEI) Linux driver 4 * Copyright (c) 2003-2012, Intel Corporation. 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 /* 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 #define MEI_CL_CONNECT_TIMEOUT 15 /* HPS: Client Connect Timeout */ 29 #define MEI_CLIENTS_INIT_TIMEOUT 15 /* HPS: Clients Enumeration Timeout */ 30 31 #define MEI_IAMTHIF_STALL_TIMER 12 /* HPS */ 32 #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 * MEI Version 39 */ 40 #define HBM_MINOR_VERSION 1 41 #define HBM_MAJOR_VERSION 1 42 43 /* 44 * MEI version with PGI support 45 */ 46 #define HBM_MINOR_VERSION_PGI 1 47 #define HBM_MAJOR_VERSION_PGI 1 48 49 /* Host bus message command opcode */ 50 #define MEI_HBM_CMD_OP_MSK 0x7f 51 /* Host bus message command RESPONSE */ 52 #define MEI_HBM_CMD_RES_MSK 0x80 53 54 /* 55 * MEI Bus Message Command IDs 56 */ 57 #define HOST_START_REQ_CMD 0x01 58 #define HOST_START_RES_CMD 0x81 59 60 #define HOST_STOP_REQ_CMD 0x02 61 #define HOST_STOP_RES_CMD 0x82 62 63 #define ME_STOP_REQ_CMD 0x03 64 65 #define HOST_ENUM_REQ_CMD 0x04 66 #define HOST_ENUM_RES_CMD 0x84 67 68 #define HOST_CLIENT_PROPERTIES_REQ_CMD 0x05 69 #define HOST_CLIENT_PROPERTIES_RES_CMD 0x85 70 71 #define CLIENT_CONNECT_REQ_CMD 0x06 72 #define CLIENT_CONNECT_RES_CMD 0x86 73 74 #define CLIENT_DISCONNECT_REQ_CMD 0x07 75 #define CLIENT_DISCONNECT_RES_CMD 0x87 76 77 #define MEI_FLOW_CONTROL_CMD 0x08 78 79 #define MEI_PG_ISOLATION_ENTRY_REQ_CMD 0x0a 80 #define MEI_PG_ISOLATION_ENTRY_RES_CMD 0x8a 81 #define MEI_PG_ISOLATION_EXIT_REQ_CMD 0x0b 82 #define MEI_PG_ISOLATION_EXIT_RES_CMD 0x8b 83 84 /* 85 * MEI Stop Reason 86 * used by hbm_host_stop_request.reason 87 */ 88 enum mei_stop_reason_types { 89 DRIVER_STOP_REQUEST = 0x00, 90 DEVICE_D1_ENTRY = 0x01, 91 DEVICE_D2_ENTRY = 0x02, 92 DEVICE_D3_ENTRY = 0x03, 93 SYSTEM_S1_ENTRY = 0x04, 94 SYSTEM_S2_ENTRY = 0x05, 95 SYSTEM_S3_ENTRY = 0x06, 96 SYSTEM_S4_ENTRY = 0x07, 97 SYSTEM_S5_ENTRY = 0x08 98 }; 99 100 /* 101 * Client Connect Status 102 * used by hbm_client_connect_response.status 103 */ 104 enum mei_cl_connect_status { 105 MEI_CL_CONN_SUCCESS = 0x00, 106 MEI_CL_CONN_NOT_FOUND = 0x01, 107 MEI_CL_CONN_ALREADY_STARTED = 0x02, 108 MEI_CL_CONN_OUT_OF_RESOURCES = 0x03, 109 MEI_CL_CONN_MESSAGE_SMALL = 0x04 110 }; 111 112 /* 113 * Client Disconnect Status 114 */ 115 enum mei_cl_disconnect_status { 116 MEI_CL_DISCONN_SUCCESS = 0x00 117 }; 118 119 /* 120 * MEI BUS Interface Section 121 */ 122 struct mei_msg_hdr { 123 u32 me_addr:8; 124 u32 host_addr:8; 125 u32 length:9; 126 u32 reserved:5; 127 u32 internal:1; 128 u32 msg_complete:1; 129 } __packed; 130 131 132 struct mei_bus_message { 133 u8 hbm_cmd; 134 u8 data[0]; 135 } __packed; 136 137 /** 138 * struct hbm_cl_cmd - client specific host bus command 139 * CONNECT, DISCONNECT, and FlOW CONTROL 140 * 141 * @hbm_cmd - bus message command header 142 * @me_addr - address of the client in ME 143 * @host_addr - address of the client in the driver 144 * @data 145 */ 146 struct mei_hbm_cl_cmd { 147 u8 hbm_cmd; 148 u8 me_addr; 149 u8 host_addr; 150 u8 data; 151 }; 152 153 struct hbm_version { 154 u8 minor_version; 155 u8 major_version; 156 } __packed; 157 158 struct hbm_host_version_request { 159 u8 hbm_cmd; 160 u8 reserved; 161 struct hbm_version host_version; 162 } __packed; 163 164 struct hbm_host_version_response { 165 u8 hbm_cmd; 166 u8 host_version_supported; 167 struct hbm_version me_max_version; 168 } __packed; 169 170 struct hbm_host_stop_request { 171 u8 hbm_cmd; 172 u8 reason; 173 u8 reserved[2]; 174 } __packed; 175 176 struct hbm_host_stop_response { 177 u8 hbm_cmd; 178 u8 reserved[3]; 179 } __packed; 180 181 struct hbm_me_stop_request { 182 u8 hbm_cmd; 183 u8 reason; 184 u8 reserved[2]; 185 } __packed; 186 187 struct hbm_host_enum_request { 188 u8 hbm_cmd; 189 u8 reserved[3]; 190 } __packed; 191 192 struct hbm_host_enum_response { 193 u8 hbm_cmd; 194 u8 reserved[3]; 195 u8 valid_addresses[32]; 196 } __packed; 197 198 struct mei_client_properties { 199 uuid_le protocol_name; 200 u8 protocol_version; 201 u8 max_number_of_connections; 202 u8 fixed_address; 203 u8 single_recv_buf; 204 u32 max_msg_length; 205 } __packed; 206 207 struct hbm_props_request { 208 u8 hbm_cmd; 209 u8 address; 210 u8 reserved[2]; 211 } __packed; 212 213 214 struct hbm_props_response { 215 u8 hbm_cmd; 216 u8 address; 217 u8 status; 218 u8 reserved[1]; 219 struct mei_client_properties client_properties; 220 } __packed; 221 222 /** 223 * struct hbm_power_gate - power gate request/response 224 * 225 * @hbm_cmd - bus message command header 226 * @reserved[3] 227 */ 228 struct hbm_power_gate { 229 u8 hbm_cmd; 230 u8 reserved[3]; 231 } __packed; 232 233 /** 234 * struct hbm_client_connect_request - connect/disconnect request 235 * 236 * @hbm_cmd - bus message command header 237 * @me_addr - address of the client in ME 238 * @host_addr - address of the client in the driver 239 * @reserved 240 */ 241 struct hbm_client_connect_request { 242 u8 hbm_cmd; 243 u8 me_addr; 244 u8 host_addr; 245 u8 reserved; 246 } __packed; 247 248 /** 249 * struct hbm_client_connect_response - connect/disconnect response 250 * 251 * @hbm_cmd - bus message command header 252 * @me_addr - address of the client in ME 253 * @host_addr - address of the client in the driver 254 * @status - status of the request 255 */ 256 struct hbm_client_connect_response { 257 u8 hbm_cmd; 258 u8 me_addr; 259 u8 host_addr; 260 u8 status; 261 } __packed; 262 263 264 #define MEI_FC_MESSAGE_RESERVED_LENGTH 5 265 266 struct hbm_flow_control { 267 u8 hbm_cmd; 268 u8 me_addr; 269 u8 host_addr; 270 u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH]; 271 } __packed; 272 273 274 #endif 275