2017-03-01 09:37:39 +00:00
|
|
|
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
2016-11-04 07:08:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
*
|
2017-03-01 09:37:39 +00:00
|
|
|
* Filename: btc_sm.c
|
2016-11-04 07:08:30 +00:00
|
|
|
*
|
2017-03-01 09:37:39 +00:00
|
|
|
* Description: Generic BTC state machine API
|
2016-11-04 07:08:30 +00:00
|
|
|
*
|
|
|
|
*****************************************************************************/
|
2018-04-08 04:10:50 +00:00
|
|
|
#include "common/bt_target.h"
|
|
|
|
#include "common/bt_defs.h"
|
|
|
|
#include "osi/allocator.h"
|
|
|
|
#include "btc/btc_common.h"
|
|
|
|
#include "btc/btc_sm.h"
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2017-03-17 07:08:47 +00:00
|
|
|
#if BTC_SM_INCLUDED
|
2016-11-04 07:08:30 +00:00
|
|
|
/*****************************************************************************
|
|
|
|
** Constants & Macros
|
|
|
|
******************************************************************************/
|
|
|
|
/*****************************************************************************
|
|
|
|
** Local type definitions
|
|
|
|
******************************************************************************/
|
|
|
|
typedef struct {
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_state_t state;
|
|
|
|
btc_sm_handler_t *p_handlers;
|
|
|
|
} btc_sm_cb_t;
|
2016-11-04 07:08:30 +00:00
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
** Static variables
|
|
|
|
******************************************************************************/
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
** Static functions
|
|
|
|
******************************************************************************/
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
** Externs
|
|
|
|
******************************************************************************/
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
** Functions
|
|
|
|
******************************************************************************/
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
**
|
2017-03-01 09:37:39 +00:00
|
|
|
** Function btc_sm_init
|
2016-11-04 07:08:30 +00:00
|
|
|
**
|
|
|
|
** Description Initializes the state machine with the state handlers
|
|
|
|
** The caller should ensure that the table and the corresponding
|
|
|
|
** states match. The location that 'p_handlers' points to shall
|
2017-03-01 09:37:39 +00:00
|
|
|
** be available until the btc_sm_shutdown API is invoked.
|
2016-11-04 07:08:30 +00:00
|
|
|
**
|
|
|
|
** Returns Returns a pointer to the initialized state machine handle.
|
|
|
|
**
|
|
|
|
******************************************************************************/
|
|
|
|
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_handle_t btc_sm_init(const btc_sm_handler_t *p_handlers, btc_sm_state_t initial_state)
|
2016-11-04 07:08:30 +00:00
|
|
|
{
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_cb_t *p_cb;
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2016-11-26 05:09:55 +00:00
|
|
|
if (p_handlers == NULL) {
|
2018-04-25 02:11:06 +00:00
|
|
|
BTC_TRACE_ERROR("%s : p_handlers is NULL", __FUNCTION__);
|
2016-11-04 07:08:30 +00:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2017-03-01 09:37:39 +00:00
|
|
|
p_cb = (btc_sm_cb_t *)osi_malloc(sizeof(btc_sm_cb_t));
|
2016-11-04 07:08:30 +00:00
|
|
|
p_cb->state = initial_state;
|
2017-03-01 09:37:39 +00:00
|
|
|
p_cb->p_handlers = (btc_sm_handler_t *)p_handlers;
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2017-03-01 09:37:39 +00:00
|
|
|
/* Send BTC_SM_ENTER_EVT to the initial state */
|
|
|
|
p_cb->p_handlers[initial_state](BTC_SM_ENTER_EVT, NULL);
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2017-03-01 09:37:39 +00:00
|
|
|
return (btc_sm_handle_t)p_cb;
|
2016-11-04 07:08:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
**
|
2017-03-01 09:37:39 +00:00
|
|
|
** Function btc_sm_shutdown
|
2016-11-04 07:08:30 +00:00
|
|
|
**
|
|
|
|
** Description Tears down the state machine
|
|
|
|
**
|
|
|
|
** Returns None
|
|
|
|
**
|
|
|
|
******************************************************************************/
|
2017-03-01 09:37:39 +00:00
|
|
|
void btc_sm_shutdown(btc_sm_handle_t handle)
|
2016-11-04 07:08:30 +00:00
|
|
|
{
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_cb_t *p_cb = (btc_sm_cb_t *)handle;
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2016-11-26 05:09:55 +00:00
|
|
|
if (p_cb == NULL) {
|
2018-04-25 02:11:06 +00:00
|
|
|
BTC_TRACE_ERROR("%s : Invalid handle", __FUNCTION__);
|
2016-11-04 07:08:30 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
osi_free(p_cb);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
**
|
2017-03-01 09:37:39 +00:00
|
|
|
** Function btc_sm_get_state
|
2016-11-04 07:08:30 +00:00
|
|
|
**
|
|
|
|
** Description Fetches the current state of the state machine
|
|
|
|
**
|
|
|
|
** Returns Current state
|
|
|
|
**
|
|
|
|
******************************************************************************/
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_state_t btc_sm_get_state(btc_sm_handle_t handle)
|
2016-11-04 07:08:30 +00:00
|
|
|
{
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_cb_t *p_cb = (btc_sm_cb_t *)handle;
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2016-11-26 05:09:55 +00:00
|
|
|
if (p_cb == NULL) {
|
2018-04-25 02:11:06 +00:00
|
|
|
BTC_TRACE_ERROR("%s : Invalid handle", __FUNCTION__);
|
2016-11-04 07:08:30 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
return p_cb->state;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
**
|
2017-03-01 09:37:39 +00:00
|
|
|
** Function btc_sm_dispatch
|
2016-11-04 07:08:30 +00:00
|
|
|
**
|
|
|
|
** Description Dispatches the 'event' along with 'data' to the current state handler
|
|
|
|
**
|
|
|
|
** Returns BT_STATUS_SUCCESS on success
|
|
|
|
** BT_STATUS_UNHANDLED if event was not processed
|
|
|
|
** BT_STATUS_FAIL otherwise
|
|
|
|
**
|
|
|
|
******************************************************************************/
|
2017-03-01 09:37:39 +00:00
|
|
|
bt_status_t btc_sm_dispatch(btc_sm_handle_t handle, btc_sm_event_t event,
|
2017-03-17 14:46:49 +00:00
|
|
|
void *data)
|
2016-11-04 07:08:30 +00:00
|
|
|
{
|
|
|
|
bt_status_t status = BT_STATUS_SUCCESS;
|
|
|
|
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_cb_t *p_cb = (btc_sm_cb_t *)handle;
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2016-11-26 05:09:55 +00:00
|
|
|
if (p_cb == NULL) {
|
2018-04-25 02:11:06 +00:00
|
|
|
BTC_TRACE_ERROR("%s : Invalid handle", __FUNCTION__);
|
2016-11-04 07:08:30 +00:00
|
|
|
return BT_STATUS_FAIL;
|
|
|
|
}
|
|
|
|
|
2016-11-26 05:09:55 +00:00
|
|
|
if (p_cb->p_handlers[p_cb->state](event, data) == FALSE) {
|
2016-11-04 07:08:30 +00:00
|
|
|
return BT_STATUS_UNHANDLED;
|
2016-11-26 05:09:55 +00:00
|
|
|
}
|
2016-11-04 07:08:30 +00:00
|
|
|
|
|
|
|
return status;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
**
|
2017-03-01 09:37:39 +00:00
|
|
|
** Function btc_sm_change_state
|
2016-11-04 07:08:30 +00:00
|
|
|
**
|
2017-03-01 09:37:39 +00:00
|
|
|
** Description Make a transition to the new 'state'. The 'BTC_SM_EXIT_EVT'
|
2016-11-04 07:08:30 +00:00
|
|
|
** shall be invoked before exiting the current state. The
|
2017-03-01 09:37:39 +00:00
|
|
|
** 'BTC_SM_ENTER_EVT' shall be invoked before entering the new state
|
2016-11-04 07:08:30 +00:00
|
|
|
**
|
|
|
|
** Returns BT_STATUS_SUCCESS on success
|
|
|
|
** BT_STATUS_UNHANDLED if event was not processed
|
|
|
|
** BT_STATUS_FAIL otherwise
|
|
|
|
**
|
|
|
|
******************************************************************************/
|
2017-03-01 09:37:39 +00:00
|
|
|
bt_status_t btc_sm_change_state(btc_sm_handle_t handle, btc_sm_state_t state)
|
2016-11-04 07:08:30 +00:00
|
|
|
{
|
|
|
|
bt_status_t status = BT_STATUS_SUCCESS;
|
2017-03-01 09:37:39 +00:00
|
|
|
btc_sm_cb_t *p_cb = (btc_sm_cb_t *)handle;
|
2016-11-04 07:08:30 +00:00
|
|
|
|
2016-11-26 05:09:55 +00:00
|
|
|
if (p_cb == NULL) {
|
2018-04-25 02:11:06 +00:00
|
|
|
BTC_TRACE_ERROR("%s : Invalid handle", __FUNCTION__);
|
2016-11-04 07:08:30 +00:00
|
|
|
return BT_STATUS_FAIL;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Send exit event to the current state */
|
2017-03-01 09:37:39 +00:00
|
|
|
if (p_cb->p_handlers[p_cb->state](BTC_SM_EXIT_EVT, NULL) == FALSE) {
|
2016-11-04 07:08:30 +00:00
|
|
|
status = BT_STATUS_UNHANDLED;
|
2016-11-26 05:09:55 +00:00
|
|
|
}
|
2016-11-04 07:08:30 +00:00
|
|
|
|
|
|
|
/* Change to the new state */
|
|
|
|
p_cb->state = state;
|
|
|
|
|
|
|
|
/* Send enter event to the new state */
|
2017-03-01 09:37:39 +00:00
|
|
|
if (p_cb->p_handlers[p_cb->state](BTC_SM_ENTER_EVT, NULL) == FALSE) {
|
2016-11-04 07:08:30 +00:00
|
|
|
status = BT_STATUS_UNHANDLED;
|
2016-11-26 05:09:55 +00:00
|
|
|
}
|
2016-11-04 07:08:30 +00:00
|
|
|
|
|
|
|
return status;
|
|
|
|
}
|
2017-03-17 07:08:47 +00:00
|
|
|
|
|
|
|
#endif /* #if BTC_SM_INCLUDED */
|