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 43 #ifndef BTSTACK_FSM_H 44 #define BTSTACK_FSM_H 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 #include <stdint.h> 51 52 typedef uint16_t btstack_fsm_signal_t; 53 enum btstack_fsm_reserved_signals_e { 54 BTSTACK_FSM_EMPTY_SIG, 55 BTSTACK_FSM_INIT_SIG, 56 BTSTACK_FSM_ENTRY_SIG, 57 BTSTACK_FSM_EXIT_SIG, 58 BTSTACK_FSM_USER_SIG 59 }; 60 61 typedef struct { 62 btstack_fsm_signal_t sig; 63 } btstack_fsm_event_t; 64 65 typedef struct btstack_fsm_s btstack_fsm_t; 66 67 typedef enum { 68 BTSTACK_FSM_TRAN_STATUS, 69 BTSTACK_FSM_SUPER_STATUS, 70 BTSTACK_FSM_HANDLED_STATUS, 71 BTSTACK_FSM_UNHANDLED_STATUS, 72 BTSTACK_FSM_IGNORED_STATUS 73 } btstack_fsm_state_t; 74 75 typedef btstack_fsm_state_t (*btstack_fsm_state_handler_t)(btstack_fsm_t * const me, btstack_fsm_event_t const * const e); 76 77 struct btstack_fsm_s { 78 btstack_fsm_state_handler_t state; 79 }; 80 81 /* API_START */ 82 83 /* 84 * @brief Request the transition from the current state to the given new state 85 * @param me the current state machine 86 * @param target the new state to transit to 87 * @result transition status 88 */ 89 btstack_fsm_state_t btstack_fsm_transit(btstack_fsm_t * const me, btstack_fsm_state_handler_t target); 90 91 /* 92 * @brief Constructs a new state hierarchical machine machine, with storage for maximum hierarchy depth. 93 * @param me the current state machine 94 * @param initial the initial state 95 */ 96 void btstack_fsm_constructor(btstack_fsm_t * const me, btstack_fsm_state_handler_t initial); 97 98 /* 99 * @brief Takes the initial transition of the state machine and sending it a BTSTACK_HSM_INIT_SIG 100 * @param me the current state machine 101 * @param e event 102 */ 103 void btstack_fsm_init(btstack_fsm_t * const me, btstack_fsm_event_t const * const e); 104 105 /* 106 * @brief Dispatches the given event to the state machine, if a transition is requested, leave the old states and enter the new on. 107 * Handling entering/exiting all states on the way. 108 * @param me the current state machine 109 * @param e event 110 */ 111 btstack_fsm_state_t btstack_fsm_dispatch(btstack_fsm_t * const me, btstack_fsm_event_t const * const e); 112 113 /* 114 * @brief Dispatches the given event to the state machine until it was handled. 115 * @param me the current state machine 116 * @param e event 117 */ 118 void btstack_fsm_dispatch_until(btstack_fsm_t * const me, btstack_fsm_event_t const * const e); 119 120 /* API_END */ 121 122 #if defined __cplusplus 123 } 124 #endif 125 126 #endif 127 128