aboutsummaryrefslogtreecommitdiff
path: root/slip.c
blob: 3b448f4d176d231a344d85e242f885cc5db07233 (plain) (blame)
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/* SLIP send/recv code, from RFC 1055 */

#include <stdio.h>      /* perror */

#include "slip_internal.h"

/* SLIP special character codes
 */
#define END             0300    /* indicates end of packet */
#define ESC             0333    /* indicates byte stuffing */
#define ESC_END         0334    /* ESC ESC_END means END data byte */
#define ESC_ESC         0335    /* ESC ESC_ESC means ESC data byte */

/* SLIP_SEND: sends a packet of length "len", starting at
 * location "p".
 */
int hal_slip_send(const uint8_t * const ptr, const size_t len)
{
    int i;
    uint8_t *p = (uint8_t *)ptr;

#define check_send_char(c) if (hal_slip_send_char(c) == -1) return perror("write"), -1;

    /* send an initial END character to flush out any data that may
     * have accumulated in the receiver due to line noise
     */
    check_send_char(END);

    /* for each byte in the packet, send the appropriate character
     * sequence
     */
    for (i = 0; i < len; ++i) {
        switch (*p) {
            /* if it's the same code as an END character, we send a
             * special two character code so as not to make the
             * receiver think we sent an END
             */
        case END:
            check_send_char(ESC);
            check_send_char(ESC_END);
            break;

            /* if it's the same code as an ESC character,
             * we send a special two character code so as not
             * to make the receiver think we sent an ESC
             */
        case ESC:
            check_send_char(ESC);
            check_send_char(ESC_ESC);
            break;

            /* otherwise, we just send the character
             */
        default:
            check_send_char(*p);
        }

        p++;
    }

    /* tell the receiver that we're done sending the packet
     */
    check_send_char(END);

    return 0;
#undef check_send_char
}

/* SLIP_RECV: receives a packet into the buffer located at "p".
 *      If more than len bytes are received, the packet will
 *      be truncated.
 *      Returns the number of bytes stored in the buffer.
 */
int hal_slip_recv(uint8_t * const p, const size_t len)
{
    uint8_t c;
    size_t received = 0;

#define check_recv_char(c) if (hal_slip_recv_char(&c) == -1) return perror("read"), -1;

    /* sit in a loop reading bytes until we put together
     * a whole packet.
     * Make sure not to copy them into the packet if we
     * run out of room.
     */
    while (1) {
        /* get a character to process
         */
        check_recv_char(c);

        /* handle bytestuffing if necessary
         */
        switch (c) {

            /* if it's an END character then we're done with
             * the packet
             */
        case END:
            /* a minor optimization: if there is no
             * data in the packet, ignore it. This is
             * meant to avoid bothering IP with all
             * the empty packets generated by the
             * duplicate END characters which are in
             * turn sent to try to detect line noise.
             */
            if (received)
                return received;
            else
                break;

            /* if it's the same code as an ESC character, wait
             * and get another character and then figure out
             * what to store in the packet based on that.
             */
        case ESC:
            check_recv_char(c);

            /* if "c" is not one of these two, then we
             * have a protocol violation.  The best bet
             * seems to be to leave the byte alone and
             * just stuff it into the packet
             */
            switch(c) {
            case ESC_END:
                c = END;
                break;
            case ESC_ESC:
                c = ESC;
                break;
            }

            /* here we fall into the default handler and let
             * it store the character for us
             */
        default:
            if (received < len)
                p[received++] = c;
        }
    }
#undef check_recv_char
}