4 * Copyright 2015 Google Inc.
5 * Copyright 2015 Linaro Ltd.
7 * Released under the GPLv2 only.
10 #include <linux/workqueue.h>
14 #define CPORT_FLAGS_E2EFC BIT(0)
15 #define CPORT_FLAGS_CSD_N BIT(1)
16 #define CPORT_FLAGS_CSV_N BIT(2)
20 struct work_struct work;
21 struct gb_connection *connection;
22 struct gb_svc_intf_hotplug_request data;
26 static ssize_t endo_id_show(struct device *dev,
27 struct device_attribute *attr, char *buf)
29 struct gb_svc *svc = to_gb_svc(dev);
31 return sprintf(buf, "0x%04x\n", svc->endo_id);
33 static DEVICE_ATTR_RO(endo_id);
35 static ssize_t ap_intf_id_show(struct device *dev,
36 struct device_attribute *attr, char *buf)
38 struct gb_svc *svc = to_gb_svc(dev);
40 return sprintf(buf, "%u\n", svc->ap_intf_id);
42 static DEVICE_ATTR_RO(ap_intf_id);
44 static struct attribute *svc_attrs[] = {
45 &dev_attr_endo_id.attr,
46 &dev_attr_ap_intf_id.attr,
49 ATTRIBUTE_GROUPS(svc);
51 static int gb_svc_intf_device_id(struct gb_svc *svc, u8 intf_id, u8 device_id)
53 struct gb_svc_intf_device_id_request request;
55 request.intf_id = intf_id;
56 request.device_id = device_id;
58 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_DEVICE_ID,
59 &request, sizeof(request), NULL, 0);
62 int gb_svc_intf_reset(struct gb_svc *svc, u8 intf_id)
64 struct gb_svc_intf_reset_request request;
66 request.intf_id = intf_id;
68 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_RESET,
69 &request, sizeof(request), NULL, 0);
71 EXPORT_SYMBOL_GPL(gb_svc_intf_reset);
73 int gb_svc_dme_peer_get(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
76 struct gb_svc_dme_peer_get_request request;
77 struct gb_svc_dme_peer_get_response response;
81 request.intf_id = intf_id;
82 request.attr = cpu_to_le16(attr);
83 request.selector = cpu_to_le16(selector);
85 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_GET,
86 &request, sizeof(request),
87 &response, sizeof(response));
89 dev_err(&svc->dev, "failed to get DME attribute (%hhu %hx %hu): %d\n",
90 intf_id, attr, selector, ret);
94 result = le16_to_cpu(response.result_code);
96 dev_err(&svc->dev, "UniPro error while getting DME attribute (%hhu %hx %hu): %hu\n",
97 intf_id, attr, selector, result);
102 *value = le32_to_cpu(response.attr_value);
106 EXPORT_SYMBOL_GPL(gb_svc_dme_peer_get);
108 int gb_svc_dme_peer_set(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
111 struct gb_svc_dme_peer_set_request request;
112 struct gb_svc_dme_peer_set_response response;
116 request.intf_id = intf_id;
117 request.attr = cpu_to_le16(attr);
118 request.selector = cpu_to_le16(selector);
119 request.value = cpu_to_le32(value);
121 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_SET,
122 &request, sizeof(request),
123 &response, sizeof(response));
125 dev_err(&svc->dev, "failed to set DME attribute (%hhu %hx %hu %u): %d\n",
126 intf_id, attr, selector, value, ret);
130 result = le16_to_cpu(response.result_code);
132 dev_err(&svc->dev, "UniPro error while setting DME attribute (%hhu %hx %hu %u): %hu\n",
133 intf_id, attr, selector, value, result);
139 EXPORT_SYMBOL_GPL(gb_svc_dme_peer_set);
142 * T_TstSrcIncrement is written by the module on ES2 as a stand-in for boot
143 * status attribute. AP needs to read and clear it, after reading a non-zero
146 * FIXME: This is module-hardware dependent and needs to be extended for every
147 * type of module we want to support.
149 static int gb_svc_read_and_clear_module_boot_status(struct gb_interface *intf)
151 struct gb_host_device *hd = intf->hd;
155 /* Read and clear boot status in T_TstSrcIncrement */
156 ret = gb_svc_dme_peer_get(hd->svc, intf->interface_id,
157 DME_ATTR_T_TST_SRC_INCREMENT,
158 DME_ATTR_SELECTOR_INDEX, &value);
164 * A nonzero boot status indicates the module has finished
168 dev_err(&intf->dev, "Module not ready yet\n");
173 * Check if the module needs to boot from unipro.
174 * For ES2: We need to check lowest 8 bits of 'value'.
175 * For ES3: We need to check highest 8 bits out of 32 of 'value'.
177 * FIXME: Add code to find if we are on ES2 or ES3 to have separate
180 if (value == DME_TSI_UNIPRO_BOOT_STARTED ||
181 value == DME_TSI_FALLBACK_UNIPRO_BOOT_STARTED)
182 intf->boot_over_unipro = true;
184 return gb_svc_dme_peer_set(hd->svc, intf->interface_id,
185 DME_ATTR_T_TST_SRC_INCREMENT,
186 DME_ATTR_SELECTOR_INDEX, 0);
189 int gb_svc_connection_create(struct gb_svc *svc,
190 u8 intf1_id, u16 cport1_id,
191 u8 intf2_id, u16 cport2_id,
192 bool boot_over_unipro)
194 struct gb_svc_conn_create_request request;
196 request.intf1_id = intf1_id;
197 request.cport1_id = cpu_to_le16(cport1_id);
198 request.intf2_id = intf2_id;
199 request.cport2_id = cpu_to_le16(cport2_id);
201 * XXX: fix connections paramaters to TC0 and all CPort flags
207 * We need to skip setting E2EFC and other flags to the connection
208 * create request, for all cports, on an interface that need to boot
209 * over unipro, i.e. interfaces required to download firmware.
211 if (boot_over_unipro)
212 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_CSD_N;
214 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_E2EFC;
216 return gb_operation_sync(svc->connection, GB_SVC_TYPE_CONN_CREATE,
217 &request, sizeof(request), NULL, 0);
219 EXPORT_SYMBOL_GPL(gb_svc_connection_create);
221 void gb_svc_connection_destroy(struct gb_svc *svc, u8 intf1_id, u16 cport1_id,
222 u8 intf2_id, u16 cport2_id)
224 struct gb_svc_conn_destroy_request request;
225 struct gb_connection *connection = svc->connection;
228 request.intf1_id = intf1_id;
229 request.cport1_id = cpu_to_le16(cport1_id);
230 request.intf2_id = intf2_id;
231 request.cport2_id = cpu_to_le16(cport2_id);
233 ret = gb_operation_sync(connection, GB_SVC_TYPE_CONN_DESTROY,
234 &request, sizeof(request), NULL, 0);
236 dev_err(&svc->dev, "failed to destroy connection (%hhu:%hu %hhu:%hu): %d\n",
237 intf1_id, cport1_id, intf2_id, cport2_id, ret);
240 EXPORT_SYMBOL_GPL(gb_svc_connection_destroy);
242 /* Creates bi-directional routes between the devices */
243 static int gb_svc_route_create(struct gb_svc *svc, u8 intf1_id, u8 dev1_id,
244 u8 intf2_id, u8 dev2_id)
246 struct gb_svc_route_create_request request;
248 request.intf1_id = intf1_id;
249 request.dev1_id = dev1_id;
250 request.intf2_id = intf2_id;
251 request.dev2_id = dev2_id;
253 return gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_CREATE,
254 &request, sizeof(request), NULL, 0);
257 /* Destroys bi-directional routes between the devices */
258 static void gb_svc_route_destroy(struct gb_svc *svc, u8 intf1_id, u8 intf2_id)
260 struct gb_svc_route_destroy_request request;
263 request.intf1_id = intf1_id;
264 request.intf2_id = intf2_id;
266 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_DESTROY,
267 &request, sizeof(request), NULL, 0);
269 dev_err(&svc->dev, "failed to destroy route (%hhu %hhu): %d\n",
270 intf1_id, intf2_id, ret);
274 static int gb_svc_version_request(struct gb_operation *op)
276 struct gb_connection *connection = op->connection;
277 struct gb_svc *svc = connection->private;
278 struct gb_protocol_version_request *request;
279 struct gb_protocol_version_response *response;
281 if (op->request->payload_size < sizeof(*request)) {
282 dev_err(&svc->dev, "short version request (%zu < %zu)\n",
283 op->request->payload_size,
288 request = op->request->payload;
290 if (request->major > GB_SVC_VERSION_MAJOR) {
291 dev_warn(&svc->dev, "unsupported major version (%hhu > %hhu)\n",
292 request->major, GB_SVC_VERSION_MAJOR);
296 connection->module_major = request->major;
297 connection->module_minor = request->minor;
299 if (!gb_operation_response_alloc(op, sizeof(*response), GFP_KERNEL))
302 response = op->response->payload;
303 response->major = connection->module_major;
304 response->minor = connection->module_minor;
309 static int gb_svc_hello(struct gb_operation *op)
311 struct gb_connection *connection = op->connection;
312 struct gb_svc *svc = connection->private;
313 struct gb_svc_hello_request *hello_request;
316 if (op->request->payload_size < sizeof(*hello_request)) {
317 dev_warn(&svc->dev, "short hello request (%zu < %zu)\n",
318 op->request->payload_size,
319 sizeof(*hello_request));
323 hello_request = op->request->payload;
324 svc->endo_id = le16_to_cpu(hello_request->endo_id);
325 svc->ap_intf_id = hello_request->interface_id;
327 ret = device_add(&svc->dev);
329 dev_err(&svc->dev, "failed to register svc device: %d\n", ret);
336 static void gb_svc_intf_remove(struct gb_svc *svc, struct gb_interface *intf)
338 u8 intf_id = intf->interface_id;
341 device_id = intf->device_id;
342 gb_interface_remove(intf);
345 * Destroy the two-way route between the AP and the interface.
347 gb_svc_route_destroy(svc, svc->ap_intf_id, intf_id);
349 ida_simple_remove(&svc->device_id_map, device_id);
353 * 'struct svc_hotplug' should be freed by svc_process_hotplug() before it
354 * returns, irrespective of success or Failure in bringing up the module.
356 static void svc_process_hotplug(struct work_struct *work)
358 struct svc_hotplug *svc_hotplug = container_of(work, struct svc_hotplug,
360 struct gb_svc_intf_hotplug_request *request;
361 struct gb_connection *connection = svc_hotplug->connection;
362 struct gb_svc *svc = connection->private;
363 struct gb_host_device *hd = connection->hd;
364 struct gb_interface *intf;
365 u8 intf_id, device_id;
368 /* The request message size has already been verified. */
369 request = &svc_hotplug->data;
370 intf_id = request->intf_id;
372 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, intf_id);
374 intf = gb_interface_find(hd, intf_id);
377 * We have received a hotplug request for an interface that
380 * This can happen in cases like:
381 * - bootrom loading the firmware image and booting into that,
382 * which only generates a hotplug event. i.e. no hot-unplug
384 * - Or the firmware on the module crashed and sent hotplug
385 * request again to the SVC, which got propagated to AP.
387 * Remove the interface and add it again, and let user know
388 * about this with a print message.
390 dev_info(&svc->dev, "removing interface %hhu to add it again\n",
392 gb_svc_intf_remove(svc, intf);
395 intf = gb_interface_create(hd, intf_id);
397 dev_err(&svc->dev, "failed to create interface %hhu\n",
399 goto free_svc_hotplug;
402 ret = gb_svc_read_and_clear_module_boot_status(intf);
404 goto destroy_interface;
406 intf->unipro_mfg_id = le32_to_cpu(request->data.unipro_mfg_id);
407 intf->unipro_prod_id = le32_to_cpu(request->data.unipro_prod_id);
408 intf->vendor_id = le32_to_cpu(request->data.ara_vend_id);
409 intf->product_id = le32_to_cpu(request->data.ara_prod_id);
412 * Create a device id for the interface:
413 * - device id 0 (GB_DEVICE_ID_SVC) belongs to the SVC
414 * - device id 1 (GB_DEVICE_ID_AP) belongs to the AP
416 * XXX Do we need to allocate device ID for SVC or the AP here? And what
417 * XXX about an AP with multiple interface blocks?
419 device_id = ida_simple_get(&svc->device_id_map,
420 GB_DEVICE_ID_MODULES_START, 0, GFP_KERNEL);
423 dev_err(&svc->dev, "failed to allocate device id for interface %hhu: %d\n",
425 goto destroy_interface;
428 ret = gb_svc_intf_device_id(svc, intf_id, device_id);
430 dev_err(&svc->dev, "failed to set device id %hhu for interface %hhu: %d\n",
431 device_id, intf_id, ret);
436 * Create a two-way route between the AP and the new interface
438 ret = gb_svc_route_create(svc, svc->ap_intf_id, GB_DEVICE_ID_AP,
441 dev_err(&svc->dev, "failed to create route to interface %hhu (device id %hhu): %d\n",
442 intf_id, device_id, ret);
446 ret = gb_interface_init(intf, device_id);
448 dev_err(&svc->dev, "failed to initialize interface %hhu (device id %hhu): %d\n",
449 intf_id, device_id, ret);
453 goto free_svc_hotplug;
456 gb_svc_route_destroy(svc, svc->ap_intf_id, intf_id);
459 * XXX Should we tell SVC that this id doesn't belong to interface
463 ida_simple_remove(&svc->device_id_map, device_id);
465 gb_interface_remove(intf);
471 * Bringing up a module can be time consuming, as that may require lots of
472 * initialization on the module side. Over that, we may also need to download
473 * the firmware first and flash that on the module.
475 * In order to make other hotplug events to not wait for all this to finish,
476 * handle most of module hotplug stuff outside of the hotplug callback, with
477 * help of a workqueue.
479 static int gb_svc_intf_hotplug_recv(struct gb_operation *op)
481 struct gb_svc *svc = op->connection->private;
482 struct gb_svc_intf_hotplug_request *request;
483 struct svc_hotplug *svc_hotplug;
485 if (op->request->payload_size < sizeof(*request)) {
486 dev_warn(&svc->dev, "short hotplug request received (%zu < %zu)\n",
487 op->request->payload_size, sizeof(*request));
491 request = op->request->payload;
493 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, request->intf_id);
495 svc_hotplug = kmalloc(sizeof(*svc_hotplug), GFP_KERNEL);
499 svc_hotplug->connection = op->connection;
500 memcpy(&svc_hotplug->data, request, sizeof(svc_hotplug->data));
502 INIT_WORK(&svc_hotplug->work, svc_process_hotplug);
503 queue_work(system_unbound_wq, &svc_hotplug->work);
508 static int gb_svc_intf_hot_unplug_recv(struct gb_operation *op)
510 struct gb_svc *svc = op->connection->private;
511 struct gb_svc_intf_hot_unplug_request *request;
512 struct gb_host_device *hd = op->connection->hd;
513 struct gb_interface *intf;
516 if (op->request->payload_size < sizeof(*request)) {
517 dev_warn(&svc->dev, "short hot unplug request received (%zu < %zu)\n",
518 op->request->payload_size, sizeof(*request));
522 request = op->request->payload;
523 intf_id = request->intf_id;
525 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, intf_id);
527 intf = gb_interface_find(hd, intf_id);
529 dev_warn(&svc->dev, "could not find hot-unplug interface %hhu\n",
534 gb_svc_intf_remove(svc, intf);
539 static int gb_svc_intf_reset_recv(struct gb_operation *op)
541 struct gb_svc *svc = op->connection->private;
542 struct gb_message *request = op->request;
543 struct gb_svc_intf_reset_request *reset;
546 if (request->payload_size < sizeof(*reset)) {
547 dev_warn(&svc->dev, "short reset request received (%zu < %zu)\n",
548 request->payload_size, sizeof(*reset));
551 reset = request->payload;
553 intf_id = reset->intf_id;
555 /* FIXME Reset the interface here */
560 static int gb_svc_request_recv(u8 type, struct gb_operation *op)
562 struct gb_connection *connection = op->connection;
563 struct gb_svc *svc = connection->private;
567 * SVC requests need to follow a specific order (at least initially) and
568 * below code takes care of enforcing that. The expected order is:
571 * - Any other request, but the earlier two.
573 * Incoming requests are guaranteed to be serialized and so we don't
574 * need to protect 'state' for any races.
577 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
578 if (svc->state != GB_SVC_STATE_RESET)
581 case GB_SVC_TYPE_SVC_HELLO:
582 if (svc->state != GB_SVC_STATE_PROTOCOL_VERSION)
586 if (svc->state != GB_SVC_STATE_SVC_HELLO)
592 dev_warn(&svc->dev, "unexpected request 0x%02x received (state %u)\n",
598 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
599 ret = gb_svc_version_request(op);
601 svc->state = GB_SVC_STATE_PROTOCOL_VERSION;
603 case GB_SVC_TYPE_SVC_HELLO:
604 ret = gb_svc_hello(op);
606 svc->state = GB_SVC_STATE_SVC_HELLO;
608 case GB_SVC_TYPE_INTF_HOTPLUG:
609 return gb_svc_intf_hotplug_recv(op);
610 case GB_SVC_TYPE_INTF_HOT_UNPLUG:
611 return gb_svc_intf_hot_unplug_recv(op);
612 case GB_SVC_TYPE_INTF_RESET:
613 return gb_svc_intf_reset_recv(op);
615 dev_warn(&svc->dev, "unsupported request 0x%02x\n", type);
620 static void gb_svc_release(struct device *dev)
622 struct gb_svc *svc = to_gb_svc(dev);
624 ida_destroy(&svc->device_id_map);
628 struct device_type greybus_svc_type = {
629 .name = "greybus_svc",
630 .release = gb_svc_release,
633 static int gb_svc_connection_init(struct gb_connection *connection)
635 struct gb_host_device *hd = connection->hd;
638 svc = kzalloc(sizeof(*svc), GFP_KERNEL);
642 svc->dev.parent = &hd->dev;
643 svc->dev.bus = &greybus_bus_type;
644 svc->dev.type = &greybus_svc_type;
645 svc->dev.groups = svc_groups;
646 svc->dev.dma_mask = svc->dev.parent->dma_mask;
647 device_initialize(&svc->dev);
649 dev_set_name(&svc->dev, "%d-svc", hd->bus_id);
651 ida_init(&svc->device_id_map);
652 svc->state = GB_SVC_STATE_RESET;
653 svc->connection = connection;
654 connection->private = svc;
661 static void gb_svc_connection_exit(struct gb_connection *connection)
663 struct gb_svc *svc = connection->private;
665 if (device_is_registered(&svc->dev))
666 device_del(&svc->dev);
668 connection->hd->svc = NULL;
669 connection->private = NULL;
671 put_device(&svc->dev);
674 static struct gb_protocol svc_protocol = {
676 .id = GREYBUS_PROTOCOL_SVC,
677 .major = GB_SVC_VERSION_MAJOR,
678 .minor = GB_SVC_VERSION_MINOR,
679 .connection_init = gb_svc_connection_init,
680 .connection_exit = gb_svc_connection_exit,
681 .request_recv = gb_svc_request_recv,
682 .flags = GB_PROTOCOL_SKIP_CONTROL_CONNECTED |
683 GB_PROTOCOL_SKIP_CONTROL_DISCONNECTED |
684 GB_PROTOCOL_SKIP_VERSION,
686 gb_builtin_protocol_driver(svc_protocol);