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
|
#pragma once
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __GNUC__
#define __weak __attribute__((weak))
#endif
#ifndef __weak
#error Could not determine weak attribute for current compiler
#define __weak
#endif
//! I2C address (10 or 7 bit)
typedef uint16_t i2c_addr_t;
//! puzzle bus command types
enum pb_cmd_id {
PB_CMD_PROP, //!< puzzle module property
PB_CMD_STATE, //!< global state
PB_CMD_MAGIC, //!< magic (handshake)
};
typedef enum pb_cmd_id pb_cmd_id_t;
//! puzzle bus command action types
enum pb_action {
PB_ACTION_REQ, //!< request
PB_ACTION_RES, //!< response
PB_ACTION_SET, //!< (over)write
};
typedef enum pb_action pb_action_t;
//! puzzle bus global states
enum pb_global_state {
PB_GS_NOINIT, //!< uninitialized (only used by puzzle modules)
PB_GS_IDLE, //!< puzzle not started yet
PB_GS_PLAYING, //!< puzzle actively being solved
PB_GS_SOLVED, //!< puzzle completed
};
typedef enum pb_global_state pb_global_state_t;
//! magic sent from main controller to puzzle module
static const char pb_cmd_magic_req[] = { 0x70, 0x75, 0x7a, 0x62, 0x75, 0x73 };
//! magic reply from puzzle module back to main controller
static const char pb_cmd_magic_res[] = { 0x67, 0x61, 0x6d, 0x69, 0x6e, 0x67 };
//! puzzle bus message header (shared by all commands)
typedef struct {
pb_cmd_id_t type; //!< command type
pb_action_t action; //!< command action
i2c_addr_t sender; //!< i2c address of sender
void * cmd; //!< command data (type dependant)
} pb_msg_t;
//! PB_CMD_PROP data
typedef struct {
uint8_t propid; //!< id of state property
uint8_t * value; //!< new or current value
size_t _value_size; //!< [META] size of \p value
} pb_cmd_prop_t;
//! PB_CMD_STATE data
typedef struct {
pb_global_state_t state; //!< global state
} pb_cmd_state_t;
//! PB_MOD_STATE data
typedef struct {
i2c_addr_t sender; //!< i2c address of sender
pb_global_state_t state; //!< global state
} pb_puzzle_module_t;
//! PB_CMD_MAGIC data
typedef struct {
char * magic; //!< magic value
size_t _magic_size; //!< [META] size of \p magic
} pb_cmd_magic_t;
#ifdef __cplusplus
}
#endif
|