qcacmn: Add qdf_periodic_work

Add a new deferred work type, qdf_periodic_work, which executes a
callback periodically until stopped.

Change-Id: Iedf5486474fccadb35e146e6d289c27a7c1002d3
CRs-Fixed: 2410005

qdf/test/qdf_periodic_work_test.c

@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2019 The Linux Foundation. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software for
+ * any purpose with or without fee is hereby granted, provided that the
+ * above copyright notice and this permission notice appear in all
+ * copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+ * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+ * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include "qdf_periodic_work.h"
+#include "qdf_periodic_work_test.h"
+#include "qdf_trace.h"
+
+#define pwork_iterations 2
+#define pwork_delay_ms 1
+
+struct qdf_pwork_ut_ctx {
+	struct qdf_periodic_work pwork;
+	uint32_t count;
+};
+
+static void __qdf_pwork_inside_cb(void *context)
+{
+	struct qdf_pwork_ut_ctx *ut_ctx = context;
+
+	/* stop before incrementing; the main thread is looking at @count */
+	if (ut_ctx->count + 1 == pwork_iterations)
+		qdf_periodic_work_stop_async(&ut_ctx->pwork);
+
+	ut_ctx->count++;
+}
+
+static uint32_t qdf_pwork_stop_inside_cb(void)
+{
+	struct qdf_pwork_ut_ctx ut_ctx = { .count = 0 };
+	QDF_STATUS status;
+
+	status = qdf_periodic_work_create(&ut_ctx.pwork,
+					  __qdf_pwork_inside_cb, &ut_ctx);
+	QDF_BUG(QDF_IS_STATUS_SUCCESS(status));
+
+	QDF_BUG(qdf_periodic_work_start(&ut_ctx.pwork, pwork_delay_ms));
+
+	while (ut_ctx.count < pwork_iterations)
+		schedule();
+
+	QDF_BUG(!qdf_periodic_work_stop_sync(&ut_ctx.pwork));
+	QDF_BUG(ut_ctx.count == pwork_iterations);
+
+	qdf_periodic_work_destroy(&ut_ctx.pwork);
+
+	return 0;
+}
+
+static void __qdf_pwork_outside_cb(void *context)
+{
+	struct qdf_pwork_ut_ctx *ut_ctx = context;
+
+	ut_ctx->count++;
+}
+
+static uint32_t qdf_pwork_stop_outside_cb(void)
+{
+	struct qdf_pwork_ut_ctx ut_ctx = { .count = 0 };
+	QDF_STATUS status;
+
+	status = qdf_periodic_work_create(&ut_ctx.pwork,
+					  __qdf_pwork_outside_cb, &ut_ctx);
+	QDF_BUG(QDF_IS_STATUS_SUCCESS(status));
+
+	QDF_BUG(qdf_periodic_work_start(&ut_ctx.pwork, pwork_delay_ms));
+
+	while (ut_ctx.count < pwork_iterations)
+		schedule();
+
+	QDF_BUG(qdf_periodic_work_stop_sync(&ut_ctx.pwork));
+	QDF_BUG(ut_ctx.count >= pwork_iterations);
+
+	qdf_periodic_work_destroy(&ut_ctx.pwork);
+
+	return 0;
+}
+
+uint32_t qdf_periodic_work_unit_test(void)
+{
+	uint32_t errors = 0;
+
+	errors += qdf_pwork_stop_inside_cb();
+	errors += qdf_pwork_stop_outside_cb();
+
+	return errors;
+}
+

qdf/test/qdf_periodic_work_test.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2019 The Linux Foundation. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software for
+ * any purpose with or without fee is hereby granted, provided that the
+ * above copyright notice and this permission notice appear in all
+ * copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+ * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+ * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#ifndef __QDF_PERIODIC_WORK_TEST
+#define __QDF_PERIODIC_WORK_TEST
+
+#ifdef WLAN_PERIODIC_WORK_TEST
+/**
+ * qdf_periodic_work_unit_test() - run the qdf periodic work unit test suite
+ *
+ * Return: number of failed test cases
+ */
+uint32_t qdf_periodic_work_unit_test(void);
+#else
+static inline uint32_t qdf_periodic_work_unit_test(void)
+{
+	return 0;
+}
+#endif /* WLAN_PERIODIC_WORK_TEST */
+
+#endif /* __QDF_PERIODIC_WORK_TEST */
+