intel_8254_timer.hh revision 5444
15443Sgblack@eecs.umich.edu/* 25443Sgblack@eecs.umich.edu * Copyright (c) 2004, 2005 35443Sgblack@eecs.umich.edu * The Regents of The University of Michigan 45443Sgblack@eecs.umich.edu * All Rights Reserved 55443Sgblack@eecs.umich.edu * 65443Sgblack@eecs.umich.edu * This code is part of the M5 simulator. 75443Sgblack@eecs.umich.edu * 85443Sgblack@eecs.umich.edu * Permission is granted to use, copy, create derivative works and 95443Sgblack@eecs.umich.edu * redistribute this software and such derivative works for any 105443Sgblack@eecs.umich.edu * purpose, so long as the copyright notice above, this grant of 115443Sgblack@eecs.umich.edu * permission, and the disclaimer below appear in all copies made; and 125443Sgblack@eecs.umich.edu * so long as the name of The University of Michigan is not used in 135443Sgblack@eecs.umich.edu * any advertising or publicity pertaining to the use or distribution 145443Sgblack@eecs.umich.edu * of this software without specific, written prior authorization. 155443Sgblack@eecs.umich.edu * 165443Sgblack@eecs.umich.edu * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE 175443Sgblack@eecs.umich.edu * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND 185443Sgblack@eecs.umich.edu * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER 195443Sgblack@eecs.umich.edu * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED 205443Sgblack@eecs.umich.edu * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 215443Sgblack@eecs.umich.edu * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE 225443Sgblack@eecs.umich.edu * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT, 235443Sgblack@eecs.umich.edu * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM 245443Sgblack@eecs.umich.edu * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN 255443Sgblack@eecs.umich.edu * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH 265443Sgblack@eecs.umich.edu * DAMAGES. 275443Sgblack@eecs.umich.edu * 285443Sgblack@eecs.umich.edu * Authors: Ali G. Saidi 295443Sgblack@eecs.umich.edu * Andrew L. Schultz 305443Sgblack@eecs.umich.edu * Miguel J. Serrano 315443Sgblack@eecs.umich.edu */ 325443Sgblack@eecs.umich.edu 335443Sgblack@eecs.umich.edu#ifndef __DEV_8254_HH__ 345443Sgblack@eecs.umich.edu#define __DEV_8254_HH__ 355443Sgblack@eecs.umich.edu 365443Sgblack@eecs.umich.edu#include "base/bitunion.hh" 375443Sgblack@eecs.umich.edu#include "sim/eventq.hh" 385443Sgblack@eecs.umich.edu#include "sim/host.hh" 395443Sgblack@eecs.umich.edu#include "sim/serialize.hh" 405443Sgblack@eecs.umich.edu 415443Sgblack@eecs.umich.edu#include <string> 425443Sgblack@eecs.umich.edu#include <iostream> 435443Sgblack@eecs.umich.edu 445443Sgblack@eecs.umich.edu/** Programmable Interval Timer (Intel 8254) */ 455443Sgblack@eecs.umich.educlass Intel8254Timer 465443Sgblack@eecs.umich.edu{ 475443Sgblack@eecs.umich.edu BitUnion8(CtrlReg) 485443Sgblack@eecs.umich.edu Bitfield<7, 6> sel; 495443Sgblack@eecs.umich.edu Bitfield<5, 4> rw; 505443Sgblack@eecs.umich.edu Bitfield<3, 1> mode; 515443Sgblack@eecs.umich.edu Bitfield<0> bcd; 525443Sgblack@eecs.umich.edu EndBitUnion(CtrlReg) 535443Sgblack@eecs.umich.edu 545443Sgblack@eecs.umich.edu enum SelectVal { 555443Sgblack@eecs.umich.edu SelectCounter0, 565443Sgblack@eecs.umich.edu SelectCounter1, 575443Sgblack@eecs.umich.edu SelectCounter2, 585443Sgblack@eecs.umich.edu ReadBackCommand 595443Sgblack@eecs.umich.edu }; 605443Sgblack@eecs.umich.edu 615443Sgblack@eecs.umich.edu enum ReadWriteVal { 625443Sgblack@eecs.umich.edu LatchCommand, 635443Sgblack@eecs.umich.edu LsbOnly, 645443Sgblack@eecs.umich.edu MsbOnly, 655443Sgblack@eecs.umich.edu TwoPhase 665443Sgblack@eecs.umich.edu }; 675443Sgblack@eecs.umich.edu 685443Sgblack@eecs.umich.edu enum ModeVal { 695443Sgblack@eecs.umich.edu InitTc, 705443Sgblack@eecs.umich.edu OneShot, 715443Sgblack@eecs.umich.edu RateGen, 725443Sgblack@eecs.umich.edu SquareWave, 735443Sgblack@eecs.umich.edu SoftwareStrobe, 745443Sgblack@eecs.umich.edu HardwareStrobe 755443Sgblack@eecs.umich.edu }; 765443Sgblack@eecs.umich.edu 775443Sgblack@eecs.umich.edu /** Counter element for PIT */ 785443Sgblack@eecs.umich.edu class Counter 795443Sgblack@eecs.umich.edu { 805443Sgblack@eecs.umich.edu /** Event for counter interrupt */ 815443Sgblack@eecs.umich.edu class CounterEvent : public Event 825443Sgblack@eecs.umich.edu { 835443Sgblack@eecs.umich.edu private: 845443Sgblack@eecs.umich.edu /** Pointer back to Counter */ 855443Sgblack@eecs.umich.edu Counter* counter; 865443Sgblack@eecs.umich.edu Tick interval; 875443Sgblack@eecs.umich.edu 885443Sgblack@eecs.umich.edu public: 895443Sgblack@eecs.umich.edu CounterEvent(Counter*); 905443Sgblack@eecs.umich.edu 915443Sgblack@eecs.umich.edu /** Event process */ 925443Sgblack@eecs.umich.edu virtual void process(); 935443Sgblack@eecs.umich.edu 945443Sgblack@eecs.umich.edu /** Event description */ 955443Sgblack@eecs.umich.edu virtual const char *description() const; 965443Sgblack@eecs.umich.edu 975443Sgblack@eecs.umich.edu friend class Counter; 985444Sgblack@eecs.umich.edu 995444Sgblack@eecs.umich.edu void setTo(int clocks); 1005443Sgblack@eecs.umich.edu }; 1015443Sgblack@eecs.umich.edu 1025443Sgblack@eecs.umich.edu private: 1035443Sgblack@eecs.umich.edu std::string _name; 1045443Sgblack@eecs.umich.edu const std::string &name() const { return _name; } 1055443Sgblack@eecs.umich.edu 1065443Sgblack@eecs.umich.edu CounterEvent event; 1075443Sgblack@eecs.umich.edu 1085443Sgblack@eecs.umich.edu /** Current count value */ 1095443Sgblack@eecs.umich.edu uint16_t count; 1105443Sgblack@eecs.umich.edu 1115443Sgblack@eecs.umich.edu /** Latched count */ 1125443Sgblack@eecs.umich.edu uint16_t latched_count; 1135443Sgblack@eecs.umich.edu 1145443Sgblack@eecs.umich.edu /** Interrupt period */ 1155443Sgblack@eecs.umich.edu uint16_t period; 1165443Sgblack@eecs.umich.edu 1175443Sgblack@eecs.umich.edu /** Current mode of operation */ 1185443Sgblack@eecs.umich.edu uint8_t mode; 1195443Sgblack@eecs.umich.edu 1205443Sgblack@eecs.umich.edu /** Output goes high when the counter reaches zero */ 1215443Sgblack@eecs.umich.edu bool output_high; 1225443Sgblack@eecs.umich.edu 1235443Sgblack@eecs.umich.edu /** State of the count latch */ 1245443Sgblack@eecs.umich.edu bool latch_on; 1255443Sgblack@eecs.umich.edu 1265443Sgblack@eecs.umich.edu /** Set of values for read_byte and write_byte */ 1275443Sgblack@eecs.umich.edu enum {LSB, MSB}; 1285443Sgblack@eecs.umich.edu 1295443Sgblack@eecs.umich.edu /** Determine which byte of a 16-bit count value to read/write */ 1305443Sgblack@eecs.umich.edu uint8_t read_byte, write_byte; 1315443Sgblack@eecs.umich.edu 1325443Sgblack@eecs.umich.edu public: 1335443Sgblack@eecs.umich.edu Counter(const std::string &name); 1345443Sgblack@eecs.umich.edu 1355443Sgblack@eecs.umich.edu /** Latch the current count (if one is not already latched) */ 1365443Sgblack@eecs.umich.edu void latchCount(); 1375443Sgblack@eecs.umich.edu 1385443Sgblack@eecs.umich.edu /** Set the read/write mode */ 1395443Sgblack@eecs.umich.edu void setRW(int rw_val); 1405443Sgblack@eecs.umich.edu 1415443Sgblack@eecs.umich.edu /** Set operational mode */ 1425443Sgblack@eecs.umich.edu void setMode(int mode_val); 1435443Sgblack@eecs.umich.edu 1445443Sgblack@eecs.umich.edu /** Set count encoding */ 1455443Sgblack@eecs.umich.edu void setBCD(int bcd_val); 1465443Sgblack@eecs.umich.edu 1475443Sgblack@eecs.umich.edu /** Read a count byte */ 1485443Sgblack@eecs.umich.edu uint8_t read(); 1495443Sgblack@eecs.umich.edu 1505443Sgblack@eecs.umich.edu /** Write a count byte */ 1515443Sgblack@eecs.umich.edu void write(const uint8_t data); 1525443Sgblack@eecs.umich.edu 1535443Sgblack@eecs.umich.edu /** Is the output high? */ 1545443Sgblack@eecs.umich.edu bool outputHigh(); 1555443Sgblack@eecs.umich.edu 1565443Sgblack@eecs.umich.edu /** 1575443Sgblack@eecs.umich.edu * Serialize this object to the given output stream. 1585443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 1595443Sgblack@eecs.umich.edu * @param os The stream to serialize to. 1605443Sgblack@eecs.umich.edu */ 1615443Sgblack@eecs.umich.edu void serialize(const std::string &base, std::ostream &os); 1625443Sgblack@eecs.umich.edu 1635443Sgblack@eecs.umich.edu /** 1645443Sgblack@eecs.umich.edu * Reconstruct the state of this object from a checkpoint. 1655443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 1665443Sgblack@eecs.umich.edu * @param cp The checkpoint use. 1675443Sgblack@eecs.umich.edu * @param section The section name of this object 1685443Sgblack@eecs.umich.edu */ 1695443Sgblack@eecs.umich.edu void unserialize(const std::string &base, Checkpoint *cp, 1705443Sgblack@eecs.umich.edu const std::string §ion); 1715443Sgblack@eecs.umich.edu }; 1725443Sgblack@eecs.umich.edu 1735443Sgblack@eecs.umich.edu private: 1745443Sgblack@eecs.umich.edu std::string _name; 1755443Sgblack@eecs.umich.edu const std::string &name() const { return _name; } 1765443Sgblack@eecs.umich.edu 1775443Sgblack@eecs.umich.edu /** PIT has three seperate counters */ 1785443Sgblack@eecs.umich.edu Counter *counter[3]; 1795443Sgblack@eecs.umich.edu 1805443Sgblack@eecs.umich.edu public: 1815443Sgblack@eecs.umich.edu /** Public way to access individual counters (avoid array accesses) */ 1825443Sgblack@eecs.umich.edu Counter counter0; 1835443Sgblack@eecs.umich.edu Counter counter1; 1845443Sgblack@eecs.umich.edu Counter counter2; 1855443Sgblack@eecs.umich.edu 1865443Sgblack@eecs.umich.edu Intel8254Timer(const std::string &name); 1875443Sgblack@eecs.umich.edu 1885443Sgblack@eecs.umich.edu /** Write control word */ 1895443Sgblack@eecs.umich.edu void writeControl(const CtrlReg data); 1905443Sgblack@eecs.umich.edu 1915443Sgblack@eecs.umich.edu /** 1925443Sgblack@eecs.umich.edu * Serialize this object to the given output stream. 1935443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 1945443Sgblack@eecs.umich.edu * @param os The stream to serialize to. 1955443Sgblack@eecs.umich.edu */ 1965443Sgblack@eecs.umich.edu void serialize(const std::string &base, std::ostream &os); 1975443Sgblack@eecs.umich.edu 1985443Sgblack@eecs.umich.edu /** 1995443Sgblack@eecs.umich.edu * Reconstruct the state of this object from a checkpoint. 2005443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 2015443Sgblack@eecs.umich.edu * @param cp The checkpoint use. 2025443Sgblack@eecs.umich.edu * @param section The section name of this object 2035443Sgblack@eecs.umich.edu */ 2045443Sgblack@eecs.umich.edu void unserialize(const std::string &base, Checkpoint *cp, 2055443Sgblack@eecs.umich.edu const std::string §ion); 2065443Sgblack@eecs.umich.edu}; 2075443Sgblack@eecs.umich.edu 2085443Sgblack@eecs.umich.edu#endif // __DEV_8254_HH__ 209