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);
179 int gb_svc_connection_create(struct gb_svc *svc,
180 u8 intf1_id, u16 cport1_id,
181 u8 intf2_id, u16 cport2_id)
183 struct gb_svc_conn_create_request request;
185 request.intf1_id = intf1_id;
186 request.cport1_id = cpu_to_le16(cport1_id);
187 request.intf2_id = intf2_id;
188 request.cport2_id = cpu_to_le16(cport2_id);
190 * XXX: fix connections paramaters to TC0 and all CPort flags
194 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_E2EFC;
196 return gb_operation_sync(svc->connection, GB_SVC_TYPE_CONN_CREATE,
197 &request, sizeof(request), NULL, 0);
199 EXPORT_SYMBOL_GPL(gb_svc_connection_create);
201 void gb_svc_connection_destroy(struct gb_svc *svc, u8 intf1_id, u16 cport1_id,
202 u8 intf2_id, u16 cport2_id)
204 struct gb_svc_conn_destroy_request request;
205 struct gb_connection *connection = svc->connection;
208 request.intf1_id = intf1_id;
209 request.cport1_id = cpu_to_le16(cport1_id);
210 request.intf2_id = intf2_id;
211 request.cport2_id = cpu_to_le16(cport2_id);
213 ret = gb_operation_sync(connection, GB_SVC_TYPE_CONN_DESTROY,
214 &request, sizeof(request), NULL, 0);
216 dev_err(&connection->dev,
217 "failed to destroy connection (%hhx:%hx %hhx:%hx) %d\n",
218 intf1_id, cport1_id, intf2_id, cport2_id, ret);
221 EXPORT_SYMBOL_GPL(gb_svc_connection_destroy);
223 /* Creates bi-directional routes between the devices */
224 static int gb_svc_route_create(struct gb_svc *svc, u8 intf1_id, u8 dev1_id,
225 u8 intf2_id, u8 dev2_id)
227 struct gb_svc_route_create_request request;
229 request.intf1_id = intf1_id;
230 request.dev1_id = dev1_id;
231 request.intf2_id = intf2_id;
232 request.dev2_id = dev2_id;
234 return gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_CREATE,
235 &request, sizeof(request), NULL, 0);
238 /* Destroys bi-directional routes between the devices */
239 static void gb_svc_route_destroy(struct gb_svc *svc, u8 intf1_id, u8 intf2_id)
241 struct gb_svc_route_destroy_request request;
244 request.intf1_id = intf1_id;
245 request.intf2_id = intf2_id;
247 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_DESTROY,
248 &request, sizeof(request), NULL, 0);
250 dev_err(&svc->connection->dev,
251 "failed to destroy route (%hhx %hhx) %d\n",
252 intf1_id, intf2_id, ret);
256 static int gb_svc_version_request(struct gb_operation *op)
258 struct gb_connection *connection = op->connection;
259 struct gb_protocol_version_request *request;
260 struct gb_protocol_version_response *response;
261 struct device *dev = &connection->dev;
263 request = op->request->payload;
265 if (request->major > GB_SVC_VERSION_MAJOR) {
266 dev_err(&connection->dev,
267 "unsupported major version (%hhu > %hhu)\n",
268 request->major, GB_SVC_VERSION_MAJOR);
272 connection->module_major = request->major;
273 connection->module_minor = request->minor;
275 if (!gb_operation_response_alloc(op, sizeof(*response), GFP_KERNEL)) {
276 dev_err(dev, "%s: error allocating response\n",
281 response = op->response->payload;
282 response->major = connection->module_major;
283 response->minor = connection->module_minor;
288 static int gb_svc_hello(struct gb_operation *op)
290 struct gb_connection *connection = op->connection;
291 struct greybus_host_device *hd = connection->hd;
292 struct gb_svc_hello_request *hello_request;
293 struct device *dev = &connection->dev;
294 struct gb_interface *intf;
300 * SVC sends information about the endo and interface-id on the hello
301 * request, use that to create an endo.
303 if (op->request->payload_size < sizeof(*hello_request)) {
304 dev_err(dev, "%s: Illegal size of hello request (%zu < %zu)\n",
305 __func__, op->request->payload_size,
306 sizeof(*hello_request));
310 hello_request = op->request->payload;
311 endo_id = le16_to_cpu(hello_request->endo_id);
312 interface_id = hello_request->interface_id;
315 ret = greybus_endo_setup(hd, endo_id, interface_id);
320 * Endo and its modules are ready now, fix AP's partially initialized
321 * svc protocol and its connection.
323 intf = gb_ap_interface_create(hd, connection, interface_id);
325 gb_endo_remove(hd->endo);
332 static void svc_intf_remove(struct gb_connection *connection,
333 struct gb_interface *intf)
335 struct greybus_host_device *hd = connection->hd;
336 struct gb_svc *svc = connection->private;
337 u8 intf_id = intf->interface_id;
340 device_id = intf->device_id;
341 gb_interface_remove(hd, intf_id);
344 * Destroy the two-way route between the AP and the interface.
346 gb_svc_route_destroy(svc, hd->endo->ap_intf_id, intf_id);
348 ida_simple_remove(&svc->device_id_map, device_id);
352 * 'struct svc_hotplug' should be freed by svc_process_hotplug() before it
353 * returns, irrespective of success or Failure in bringing up the module.
355 static void svc_process_hotplug(struct work_struct *work)
357 struct svc_hotplug *svc_hotplug = container_of(work, struct svc_hotplug,
359 struct gb_svc_intf_hotplug_request *hotplug = &svc_hotplug->data;
360 struct gb_connection *connection = svc_hotplug->connection;
361 struct gb_svc *svc = connection->private;
362 struct greybus_host_device *hd = connection->hd;
363 struct device *dev = &connection->dev;
364 struct gb_interface *intf;
365 u8 intf_id, device_id;
369 * Grab the information we need.
371 intf_id = hotplug->intf_id;
373 intf = gb_interface_find(hd, intf_id);
376 * We have received a hotplug request for an interface that
379 * This can happen in cases like:
380 * - bootrom loading the firmware image and booting into that,
381 * which only generates a hotplug event. i.e. no hot-unplug
383 * - Or the firmware on the module crashed and sent hotplug
384 * request again to the SVC, which got propagated to AP.
386 * Remove the interface and add it again, and let user know
387 * about this with a print message.
389 dev_info(dev, "Removed interface (%hhu) to add it again\n",
391 svc_intf_remove(connection, intf);
394 intf = gb_interface_create(hd, intf_id);
396 dev_err(dev, "%s: Failed to create interface with id %hhu\n",
398 goto free_svc_hotplug;
401 intf->unipro_mfg_id = le32_to_cpu(hotplug->data.unipro_mfg_id);
402 intf->unipro_prod_id = le32_to_cpu(hotplug->data.unipro_prod_id);
403 intf->ara_vend_id = le32_to_cpu(hotplug->data.ara_vend_id);
404 intf->ara_prod_id = le32_to_cpu(hotplug->data.ara_prod_id);
407 * Create a device id for the interface:
408 * - device id 0 (GB_DEVICE_ID_SVC) belongs to the SVC
409 * - device id 1 (GB_DEVICE_ID_AP) belongs to the AP
411 * XXX Do we need to allocate device ID for SVC or the AP here? And what
412 * XXX about an AP with multiple interface blocks?
414 device_id = ida_simple_get(&svc->device_id_map,
415 GB_DEVICE_ID_MODULES_START, 0, GFP_KERNEL);
418 dev_err(dev, "%s: Failed to allocate device id for interface with id %hhu (%d)\n",
419 __func__, intf_id, ret);
420 goto destroy_interface;
423 ret = gb_svc_intf_device_id(svc, intf_id, device_id);
425 dev_err(dev, "%s: Device id operation failed, interface %hhu device_id %hhu (%d)\n",
426 __func__, intf_id, device_id, ret);
431 * Create a two-way route between the AP and the new interface
433 ret = gb_svc_route_create(svc, hd->endo->ap_intf_id, GB_DEVICE_ID_AP,
436 dev_err(dev, "%s: Route create operation failed, interface %hhu device_id %hhu (%d)\n",
437 __func__, intf_id, device_id, ret);
441 ret = gb_interface_init(intf, device_id);
443 dev_err(dev, "%s: Failed to initialize interface, interface %hhu device_id %hhu (%d)\n",
444 __func__, intf_id, device_id, ret);
448 goto free_svc_hotplug;
451 gb_svc_route_destroy(svc, hd->endo->ap_intf_id, intf_id);
454 * XXX Should we tell SVC that this id doesn't belong to interface
458 ida_simple_remove(&svc->device_id_map, device_id);
460 gb_interface_remove(hd, intf_id);
466 * Bringing up a module can be time consuming, as that may require lots of
467 * initialization on the module side. Over that, we may also need to download
468 * the firmware first and flash that on the module.
470 * In order to make other hotplug events to not wait for all this to finish,
471 * handle most of module hotplug stuff outside of the hotplug callback, with
472 * help of a workqueue.
474 static int gb_svc_intf_hotplug_recv(struct gb_operation *op)
476 struct gb_message *request = op->request;
477 struct svc_hotplug *svc_hotplug;
479 if (request->payload_size < sizeof(svc_hotplug->data)) {
480 dev_err(&op->connection->dev,
481 "%s: short hotplug request received (%zu < %zu)\n",
482 __func__, request->payload_size,
483 sizeof(svc_hotplug->data));
487 svc_hotplug = kmalloc(sizeof(*svc_hotplug), GFP_KERNEL);
491 svc_hotplug->connection = op->connection;
492 memcpy(&svc_hotplug->data, op->request->payload, sizeof(svc_hotplug->data));
494 INIT_WORK(&svc_hotplug->work, svc_process_hotplug);
495 queue_work(system_unbound_wq, &svc_hotplug->work);
500 static int gb_svc_intf_hot_unplug_recv(struct gb_operation *op)
502 struct gb_message *request = op->request;
503 struct gb_svc_intf_hot_unplug_request *hot_unplug = request->payload;
504 struct greybus_host_device *hd = op->connection->hd;
505 struct device *dev = &op->connection->dev;
506 struct gb_interface *intf;
509 if (request->payload_size < sizeof(*hot_unplug)) {
510 dev_err(dev, "short hot unplug request received (%zu < %zu)\n",
511 request->payload_size, sizeof(*hot_unplug));
515 intf_id = hot_unplug->intf_id;
517 intf = gb_interface_find(hd, intf_id);
519 dev_err(dev, "%s: Couldn't find interface for id %hhu\n",
524 svc_intf_remove(op->connection, intf);
529 static int gb_svc_intf_reset_recv(struct gb_operation *op)
531 struct gb_message *request = op->request;
532 struct gb_svc_intf_reset_request *reset;
535 if (request->payload_size < sizeof(*reset)) {
536 dev_err(&op->connection->dev,
537 "short reset request received (%zu < %zu)\n",
538 request->payload_size, sizeof(*reset));
541 reset = request->payload;
543 intf_id = reset->intf_id;
545 /* FIXME Reset the interface here */
550 static int gb_svc_request_recv(u8 type, struct gb_operation *op)
552 struct gb_connection *connection = op->connection;
553 struct gb_svc *svc = connection->private;
557 * SVC requests need to follow a specific order (at least initially) and
558 * below code takes care of enforcing that. The expected order is:
561 * - Any other request, but the earlier two.
563 * Incoming requests are guaranteed to be serialized and so we don't
564 * need to protect 'state' for any races.
567 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
568 if (svc->state != GB_SVC_STATE_RESET)
571 case GB_SVC_TYPE_SVC_HELLO:
572 if (svc->state != GB_SVC_STATE_PROTOCOL_VERSION)
576 if (svc->state != GB_SVC_STATE_SVC_HELLO)
582 dev_warn(&connection->dev,
583 "unexpected SVC request 0x%02x received (state %u)\n",
589 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
590 ret = gb_svc_version_request(op);
592 svc->state = GB_SVC_STATE_PROTOCOL_VERSION;
594 case GB_SVC_TYPE_SVC_HELLO:
595 ret = gb_svc_hello(op);
597 svc->state = GB_SVC_STATE_SVC_HELLO;
599 case GB_SVC_TYPE_INTF_HOTPLUG:
600 return gb_svc_intf_hotplug_recv(op);
601 case GB_SVC_TYPE_INTF_HOT_UNPLUG:
602 return gb_svc_intf_hot_unplug_recv(op);
603 case GB_SVC_TYPE_INTF_RESET:
604 return gb_svc_intf_reset_recv(op);
606 dev_err(&op->connection->dev,
607 "unsupported request: %hhu\n", type);
612 static int gb_svc_connection_init(struct gb_connection *connection)
616 svc = kzalloc(sizeof(*svc), GFP_KERNEL);
620 connection->hd->svc = svc;
621 svc->state = GB_SVC_STATE_RESET;
622 svc->connection = connection;
623 connection->private = svc;
625 WARN_ON(connection->hd->initial_svc_connection);
626 connection->hd->initial_svc_connection = connection;
628 ida_init(&svc->device_id_map);
633 static void gb_svc_connection_exit(struct gb_connection *connection)
635 struct gb_svc *svc = connection->private;
637 ida_destroy(&svc->device_id_map);
638 connection->hd->svc = NULL;
639 connection->private = NULL;
643 static struct gb_protocol svc_protocol = {
645 .id = GREYBUS_PROTOCOL_SVC,
646 .major = GB_SVC_VERSION_MAJOR,
647 .minor = GB_SVC_VERSION_MINOR,
648 .connection_init = gb_svc_connection_init,
649 .connection_exit = gb_svc_connection_exit,
650 .request_recv = gb_svc_request_recv,
651 .flags = GB_PROTOCOL_SKIP_CONTROL_CONNECTED |
652 GB_PROTOCOL_SKIP_CONTROL_DISCONNECTED |
653 GB_PROTOCOL_NO_BUNDLE |
654 GB_PROTOCOL_SKIP_VERSION |
655 GB_PROTOCOL_SKIP_SVC_CONNECTION,
657 gb_builtin_protocol_driver(svc_protocol);