3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
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.
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
17 #ifndef _MEI_HW_TYPES_H_
18 #define _MEI_HW_TYPES_H_
20 #include <linux/uuid.h>
25 #define MEI_HW_READY_TIMEOUT 2 /* Timeout on ready message */
26 #define MEI_CONNECT_TIMEOUT 3 /* HPS: at least 2 seconds */
28 #define MEI_CL_CONNECT_TIMEOUT 15 /* HPS: Client Connect Timeout */
29 #define MEI_CLIENTS_INIT_TIMEOUT 15 /* HPS: Clients Enumeration Timeout */
31 #define MEI_PGI_TIMEOUT 1 /* PG Isolation time response 1 sec */
32 #define MEI_D0I3_TIMEOUT 5 /* D0i3 set/unset max response time */
33 #define MEI_HBM_TIMEOUT 1 /* 1 second */
38 #define HBM_MINOR_VERSION 1
39 #define HBM_MAJOR_VERSION 2
42 * MEI version with PGI support
44 #define HBM_MINOR_VERSION_PGI 1
45 #define HBM_MAJOR_VERSION_PGI 1
48 * MEI version with Dynamic clients support
50 #define HBM_MINOR_VERSION_DC 0
51 #define HBM_MAJOR_VERSION_DC 2
54 * MEI version with immediate reply to enum request support
56 #define HBM_MINOR_VERSION_IE 0
57 #define HBM_MAJOR_VERSION_IE 2
60 * MEI version with disconnect on connection timeout support
62 #define HBM_MINOR_VERSION_DOT 0
63 #define HBM_MAJOR_VERSION_DOT 2
66 * MEI version with notification support
68 #define HBM_MINOR_VERSION_EV 0
69 #define HBM_MAJOR_VERSION_EV 2
72 * MEI version with fixed address client support
74 #define HBM_MINOR_VERSION_FA 0
75 #define HBM_MAJOR_VERSION_FA 2
78 * MEI version with OS ver message support
80 #define HBM_MINOR_VERSION_OS 0
81 #define HBM_MAJOR_VERSION_OS 2
84 * MEI version with dma ring support
86 #define HBM_MINOR_VERSION_DR 1
87 #define HBM_MAJOR_VERSION_DR 2
89 /* Host bus message command opcode */
90 #define MEI_HBM_CMD_OP_MSK 0x7f
91 /* Host bus message command RESPONSE */
92 #define MEI_HBM_CMD_RES_MSK 0x80
95 * MEI Bus Message Command IDs
97 #define HOST_START_REQ_CMD 0x01
98 #define HOST_START_RES_CMD 0x81
100 #define HOST_STOP_REQ_CMD 0x02
101 #define HOST_STOP_RES_CMD 0x82
103 #define ME_STOP_REQ_CMD 0x03
105 #define HOST_ENUM_REQ_CMD 0x04
106 #define HOST_ENUM_RES_CMD 0x84
108 #define HOST_CLIENT_PROPERTIES_REQ_CMD 0x05
109 #define HOST_CLIENT_PROPERTIES_RES_CMD 0x85
111 #define CLIENT_CONNECT_REQ_CMD 0x06
112 #define CLIENT_CONNECT_RES_CMD 0x86
114 #define CLIENT_DISCONNECT_REQ_CMD 0x07
115 #define CLIENT_DISCONNECT_RES_CMD 0x87
117 #define MEI_FLOW_CONTROL_CMD 0x08
119 #define MEI_PG_ISOLATION_ENTRY_REQ_CMD 0x0a
120 #define MEI_PG_ISOLATION_ENTRY_RES_CMD 0x8a
121 #define MEI_PG_ISOLATION_EXIT_REQ_CMD 0x0b
122 #define MEI_PG_ISOLATION_EXIT_RES_CMD 0x8b
124 #define MEI_HBM_ADD_CLIENT_REQ_CMD 0x0f
125 #define MEI_HBM_ADD_CLIENT_RES_CMD 0x8f
127 #define MEI_HBM_NOTIFY_REQ_CMD 0x10
128 #define MEI_HBM_NOTIFY_RES_CMD 0x90
129 #define MEI_HBM_NOTIFICATION_CMD 0x11
131 #define MEI_HBM_DMA_SETUP_REQ_CMD 0x12
132 #define MEI_HBM_DMA_SETUP_RES_CMD 0x92
136 * used by hbm_host_stop_request.reason
138 enum mei_stop_reason_types {
139 DRIVER_STOP_REQUEST = 0x00,
140 DEVICE_D1_ENTRY = 0x01,
141 DEVICE_D2_ENTRY = 0x02,
142 DEVICE_D3_ENTRY = 0x03,
143 SYSTEM_S1_ENTRY = 0x04,
144 SYSTEM_S2_ENTRY = 0x05,
145 SYSTEM_S3_ENTRY = 0x06,
146 SYSTEM_S4_ENTRY = 0x07,
147 SYSTEM_S5_ENTRY = 0x08
152 * enum mei_hbm_status - mei host bus messages return values
154 * @MEI_HBMS_SUCCESS : status success
155 * @MEI_HBMS_CLIENT_NOT_FOUND : client not found
156 * @MEI_HBMS_ALREADY_EXISTS : connection already established
157 * @MEI_HBMS_REJECTED : connection is rejected
158 * @MEI_HBMS_INVALID_PARAMETER : invalid parameter
159 * @MEI_HBMS_NOT_ALLOWED : operation not allowed
160 * @MEI_HBMS_ALREADY_STARTED : system is already started
161 * @MEI_HBMS_NOT_STARTED : system not started
163 * @MEI_HBMS_MAX : sentinel
165 enum mei_hbm_status {
166 MEI_HBMS_SUCCESS = 0,
167 MEI_HBMS_CLIENT_NOT_FOUND = 1,
168 MEI_HBMS_ALREADY_EXISTS = 2,
169 MEI_HBMS_REJECTED = 3,
170 MEI_HBMS_INVALID_PARAMETER = 4,
171 MEI_HBMS_NOT_ALLOWED = 5,
172 MEI_HBMS_ALREADY_STARTED = 6,
173 MEI_HBMS_NOT_STARTED = 7,
180 * Client Connect Status
181 * used by hbm_client_connect_response.status
183 enum mei_cl_connect_status {
184 MEI_CL_CONN_SUCCESS = MEI_HBMS_SUCCESS,
185 MEI_CL_CONN_NOT_FOUND = MEI_HBMS_CLIENT_NOT_FOUND,
186 MEI_CL_CONN_ALREADY_STARTED = MEI_HBMS_ALREADY_EXISTS,
187 MEI_CL_CONN_OUT_OF_RESOURCES = MEI_HBMS_REJECTED,
188 MEI_CL_CONN_MESSAGE_SMALL = MEI_HBMS_INVALID_PARAMETER,
189 MEI_CL_CONN_NOT_ALLOWED = MEI_HBMS_NOT_ALLOWED,
193 * Client Disconnect Status
195 enum mei_cl_disconnect_status {
196 MEI_CL_DISCONN_SUCCESS = MEI_HBMS_SUCCESS
200 * struct mei_msg_hdr - MEI BUS Interface Section
202 * @me_addr: device address
203 * @host_addr: host address
204 * @length: message length
205 * @reserved: reserved
206 * @dma_ring: message is on dma ring
207 * @internal: message is internal
208 * @msg_complete: last packet of the message
209 * @extension: extension of the header
222 #define MEI_MSG_HDR_MAX 2
224 struct mei_bus_message {
230 * struct hbm_cl_cmd - client specific host bus command
231 * CONNECT, DISCONNECT, and FlOW CONTROL
233 * @hbm_cmd: bus message command header
234 * @me_addr: address of the client in ME
235 * @host_addr: address of the client in the driver
236 * @data: generic data
238 struct mei_hbm_cl_cmd {
250 struct hbm_host_version_request {
253 struct hbm_version host_version;
256 struct hbm_host_version_response {
258 u8 host_version_supported;
259 struct hbm_version me_max_version;
262 struct hbm_host_stop_request {
268 struct hbm_host_stop_response {
273 struct hbm_me_stop_request {
280 * enum hbm_host_enum_flags - enumeration request flags (HBM version >= 2.0)
282 * @MEI_HBM_ENUM_F_ALLOW_ADD: allow dynamic clients add
283 * @MEI_HBM_ENUM_F_IMMEDIATE_ENUM: allow FW to send answer immediately
285 enum hbm_host_enum_flags {
286 MEI_HBM_ENUM_F_ALLOW_ADD = BIT(0),
287 MEI_HBM_ENUM_F_IMMEDIATE_ENUM = BIT(1),
291 * struct hbm_host_enum_request - enumeration request from host to fw
293 * @hbm_cmd : bus message command header
294 * @flags : request flags
295 * @reserved: reserved
297 struct hbm_host_enum_request {
303 struct hbm_host_enum_response {
306 u8 valid_addresses[32];
309 struct mei_client_properties {
310 uuid_le protocol_name;
312 u8 max_number_of_connections;
314 u8 single_recv_buf:1;
319 struct hbm_props_request {
325 struct hbm_props_response {
330 struct mei_client_properties client_properties;
334 * struct hbm_add_client_request - request to add a client
335 * might be sent by fw after enumeration has already completed
337 * @hbm_cmd: bus message command header
338 * @me_addr: address of the client in ME
339 * @reserved: reserved
340 * @client_properties: client properties
342 struct hbm_add_client_request {
346 struct mei_client_properties client_properties;
350 * struct hbm_add_client_response - response to add a client
351 * sent by the host to report client addition status to fw
353 * @hbm_cmd: bus message command header
354 * @me_addr: address of the client in ME
355 * @status: if HBMS_SUCCESS then the client can now accept connections.
356 * @reserved: reserved
358 struct hbm_add_client_response {
366 * struct hbm_power_gate - power gate request/response
368 * @hbm_cmd: bus message command header
369 * @reserved: reserved
371 struct hbm_power_gate {
377 * struct hbm_client_connect_request - connect/disconnect request
379 * @hbm_cmd: bus message command header
380 * @me_addr: address of the client in ME
381 * @host_addr: address of the client in the driver
382 * @reserved: reserved
384 struct hbm_client_connect_request {
392 * struct hbm_client_connect_response - connect/disconnect response
394 * @hbm_cmd: bus message command header
395 * @me_addr: address of the client in ME
396 * @host_addr: address of the client in the driver
397 * @status: status of the request
399 struct hbm_client_connect_response {
407 #define MEI_FC_MESSAGE_RESERVED_LENGTH 5
409 struct hbm_flow_control {
413 u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
416 #define MEI_HBM_NOTIFICATION_START 1
417 #define MEI_HBM_NOTIFICATION_STOP 0
419 * struct hbm_notification_request - start/stop notification request
421 * @hbm_cmd: bus message command header
422 * @me_addr: address of the client in ME
423 * @host_addr: address of the client in the driver
424 * @start: start = 1 or stop = 0 asynchronous notifications
426 struct hbm_notification_request {
434 * struct hbm_notification_response - start/stop notification response
436 * @hbm_cmd: bus message command header
437 * @me_addr: address of the client in ME
438 * @host_addr: - address of the client in the driver
439 * @status: (mei_hbm_status) response status for the request
440 * - MEI_HBMS_SUCCESS: successful stop/start
441 * - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
442 * - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
443 * started notification.
444 * - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
445 * asynchronous notifications are currently disabled.
447 * @start: start = 1 or stop = 0 asynchronous notifications
448 * @reserved: reserved
450 struct hbm_notification_response {
460 * struct hbm_notification - notification event
462 * @hbm_cmd: bus message command header
463 * @me_addr: address of the client in ME
464 * @host_addr: address of the client in the driver
465 * @reserved: reserved for alignment
467 struct hbm_notification {
475 * struct hbm_dma_mem_dscr - dma ring
477 * @addr_hi: the high 32bits of 64 bit address
478 * @addr_lo: the low 32bits of 64 bit address
479 * @size : size in bytes (must be power of 2)
481 struct hbm_dma_mem_dscr {
495 * struct hbm_dma_setup_request - dma setup request
497 * @hbm_cmd: bus message command header
498 * @reserved: reserved for alignment
499 * @dma_dscr: dma descriptor for HOST, DEVICE, and CTRL
501 struct hbm_dma_setup_request {
504 struct hbm_dma_mem_dscr dma_dscr[DMA_DSCR_NUM];
508 * struct hbm_dma_setup_response - dma setup response
510 * @hbm_cmd: bus message command header
511 * @status: 0 on success; otherwise DMA setup failed.
512 * @reserved: reserved for alignment
514 struct hbm_dma_setup_response {
521 * struct mei_dma_ring_ctrl - dma ring control block
523 * @hbuf_wr_idx: host circular buffer write index in slots
524 * @reserved1: reserved for alignment
525 * @hbuf_rd_idx: host circular buffer read index in slots
526 * @reserved2: reserved for alignment
527 * @dbuf_wr_idx: device circular buffer write index in slots
528 * @reserved3: reserved for alignment
529 * @dbuf_rd_idx: device circular buffer read index in slots
530 * @reserved4: reserved for alignment
532 struct hbm_dma_ring_ctrl {