tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
fork
Configure Feed
Select the types of activity you want to include in your feed.
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_INTEROP_TIMEOUT 7 /* 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
35/*
36 * MEI Version
37 */
38#define HBM_MINOR_VERSION 0
39#define HBM_MAJOR_VERSION 1
40#define HBM_TIMEOUT 1 /* 1 second */
41
42/* Host bus message command opcode */
43#define MEI_HBM_CMD_OP_MSK 0x7f
44/* Host bus message command RESPONSE */
45#define MEI_HBM_CMD_RES_MSK 0x80
46
47/*
48 * MEI Bus Message Command IDs
49 */
50#define HOST_START_REQ_CMD 0x01
51#define HOST_START_RES_CMD 0x81
52
53#define HOST_STOP_REQ_CMD 0x02
54#define HOST_STOP_RES_CMD 0x82
55
56#define ME_STOP_REQ_CMD 0x03
57
58#define HOST_ENUM_REQ_CMD 0x04
59#define HOST_ENUM_RES_CMD 0x84
60
61#define HOST_CLIENT_PROPERTIES_REQ_CMD 0x05
62#define HOST_CLIENT_PROPERTIES_RES_CMD 0x85
63
64#define CLIENT_CONNECT_REQ_CMD 0x06
65#define CLIENT_CONNECT_RES_CMD 0x86
66
67#define CLIENT_DISCONNECT_REQ_CMD 0x07
68#define CLIENT_DISCONNECT_RES_CMD 0x87
69
70#define MEI_FLOW_CONTROL_CMD 0x08
71
72/*
73 * MEI Stop Reason
74 * used by hbm_host_stop_request.reason
75 */
76enum mei_stop_reason_types {
77 DRIVER_STOP_REQUEST = 0x00,
78 DEVICE_D1_ENTRY = 0x01,
79 DEVICE_D2_ENTRY = 0x02,
80 DEVICE_D3_ENTRY = 0x03,
81 SYSTEM_S1_ENTRY = 0x04,
82 SYSTEM_S2_ENTRY = 0x05,
83 SYSTEM_S3_ENTRY = 0x06,
84 SYSTEM_S4_ENTRY = 0x07,
85 SYSTEM_S5_ENTRY = 0x08
86};
87
88/*
89 * Client Connect Status
90 * used by hbm_client_connect_response.status
91 */
92enum client_connect_status_types {
93 CCS_SUCCESS = 0x00,
94 CCS_NOT_FOUND = 0x01,
95 CCS_ALREADY_STARTED = 0x02,
96 CCS_OUT_OF_RESOURCES = 0x03,
97 CCS_MESSAGE_SMALL = 0x04
98};
99
100/*
101 * Client Disconnect Status
102 */
103enum client_disconnect_status_types {
104 CDS_SUCCESS = 0x00
105};
106
107/*
108 * MEI BUS Interface Section
109 */
110struct mei_msg_hdr {
111 u32 me_addr:8;
112 u32 host_addr:8;
113 u32 length:9;
114 u32 reserved:6;
115 u32 msg_complete:1;
116} __packed;
117
118
119struct mei_bus_message {
120 u8 hbm_cmd;
121 u8 data[0];
122} __packed;
123
124/**
125 * struct hbm_cl_cmd - client specific host bus command
126 * CONNECT, DISCONNECT, and FlOW CONTROL
127 *
128 * @hbm_cmd - bus message command header
129 * @me_addr - address of the client in ME
130 * @host_addr - address of the client in the driver
131 * @data
132 */
133struct mei_hbm_cl_cmd {
134 u8 hbm_cmd;
135 u8 me_addr;
136 u8 host_addr;
137 u8 data;
138};
139
140struct hbm_version {
141 u8 minor_version;
142 u8 major_version;
143} __packed;
144
145struct hbm_host_version_request {
146 u8 hbm_cmd;
147 u8 reserved;
148 struct hbm_version host_version;
149} __packed;
150
151struct hbm_host_version_response {
152 u8 hbm_cmd;
153 u8 host_version_supported;
154 struct hbm_version me_max_version;
155} __packed;
156
157struct hbm_host_stop_request {
158 u8 hbm_cmd;
159 u8 reason;
160 u8 reserved[2];
161} __packed;
162
163struct hbm_host_stop_response {
164 u8 hbm_cmd;
165 u8 reserved[3];
166} __packed;
167
168struct hbm_me_stop_request {
169 u8 hbm_cmd;
170 u8 reason;
171 u8 reserved[2];
172} __packed;
173
174struct hbm_host_enum_request {
175 u8 hbm_cmd;
176 u8 reserved[3];
177} __packed;
178
179struct hbm_host_enum_response {
180 u8 hbm_cmd;
181 u8 reserved[3];
182 u8 valid_addresses[32];
183} __packed;
184
185struct mei_client_properties {
186 uuid_le protocol_name;
187 u8 protocol_version;
188 u8 max_number_of_connections;
189 u8 fixed_address;
190 u8 single_recv_buf;
191 u32 max_msg_length;
192} __packed;
193
194struct hbm_props_request {
195 u8 hbm_cmd;
196 u8 address;
197 u8 reserved[2];
198} __packed;
199
200
201struct hbm_props_response {
202 u8 hbm_cmd;
203 u8 address;
204 u8 status;
205 u8 reserved[1];
206 struct mei_client_properties client_properties;
207} __packed;
208
209/**
210 * struct hbm_client_connect_request - connect/disconnect request
211 *
212 * @hbm_cmd - bus message command header
213 * @me_addr - address of the client in ME
214 * @host_addr - address of the client in the driver
215 * @reserved
216 */
217struct hbm_client_connect_request {
218 u8 hbm_cmd;
219 u8 me_addr;
220 u8 host_addr;
221 u8 reserved;
222} __packed;
223
224/**
225 * struct hbm_client_connect_response - connect/disconnect response
226 *
227 * @hbm_cmd - bus message command header
228 * @me_addr - address of the client in ME
229 * @host_addr - address of the client in the driver
230 * @status - status of the request
231 */
232struct hbm_client_connect_response {
233 u8 hbm_cmd;
234 u8 me_addr;
235 u8 host_addr;
236 u8 status;
237} __packed;
238
239
240#define MEI_FC_MESSAGE_RESERVED_LENGTH 5
241
242struct hbm_flow_control {
243 u8 hbm_cmd;
244 u8 me_addr;
245 u8 host_addr;
246 u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
247} __packed;
248
249
250#endif