States

Control system state machine. More...

Collaboration diagram for States:

Data Structures
struct	states_trans_cmd_info
	State transition command information. More...
struct	states_callback
	State transition callback. More...

Macros
#define	STATES_CALLBACK_DEFINE_NAMED(_name, _states, _handler, _user_data)
	Same as STATES_CALLBACK_DEFINE, but with a custom name for the callback.
#define	STATES_CALLBACK_DEFINE(states, handler, user_data)
	Define a callback for state transition.

Typedefs
typedef uint32_t	states_t
	State machine states type, where each bit represents a state defined in states_state.
typedef void(*	states_handler_t) (enum states_state state, bool is_entry, void *user_data)
	State transition handler type.

Enumerations
enum	states_state {   STATE_INVALID = 0 , STATE_READY = BIT(0) , STATE_RTD_BLINK = BIT(1) , STATE_RTD_STEADY = BIT(2) ,   STATE_RTD_READY = BIT(3) , STATE_RTD_SOUND = BIT(4) , STATE_RUNNING = BIT(5) , STATE_RUNNING_OK = BIT(6) ,   STATE_RUNNING_ERROR = BIT(7) , STATE_ERROR = BIT(8) , STATE_ALL = UINT32_MAX , NUM_STATE = 9 }
	State machine states. More...
enum	states_trans_cmd {   TRANS_CMD_INVALID = 0 , TRANS_CMD_PEDAL , TRANS_CMD_PEDAL_CLEAR , TRANS_CMD_RTD ,   TRANS_CMD_RTD_FORCED , TRANS_CMD_RTD_FINISH , TRANS_CMD_ERROR , TRANS_CMD_ERROR_CLEARED ,   TRANS_CMD_ERROR_RUNNING , TRANS_CMD_ERROR_CLEARED_RUNNING , TRANS_CMD_FATAL_ERROR , TRANS_CMD_DISABLE ,   NUM_TRANS_CMD }
	State transition commands. More...

Functions
states_t	states_get ()
	Get the current states.
bool	states_valid_transition (enum states_trans_cmd cmd)
	Test if a state transition command is valid.
bool	states_transition_pending ()
	Check if a state transition is currently pending.
void	states_transition (enum states_trans_cmd cmd)
	Execute a state transition command to transition to a new state.
const char *	states_state_str (enum states_state state)
	Get the string representation of a state.
int	states_states_str (char *buf, size_t size, states_t states)
	Get the string representation of states separated by commas in the same semantic as snprintf.
const struct states_trans_cmd_info *	states_transition_info (enum states_trans_cmd cmd)
	Get the information of a state transition.

Detailed Description

Control system state machine.

Macro Definition Documentation

STATES_CALLBACK_DEFINE

#define STATES_CALLBACK_DEFINE	(		states,
			handler,
			user_data )

#include <vcu/ctrl/states.h>

Value:

  STATES_CALLBACK_DEFINE_NAMED(CONCAT(__states_handler_, handler), states, \
                               handler, user_data)

Define a callback for state transition.

Parameters

[in]	states	When transition from/to what states to call the callback. Multiple states_state can be specified using bitwise OR operator (|).
[in]	handler	Handler of the state transition.
[in]	user_data	Pointer to custom data for the callback.

Note

Since the name of the callback is derived from the name of handler , if the same handler is used for multiple callbacks, STATES_CALLBACK_DEFINE_NAMED can be used instead to prevent linker errors.

STATES_CALLBACK_DEFINE_NAMED

#define STATES_CALLBACK_DEFINE_NAMED	(		_name,
			_states,
			_handler,
			_user_data )

#include <vcu/ctrl/states.h>

Value:

  static const STRUCT_SECTION_ITERABLE(states_callback, _name) = {         \
      .states = _states,                                                   \
      .handler = _handler,                                                 \
      .user_data = _user_data,                                             \
  }

Same as STATES_CALLBACK_DEFINE, but with a custom name for the callback.

Typedef Documentation

states_handler_t

typedef void(* states_handler_t) (enum states_state state, bool is_entry, void *user_data)

#include <vcu/ctrl/states.h>

State transition handler type.

Parameters

[in]	state	to transition from/to.
[in]	is_entry	True when transitioning to the state. False when transition from.
[in,out]	user_data	Pointer to custom data for the callback provided by STATES_CALLBACK_DEFINE.

states_t

typedef uint32_t states_t

#include <vcu/ctrl/states.h>

State machine states type, where each bit represents a state defined in states_state.

Enumeration Type Documentation

states_state

enum states_state

#include <vcu/ctrl/states.h>

State machine states.

Enumerator
STATE_INVALID
STATE_READY
STATE_RTD_BLINK
STATE_RTD_STEADY
STATE_RTD_READY
STATE_RTD_SOUND
STATE_RUNNING
STATE_RUNNING_OK
STATE_RUNNING_ERROR
STATE_ERROR
STATE_ALL
NUM_STATE

states_trans_cmd

enum states_trans_cmd

#include <vcu/ctrl/states.h>

State transition commands.

Enumerator
TRANS_CMD_INVALID
TRANS_CMD_PEDAL
TRANS_CMD_PEDAL_CLEAR
TRANS_CMD_RTD
TRANS_CMD_RTD_FORCED
TRANS_CMD_RTD_FINISH
TRANS_CMD_ERROR
TRANS_CMD_ERROR_CLEARED
TRANS_CMD_ERROR_RUNNING
TRANS_CMD_ERROR_CLEARED_RUNNING
TRANS_CMD_FATAL_ERROR
TRANS_CMD_DISABLE
NUM_TRANS_CMD

Function Documentation

states_get()

states_t states_get

(

)

#include <vcu/ctrl/states.h>

Get the current states.

Returns

states_t Current states.

states_state_str()

const char * states_state_str

(

enum states_state

state

)

#include <vcu/ctrl/states.h>

Get the string representation of a state.

Parameters

[in]

state

State.

Returns

const char* String representation.

states_states_str()

int states_states_str	(	char *	buf,
		size_t	size,
		states_t	states )

#include <vcu/ctrl/states.h>

Get the string representation of states separated by commas in the same semantic as snprintf.

Parameters

[out]	buf	Buffer to store the string representation.
[in]	size	Size of the buffer.
[in]	states	States.

Returns

int Number of bytes written to the buffer, excluding the null terminator which would be written if the buffer is large enough.

states_transition()

void states_transition

(

enum states_trans_cmd

cmd

)

#include <vcu/ctrl/states.h>

Execute a state transition command to transition to a new state.

Parameters

[in]

cmd

State transition command.

Warning

Must not be called from an ISR or within a state transition callback.

states_transition_info()

const struct states_trans_cmd_info * states_transition_info

(

enum states_trans_cmd

cmd

)

#include <vcu/ctrl/states.h>

Get the information of a state transition.

Parameters

[in]

cmd

State transition command.

Returns

const struct states_trans_cmd_info* Pointer to the state transition command information.

states_transition_pending()

bool states_transition_pending

(

)

#include <vcu/ctrl/states.h>

Check if a state transition is currently pending.

Returns

true If a state transition is pending.

false If no state transition is pending.

states_valid_transition()

bool states_valid_transition

(

enum states_trans_cmd

cmd

)

#include <vcu/ctrl/states.h>

Test if a state transition command is valid.

Parameters

[in]

cmd

State transition command.

Return values

true	If the command can be executed.
false	If the command cannot be executed.