4 * Copyright 2014 Google Inc.
5 * Copyright 2014 Linaro Ltd.
7 * Released under the GPLv2 only.
10 #include <linux/workqueue.h>
15 static void gb_connection_kref_release(struct kref *kref);
18 static DEFINE_SPINLOCK(gb_connections_lock);
19 static DEFINE_MUTEX(gb_connection_mutex);
22 /* Caller holds gb_connection_mutex. */
23 static struct gb_connection *
24 gb_connection_intf_find(struct gb_interface *intf, u16 cport_id)
26 struct gb_host_device *hd = intf->hd;
27 struct gb_connection *connection;
29 list_for_each_entry(connection, &hd->connections, hd_links) {
30 if (connection->intf == intf &&
31 connection->intf_cport_id == cport_id)
38 static void gb_connection_get(struct gb_connection *connection)
40 kref_get(&connection->kref);
43 static void gb_connection_put(struct gb_connection *connection)
45 kref_put(&connection->kref, gb_connection_kref_release);
49 * Returns a reference-counted pointer to the connection if found.
51 static struct gb_connection *
52 gb_connection_hd_find(struct gb_host_device *hd, u16 cport_id)
54 struct gb_connection *connection;
57 spin_lock_irqsave(&gb_connections_lock, flags);
58 list_for_each_entry(connection, &hd->connections, hd_links)
59 if (connection->hd_cport_id == cport_id) {
60 gb_connection_get(connection);
65 spin_unlock_irqrestore(&gb_connections_lock, flags);
71 * Callback from the host driver to let us know that data has been
72 * received on the bundle.
74 void greybus_data_rcvd(struct gb_host_device *hd, u16 cport_id,
75 u8 *data, size_t length)
77 struct gb_connection *connection;
79 connection = gb_connection_hd_find(hd, cport_id);
82 "nonexistent connection (%zu bytes dropped)\n", length);
85 gb_connection_recv(connection, data, length);
86 gb_connection_put(connection);
88 EXPORT_SYMBOL_GPL(greybus_data_rcvd);
90 static void gb_connection_kref_release(struct kref *kref)
92 struct gb_connection *connection;
94 connection = container_of(kref, struct gb_connection, kref);
99 static void gb_connection_init_name(struct gb_connection *connection)
101 u16 hd_cport_id = connection->hd_cport_id;
105 if (connection->intf) {
106 intf_id = connection->intf->interface_id;
107 cport_id = connection->intf_cport_id;
110 snprintf(connection->name, sizeof(connection->name),
111 "%u/%u:%u", hd_cport_id, intf_id, cport_id);
115 * _gb_connection_create() - create a Greybus connection
116 * @hd: host device of the connection
117 * @hd_cport_id: host-device cport id, or -1 for dynamic allocation
118 * @intf: remote interface, or NULL for static connections
119 * @bundle: remote-interface bundle (may be NULL)
120 * @cport_id: remote-interface cport id, or 0 for static connections
121 * @handler: request handler (may be NULL)
122 * @flags: connection flags
124 * Create a Greybus connection, representing the bidirectional link
125 * between a CPort on a (local) Greybus host device and a CPort on
126 * another Greybus interface.
128 * A connection also maintains the state of operations sent over the
131 * Serialised against concurrent create and destroy using the
132 * gb_connection_mutex.
134 * Return: A pointer to the new connection if successful, or an ERR_PTR
137 static struct gb_connection *
138 _gb_connection_create(struct gb_host_device *hd, int hd_cport_id,
139 struct gb_interface *intf,
140 struct gb_bundle *bundle, int cport_id,
141 gb_request_handler_t handler,
144 struct gb_connection *connection;
147 mutex_lock(&gb_connection_mutex);
149 if (intf && gb_connection_intf_find(intf, cport_id)) {
150 dev_err(&intf->dev, "cport %u already in use\n", cport_id);
155 ret = gb_hd_cport_allocate(hd, hd_cport_id, flags);
157 dev_err(&hd->dev, "failed to allocate cport: %d\n", ret);
162 connection = kzalloc(sizeof(*connection), GFP_KERNEL);
165 goto err_hd_cport_release;
168 connection->hd_cport_id = hd_cport_id;
169 connection->intf_cport_id = cport_id;
171 connection->intf = intf;
172 connection->bundle = bundle;
173 connection->handler = handler;
174 connection->flags = flags;
175 if (intf && (intf->quirks & GB_INTERFACE_QUIRK_NO_CPORT_FEATURES))
176 connection->flags |= GB_CONNECTION_FLAG_NO_FLOWCTRL;
177 connection->state = GB_CONNECTION_STATE_DISABLED;
179 atomic_set(&connection->op_cycle, 0);
180 mutex_init(&connection->mutex);
181 spin_lock_init(&connection->lock);
182 INIT_LIST_HEAD(&connection->operations);
184 connection->wq = alloc_workqueue("%s:%d", WQ_UNBOUND, 1,
185 dev_name(&hd->dev), hd_cport_id);
186 if (!connection->wq) {
188 goto err_free_connection;
191 kref_init(&connection->kref);
193 gb_connection_init_name(connection);
195 spin_lock_irq(&gb_connections_lock);
196 list_add(&connection->hd_links, &hd->connections);
199 list_add(&connection->bundle_links, &bundle->connections);
201 INIT_LIST_HEAD(&connection->bundle_links);
203 spin_unlock_irq(&gb_connections_lock);
205 mutex_unlock(&gb_connection_mutex);
211 err_hd_cport_release:
212 gb_hd_cport_release(hd, hd_cport_id);
214 mutex_unlock(&gb_connection_mutex);
219 struct gb_connection *
220 gb_connection_create_static(struct gb_host_device *hd, u16 hd_cport_id,
221 gb_request_handler_t handler)
223 return _gb_connection_create(hd, hd_cport_id, NULL, NULL, 0, handler,
227 struct gb_connection *
228 gb_connection_create_control(struct gb_interface *intf)
230 return _gb_connection_create(intf->hd, -1, intf, NULL, 0, NULL,
231 GB_CONNECTION_FLAG_CONTROL);
234 struct gb_connection *
235 gb_connection_create(struct gb_bundle *bundle, u16 cport_id,
236 gb_request_handler_t handler)
238 struct gb_interface *intf = bundle->intf;
240 return _gb_connection_create(intf->hd, -1, intf, bundle, cport_id,
243 EXPORT_SYMBOL_GPL(gb_connection_create);
245 struct gb_connection *
246 gb_connection_create_flags(struct gb_bundle *bundle, u16 cport_id,
247 gb_request_handler_t handler,
250 struct gb_interface *intf = bundle->intf;
252 return _gb_connection_create(intf->hd, -1, intf, bundle, cport_id,
255 EXPORT_SYMBOL_GPL(gb_connection_create_flags);
257 struct gb_connection *
258 gb_connection_create_offloaded(struct gb_bundle *bundle, u16 cport_id,
261 struct gb_interface *intf = bundle->intf;
263 flags |= GB_CONNECTION_FLAG_OFFLOADED;
265 return _gb_connection_create(intf->hd, -1, intf, bundle, cport_id,
268 EXPORT_SYMBOL_GPL(gb_connection_create_offloaded);
270 static int gb_connection_hd_cport_enable(struct gb_connection *connection)
272 struct gb_host_device *hd = connection->hd;
275 if (!hd->driver->cport_enable)
278 ret = hd->driver->cport_enable(hd, connection->hd_cport_id);
281 "%s: failed to enable host cport: %d\n",
282 connection->name, ret);
289 static void gb_connection_hd_cport_disable(struct gb_connection *connection)
291 struct gb_host_device *hd = connection->hd;
294 if (!hd->driver->cport_disable)
297 ret = hd->driver->cport_disable(hd, connection->hd_cport_id);
300 "%s: failed to disable host cport: %d\n",
301 connection->name, ret);
306 gb_connection_hd_cport_features_enable(struct gb_connection *connection)
308 struct gb_host_device *hd = connection->hd;
311 if (!hd->driver->cport_features_enable)
314 ret = hd->driver->cport_features_enable(hd, connection->hd_cport_id);
316 dev_err(&hd->dev, "%s: failed to enable CPort features: %d\n",
317 connection->name, ret);
325 gb_connection_hd_cport_features_disable(struct gb_connection *connection)
327 struct gb_host_device *hd = connection->hd;
329 if (!hd->driver->cport_features_disable)
332 hd->driver->cport_features_disable(hd, connection->hd_cport_id);
336 * Request the SVC to create a connection from AP's cport to interface's
340 gb_connection_svc_connection_create(struct gb_connection *connection)
342 struct gb_host_device *hd = connection->hd;
343 struct gb_interface *intf;
347 if (gb_connection_is_static(connection))
350 intf = connection->intf;
353 * Enable either E2EFC or CSD, unless no flow control is requested.
355 cport_flags = GB_SVC_CPORT_FLAG_CSV_N;
356 if (gb_connection_flow_control_disabled(connection)) {
357 cport_flags |= GB_SVC_CPORT_FLAG_CSD_N;
358 } else if (gb_connection_e2efc_enabled(connection)) {
359 cport_flags |= GB_SVC_CPORT_FLAG_CSD_N |
360 GB_SVC_CPORT_FLAG_E2EFC;
363 ret = gb_svc_connection_create(hd->svc,
365 connection->hd_cport_id,
367 connection->intf_cport_id,
370 dev_err(&connection->hd->dev,
371 "%s: failed to create svc connection: %d\n",
372 connection->name, ret);
380 gb_connection_svc_connection_destroy(struct gb_connection *connection)
382 if (gb_connection_is_static(connection))
385 gb_svc_connection_destroy(connection->hd->svc,
386 connection->hd->svc->ap_intf_id,
387 connection->hd_cport_id,
388 connection->intf->interface_id,
389 connection->intf_cport_id);
392 /* Inform Interface about active CPorts */
393 static int gb_connection_control_connected(struct gb_connection *connection)
395 struct gb_control *control;
396 u16 cport_id = connection->intf_cport_id;
399 if (gb_connection_is_static(connection))
403 * HACK: Suppress connected request for the offloaded camera
404 * connection as it is currently not supported by firmware. Note that
405 * the corresponding non-fatal disconnected event is still sent.
407 if (gb_connection_is_offloaded(connection) &&
408 connection->flags & GB_CONNECTION_FLAG_CDSI1) {
412 if (gb_connection_is_control(connection))
415 control = connection->intf->control;
417 ret = gb_control_connected_operation(control, cport_id);
419 dev_err(&connection->bundle->dev,
420 "failed to connect cport: %d\n", ret);
427 /* Inform Interface about inactive CPorts */
429 gb_connection_control_disconnected(struct gb_connection *connection)
431 struct gb_control *control;
432 u16 cport_id = connection->intf_cport_id;
435 if (gb_connection_is_static(connection))
438 if (gb_connection_is_control(connection))
441 control = connection->intf->control;
443 ret = gb_control_disconnected_operation(control, cport_id);
445 dev_warn(&connection->bundle->dev,
446 "failed to disconnect cport: %d\n", ret);
451 * Cancel all active operations on a connection.
453 * Locking: Called with connection lock held and state set to DISABLED.
455 static void gb_connection_cancel_operations(struct gb_connection *connection,
457 __must_hold(&connection->lock)
459 struct gb_operation *operation;
461 while (!list_empty(&connection->operations)) {
462 operation = list_last_entry(&connection->operations,
463 struct gb_operation, links);
464 gb_operation_get(operation);
465 spin_unlock_irq(&connection->lock);
467 if (gb_operation_is_incoming(operation))
468 gb_operation_cancel_incoming(operation, errno);
470 gb_operation_cancel(operation, errno);
472 gb_operation_put(operation);
474 spin_lock_irq(&connection->lock);
479 * Cancel all active incoming operations on a connection.
481 * Locking: Called with connection lock held and state set to ENABLED_TX.
484 gb_connection_flush_incoming_operations(struct gb_connection *connection,
486 __must_hold(&connection->lock)
488 struct gb_operation *operation;
491 while (!list_empty(&connection->operations)) {
493 list_for_each_entry(operation, &connection->operations,
495 if (gb_operation_is_incoming(operation)) {
496 gb_operation_get(operation);
505 spin_unlock_irq(&connection->lock);
507 /* FIXME: flush, not cancel? */
508 gb_operation_cancel_incoming(operation, errno);
509 gb_operation_put(operation);
511 spin_lock_irq(&connection->lock);
516 * _gb_connection_enable() - enable a connection
517 * @connection: connection to enable
518 * @rx: whether to enable incoming requests
520 * Connection-enable helper for DISABLED->ENABLED, DISABLED->ENABLED_TX, and
521 * ENABLED_TX->ENABLED state transitions.
523 * Locking: Caller holds connection->mutex.
525 static int _gb_connection_enable(struct gb_connection *connection, bool rx)
529 /* Handle ENABLED_TX -> ENABLED transitions. */
530 if (connection->state == GB_CONNECTION_STATE_ENABLED_TX) {
531 if (!(connection->handler && rx))
534 spin_lock_irq(&connection->lock);
535 connection->state = GB_CONNECTION_STATE_ENABLED;
536 spin_unlock_irq(&connection->lock);
541 ret = gb_connection_hd_cport_enable(connection);
545 ret = gb_connection_svc_connection_create(connection);
547 goto err_hd_cport_disable;
549 ret = gb_connection_hd_cport_features_enable(connection);
551 goto err_svc_connection_destroy;
553 spin_lock_irq(&connection->lock);
554 if (connection->handler && rx)
555 connection->state = GB_CONNECTION_STATE_ENABLED;
557 connection->state = GB_CONNECTION_STATE_ENABLED_TX;
558 spin_unlock_irq(&connection->lock);
560 ret = gb_connection_control_connected(connection);
562 goto err_flush_operations;
566 err_flush_operations:
567 spin_lock_irq(&connection->lock);
568 connection->state = GB_CONNECTION_STATE_DISABLED;
569 gb_connection_cancel_operations(connection, -ESHUTDOWN);
570 spin_unlock_irq(&connection->lock);
572 gb_connection_hd_cport_features_disable(connection);
573 err_svc_connection_destroy:
574 gb_connection_svc_connection_destroy(connection);
575 err_hd_cport_disable:
576 gb_connection_hd_cport_disable(connection);
581 int gb_connection_enable(struct gb_connection *connection)
585 mutex_lock(&connection->mutex);
587 if (connection->state == GB_CONNECTION_STATE_ENABLED)
590 ret = _gb_connection_enable(connection, true);
592 mutex_unlock(&connection->mutex);
596 EXPORT_SYMBOL_GPL(gb_connection_enable);
598 int gb_connection_enable_tx(struct gb_connection *connection)
602 mutex_lock(&connection->mutex);
604 if (connection->state == GB_CONNECTION_STATE_ENABLED) {
609 if (connection->state == GB_CONNECTION_STATE_ENABLED_TX)
612 ret = _gb_connection_enable(connection, false);
614 mutex_unlock(&connection->mutex);
618 EXPORT_SYMBOL_GPL(gb_connection_enable_tx);
620 void gb_connection_disable_rx(struct gb_connection *connection)
622 mutex_lock(&connection->mutex);
624 spin_lock_irq(&connection->lock);
625 if (connection->state != GB_CONNECTION_STATE_ENABLED) {
626 spin_unlock_irq(&connection->lock);
629 connection->state = GB_CONNECTION_STATE_ENABLED_TX;
630 gb_connection_flush_incoming_operations(connection, -ESHUTDOWN);
631 spin_unlock_irq(&connection->lock);
634 mutex_unlock(&connection->mutex);
636 EXPORT_SYMBOL_GPL(gb_connection_disable_rx);
638 void gb_connection_disable(struct gb_connection *connection)
640 mutex_lock(&connection->mutex);
642 if (connection->state == GB_CONNECTION_STATE_DISABLED)
645 gb_connection_control_disconnected(connection);
647 spin_lock_irq(&connection->lock);
648 connection->state = GB_CONNECTION_STATE_DISABLED;
649 gb_connection_cancel_operations(connection, -ESHUTDOWN);
650 spin_unlock_irq(&connection->lock);
652 gb_connection_hd_cport_features_disable(connection);
653 gb_connection_svc_connection_destroy(connection);
654 gb_connection_hd_cport_disable(connection);
657 mutex_unlock(&connection->mutex);
659 EXPORT_SYMBOL_GPL(gb_connection_disable);
661 /* Disable a connection without communicating with the remote end. */
662 void gb_connection_disable_forced(struct gb_connection *connection)
664 mutex_lock(&connection->mutex);
666 if (connection->state == GB_CONNECTION_STATE_DISABLED)
669 spin_lock_irq(&connection->lock);
670 connection->state = GB_CONNECTION_STATE_DISABLED;
671 gb_connection_cancel_operations(connection, -ESHUTDOWN);
672 spin_unlock_irq(&connection->lock);
674 gb_connection_hd_cport_features_disable(connection);
675 gb_connection_svc_connection_destroy(connection);
676 gb_connection_hd_cport_disable(connection);
679 mutex_unlock(&connection->mutex);
681 EXPORT_SYMBOL_GPL(gb_connection_disable_forced);
683 /* Caller must have disabled the connection before destroying it. */
684 void gb_connection_destroy(struct gb_connection *connection)
689 if (WARN_ON(connection->state != GB_CONNECTION_STATE_DISABLED))
690 gb_connection_disable(connection);
692 mutex_lock(&gb_connection_mutex);
694 spin_lock_irq(&gb_connections_lock);
695 list_del(&connection->bundle_links);
696 list_del(&connection->hd_links);
697 spin_unlock_irq(&gb_connections_lock);
699 destroy_workqueue(connection->wq);
701 gb_hd_cport_release(connection->hd, connection->hd_cport_id);
702 connection->hd_cport_id = CPORT_ID_BAD;
704 mutex_unlock(&gb_connection_mutex);
706 gb_connection_put(connection);
708 EXPORT_SYMBOL_GPL(gb_connection_destroy);
710 void gb_connection_latency_tag_enable(struct gb_connection *connection)
712 struct gb_host_device *hd = connection->hd;
715 if (!hd->driver->latency_tag_enable)
718 ret = hd->driver->latency_tag_enable(hd, connection->hd_cport_id);
720 dev_err(&connection->hd->dev,
721 "%s: failed to enable latency tag: %d\n",
722 connection->name, ret);
725 EXPORT_SYMBOL_GPL(gb_connection_latency_tag_enable);
727 void gb_connection_latency_tag_disable(struct gb_connection *connection)
729 struct gb_host_device *hd = connection->hd;
732 if (!hd->driver->latency_tag_disable)
735 ret = hd->driver->latency_tag_disable(hd, connection->hd_cport_id);
737 dev_err(&connection->hd->dev,
738 "%s: failed to disable latency tag: %d\n",
739 connection->name, ret);
742 EXPORT_SYMBOL_GPL(gb_connection_latency_tag_disable);