2 * A generic FSM based on fsm used in isdn4linux
7 #include <linux/module.h>
8 #include <linux/timer.h>
10 MODULE_AUTHOR("(C) 2000 IBM Corp. by Fritz Elfert (felfert@millenux.com)");
11 MODULE_DESCRIPTION("Finite state machine helper functions");
12 MODULE_LICENSE("GPL");
15 init_fsm(char *name, const char **state_names, const char **event_names, int nr_states,
16 int nr_events, const fsm_node *tmpl, int tmpl_len, gfp_t order)
23 this = kzalloc(sizeof(fsm_instance), order);
26 "fsm(%s): init_fsm: Couldn't alloc instance\n", name);
29 strlcpy(this->name, name, sizeof(this->name));
31 f = kzalloc(sizeof(fsm), order);
34 "fsm(%s): init_fsm: Couldn't alloc fsm\n", name);
38 f->nr_events = nr_events;
39 f->nr_states = nr_states;
40 f->event_names = event_names;
41 f->state_names = state_names;
44 m = kcalloc(nr_states*nr_events, sizeof(fsm_function_t), order);
47 "fsm(%s): init_fsm: Couldn't alloc jumptable\n", name);
53 for (i = 0; i < tmpl_len; i++) {
54 if ((tmpl[i].cond_state >= nr_states) ||
55 (tmpl[i].cond_event >= nr_events) ) {
57 "fsm(%s): init_fsm: Bad template l=%d st(%ld/%ld) ev(%ld/%ld)\n",
58 name, i, (long)tmpl[i].cond_state, (long)f->nr_states,
59 (long)tmpl[i].cond_event, (long)f->nr_events);
63 m[nr_states * tmpl[i].cond_event + tmpl[i].cond_state] =
70 kfree_fsm(fsm_instance *this)
74 kfree(this->f->jumpmatrix);
80 "fsm: kfree_fsm called with NULL argument\n");
85 fsm_print_history(fsm_instance *fi)
90 if (fi->history_size >= FSM_HISTORY_SIZE)
91 idx = fi->history_index;
93 printk(KERN_DEBUG "fsm(%s): History:\n", fi->name);
94 for (i = 0; i < fi->history_size; i++) {
95 int e = fi->history[idx].event;
96 int s = fi->history[idx++].state;
97 idx %= FSM_HISTORY_SIZE;
99 printk(KERN_DEBUG " S=%s\n",
100 fi->f->state_names[s]);
102 printk(KERN_DEBUG " S=%s E=%s\n",
103 fi->f->state_names[s],
104 fi->f->event_names[e]);
106 fi->history_size = fi->history_index = 0;
110 fsm_record_history(fsm_instance *fi, int state, int event)
112 fi->history[fi->history_index].state = state;
113 fi->history[fi->history_index++].event = event;
114 fi->history_index %= FSM_HISTORY_SIZE;
115 if (fi->history_size < FSM_HISTORY_SIZE)
121 fsm_getstate_str(fsm_instance *fi)
123 int st = atomic_read(&fi->state);
124 if (st >= fi->f->nr_states)
126 return fi->f->state_names[st];
130 fsm_expire_timer(fsm_timer *this)
133 printk(KERN_DEBUG "fsm(%s): Timer %p expired\n",
134 this->fi->name, this);
136 fsm_event(this->fi, this->expire_event, this->event_arg);
140 fsm_settimer(fsm_instance *fi, fsm_timer *this)
143 this->tl.function = (void *)fsm_expire_timer;
144 this->tl.data = (long)this;
146 printk(KERN_DEBUG "fsm(%s): Create timer %p\n", fi->name,
149 init_timer(&this->tl);
153 fsm_deltimer(fsm_timer *this)
156 printk(KERN_DEBUG "fsm(%s): Delete timer %p\n", this->fi->name,
159 del_timer(&this->tl);
163 fsm_addtimer(fsm_timer *this, int millisec, int event, void *arg)
167 printk(KERN_DEBUG "fsm(%s): Add timer %p %dms\n",
168 this->fi->name, this, millisec);
171 init_timer(&this->tl);
172 this->tl.function = (void *)fsm_expire_timer;
173 this->tl.data = (long)this;
174 this->expire_event = event;
175 this->event_arg = arg;
176 this->tl.expires = jiffies + (millisec * HZ) / 1000;
177 add_timer(&this->tl);
181 /* FIXME: this function is never used, why */
183 fsm_modtimer(fsm_timer *this, int millisec, int event, void *arg)
187 printk(KERN_DEBUG "fsm(%s): Restart timer %p %dms\n",
188 this->fi->name, this, millisec);
191 del_timer(&this->tl);
192 init_timer(&this->tl);
193 this->tl.function = (void *)fsm_expire_timer;
194 this->tl.data = (long)this;
195 this->expire_event = event;
196 this->event_arg = arg;
197 this->tl.expires = jiffies + (millisec * HZ) / 1000;
198 add_timer(&this->tl);
201 EXPORT_SYMBOL(init_fsm);
202 EXPORT_SYMBOL(kfree_fsm);
203 EXPORT_SYMBOL(fsm_settimer);
204 EXPORT_SYMBOL(fsm_deltimer);
205 EXPORT_SYMBOL(fsm_addtimer);
206 EXPORT_SYMBOL(fsm_modtimer);
207 EXPORT_SYMBOL(fsm_getstate_str);
209 #if FSM_DEBUG_HISTORY
210 EXPORT_SYMBOL(fsm_print_history);
211 EXPORT_SYMBOL(fsm_record_history);