aboutsummaryrefslogtreecommitdiffstats
path: root/libmaple/usart.c
blob: 282fc5d4a18baa75bfbb90e837540fa7bc0a52d1 (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
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
/* *****************************************************************************
 * The MIT License
 *
 * Copyright (c) 2010 Perry Hung.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * ****************************************************************************/

/**
 *  @file usart.c
 *
 *  @brief USART control routines
 */

#include "libmaple.h"
#include "rcc.h"
#include "nvic.h"
#include "usart.h"

#define USART1_BASE         0x40013800
#define USART2_BASE         0x40004400
#define USART3_BASE         0x40004800

#define USART_UE            BIT(13)
#define USART_M             BIT(12)
#define USART_TE            BIT(3)
#define USART_RE            BIT(2)
#define USART_RXNEIE        BIT(5)       // read data register not empty interrupt enable
#define USART_TXE           BIT(7)
#define USART_TC            BIT(6)

#define USART_STOP_BITS_1   BIT_MASK_SHIFT(0b0, 12)
#define USART_STOP_BITS_05  BIT_MASK_SHIFT(0b01, 12)
#define USART_STOP_BITS_2   BIT_MASK_SHIFT(0b02, 12)
#define USART_STOP_BITS_15  BIT_MASK_SHIFT(0b02, 12)

#define USART1_CLK          72000000UL
#define USART2_CLK          36000000UL
#define USART3_CLK          36000000UL

#define USART_RECV_BUF_SIZE 64

/* Ring buffer notes:
 * The buffer is empty when head == tail.
 * The buffer is full when the head is one byte in front of the tail
 * The total buffer size must be a power of two
 * Note, one byte is necessarily left free with this scheme */
typedef struct usart_ring_buf {
    uint32 head;
    uint32 tail;
    uint8 buf[USART_RECV_BUF_SIZE];
} usart_ring_buf;

static usart_ring_buf ring_buf1;
static usart_ring_buf ring_buf2;
static usart_ring_buf ring_buf3;

typedef struct usart_port {
    volatile uint32 SR;       // Status register
    volatile uint32 DR;       // Data register
    volatile uint32 BRR;      // Baud rate register
    volatile uint32 CR1;      // Control register 1
    volatile uint32 CR2;      // Control register 2
    volatile uint32 CR3;      // Control register 3
    volatile uint32 GTPR;     // Guard time and prescaler register
} usart_port;

void USART1_IRQHandler(void) {
    /* Read the data  */
    ring_buf1.buf[ring_buf1.tail++] = (uint8)(((usart_port*)(USART1_BASE))->DR);
    ring_buf1.tail %= USART_RECV_BUF_SIZE;
}

/* Don't overrun your buffer, seriously  */
void USART2_IRQHandler(void) {
    /* Read the data  */
    ring_buf2.buf[ring_buf2.tail++] = (uint8)(((usart_port*)(USART2_BASE))->DR);
    ring_buf2.tail %= USART_RECV_BUF_SIZE;
}
/* Don't overrun your buffer, seriously  */
void USART3_IRQHandler(void) {
    /* Read the data  */
    ring_buf3.buf[ring_buf3.tail++] = (uint8)(((usart_port*)(USART3_BASE))->DR);
    ring_buf3.tail %= USART_RECV_BUF_SIZE;
}

/**
 *  @brief Enable a USART in single buffer transmission mode, multibuffer
 *  receiver mode.
 *
 *  @param usart_num USART to be initialized
 *  @param baud Baud rate to be set at
 *  @param recvBuf buf buffer for receiver
 *  @param len size of recvBuf
 *
 *  @sideeffect Turns on the specified USART
 */
void usart_init(uint8 usart_num, uint32 baud) {
    ASSERT((usart_num <= NR_USARTS) && (usart_num > 0));
    ASSERT(baud && (baud < USART_MAX_BAUD));

    usart_port *port;
    usart_ring_buf *ring_buf;

    uint32 clk_speed;
    uint32 integer_part;
    uint32 fractional_part;
    uint32 tmp;

    switch (usart_num) {
    case 1:
        port = (usart_port*)USART1_BASE;
        ring_buf = &ring_buf1;
        clk_speed = USART1_CLK;
        rcc_enable_clk_usart1();
        REG_SET(NVIC_ISER1, BIT(5));
        break;
    case 2:
        port = (usart_port*)USART2_BASE;
        ring_buf = &ring_buf2;
        clk_speed = USART2_CLK;
        rcc_enable_clk_usart2();
        REG_SET(NVIC_ISER1, BIT(6));
        break;
    case 3:
        port = (usart_port*)USART3_BASE;
        ring_buf = &ring_buf3;
        clk_speed = USART3_CLK;
        rcc_enable_clk_usart3();
        REG_SET(NVIC_ISER1, BIT(7));
        break;
    default:
        /* should never get here  */
        ASSERT(0);
    }

    /* Initialize ring buffer  */
    ring_buf->head = 0;
    ring_buf->tail = 0;

    /* Set baud rate  */
    integer_part = ((25 * clk_speed) / (4 * baud));
    tmp = (integer_part / 100) << 4;

    fractional_part = integer_part - (100 * (tmp >> 4));
    tmp |= (((fractional_part * 16) + 50) / 100) & ((uint8)0x0F);

    port->BRR = (uint16)tmp;

    port->CR1 = USART_TE          |    // transmitter enable
                USART_RE          |    // receiver enable
                USART_RXNEIE;          // receive interrupt enable


    /* Enable the USART and set mode to 8n1 */
    port->CR1 |= USART_UE;
}


/**
 *  @brief Turn off a USART.
 *
 *  @param USART to be disabled
 *
 *  @sideeffect Turns off the specified USART
 */
void usart_disable(uint8 usart_num) {
    ASSERT((usart_num <= NR_USARTS) && (usart_num > 0));
    usart_port *port;

    switch (usart_num) {
    case 1:
        port = (usart_port*)USART1_BASE;
        break;
    case 2:
        port = (usart_port*)USART2_BASE;
        break;
    case 3:
        port = (usart_port*)USART3_BASE;
        break;
    default:
        /* should never get here  */
        ASSERT(0);
    }

    /* Is this usart enabled?  */
    if (!(port->SR & USART_UE))
        return;

    /* TC bit must be high before disabling the usart  */
    while ((port->SR & USART_TC) == 0)
        ;

    /* Disable UE */
    port->CR1 = 0;

    /* Clean up buffer */
    usart_clear_buffer(usart_num);
}


/**
 *  @brief Print a null terminated string to the specified USART
 *
 *  @param[in] usart_num USART to send on
 *  @param[in] str String to send
 */
void usart_putstr(uint8 usart_num, const char* str) {
    ASSERT((usart_num <= NR_USARTS) && (usart_num > 0));
    char ch;

    while((ch = *(str++)) != '\0') {
        usart_putc(usart_num, ch);
    }
}

/**
 *  @brief Print an unsigned integer to the specified usart
 *
 *  @param[in] usart_num usart to send on
 *  @param[in] val number to print
 */
void usart_putudec(uint8 usart_num, uint32 val) {
    ASSERT((usart_num <= NR_USARTS) && (usart_num > 0));
    char digits[12];
    int i;

    i = 0;
    do {
        digits[i++] = val % 10 + '0';
        val /= 10;
    } while (val > 0);
    while (--i >= 0) {
        usart_putc(usart_num, digits[i]);
    }

}


/**
 *  @brief Return one character from the receive buffer. Assumes
 *  that there is data available.
 *
 *  @param[in] usart_num number of the usart to read from
 *
 *  @return character from ring buffer
 *
 *  @sideeffect may update the head pointer of the recv buffer
 */
uint8 usart_getc(uint8 usart_num) {
    uint8 ch;
    usart_ring_buf *rb;

    switch (usart_num) {
    case 1:
        rb = &ring_buf1;
        break;
    case 2:
        rb = &ring_buf2;
        break;
    case 3:
        rb = &ring_buf3;
        break;
    default:
        ASSERT(0);
    }

    /* Make sure there's actually data to be read  */
    ASSERT(rb->head != rb->tail);

    /* Read the data and check for wraparound  */
    ch = rb->buf[rb->head++];
    rb->head %= USART_RECV_BUF_SIZE;

    return ch;
}

uint32 usart_data_available(uint8 usart_num) {
    usart_ring_buf *rb;

    switch (usart_num) {
    case 1:
        rb = &ring_buf1;
        break;
    case 2:
        rb = &ring_buf2;
        break;
    case 3:
        rb = &ring_buf3;
        break;
    default:
        ASSERT(0);
    }

    return rb->tail - rb->head;
}

void usart_clear_buffer(uint8 usart_num) {
    usart_ring_buf *rb;

    switch (usart_num) {
    case 1:
        rb = &ring_buf1;
        break;
    case 2:
        rb = &ring_buf2;
        break;
    case 3:
        rb = &ring_buf3;
        break;
    default:
        ASSERT(0);
    }

    rb->tail = rb->head;
}



/**
 *  @brief Output a byte out the uart
 *
 *  @param[in] usart_num usart number to output on
 *  @param[in] byte byte to send
 *
 */
void usart_putc(uint8 usart_num, uint8 byte) {
    ASSERT((usart_num <= NR_USARTS) && (usart_num > 0));
    usart_port *port;

    switch (usart_num) {
    case 1:
        port = (usart_port*)USART1_BASE;
        break;
    case 2:
        port = (usart_port*)USART2_BASE;
        break;
    case 3:
        port = (usart_port*)USART3_BASE;
        break;
    default:
        /* Should never get here  */
        ASSERT(0);
    }

//    if (ch == '\n') {
//        usart_putc(usart_num, '\r');
//    }

    port->DR = byte;

    /* Wait for transmission to complete  */
    while ((port->SR & USART_TXE) == 0)
        ;
}