summaryrefslogtreecommitdiff
path: root/digital/ucoolib/ucoolib/intf/io.hh
blob: ebb5e75ed98897af8375cfd0acdab9e98f2a1eb1 (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
#ifndef ucoolib_ucoolib_intf_io_hh
#define ucoolib_ucoolib_intf_io_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.
//
// }}}

namespace ucoo {

/// One bit input/output interface.
class Io
{
  public:
    /// Set output to 1.
    virtual void set () = 0;
    /// Reset output to 0.
    virtual void reset () = 0;
    /// Set or reset output.
    virtual void set (bool state) = 0;
    /// Toggle output.
    virtual void toggle () = 0;
    /// Get input state (not the same as output latch!).
    virtual bool get () const = 0;
    /// Set as input.
    virtual void input () = 0;
    /// Set as output.
    virtual void output () = 0;
  protected:
    /// Default constructor.
    Io () { }
};

} // namespace ucoo

#endif // ucoolib_ucoolib_intf_io_hh