^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * A generic FSM based on fsm used in isdn4linux
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #include "fsm.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/timer.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) MODULE_AUTHOR("(C) 2000 IBM Corp. by Fritz Elfert (felfert@millenux.com)");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) MODULE_DESCRIPTION("Finite state machine helper functions");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) MODULE_LICENSE("GPL");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) fsm_instance *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) init_fsm(char *name, const char **state_names, const char **event_names, int nr_states,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) int nr_events, const fsm_node *tmpl, int tmpl_len, gfp_t order)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) fsm_instance *this;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) fsm_function_t *m;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) fsm *f;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) this = kzalloc(sizeof(fsm_instance), order);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) if (this == NULL) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) printk(KERN_WARNING
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) "fsm(%s): init_fsm: Couldn't alloc instance\n", name);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) return NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) strlcpy(this->name, name, sizeof(this->name));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) init_waitqueue_head(&this->wait_q);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) f = kzalloc(sizeof(fsm), order);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) if (f == NULL) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) printk(KERN_WARNING
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) "fsm(%s): init_fsm: Couldn't alloc fsm\n", name);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) kfree_fsm(this);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) return NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) f->nr_events = nr_events;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) f->nr_states = nr_states;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) f->event_names = event_names;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) f->state_names = state_names;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) this->f = f;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) m = kcalloc(nr_states*nr_events, sizeof(fsm_function_t), order);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) if (m == NULL) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) printk(KERN_WARNING
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) "fsm(%s): init_fsm: Couldn't alloc jumptable\n", name);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) kfree_fsm(this);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) return NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) f->jumpmatrix = m;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) for (i = 0; i < tmpl_len; i++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) if ((tmpl[i].cond_state >= nr_states) ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) (tmpl[i].cond_event >= nr_events) ) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) printk(KERN_ERR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) "fsm(%s): init_fsm: Bad template l=%d st(%ld/%ld) ev(%ld/%ld)\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) name, i, (long)tmpl[i].cond_state, (long)f->nr_states,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) (long)tmpl[i].cond_event, (long)f->nr_events);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) kfree_fsm(this);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) return NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) } else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) m[nr_states * tmpl[i].cond_event + tmpl[i].cond_state] =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) tmpl[i].function;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) return this;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) kfree_fsm(fsm_instance *this)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) if (this) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) if (this->f) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) kfree(this->f->jumpmatrix);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) kfree(this->f);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) kfree(this);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) } else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) printk(KERN_WARNING
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) "fsm: kfree_fsm called with NULL argument\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) #if FSM_DEBUG_HISTORY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) fsm_print_history(fsm_instance *fi)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) int idx = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) if (fi->history_size >= FSM_HISTORY_SIZE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) idx = fi->history_index;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) printk(KERN_DEBUG "fsm(%s): History:\n", fi->name);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) for (i = 0; i < fi->history_size; i++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) int e = fi->history[idx].event;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) int s = fi->history[idx++].state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) idx %= FSM_HISTORY_SIZE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) if (e == -1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) printk(KERN_DEBUG " S=%s\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) fi->f->state_names[s]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) printk(KERN_DEBUG " S=%s E=%s\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) fi->f->state_names[s],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) fi->f->event_names[e]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) fi->history_size = fi->history_index = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) fsm_record_history(fsm_instance *fi, int state, int event)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) fi->history[fi->history_index].state = state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) fi->history[fi->history_index++].event = event;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) fi->history_index %= FSM_HISTORY_SIZE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) if (fi->history_size < FSM_HISTORY_SIZE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) fi->history_size++;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) const char *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) fsm_getstate_str(fsm_instance *fi)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) int st = atomic_read(&fi->state);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) if (st >= fi->f->nr_states)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) return "Invalid";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) return fi->f->state_names[st];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) static void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) fsm_expire_timer(struct timer_list *t)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) fsm_timer *this = from_timer(this, t, tl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) #if FSM_TIMER_DEBUG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) printk(KERN_DEBUG "fsm(%s): Timer %p expired\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) this->fi->name, this);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) fsm_event(this->fi, this->expire_event, this->event_arg);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) fsm_settimer(fsm_instance *fi, fsm_timer *this)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) this->fi = fi;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) #if FSM_TIMER_DEBUG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) printk(KERN_DEBUG "fsm(%s): Create timer %p\n", fi->name,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) this);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) timer_setup(&this->tl, fsm_expire_timer, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) fsm_deltimer(fsm_timer *this)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) #if FSM_TIMER_DEBUG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) printk(KERN_DEBUG "fsm(%s): Delete timer %p\n", this->fi->name,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) this);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) del_timer(&this->tl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) int
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) fsm_addtimer(fsm_timer *this, int millisec, int event, void *arg)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) #if FSM_TIMER_DEBUG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) printk(KERN_DEBUG "fsm(%s): Add timer %p %dms\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) this->fi->name, this, millisec);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) timer_setup(&this->tl, fsm_expire_timer, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) this->expire_event = event;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) this->event_arg = arg;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) this->tl.expires = jiffies + (millisec * HZ) / 1000;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) add_timer(&this->tl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) /* FIXME: this function is never used, why */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) fsm_modtimer(fsm_timer *this, int millisec, int event, void *arg)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) #if FSM_TIMER_DEBUG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) printk(KERN_DEBUG "fsm(%s): Restart timer %p %dms\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) this->fi->name, this, millisec);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) del_timer(&this->tl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) timer_setup(&this->tl, fsm_expire_timer, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) this->expire_event = event;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) this->event_arg = arg;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) this->tl.expires = jiffies + (millisec * HZ) / 1000;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) add_timer(&this->tl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) EXPORT_SYMBOL(init_fsm);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) EXPORT_SYMBOL(kfree_fsm);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) EXPORT_SYMBOL(fsm_settimer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) EXPORT_SYMBOL(fsm_deltimer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) EXPORT_SYMBOL(fsm_addtimer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) EXPORT_SYMBOL(fsm_modtimer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) EXPORT_SYMBOL(fsm_getstate_str);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) #if FSM_DEBUG_HISTORY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) EXPORT_SYMBOL(fsm_print_history);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) EXPORT_SYMBOL(fsm_record_history);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) #endif
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags