1 /*
2 * Copyright (C) 2024 BlueKitchen GmbH
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the copyright holders nor the names of
14 * contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 * 4. Any redistribution, use, or modification is done solely for
17 * personal benefit and not for any commercial purpose or for
18 * monetary gain.
19 *
20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * Please inquire about commercial licensing options at
34 * [email protected]
35 *
36 */
37
38 /**
39 * @title Finite State Machine (FSM)
40 *
41 */
42 #define BTSTACK_FILE__ "btstack_fsm.c"
43
44 #include <stddef.h>
45
46 #include "btstack_fsm.h"
47
48 #include "btstack_config.h"
49 #include "btstack_debug.h"
50
51 static btstack_fsm_event_t const entry_evt = { BTSTACK_FSM_ENTRY_SIG };
52 static btstack_fsm_event_t const exit_evt = { BTSTACK_FSM_EXIT_SIG };
53
btstack_fsm_transit(btstack_fsm_t * me,btstack_fsm_state_handler_t target)54 btstack_fsm_state_t btstack_fsm_transit(btstack_fsm_t *me, btstack_fsm_state_handler_t target) {
55 me->state = target;
56 return BTSTACK_FSM_TRAN_STATUS;
57 }
58
btstack_fsm_constructor(btstack_fsm_t * const me,btstack_fsm_state_handler_t initial)59 void btstack_fsm_constructor(btstack_fsm_t * const me, btstack_fsm_state_handler_t initial) {
60 me->state = initial;
61 }
62
btstack_fsm_init(btstack_fsm_t * const me,btstack_fsm_event_t const * const e)63 void btstack_fsm_init(btstack_fsm_t * const me, btstack_fsm_event_t const * const e) {
64 btstack_assert(me->state != NULL);
65 me->state(me, e);
66 me->state(me, &entry_evt);
67 }
68
btstack_fsm_dispatch(btstack_fsm_t * const me,btstack_fsm_event_t const * const e)69 btstack_fsm_state_t btstack_fsm_dispatch(btstack_fsm_t * const me, btstack_fsm_event_t const * const e) {
70 btstack_fsm_state_t status;
71 btstack_fsm_state_handler_t prev_state = me->state;
72 btstack_assert( me->state != NULL );
73
74 status = me->state(me, e);
75
76 if( status == BTSTACK_FSM_TRAN_STATUS ) {
77 prev_state(me, &exit_evt);
78 me->state(me, &entry_evt);
79 }
80 return status;
81 }
82
btstack_fsm_dispatch_until(btstack_fsm_t * const me,btstack_fsm_event_t const * const e)83 void btstack_fsm_dispatch_until(btstack_fsm_t * const me, btstack_fsm_event_t const * const e) {
84 btstack_fsm_state_t status;
85 do {
86 status = btstack_fsm_dispatch( me, e );
87 } while( status == BTSTACK_FSM_TRAN_STATUS );
88 }
89
90