forked from cmcqueen/cobs-c
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcobs.h
110 lines (87 loc) · 3.33 KB
/
cobs.h
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*****************************************************************************
*
* cobs.h
*
* Consistent Overhead Byte Stuffing
*
****************************************************************************/
#ifndef COBS_H_
#define COBS_H_
/*****************************************************************************
* Includes
****************************************************************************/
#include <stdint.h>
#include <stdlib.h>
/*****************************************************************************
* Defines
****************************************************************************/
#define COBS_ENCODE_DST_BUF_LEN_MAX(SRC_LEN) (((SRC_LEN) == 0u) ? 1u : ((SRC_LEN) + (((SRC_LEN) + 253u) / 254u)))
#define COBS_DECODE_DST_BUF_LEN_MAX(SRC_LEN) (((SRC_LEN) == 0u) ? 0u : ((SRC_LEN) - 1u))
/*
* For in-place encoding, the source data must be offset in the buffer by
* the following amount (or more).
*/
#define COBS_ENCODE_SRC_OFFSET(SRC_LEN) (((SRC_LEN) + 253u)/254u)
/*****************************************************************************
* Typedefs
****************************************************************************/
typedef enum
{
COBS_ENCODE_OK = 0x00,
COBS_ENCODE_NULL_POINTER = 0x01,
COBS_ENCODE_OUT_BUFFER_OVERFLOW = 0x02
} cobs_encode_status;
typedef struct
{
size_t out_len;
cobs_encode_status status;
} cobs_encode_result;
typedef enum
{
COBS_DECODE_OK = 0x00,
COBS_DECODE_NULL_POINTER = 0x01,
COBS_DECODE_OUT_BUFFER_OVERFLOW = 0x02,
COBS_DECODE_ZERO_BYTE_IN_INPUT = 0x04,
COBS_DECODE_INPUT_TOO_SHORT = 0x08
} cobs_decode_status;
typedef struct
{
size_t out_len;
cobs_decode_status status;
} cobs_decode_result;
/*****************************************************************************
* Function prototypes
****************************************************************************/
#ifdef __cplusplus
extern "C" {
#endif
/* COBS-encode a string of input bytes.
*
* dst_buf_ptr: The buffer into which the result will be written
* dst_buf_len: Length of the buffer into which the result will be written
* src_ptr: The byte string to be encoded
* src_len Length of the byte string to be encoded
*
* returns: A struct containing the success status of the encoding
* operation and the length of the result (that was written to
* dst_buf_ptr)
*/
cobs_encode_result cobs_encode(void * dst_buf_ptr, size_t dst_buf_len,
const void * src_ptr, size_t src_len);
/* Decode a COBS byte string.
*
* dst_buf_ptr: The buffer into which the result will be written
* dst_buf_len: Length of the buffer into which the result will be written
* src_ptr: The byte string to be decoded
* src_len Length of the byte string to be decoded
*
* returns: A struct containing the success status of the decoding
* operation and the length of the result (that was written to
* dst_buf_ptr)
*/
cobs_decode_result cobs_decode(void * dst_buf_ptr, size_t dst_buf_len,
const void * src_ptr, size_t src_len);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* COBS_H_ */