aboutsummaryrefslogtreecommitdiff
path: root/shared/pb/types.h
blob: d4a65ed7afab618a537a2abf224b87ca5a9ea79b (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
74
75
76
77
78
#pragma once
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __GNUC__
#ifndef __packed
#define __packed __attribute__((packed))
#endif
#ifndef __weak
#define __weak __attribute__((weak))
#endif
#endif
#ifndef __packed
#error Could not determine packed attribute for current compiler
#define __packed
#endif
#ifndef __weak
#error Could not determine weak attribute for current compiler
#define __weak
#endif

/**
 * \brief puzzle bus command types
 *
 * The first byte of a puzzle bus message's data indicates the command type.
 */
enum __packed pb_cmd {
	PB_CMD_READ, //!< read a puzzle module property
	PB_CMD_WRITE, //!< write to a puzzle module property
	PB_CMD_SEX, //!< state exchange
	PB_CMD_MAGIC, //!< magic message
};
// typedef enum pb_cmd pb_cmd_t;

/** \brief magic sent from main controller to puzzle module */
static const char pb_magic_msg[] = { 0x70, 0x75, 0x7a, 0x62, 0x75, 0x73 };
/** \brief magic reply from puzzle module back to main controller */
static const char pb_magic_res[] = { 0x67, 0x61, 0x6d, 0x69, 0x6e, 0x67 };

/** \brief Puzzle bus global states */
enum __packed pb_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_state pb_state_t;

typedef struct __packed {
	const enum pb_cmd cmd;
	const uint8_t data[];
} pb_cmd_t;

typedef struct __packed {
	const uint8_t address;
	const uint8_t data[];
} pb_cmd_read_t;

typedef struct __packed {
	const uint8_t address;
	const uint8_t data[];
} pb_cmd_write_t;

typedef struct __packed {
	const enum pb_state main_state;
} pb_cmd_sex_t;

enum __packed {
	PB_ADDR_GS = 0x00, //!< global state address
};

#ifdef __cplusplus
}
#endif