mei: hbm: introduce dma bit in the message header
[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  * struct mei_msg_hdr - MEI BUS Interface Section
195  *
196  * @me_addr: device address
197  * @host_addr: host address
198  * @length: message length
199  * @reserved: reserved
200  * @dma_ring: message is on dma ring
201  * @internal: message is internal
202  * @msg_complete: last packet of the message
203  */
204 struct mei_msg_hdr {
205         u32 me_addr:8;
206         u32 host_addr:8;
207         u32 length:9;
208         u32 reserved:4;
209         u32 dma_ring:1;
210         u32 internal:1;
211         u32 msg_complete:1;
212 } __packed;
213
214 struct mei_bus_message {
215         u8 hbm_cmd;
216         u8 data[0];
217 } __packed;
218
219 /**
220  * struct hbm_cl_cmd - client specific host bus command
221  *      CONNECT, DISCONNECT, and FlOW CONTROL
222  *
223  * @hbm_cmd: bus message command header
224  * @me_addr: address of the client in ME
225  * @host_addr: address of the client in the driver
226  * @data: generic data
227  */
228 struct mei_hbm_cl_cmd {
229         u8 hbm_cmd;
230         u8 me_addr;
231         u8 host_addr;
232         u8 data;
233 };
234
235 struct hbm_version {
236         u8 minor_version;
237         u8 major_version;
238 } __packed;
239
240 struct hbm_host_version_request {
241         u8 hbm_cmd;
242         u8 reserved;
243         struct hbm_version host_version;
244 } __packed;
245
246 struct hbm_host_version_response {
247         u8 hbm_cmd;
248         u8 host_version_supported;
249         struct hbm_version me_max_version;
250 } __packed;
251
252 struct hbm_host_stop_request {
253         u8 hbm_cmd;
254         u8 reason;
255         u8 reserved[2];
256 } __packed;
257
258 struct hbm_host_stop_response {
259         u8 hbm_cmd;
260         u8 reserved[3];
261 } __packed;
262
263 struct hbm_me_stop_request {
264         u8 hbm_cmd;
265         u8 reason;
266         u8 reserved[2];
267 } __packed;
268
269 /**
270  * enum hbm_host_enum_flags - enumeration request flags (HBM version >= 2.0)
271  *
272  * @MEI_HBM_ENUM_F_ALLOW_ADD: allow dynamic clients add
273  * @MEI_HBM_ENUM_F_IMMEDIATE_ENUM: allow FW to send answer immediately
274  */
275 enum hbm_host_enum_flags {
276         MEI_HBM_ENUM_F_ALLOW_ADD = BIT(0),
277         MEI_HBM_ENUM_F_IMMEDIATE_ENUM = BIT(1),
278 };
279
280 /**
281  * struct hbm_host_enum_request - enumeration request from host to fw
282  *
283  * @hbm_cmd : bus message command header
284  * @flags   : request flags
285  * @reserved: reserved
286  */
287 struct hbm_host_enum_request {
288         u8 hbm_cmd;
289         u8 flags;
290         u8 reserved[2];
291 } __packed;
292
293 struct hbm_host_enum_response {
294         u8 hbm_cmd;
295         u8 reserved[3];
296         u8 valid_addresses[32];
297 } __packed;
298
299 struct mei_client_properties {
300         uuid_le protocol_name;
301         u8 protocol_version;
302         u8 max_number_of_connections;
303         u8 fixed_address;
304         u8 single_recv_buf;
305         u32 max_msg_length;
306 } __packed;
307
308 struct hbm_props_request {
309         u8 hbm_cmd;
310         u8 me_addr;
311         u8 reserved[2];
312 } __packed;
313
314 struct hbm_props_response {
315         u8 hbm_cmd;
316         u8 me_addr;
317         u8 status;
318         u8 reserved[1];
319         struct mei_client_properties client_properties;
320 } __packed;
321
322 /**
323  * struct hbm_add_client_request - request to add a client
324  *     might be sent by fw after enumeration has already completed
325  *
326  * @hbm_cmd: bus message command header
327  * @me_addr: address of the client in ME
328  * @reserved: reserved
329  * @client_properties: client properties
330  */
331 struct hbm_add_client_request {
332         u8 hbm_cmd;
333         u8 me_addr;
334         u8 reserved[2];
335         struct mei_client_properties client_properties;
336 } __packed;
337
338 /**
339  * struct hbm_add_client_response - response to add a client
340  *     sent by the host to report client addition status to fw
341  *
342  * @hbm_cmd: bus message command header
343  * @me_addr: address of the client in ME
344  * @status: if HBMS_SUCCESS then the client can now accept connections.
345  * @reserved: reserved
346  */
347 struct hbm_add_client_response {
348         u8 hbm_cmd;
349         u8 me_addr;
350         u8 status;
351         u8 reserved[1];
352 } __packed;
353
354 /**
355  * struct hbm_power_gate - power gate request/response
356  *
357  * @hbm_cmd: bus message command header
358  * @reserved: reserved
359  */
360 struct hbm_power_gate {
361         u8 hbm_cmd;
362         u8 reserved[3];
363 } __packed;
364
365 /**
366  * struct hbm_client_connect_request - connect/disconnect request
367  *
368  * @hbm_cmd: bus message command header
369  * @me_addr: address of the client in ME
370  * @host_addr: address of the client in the driver
371  * @reserved: reserved
372  */
373 struct hbm_client_connect_request {
374         u8 hbm_cmd;
375         u8 me_addr;
376         u8 host_addr;
377         u8 reserved;
378 } __packed;
379
380 /**
381  * struct hbm_client_connect_response - connect/disconnect response
382  *
383  * @hbm_cmd: bus message command header
384  * @me_addr: address of the client in ME
385  * @host_addr: address of the client in the driver
386  * @status: status of the request
387  */
388 struct hbm_client_connect_response {
389         u8 hbm_cmd;
390         u8 me_addr;
391         u8 host_addr;
392         u8 status;
393 } __packed;
394
395
396 #define MEI_FC_MESSAGE_RESERVED_LENGTH           5
397
398 struct hbm_flow_control {
399         u8 hbm_cmd;
400         u8 me_addr;
401         u8 host_addr;
402         u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
403 } __packed;
404
405 #define MEI_HBM_NOTIFICATION_START 1
406 #define MEI_HBM_NOTIFICATION_STOP  0
407 /**
408  * struct hbm_notification_request - start/stop notification request
409  *
410  * @hbm_cmd: bus message command header
411  * @me_addr: address of the client in ME
412  * @host_addr: address of the client in the driver
413  * @start:  start = 1 or stop = 0 asynchronous notifications
414  */
415 struct hbm_notification_request {
416         u8 hbm_cmd;
417         u8 me_addr;
418         u8 host_addr;
419         u8 start;
420 } __packed;
421
422 /**
423  * struct hbm_notification_response - start/stop notification response
424  *
425  * @hbm_cmd: bus message command header
426  * @me_addr: address of the client in ME
427  * @host_addr: - address of the client in the driver
428  * @status: (mei_hbm_status) response status for the request
429  *  - MEI_HBMS_SUCCESS: successful stop/start
430  *  - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
431  *  - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
432  *                         started notification.
433  *  - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
434  *                         asynchronous notifications are currently disabled.
435  *
436  * @start:  start = 1 or stop = 0 asynchronous notifications
437  * @reserved: reserved
438  */
439 struct hbm_notification_response {
440         u8 hbm_cmd;
441         u8 me_addr;
442         u8 host_addr;
443         u8 status;
444         u8 start;
445         u8 reserved[3];
446 } __packed;
447
448 /**
449  * struct hbm_notification - notification event
450  *
451  * @hbm_cmd: bus message command header
452  * @me_addr:  address of the client in ME
453  * @host_addr:  address of the client in the driver
454  * @reserved: reserved for alignment
455  */
456 struct hbm_notification {
457         u8 hbm_cmd;
458         u8 me_addr;
459         u8 host_addr;
460         u8 reserved[1];
461 } __packed;
462
463 /**
464  * struct hbm_dma_mem_dscr - dma ring
465  *
466  * @addr_hi: the high 32bits of 64 bit address
467  * @addr_lo: the low  32bits of 64 bit address
468  * @size   : size in bytes (must be power of 2)
469  */
470 struct hbm_dma_mem_dscr {
471         u32 addr_hi;
472         u32 addr_lo;
473         u32 size;
474 } __packed;
475
476 enum {
477         DMA_DSCR_HOST = 0,
478         DMA_DSCR_DEVICE = 1,
479         DMA_DSCR_CTRL = 2,
480         DMA_DSCR_NUM,
481 };
482
483 /**
484  * struct hbm_dma_setup_request - dma setup request
485  *
486  * @hbm_cmd: bus message command header
487  * @reserved: reserved for alignment
488  * @dma_dscr: dma descriptor for HOST, DEVICE, and CTRL
489  */
490 struct hbm_dma_setup_request {
491         u8 hbm_cmd;
492         u8 reserved[3];
493         struct hbm_dma_mem_dscr dma_dscr[DMA_DSCR_NUM];
494 } __packed;
495
496 /**
497  * struct hbm_dma_setup_response - dma setup response
498  *
499  * @hbm_cmd: bus message command header
500  * @status: 0 on success; otherwise DMA setup failed.
501  * @reserved: reserved for alignment
502  */
503 struct hbm_dma_setup_response {
504         u8 hbm_cmd;
505         u8 status;
506         u8 reserved[2];
507 } __packed;
508
509 #endif