aboutsummaryrefslogtreecommitdiffstats
path: root/libmaple/usart.c
blob: 030d3ccd87d082e8cca1d16193dbb475a3b6a625 (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
/******************************************************************************
 * 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.
 *****************************************************************************/

/**
 * @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 UART4_BASE     0x40004C00  // High-density devices only (Maple Native)
#define UART5_BASE     0x40005000  // High-density devices only (Maple Native)

#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_TC       BIT(6)

/* usart descriptor table  */
struct usart_dev usart_dev_table[] = {
    [USART1] = {
        .base = (usart_port*)USART1_BASE,
        .rcc_dev_num = RCC_USART1,
        .nvic_dev_num = NVIC_USART1
    },
    [USART2] = {
        .base = (usart_port*)USART2_BASE,
        .rcc_dev_num = RCC_USART2,
        .nvic_dev_num = NVIC_USART2
    },
    [USART3] = {
        .base = (usart_port*)USART3_BASE,
        .rcc_dev_num = RCC_USART3,
        .nvic_dev_num = NVIC_USART3
    },
#ifdef STM32_HIGH_DENSITY
    /* TODO test */
    [UART4] = {
        .base = (usart_port*)UART4_BASE,
        .rcc_dev_num = RCC_UART4,
        .nvic_dev_num = NVIC_UART4
    },
    [UART5] = {
        .base = (usart_port*)UART5_BASE,
        .rcc_dev_num = RCC_UART5,
        .nvic_dev_num = NVIC_UART5
    },
#endif
};

/*
 * Usart interrupt handlers.
 */

static inline void usart_irq(int usart_num) {
#ifdef USART_SAFE_INSERT
    /* Ignore old bytes if the user defines USART_SAFE_INSERT. */
    rb_safe_insert(&(usart_dev_table[usart_num].rb),
                   (uint8)((usart_dev_table[usart_num].base)->DR));
#else
    /* By default, push bytes around in the ring buffer. */
    rb_push_insert(&(usart_dev_table[usart_num].rb),
                   (uint8)((usart_dev_table[usart_num].base)->DR));
#endif
}

/* TODO: Check the disassembly for the following functions to make
   sure GCC inlined properly. */

void USART1_IRQHandler(void) {
    usart_irq(USART1);
}

void USART2_IRQHandler(void) {
    usart_irq(USART2);
}

void USART3_IRQHandler(void) {
    usart_irq(USART3);
}

#ifdef STM32_HIGH_DENSITY
void UART4_IRQHandler(void) {
    usart_irq(UART4);
}

void UART5_IRQHandler(void) {
    usart_irq(UART5);
}
#endif

/**
 *  @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
 */
void usart_init(uint8 usart_num, uint32 baud) {
#ifdef STM32_HIGH_DENSITY
    ASSERT(usart_num <= UART5);
#else
    ASSERT(usart_num <= USART3);
#endif
    usart_port *port;
    ring_buffer *ring_buf;

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

    port = usart_dev_table[usart_num].base;
    rcc_clk_enable(usart_dev_table[usart_num].rcc_dev_num);
    nvic_irq_enable(usart_dev_table[usart_num].nvic_dev_num);

    /* usart1 is mad fast  */
    clk_speed = (usart_num == USART1) ? 72000000UL : 36000000UL;

    /* Initialize rx ring buffer  */
    rb_init(&usart_dev_table[usart_num].rb,
            sizeof (usart_dev_table[usart_num].rx_buf),
            usart_dev_table[usart_num].rx_buf);

    /* 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 all USARTs.
 */
void usart_disable_all() {
    usart_disable(USART1);
    usart_disable(USART2);
    usart_disable(USART3);
#ifdef STM32_HIGH_DENSITY
    usart_disable(UART4);
    usart_disable(UART5);
#endif
}

/**
 * @brief Turn off a USART.
 * @param USART to be disabled
 */
void usart_disable(uint8 usart_num) {
    usart_port *port = usart_dev_table[usart_num].base;

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

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

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


/**
 * @brief Print a null terminated string to the specified USART
 *
 * @param usart_num usart to send on
 * @param str string to send
 */
void usart_putstr(uint8 usart_num, const char* str) {
    char ch;

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

/**
 * @brief Print an unsigned integer to the specified usart
 *
 * @param usart_num usart to send on
 * @param val number to print
 */
void usart_putudec(uint8 usart_num, uint32 val) {
    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]);
    }
}