2 * Copyright (C) 2013 Google, Inc
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * Expose an I2C passthrough to the ChromeOS EC.
12 #include <linux/module.h>
13 #include <linux/i2c.h>
14 #include <linux/mfd/cros_ec.h>
15 #include <linux/mfd/cros_ec_commands.h>
16 #include <linux/platform_device.h>
17 #include <linux/slab.h>
20 * struct ec_i2c_device - Driver data for I2C tunnel
24 * @ec: Pointer to EC device
25 * @remote_bus: The EC bus number we tunnel to on the other side.
26 * @request_buf: Buffer for transmitting data; we expect most transfers to fit.
27 * @response_buf: Buffer for receiving data; we expect most transfers to fit.
30 struct ec_i2c_device
{
32 struct i2c_adapter adap
;
33 struct cros_ec_device
*ec
;
42 * ec_i2c_count_message - Count bytes needed for ec_i2c_construct_message
44 * @i2c_msgs: The i2c messages to read
45 * @num: The number of i2c messages.
47 * Returns the number of bytes the messages will take up.
49 static int ec_i2c_count_message(const struct i2c_msg i2c_msgs
[], int num
)
54 size
= sizeof(struct ec_params_i2c_passthru
);
55 size
+= num
* sizeof(struct ec_params_i2c_passthru_msg
);
56 for (i
= 0; i
< num
; i
++)
57 if (!(i2c_msgs
[i
].flags
& I2C_M_RD
))
58 size
+= i2c_msgs
[i
].len
;
64 * ec_i2c_construct_message - construct a message to go to the EC
66 * This function effectively stuffs the standard i2c_msg format of Linux into
67 * a format that the EC understands.
69 * @buf: The buffer to fill. We assume that the buffer is big enough.
70 * @i2c_msgs: The i2c messages to read.
71 * @num: The number of i2c messages.
72 * @bus_num: The remote bus number we want to talk to.
74 * Returns 0 or a negative error number.
76 static int ec_i2c_construct_message(u8
*buf
, const struct i2c_msg i2c_msgs
[],
79 struct ec_params_i2c_passthru
*params
;
83 out_data
= buf
+ sizeof(struct ec_params_i2c_passthru
) +
84 num
* sizeof(struct ec_params_i2c_passthru_msg
);
86 params
= (struct ec_params_i2c_passthru
*)buf
;
87 params
->port
= bus_num
;
88 params
->num_msgs
= num
;
89 for (i
= 0; i
< num
; i
++) {
90 const struct i2c_msg
*i2c_msg
= &i2c_msgs
[i
];
91 struct ec_params_i2c_passthru_msg
*msg
= ¶ms
->msg
[i
];
93 msg
->len
= i2c_msg
->len
;
94 msg
->addr_flags
= i2c_msg
->addr
;
96 if (i2c_msg
->flags
& I2C_M_TEN
)
97 msg
->addr_flags
|= EC_I2C_FLAG_10BIT
;
99 if (i2c_msg
->flags
& I2C_M_RD
) {
100 msg
->addr_flags
|= EC_I2C_FLAG_READ
;
102 memcpy(out_data
, i2c_msg
->buf
, msg
->len
);
103 out_data
+= msg
->len
;
111 * ec_i2c_count_response - Count bytes needed for ec_i2c_parse_response
113 * @i2c_msgs: The i2c messages to to fill up.
114 * @num: The number of i2c messages expected.
116 * Returns the number of response bytes expeced.
118 static int ec_i2c_count_response(struct i2c_msg i2c_msgs
[], int num
)
123 size
= sizeof(struct ec_response_i2c_passthru
);
124 for (i
= 0; i
< num
; i
++)
125 if (i2c_msgs
[i
].flags
& I2C_M_RD
)
126 size
+= i2c_msgs
[i
].len
;
132 * ec_i2c_parse_response - Parse a response from the EC
134 * We'll take the EC's response and copy it back into msgs.
136 * @buf: The buffer to parse.
137 * @i2c_msgs: The i2c messages to to fill up.
138 * @num: The number of i2c messages; will be modified to include the actual
141 * Returns 0 or a negative error number.
143 static int ec_i2c_parse_response(const u8
*buf
, struct i2c_msg i2c_msgs
[],
146 const struct ec_response_i2c_passthru
*resp
;
150 in_data
= buf
+ sizeof(struct ec_response_i2c_passthru
);
152 resp
= (const struct ec_response_i2c_passthru
*)buf
;
153 if (resp
->i2c_status
& EC_I2C_STATUS_TIMEOUT
)
155 else if (resp
->i2c_status
& EC_I2C_STATUS_ERROR
)
158 /* Other side could send us back fewer messages, but not more */
159 if (resp
->num_msgs
> *num
)
161 *num
= resp
->num_msgs
;
163 for (i
= 0; i
< *num
; i
++) {
164 struct i2c_msg
*i2c_msg
= &i2c_msgs
[i
];
166 if (i2c_msgs
[i
].flags
& I2C_M_RD
) {
167 memcpy(i2c_msg
->buf
, in_data
, i2c_msg
->len
);
168 in_data
+= i2c_msg
->len
;
175 static int ec_i2c_xfer(struct i2c_adapter
*adap
, struct i2c_msg i2c_msgs
[],
178 struct ec_i2c_device
*bus
= adap
->algo_data
;
179 struct device
*dev
= bus
->dev
;
180 const u16 bus_num
= bus
->remote_bus
;
187 request_len
= ec_i2c_count_message(i2c_msgs
, num
);
188 if (request_len
< 0) {
189 dev_warn(dev
, "Error constructing message %d\n", request_len
);
190 result
= request_len
;
193 response_len
= ec_i2c_count_response(i2c_msgs
, num
);
194 if (response_len
< 0) {
195 /* Unexpected; no errors should come when NULL response */
196 dev_warn(dev
, "Error preparing response %d\n", response_len
);
197 result
= response_len
;
201 if (request_len
<= ARRAY_SIZE(bus
->request_buf
)) {
202 request
= bus
->request_buf
;
204 request
= kzalloc(request_len
, GFP_KERNEL
);
205 if (request
== NULL
) {
210 if (response_len
<= ARRAY_SIZE(bus
->response_buf
)) {
211 response
= bus
->response_buf
;
213 response
= kzalloc(response_len
, GFP_KERNEL
);
214 if (response
== NULL
) {
220 ec_i2c_construct_message(request
, i2c_msgs
, num
, bus_num
);
221 result
= bus
->ec
->command_sendrecv(bus
->ec
, EC_CMD_I2C_PASSTHRU
,
222 request
, request_len
,
223 response
, response_len
);
227 result
= ec_i2c_parse_response(response
, i2c_msgs
, &num
);
231 /* Indicate success by saying how many messages were sent */
234 if (request
!= bus
->request_buf
)
236 if (response
!= bus
->response_buf
)
242 static u32
ec_i2c_functionality(struct i2c_adapter
*adap
)
244 return I2C_FUNC_I2C
| I2C_FUNC_SMBUS_EMUL
;
247 static const struct i2c_algorithm ec_i2c_algorithm
= {
248 .master_xfer
= ec_i2c_xfer
,
249 .functionality
= ec_i2c_functionality
,
252 static int ec_i2c_probe(struct platform_device
*pdev
)
254 struct device_node
*np
= pdev
->dev
.of_node
;
255 struct cros_ec_device
*ec
= dev_get_drvdata(pdev
->dev
.parent
);
256 struct device
*dev
= &pdev
->dev
;
257 struct ec_i2c_device
*bus
= NULL
;
261 if (!ec
->command_sendrecv
) {
262 dev_err(dev
, "Missing sendrecv\n");
266 bus
= devm_kzalloc(dev
, sizeof(*bus
), GFP_KERNEL
);
270 err
= of_property_read_u32(np
, "google,remote-bus", &remote_bus
);
272 dev_err(dev
, "Couldn't read remote-bus property\n");
275 bus
->remote_bus
= remote_bus
;
280 bus
->adap
.owner
= THIS_MODULE
;
281 strlcpy(bus
->adap
.name
, "cros-ec-i2c-tunnel", sizeof(bus
->adap
.name
));
282 bus
->adap
.algo
= &ec_i2c_algorithm
;
283 bus
->adap
.algo_data
= bus
;
284 bus
->adap
.dev
.parent
= &pdev
->dev
;
285 bus
->adap
.dev
.of_node
= np
;
287 err
= i2c_add_adapter(&bus
->adap
);
289 dev_err(dev
, "cannot register i2c adapter\n");
292 platform_set_drvdata(pdev
, bus
);
297 static int ec_i2c_remove(struct platform_device
*dev
)
299 struct ec_i2c_device
*bus
= platform_get_drvdata(dev
);
301 i2c_del_adapter(&bus
->adap
);
306 static struct platform_driver ec_i2c_tunnel_driver
= {
307 .probe
= ec_i2c_probe
,
308 .remove
= ec_i2c_remove
,
310 .name
= "cros-ec-i2c-tunnel",
314 module_platform_driver(ec_i2c_tunnel_driver
);
316 MODULE_LICENSE("GPL");
317 MODULE_DESCRIPTION("EC I2C tunnel driver");
318 MODULE_ALIAS("platform:cros-ec-i2c-tunnel");