aboutsummaryrefslogtreecommitdiff
path: root/testing/yup-comm/protocol/frame.h
blob: d1019687cd19035dee86b59cf310b32031510195 (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
/* Author: Jan Sucan */

#ifndef FRAME_H_
#define FRAME_H_

#include "return_codes.h"

#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>

#define FRAME_MAX_BYTES       254

#define FRAME_MAX_DATA_BYTES  240

typedef struct {
	uint8_t raw[FRAME_MAX_BYTES];
} frame_t;

void            frame_init   (frame_t * const frame, uint8_t protocol_version);
yup_retcode_t   frame_receive(frame_t * const frame, uint8_t protocol_version);
void            frame_send   (frame_t * const frame);

// Protocol version
uint8_t  frame_get_protocol_version(const frame_t * const frame);
void     frame_set_protocol_version(frame_t * const frame, uint8_t v);
// Flags
void     frame_set_flag_ack(frame_t * const frame);
bool     frame_is_flag_ack_set(const frame_t * const frame);
void     frame_set_flag_rej(frame_t * const frame);
bool     frame_is_flag_rej_set(const frame_t * const frame);
void     frame_set_flag_lor(frame_t * const frame);
bool     frame_is_flag_lor_set(const frame_t * const frame);
// Data length
uint8_t  frame_get_data_length(const frame_t * const frame);
void     frame_set_data_length(frame_t * const frame, uint8_t v);
// Relation ID
uint16_t frame_get_relation_id(const frame_t * const frame);
void     frame_set_relation_id(frame_t * const frame, uint16_t v);
// Seq number
uint16_t frame_get_seq_number(const frame_t * const frame);
void     frame_set_seq_number(frame_t * const frame, uint16_t v);
// Header checksum
uint32_t frame_get_header_checksum(const frame_t * const frame);
void     frame_set_header_checksum(frame_t * const frame);
// Data
void     frame_get_data(const frame_t * const frame, uint8_t * const data, uint8_t * const data_length);
void     frame_set_data(frame_t * const frame, const uint8_t * const data, uint8_t num);
// Data checksum
uint32_t frame_get_data_checksum(const frame_t * const frame);
void     frame_set_data_checksum(frame_t * const frame);

// Ostatne
uint8_t  frame_get_length(const frame_t * const frame);

#endif /* FRAME_H_ */