qcacmn: Rename control path scheduler from sch to scheduler

Legacy protocol engine already has a module name 'sch' rename control path scheduler from sch to scheduler to avoid naming conflict with protocol sch. Change-Id: I94ce9aa5037aa75319aaad2287116462444c03f4 CRs-Fixed: 1105115
2016-12-24 18:59:55 -08:00
--- a/scheduler/inc/scheduler_api.h
+++ b/scheduler/inc/scheduler_api.h
@@ -0,0 +1,245 @@
+/*
+ * Copyright (c) 2014-2016 The Linux Foundation. All rights reserved.
+ *
+ * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
+ *
+ *
+ * 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.
+ */
+
+/*
+ * This file was originally distributed by Qualcomm Atheros, Inc.
+ * under proprietary terms before Copyright ownership was assigned
+ * to the Linux Foundation.
+ */
+#if !defined(__SCHEDULER_API_H)
+#define __SCHEDULER_API_H
+
+
+#include <qdf_event.h>
+#include <qdf_types.h>
+#include <qdf_lock.h>
+#include <qdf_mc_timer.h>
+#include <qdf_status.h>
+
+
+/* Controller thread various event masks
+ * MC_POST_EVENT_MASK: wake up thread after posting message
+ * MC_SUSPEND_EVENT_MASK: signal thread to suspend during kernel pm suspend
+ * MC_SHUTDOWN_EVENT_MASK: signal thread to shutdown and exit during unload
+ */
+#define MC_POST_EVENT_MASK               0x001
+#define MC_SUSPEND_EVENT_MASK            0x002
+#define MC_SHUTDOWN_EVENT_MASK           0x010
+
+/*
+ * Cookie for timer messages.  Note that anyone posting a timer message
+ * has to write the COOKIE in the reserved field of the message.  The
+ * timer queue handler relies on this COOKIE
+ */
+#define SYS_MSG_COOKIE      0xFACE
+
+typedef enum {
+	SYS_MSG_ID_MC_START,
+	SYS_MSG_ID_MC_THR_PROBE,
+	SYS_MSG_ID_MC_TIMER,
+	SYS_MSG_ID_MC_STOP,
+	SYS_MSG_ID_FTM_RSP,
+	SYS_MSG_ID_QVIT,
+
+} SYS_MSG_ID;
+
+/**
+ * struct scheduler_msg: scheduler message structure
+ * @type: message type
+ * @reserved: reserved field
+ * @bodyptr: message body pointer based on the type either a bodyptr pointer
+ *     into memory or bodyval as a 32 bit data is used. bodyptr is always a
+ *     freeable pointer, one should always make sure that bodyptr is always
+ *     freeable.
+ * Messages should use either bodyptr or bodyval; not both !!!
+ * @bodyval: message body val
+ * @callback: callback to be called by scheduler thread once message is posted
+ *   and scheduler thread has started processing the message.
+ */
+struct scheduler_msg {
+	uint16_t type;
+	uint16_t reserved;
+	void *bodyptr;
+	uint32_t bodyval;
+	void *callback;
+};
+
+typedef QDF_STATUS (*scheduler_msg_process_fn_t) (struct scheduler_msg  *msg);
+typedef void (*hdd_suspend_callback)(void);
+
+/**
+ * scheduler_init() - initialize control path scheduler
+ *
+ * This API initializes control path scheduler.
+ *
+ * Return: QDF status
+ */
+QDF_STATUS scheduler_init(void);
+
+/**
+ * scheduler_deinit() - de-initialize control path scheduler
+ *
+ * This API de-initializes control path scheduler.
+ *
+ * Return: QDF status
+ */
+QDF_STATUS scheduler_deinit(void);
+
+/**
+ * scheduler_register_module() - register input module/queue id
+ * @qid: queue id to get registered
+ * @callback: queue message to be called when a message is posted
+ *
+ * Return: QDF status
+ */
+QDF_STATUS scheduler_register_module(QDF_MODULE_ID qid,
+		scheduler_msg_process_fn_t callback);
+
+/**
+ * scheduler_deregister_module() - deregister input module/queue id
+ * @qid: queue id to get deregistered
+ *
+ * Return: QDF status
+ */
+QDF_STATUS scheduler_deregister_module(QDF_MODULE_ID qid);
+
+/**
+ * scheduler_post_msg_by_priority() - post messages by priority
+ * @qid: queue id to to post message
+ * @msg: mesage pointer
+ * @is_high_priority: set to true for high priority message else false
+ *
+ * Return: QDF status
+ */
+QDF_STATUS scheduler_post_msg_by_priority(QDF_MODULE_ID qid,
+		struct scheduler_msg *msg, bool is_high_priority);
+
+/**
+ * scheduler_post_msg() - post normal messages(no priority)
+ * @qid: queue id to to post message
+ * @msg: mesage pointer
+ *
+ * Return: QDF status
+ */
+static inline QDF_STATUS scheduler_post_msg(QDF_MODULE_ID qid,
+		struct scheduler_msg *msg)
+{
+	return scheduler_post_msg_by_priority(qid, msg, false);
+}
+
+/**
+ * scheduler_resume() - resume scheduler thread
+ *
+ * Complete scheduler thread resume wait event such that scheduler
+ * thread can wake up and process message queues
+ *
+ * Return: none
+ */
+void scheduler_resume(void);
+
+/**
+ * scheduler_register_hdd_suspend_callback() - suspend callback to hdd
+ * @callback: hdd callback to be called when controllred thread is suspended
+ *
+ * Return: none
+ */
+void scheduler_register_hdd_suspend_callback(hdd_suspend_callback callback);
+
+/**
+ * scheduler_wake_up_controller_thread() - wake up controller thread
+ *
+ * Wake up controller thread to process a critical message.
+ *
+ * Return: none
+ */
+void scheduler_wake_up_controller_thread(void);
+
+/**
+ * scheduler_set_event_mask() - set given event mask
+ * @event_mask: event mask to set
+ *
+ * Set given event mask such that controller scheduler thread can do
+ * specified work after wake up.
+ *
+ * Return: none
+ */
+void scheduler_set_event_mask(uint32_t event_mask);
+
+/**
+ * scheduler_clear_event_mask() - clear given event mask
+ * @event_mask: event mask to set
+ *
+ * Return: none
+ */
+void scheduler_clear_event_mask(uint32_t event_mask);
+
+/**
+ * scheduler_target_if_mq_handler() - top level message queue handler for
+ *                                    target_if message queue
+ * @msg: pointer to actual message being handled
+ *
+ * Return: none
+ */
+QDF_STATUS scheduler_target_if_mq_handler(struct scheduler_msg *msg);
+
+/**
+ * scheduler_os_if_mq_handler() - top level message queue handler for
+ *                                os_if message queue
+ * @msg: pointer to actual message being handled
+ *
+ * Return: none
+ */
+QDF_STATUS scheduler_os_if_mq_handler(struct scheduler_msg *msg);
+
+/**
+ * scheduler_timer_q_mq_handler() - top level message queue handler for
+ *                                timer queue
+ * @msg: pointer to actual message being handled
+ *
+ * Return: none
+ */
+QDF_STATUS scheduler_timer_q_mq_handler(struct scheduler_msg *msg);
+
+/**
+ * scheduler_register_wma_legacy_handler() - register legacy wma handler
+ * @callback: legacy wma handler to be called for WMA messages
+ *
+ * Return: QDF status
+ */
+QDF_STATUS scheduler_register_wma_legacy_handler(scheduler_msg_process_fn_t
+						callback);
+
+/**
+ * scheduler_register_sys_legacy_handler() - register legacy sys handler
+ * @callback: legacy sys handler to be called for sys messages
+ *
+ * Return: QDF status
+ */
+QDF_STATUS scheduler_register_sys_legacy_handler(scheduler_msg_process_fn_t
+						callback);
+/**
+ * scheduler_mc_timer_callback() - timer callback, gets called at time out
+ * @data: unsigned long, holds the timer object.
+ *
+ * Return: None
+ */
+void scheduler_mc_timer_callback(unsigned long data);
+#endif