qcacld-3.0: Add bearer switch state machine

When there are more than one audio transport mediums
are available, there is a possibility to switch the
audio transport medium from one medium to another
medium.
To provide this support to switch the audio transport
medium, add a bearer switch state machine in host driver.

Change-Id: Ic57c11d2cff72cfa00ce7bc438998c501ce97d33
CRs-Fixed: 3626949

components/umac/mlme/sap/ll_sap/core/src/wlan_ll_lt_sap_bearer_switch.c

@@ -16,6 +16,7 @@
 
 #include "wlan_ll_sap_main.h"
 #include "wlan_ll_lt_sap_bearer_switch.h"
+#include "wlan_sm_engine.h"
 
 uint32_t ll_lt_sap_bearer_switch_get_id(struct wlan_objmgr_vdev *vdev)
 {
@@ -37,3 +38,325 @@ uint32_t ll_lt_sap_bearer_switch_get_id(struct wlan_objmgr_vdev *vdev)
 	return request_id;
 }
 
+/**
+ * bs_state_non_wlan_entry() - Entry API for non wlan state for bearer switch
+ * state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on moving to non-wlan state
+ *
+ * Return: void
+ */
+static void bs_state_non_wlan_entry(void *ctx)
+{
+}
+
+/**
+ * bs_state_non_wlan_exit() - Exit API for non wlan state for bearer switch
+ * state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on exiting from non-wlan state
+ *
+ * Return: void
+ */
+static void bs_state_non_wlan_exit(void *ctx)
+{
+}
+
+/**
+ * bs_state_non_wlan_event() - Non-wlan State event handler for bearer switch
+ * state machine
+ * @ctx: Bearer switch context
+ * @event: event
+ * @data_len: length of @data
+ * @data: event data
+ *
+ * API to handle events in Non-wlan state
+ *
+ * Return: bool
+ */
+static bool bs_state_non_wlan_event(void *ctx, uint16_t event,
+				    uint16_t data_len, void *data)
+{
+	bool event_handled = false;
+
+	switch (event) {
+	case WLAN_BS_SM_EV_SWITCH_TO_WLAN:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN:
+		event_handled = true;
+		break;
+	default:
+		break;
+	}
+
+	return event_handled;
+}
+
+/**
+ * bs_state_non_wlan_req_entry() - Entry API for non wlan requested state for
+ *bearer switch state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on moving to non-wlan requested state
+ *
+ * Return: void
+ */
+static void bs_state_non_wlan_req_entry(void *ctx)
+{
+}
+
+/**
+ * bs_state_non_wlan_req_exit() - Exit API for non wlan requested state for
+ * bearer switch state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on exiting from non-wlan requested state
+ *
+ * Return: void
+ */
+static void bs_state_non_wlan_req_exit(void *ctx)
+{
+}
+
+/**
+ * bs_state_non_wlan_req_event() - Non-wlan requested State event handler for
+ * bearer switch state machine
+ * @ctx: Bearer switch context
+ * @event: event
+ * @data_len: length of @data
+ * @data: event data
+ *
+ * API to handle events in Non-wlan state
+ *
+ * Return: bool
+ */
+static bool bs_state_non_wlan_req_event(void *ctx, uint16_t event,
+					uint16_t data_len, void *data)
+{
+	bool event_handled = false;
+
+	switch (event) {
+	case WLAN_BS_SM_EV_SWITCH_TO_WLAN:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_TIMEOUT:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_COMPLETED:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_FAILURE:
+		event_handled = true;
+		break;
+	default:
+		break;
+	}
+
+	return event_handled;
+}
+
+/**
+ * bs_state_wlan_entry() - Entry API for wlan state for bearer switch
+ * state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on moving to wlan state
+ *
+ * Return: void
+ */
+static void bs_state_wlan_entry(void *ctx)
+{
+}
+
+/**
+ * bs_state_wlan_exit() - Exit API for wlan state for bearer switch
+ * state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on exiting from wlan state
+ *
+ * Return: void
+ */
+static void bs_state_wlan_exit(void *ctx)
+{
+}
+
+/**
+ * bs_state_wlan_event() - Wlan State event handler for bearer switch
+ * state machine
+ * @ctx: Bearer switch context
+ * @event: event
+ * @data_len: length of @data
+ * @data: event data
+ *
+ * API to handle events in Wlan state
+ *
+ * Return: bool
+ */
+static bool bs_state_wlan_event(void *ctx, uint16_t event,
+				uint16_t data_len, void *data)
+{
+	bool event_handled = false;
+
+	switch (event) {
+	case WLAN_BS_SM_EV_SWITCH_TO_WLAN:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN:
+		event_handled = true;
+		break;
+	default:
+		break;
+	}
+
+	return event_handled;
+}
+
+/**
+ * bs_state_wlan_req_entry() - Entry API for Wlan requested state for
+ *bearer switch state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on moving to Wlan requested state
+ *
+ * Return: void
+ */
+static void bs_state_wlan_req_entry(void *ctx)
+{
+}
+
+/**
+ * bs_state_wlan_req_exit() - Exit API for Wlan requested state for
+ * bearer switch state machine
+ * @ctx: Bearer switch context
+ *
+ * API to perform operations on exiting from Wlan requested state
+ *
+ * Return: void
+ */
+static void bs_state_wlan_req_exit(void *ctx)
+{
+}
+
+/**
+ * bs_state_wlan_req_event() - Wlan requested State event handler for
+ * bearer switch state machine
+ * @ctx: Bearer switch context
+ * @event: event
+ * @data_len: length of @data
+ * @data: event data
+ *
+ * API to handle events in Wlan state
+ *
+ * Return: bool
+ */
+static bool bs_state_wlan_req_event(void *ctx, uint16_t event,
+				    uint16_t data_len, void *data)
+{
+	bool event_handled = false;
+
+	switch (event) {
+	case WLAN_BS_SM_EV_SWITCH_TO_WLAN:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN:
+	case WLAN_BS_SM_EV_SWITCH_TO_WLAN_TIMEOUT:
+	case WLAN_BS_SM_EV_SWITCH_TO_WLAN_FAILURE:
+	case WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_FAILURE:
+		event_handled = true;
+		break;
+	default:
+		break;
+	}
+
+	return event_handled;
+}
+
+struct wlan_sm_state_info bs_sm_info[] = {
+	{
+		(uint8_t)BEARER_NON_WLAN,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		false,
+		"NON_WLAN",
+		bs_state_non_wlan_entry,
+		bs_state_non_wlan_exit,
+		bs_state_non_wlan_event
+	},
+	{
+		(uint8_t)BEARER_NON_WLAN_REQUESTED,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		false,
+		"NON_WLAN_REQUESTED",
+		bs_state_non_wlan_req_entry,
+		bs_state_non_wlan_req_exit,
+		bs_state_non_wlan_req_event
+	},
+	{
+		(uint8_t)BEARER_WLAN_REQUESTED,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		false,
+		"WLAN_REQUESTED",
+		bs_state_wlan_req_entry,
+		bs_state_wlan_req_exit,
+		bs_state_wlan_req_event
+	},
+	{
+		(uint8_t)BEARER_WLAN,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		false,
+		"WLAN",
+		bs_state_wlan_entry,
+		bs_state_wlan_exit,
+		bs_state_wlan_event
+	},
+	{
+		(uint8_t)BEARER_SWITCH_MAX,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		(uint8_t)WLAN_SM_ENGINE_STATE_NONE,
+		false,
+		"INVALID",
+		NULL,
+		NULL,
+		NULL
+	},
+};
+
+static const char *bs_sm_event_names[] = {
+	"EV_SW_TO_WLAN",
+	"EV_SW_TO_NON_WLAN",
+	"EV_SW_TO_WLAN_TIMEOUT",
+	"EV_SW_TO_NON_WLAN_TIMEOUT",
+	"EV_SW_TO_WLAN_COMPLETED",
+	"EV_SW_TO_NON_WLAN_COMPLETED",
+	"EV_SW_TO_WLAN_FAILURE",
+	"EV_SW_TO_NON_WLAN_FAILURE",
+};
+
+QDF_STATUS bs_sm_create(struct bearer_switch_info *bs_ctx)
+{
+	struct wlan_sm *sm;
+	uint8_t name[WLAN_SM_ENGINE_MAX_NAME];
+
+	qdf_scnprintf(name, sizeof(name), "BS_%d",
+		      wlan_vdev_get_id(bs_ctx->vdev));
+	sm = wlan_sm_create(name, bs_ctx,
+			    BEARER_NON_WLAN,
+			    bs_sm_info,
+			    QDF_ARRAY_SIZE(bs_sm_info),
+			    bs_sm_event_names,
+			    QDF_ARRAY_SIZE(bs_sm_event_names));
+	if (!sm) {
+		ll_sap_err("Bearer switch State Machine creation failed");
+		return QDF_STATUS_E_NOMEM;
+	}
+	bs_ctx->sm.sm_hdl = sm;
+
+	bs_lock_create(bs_ctx);
+
+	return QDF_STATUS_SUCCESS;
+}
+
+QDF_STATUS bs_sm_destroy(struct bearer_switch_info *bs_ctx)
+{
+	bs_lock_destroy(bs_ctx);
+	wlan_sm_delete(bs_ctx->sm.sm_hdl);
+
+	return QDF_STATUS_SUCCESS;
+}
+

components/umac/mlme/sap/ll_sap/core/src/wlan_ll_lt_sap_bearer_switch.h

@@ -41,6 +41,63 @@ enum bearer_switch_status {
 	XPAN_BLE_SWITCH_TIMEOUT,
 };
 
+/**
+ * enum wlan_bearer_switch_sm_state - Bearer switch states
+ * @BEARER_NON_WLAN: Default state, Bearer non wlan state
+ * @BEARER_NON_WLAN_REQUESTED: State when bearer switch requested to non-wlan
+ * @BEARER_WLAN_REQUESTED: State when bearer switch requested to wlan
+ * @BEARER_WLAN: Bearer non wlan state
+ * @BEARER_SWITCH_MAX: Max state
+ */
+enum wlan_bearer_switch_sm_state {
+	BEARER_NON_WLAN = 0,
+	BEARER_NON_WLAN_REQUESTED = 1,
+	BEARER_WLAN_REQUESTED = 2,
+	BEARER_WLAN = 3,
+	BEARER_SWITCH_MAX = 4,
+};
+
+/**
+ * enum wlan_bearer_switch_sm_evt - Bearer switch related events, if any new
+ * enum is added to this enum, then please update bs_sm_event_names
+ * @WLAN_BS_SM_EV_SWITCH_TO_WLAN: Bearer switch request to WLAN
+ * @WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN: Bearer switch request to NON WLAN
+ * @WLAN_BS_SM_EV_SWITCH_TO_WLAN_TIMEOUT: Bearer switch request to WLA
+ * timeout
+ * @WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_TIMEOUT: Bearer switch request to NON-WLAN
+ * timeout
+ * @WLAN_BS_SM_EV_SWITCH_TO_WLAN_COMPLETED: Bearer switch request to WLAN
+ * completed
+ * @WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_COMPLETED: Bearer switch request to
+ * NON-WLAN completed
+ * @WLAN_BS_SM_EV_SWITCH_TO_WLAN_FAILURE: Bearer switch request to WLAN
+ * failure
+ * @WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_FAILURE: Bearer switch request to NON-WLAN
+ * failure
+ */
+enum wlan_bearer_switch_sm_evt {
+	WLAN_BS_SM_EV_SWITCH_TO_WLAN = 0,
+	WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN = 1,
+	WLAN_BS_SM_EV_SWITCH_TO_WLAN_TIMEOUT = 2,
+	WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_TIMEOUT = 3,
+	WLAN_BS_SM_EV_SWITCH_TO_WLAN_COMPLETED = 4,
+	WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_COMPLETED = 5,
+	WLAN_BS_SM_EV_SWITCH_TO_WLAN_FAILURE = 6,
+	WLAN_BS_SM_EV_SWITCH_TO_NON_WLAN_FAILURE = 7,
+};
+
+/**
+ * struct bs_state_sm - Bearer switch state machine
+ * @bs_sm_lock: sm lock
+ * @sm_hdl: sm handlers
+ * @bs_state: bearer switch state
+ */
+struct bs_state_sm {
+	qdf_mutex_t bs_sm_lock;
+	struct wlan_sm *sm_hdl;
+	enum wlan_bearer_switch_sm_state bs_state;
+};
+
 /**
  * struct bearer_switch_request - Data structure to store the bearer switch
  * request
@@ -61,13 +118,17 @@ struct bearer_switch_request {
 /**
  * struct bearer_switch_info - Data structure to store the bearer switch
  * requests and related information
+ * @vdev: Pointer to the ll lt sap vdev
  * @request_id: Last allocated request id
+ * @sm: state machine context
  * @ref_count: Reference count corresponding to each vdev and requester
  * @last_status: last status of the bearer switch request
  * @requests: Array of bearer_switch_requests to cache the request information
  */
 struct bearer_switch_info {
+	struct wlan_objmgr_vdev *vdev;
 	qdf_atomic_t request_id;
+	struct bs_state_sm sm;
 	uint8_t ref_count[WLAN_UMAC_PSOC_MAX_VDEVS][XPAN_BLE_SWITCH_REQUESTER_MAX];
 	enum bearer_switch_status last_status;
 	struct bearer_switch_request requests[MAX_BEARER_SWITCH_REQUESTERS];
@@ -80,4 +141,74 @@ struct bearer_switch_info {
  * Return: Bearer switch request id
  */
 uint32_t ll_lt_sap_bearer_switch_get_id(struct wlan_objmgr_vdev *vdev);
+
+/**
+ * bs_sm_create() - Invoke SM creation for bearer switch
+ * @bs_ctx:  Bearer switch context
+ *
+ * Return: SUCCESS on successful creation
+ *         FAILURE, if creation fails
+ */
+QDF_STATUS bs_sm_create(struct bearer_switch_info *bs_ctx);
+
+/**
+ * bs_sm_destroy() - Invoke SM deletion for bearer switch
+ * @bs_ctx:  Bearer switch context
+ *
+ * Return: SUCCESS on successful deletion
+ *         FAILURE, if deletion fails
+ */
+QDF_STATUS bs_sm_destroy(struct bearer_switch_info *bs_ctx);
+
+/**
+ * bs_lock_create() - Create BS SM mutex
+ * @bs_ctx:  Bearer switch ctx
+ *
+ * Creates Bearer switch state machine mutex
+ *
+ * Return: void
+ */
+static inline void bs_lock_create(struct bearer_switch_info *bs_ctx)
+{
+	qdf_mutex_create(&bs_ctx->sm.bs_sm_lock);
+}
+
+/**
+ * bs_lock_destroy() - Create BS SM mutex
+ * @bs_ctx:  Bearer switch ctx
+ *
+ * Deatroys Bearer switch state machine mutex
+ *
+ * Return: void
+ */
+static inline void bs_lock_destroy(struct bearer_switch_info *bs_ctx)
+{
+	qdf_mutex_destroy(&bs_ctx->sm.bs_sm_lock);
+}
+
+/**
+ * bs_lock_acquire() - Acquires BS SM mutex
+ * @bs_ctx:  Bearer switch ctx
+ *
+ * Acquire Bearer switch state machine mutex
+ *
+ * Return: void
+ */
+static inline void bs_lock_acquire(struct bearer_switch_info *bs_ctx)
+{
+	qdf_mutex_acquire(&bs_ctx->sm.bs_sm_lock);
+}
+
+/**
+ * bs_lock_release() - Release BS SM mutex
+ * @bs_ctx:  Bearer switch ctx
+ *
+ * Releases Bearer switch state machine mutex
+ *
+ * Return: void
+ */
+static inline void bs_lock_release(struct bearer_switch_info *bs_ctx)
+{
+	qdf_mutex_release(&bs_ctx->sm.bs_sm_lock);
+}
 #endif /* _WLAN_LL_LT_SAP_BEARER_SWITCH_H_ */

components/umac/mlme/sap/ll_sap/core/src/wlan_ll_lt_sap_main.c

@@ -75,6 +75,7 @@ rel_ref:
 QDF_STATUS ll_lt_sap_init(struct wlan_objmgr_vdev *vdev)
 {
 	struct ll_sap_vdev_priv_obj *ll_sap_obj;
+	QDF_STATUS status;
 
 	ll_sap_obj = ll_sap_get_vdev_priv_obj(vdev);
 
@@ -90,9 +91,21 @@ QDF_STATUS ll_lt_sap_init(struct wlan_objmgr_vdev *vdev)
 		return QDF_STATUS_E_NOMEM;
 
 	qdf_atomic_init(&ll_sap_obj->bearer_switch_ctx->request_id);
+
+	ll_sap_obj->bearer_switch_ctx->vdev = vdev;
+
+	status = bs_sm_create(ll_sap_obj->bearer_switch_ctx);
+
+	if (QDF_IS_STATUS_ERROR(status))
+		goto bs_sm_failed;
+
 	ll_sap_debug("vdev %d", wlan_vdev_get_id(vdev));
 
 	return QDF_STATUS_SUCCESS;
+
+bs_sm_failed:
+	qdf_mem_free(ll_sap_obj->bearer_switch_ctx);
+	return status;
 }
 
 QDF_STATUS ll_lt_sap_deinit(struct wlan_objmgr_vdev *vdev)
@@ -107,8 +120,16 @@ QDF_STATUS ll_lt_sap_deinit(struct wlan_objmgr_vdev *vdev)
 		return QDF_STATUS_E_INVAL;
 	}
 
-	if (ll_sap_obj->bearer_switch_ctx)
-		qdf_mem_free(ll_sap_obj->bearer_switch_ctx);
+	if (!ll_sap_obj->bearer_switch_ctx) {
+		ll_sap_debug("vdev %d Bearer switch context is NULL",
+			     wlan_vdev_get_id(vdev));
+		return QDF_STATUS_E_INVAL;
+	}
+
+	bs_sm_destroy(ll_sap_obj->bearer_switch_ctx);
+	qdf_mem_free(ll_sap_obj->bearer_switch_ctx);
+	ll_sap_obj->bearer_switch_ctx = NULL;
+
 	ll_sap_debug("vdev %d", wlan_vdev_get_id(vdev));
 
 	return QDF_STATUS_SUCCESS;

components/umac/mlme/sap/ll_sap/core/src/wlan_ll_sap_main.c

@@ -91,6 +91,8 @@ static QDF_STATUS ll_sap_vdev_obj_destroyed_notification(
 	if (wlan_vdev_mlme_get_opmode(vdev) != QDF_SAP_MODE)
 		return QDF_STATUS_SUCCESS;
 
+	ll_lt_sap_deinit(vdev);
+
 	ll_sap_obj = ll_sap_get_vdev_priv_obj(vdev);
 
 	if (!ll_sap_obj) {
@@ -106,8 +108,6 @@ static QDF_STATUS ll_sap_vdev_obj_destroyed_notification(
 		ll_sap_err("vdev %d ll sap obj detach failed, status %d",
 			   wlan_vdev_get_id(vdev), status);
 
-	ll_lt_sap_deinit(vdev);
-
 	qdf_mem_free(ll_sap_obj);
 
 	return status;