summaryrefslogtreecommitdiff
path: root/ucoo/dev/lcd/lcd_spi.hh
blob: b0f43681d1ee4ca49b72c0d2673dee3024084566 (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
#ifndef ucoo_dev_lcd_lcd_spi_hh
#define ucoo_dev_lcd_lcd_spi_hh
// ucoolib - Microcontroller object oriented library. {{{
//
// Copyright (C) 2015 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.
//
// }}}
#include "ucoo/intf/lcd.hh"
#include "ucoo/intf/spi_master.hh"
#include "ucoo/intf/io.hh"

// TODO: support several LCD and buses using subclassing.

namespace ucoo {

/// Typical character based LCD using SPI connection.
class LcdSpi : public Lcd
{
  public:
    /// Constructor.
    LcdSpi (SpiMaster &spi, Io &cs, Io &rs);
    /// Destructor.
    ~LcdSpi ();
    /// Enable, initialise display.
    void enable ();
    /// Disable, clear display and shutdown if possible.
    void disable ();
    /// See Lcd::puts.
    void puts (const char *str);
    /// See Lcd::go.
    void go (int line, int column);
    /// See Lcd::clear.
    void clear ();
    /// See Lcd::get_lines.
    int get_lines () const;
    /// See Lcd::get_columns.
    int get_columns () const;
  protected:
    /// Send commands or data to LCD.
    void send (const char *buf, int count, bool command = false,
               bool long_delay = false);
  private:
    SpiMaster &spi_;
    Io &cs_, &rs_;
    /// Number of lines, columns and current line.
    int lines_, columns_, cur_line_;
    /// Is it enabled?
    bool enabled_;
    /// SPI frequency.
    static const int spi_speed_hz_ = 250000;
};

inline
LcdSpi::LcdSpi (SpiMaster &spi, Io &cs, Io &rs)
    : spi_ (spi), cs_ (cs), rs_ (rs),
      lines_ (2), columns_ (16),
      cur_line_ (0), enabled_ (false)
{
}

} // namespace ucoo

#endif // ucoo_dev_lcd_lcd_spi_hh