summaryrefslogtreecommitdiff
path: root/digital/ucoolib/ucoolib/hal/uart/uart.stm32.hh
blob: 1bfbcdb3d16e01282dcd80ba6de2444af4db3617 (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
#ifndef ucoolib_hal_uart_uart_stm32_hh
#define ucoolib_hal_uart_uart_stm32_hh
// ucoolib - Microcontroller object oriented library. {{{
//
// Copyright (C) 2012 Nicolas Schodet
//
// APBTeam:
//        Web: http://apbteam.org/
//      Email: team AT apbteam DOT org
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// }}}
#include "ucoolib/intf/stream.hh"
#include "ucoolib/utils/fifo.hh"

#include "config/hal/uart.hh"

namespace ucoo {

/// Universal asynchronous receiver transmitter (UART).
///
/// When an error is detected on RX, error character is inserted in receive
/// FIFO.
class Uart : public Stream
{
  public:
    /// Parity setting.
    enum Parity { ODD, EVEN, NONE };
    /// Default error character.
    static const char default_error_char = '~';
  public:
    /// Constructor for the Nth UART.
    Uart (int n);
    /// Shutdown UART.
    ~Uart ();
    /// Enable and setup UART.
    void enable (int speed, Parity parity = NONE, int stop_bits = 1);
    /// Disable.
    void disable ();
    /// Change the error character.
    void set_error_char (char c);
    /// See Stream::read.
    int read (char *buf, int count);
    /// See Stream::write.
    int write (const char *buf, int count);
    /// See Stream::poll.
    int poll ();
    /// Handle interrupts.
    static void isr (int n);
  private:
    /// UART number.
    int n_;
    /// RX FIFO, filled by interrupt handler.
    Fifo<char, UCOO_CONFIG_HAL_UART_RX_BUFFER> rx_fifo_;
    /// TX FIFO, emptied by interrupt handler.
    Fifo<char, UCOO_CONFIG_HAL_UART_TX_BUFFER> tx_fifo_;
    /// Error character, inserted in case of error.
    char error_char_;
    /// Is it enabled?
    bool enabled_;
};

} // namespace ucoo

#endif // ucoolib_hal_uart_uart_stm32_hh