76fb502e6f71973ea82a93c2f0c6620b3ae2e433
[muen/linux.git] / drivers / misc / mei / hw.h
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_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 */
34
35 /*
36  * MEI Version
37  */
38 #define HBM_MINOR_VERSION                   0
39 #define HBM_MAJOR_VERSION                   2
40
41 /*
42  * MEI version with PGI support
43  */
44 #define HBM_MINOR_VERSION_PGI               1
45 #define HBM_MAJOR_VERSION_PGI               1
46
47 /*
48  * MEI version with Dynamic clients support
49  */
50 #define HBM_MINOR_VERSION_DC               0
51 #define HBM_MAJOR_VERSION_DC               2
52
53 /*
54  * MEI version with immediate reply to enum request support
55  */
56 #define HBM_MINOR_VERSION_IE               0
57 #define HBM_MAJOR_VERSION_IE               2
58
59 /*
60  * MEI version with disconnect on connection timeout support
61  */
62 #define HBM_MINOR_VERSION_DOT              0
63 #define HBM_MAJOR_VERSION_DOT              2
64
65 /*
66  * MEI version with notification support
67  */
68 #define HBM_MINOR_VERSION_EV               0
69 #define HBM_MAJOR_VERSION_EV               2
70
71 /*
72  * MEI version with fixed address client support
73  */
74 #define HBM_MINOR_VERSION_FA               0
75 #define HBM_MAJOR_VERSION_FA               2
76
77 /*
78  * MEI version with OS ver message support
79  */
80 #define HBM_MINOR_VERSION_OS               0
81 #define HBM_MAJOR_VERSION_OS               2
82
83 /* Host bus message command opcode */
84 #define MEI_HBM_CMD_OP_MSK                  0x7f
85 /* Host bus message command RESPONSE */
86 #define MEI_HBM_CMD_RES_MSK                 0x80
87
88 /*
89  * MEI Bus Message Command IDs
90  */
91 #define HOST_START_REQ_CMD                  0x01
92 #define HOST_START_RES_CMD                  0x81
93
94 #define HOST_STOP_REQ_CMD                   0x02
95 #define HOST_STOP_RES_CMD                   0x82
96
97 #define ME_STOP_REQ_CMD                     0x03
98
99 #define HOST_ENUM_REQ_CMD                   0x04
100 #define HOST_ENUM_RES_CMD                   0x84
101
102 #define HOST_CLIENT_PROPERTIES_REQ_CMD      0x05
103 #define HOST_CLIENT_PROPERTIES_RES_CMD      0x85
104
105 #define CLIENT_CONNECT_REQ_CMD              0x06
106 #define CLIENT_CONNECT_RES_CMD              0x86
107
108 #define CLIENT_DISCONNECT_REQ_CMD           0x07
109 #define CLIENT_DISCONNECT_RES_CMD           0x87
110
111 #define MEI_FLOW_CONTROL_CMD                0x08
112
113 #define MEI_PG_ISOLATION_ENTRY_REQ_CMD      0x0a
114 #define MEI_PG_ISOLATION_ENTRY_RES_CMD      0x8a
115 #define MEI_PG_ISOLATION_EXIT_REQ_CMD       0x0b
116 #define MEI_PG_ISOLATION_EXIT_RES_CMD       0x8b
117
118 #define MEI_HBM_ADD_CLIENT_REQ_CMD          0x0f
119 #define MEI_HBM_ADD_CLIENT_RES_CMD          0x8f
120
121 #define MEI_HBM_NOTIFY_REQ_CMD              0x10
122 #define MEI_HBM_NOTIFY_RES_CMD              0x90
123 #define MEI_HBM_NOTIFICATION_CMD            0x11
124
125 #define MEI_HBM_DMA_SETUP_REQ_CMD           0x12
126 #define MEI_HBM_DMA_SETUP_RES_CMD           0x92
127
128 /*
129  * MEI Stop Reason
130  * used by hbm_host_stop_request.reason
131  */
132 enum mei_stop_reason_types {
133         DRIVER_STOP_REQUEST = 0x00,
134         DEVICE_D1_ENTRY = 0x01,
135         DEVICE_D2_ENTRY = 0x02,
136         DEVICE_D3_ENTRY = 0x03,
137         SYSTEM_S1_ENTRY = 0x04,
138         SYSTEM_S2_ENTRY = 0x05,
139         SYSTEM_S3_ENTRY = 0x06,
140         SYSTEM_S4_ENTRY = 0x07,
141         SYSTEM_S5_ENTRY = 0x08
142 };
143
144
145 /**
146  * enum mei_hbm_status  - mei host bus messages return values
147  *
148  * @MEI_HBMS_SUCCESS           : status success
149  * @MEI_HBMS_CLIENT_NOT_FOUND  : client not found
150  * @MEI_HBMS_ALREADY_EXISTS    : connection already established
151  * @MEI_HBMS_REJECTED          : connection is rejected
152  * @MEI_HBMS_INVALID_PARAMETER : invalid parameter
153  * @MEI_HBMS_NOT_ALLOWED       : operation not allowed
154  * @MEI_HBMS_ALREADY_STARTED   : system is already started
155  * @MEI_HBMS_NOT_STARTED       : system not started
156  *
157  * @MEI_HBMS_MAX               : sentinel
158  */
159 enum mei_hbm_status {
160         MEI_HBMS_SUCCESS           = 0,
161         MEI_HBMS_CLIENT_NOT_FOUND  = 1,
162         MEI_HBMS_ALREADY_EXISTS    = 2,
163         MEI_HBMS_REJECTED          = 3,
164         MEI_HBMS_INVALID_PARAMETER = 4,
165         MEI_HBMS_NOT_ALLOWED       = 5,
166         MEI_HBMS_ALREADY_STARTED   = 6,
167         MEI_HBMS_NOT_STARTED       = 7,
168
169         MEI_HBMS_MAX
170 };
171
172
173 /*
174  * Client Connect Status
175  * used by hbm_client_connect_response.status
176  */
177 enum mei_cl_connect_status {
178         MEI_CL_CONN_SUCCESS          = MEI_HBMS_SUCCESS,
179         MEI_CL_CONN_NOT_FOUND        = MEI_HBMS_CLIENT_NOT_FOUND,
180         MEI_CL_CONN_ALREADY_STARTED  = MEI_HBMS_ALREADY_EXISTS,
181         MEI_CL_CONN_OUT_OF_RESOURCES = MEI_HBMS_REJECTED,
182         MEI_CL_CONN_MESSAGE_SMALL    = MEI_HBMS_INVALID_PARAMETER,
183         MEI_CL_CONN_NOT_ALLOWED      = MEI_HBMS_NOT_ALLOWED,
184 };
185
186 /*
187  * Client Disconnect Status
188  */
189 enum  mei_cl_disconnect_status {
190         MEI_CL_DISCONN_SUCCESS = MEI_HBMS_SUCCESS
191 };
192
193 /*
194  *  MEI BUS Interface Section
195  */
196 struct mei_msg_hdr {
197         u32 me_addr:8;
198         u32 host_addr:8;
199         u32 length:9;
200         u32 reserved:5;
201         u32 internal:1;
202         u32 msg_complete:1;
203 } __packed;
204
205
206 struct mei_bus_message {
207         u8 hbm_cmd;
208         u8 data[0];
209 } __packed;
210
211 /**
212  * struct hbm_cl_cmd - client specific host bus command
213  *      CONNECT, DISCONNECT, and FlOW CONTROL
214  *
215  * @hbm_cmd: bus message command header
216  * @me_addr: address of the client in ME
217  * @host_addr: address of the client in the driver
218  * @data: generic data
219  */
220 struct mei_hbm_cl_cmd {
221         u8 hbm_cmd;
222         u8 me_addr;
223         u8 host_addr;
224         u8 data;
225 };
226
227 struct hbm_version {
228         u8 minor_version;
229         u8 major_version;
230 } __packed;
231
232 struct hbm_host_version_request {
233         u8 hbm_cmd;
234         u8 reserved;
235         struct hbm_version host_version;
236 } __packed;
237
238 struct hbm_host_version_response {
239         u8 hbm_cmd;
240         u8 host_version_supported;
241         struct hbm_version me_max_version;
242 } __packed;
243
244 struct hbm_host_stop_request {
245         u8 hbm_cmd;
246         u8 reason;
247         u8 reserved[2];
248 } __packed;
249
250 struct hbm_host_stop_response {
251         u8 hbm_cmd;
252         u8 reserved[3];
253 } __packed;
254
255 struct hbm_me_stop_request {
256         u8 hbm_cmd;
257         u8 reason;
258         u8 reserved[2];
259 } __packed;
260
261 /**
262  * enum hbm_host_enum_flags - enumeration request flags (HBM version >= 2.0)
263  *
264  * @MEI_HBM_ENUM_F_ALLOW_ADD: allow dynamic clients add
265  * @MEI_HBM_ENUM_F_IMMEDIATE_ENUM: allow FW to send answer immediately
266  */
267 enum hbm_host_enum_flags {
268         MEI_HBM_ENUM_F_ALLOW_ADD = BIT(0),
269         MEI_HBM_ENUM_F_IMMEDIATE_ENUM = BIT(1),
270 };
271
272 /**
273  * struct hbm_host_enum_request - enumeration request from host to fw
274  *
275  * @hbm_cmd : bus message command header
276  * @flags   : request flags
277  * @reserved: reserved
278  */
279 struct hbm_host_enum_request {
280         u8 hbm_cmd;
281         u8 flags;
282         u8 reserved[2];
283 } __packed;
284
285 struct hbm_host_enum_response {
286         u8 hbm_cmd;
287         u8 reserved[3];
288         u8 valid_addresses[32];
289 } __packed;
290
291 struct mei_client_properties {
292         uuid_le protocol_name;
293         u8 protocol_version;
294         u8 max_number_of_connections;
295         u8 fixed_address;
296         u8 single_recv_buf;
297         u32 max_msg_length;
298 } __packed;
299
300 struct hbm_props_request {
301         u8 hbm_cmd;
302         u8 me_addr;
303         u8 reserved[2];
304 } __packed;
305
306 struct hbm_props_response {
307         u8 hbm_cmd;
308         u8 me_addr;
309         u8 status;
310         u8 reserved[1];
311         struct mei_client_properties client_properties;
312 } __packed;
313
314 /**
315  * struct hbm_add_client_request - request to add a client
316  *     might be sent by fw after enumeration has already completed
317  *
318  * @hbm_cmd: bus message command header
319  * @me_addr: address of the client in ME
320  * @reserved: reserved
321  * @client_properties: client properties
322  */
323 struct hbm_add_client_request {
324         u8 hbm_cmd;
325         u8 me_addr;
326         u8 reserved[2];
327         struct mei_client_properties client_properties;
328 } __packed;
329
330 /**
331  * struct hbm_add_client_response - response to add a client
332  *     sent by the host to report client addition status to fw
333  *
334  * @hbm_cmd: bus message command header
335  * @me_addr: address of the client in ME
336  * @status: if HBMS_SUCCESS then the client can now accept connections.
337  * @reserved: reserved
338  */
339 struct hbm_add_client_response {
340         u8 hbm_cmd;
341         u8 me_addr;
342         u8 status;
343         u8 reserved[1];
344 } __packed;
345
346 /**
347  * struct hbm_power_gate - power gate request/response
348  *
349  * @hbm_cmd: bus message command header
350  * @reserved: reserved
351  */
352 struct hbm_power_gate {
353         u8 hbm_cmd;
354         u8 reserved[3];
355 } __packed;
356
357 /**
358  * struct hbm_client_connect_request - connect/disconnect request
359  *
360  * @hbm_cmd: bus message command header
361  * @me_addr: address of the client in ME
362  * @host_addr: address of the client in the driver
363  * @reserved: reserved
364  */
365 struct hbm_client_connect_request {
366         u8 hbm_cmd;
367         u8 me_addr;
368         u8 host_addr;
369         u8 reserved;
370 } __packed;
371
372 /**
373  * struct hbm_client_connect_response - connect/disconnect response
374  *
375  * @hbm_cmd: bus message command header
376  * @me_addr: address of the client in ME
377  * @host_addr: address of the client in the driver
378  * @status: status of the request
379  */
380 struct hbm_client_connect_response {
381         u8 hbm_cmd;
382         u8 me_addr;
383         u8 host_addr;
384         u8 status;
385 } __packed;
386
387
388 #define MEI_FC_MESSAGE_RESERVED_LENGTH           5
389
390 struct hbm_flow_control {
391         u8 hbm_cmd;
392         u8 me_addr;
393         u8 host_addr;
394         u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
395 } __packed;
396
397 #define MEI_HBM_NOTIFICATION_START 1
398 #define MEI_HBM_NOTIFICATION_STOP  0
399 /**
400  * struct hbm_notification_request - start/stop notification request
401  *
402  * @hbm_cmd: bus message command header
403  * @me_addr: address of the client in ME
404  * @host_addr: address of the client in the driver
405  * @start:  start = 1 or stop = 0 asynchronous notifications
406  */
407 struct hbm_notification_request {
408         u8 hbm_cmd;
409         u8 me_addr;
410         u8 host_addr;
411         u8 start;
412 } __packed;
413
414 /**
415  * struct hbm_notification_response - start/stop notification response
416  *
417  * @hbm_cmd: bus message command header
418  * @me_addr: address of the client in ME
419  * @host_addr: - address of the client in the driver
420  * @status: (mei_hbm_status) response status for the request
421  *  - MEI_HBMS_SUCCESS: successful stop/start
422  *  - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
423  *  - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
424  *                         started notification.
425  *  - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
426  *                         asynchronous notifications are currently disabled.
427  *
428  * @start:  start = 1 or stop = 0 asynchronous notifications
429  * @reserved: reserved
430  */
431 struct hbm_notification_response {
432         u8 hbm_cmd;
433         u8 me_addr;
434         u8 host_addr;
435         u8 status;
436         u8 start;
437         u8 reserved[3];
438 } __packed;
439
440 /**
441  * struct hbm_notification - notification event
442  *
443  * @hbm_cmd: bus message command header
444  * @me_addr:  address of the client in ME
445  * @host_addr:  address of the client in the driver
446  * @reserved: reserved for alignment
447  */
448 struct hbm_notification {
449         u8 hbm_cmd;
450         u8 me_addr;
451         u8 host_addr;
452         u8 reserved[1];
453 } __packed;
454
455 /**
456  * struct hbm_dma_mem_dscr - dma ring
457  *
458  * @addr_hi: the high 32bits of 64 bit address
459  * @addr_lo: the low  32bits of 64 bit address
460  * @size   : size in bytes (must be power of 2)
461  */
462 struct hbm_dma_mem_dscr {
463         u32 addr_hi;
464         u32 addr_lo;
465         u32 size;
466 } __packed;
467
468 enum {
469         DMA_DSCR_HOST = 0,
470         DMA_DSCR_DEVICE = 1,
471         DMA_DSCR_CTRL = 2,
472         DMA_DSCR_NUM,
473 };
474
475 /**
476  * struct hbm_dma_setup_request - dma setup request
477  *
478  * @hbm_cmd: bus message command header
479  * @reserved: reserved for alignment
480  * @dma_dscr: dma descriptor for HOST, DEVICE, and CTRL
481  */
482 struct hbm_dma_setup_request {
483         u8 hbm_cmd;
484         u8 reserved[3];
485         struct hbm_dma_mem_dscr dma_dscr[DMA_DSCR_NUM];
486 } __packed;
487
488 /**
489  * struct hbm_dma_setup_response - dma setup response
490  *
491  * @hbm_cmd: bus message command header
492  * @status: 0 on success; otherwise DMA setup failed.
493  * @reserved: reserved for alignment
494  */
495 struct hbm_dma_setup_response {
496         u8 hbm_cmd;
497         u8 status;
498         u8 reserved[2];
499 } __packed;
500
501 #endif