speaker.hh revision 5445 
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_SOUTH_BRIDGE_SPEAKER_HH__
32#define __DEV_X86_SOUTH_BRIDGE_SPEAKER_HH__
33
34#include "arch/x86/x86_traits.hh"
35#include "base/range.hh"
36#include "dev/x86/south_bridge/sub_device.hh"
37
38namespace X86ISA
39{
40
41class I8254;
42
43class Speaker : public SubDevice
44{
45  protected:
46    BitUnion8(SpeakerControl)
47        Bitfield<0> gate;
48        Bitfield<1> speaker;
49        Bitfield<5> timer;
50    EndBitUnion(SpeakerControl)
51
52    SpeakerControl controlVal;
53
54    I8254 * timer;
55
56  public:
57
58    Speaker(I8254 * _timer) : timer(_timer)
59    {}
60    Speaker(I8254 * _timer, Tick _latency) :
61        SubDevice(_latency), timer(_timer)
62    {}
63    Speaker(I8254 * _timer, Addr start, Addr size, Tick _latency) :
64        SubDevice(start, size, _latency), timer(_timer)
65    {}
66
67    Tick read(PacketPtr pkt);
68
69    Tick write(PacketPtr pkt);
70};
71
72}; // namespace X86ISA
73
74#endif //__DEV_X86_SOUTH_BRIDGE_SPEAKER_HH__
75