uart.hh revision 12239 
1/*
2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Ali Saidi
29 */
30
31/** @file
32 * Base class for UART
33 */
34
35#ifndef __UART_HH__
36#define __UART_HH__
37
38#include "base/callback.hh"
39#include "dev/io_device.hh"
40#include "dev/serial/serial.hh"
41#include "params/Uart.hh"
42
43class Platform;
44
45const int RX_INT = 0x1;
46const int TX_INT = 0x2;
47
48class Uart : public BasicPioDevice
49{
50  protected:
51    int status;
52    Platform *platform;
53    SerialDevice *device;
54
55  public:
56    typedef UartParams Params;
57    Uart(const Params *p, Addr pio_size);
58
59    const Params *
60    params() const
61    {
62        return dynamic_cast<const Params *>(_params);
63    }
64
65    /**
66     * Inform the uart that there is data available.
67     */
68    virtual void dataAvailable() = 0;
69
70    /**
71     * Return if we have an interrupt pending
72     * @return interrupt status
73     */
74    bool intStatus() { return status ? true : false; }
75
76  protected:
77    MakeCallback<Uart, &Uart::dataAvailable> callbackDataAvail;
78};
79
80#endif // __UART_HH__
81