1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/* Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* LPC command constants for Chrome EC */
#ifndef __CROS_EC_LPC_COMMANDS_H
#define __CROS_EC_LPC_COMMANDS_H
#include <stdint.h>
/* During the development stage, the LPC bus has high error bit rate.
* Using checksum can detect the error and trigger re-transmit.
* FIXME: remove this after mass production.
*/
#define SUPPORT_CHECKSUM
/* I/O addresses for LPC commands */
#define EC_LPC_ADDR_KERNEL_DATA 0x62
#define EC_LPC_ADDR_KERNEL_CMD 0x66
#define EC_LPC_ADDR_KERNEL_PARAM 0x800
#define EC_LPC_ADDR_USER_DATA 0x200
#define EC_LPC_ADDR_USER_CMD 0x204
#define EC_LPC_ADDR_USER_PARAM 0x900
#define EC_LPC_PARAM_SIZE 256 /* Size of param areas in bytes */
/* LPC command status byte masks */
/* EC is busy processing a command. This covers both bit 0x04, which
* is the busy-bit, and 0x02, which is the bit which indicates the
* host has written a byte but the EC hasn't picked it up yet. */
#define EC_LPC_BUSY_MASK 0x06
#define EC_LPC_STATUS_MASK 0xF0 /* Mask for status codes in status byte */
#define EC_LPC_GET_STATUS(x) (((x) & EC_LPC_STATUS_MASK) >> 4)
/* LPC command response codes */
enum lpc_status {
EC_LPC_STATUS_SUCCESS = 0,
EC_LPC_STATUS_INVALID_COMMAND = 1,
EC_LPC_STATUS_ERROR = 2,
EC_LPC_STATUS_INVALID_PARAM = 3,
};
/* Notes on commands:
*
* Each command is an 8-byte command value. Commands which take
* params or return response data specify structs for that data. If
* no struct is specified, the command does not input or output data,
* respectively. */
/* Reboot. This command will work even when the EC LPC interface is
* busy, because the reboot command is processed at interrupt
* level. Note that when the EC reboots, the host will reboot too, so
* there is no response to this command. */
#define EC_LPC_COMMAND_REBOOT 0xD1 /* Think "die" */
/* Hello. This is a simple command to test the EC is responsive to
* commands. */
#define EC_LPC_COMMAND_HELLO 0x01
struct lpc_params_hello {
uint32_t in_data; /* Pass anything here */
} __attribute__ ((packed));
struct lpc_response_hello {
uint32_t out_data; /* Output will be in_data + 0x01020304 */
} __attribute__ ((packed));
/* Get version number */
#define EC_LPC_COMMAND_GET_VERSION 0x02
enum lpc_current_image {
EC_LPC_IMAGE_UNKNOWN = 0,
EC_LPC_IMAGE_RO,
EC_LPC_IMAGE_RW_A,
EC_LPC_IMAGE_RW_B
};
struct lpc_response_get_version {
/* Null-terminated version strings for RO, RW-A, RW-B */
char version_string_ro[32];
char version_string_rw_a[32];
char version_string_rw_b[32];
uint32_t current_image; /* One of lpc_current_image */
} __attribute__ ((packed));
/* Read test */
#define EC_LPC_COMMAND_READ_TEST 0x03
struct lpc_params_read_test {
uint32_t offset; /* Starting value for read buffer */
uint32_t size; /* Size to read in bytes */
} __attribute__ ((packed));
struct lpc_response_read_test {
uint32_t data[32];
} __attribute__ ((packed));
/*****************************************************************************/
/* Flash commands */
/* Maximum bytes that can be read/written in a single command */
#define EC_LPC_FLASH_SIZE_MAX 128
/* Get flash info */
#define EC_LPC_COMMAND_FLASH_INFO 0x10
struct lpc_response_flash_info {
/* Usable flash size, in bytes */
uint32_t flash_size;
/* Write block size. Write offset and size must be a multiple
* of this. */
uint32_t write_block_size;
/* Erase block size. Erase offset and size must be a multiple
* of this. */
uint32_t erase_block_size;
/* Protection block size. Protection offset and size must be a
* multiple of this. */
uint32_t protect_block_size;
} __attribute__ ((packed));
/* Read flash */
#define EC_LPC_COMMAND_FLASH_READ 0x11
struct lpc_params_flash_read {
uint32_t offset; /* Byte offset to read */
uint32_t size; /* Size to read in bytes */
} __attribute__ ((packed));
struct lpc_response_flash_read {
uint8_t data[EC_LPC_FLASH_SIZE_MAX];
} __attribute__ ((packed));
/* Write flash */
#define EC_LPC_COMMAND_FLASH_WRITE 0x12
struct lpc_params_flash_write {
uint32_t offset; /* Byte offset to erase */
uint32_t size; /* Size to erase in bytes */
uint8_t data[EC_LPC_FLASH_SIZE_MAX];
} __attribute__ ((packed));
/* Erase flash */
#define EC_LPC_COMMAND_FLASH_ERASE 0x13
struct lpc_params_flash_erase {
uint32_t offset; /* Byte offset to erase */
uint32_t size; /* Size to erase in bytes */
} __attribute__ ((packed));
/* Flashmap offset */
#define EC_LPC_COMMAND_FLASH_GET_FLASHMAP 0x14
struct lpc_response_flash_flashmap {
uint32_t offset; /* Flashmap offset */
} __attribute__ ((packed));
/* Enable/disable flash write protect */
#define EC_LPC_COMMAND_FLASH_WP_ENABLE 0x15
struct lpc_params_flash_wp_enable {
uint32_t enable_wp;
} __attribute__ ((packed));
/* Get flash write protection commit state */
#define EC_LPC_COMMAND_FLASH_WP_GET_STATE 0x16
struct lpc_response_flash_wp_enable {
uint32_t enable_wp;
} __attribute__ ((packed));
/* Set/get flash write protection range */
#define EC_LPC_COMMAND_FLASH_WP_SET_RANGE 0x17
struct lpc_params_flash_wp_range {
/* Byte offset aligned to info.protect_block_size */
uint32_t offset;
/* Size should be multiply of info.protect_block_size */
uint32_t size;
} __attribute__ ((packed));
#define EC_LPC_COMMAND_FLASH_WP_GET_RANGE 0x18
struct lpc_response_flash_wp_range {
uint32_t offset;
uint32_t size;
} __attribute__ ((packed));
/* Read flash write protection GPIO pin */
#define EC_LPC_COMMAND_FLASH_WP_GET_GPIO 0x19
struct lpc_params_flash_wp_gpio {
uint32_t pin_no;
} __attribute__ ((packed));
struct lpc_response_flash_wp_gpio {
uint32_t value;
} __attribute__ ((packed));
#ifdef SUPPORT_CHECKSUM
/* Checksum a range of flash datq */
#define EC_LPC_COMMAND_FLASH_CHECKSUM 0x1f
struct lpc_params_flash_checksum {
uint32_t offset; /* Byte offset to read */
uint32_t size; /* Size to read in bytes */
} __attribute__ ((packed));
struct lpc_response_flash_checksum {
uint8_t checksum;
} __attribute__ ((packed));
#define BYTE_IN(sum, byte) do { \
sum = (sum << 1) | (sum >> 7); \
sum ^= (byte ^ 0x53); \
} while (0)
#endif /* SUPPORT_CHECKSUM */
/*****************************************************************************/
/* PWM commands */
/* Get fan RPM */
#define EC_LPC_COMMAND_PWM_GET_FAN_RPM 0x20
struct lpc_response_pwm_get_fan_rpm {
uint32_t rpm;
} __attribute__ ((packed));
/* Set target fan RPM */
#define EC_LPC_COMMAND_PWM_SET_FAN_TARGET_RPM 0x21
struct lpc_params_pwm_set_fan_target_rpm {
uint32_t rpm;
} __attribute__ ((packed));
/*****************************************************************************/
/* Temperature sensor commands */
/* Get temperature readings */
#define EC_LPC_COMMAND_TEMP_SENSOR_GET_READINGS 0x30
struct lpc_params_temp_sensor_get_readings {
uint8_t temp_sensor_id;
} __attribute__ ((packed));
struct lpc_response_temp_sensor_get_readings {
uint32_t value;
} __attribute__ ((packed));
#endif /* __CROS_EC_LPC_COMMANDS_H */
|
