csr_wifi_fsm_types.h File Reference

#include <linux/types.h>
#include "csr_macro.h"
#include "csr_panic.h"
#include "csr_sched.h"
#include "csr_wifi_fsm.h"

Go to the source code of this file.

Data Structures
struct	CsrWifiFsmEventList
	FSM event list header. More...
struct	CsrWifiFsmTimerId
	FSM timer id. More...
struct	CsrWifiFsmTimer
	FSM timer header. More...
struct	CsrWifiFsmAlienEvent
	Fsm Alien Event. More...
struct	CsrWifiFsmTimerList
	FSM timer list header. More...
struct	CsrWifiFsmEventEntry
	Event ID to transition function entry. More...
struct	CsrWifiFsmTableEntry
	Single State's Transition Table. More...
struct	CsrWifiFsmTransitionFunctionTable
	Process State Transtion table. More...
struct	CsrWifiFsmProcessStateMachine
	Const Process definition. More...
struct	CsrWifiFsmInstanceEntry
	Dynamic Process data. More...
struct	CsrWifiFsmContext
	Toplevel FSM context data. More...

Macros
#define	CSR_WIFI_FSM_MAX_TRANSITION_HISTORY   10

Typedefs
typedef struct CsrWifiFsmEventList	CsrWifiFsmEventList
	FSM event list header.
typedef struct CsrWifiFsmTimerId	CsrWifiFsmTimerId
	FSM timer id.
typedef struct CsrWifiFsmTimer	CsrWifiFsmTimer
	FSM timer header.
typedef struct CsrWifiFsmTimerList	CsrWifiFsmTimerList
	FSM timer list header.
typedef void(*	CsrWifiFsmProcEntryFnPtr )(CsrWifiFsmContext *context)
	Process Entry Function Pointer.
typedef void(*	CsrWifiFsmTransitionFnPtr )(CsrWifiFsmContext *context, void *fsmData, const CsrWifiFsmEvent *event)
	Process Transition Function Pointer.
typedef void(*	CsrWifiFsmProcResetFnPtr )(CsrWifiFsmContext *context)
	Process reset/shutdown Function Pointer.
typedef u16(*	CsrWifiFsmDestLookupCallbackPtr )(void *context, const CsrWifiFsmEvent *event)
	FSM Default Destination CallbackFunction Pointer.
typedef void(*	CsrWifiFsmOnCreateFnPtr )(void *extContext, const CsrWifiFsmInstanceEntry *instance)
	OnCreate Callback Function Pointer.
typedef void(*	CsrWifiFsmOnTransitionFnPtr )(void *extContext, const CsrWifiFsmEventEntry *eventEntryArray, const CsrWifiFsmEvent *event)
	OnTransition Callback Function Pointer.
typedef void(*	CsrWifiFsmOnStateChangeFnPtr )(void *extContext, u16 nextstate)
	OnStateChange Callback Function Pointer.
typedef void(*	CsrWifiFsmOnEventFnPtr )(void *extContext, const CsrWifiFsmEvent *event)
	OnIgnore,OnError or OnInvalid Callback Function Pointer.

Macro Definition Documentation

#define CSR_WIFI_FSM_MAX_TRANSITION_HISTORY   10

Definition at line 29 of file csr_wifi_fsm_types.h.

Typedef Documentation

typedef u16(* CsrWifiFsmDestLookupCallbackPtr)(void *context, const CsrWifiFsmEvent *event)

FSM Default Destination CallbackFunction Pointer.

Description

Defines the default destination function for the FSM to call when an event does not have a valid destination. This

Parameters

[in]

context

: External context

Returns

u16 a valid destination OR CSR_WIFI_FSM_ENV

Definition at line 175 of file csr_wifi_fsm_types.h.

typedef struct CsrWifiFsmEventList CsrWifiFsmEventList

FSM event list header.

Description

Singly linked list of events.

typedef void(* CsrWifiFsmOnCreateFnPtr)(void *extContext, const CsrWifiFsmInstanceEntry *instance)

OnCreate Callback Function Pointer.

Description

Called when an fsm is created.

Parameters

[in]	extContext	: External context
[in]	instance	: FSM instance

Returns

void

Definition at line 330 of file csr_wifi_fsm_types.h.

typedef void(* CsrWifiFsmOnEventFnPtr)(void *extContext, const CsrWifiFsmEvent *event)

OnIgnore,OnError or OnInvalid Callback Function Pointer.

Description

Called when an event is processed by a fsm

Parameters

[in]	extContext	: External context
[in]	event	: Event

Returns

void

Definition at line 375 of file csr_wifi_fsm_types.h.

typedef void(* CsrWifiFsmOnStateChangeFnPtr)(void *extContext, u16 nextstate)

OnStateChange Callback Function Pointer.

Description

Called when CsrWifiFsmNextState is called

Parameters

[in]

extContext

: External context

Returns

void

Definition at line 360 of file csr_wifi_fsm_types.h.

typedef void(* CsrWifiFsmOnTransitionFnPtr)(void *extContext, const CsrWifiFsmEventEntry *eventEntryArray, const CsrWifiFsmEvent *event)

OnTransition Callback Function Pointer.

Description

Called when an event is processed by a fsm

Parameters

[in]	extContext	: External context
[in]	eventEntryArray	: Entry data
[in]	event	: Event

Returns

void

Definition at line 346 of file csr_wifi_fsm_types.h.

typedef void(* CsrWifiFsmProcEntryFnPtr)(CsrWifiFsmContext *context)

Process Entry Function Pointer.

Description

Defines the entry function for a processes. Called at process initialisation.

Parameters

[in]

context

: FSM context

Returns

void

Definition at line 127 of file csr_wifi_fsm_types.h.

typedef void(* CsrWifiFsmProcResetFnPtr)(CsrWifiFsmContext *context)

Process reset/shutdown Function Pointer.

Description

Defines the reset/shutdown function for a processes. Called to reset or shutdown an fsm.

Parameters

[in]

context

: FSM context

Returns

void

Definition at line 159 of file csr_wifi_fsm_types.h.

typedef struct CsrWifiFsmTimer CsrWifiFsmTimer

FSM timer header.

Description

All timer MUST have this struct as the FIRST member. The first members of the structure MUST remain compatable with the CsrWifiFsmEvent so that timers are just specialised events

typedef struct CsrWifiFsmTimerId CsrWifiFsmTimerId

FSM timer id.

Description

Composite Id made up of the type, dest and a unique id so CsrWifiFsmRemoveTimer knows where to look when removing the timer

typedef struct CsrWifiFsmTimerList CsrWifiFsmTimerList

FSM timer list header.

Description

Singly linked list of timers.

typedef void(* CsrWifiFsmTransitionFnPtr)(CsrWifiFsmContext *context, void *fsmData, const CsrWifiFsmEvent *event)

Process Transition Function Pointer.

Description

Defines a transition function for a processes. Called when an event causes a transition on a process

Parameters

[in]	CsrWifiFsmContext*	: FSM context
[in]	void*	: FSM data (can be NULL)
[in]	const	CsrWifiFsmEvent* : event to process

Returns

void

Definition at line 144 of file csr_wifi_fsm_types.h.