blob: ff865b3b4825eefa7899a6397bc65b18e81a950b [file] [log] [blame]
Alex Elder30c6d9d2015-05-22 13:02:08 -05001/*
2 * SVC Greybus driver.
3 *
4 * Copyright 2015 Google Inc.
5 * Copyright 2015 Linaro Ltd.
6 *
7 * Released under the GPLv2 only.
8 */
9
Viresh Kumar067906f2015-08-06 12:44:55 +053010#include <linux/workqueue.h>
Alex Elder30c6d9d2015-05-22 13:02:08 -050011
Viresh Kumarf66427a2015-09-02 21:27:13 +053012#include "greybus.h"
13
Johan Hovoldf6c6c132015-11-11 10:07:08 +010014#define CPORT_FLAGS_E2EFC BIT(0)
15#define CPORT_FLAGS_CSD_N BIT(1)
16#define CPORT_FLAGS_CSV_N BIT(2)
Perry Hung0b226492015-07-24 19:02:34 -040017
Viresh Kumarb45864d2015-07-24 15:32:21 +053018
Johan Hovold9ae41092015-12-02 18:23:29 +010019struct gb_svc_deferred_request {
Viresh Kumar067906f2015-08-06 12:44:55 +053020 struct work_struct work;
Johan Hovold9ae41092015-12-02 18:23:29 +010021 struct gb_operation *operation;
Viresh Kumar067906f2015-08-06 12:44:55 +053022};
23
Viresh Kumaread35462015-07-21 17:44:19 +053024
Johan Hovold66069fb2015-11-25 15:59:09 +010025static ssize_t endo_id_show(struct device *dev,
26 struct device_attribute *attr, char *buf)
27{
28 struct gb_svc *svc = to_gb_svc(dev);
29
30 return sprintf(buf, "0x%04x\n", svc->endo_id);
31}
32static DEVICE_ATTR_RO(endo_id);
33
34static ssize_t ap_intf_id_show(struct device *dev,
35 struct device_attribute *attr, char *buf)
36{
37 struct gb_svc *svc = to_gb_svc(dev);
38
39 return sprintf(buf, "%u\n", svc->ap_intf_id);
40}
41static DEVICE_ATTR_RO(ap_intf_id);
42
43static struct attribute *svc_attrs[] = {
44 &dev_attr_endo_id.attr,
45 &dev_attr_ap_intf_id.attr,
46 NULL,
47};
48ATTRIBUTE_GROUPS(svc);
49
Viresh Kumar505f16c2015-08-31 17:21:07 +053050static int gb_svc_intf_device_id(struct gb_svc *svc, u8 intf_id, u8 device_id)
Alex Elder30c6d9d2015-05-22 13:02:08 -050051{
52 struct gb_svc_intf_device_id_request request;
53
54 request.intf_id = intf_id;
55 request.device_id = device_id;
56
57 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_DEVICE_ID,
58 &request, sizeof(request), NULL, 0);
59}
60
Viresh Kumar3f0e9182015-08-31 17:21:06 +053061int gb_svc_intf_reset(struct gb_svc *svc, u8 intf_id)
Alex Elder30c6d9d2015-05-22 13:02:08 -050062{
63 struct gb_svc_intf_reset_request request;
64
65 request.intf_id = intf_id;
66
67 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_RESET,
68 &request, sizeof(request), NULL, 0);
69}
Viresh Kumar3f0e9182015-08-31 17:21:06 +053070EXPORT_SYMBOL_GPL(gb_svc_intf_reset);
Alex Elder30c6d9d2015-05-22 13:02:08 -050071
Viresh Kumar19151c32015-09-09 21:08:29 +053072int gb_svc_dme_peer_get(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
73 u32 *value)
74{
75 struct gb_svc_dme_peer_get_request request;
76 struct gb_svc_dme_peer_get_response response;
77 u16 result;
78 int ret;
79
80 request.intf_id = intf_id;
81 request.attr = cpu_to_le16(attr);
82 request.selector = cpu_to_le16(selector);
83
84 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_GET,
85 &request, sizeof(request),
86 &response, sizeof(response));
87 if (ret) {
Viresh Kumarb933fa42015-12-04 21:30:10 +053088 dev_err(&svc->dev, "failed to get DME attribute (%u 0x%04x %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +010089 intf_id, attr, selector, ret);
Viresh Kumar19151c32015-09-09 21:08:29 +053090 return ret;
91 }
92
93 result = le16_to_cpu(response.result_code);
94 if (result) {
Viresh Kumarb933fa42015-12-04 21:30:10 +053095 dev_err(&svc->dev, "UniPro error while getting DME attribute (%u 0x%04x %u): %u\n",
Johan Hovold684156a2015-11-25 15:59:19 +010096 intf_id, attr, selector, result);
Viresh Kumar4aac6c52015-12-04 21:30:08 +053097 return -EIO;
Viresh Kumar19151c32015-09-09 21:08:29 +053098 }
99
100 if (value)
101 *value = le32_to_cpu(response.attr_value);
102
103 return 0;
104}
105EXPORT_SYMBOL_GPL(gb_svc_dme_peer_get);
106
107int gb_svc_dme_peer_set(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
108 u32 value)
109{
110 struct gb_svc_dme_peer_set_request request;
111 struct gb_svc_dme_peer_set_response response;
112 u16 result;
113 int ret;
114
115 request.intf_id = intf_id;
116 request.attr = cpu_to_le16(attr);
117 request.selector = cpu_to_le16(selector);
118 request.value = cpu_to_le32(value);
119
120 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_SET,
121 &request, sizeof(request),
122 &response, sizeof(response));
123 if (ret) {
Viresh Kumarb933fa42015-12-04 21:30:10 +0530124 dev_err(&svc->dev, "failed to set DME attribute (%u 0x%04x %u %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100125 intf_id, attr, selector, value, ret);
Viresh Kumar19151c32015-09-09 21:08:29 +0530126 return ret;
127 }
128
129 result = le16_to_cpu(response.result_code);
130 if (result) {
Viresh Kumarb933fa42015-12-04 21:30:10 +0530131 dev_err(&svc->dev, "UniPro error while setting DME attribute (%u 0x%04x %u %u): %u\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100132 intf_id, attr, selector, value, result);
Viresh Kumar4aac6c52015-12-04 21:30:08 +0530133 return -EIO;
Viresh Kumar19151c32015-09-09 21:08:29 +0530134 }
135
136 return 0;
137}
138EXPORT_SYMBOL_GPL(gb_svc_dme_peer_set);
139
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700140/*
141 * T_TstSrcIncrement is written by the module on ES2 as a stand-in for boot
142 * status attribute. AP needs to read and clear it, after reading a non-zero
143 * value from it.
144 *
145 * FIXME: This is module-hardware dependent and needs to be extended for every
146 * type of module we want to support.
147 */
148static int gb_svc_read_and_clear_module_boot_status(struct gb_interface *intf)
149{
Johan Hovold25376362015-11-03 18:03:23 +0100150 struct gb_host_device *hd = intf->hd;
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700151 int ret;
152 u32 value;
153
154 /* Read and clear boot status in T_TstSrcIncrement */
155 ret = gb_svc_dme_peer_get(hd->svc, intf->interface_id,
156 DME_ATTR_T_TST_SRC_INCREMENT,
157 DME_ATTR_SELECTOR_INDEX, &value);
158
159 if (ret)
160 return ret;
161
162 /*
163 * A nonzero boot status indicates the module has finished
164 * booting. Clear it.
165 */
166 if (!value) {
167 dev_err(&intf->dev, "Module not ready yet\n");
168 return -ENODEV;
169 }
170
Viresh Kumar1575ef12015-10-07 15:40:24 -0400171 /*
172 * Check if the module needs to boot from unipro.
173 * For ES2: We need to check lowest 8 bits of 'value'.
174 * For ES3: We need to check highest 8 bits out of 32 of 'value'.
175 *
176 * FIXME: Add code to find if we are on ES2 or ES3 to have separate
177 * checks.
178 */
179 if (value == DME_TSI_UNIPRO_BOOT_STARTED ||
180 value == DME_TSI_FALLBACK_UNIPRO_BOOT_STARTED)
181 intf->boot_over_unipro = true;
182
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700183 return gb_svc_dme_peer_set(hd->svc, intf->interface_id,
184 DME_ATTR_T_TST_SRC_INCREMENT,
185 DME_ATTR_SELECTOR_INDEX, 0);
186}
187
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530188int gb_svc_connection_create(struct gb_svc *svc,
Alex Elder30c6d9d2015-05-22 13:02:08 -0500189 u8 intf1_id, u16 cport1_id,
Viresh Kumar1575ef12015-10-07 15:40:24 -0400190 u8 intf2_id, u16 cport2_id,
191 bool boot_over_unipro)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500192{
193 struct gb_svc_conn_create_request request;
194
195 request.intf1_id = intf1_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100196 request.cport1_id = cpu_to_le16(cport1_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500197 request.intf2_id = intf2_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100198 request.cport2_id = cpu_to_le16(cport2_id);
Perry Hung0b226492015-07-24 19:02:34 -0400199 /*
200 * XXX: fix connections paramaters to TC0 and all CPort flags
201 * for now.
202 */
203 request.tc = 0;
Viresh Kumar1575ef12015-10-07 15:40:24 -0400204
205 /*
206 * We need to skip setting E2EFC and other flags to the connection
207 * create request, for all cports, on an interface that need to boot
208 * over unipro, i.e. interfaces required to download firmware.
209 */
210 if (boot_over_unipro)
211 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_CSD_N;
212 else
213 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_E2EFC;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500214
215 return gb_operation_sync(svc->connection, GB_SVC_TYPE_CONN_CREATE,
216 &request, sizeof(request), NULL, 0);
217}
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530218EXPORT_SYMBOL_GPL(gb_svc_connection_create);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500219
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530220void gb_svc_connection_destroy(struct gb_svc *svc, u8 intf1_id, u16 cport1_id,
221 u8 intf2_id, u16 cport2_id)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500222{
223 struct gb_svc_conn_destroy_request request;
Viresh Kumard9fcfff2015-08-31 17:21:05 +0530224 struct gb_connection *connection = svc->connection;
225 int ret;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500226
227 request.intf1_id = intf1_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100228 request.cport1_id = cpu_to_le16(cport1_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500229 request.intf2_id = intf2_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100230 request.cport2_id = cpu_to_le16(cport2_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500231
Viresh Kumard9fcfff2015-08-31 17:21:05 +0530232 ret = gb_operation_sync(connection, GB_SVC_TYPE_CONN_DESTROY,
233 &request, sizeof(request), NULL, 0);
Johan Hovold684156a2015-11-25 15:59:19 +0100234 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530235 dev_err(&svc->dev, "failed to destroy connection (%u:%u %u:%u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100236 intf1_id, cport1_id, intf2_id, cport2_id, ret);
237 }
Alex Elder30c6d9d2015-05-22 13:02:08 -0500238}
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530239EXPORT_SYMBOL_GPL(gb_svc_connection_destroy);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500240
Viresh Kumarbb106852015-09-07 16:01:25 +0530241/* Creates bi-directional routes between the devices */
Viresh Kumar505f16c2015-08-31 17:21:07 +0530242static int gb_svc_route_create(struct gb_svc *svc, u8 intf1_id, u8 dev1_id,
243 u8 intf2_id, u8 dev2_id)
Perry Hunge08aaa42015-07-24 19:02:31 -0400244{
245 struct gb_svc_route_create_request request;
246
247 request.intf1_id = intf1_id;
248 request.dev1_id = dev1_id;
249 request.intf2_id = intf2_id;
250 request.dev2_id = dev2_id;
251
252 return gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_CREATE,
253 &request, sizeof(request), NULL, 0);
254}
Perry Hunge08aaa42015-07-24 19:02:31 -0400255
Viresh Kumar0a020572015-09-07 18:05:26 +0530256/* Destroys bi-directional routes between the devices */
257static void gb_svc_route_destroy(struct gb_svc *svc, u8 intf1_id, u8 intf2_id)
258{
259 struct gb_svc_route_destroy_request request;
260 int ret;
261
262 request.intf1_id = intf1_id;
263 request.intf2_id = intf2_id;
264
265 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_DESTROY,
266 &request, sizeof(request), NULL, 0);
Johan Hovold684156a2015-11-25 15:59:19 +0100267 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530268 dev_err(&svc->dev, "failed to destroy route (%u %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100269 intf1_id, intf2_id, ret);
270 }
Viresh Kumar0a020572015-09-07 18:05:26 +0530271}
272
Laurent Pinchart784f8762015-12-18 21:23:22 +0200273/* Creates bi-directional routes between the devices */
274int gb_svc_link_config(struct gb_svc *svc, u8 intf_id,
275 unsigned int burst, unsigned int gear,
276 unsigned int nlanes, unsigned int flags)
277{
278 struct gb_svc_link_config_request request;
279
280 request.intf_id = intf_id;
281 request.burst = burst;
282 request.gear = gear;
283 request.nlanes = nlanes;
284 request.flags = flags;
285
286 return gb_operation_sync(svc->connection, GB_SVC_TYPE_LINK_CONFIG,
287 &request, sizeof(request), NULL, 0);
288}
289EXPORT_SYMBOL_GPL(gb_svc_link_config);
290
Viresh Kumaread35462015-07-21 17:44:19 +0530291static int gb_svc_version_request(struct gb_operation *op)
292{
293 struct gb_connection *connection = op->connection;
Johan Hovold684156a2015-11-25 15:59:19 +0100294 struct gb_svc *svc = connection->private;
Johan Hovoldcfb16902015-09-15 10:48:01 +0200295 struct gb_protocol_version_request *request;
296 struct gb_protocol_version_response *response;
Viresh Kumaread35462015-07-21 17:44:19 +0530297
Johan Hovold55510842015-11-19 18:28:01 +0100298 if (op->request->payload_size < sizeof(*request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100299 dev_err(&svc->dev, "short version request (%zu < %zu)\n",
Johan Hovold55510842015-11-19 18:28:01 +0100300 op->request->payload_size,
301 sizeof(*request));
302 return -EINVAL;
303 }
304
Johan Hovoldcfb16902015-09-15 10:48:01 +0200305 request = op->request->payload;
Viresh Kumaread35462015-07-21 17:44:19 +0530306
Johan Hovoldcfb16902015-09-15 10:48:01 +0200307 if (request->major > GB_SVC_VERSION_MAJOR) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530308 dev_warn(&svc->dev, "unsupported major version (%u > %u)\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100309 request->major, GB_SVC_VERSION_MAJOR);
Viresh Kumaread35462015-07-21 17:44:19 +0530310 return -ENOTSUPP;
311 }
312
Johan Hovoldcfb16902015-09-15 10:48:01 +0200313 connection->module_major = request->major;
314 connection->module_minor = request->minor;
Viresh Kumar3ea959e32015-08-11 07:36:14 +0530315
Johan Hovold684156a2015-11-25 15:59:19 +0100316 if (!gb_operation_response_alloc(op, sizeof(*response), GFP_KERNEL))
Viresh Kumaread35462015-07-21 17:44:19 +0530317 return -ENOMEM;
Viresh Kumaread35462015-07-21 17:44:19 +0530318
Johan Hovoldcfb16902015-09-15 10:48:01 +0200319 response = op->response->payload;
320 response->major = connection->module_major;
321 response->minor = connection->module_minor;
Johan Hovold59832932015-09-15 10:48:00 +0200322
Viresh Kumaread35462015-07-21 17:44:19 +0530323 return 0;
324}
325
326static int gb_svc_hello(struct gb_operation *op)
327{
328 struct gb_connection *connection = op->connection;
Johan Hovold88f7b962015-11-25 15:59:08 +0100329 struct gb_svc *svc = connection->private;
Viresh Kumaread35462015-07-21 17:44:19 +0530330 struct gb_svc_hello_request *hello_request;
Viresh Kumaread35462015-07-21 17:44:19 +0530331 int ret;
332
Viresh Kumar0c32d2a2015-08-11 07:29:19 +0530333 if (op->request->payload_size < sizeof(*hello_request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100334 dev_warn(&svc->dev, "short hello request (%zu < %zu)\n",
335 op->request->payload_size,
336 sizeof(*hello_request));
Viresh Kumaread35462015-07-21 17:44:19 +0530337 return -EINVAL;
338 }
339
340 hello_request = op->request->payload;
Johan Hovold66069fb2015-11-25 15:59:09 +0100341 svc->endo_id = le16_to_cpu(hello_request->endo_id);
342 svc->ap_intf_id = hello_request->interface_id;
Viresh Kumaread35462015-07-21 17:44:19 +0530343
Johan Hovold88f7b962015-11-25 15:59:08 +0100344 ret = device_add(&svc->dev);
345 if (ret) {
346 dev_err(&svc->dev, "failed to register svc device: %d\n", ret);
347 return ret;
348 }
349
Viresh Kumaread35462015-07-21 17:44:19 +0530350 return 0;
351}
352
Johan Hovoldb4ee82e2015-12-02 18:23:28 +0100353static void gb_svc_intf_remove(struct gb_svc *svc, struct gb_interface *intf)
Viresh Kumarbbaca712015-09-23 16:48:08 -0700354{
Viresh Kumarbbaca712015-09-23 16:48:08 -0700355 u8 intf_id = intf->interface_id;
Johan Hovold141af4f2015-12-15 15:28:57 +0100356 u8 device_id = intf->device_id;
Viresh Kumarbbaca712015-09-23 16:48:08 -0700357
Johan Hovold141af4f2015-12-15 15:28:57 +0100358 intf->disconnected = true;
359
Viresh Kumar80d1ede2015-09-23 16:48:10 -0700360 gb_interface_remove(intf);
Viresh Kumarbbaca712015-09-23 16:48:08 -0700361
362 /*
363 * Destroy the two-way route between the AP and the interface.
364 */
Johan Hovold66069fb2015-11-25 15:59:09 +0100365 gb_svc_route_destroy(svc, svc->ap_intf_id, intf_id);
Viresh Kumarbbaca712015-09-23 16:48:08 -0700366
367 ida_simple_remove(&svc->device_id_map, device_id);
368}
369
Johan Hovold9ae41092015-12-02 18:23:29 +0100370static void gb_svc_process_intf_hotplug(struct gb_operation *operation)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500371{
Johan Hovold24456a092015-12-02 18:23:27 +0100372 struct gb_svc_intf_hotplug_request *request;
Johan Hovold9ae41092015-12-02 18:23:29 +0100373 struct gb_connection *connection = operation->connection;
Viresh Kumar067906f2015-08-06 12:44:55 +0530374 struct gb_svc *svc = connection->private;
Johan Hovold25376362015-11-03 18:03:23 +0100375 struct gb_host_device *hd = connection->hd;
Viresh Kumaread35462015-07-21 17:44:19 +0530376 struct gb_interface *intf;
377 u8 intf_id, device_id;
Viresh Kumaread35462015-07-21 17:44:19 +0530378 int ret;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500379
Johan Hovold24456a092015-12-02 18:23:27 +0100380 /* The request message size has already been verified. */
Johan Hovold9ae41092015-12-02 18:23:29 +0100381 request = operation->request->payload;
Johan Hovold24456a092015-12-02 18:23:27 +0100382 intf_id = request->intf_id;
383
384 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, intf_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500385
Viresh Kumarbbaca712015-09-23 16:48:08 -0700386 intf = gb_interface_find(hd, intf_id);
387 if (intf) {
388 /*
389 * We have received a hotplug request for an interface that
390 * already exists.
391 *
392 * This can happen in cases like:
393 * - bootrom loading the firmware image and booting into that,
394 * which only generates a hotplug event. i.e. no hot-unplug
395 * event.
396 * - Or the firmware on the module crashed and sent hotplug
397 * request again to the SVC, which got propagated to AP.
398 *
399 * Remove the interface and add it again, and let user know
400 * about this with a print message.
401 */
Viresh Kumar2f3db922015-12-04 21:30:09 +0530402 dev_info(&svc->dev, "removing interface %u to add it again\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100403 intf_id);
Johan Hovoldb4ee82e2015-12-02 18:23:28 +0100404 gb_svc_intf_remove(svc, intf);
Viresh Kumarbbaca712015-09-23 16:48:08 -0700405 }
406
Viresh Kumaread35462015-07-21 17:44:19 +0530407 intf = gb_interface_create(hd, intf_id);
408 if (!intf) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530409 dev_err(&svc->dev, "failed to create interface %u\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100410 intf_id);
Johan Hovold9ae41092015-12-02 18:23:29 +0100411 return;
Viresh Kumaread35462015-07-21 17:44:19 +0530412 }
413
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700414 ret = gb_svc_read_and_clear_module_boot_status(intf);
Johan Hovoldb395754a2015-12-07 15:05:28 +0100415 if (ret) {
416 dev_err(&svc->dev, "failed to clear boot status of interface %u: %d\n",
417 intf_id, ret);
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700418 goto destroy_interface;
Johan Hovoldb395754a2015-12-07 15:05:28 +0100419 }
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700420
Johan Hovold24456a092015-12-02 18:23:27 +0100421 intf->unipro_mfg_id = le32_to_cpu(request->data.unipro_mfg_id);
422 intf->unipro_prod_id = le32_to_cpu(request->data.unipro_prod_id);
423 intf->vendor_id = le32_to_cpu(request->data.ara_vend_id);
424 intf->product_id = le32_to_cpu(request->data.ara_prod_id);
Viresh Kumar3944a452015-08-12 09:19:31 +0530425
Viresh Kumaread35462015-07-21 17:44:19 +0530426 /*
427 * Create a device id for the interface:
428 * - device id 0 (GB_DEVICE_ID_SVC) belongs to the SVC
429 * - device id 1 (GB_DEVICE_ID_AP) belongs to the AP
430 *
431 * XXX Do we need to allocate device ID for SVC or the AP here? And what
432 * XXX about an AP with multiple interface blocks?
433 */
Johan Hovoldc09db182015-09-15 09:18:08 +0200434 device_id = ida_simple_get(&svc->device_id_map,
Johan Hovold89f637f2015-09-01 12:25:25 +0200435 GB_DEVICE_ID_MODULES_START, 0, GFP_KERNEL);
Viresh Kumaread35462015-07-21 17:44:19 +0530436 if (device_id < 0) {
437 ret = device_id;
Viresh Kumar2f3db922015-12-04 21:30:09 +0530438 dev_err(&svc->dev, "failed to allocate device id for interface %u: %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100439 intf_id, ret);
Viresh Kumaread35462015-07-21 17:44:19 +0530440 goto destroy_interface;
441 }
442
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530443 ret = gb_svc_intf_device_id(svc, intf_id, device_id);
Viresh Kumaread35462015-07-21 17:44:19 +0530444 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530445 dev_err(&svc->dev, "failed to set device id %u for interface %u: %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100446 device_id, intf_id, ret);
Viresh Kumaread35462015-07-21 17:44:19 +0530447 goto ida_put;
448 }
449
Perry Hung7e275462015-07-24 19:02:32 -0400450 /*
451 * Create a two-way route between the AP and the new interface
452 */
Johan Hovold66069fb2015-11-25 15:59:09 +0100453 ret = gb_svc_route_create(svc, svc->ap_intf_id, GB_DEVICE_ID_AP,
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530454 intf_id, device_id);
Perry Hung7e275462015-07-24 19:02:32 -0400455 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530456 dev_err(&svc->dev, "failed to create route to interface %u (device id %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100457 intf_id, device_id, ret);
Viresh Kumar0a020572015-09-07 18:05:26 +0530458 goto svc_id_free;
Perry Hung7e275462015-07-24 19:02:32 -0400459 }
460
Viresh Kumaread35462015-07-21 17:44:19 +0530461 ret = gb_interface_init(intf, device_id);
462 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530463 dev_err(&svc->dev, "failed to initialize interface %u (device id %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100464 intf_id, device_id, ret);
Viresh Kumar0a020572015-09-07 18:05:26 +0530465 goto destroy_route;
Viresh Kumaread35462015-07-21 17:44:19 +0530466 }
Alex Elder30c6d9d2015-05-22 13:02:08 -0500467
Johan Hovold9ae41092015-12-02 18:23:29 +0100468 return;
Viresh Kumaread35462015-07-21 17:44:19 +0530469
Viresh Kumar0a020572015-09-07 18:05:26 +0530470destroy_route:
Johan Hovold66069fb2015-11-25 15:59:09 +0100471 gb_svc_route_destroy(svc, svc->ap_intf_id, intf_id);
Viresh Kumaread35462015-07-21 17:44:19 +0530472svc_id_free:
473 /*
474 * XXX Should we tell SVC that this id doesn't belong to interface
475 * XXX anymore.
476 */
477ida_put:
Johan Hovoldc09db182015-09-15 09:18:08 +0200478 ida_simple_remove(&svc->device_id_map, device_id);
Viresh Kumaread35462015-07-21 17:44:19 +0530479destroy_interface:
Viresh Kumar80d1ede2015-09-23 16:48:10 -0700480 gb_interface_remove(intf);
Johan Hovold9ae41092015-12-02 18:23:29 +0100481}
482
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100483static void gb_svc_process_intf_hot_unplug(struct gb_operation *operation)
484{
485 struct gb_svc *svc = operation->connection->private;
486 struct gb_svc_intf_hot_unplug_request *request;
487 struct gb_host_device *hd = operation->connection->hd;
488 struct gb_interface *intf;
489 u8 intf_id;
490
491 /* The request message size has already been verified. */
492 request = operation->request->payload;
493 intf_id = request->intf_id;
494
495 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, intf_id);
496
497 intf = gb_interface_find(hd, intf_id);
498 if (!intf) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530499 dev_warn(&svc->dev, "could not find hot-unplug interface %u\n",
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100500 intf_id);
501 return;
502 }
503
504 gb_svc_intf_remove(svc, intf);
505}
506
Johan Hovold9ae41092015-12-02 18:23:29 +0100507static void gb_svc_process_deferred_request(struct work_struct *work)
508{
509 struct gb_svc_deferred_request *dr;
510 struct gb_operation *operation;
511 struct gb_svc *svc;
512 u8 type;
513
514 dr = container_of(work, struct gb_svc_deferred_request, work);
515 operation = dr->operation;
516 svc = operation->connection->private;
517 type = operation->request->header->type;
518
519 switch (type) {
520 case GB_SVC_TYPE_INTF_HOTPLUG:
521 gb_svc_process_intf_hotplug(operation);
522 break;
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100523 case GB_SVC_TYPE_INTF_HOT_UNPLUG:
524 gb_svc_process_intf_hot_unplug(operation);
525 break;
Johan Hovold9ae41092015-12-02 18:23:29 +0100526 default:
Viresh Kumarb933fa42015-12-04 21:30:10 +0530527 dev_err(&svc->dev, "bad deferred request type: 0x%02x\n", type);
Johan Hovold9ae41092015-12-02 18:23:29 +0100528 }
529
530 gb_operation_put(operation);
531 kfree(dr);
532}
533
534static int gb_svc_queue_deferred_request(struct gb_operation *operation)
535{
Johan Hovold3e48aca2015-12-02 18:23:31 +0100536 struct gb_svc *svc = operation->connection->private;
Johan Hovold9ae41092015-12-02 18:23:29 +0100537 struct gb_svc_deferred_request *dr;
538
539 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
540 if (!dr)
541 return -ENOMEM;
542
543 gb_operation_get(operation);
544
545 dr->operation = operation;
546 INIT_WORK(&dr->work, gb_svc_process_deferred_request);
547
Johan Hovold3e48aca2015-12-02 18:23:31 +0100548 queue_work(svc->wq, &dr->work);
Johan Hovold9ae41092015-12-02 18:23:29 +0100549
550 return 0;
Viresh Kumar067906f2015-08-06 12:44:55 +0530551}
Viresh Kumaread35462015-07-21 17:44:19 +0530552
Viresh Kumar067906f2015-08-06 12:44:55 +0530553/*
554 * Bringing up a module can be time consuming, as that may require lots of
555 * initialization on the module side. Over that, we may also need to download
556 * the firmware first and flash that on the module.
557 *
Johan Hovold3e48aca2015-12-02 18:23:31 +0100558 * In order not to make other svc events wait for all this to finish,
Viresh Kumar067906f2015-08-06 12:44:55 +0530559 * handle most of module hotplug stuff outside of the hotplug callback, with
560 * help of a workqueue.
561 */
562static int gb_svc_intf_hotplug_recv(struct gb_operation *op)
563{
Johan Hovold684156a2015-11-25 15:59:19 +0100564 struct gb_svc *svc = op->connection->private;
Johan Hovoldd34a3642015-12-02 18:23:26 +0100565 struct gb_svc_intf_hotplug_request *request;
Viresh Kumar067906f2015-08-06 12:44:55 +0530566
Johan Hovoldd34a3642015-12-02 18:23:26 +0100567 if (op->request->payload_size < sizeof(*request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100568 dev_warn(&svc->dev, "short hotplug request received (%zu < %zu)\n",
Johan Hovoldd34a3642015-12-02 18:23:26 +0100569 op->request->payload_size, sizeof(*request));
Viresh Kumar067906f2015-08-06 12:44:55 +0530570 return -EINVAL;
571 }
572
Johan Hovoldd34a3642015-12-02 18:23:26 +0100573 request = op->request->payload;
574
575 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, request->intf_id);
576
Johan Hovold9ae41092015-12-02 18:23:29 +0100577 return gb_svc_queue_deferred_request(op);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500578}
579
580static int gb_svc_intf_hot_unplug_recv(struct gb_operation *op)
581{
Johan Hovold684156a2015-11-25 15:59:19 +0100582 struct gb_svc *svc = op->connection->private;
Johan Hovoldd34a3642015-12-02 18:23:26 +0100583 struct gb_svc_intf_hot_unplug_request *request;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500584
Johan Hovoldd34a3642015-12-02 18:23:26 +0100585 if (op->request->payload_size < sizeof(*request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100586 dev_warn(&svc->dev, "short hot unplug request received (%zu < %zu)\n",
Johan Hovoldd34a3642015-12-02 18:23:26 +0100587 op->request->payload_size, sizeof(*request));
Alex Elder30c6d9d2015-05-22 13:02:08 -0500588 return -EINVAL;
589 }
Alex Elder30c6d9d2015-05-22 13:02:08 -0500590
Johan Hovoldd34a3642015-12-02 18:23:26 +0100591 request = op->request->payload;
Johan Hovoldd34a3642015-12-02 18:23:26 +0100592
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100593 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, request->intf_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500594
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100595 return gb_svc_queue_deferred_request(op);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500596}
597
598static int gb_svc_intf_reset_recv(struct gb_operation *op)
599{
Johan Hovold684156a2015-11-25 15:59:19 +0100600 struct gb_svc *svc = op->connection->private;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500601 struct gb_message *request = op->request;
602 struct gb_svc_intf_reset_request *reset;
603 u8 intf_id;
604
605 if (request->payload_size < sizeof(*reset)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100606 dev_warn(&svc->dev, "short reset request received (%zu < %zu)\n",
607 request->payload_size, sizeof(*reset));
Alex Elder30c6d9d2015-05-22 13:02:08 -0500608 return -EINVAL;
609 }
610 reset = request->payload;
611
612 intf_id = reset->intf_id;
613
614 /* FIXME Reset the interface here */
615
616 return 0;
617}
618
619static int gb_svc_request_recv(u8 type, struct gb_operation *op)
620{
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530621 struct gb_connection *connection = op->connection;
622 struct gb_svc *svc = connection->private;
623 int ret = 0;
624
625 /*
626 * SVC requests need to follow a specific order (at least initially) and
627 * below code takes care of enforcing that. The expected order is:
628 * - PROTOCOL_VERSION
629 * - SVC_HELLO
630 * - Any other request, but the earlier two.
631 *
632 * Incoming requests are guaranteed to be serialized and so we don't
633 * need to protect 'state' for any races.
634 */
Alex Elder30c6d9d2015-05-22 13:02:08 -0500635 switch (type) {
Viresh Kumar0e2462d2015-08-14 07:57:38 +0530636 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530637 if (svc->state != GB_SVC_STATE_RESET)
638 ret = -EINVAL;
639 break;
Viresh Kumaread35462015-07-21 17:44:19 +0530640 case GB_SVC_TYPE_SVC_HELLO:
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530641 if (svc->state != GB_SVC_STATE_PROTOCOL_VERSION)
642 ret = -EINVAL;
643 break;
644 default:
645 if (svc->state != GB_SVC_STATE_SVC_HELLO)
646 ret = -EINVAL;
647 break;
648 }
649
650 if (ret) {
Johan Hovold684156a2015-11-25 15:59:19 +0100651 dev_warn(&svc->dev, "unexpected request 0x%02x received (state %u)\n",
652 type, svc->state);
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530653 return ret;
654 }
655
656 switch (type) {
657 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
658 ret = gb_svc_version_request(op);
659 if (!ret)
660 svc->state = GB_SVC_STATE_PROTOCOL_VERSION;
661 return ret;
662 case GB_SVC_TYPE_SVC_HELLO:
663 ret = gb_svc_hello(op);
664 if (!ret)
665 svc->state = GB_SVC_STATE_SVC_HELLO;
666 return ret;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500667 case GB_SVC_TYPE_INTF_HOTPLUG:
668 return gb_svc_intf_hotplug_recv(op);
669 case GB_SVC_TYPE_INTF_HOT_UNPLUG:
670 return gb_svc_intf_hot_unplug_recv(op);
671 case GB_SVC_TYPE_INTF_RESET:
672 return gb_svc_intf_reset_recv(op);
673 default:
Johan Hovold684156a2015-11-25 15:59:19 +0100674 dev_warn(&svc->dev, "unsupported request 0x%02x\n", type);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500675 return -EINVAL;
676 }
677}
678
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100679static void gb_svc_release(struct device *dev)
680{
Johan Hovold88f7b962015-11-25 15:59:08 +0100681 struct gb_svc *svc = to_gb_svc(dev);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100682
Johan Hovold7adeaae72015-12-07 15:05:37 +0100683 if (svc->connection)
684 gb_connection_destroy(svc->connection);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100685 ida_destroy(&svc->device_id_map);
Johan Hovold3e48aca2015-12-02 18:23:31 +0100686 destroy_workqueue(svc->wq);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100687 kfree(svc);
688}
689
690struct device_type greybus_svc_type = {
691 .name = "greybus_svc",
692 .release = gb_svc_release,
693};
694
Johan Hovold7adeaae72015-12-07 15:05:37 +0100695struct gb_svc *gb_svc_create(struct gb_host_device *hd)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500696{
697 struct gb_svc *svc;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500698
699 svc = kzalloc(sizeof(*svc), GFP_KERNEL);
700 if (!svc)
Johan Hovold7adeaae72015-12-07 15:05:37 +0100701 return NULL;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500702
Johan Hovold3e48aca2015-12-02 18:23:31 +0100703 svc->wq = alloc_workqueue("%s:svc", WQ_UNBOUND, 1, dev_name(&hd->dev));
704 if (!svc->wq) {
705 kfree(svc);
Johan Hovold7adeaae72015-12-07 15:05:37 +0100706 return NULL;
Johan Hovold3e48aca2015-12-02 18:23:31 +0100707 }
708
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100709 svc->dev.parent = &hd->dev;
710 svc->dev.bus = &greybus_bus_type;
711 svc->dev.type = &greybus_svc_type;
Johan Hovold66069fb2015-11-25 15:59:09 +0100712 svc->dev.groups = svc_groups;
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100713 svc->dev.dma_mask = svc->dev.parent->dma_mask;
714 device_initialize(&svc->dev);
715
716 dev_set_name(&svc->dev, "%d-svc", hd->bus_id);
717
Johan Hovold6106e512015-11-25 15:59:07 +0100718 ida_init(&svc->device_id_map);
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530719 svc->state = GB_SVC_STATE_RESET;
Johan Hovoldf0960d02015-12-03 19:18:02 +0100720 svc->hd = hd;
Viresh Kumard3d44842015-07-21 17:44:18 +0530721
Johan Hovold7adeaae72015-12-07 15:05:37 +0100722 svc->connection = gb_connection_create_static(hd, GB_SVC_CPORT_ID,
723 GREYBUS_PROTOCOL_SVC);
724 if (!svc->connection) {
725 dev_err(&svc->dev, "failed to create connection\n");
726 put_device(&svc->dev);
727 return NULL;
728 }
729
730 svc->connection->private = svc;
731
732 return svc;
733}
734
735int gb_svc_add(struct gb_svc *svc)
736{
737 int ret;
738
739 /*
740 * The SVC protocol is currently driven by the SVC, so the SVC device
741 * is added from the connection request handler when enough
742 * information has been received.
743 */
744 ret = gb_connection_init(svc->connection);
745 if (ret)
746 return ret;
747
748 return 0;
749}
750
751void gb_svc_del(struct gb_svc *svc)
752{
753 /*
754 * The SVC device may have been registered from the request handler.
755 */
756 if (device_is_registered(&svc->dev))
757 device_del(&svc->dev);
758
759 gb_connection_exit(svc->connection);
760
761 flush_workqueue(svc->wq);
762}
763
764void gb_svc_put(struct gb_svc *svc)
765{
766 put_device(&svc->dev);
767}
768
769static int gb_svc_connection_init(struct gb_connection *connection)
770{
771 struct gb_svc *svc = connection->private;
772
773 dev_dbg(&svc->dev, "%s\n", __func__);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100774
Viresh Kumar18d777c2015-07-21 17:44:20 +0530775 return 0;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500776}
777
778static void gb_svc_connection_exit(struct gb_connection *connection)
779{
780 struct gb_svc *svc = connection->private;
781
Johan Hovold7adeaae72015-12-07 15:05:37 +0100782 dev_dbg(&svc->dev, "%s\n", __func__);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500783}
784
785static struct gb_protocol svc_protocol = {
786 .name = "svc",
787 .id = GREYBUS_PROTOCOL_SVC,
Viresh Kumar06e305f2015-07-01 12:13:51 +0530788 .major = GB_SVC_VERSION_MAJOR,
789 .minor = GB_SVC_VERSION_MINOR,
Alex Elder30c6d9d2015-05-22 13:02:08 -0500790 .connection_init = gb_svc_connection_init,
791 .connection_exit = gb_svc_connection_exit,
792 .request_recv = gb_svc_request_recv,
Viresh Kumar5a5296b2015-09-07 16:01:24 +0530793 .flags = GB_PROTOCOL_SKIP_CONTROL_CONNECTED |
794 GB_PROTOCOL_SKIP_CONTROL_DISCONNECTED |
Johan Hovold4ec15742015-11-25 15:59:13 +0100795 GB_PROTOCOL_SKIP_VERSION,
Alex Elder30c6d9d2015-05-22 13:02:08 -0500796};
Viresh Kumarab69c4c2015-07-03 17:00:29 +0530797gb_builtin_protocol_driver(svc_protocol);