qcacmn: Create serialization component's public API

Define the public APIs for serialization component for other
components to use.

Change-Id: I66c8fd2c85aaf7b78f98ea6a273784fa253969b6
CRs-Fixed: 2000032

umac/cmn_services/serialization/inc/wlan_serialization_api.h

@@ -0,0 +1,380 @@
+/*
+ * Copyright (c) 2017 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.
+ */
+
+/**
+ * DOC: wlan_serialization_api.h
+ * This file provides prototypes of the routines needed for the
+ * external components to utilize the services provided by the
+ * serialization component.
+ */
+
+/* Include files */
+#ifndef __WLAN_SERIALIZATION_API_H
+#define __WLAN_SERIALIZATION_API_H
+
+#include "qdf_status.h"
+#include "wlan_objmgr_cmn.h"
+
+/* Preprocessor Definitions and Constants */
+
+/*
+ * struct wlan_serialization_queued_cmd_info member queue_type specifies the
+ * below values to cancel the commands in these queues. Setting both the
+ * bits will cancel the commands in both the queues.
+ */
+#define WLAN_SERIALIZATION_ACTIVE_QUEUE  0x1
+#define WLAN_SERIALIZATION_PENDING_QUEUE 0x2
+
+/**
+ * enum wlan_serialization_cb_reason - reason for calling the callback
+ * WLAN_SERIALIZATION_REASON_ACTIVATE_CMD: activate the cmd by sending it to FW
+ * WLAN_SERIALIZATION_REASON_CANCEL_CMD: Cancel the cmd in the pending list
+ * WLAN_SERIALIZATION_REASON_RELEASE_MEM_CMD:cmd execution complete. Release
+ *                                           the memory allocated while
+ *                                           building the command
+ */
+enum wlan_serialization_cb_reason {
+	WLAN_SER_CB_ACTIVATE_CMD,
+	WLAN_SER_CB_CANCEL_CMD,
+	WLAN_SER_CB_RELEASE_MEM_CMD,
+};
+
+/**
+ * struct wlan_serialization_scan_info - Information needed for scan cmd
+ * @is_cac_in_progress: boolean to check the cac status
+ *
+ * This information is needed for scan command from other components
+ * to apply the rules and check whether the cmd is allowed or not
+ */
+struct wlan_serialization_scan_info {
+	bool is_cac_in_progress;
+};
+
+/**
+ * union wlan_serialization_rules_info - union of all rules info structures
+ * @scan_info: information needed to apply rules on scan command
+ */
+union wlan_serialization_rules_info {
+	struct wlan_serialization_scan_info scan_info;
+};
+
+/**
+ * wlan_serialization_cmd_callback() - Callback registered by the component
+ * @wlan_cmd: Command passed by the component for serialization
+ * @reason: Reason code for which the callback is being called
+ *
+ * Reason specifies the reason for which the callback is being called
+ *
+ * Return: None
+ */
+typedef void (*wlan_serialization_cmd_callback)(
+		void *wlan_cmd, enum wlan_serialization_cb_reason reason);
+
+/**
+ * wlan_serialization_active_cmd_timeout_callback() - callback for cmd timeout
+ * @wlan_cmd: Command that has timed out
+ *
+ * Return: None
+ */
+typedef void (*wlan_serialization_active_cmd_timeout_callback)(
+		void *wlan_cmd);
+
+/**
+ * wlan_serialization_comp_info_cb() - callback to fill the rules information
+ * @comp_info: Information filled by the component
+ *
+ * This callback is registered dynamically by the component with the
+ * serialization component. Serialization component invokes the callback
+ * while applying the rules for a particular command and the component
+ * fills in the required information to apply the rules
+ *
+ * Return: None
+ */
+typedef void (*wlan_serialization_comp_info_cb)(
+		union wlan_serialization_rules_info *comp_info);
+
+/**
+ * wlan_serialization_apply_rules_cb() - callback per command to apply rules
+ * @comp_info: information needed to apply the rules
+ *
+ * The rules are applied using this callback and decided whether to
+ * allow or deny the command
+ *
+ * Return: true, if rules are successfull and cmd can be queued
+ *         false, if rules failed and cmd should not be queued
+ */
+typedef bool (*wlan_serialization_apply_rules_cb)(
+		union wlan_serialization_rules_info *comp_info);
+
+/**
+ * enum wlan_umac_cmd_id - Command Type
+ * @WLAN_SER_CMD_SCAN:     Scan command
+ */
+enum wlan_serialization_cmd_type {
+	WLAN_SER_CMD_SCAN,
+	WLAN_SER_CMD_MAX,
+};
+
+/**
+ * enum wlan_serialization_cancel_type - Type of commands to be cancelled
+ * @WLAN_SER_CANCEL_SINGLE_SCAN: Cancel a single scan with a given ID
+ * @WLAN_SER_CANCEL_PDEV_SCANS: Cancel all the scans on a given pdev
+ * @WLAN_SER_CANCEL_VDEV_SCANS: Cancel all the scans on given vdev
+ * @WLAN_SER_CANCEL_NON_SCAN_CMD: Cancel the given non scan command
+ */
+enum wlan_serialization_cancel_type {
+	WLAN_SER_CANCEL_SINGLE_SCAN,
+	WLAN_SER_CANCEL_PDEV_SCANS,
+	WLAN_SER_CANCEL_VDEV_SCANS,
+	WLAN_SER_CANCEL_NON_SCAN_CMD,
+	WLAN_SER_CANCEL_MAX,
+};
+
+/**
+ * enum wlan_serialization_status - Return status of cmd serialization request
+ * @WLAN_SER_CMD_PENDING: Command is put into the pending queue
+ * @WLAN_SER_CMD_ACTIVE: Command is activated and put in active queue
+ * @WLAN_SER_CMD_DENIED_RULES_FAILED: Command denied as the rules fail
+ * @WLAN_SER_CMD_DENIED_LIST_FULL: Command denied as the pending list is full
+ * @WLAN_SER_CMD_DENIED_UNSPECIFIED: Command denied due to unknown reason
+ */
+enum wlan_serialization_status {
+	WLAN_SER_CMD_PENDING,
+	WLAN_SER_CMD_ACTIVE,
+	WLAN_SER_CMD_DENIED_RULES_FAILED,
+	WLAN_SER_CMD_DENIED_LIST_FULL,
+	WLAN_SER_CMD_DENIED_UNSPECIFIED,
+};
+
+/**
+ * enum wlan_serialization_cmd_status - Return status for a cancel request
+ * @WLAN_SER_CMD_IN_PENDING_LIST: Command cancelled from pending list
+ * @WLAN_SER_CMD_IN_ACTIVE_LIST: Command cancelled from active list
+ * @WLAN_SER_CMDS_IN_ALL_LISTS: Command cancelled from all lists
+ * @WLAN_SER_CMD_NOT_FOUND: Specified command to be cancelled
+ *                                    not found in the lists
+ */
+enum wlan_serialization_cmd_status {
+	WLAN_SER_CMD_IN_PENDING_LIST,
+	WLAN_SER_CMD_IN_ACTIVE_LIST,
+	WLAN_SER_CMDS_IN_ALL_LISTS,
+	WLAN_SER_CMD_NOT_FOUND,
+};
+
+/**
+ * union wlan_serialization_obj_context - Object associated to the command
+ * @pdev: PDEV object associated to the command
+ * @vdev: VDEV object associated to the command
+ *
+ * Object passed for the command
+ * This is an agreement between the component and serialization as to which
+ * object is being passed. A copy of this command is maintained by
+ * serialization as part of queuing the command. So, the object ref count has
+ * to be maintained while queuing and released during cancellation/dequeuing/
+ * flushing the command.
+ */
+union wlan_serialization_obj_context {
+	struct wlan_objmgr_pdev *pdev;
+	struct wlan_objmgr_vdev *vdev;
+};
+
+/**
+ * struct wlan_serialization_command - Command to be serialized
+ * @wlan_serialization_cmd_type: Type of command
+ * @cmd_id: Command Identifier
+ * @cmd_cb: Command callback
+ * @source: component ID of the source of the command
+ * @is_high_priority: Normal/High Priority at which the cmd has to be queued
+ * @cmd_timeout_cb: Command timeout callback
+ * @cmd_timeout_duration: Timeout duration in milliseconds
+ * @obj_ctxt: Object passed for the command
+ * @umac_cmd: Actual command that needs to be sent to WMI/firmware
+ */
+struct wlan_serialization_command {
+	enum wlan_serialization_cmd_type cmd_type;
+	uint16_t cmd_id;
+	wlan_serialization_cmd_callback cmd_cb;
+	uint8_t source;
+	uint8_t is_high_priority;
+	wlan_serialization_active_cmd_timeout_callback cmd_timeout_cb;
+	uint16_t cmd_timeout_duration;
+	union wlan_serialization_obj_context obj_ctxt;
+	void *umac_cmd;
+};
+
+/**
+ * struct wlan_serialization_queued_cmd_info  - cmd that has to be cancelled
+ * @requestor: component ID of the source requesting this action
+ * @cmd_type: Command type
+ * @cmd_id: Command ID
+ * @req_type: Commands that need to be cancelled
+ * @obj_ctxt: PDEV/VDEV object on which the commands need to be cancelled
+ * @queue_type: Queues from which the command to be cancelled
+ */
+struct wlan_serialization_queued_cmd_info {
+	uint8_t requestor;
+	enum wlan_serialization_cmd_type cmd_type;
+	uint16_t cmd_id;
+	enum wlan_serialization_cancel_type req_type;
+	union wlan_serialization_obj_context obj_ctxt;
+	uint8_t queue_type;
+};
+
+/**
+ * wlan_serialization_cancel_request() - Request to cancel a command
+ * @req: Request information
+ *
+ * This API is used by external components to cancel a command
+ * that is either in the pending or active queue. Based on the
+ * req_type, it is decided whether to use pdev or vdev
+ * object. For all non-scan commands, it will be pdev.
+ *
+ * Return: Status specifying the removal of a command from a certain queue
+ */
+enum wlan_serialization_cmd_status
+wlan_serialization_cancel_request(
+		struct wlan_serialization_queued_cmd_info *req);
+
+/**
+ * wlan_serialization_remove_cmd() - Request to release a command
+ * @cmd: Command information
+ *
+ * This API is used to release a command sitting in the active
+ * queue upon successful completion of the command
+ *
+ * Return: None
+ */
+void wlan_serialization_remove_cmd(
+		struct wlan_serialization_queued_cmd_info *cmd);
+
+/**
+ * wlan_serialization_flush_cmd() - Request to flush command
+ * @cmd: Command information
+ *
+ * This API is used to flush a cmd sitting in the queue. It
+ * simply flushes the cmd from the queue and does not call
+ * any callbacks in between. If the request is for active
+ * queue, and if the active queue becomes empty upon flush,
+ * then it will pick the next pending cmd and put in the active
+ * queue before returning.
+ *
+ * Return: None
+ */
+void wlan_serialization_flush_cmd(
+		struct wlan_serialization_queued_cmd_info *cmd);
+/**
+ * wlan_serialization_request() - Request to serialize a command
+ * @cmd: Command information
+ *
+ * Return: Status of the serialization request
+ */
+enum wlan_serialization_status
+wlan_serialization_request(struct wlan_serialization_command *cmd);
+
+/**
+ * wlan_serialization_register_comp_info_cb() - Register component's info
+ * 						callback
+ * @psoc: PSOC object information
+ * @comp_id: Component ID
+ * @cmd_id: Command ID
+ * @cb: Callback
+ *
+ * This is called from component during its initialization.It initializes
+ * callback handler for given comp_id/cmd_id in a 2-D array.
+ *
+ * Return: QDF Status
+ */
+QDF_STATUS
+wlan_serialization_register_comp_info_cb(struct wlan_objmgr_psoc *psoc,
+		enum wlan_umac_comp_id comp_id,
+		enum wlan_serialization_cmd_type cmd_id,
+		wlan_serialization_comp_info_cb cb);
+
+/**
+ * wlan_serialization_deregister_comp_info_cb() - Deregister component's info
+ * 						  callback
+ * @psoc: PSOC object information
+ * @comp_id: Component ID
+ * @cmd_id: Command ID
+ *
+ * This routine is called from other component during its de-initialization.
+ *
+ * Return: QDF Status
+ */
+QDF_STATUS
+wlan_serialization_deregister_comp_info_cb(struct wlan_objmgr_psoc *psoc,
+		enum wlan_umac_comp_id comp_id,
+		enum wlan_serialization_cmd_type cmd_id);
+
+/**
+ * @wlan_serialization_init() - Serialization component initialization routine
+ *
+ * Return - QDF Status
+ */
+QDF_STATUS wlan_serialization_init(void);
+
+/**
+ * @wlan_serialization_deinit() - Serialization component de-init routine
+ *
+ * Return - QDF Status
+ */
+QDF_STATUS wlan_serialization_deinit(void);
+
+/**
+ * @wlan_serialization_psoc_open() - Serialization component open routine
+ *
+ * Return - QDF Status
+ */
+QDF_STATUS wlan_serialization_psoc_open(struct wlan_objmgr_psoc *psoc);
+
+/**
+ * @wlan_serialization_psoc_close() - Serialization component close routine
+ *
+ * Return - QDF Status
+ */
+QDF_STATUS wlan_serialization_psoc_close(struct wlan_objmgr_psoc *psoc);
+
+/**
+ * wlan_serialization_vdev_scan_status() - Return the status of the vdev scan
+ * @vdev: VDEV Object
+ *
+ * Return: Status of the scans for the corresponding vdev
+ */
+enum wlan_serialization_cmd_status
+wlan_serialization_vdev_scan_status(struct wlan_objmgr_vdev *vdev);
+
+/**
+ * wlan_serialization_pdev_scan_status() - Return the status of the pdev scan
+ * @pdev: PDEV Object
+ *
+ * Return: Status of the scans for the corresponding pdev
+ */
+enum wlan_serialization_cmd_status
+wlan_serialization_pdev_scan_status(struct wlan_objmgr_pdev *pdev);
+
+/**
+ * wlan_serialization_non_scan_cmd_status() - Return status of pdev non-scan cmd
+ * @pdev: PDEV Object
+ * @cmd_id: ID of the command for which the status has to be checked
+ *
+ * Return: Status of the command for the corresponding pdev
+ */
+enum wlan_serialization_cmd_status
+wlan_serialization_non_scan_cmd_status(struct wlan_objmgr_pdev *pdev,
+		enum wlan_serialization_cmd_type cmd_id);
+#endif

umac/cmn_services/serialization/src/wlan_serialization_api.c

@@ -0,0 +1,122 @@
+/*
+ * Copyright (c) 2017 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.
+ */
+
+/**
+ * DOC: wlan_serialization_api.c
+ * This file provides an interface for the external components
+ * to utilize the services provided by the serialization
+ * component.
+ */
+
+/* Include files */
+#include "wlan_objmgr_psoc_obj.h"
+#include "wlan_serialization_main_i.h"
+
+QDF_STATUS
+wlan_serialization_register_comp_info_cb(struct wlan_objmgr_psoc *psoc,
+		enum wlan_umac_comp_id comp_id,
+		enum wlan_serialization_cmd_type cmd_type,
+		wlan_serialization_comp_info_cb cb)
+{
+	struct wlan_serialization_psoc_priv_obj *ser_soc_obj;
+	QDF_STATUS status;
+
+	status = wlan_serialization_validate_cmd(comp_id, cmd_type);
+	if (status != QDF_STATUS_SUCCESS)
+		return status;
+	ser_soc_obj = wlan_serialization_get_psoc_priv_obj(psoc);
+	ser_soc_obj->comp_info_cb[cmd_type][comp_id] = cb;
+
+	return QDF_STATUS_SUCCESS;
+}
+
+QDF_STATUS
+wlan_serialization_deregister_comp_info_cb(struct wlan_objmgr_psoc *psoc,
+		enum wlan_umac_comp_id comp_id,
+		enum wlan_serialization_cmd_type cmd_type)
+{
+	struct wlan_serialization_psoc_priv_obj *ser_soc_obj;
+	QDF_STATUS status;
+
+	status = wlan_serialization_validate_cmd(comp_id, cmd_type);
+	if (status != QDF_STATUS_SUCCESS)
+		return status;
+	ser_soc_obj = wlan_serialization_get_psoc_priv_obj(psoc);
+	ser_soc_obj->comp_info_cb[cmd_type][comp_id] = NULL;
+
+	return QDF_STATUS_SUCCESS;
+}
+
+enum wlan_serialization_cmd_status
+wlan_serialization_vdev_scan_status(struct wlan_objmgr_vdev *vdev)
+{
+	serialization_info("vdev scan status entry");
+
+	return WLAN_SER_CMD_NOT_FOUND;
+}
+
+enum wlan_serialization_cmd_status
+wlan_serialization_pdev_scan_status(struct wlan_objmgr_pdev *pdev)
+{
+	serialization_info("pdev scan status entry");
+
+	return WLAN_SER_CMD_NOT_FOUND;
+}
+
+enum wlan_serialization_cmd_status
+wlan_serialization_non_scan_cmd_status(struct wlan_objmgr_pdev *pdev,
+		enum wlan_serialization_cmd_type cmd_id)
+{
+	serialization_info("pdev non cmd status entry");
+
+	return WLAN_SER_CMD_NOT_FOUND;
+}
+
+enum wlan_serialization_cmd_status
+wlan_serialization_cancel_request(
+		struct wlan_serialization_queued_cmd_info *req)
+{
+	serialization_info("serialization cancel request entry");
+
+	return WLAN_SER_CMD_NOT_FOUND;
+}
+
+void wlan_serialization_remove_cmd(
+		struct wlan_serialization_queued_cmd_info *cmd)
+{
+	serialization_info("serialization remove request entry");
+
+	return;
+}
+
+enum wlan_serialization_status
+wlan_serialization_request(struct wlan_serialization_command *cmd)
+{
+	serialization_info("serialization queue cmd entry");
+
+	return WLAN_SER_CMD_NOT_FOUND;
+}
+
+void wlan_serialization_flush_cmd(
+		struct wlan_serialization_queued_cmd_info *cmd)
+{
+	serialization_info("serialization cmd flushed");
+
+	return;
+}
+