i2c: i801: Add Device IDs for Intel Sunrise Point PCH
[sfrench/cifs-2.6.git] / drivers / i2c / busses / i2c-cros-ec-tunnel.c
1 /*
2  *  Copyright (C) 2013 Google, Inc
3  *
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.
8  *
9  * Expose an I2C passthrough to the ChromeOS EC.
10  */
11
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>
18
19 /**
20  * struct ec_i2c_device - Driver data for I2C tunnel
21  *
22  * @dev: Device node
23  * @adap: I2C adapter
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.
28  */
29
30 struct ec_i2c_device {
31         struct device *dev;
32         struct i2c_adapter adap;
33         struct cros_ec_device *ec;
34
35         u16 remote_bus;
36
37         u8 request_buf[256];
38         u8 response_buf[256];
39 };
40
41 /**
42  * ec_i2c_count_message - Count bytes needed for ec_i2c_construct_message
43  *
44  * @i2c_msgs: The i2c messages to read
45  * @num: The number of i2c messages.
46  *
47  * Returns the number of bytes the messages will take up.
48  */
49 static int ec_i2c_count_message(const struct i2c_msg i2c_msgs[], int num)
50 {
51         int i;
52         int size;
53
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;
59
60         return size;
61 }
62
63 /**
64  * ec_i2c_construct_message - construct a message to go to the EC
65  *
66  * This function effectively stuffs the standard i2c_msg format of Linux into
67  * a format that the EC understands.
68  *
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.
73  *
74  * Returns 0 or a negative error number.
75  */
76 static int ec_i2c_construct_message(u8 *buf, const struct i2c_msg i2c_msgs[],
77                                     int num, u16 bus_num)
78 {
79         struct ec_params_i2c_passthru *params;
80         u8 *out_data;
81         int i;
82
83         out_data = buf + sizeof(struct ec_params_i2c_passthru) +
84                    num * sizeof(struct ec_params_i2c_passthru_msg);
85
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 = &params->msg[i];
92
93                 msg->len = i2c_msg->len;
94                 msg->addr_flags = i2c_msg->addr;
95
96                 if (i2c_msg->flags & I2C_M_TEN)
97                         return -EINVAL;
98
99                 if (i2c_msg->flags & I2C_M_RD) {
100                         msg->addr_flags |= EC_I2C_FLAG_READ;
101                 } else {
102                         memcpy(out_data, i2c_msg->buf, msg->len);
103                         out_data += msg->len;
104                 }
105         }
106
107         return 0;
108 }
109
110 /**
111  * ec_i2c_count_response - Count bytes needed for ec_i2c_parse_response
112  *
113  * @i2c_msgs: The i2c messages to to fill up.
114  * @num: The number of i2c messages expected.
115  *
116  * Returns the number of response bytes expeced.
117  */
118 static int ec_i2c_count_response(struct i2c_msg i2c_msgs[], int num)
119 {
120         int size;
121         int i;
122
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;
127
128         return size;
129 }
130
131 /**
132  * ec_i2c_parse_response - Parse a response from the EC
133  *
134  * We'll take the EC's response and copy it back into msgs.
135  *
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
139  *       number received.
140  *
141  * Returns 0 or a negative error number.
142  */
143 static int ec_i2c_parse_response(const u8 *buf, struct i2c_msg i2c_msgs[],
144                                  int *num)
145 {
146         const struct ec_response_i2c_passthru *resp;
147         const u8 *in_data;
148         int i;
149
150         in_data = buf + sizeof(struct ec_response_i2c_passthru);
151
152         resp = (const struct ec_response_i2c_passthru *)buf;
153         if (resp->i2c_status & EC_I2C_STATUS_TIMEOUT)
154                 return -ETIMEDOUT;
155         else if (resp->i2c_status & EC_I2C_STATUS_ERROR)
156                 return -EREMOTEIO;
157
158         /* Other side could send us back fewer messages, but not more */
159         if (resp->num_msgs > *num)
160                 return -EPROTO;
161         *num = resp->num_msgs;
162
163         for (i = 0; i < *num; i++) {
164                 struct i2c_msg *i2c_msg = &i2c_msgs[i];
165
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;
169                 }
170         }
171
172         return 0;
173 }
174
175 static int ec_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg i2c_msgs[],
176                        int num)
177 {
178         struct ec_i2c_device *bus = adap->algo_data;
179         struct device *dev = bus->dev;
180         const u16 bus_num = bus->remote_bus;
181         int request_len;
182         int response_len;
183         u8 *request = NULL;
184         u8 *response = NULL;
185         int result;
186         struct cros_ec_command msg;
187
188         request_len = ec_i2c_count_message(i2c_msgs, num);
189         if (request_len < 0) {
190                 dev_warn(dev, "Error constructing message %d\n", request_len);
191                 result = request_len;
192                 goto exit;
193         }
194         response_len = ec_i2c_count_response(i2c_msgs, num);
195         if (response_len < 0) {
196                 /* Unexpected; no errors should come when NULL response */
197                 dev_warn(dev, "Error preparing response %d\n", response_len);
198                 result = response_len;
199                 goto exit;
200         }
201
202         if (request_len <= ARRAY_SIZE(bus->request_buf)) {
203                 request = bus->request_buf;
204         } else {
205                 request = kzalloc(request_len, GFP_KERNEL);
206                 if (request == NULL) {
207                         result = -ENOMEM;
208                         goto exit;
209                 }
210         }
211         if (response_len <= ARRAY_SIZE(bus->response_buf)) {
212                 response = bus->response_buf;
213         } else {
214                 response = kzalloc(response_len, GFP_KERNEL);
215                 if (response == NULL) {
216                         result = -ENOMEM;
217                         goto exit;
218                 }
219         }
220
221         result = ec_i2c_construct_message(request, i2c_msgs, num, bus_num);
222         if (result)
223                 goto exit;
224
225         msg.version = 0;
226         msg.command = EC_CMD_I2C_PASSTHRU;
227         msg.outdata = request;
228         msg.outsize = request_len;
229         msg.indata = response;
230         msg.insize = response_len;
231
232         result = bus->ec->cmd_xfer(bus->ec, &msg);
233         if (result < 0)
234                 goto exit;
235
236         result = ec_i2c_parse_response(response, i2c_msgs, &num);
237         if (result < 0)
238                 goto exit;
239
240         /* Indicate success by saying how many messages were sent */
241         result = num;
242 exit:
243         if (request != bus->request_buf)
244                 kfree(request);
245         if (response != bus->response_buf)
246                 kfree(response);
247
248         return result;
249 }
250
251 static u32 ec_i2c_functionality(struct i2c_adapter *adap)
252 {
253         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
254 }
255
256 static const struct i2c_algorithm ec_i2c_algorithm = {
257         .master_xfer    = ec_i2c_xfer,
258         .functionality  = ec_i2c_functionality,
259 };
260
261 static int ec_i2c_probe(struct platform_device *pdev)
262 {
263         struct device_node *np = pdev->dev.of_node;
264         struct cros_ec_device *ec = dev_get_drvdata(pdev->dev.parent);
265         struct device *dev = &pdev->dev;
266         struct ec_i2c_device *bus = NULL;
267         u32 remote_bus;
268         int err;
269
270         if (!ec->cmd_xfer) {
271                 dev_err(dev, "Missing sendrecv\n");
272                 return -EINVAL;
273         }
274
275         bus = devm_kzalloc(dev, sizeof(*bus), GFP_KERNEL);
276         if (bus == NULL)
277                 return -ENOMEM;
278
279         err = of_property_read_u32(np, "google,remote-bus", &remote_bus);
280         if (err) {
281                 dev_err(dev, "Couldn't read remote-bus property\n");
282                 return err;
283         }
284         bus->remote_bus = remote_bus;
285
286         bus->ec = ec;
287         bus->dev = dev;
288
289         bus->adap.owner = THIS_MODULE;
290         strlcpy(bus->adap.name, "cros-ec-i2c-tunnel", sizeof(bus->adap.name));
291         bus->adap.algo = &ec_i2c_algorithm;
292         bus->adap.algo_data = bus;
293         bus->adap.dev.parent = &pdev->dev;
294         bus->adap.dev.of_node = np;
295
296         err = i2c_add_adapter(&bus->adap);
297         if (err) {
298                 dev_err(dev, "cannot register i2c adapter\n");
299                 return err;
300         }
301         platform_set_drvdata(pdev, bus);
302
303         return err;
304 }
305
306 static int ec_i2c_remove(struct platform_device *dev)
307 {
308         struct ec_i2c_device *bus = platform_get_drvdata(dev);
309
310         i2c_del_adapter(&bus->adap);
311
312         return 0;
313 }
314
315 #ifdef CONFIG_OF
316 static const struct of_device_id cros_ec_i2c_of_match[] = {
317         { .compatible = "google,cros-ec-i2c-tunnel" },
318         {},
319 };
320 MODULE_DEVICE_TABLE(of, cros_ec_i2c_of_match);
321 #endif
322
323 static struct platform_driver ec_i2c_tunnel_driver = {
324         .probe = ec_i2c_probe,
325         .remove = ec_i2c_remove,
326         .driver = {
327                 .name = "cros-ec-i2c-tunnel",
328                 .of_match_table = of_match_ptr(cros_ec_i2c_of_match),
329         },
330 };
331
332 module_platform_driver(ec_i2c_tunnel_driver);
333
334 MODULE_LICENSE("GPL");
335 MODULE_DESCRIPTION("EC I2C tunnel driver");
336 MODULE_ALIAS("platform:cros-ec-i2c-tunnel");