HARMcksL/handlers_sequencer.h at master · SMFSW/HARMcksL · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*!\file handlers_sequencer.h
** \author SMFSW
** \copyright MIT (c) 2017-2026, SMFSW
** \brief Simple task sequencer handling
**/
/****************************************************************/
#ifndef HANDLERS_SEQUENCER_H__
	#define HANDLERS_SEQUENCER_H__

#ifdef __cplusplus
	extern "C" {
#endif

#include "sarmfsw.h"
/****************************************************************/


// *****************************************************************************
// Section: Types
// *****************************************************************************
/*!\enum eSeqCallback
** \brief Callback id
**/
typedef enum {
	cback_preSeq = 0,
	cback_postSeq,
	cback_preHandle,
	cback_postHandle,
	cback_max,
} eSeqCallback;


typedef struct sequencer	Sequencer;					//!< Typedef for StruSequencer used by function pointers included in struct

typedef void (*pfHandler_t)(void);						//!< Basic handler function pointer typedef
typedef void (*pfSeq_cback_t)(Sequencer const *);


typedef struct {
	const pfHandler_t *	aHandlers;
	uintCPU_t			nb_handlers;
	pfSeq_cback_t		pf_callback[cback_max];
	uint32_t			handler_en;
} Sequencer_cfg;


/*!\struct sequencer
** \brief Sequencer structure
**/
struct sequencer {
	Sequencer_cfg	cfg;
	uintCPU_t		current_handler;
	bool			sequencer_en;
};


// *****************************************************************************
// Section: Interface Routines
// *****************************************************************************
__INLINE void NONNULL_INLINE__ handler_disable(Sequencer * const pSeq, const uint8_t idx) {
	CLR_BITS(pSeq->cfg.handler_en, LSHIFT32(1UL, idx)); }

__INLINE void NONNULL_INLINE__ handler_enable(Sequencer * const pSeq, const uint8_t idx) {
	SET_BITS(pSeq->cfg.handler_en, LSHIFT32(1UL, idx)); }

__INLINE void NONNULL_INLINE__ handler_set_mask(Sequencer * const pSeq, const uint32_t mask) {
	pSeq->cfg.handler_en = mask; }

__INLINE void NONNULL_INLINE__ sequencer_stop(Sequencer * const pSeq) {
	pSeq->sequencer_en = false; }

__INLINE void NONNULL_INLINE__ sequencer_start(Sequencer * const pSeq) {
	pSeq->sequencer_en = true; }

FctERR NONNULL__ sequencer_init(Sequencer * const pSeq, const pfHandler_t * const aHandlers, const uintCPU_t nb_handlers, const bool start);
FctERR NONNULL__ sequencer_init_all(Sequencer * const pSeq, const Sequencer_cfg * const pCfg, const bool start);
FctERR NONNULL__ sequencer_deinit(Sequencer * const pSeq);

// Note: sequencer_init has to be called prior registering any callback
FctERR NONNULL__ sequencer_register_callback(Sequencer * const pSeq, const eSeqCallback callback, const pfSeq_cback_t pCallback);
FctERR NONNULL__ sequencer_unregister_callback(Sequencer * const pSeq, const eSeqCallback callback);

void NONNULL__ sequencer_handler(Sequencer * const pSeq);

/****************************************************************/
#ifdef __cplusplus
	}
#endif

#endif	/* HANDLERS_SEQUENCER_H__ */
/****************************************************************/