speaker.hh revision 7903:7fcfb515d7bf 
1/*
2 * Copyright (c) 2008 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: Gabe Black
29 */
30
31#ifndef __DEV_X86_SPEAKER_HH__
32#define __DEV_X86_SPEAKER_HH__
33
34#include "base/bitunion.hh"
35#include "params/PcSpeaker.hh"
36
37namespace X86ISA
38{
39
40class I8254;
41
42class Speaker : public BasicPioDevice
43{
44  protected:
45    Tick latency;
46
47    BitUnion8(SpeakerControl)
48        Bitfield<0> gate;
49        Bitfield<1> speaker;
50        Bitfield<5> timer;
51    EndBitUnion(SpeakerControl)
52
53    SpeakerControl controlVal;
54
55    I8254 * timer;
56
57  public:
58    typedef PcSpeakerParams Params;
59
60    const Params *
61    params() const
62    {
63        return dynamic_cast<const Params *>(_params);
64    }
65
66    Speaker(Params *p) : BasicPioDevice(p),
67        latency(p->pio_latency), controlVal(0), timer(p->i8254)
68    {
69        pioSize = 1;
70    }
71
72    Tick read(PacketPtr pkt);
73
74    Tick write(PacketPtr pkt);
75
76    virtual void serialize(std::ostream &os);
77    virtual void unserialize(Checkpoint *cp, const std::string &section);
78
79};
80
81} // namespace X86ISA
82
83#endif //__DEV_X86_SPEAKER_HH__
84