summaryrefslogtreecommitdiff
path: root/ucoo/intf/io.hh
blob: 34246a133770ed40b05a143d2817e1acf689acd3 (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 ucoo_intf_io_hh
#define ucoo_intf_io_hh
// ucoolib - Microcontroller object oriented library. {{{
//
// Copyright (C) 2012 Nicolas Schodet
//
// 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.
//
// }}}

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 // ucoo_intf_io_hh