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 (1)
15 #define CPORT_FLAGS_CSD_N (2)
16 #define CPORT_FLAGS_CSV_N (4)
20 GB_SVC_STATE_PROTOCOL_VERSION,
21 GB_SVC_STATE_SVC_HELLO,
25 struct gb_connection *connection;
26 enum gb_svc_state state;
27 struct ida device_id_map;
31 struct work_struct work;
32 struct gb_connection *connection;
33 struct gb_svc_intf_hotplug_request data;
38 * AP's SVC cport is required early to get messages from the SVC. This happens
39 * even before the Endo is created and hence any modules or interfaces.
41 * This is a temporary connection, used only at initial bootup.
43 struct gb_connection *
44 gb_ap_svc_connection_create(struct greybus_host_device *hd)
46 struct gb_connection *connection;
48 connection = gb_connection_create_range(hd, NULL, hd->parent,
58 * We know endo-type and AP's interface id now, lets create a proper svc
59 * connection (and its interface/bundle) now and get rid of the initial
60 * 'partially' initialized one svc connection.
62 static struct gb_interface *
63 gb_ap_interface_create(struct greybus_host_device *hd,
64 struct gb_connection *connection, u8 interface_id)
66 struct gb_interface *intf;
67 struct device *dev = &hd->endo->dev;
69 intf = gb_interface_create(hd, interface_id);
71 dev_err(dev, "%s: Failed to create interface with id %hhu\n",
72 __func__, interface_id);
76 intf->device_id = GB_DEVICE_ID_AP;
77 svc_update_connection(intf, connection);
79 /* Its no longer a partially initialized connection */
80 hd->initial_svc_connection = NULL;
85 static int gb_svc_intf_device_id(struct gb_svc *svc, u8 intf_id, u8 device_id)
87 struct gb_svc_intf_device_id_request request;
89 request.intf_id = intf_id;
90 request.device_id = device_id;
92 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_DEVICE_ID,
93 &request, sizeof(request), NULL, 0);
96 int gb_svc_intf_reset(struct gb_svc *svc, u8 intf_id)
98 struct gb_svc_intf_reset_request request;
100 request.intf_id = intf_id;
102 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_RESET,
103 &request, sizeof(request), NULL, 0);
105 EXPORT_SYMBOL_GPL(gb_svc_intf_reset);
107 int gb_svc_dme_peer_get(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
110 struct gb_svc_dme_peer_get_request request;
111 struct gb_svc_dme_peer_get_response response;
115 request.intf_id = intf_id;
116 request.attr = cpu_to_le16(attr);
117 request.selector = cpu_to_le16(selector);
119 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_GET,
120 &request, sizeof(request),
121 &response, sizeof(response));
123 dev_err(&svc->connection->dev,
124 "failed to get DME attribute (%hhu %hx %hu) %d\n",
125 intf_id, attr, selector, ret);
129 result = le16_to_cpu(response.result_code);
131 dev_err(&svc->connection->dev,
132 "Unipro error %hu while getting DME attribute (%hhu %hx %hu)\n",
133 result, intf_id, attr, selector);
138 *value = le32_to_cpu(response.attr_value);
142 EXPORT_SYMBOL_GPL(gb_svc_dme_peer_get);
144 int gb_svc_dme_peer_set(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
147 struct gb_svc_dme_peer_set_request request;
148 struct gb_svc_dme_peer_set_response response;
152 request.intf_id = intf_id;
153 request.attr = cpu_to_le16(attr);
154 request.selector = cpu_to_le16(selector);
155 request.value = cpu_to_le32(value);
157 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_SET,
158 &request, sizeof(request),
159 &response, sizeof(response));
161 dev_err(&svc->connection->dev,
162 "failed to set DME attribute (%hhu %hx %hu %u) %d\n",
163 intf_id, attr, selector, value, ret);
167 result = le16_to_cpu(response.result_code);
169 dev_err(&svc->connection->dev,
170 "Unipro error %hu while setting DME attribute (%hhu %hx %hu %u)\n",
171 result, intf_id, attr, selector, value);
177 EXPORT_SYMBOL_GPL(gb_svc_dme_peer_set);
180 * T_TstSrcIncrement is written by the module on ES2 as a stand-in for boot
181 * status attribute. AP needs to read and clear it, after reading a non-zero
184 * FIXME: This is module-hardware dependent and needs to be extended for every
185 * type of module we want to support.
187 static int gb_svc_read_and_clear_module_boot_status(struct gb_interface *intf)
189 struct greybus_host_device *hd = intf->hd;
193 /* Read and clear boot status in T_TstSrcIncrement */
194 ret = gb_svc_dme_peer_get(hd->svc, intf->interface_id,
195 DME_ATTR_T_TST_SRC_INCREMENT,
196 DME_ATTR_SELECTOR_INDEX, &value);
202 * A nonzero boot status indicates the module has finished
206 dev_err(&intf->dev, "Module not ready yet\n");
210 return gb_svc_dme_peer_set(hd->svc, intf->interface_id,
211 DME_ATTR_T_TST_SRC_INCREMENT,
212 DME_ATTR_SELECTOR_INDEX, 0);
215 int gb_svc_connection_create(struct gb_svc *svc,
216 u8 intf1_id, u16 cport1_id,
217 u8 intf2_id, u16 cport2_id)
219 struct gb_svc_conn_create_request request;
221 request.intf1_id = intf1_id;
222 request.cport1_id = cpu_to_le16(cport1_id);
223 request.intf2_id = intf2_id;
224 request.cport2_id = cpu_to_le16(cport2_id);
226 * XXX: fix connections paramaters to TC0 and all CPort flags
230 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_E2EFC;
232 return gb_operation_sync(svc->connection, GB_SVC_TYPE_CONN_CREATE,
233 &request, sizeof(request), NULL, 0);
235 EXPORT_SYMBOL_GPL(gb_svc_connection_create);
237 void gb_svc_connection_destroy(struct gb_svc *svc, u8 intf1_id, u16 cport1_id,
238 u8 intf2_id, u16 cport2_id)
240 struct gb_svc_conn_destroy_request request;
241 struct gb_connection *connection = svc->connection;
244 request.intf1_id = intf1_id;
245 request.cport1_id = cpu_to_le16(cport1_id);
246 request.intf2_id = intf2_id;
247 request.cport2_id = cpu_to_le16(cport2_id);
249 ret = gb_operation_sync(connection, GB_SVC_TYPE_CONN_DESTROY,
250 &request, sizeof(request), NULL, 0);
252 dev_err(&connection->dev,
253 "failed to destroy connection (%hhx:%hx %hhx:%hx) %d\n",
254 intf1_id, cport1_id, intf2_id, cport2_id, ret);
257 EXPORT_SYMBOL_GPL(gb_svc_connection_destroy);
259 /* Creates bi-directional routes between the devices */
260 static int gb_svc_route_create(struct gb_svc *svc, u8 intf1_id, u8 dev1_id,
261 u8 intf2_id, u8 dev2_id)
263 struct gb_svc_route_create_request request;
265 request.intf1_id = intf1_id;
266 request.dev1_id = dev1_id;
267 request.intf2_id = intf2_id;
268 request.dev2_id = dev2_id;
270 return gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_CREATE,
271 &request, sizeof(request), NULL, 0);
274 /* Destroys bi-directional routes between the devices */
275 static void gb_svc_route_destroy(struct gb_svc *svc, u8 intf1_id, u8 intf2_id)
277 struct gb_svc_route_destroy_request request;
280 request.intf1_id = intf1_id;
281 request.intf2_id = intf2_id;
283 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_DESTROY,
284 &request, sizeof(request), NULL, 0);
286 dev_err(&svc->connection->dev,
287 "failed to destroy route (%hhx %hhx) %d\n",
288 intf1_id, intf2_id, ret);
292 static int gb_svc_version_request(struct gb_operation *op)
294 struct gb_connection *connection = op->connection;
295 struct gb_protocol_version_request *request;
296 struct gb_protocol_version_response *response;
297 struct device *dev = &connection->dev;
299 request = op->request->payload;
301 if (request->major > GB_SVC_VERSION_MAJOR) {
302 dev_err(&connection->dev,
303 "unsupported major version (%hhu > %hhu)\n",
304 request->major, GB_SVC_VERSION_MAJOR);
308 connection->module_major = request->major;
309 connection->module_minor = request->minor;
311 if (!gb_operation_response_alloc(op, sizeof(*response), GFP_KERNEL)) {
312 dev_err(dev, "%s: error allocating response\n",
317 response = op->response->payload;
318 response->major = connection->module_major;
319 response->minor = connection->module_minor;
324 static int gb_svc_hello(struct gb_operation *op)
326 struct gb_connection *connection = op->connection;
327 struct greybus_host_device *hd = connection->hd;
328 struct gb_svc_hello_request *hello_request;
329 struct device *dev = &connection->dev;
330 struct gb_interface *intf;
336 * SVC sends information about the endo and interface-id on the hello
337 * request, use that to create an endo.
339 if (op->request->payload_size < sizeof(*hello_request)) {
340 dev_err(dev, "%s: Illegal size of hello request (%zu < %zu)\n",
341 __func__, op->request->payload_size,
342 sizeof(*hello_request));
346 hello_request = op->request->payload;
347 endo_id = le16_to_cpu(hello_request->endo_id);
348 interface_id = hello_request->interface_id;
351 ret = greybus_endo_setup(hd, endo_id, interface_id);
356 * Endo and its modules are ready now, fix AP's partially initialized
357 * svc protocol and its connection.
359 intf = gb_ap_interface_create(hd, connection, interface_id);
361 gb_endo_remove(hd->endo);
368 static void svc_intf_remove(struct gb_connection *connection,
369 struct gb_interface *intf)
371 struct greybus_host_device *hd = connection->hd;
372 struct gb_svc *svc = connection->private;
373 u8 intf_id = intf->interface_id;
376 device_id = intf->device_id;
377 gb_interface_remove(intf);
380 * Destroy the two-way route between the AP and the interface.
382 gb_svc_route_destroy(svc, hd->endo->ap_intf_id, intf_id);
384 ida_simple_remove(&svc->device_id_map, device_id);
388 * 'struct svc_hotplug' should be freed by svc_process_hotplug() before it
389 * returns, irrespective of success or Failure in bringing up the module.
391 static void svc_process_hotplug(struct work_struct *work)
393 struct svc_hotplug *svc_hotplug = container_of(work, struct svc_hotplug,
395 struct gb_svc_intf_hotplug_request *hotplug = &svc_hotplug->data;
396 struct gb_connection *connection = svc_hotplug->connection;
397 struct gb_svc *svc = connection->private;
398 struct greybus_host_device *hd = connection->hd;
399 struct device *dev = &connection->dev;
400 struct gb_interface *intf;
401 u8 intf_id, device_id;
405 * Grab the information we need.
407 intf_id = hotplug->intf_id;
409 intf = gb_interface_find(hd, intf_id);
412 * We have received a hotplug request for an interface that
415 * This can happen in cases like:
416 * - bootrom loading the firmware image and booting into that,
417 * which only generates a hotplug event. i.e. no hot-unplug
419 * - Or the firmware on the module crashed and sent hotplug
420 * request again to the SVC, which got propagated to AP.
422 * Remove the interface and add it again, and let user know
423 * about this with a print message.
425 dev_info(dev, "Removed interface (%hhu) to add it again\n",
427 svc_intf_remove(connection, intf);
430 intf = gb_interface_create(hd, intf_id);
432 dev_err(dev, "%s: Failed to create interface with id %hhu\n",
434 goto free_svc_hotplug;
437 ret = gb_svc_read_and_clear_module_boot_status(intf);
439 goto destroy_interface;
441 intf->unipro_mfg_id = le32_to_cpu(hotplug->data.unipro_mfg_id);
442 intf->unipro_prod_id = le32_to_cpu(hotplug->data.unipro_prod_id);
443 intf->ara_vend_id = le32_to_cpu(hotplug->data.ara_vend_id);
444 intf->ara_prod_id = le32_to_cpu(hotplug->data.ara_prod_id);
447 * Create a device id for the interface:
448 * - device id 0 (GB_DEVICE_ID_SVC) belongs to the SVC
449 * - device id 1 (GB_DEVICE_ID_AP) belongs to the AP
451 * XXX Do we need to allocate device ID for SVC or the AP here? And what
452 * XXX about an AP with multiple interface blocks?
454 device_id = ida_simple_get(&svc->device_id_map,
455 GB_DEVICE_ID_MODULES_START, 0, GFP_KERNEL);
458 dev_err(dev, "%s: Failed to allocate device id for interface with id %hhu (%d)\n",
459 __func__, intf_id, ret);
460 goto destroy_interface;
463 ret = gb_svc_intf_device_id(svc, intf_id, device_id);
465 dev_err(dev, "%s: Device id operation failed, interface %hhu device_id %hhu (%d)\n",
466 __func__, intf_id, device_id, ret);
471 * Create a two-way route between the AP and the new interface
473 ret = gb_svc_route_create(svc, hd->endo->ap_intf_id, GB_DEVICE_ID_AP,
476 dev_err(dev, "%s: Route create operation failed, interface %hhu device_id %hhu (%d)\n",
477 __func__, intf_id, device_id, ret);
481 ret = gb_interface_init(intf, device_id);
483 dev_err(dev, "%s: Failed to initialize interface, interface %hhu device_id %hhu (%d)\n",
484 __func__, intf_id, device_id, ret);
488 goto free_svc_hotplug;
491 gb_svc_route_destroy(svc, hd->endo->ap_intf_id, intf_id);
494 * XXX Should we tell SVC that this id doesn't belong to interface
498 ida_simple_remove(&svc->device_id_map, device_id);
500 gb_interface_remove(intf);
506 * Bringing up a module can be time consuming, as that may require lots of
507 * initialization on the module side. Over that, we may also need to download
508 * the firmware first and flash that on the module.
510 * In order to make other hotplug events to not wait for all this to finish,
511 * handle most of module hotplug stuff outside of the hotplug callback, with
512 * help of a workqueue.
514 static int gb_svc_intf_hotplug_recv(struct gb_operation *op)
516 struct gb_message *request = op->request;
517 struct svc_hotplug *svc_hotplug;
519 if (request->payload_size < sizeof(svc_hotplug->data)) {
520 dev_err(&op->connection->dev,
521 "%s: short hotplug request received (%zu < %zu)\n",
522 __func__, request->payload_size,
523 sizeof(svc_hotplug->data));
527 svc_hotplug = kmalloc(sizeof(*svc_hotplug), GFP_KERNEL);
531 svc_hotplug->connection = op->connection;
532 memcpy(&svc_hotplug->data, op->request->payload, sizeof(svc_hotplug->data));
534 INIT_WORK(&svc_hotplug->work, svc_process_hotplug);
535 queue_work(system_unbound_wq, &svc_hotplug->work);
540 static int gb_svc_intf_hot_unplug_recv(struct gb_operation *op)
542 struct gb_message *request = op->request;
543 struct gb_svc_intf_hot_unplug_request *hot_unplug = request->payload;
544 struct greybus_host_device *hd = op->connection->hd;
545 struct device *dev = &op->connection->dev;
546 struct gb_interface *intf;
549 if (request->payload_size < sizeof(*hot_unplug)) {
550 dev_err(dev, "short hot unplug request received (%zu < %zu)\n",
551 request->payload_size, sizeof(*hot_unplug));
555 intf_id = hot_unplug->intf_id;
557 intf = gb_interface_find(hd, intf_id);
559 dev_err(dev, "%s: Couldn't find interface for id %hhu\n",
564 svc_intf_remove(op->connection, intf);
569 static int gb_svc_intf_reset_recv(struct gb_operation *op)
571 struct gb_message *request = op->request;
572 struct gb_svc_intf_reset_request *reset;
575 if (request->payload_size < sizeof(*reset)) {
576 dev_err(&op->connection->dev,
577 "short reset request received (%zu < %zu)\n",
578 request->payload_size, sizeof(*reset));
581 reset = request->payload;
583 intf_id = reset->intf_id;
585 /* FIXME Reset the interface here */
590 static int gb_svc_request_recv(u8 type, struct gb_operation *op)
592 struct gb_connection *connection = op->connection;
593 struct gb_svc *svc = connection->private;
597 * SVC requests need to follow a specific order (at least initially) and
598 * below code takes care of enforcing that. The expected order is:
601 * - Any other request, but the earlier two.
603 * Incoming requests are guaranteed to be serialized and so we don't
604 * need to protect 'state' for any races.
607 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
608 if (svc->state != GB_SVC_STATE_RESET)
611 case GB_SVC_TYPE_SVC_HELLO:
612 if (svc->state != GB_SVC_STATE_PROTOCOL_VERSION)
616 if (svc->state != GB_SVC_STATE_SVC_HELLO)
622 dev_warn(&connection->dev,
623 "unexpected SVC request 0x%02x received (state %u)\n",
629 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
630 ret = gb_svc_version_request(op);
632 svc->state = GB_SVC_STATE_PROTOCOL_VERSION;
634 case GB_SVC_TYPE_SVC_HELLO:
635 ret = gb_svc_hello(op);
637 svc->state = GB_SVC_STATE_SVC_HELLO;
639 case GB_SVC_TYPE_INTF_HOTPLUG:
640 return gb_svc_intf_hotplug_recv(op);
641 case GB_SVC_TYPE_INTF_HOT_UNPLUG:
642 return gb_svc_intf_hot_unplug_recv(op);
643 case GB_SVC_TYPE_INTF_RESET:
644 return gb_svc_intf_reset_recv(op);
646 dev_err(&op->connection->dev,
647 "unsupported request: %hhu\n", type);
652 static int gb_svc_connection_init(struct gb_connection *connection)
656 svc = kzalloc(sizeof(*svc), GFP_KERNEL);
660 connection->hd->svc = svc;
661 svc->state = GB_SVC_STATE_RESET;
662 svc->connection = connection;
663 connection->private = svc;
665 WARN_ON(connection->hd->initial_svc_connection);
666 connection->hd->initial_svc_connection = connection;
668 ida_init(&svc->device_id_map);
673 static void gb_svc_connection_exit(struct gb_connection *connection)
675 struct gb_svc *svc = connection->private;
677 ida_destroy(&svc->device_id_map);
678 connection->hd->svc = NULL;
679 connection->private = NULL;
683 static struct gb_protocol svc_protocol = {
685 .id = GREYBUS_PROTOCOL_SVC,
686 .major = GB_SVC_VERSION_MAJOR,
687 .minor = GB_SVC_VERSION_MINOR,
688 .connection_init = gb_svc_connection_init,
689 .connection_exit = gb_svc_connection_exit,
690 .request_recv = gb_svc_request_recv,
691 .flags = GB_PROTOCOL_SKIP_CONTROL_CONNECTED |
692 GB_PROTOCOL_SKIP_CONTROL_DISCONNECTED |
693 GB_PROTOCOL_NO_BUNDLE |
694 GB_PROTOCOL_SKIP_VERSION |
695 GB_PROTOCOL_SKIP_SVC_CONNECTION,
697 gb_builtin_protocol_driver(svc_protocol);