summaryrefslogtreecommitdiff
path: root/include/dataflow.h
blob: 665c92d6e6501e8f00c3e33af6a5cfb4f98e7a45 (plain)
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
#include "stream.h"

/*
 *
 * Dataflow Status Enumeration
 *
 * This typedef governs the dataflow state machine. Enums should be self explanatory
 *
 * TODO Handle other DF pathways for slave RX datapoint and slave RX command
 *
 * |------------+-----+----------------------------------------+---------------------+-------------------------|
 * | Status     | Int | Status Invariant                       | Action              | Next Status             |
 * |------------+-----+----------------------------------------+---------------------+-------------------------|
 * | DF_IDLE    |   0 | Ready to send m2s_SOR                  | Send m2s_SOR        | DF_RX_DOC or ???        |
 * | DF_RX_DOC  |   1 | Sent m2s_SOR; ready to receive s2m_DOC | Receive s2m_DOC     | DF_CTS                  |
 * | DF_CTS     |   2 | Received m2s_SOR; ready to send DF_CTS | Send m2s_CTS        | DF_RX_DATA or DF_RX_CMD |
 * | DF_RX_DATA |   3 | Sent m2s_CTS; receive s2m_data         | Receive s2m_data    | DF_SUCCESS              |
 * | DF_RX_CMD  |   4 | sent m2s_CTS receive s2m_command       | Receive s2m_command | DF_SUCCESS              |
 * |------------+-----+----------------------------------------+---------------------+-------------------------|
 *
 *
*/

typedef enum dataflow_status {
    DF_IDLE      = 0,
    DF_RX_DOC    = 1,
    DF_CTS       = 2,
    DF_RX_DATA   = 3,
    DF_RX_CMD    = 4,
    DF_SUCCESS   = 5,
    DF_FAIL      = 6,
    DF_TX_DATA   = 7,
    DF_TX_CMD    = 8
} dataflow_status_t;

typedef enum SOR_codes {
    SLAVE_TX            = 1,
    SLAVE_RX_DATAPOINT  = 2,
    SLAVE_RX_COMMAND    = 3
} SOR_codes_t;

typedef enum DOC_codes {
    CMD_UNICAST    = 0x1,
    CMD_MULTICAST  = 0x2,
    CMD_BROADCAST  = 0x3,
    RESERVED       = 0x4,
    DATA           = 0x5
} DOC_codes_t;



#define EXPAND_AS_ENUM(a, b) a,
#define EXPAND_AS_JUMPTABLE(a, b) b,
#define EXPAND_DF_PROTOTYPES(a, b) int b(p_stream_t, void**);

#define DF_STATE_TABLE(ENTRY)			\
    ENTRY(DF_IDLE, DF_func_idle)		\
	ENTRY(DF_RX_DOC, DF_rx_doc)		\
	ENTRY(DF_RX_DATA, DF_rx_data)		\
	ENTRY(DF_RX_CMD, DF_rx_cmd)		\
	ENTRY(DF_TX_DATA, DF_tx_data)		\
	ENTRY(DF_TX_CMD, DF_tx_cmd)

enum {
    /* DF_STATE_TABLE(EXPAND_AS_ENUM) */
    /* NUM_DF_STATES, */
    DF_STATE_FAIL,
    DF_STATE_SUCCESS
};

typedef int (*df_func_t)(p_stream_t, void**);

DF_STATE_TABLE(EXPAND_DF_PROTOTYPES);