2 * Loopback bridge driver for the Greybus loopback module.
4 * Copyright 2014 Google Inc.
5 * Copyright 2014 Linaro Ltd.
7 * Released under the GPLv2 only.
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/mutex.h>
15 #include <linux/slab.h>
16 #include <linux/kthread.h>
17 #include <linux/delay.h>
18 #include <linux/random.h>
19 #include <linux/sizes.h>
20 #include <linux/cdev.h>
22 #include <linux/kfifo.h>
23 #include <linux/debugfs.h>
24 #include <linux/list_sort.h>
25 #include <linux/spinlock.h>
26 #include <linux/workqueue.h>
27 #include <linux/atomic.h>
28 #include <linux/pm_runtime.h>
30 #include <asm/div64.h>
33 #include "connection.h"
35 #define NSEC_PER_DAY 86400000000000ULL
37 struct gb_loopback_stats {
44 struct gb_loopback_device {
49 /* We need to take a lock in atomic context */
51 struct list_head list;
52 struct list_head list_op_async;
56 static struct gb_loopback_device gb_dev;
58 struct gb_loopback_async_operation {
59 struct gb_loopback *gb;
60 struct gb_operation *operation;
62 struct timer_list timer;
63 struct list_head entry;
64 struct work_struct work;
67 int (*completion)(struct gb_loopback_async_operation *op_async);
71 struct gb_connection *connection;
74 struct kfifo kfifo_lat;
75 struct kfifo kfifo_ts;
77 struct task_struct *task;
78 struct list_head entry;
81 wait_queue_head_t wq_completion;
82 atomic_t outstanding_operations;
84 /* Per connection stats */
86 struct gb_loopback_stats latency;
87 struct gb_loopback_stats throughput;
88 struct gb_loopback_stats requests_per_second;
89 struct gb_loopback_stats apbridge_unipro_latency;
90 struct gb_loopback_stats gbphy_firmware_latency;
100 u32 requests_completed;
101 u32 requests_timedout;
106 u32 outstanding_operations_max;
109 u32 apbridge_latency_ts;
110 u32 gbphy_latency_ts;
115 static struct class loopback_class = {
116 .name = "gb_loopback",
117 .owner = THIS_MODULE,
119 static DEFINE_IDA(loopback_ida);
121 /* Min/max values in jiffies */
122 #define GB_LOOPBACK_TIMEOUT_MIN 1
123 #define GB_LOOPBACK_TIMEOUT_MAX 10000
125 #define GB_LOOPBACK_FIFO_DEFAULT 8192
127 static unsigned int kfifo_depth = GB_LOOPBACK_FIFO_DEFAULT;
128 module_param(kfifo_depth, uint, 0444);
130 /* Maximum size of any one send data buffer we support */
131 #define MAX_PACKET_SIZE (PAGE_SIZE * 2)
133 #define GB_LOOPBACK_US_WAIT_MAX 1000000
135 /* interface sysfs attributes */
136 #define gb_loopback_ro_attr(field) \
137 static ssize_t field##_show(struct device *dev, \
138 struct device_attribute *attr, \
141 struct gb_loopback *gb = dev_get_drvdata(dev); \
142 return sprintf(buf, "%u\n", gb->field); \
144 static DEVICE_ATTR_RO(field)
146 #define gb_loopback_ro_stats_attr(name, field, type) \
147 static ssize_t name##_##field##_show(struct device *dev, \
148 struct device_attribute *attr, \
151 struct gb_loopback *gb = dev_get_drvdata(dev); \
152 /* Report 0 for min and max if no transfer successed */ \
153 if (!gb->requests_completed) \
154 return sprintf(buf, "0\n"); \
155 return sprintf(buf, "%"#type"\n", gb->name.field); \
157 static DEVICE_ATTR_RO(name##_##field)
159 #define gb_loopback_ro_avg_attr(name) \
160 static ssize_t name##_avg_show(struct device *dev, \
161 struct device_attribute *attr, \
164 struct gb_loopback_stats *stats; \
165 struct gb_loopback *gb; \
168 gb = dev_get_drvdata(dev); \
170 count = stats->count ? stats->count : 1; \
171 avg = stats->sum + count / 2000000; /* round closest */ \
172 rem = do_div(avg, count); \
174 do_div(rem, count); \
175 return sprintf(buf, "%llu.%06u\n", avg, (u32)rem); \
177 static DEVICE_ATTR_RO(name##_avg)
179 #define gb_loopback_stats_attrs(field) \
180 gb_loopback_ro_stats_attr(field, min, u); \
181 gb_loopback_ro_stats_attr(field, max, u); \
182 gb_loopback_ro_avg_attr(field)
184 #define gb_loopback_attr(field, type) \
185 static ssize_t field##_show(struct device *dev, \
186 struct device_attribute *attr, \
189 struct gb_loopback *gb = dev_get_drvdata(dev); \
190 return sprintf(buf, "%"#type"\n", gb->field); \
192 static ssize_t field##_store(struct device *dev, \
193 struct device_attribute *attr, \
198 struct gb_loopback *gb = dev_get_drvdata(dev); \
199 mutex_lock(&gb->mutex); \
200 ret = sscanf(buf, "%"#type, &gb->field); \
204 gb_loopback_check_attr(gb, bundle); \
205 mutex_unlock(&gb->mutex); \
208 static DEVICE_ATTR_RW(field)
210 #define gb_dev_loopback_ro_attr(field, conn) \
211 static ssize_t field##_show(struct device *dev, \
212 struct device_attribute *attr, \
215 struct gb_loopback *gb = dev_get_drvdata(dev); \
216 return sprintf(buf, "%u\n", gb->field); \
218 static DEVICE_ATTR_RO(field)
220 #define gb_dev_loopback_rw_attr(field, type) \
221 static ssize_t field##_show(struct device *dev, \
222 struct device_attribute *attr, \
225 struct gb_loopback *gb = dev_get_drvdata(dev); \
226 return sprintf(buf, "%"#type"\n", gb->field); \
228 static ssize_t field##_store(struct device *dev, \
229 struct device_attribute *attr, \
234 struct gb_loopback *gb = dev_get_drvdata(dev); \
235 mutex_lock(&gb->mutex); \
236 ret = sscanf(buf, "%"#type, &gb->field); \
240 gb_loopback_check_attr(gb); \
241 mutex_unlock(&gb->mutex); \
244 static DEVICE_ATTR_RW(field)
246 static void gb_loopback_reset_stats(struct gb_loopback *gb);
247 static void gb_loopback_check_attr(struct gb_loopback *gb)
249 if (gb->us_wait > GB_LOOPBACK_US_WAIT_MAX)
250 gb->us_wait = GB_LOOPBACK_US_WAIT_MAX;
251 if (gb->size > gb_dev.size_max)
252 gb->size = gb_dev.size_max;
253 gb->requests_timedout = 0;
254 gb->requests_completed = 0;
255 gb->iteration_count = 0;
259 if (kfifo_depth < gb->iteration_max) {
261 "cannot log bytes %u kfifo_depth %u\n",
262 gb->iteration_max, kfifo_depth);
264 kfifo_reset_out(&gb->kfifo_lat);
265 kfifo_reset_out(&gb->kfifo_ts);
268 case GB_LOOPBACK_TYPE_PING:
269 case GB_LOOPBACK_TYPE_TRANSFER:
270 case GB_LOOPBACK_TYPE_SINK:
271 gb->jiffy_timeout = usecs_to_jiffies(gb->timeout);
272 if (!gb->jiffy_timeout)
273 gb->jiffy_timeout = GB_LOOPBACK_TIMEOUT_MIN;
274 else if (gb->jiffy_timeout > GB_LOOPBACK_TIMEOUT_MAX)
275 gb->jiffy_timeout = GB_LOOPBACK_TIMEOUT_MAX;
276 gb_loopback_reset_stats(gb);
285 /* Time to send and receive one message */
286 gb_loopback_stats_attrs(latency);
287 /* Number of requests sent per second on this cport */
288 gb_loopback_stats_attrs(requests_per_second);
289 /* Quantity of data sent and received on this cport */
290 gb_loopback_stats_attrs(throughput);
291 /* Latency across the UniPro link from APBridge's perspective */
292 gb_loopback_stats_attrs(apbridge_unipro_latency);
293 /* Firmware induced overhead in the GPBridge */
294 gb_loopback_stats_attrs(gbphy_firmware_latency);
296 /* Number of errors encountered during loop */
297 gb_loopback_ro_attr(error);
298 /* Number of requests successfully completed async */
299 gb_loopback_ro_attr(requests_completed);
300 /* Number of requests timed out async */
301 gb_loopback_ro_attr(requests_timedout);
302 /* Timeout minimum in useconds */
303 gb_loopback_ro_attr(timeout_min);
304 /* Timeout minimum in useconds */
305 gb_loopback_ro_attr(timeout_max);
308 * Type of loopback message to send based on protocol type definitions
309 * 0 => Don't send message
310 * 2 => Send ping message continuously (message without payload)
311 * 3 => Send transfer message continuously (message with payload,
312 * payload returned in response)
313 * 4 => Send a sink message (message with payload, no payload in response)
315 gb_dev_loopback_rw_attr(type, d);
316 /* Size of transfer message payload: 0-4096 bytes */
317 gb_dev_loopback_rw_attr(size, u);
318 /* Time to wait between two messages: 0-1000 ms */
319 gb_dev_loopback_rw_attr(us_wait, d);
320 /* Maximum iterations for a given operation: 1-(2^32-1), 0 implies infinite */
321 gb_dev_loopback_rw_attr(iteration_max, u);
322 /* The current index of the for (i = 0; i < iteration_max; i++) loop */
323 gb_dev_loopback_ro_attr(iteration_count, false);
324 /* A flag to indicate synchronous or asynchronous operations */
325 gb_dev_loopback_rw_attr(async, u);
326 /* Timeout of an individual asynchronous request */
327 gb_dev_loopback_rw_attr(timeout, u);
328 /* Maximum number of in-flight operations before back-off */
329 gb_dev_loopback_rw_attr(outstanding_operations_max, u);
331 static struct attribute *loopback_attrs[] = {
332 &dev_attr_latency_min.attr,
333 &dev_attr_latency_max.attr,
334 &dev_attr_latency_avg.attr,
335 &dev_attr_requests_per_second_min.attr,
336 &dev_attr_requests_per_second_max.attr,
337 &dev_attr_requests_per_second_avg.attr,
338 &dev_attr_throughput_min.attr,
339 &dev_attr_throughput_max.attr,
340 &dev_attr_throughput_avg.attr,
341 &dev_attr_apbridge_unipro_latency_min.attr,
342 &dev_attr_apbridge_unipro_latency_max.attr,
343 &dev_attr_apbridge_unipro_latency_avg.attr,
344 &dev_attr_gbphy_firmware_latency_min.attr,
345 &dev_attr_gbphy_firmware_latency_max.attr,
346 &dev_attr_gbphy_firmware_latency_avg.attr,
349 &dev_attr_us_wait.attr,
350 &dev_attr_iteration_count.attr,
351 &dev_attr_iteration_max.attr,
352 &dev_attr_async.attr,
353 &dev_attr_error.attr,
354 &dev_attr_requests_completed.attr,
355 &dev_attr_requests_timedout.attr,
356 &dev_attr_timeout.attr,
357 &dev_attr_outstanding_operations_max.attr,
358 &dev_attr_timeout_min.attr,
359 &dev_attr_timeout_max.attr,
362 ATTRIBUTE_GROUPS(loopback);
364 static void gb_loopback_calculate_stats(struct gb_loopback *gb, bool error);
366 static u32 gb_loopback_nsec_to_usec_latency(u64 elapsed_nsecs)
368 do_div(elapsed_nsecs, NSEC_PER_USEC);
369 return elapsed_nsecs;
372 static u64 __gb_loopback_calc_latency(u64 t1, u64 t2)
377 return NSEC_PER_DAY - t2 + t1;
380 static u64 gb_loopback_calc_latency(struct timeval *ts, struct timeval *te)
384 t1 = timeval_to_ns(ts);
385 t2 = timeval_to_ns(te);
387 return __gb_loopback_calc_latency(t1, t2);
390 static void gb_loopback_push_latency_ts(struct gb_loopback *gb,
391 struct timeval *ts, struct timeval *te)
393 kfifo_in(&gb->kfifo_ts, (unsigned char *)ts, sizeof(*ts));
394 kfifo_in(&gb->kfifo_ts, (unsigned char *)te, sizeof(*te));
397 static int gb_loopback_operation_sync(struct gb_loopback *gb, int type,
398 void *request, int request_size,
399 void *response, int response_size)
401 struct gb_operation *operation;
402 struct timeval ts, te;
405 do_gettimeofday(&ts);
406 operation = gb_operation_create(gb->connection, type, request_size,
407 response_size, GFP_KERNEL);
412 memcpy(operation->request->payload, request, request_size);
414 ret = gb_operation_request_send_sync(operation);
416 dev_err(&gb->connection->bundle->dev,
417 "synchronous operation failed: %d\n", ret);
418 goto out_put_operation;
420 if (response_size == operation->response->payload_size) {
421 memcpy(response, operation->response->payload,
424 dev_err(&gb->connection->bundle->dev,
425 "response size %zu expected %d\n",
426 operation->response->payload_size,
429 goto out_put_operation;
433 do_gettimeofday(&te);
435 /* Calculate the total time the message took */
436 gb_loopback_push_latency_ts(gb, &ts, &te);
437 gb->elapsed_nsecs = gb_loopback_calc_latency(&ts, &te);
440 gb_operation_put(operation);
445 static void __gb_loopback_async_operation_destroy(struct kref *kref)
447 struct gb_loopback_async_operation *op_async;
449 op_async = container_of(kref, struct gb_loopback_async_operation, kref);
451 list_del(&op_async->entry);
452 if (op_async->operation)
453 gb_operation_put(op_async->operation);
454 atomic_dec(&op_async->gb->outstanding_operations);
455 wake_up(&op_async->gb->wq_completion);
459 static void gb_loopback_async_operation_get(struct gb_loopback_async_operation
462 kref_get(&op_async->kref);
465 static void gb_loopback_async_operation_put(struct gb_loopback_async_operation
470 spin_lock_irqsave(&gb_dev.lock, flags);
471 kref_put(&op_async->kref, __gb_loopback_async_operation_destroy);
472 spin_unlock_irqrestore(&gb_dev.lock, flags);
475 static struct gb_loopback_async_operation *
476 gb_loopback_operation_find(u16 id)
478 struct gb_loopback_async_operation *op_async;
482 spin_lock_irqsave(&gb_dev.lock, flags);
483 list_for_each_entry(op_async, &gb_dev.list_op_async, entry) {
484 if (op_async->operation->id == id) {
485 gb_loopback_async_operation_get(op_async);
490 spin_unlock_irqrestore(&gb_dev.lock, flags);
492 return found ? op_async : NULL;
495 static void gb_loopback_async_wait_all(struct gb_loopback *gb)
497 wait_event(gb->wq_completion,
498 !atomic_read(&gb->outstanding_operations));
501 static void gb_loopback_async_operation_callback(struct gb_operation *operation)
503 struct gb_loopback_async_operation *op_async;
504 struct gb_loopback *gb;
508 do_gettimeofday(&te);
509 op_async = gb_loopback_operation_find(operation->id);
514 mutex_lock(&gb->mutex);
516 if (!op_async->pending || gb_operation_result(operation)) {
519 if (op_async->completion)
520 if (op_async->completion(op_async))
525 gb_loopback_push_latency_ts(gb, &op_async->ts, &te);
526 gb->elapsed_nsecs = gb_loopback_calc_latency(&op_async->ts,
530 if (op_async->pending) {
533 gb->iteration_count++;
534 op_async->pending = false;
535 del_timer_sync(&op_async->timer);
536 gb_loopback_async_operation_put(op_async);
537 gb_loopback_calculate_stats(gb, err);
539 mutex_unlock(&gb->mutex);
541 dev_dbg(&gb->connection->bundle->dev, "complete operation %d\n",
544 gb_loopback_async_operation_put(op_async);
547 static void gb_loopback_async_operation_work(struct work_struct *work)
549 struct gb_loopback *gb;
550 struct gb_operation *operation;
551 struct gb_loopback_async_operation *op_async;
553 op_async = container_of(work, struct gb_loopback_async_operation, work);
555 operation = op_async->operation;
557 mutex_lock(&gb->mutex);
558 if (op_async->pending) {
559 gb->requests_timedout++;
561 gb->iteration_count++;
562 op_async->pending = false;
563 gb_loopback_async_operation_put(op_async);
564 gb_loopback_calculate_stats(gb, true);
566 mutex_unlock(&gb->mutex);
568 dev_dbg(&gb->connection->bundle->dev, "timeout operation %d\n",
571 gb_operation_cancel(operation, -ETIMEDOUT);
572 gb_loopback_async_operation_put(op_async);
575 static void gb_loopback_async_operation_timeout(unsigned long data)
577 struct gb_loopback_async_operation *op_async;
580 op_async = gb_loopback_operation_find(id);
582 pr_err("operation %d not found - time out ?\n", id);
585 schedule_work(&op_async->work);
588 static int gb_loopback_async_operation(struct gb_loopback *gb, int type,
589 void *request, int request_size,
593 struct gb_loopback_async_operation *op_async;
594 struct gb_operation *operation;
598 op_async = kzalloc(sizeof(*op_async), GFP_KERNEL);
602 INIT_WORK(&op_async->work, gb_loopback_async_operation_work);
603 kref_init(&op_async->kref);
605 operation = gb_operation_create(gb->connection, type, request_size,
606 response_size, GFP_KERNEL);
613 memcpy(operation->request->payload, request, request_size);
616 op_async->operation = operation;
617 op_async->completion = completion;
619 spin_lock_irqsave(&gb_dev.lock, flags);
620 list_add_tail(&op_async->entry, &gb_dev.list_op_async);
621 spin_unlock_irqrestore(&gb_dev.lock, flags);
623 do_gettimeofday(&op_async->ts);
624 op_async->pending = true;
625 atomic_inc(&gb->outstanding_operations);
626 mutex_lock(&gb->mutex);
627 ret = gb_operation_request_send(operation,
628 gb_loopback_async_operation_callback,
634 setup_timer(&op_async->timer, gb_loopback_async_operation_timeout,
635 (unsigned long)operation->id);
636 op_async->timer.expires = jiffies + gb->jiffy_timeout;
637 add_timer(&op_async->timer);
641 gb_loopback_async_operation_put(op_async);
643 mutex_unlock(&gb->mutex);
647 static int gb_loopback_sync_sink(struct gb_loopback *gb, u32 len)
649 struct gb_loopback_transfer_request *request;
652 request = kmalloc(len + sizeof(*request), GFP_KERNEL);
656 request->len = cpu_to_le32(len);
657 retval = gb_loopback_operation_sync(gb, GB_LOOPBACK_TYPE_SINK,
658 request, len + sizeof(*request),
664 static int gb_loopback_sync_transfer(struct gb_loopback *gb, u32 len)
666 struct gb_loopback_transfer_request *request;
667 struct gb_loopback_transfer_response *response;
670 gb->apbridge_latency_ts = 0;
671 gb->gbphy_latency_ts = 0;
673 request = kmalloc(len + sizeof(*request), GFP_KERNEL);
676 response = kmalloc(len + sizeof(*response), GFP_KERNEL);
682 memset(request->data, 0x5A, len);
684 request->len = cpu_to_le32(len);
685 retval = gb_loopback_operation_sync(gb, GB_LOOPBACK_TYPE_TRANSFER,
686 request, len + sizeof(*request),
687 response, len + sizeof(*response));
691 if (memcmp(request->data, response->data, len)) {
692 dev_err(&gb->connection->bundle->dev,
693 "Loopback Data doesn't match\n");
696 gb->apbridge_latency_ts = (u32)__le32_to_cpu(response->reserved0);
697 gb->gbphy_latency_ts = (u32)__le32_to_cpu(response->reserved1);
706 static int gb_loopback_sync_ping(struct gb_loopback *gb)
708 return gb_loopback_operation_sync(gb, GB_LOOPBACK_TYPE_PING,
712 static int gb_loopback_async_sink(struct gb_loopback *gb, u32 len)
714 struct gb_loopback_transfer_request *request;
717 request = kmalloc(len + sizeof(*request), GFP_KERNEL);
721 request->len = cpu_to_le32(len);
722 retval = gb_loopback_async_operation(gb, GB_LOOPBACK_TYPE_SINK,
723 request, len + sizeof(*request),
729 static int gb_loopback_async_transfer_complete(
730 struct gb_loopback_async_operation *op_async)
732 struct gb_loopback *gb;
733 struct gb_operation *operation;
734 struct gb_loopback_transfer_request *request;
735 struct gb_loopback_transfer_response *response;
740 operation = op_async->operation;
741 request = operation->request->payload;
742 response = operation->response->payload;
743 len = le32_to_cpu(request->len);
745 if (memcmp(request->data, response->data, len)) {
746 dev_err(&gb->connection->bundle->dev,
747 "Loopback Data doesn't match operation id %d\n",
751 gb->apbridge_latency_ts =
752 (u32)__le32_to_cpu(response->reserved0);
753 gb->gbphy_latency_ts =
754 (u32)__le32_to_cpu(response->reserved1);
760 static int gb_loopback_async_transfer(struct gb_loopback *gb, u32 len)
762 struct gb_loopback_transfer_request *request;
763 int retval, response_len;
765 request = kmalloc(len + sizeof(*request), GFP_KERNEL);
769 memset(request->data, 0x5A, len);
771 request->len = cpu_to_le32(len);
772 response_len = sizeof(struct gb_loopback_transfer_response);
773 retval = gb_loopback_async_operation(gb, GB_LOOPBACK_TYPE_TRANSFER,
774 request, len + sizeof(*request),
776 gb_loopback_async_transfer_complete);
785 static int gb_loopback_async_ping(struct gb_loopback *gb)
787 return gb_loopback_async_operation(gb, GB_LOOPBACK_TYPE_PING,
791 static int gb_loopback_request_handler(struct gb_operation *operation)
793 struct gb_connection *connection = operation->connection;
794 struct gb_loopback_transfer_request *request;
795 struct gb_loopback_transfer_response *response;
796 struct device *dev = &connection->bundle->dev;
799 /* By convention, the AP initiates the version operation */
800 switch (operation->type) {
801 case GB_LOOPBACK_TYPE_PING:
802 case GB_LOOPBACK_TYPE_SINK:
804 case GB_LOOPBACK_TYPE_TRANSFER:
805 if (operation->request->payload_size < sizeof(*request)) {
806 dev_err(dev, "transfer request too small (%zu < %zu)\n",
807 operation->request->payload_size,
809 return -EINVAL; /* -EMSGSIZE */
811 request = operation->request->payload;
812 len = le32_to_cpu(request->len);
813 if (len > gb_dev.size_max) {
814 dev_err(dev, "transfer request too large (%zu > %zu)\n",
815 len, gb_dev.size_max);
819 if (!gb_operation_response_alloc(operation,
820 len + sizeof(*response), GFP_KERNEL)) {
821 dev_err(dev, "error allocating response\n");
824 response = operation->response->payload;
825 response->len = cpu_to_le32(len);
827 memcpy(response->data, request->data, len);
831 dev_err(dev, "unsupported request: %u\n", operation->type);
836 static void gb_loopback_reset_stats(struct gb_loopback *gb)
838 struct gb_loopback_stats reset = {
842 /* Reset per-connection stats */
843 memcpy(&gb->latency, &reset,
844 sizeof(struct gb_loopback_stats));
845 memcpy(&gb->throughput, &reset,
846 sizeof(struct gb_loopback_stats));
847 memcpy(&gb->requests_per_second, &reset,
848 sizeof(struct gb_loopback_stats));
849 memcpy(&gb->apbridge_unipro_latency, &reset,
850 sizeof(struct gb_loopback_stats));
851 memcpy(&gb->gbphy_firmware_latency, &reset,
852 sizeof(struct gb_loopback_stats));
854 /* Should be initialized at least once per transaction set */
855 gb->apbridge_latency_ts = 0;
856 gb->gbphy_latency_ts = 0;
857 memset(&gb->ts, 0, sizeof(struct timeval));
860 static void gb_loopback_update_stats(struct gb_loopback_stats *stats, u32 val)
862 if (stats->min > val)
864 if (stats->max < val)
870 static void gb_loopback_update_stats_window(struct gb_loopback_stats *stats,
874 stats->count += count;
877 if (stats->min > val)
879 if (stats->max < val)
883 static void gb_loopback_requests_update(struct gb_loopback *gb, u32 latency)
885 u64 req = gb->requests_completed * USEC_PER_SEC;
887 gb_loopback_update_stats_window(&gb->requests_per_second, req, latency);
890 static void gb_loopback_throughput_update(struct gb_loopback *gb, u32 latency)
892 u64 aggregate_size = sizeof(struct gb_operation_msg_hdr) * 2;
895 case GB_LOOPBACK_TYPE_PING:
897 case GB_LOOPBACK_TYPE_SINK:
898 aggregate_size += sizeof(struct gb_loopback_transfer_request) +
901 case GB_LOOPBACK_TYPE_TRANSFER:
902 aggregate_size += sizeof(struct gb_loopback_transfer_request) +
903 sizeof(struct gb_loopback_transfer_response) +
910 aggregate_size *= gb->requests_completed;
911 aggregate_size *= USEC_PER_SEC;
912 gb_loopback_update_stats_window(&gb->throughput, aggregate_size,
916 static void gb_loopback_calculate_latency_stats(struct gb_loopback *gb)
920 /* Express latency in terms of microseconds */
921 lat = gb_loopback_nsec_to_usec_latency(gb->elapsed_nsecs);
923 /* Log latency stastic */
924 gb_loopback_update_stats(&gb->latency, lat);
926 /* Raw latency log on a per thread basis */
927 kfifo_in(&gb->kfifo_lat, (unsigned char *)&lat, sizeof(lat));
929 /* Log the firmware supplied latency values */
930 gb_loopback_update_stats(&gb->apbridge_unipro_latency,
931 gb->apbridge_latency_ts);
932 gb_loopback_update_stats(&gb->gbphy_firmware_latency,
933 gb->gbphy_latency_ts);
936 static void gb_loopback_calculate_stats(struct gb_loopback *gb, bool error)
943 gb->requests_completed++;
944 gb_loopback_calculate_latency_stats(gb);
947 do_gettimeofday(&te);
948 nlat = gb_loopback_calc_latency(&gb->ts, &te);
949 if (nlat >= NSEC_PER_SEC || gb->iteration_count == gb->iteration_max) {
950 lat = gb_loopback_nsec_to_usec_latency(nlat);
952 gb_loopback_throughput_update(gb, lat);
953 gb_loopback_requests_update(gb, lat);
955 if (gb->iteration_count != gb->iteration_max) {
957 gb->requests_completed = 0;
962 static void gb_loopback_async_wait_to_send(struct gb_loopback *gb)
964 if (!(gb->async && gb->outstanding_operations_max))
966 wait_event_interruptible(gb->wq_completion,
967 (atomic_read(&gb->outstanding_operations) <
968 gb->outstanding_operations_max) ||
969 kthread_should_stop());
972 static int gb_loopback_fn(void *data)
980 struct gb_loopback *gb = data;
981 struct gb_bundle *bundle = gb->connection->bundle;
983 ret = gb_pm_runtime_get_sync(bundle);
989 gb_pm_runtime_put_autosuspend(bundle);
990 wait_event_interruptible(gb->wq, gb->type ||
991 kthread_should_stop());
992 ret = gb_pm_runtime_get_sync(bundle);
997 if (kthread_should_stop())
1000 /* Limit the maximum number of in-flight async operations */
1001 gb_loopback_async_wait_to_send(gb);
1002 if (kthread_should_stop())
1005 mutex_lock(&gb->mutex);
1007 /* Optionally terminate */
1008 if (gb->send_count == gb->iteration_max) {
1009 mutex_unlock(&gb->mutex);
1011 /* Wait for synchronous and asynchronus completion */
1012 gb_loopback_async_wait_all(gb);
1014 /* Mark complete unless user-space has poked us */
1015 mutex_lock(&gb->mutex);
1016 if (gb->iteration_count == gb->iteration_max) {
1019 sysfs_notify(&gb->dev->kobj, NULL,
1021 dev_dbg(&bundle->dev, "load test complete\n");
1023 dev_dbg(&bundle->dev,
1024 "continuing on with new test set\n");
1026 mutex_unlock(&gb->mutex);
1030 us_wait = gb->us_wait;
1032 if (gb->ts.tv_usec == 0 && gb->ts.tv_sec == 0)
1033 do_gettimeofday(&gb->ts);
1034 mutex_unlock(&gb->mutex);
1036 /* Else operations to perform */
1038 if (type == GB_LOOPBACK_TYPE_PING)
1039 error = gb_loopback_async_ping(gb);
1040 else if (type == GB_LOOPBACK_TYPE_TRANSFER)
1041 error = gb_loopback_async_transfer(gb, size);
1042 else if (type == GB_LOOPBACK_TYPE_SINK)
1043 error = gb_loopback_async_sink(gb, size);
1047 gb->iteration_count++;
1050 /* We are effectively single threaded here */
1051 if (type == GB_LOOPBACK_TYPE_PING)
1052 error = gb_loopback_sync_ping(gb);
1053 else if (type == GB_LOOPBACK_TYPE_TRANSFER)
1054 error = gb_loopback_sync_transfer(gb, size);
1055 else if (type == GB_LOOPBACK_TYPE_SINK)
1056 error = gb_loopback_sync_sink(gb, size);
1060 gb->iteration_count++;
1061 gb_loopback_calculate_stats(gb, !!error);
1066 if (us_wait < 20000)
1067 usleep_range(us_wait, us_wait + 100);
1069 msleep(us_wait / 1000);
1073 gb_pm_runtime_put_autosuspend(bundle);
1078 static int gb_loopback_dbgfs_latency_show_common(struct seq_file *s,
1079 struct kfifo *kfifo,
1080 struct mutex *mutex)
1085 if (kfifo_len(kfifo) == 0) {
1091 retval = kfifo_out(kfifo, &latency, sizeof(latency));
1093 seq_printf(s, "%u", latency);
1096 mutex_unlock(mutex);
1101 static int gb_loopback_dbgfs_latency_show(struct seq_file *s, void *unused)
1103 struct gb_loopback *gb = s->private;
1105 return gb_loopback_dbgfs_latency_show_common(s, &gb->kfifo_lat,
1109 static int gb_loopback_latency_open(struct inode *inode, struct file *file)
1111 return single_open(file, gb_loopback_dbgfs_latency_show,
1115 static const struct file_operations gb_loopback_debugfs_latency_ops = {
1116 .open = gb_loopback_latency_open,
1118 .llseek = seq_lseek,
1119 .release = single_release,
1122 static int gb_loopback_bus_id_compare(void *priv, struct list_head *lha,
1123 struct list_head *lhb)
1125 struct gb_loopback *a = list_entry(lha, struct gb_loopback, entry);
1126 struct gb_loopback *b = list_entry(lhb, struct gb_loopback, entry);
1127 struct gb_connection *ca = a->connection;
1128 struct gb_connection *cb = b->connection;
1130 if (ca->bundle->intf->interface_id < cb->bundle->intf->interface_id)
1132 if (cb->bundle->intf->interface_id < ca->bundle->intf->interface_id)
1134 if (ca->bundle->id < cb->bundle->id)
1136 if (cb->bundle->id < ca->bundle->id)
1138 if (ca->intf_cport_id < cb->intf_cport_id)
1140 else if (cb->intf_cport_id < ca->intf_cport_id)
1146 static void gb_loopback_insert_id(struct gb_loopback *gb)
1148 struct gb_loopback *gb_list;
1151 /* perform an insertion sort */
1152 list_add_tail(&gb->entry, &gb_dev.list);
1153 list_sort(NULL, &gb_dev.list, gb_loopback_bus_id_compare);
1154 list_for_each_entry(gb_list, &gb_dev.list, entry) {
1155 gb_list->lbid = 1 << new_lbid;
1160 #define DEBUGFS_NAMELEN 32
1162 static int gb_loopback_probe(struct gb_bundle *bundle,
1163 const struct greybus_bundle_id *id)
1165 struct greybus_descriptor_cport *cport_desc;
1166 struct gb_connection *connection;
1167 struct gb_loopback *gb;
1170 char name[DEBUGFS_NAMELEN];
1171 unsigned long flags;
1173 if (bundle->num_cports != 1)
1176 cport_desc = &bundle->cport_desc[0];
1177 if (cport_desc->protocol_id != GREYBUS_PROTOCOL_LOOPBACK)
1180 gb = kzalloc(sizeof(*gb), GFP_KERNEL);
1184 connection = gb_connection_create(bundle, le16_to_cpu(cport_desc->id),
1185 gb_loopback_request_handler);
1186 if (IS_ERR(connection)) {
1187 retval = PTR_ERR(connection);
1191 gb->connection = connection;
1192 greybus_set_drvdata(bundle, gb);
1194 init_waitqueue_head(&gb->wq);
1195 init_waitqueue_head(&gb->wq_completion);
1196 atomic_set(&gb->outstanding_operations, 0);
1197 gb_loopback_reset_stats(gb);
1199 /* Reported values to user-space for min/max timeouts */
1200 gb->timeout_min = jiffies_to_usecs(GB_LOOPBACK_TIMEOUT_MIN);
1201 gb->timeout_max = jiffies_to_usecs(GB_LOOPBACK_TIMEOUT_MAX);
1203 if (!gb_dev.count) {
1204 /* Calculate maximum payload */
1205 gb_dev.size_max = gb_operation_get_payload_size_max(connection);
1206 if (gb_dev.size_max <=
1207 sizeof(struct gb_loopback_transfer_request)) {
1209 goto out_connection_destroy;
1211 gb_dev.size_max -= sizeof(struct gb_loopback_transfer_request);
1214 /* Create per-connection sysfs and debugfs data-points */
1215 snprintf(name, sizeof(name), "raw_latency_%s",
1216 dev_name(&connection->bundle->dev));
1217 gb->file = debugfs_create_file(name, S_IFREG | 0444, gb_dev.root, gb,
1218 &gb_loopback_debugfs_latency_ops);
1220 gb->id = ida_simple_get(&loopback_ida, 0, 0, GFP_KERNEL);
1223 goto out_debugfs_remove;
1226 retval = gb_connection_enable(connection);
1228 goto out_ida_remove;
1230 dev = device_create_with_groups(&loopback_class,
1231 &connection->bundle->dev,
1232 MKDEV(0, 0), gb, loopback_groups,
1233 "gb_loopback%d", gb->id);
1235 retval = PTR_ERR(dev);
1236 goto out_connection_disable;
1240 /* Allocate kfifo */
1241 if (kfifo_alloc(&gb->kfifo_lat, kfifo_depth * sizeof(u32),
1246 if (kfifo_alloc(&gb->kfifo_ts, kfifo_depth * sizeof(struct timeval) * 2,
1252 /* Fork worker thread */
1253 mutex_init(&gb->mutex);
1254 gb->task = kthread_run(gb_loopback_fn, gb, "gb_loopback");
1255 if (IS_ERR(gb->task)) {
1256 retval = PTR_ERR(gb->task);
1260 spin_lock_irqsave(&gb_dev.lock, flags);
1261 gb_loopback_insert_id(gb);
1263 spin_unlock_irqrestore(&gb_dev.lock, flags);
1265 gb_connection_latency_tag_enable(connection);
1267 gb_pm_runtime_put_autosuspend(bundle);
1272 kfifo_free(&gb->kfifo_ts);
1274 kfifo_free(&gb->kfifo_lat);
1276 device_unregister(dev);
1277 out_connection_disable:
1278 gb_connection_disable(connection);
1280 ida_simple_remove(&loopback_ida, gb->id);
1282 debugfs_remove(gb->file);
1283 out_connection_destroy:
1284 gb_connection_destroy(connection);
1291 static void gb_loopback_disconnect(struct gb_bundle *bundle)
1293 struct gb_loopback *gb = greybus_get_drvdata(bundle);
1294 unsigned long flags;
1297 ret = gb_pm_runtime_get_sync(bundle);
1299 gb_pm_runtime_get_noresume(bundle);
1301 gb_connection_disable(gb->connection);
1303 if (!IS_ERR_OR_NULL(gb->task))
1304 kthread_stop(gb->task);
1306 kfifo_free(&gb->kfifo_lat);
1307 kfifo_free(&gb->kfifo_ts);
1308 gb_connection_latency_tag_disable(gb->connection);
1309 debugfs_remove(gb->file);
1312 * FIXME: gb_loopback_async_wait_all() is redundant now, as connection
1313 * is disabled at the beginning and so we can't have any more
1314 * incoming/outgoing requests.
1316 gb_loopback_async_wait_all(gb);
1318 spin_lock_irqsave(&gb_dev.lock, flags);
1320 list_del(&gb->entry);
1321 spin_unlock_irqrestore(&gb_dev.lock, flags);
1323 device_unregister(gb->dev);
1324 ida_simple_remove(&loopback_ida, gb->id);
1326 gb_connection_destroy(gb->connection);
1330 static const struct greybus_bundle_id gb_loopback_id_table[] = {
1331 { GREYBUS_DEVICE_CLASS(GREYBUS_CLASS_LOOPBACK) },
1334 MODULE_DEVICE_TABLE(greybus, gb_loopback_id_table);
1336 static struct greybus_driver gb_loopback_driver = {
1338 .probe = gb_loopback_probe,
1339 .disconnect = gb_loopback_disconnect,
1340 .id_table = gb_loopback_id_table,
1343 static int loopback_init(void)
1347 INIT_LIST_HEAD(&gb_dev.list);
1348 INIT_LIST_HEAD(&gb_dev.list_op_async);
1349 spin_lock_init(&gb_dev.lock);
1350 gb_dev.root = debugfs_create_dir("gb_loopback", NULL);
1352 retval = class_register(&loopback_class);
1356 retval = greybus_register(&gb_loopback_driver);
1358 goto err_unregister;
1363 class_unregister(&loopback_class);
1365 debugfs_remove_recursive(gb_dev.root);
1368 module_init(loopback_init);
1370 static void __exit loopback_exit(void)
1372 debugfs_remove_recursive(gb_dev.root);
1373 greybus_deregister(&gb_loopback_driver);
1374 class_unregister(&loopback_class);
1375 ida_destroy(&loopback_ida);
1377 module_exit(loopback_exit);
1379 MODULE_LICENSE("GPL v2");