summaryrefslogtreecommitdiff
path: root/digital/ucoolib/ucoolib/hal/uart/uart.stm32.hh
blob: d10d12d8d8007b8f97985cf4a6a5558e38f8ad84 (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
#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"

namespace ucoo {

/// Universal asynchronous receiver transmitter (UART).
class Uart : public Stream
{
  public:
    /// Parity setting.
    enum Parity { ODD, EVEN, NONE };
  public:
    /// Initialise the Nth UART with given parameters.
    Uart (int n, int speed, Parity parity, int stop_bits);
    /// Shutdown UART.
    ~Uart ();
    /// Change UART settings.
    void setup (int speed, Parity parity, int stop_bits);
    /// See Stream::read.
    int read (char *buf, int count);
    /// See Stream::write.
    int write (const char *buf, int count);
    /// See Stream::poll.
    int poll ();
};

} // namespace ucoo

#endif // ucoolib_hal_uart_uart_stm32_hh