rb8515_clock.h

/*
 * rb8515_clock.h - clock for delay module (RB8515).
 *
 * This file is part of the Rulbus Device Class Library (RDCL).
 *
 * Copyright (C) 2003-2004, Leiden University.
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with mngdriver; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * $Id: rb8515_clock.h 2 2004-10-12 11:54:15Z moene $
 */

#ifndef __RB8515_CLOCK_H
#define __RB8515_CLOCK_H

#ifndef __RULBUSDEVICE_H
#include "RulbusDevice.h"       // for class RulbusDevice
#endif

namespace Rulbus
{
   DECLARE_CLASS( RB8515_clock );       // the clock for delay class type

   class RB8515_clock: public RulbusDevice
   {
   public:

      RB8515_clock( NameCref name, Addr addr = DEF_ADDR, Rack rack = DEF_RACK );

      ~RB8515_clock();


      Freq   clockFrequency      () const;
      Freq   interruptFrequency  () const;

      bool   isPendingInterrupt  () ;     // clears pending interrupt
      bool   isEnabledInterrupt  () const;


      void   setClockFrequency      ( Freq aFrequency );
      void   setInterruptFrequency  ( Freq aFrequency );

      void   clearInterrupt         ();

      bool   disableInterrupt       ();
      bool   enableInterrupt        ( bool enable = true );


   protected:                                           // protected methods

      RB8515_clock();                                   
      RB8515_clock( RB8515_clockCref rhs );             
      RB8515_clockRef operator= ( RB8515_clockCref rhs ); 


   private:                                             // private data

      Byte   theCtlByte;                                


      enum // ClockFreq
      {
        FC_INVALID = -1,        
        FC_0Hz = 0,             
        FC_100Hz,               
        FC_1kHz,                
        FC_10kHz,               
        FC_100kHz,              
        FC_1MHz,                
        FC_10MHz,               
        FC_100MHz,              
      };


      enum // IntFreq
      {
         FI_INVALID = -1,       
         FI_0Hz = 0,            
         FI_1Hz,                
         FI_5kHz,               
         FI_10Hz,               
         FI_50Hz,               
         FI_100Hz,              
         FI_500Hz,              
         FI_1kHz,               
      };


      static const int  OFF_CR      = 0;                
      static const int  OFF_SR      = 0;                
      static const int  ADR_WIDTH   = OFF_SR + 1;       


      static const int  MSK_CLKFRQ  = 0x07;             
      static const int  MSK_INTFRQ  = 0x38;             
      static const int  MSK_INTENA  = 0x40;             
      static const int  MSK_INTCLRn = 0x80;             
      static const int  MSK_INTSTS  = 0x80;             

      static const int  SHL_CLKFRQ  = 0x00;             
      static const int  SHL_INTFRQ  = 0x03;             


      static const Addr DEF_ADDR = 0xC8;                
      static const Freq DEF_CLKFRQ /* = 1e3 */ ;        
      static const Freq DEF_INTFRQ /* = 0e0 */ ;        


      struct FreqTable
      {
         Freq freq;                                     
         Int  code;                                     
      };

      static FreqTable   clkTable[];
      static FreqTable   intTable[];


   protected:                                           // protected methods
      void   getClkFreqCode( Freq aFrequency, IntPtr pCode ) const;
      void   getIntFreqCode( Freq aFrequency, IntPtr pCode ) const;
      void   getFreqCode   ( Freq aFrequency, const FreqTable *tablePtr, IntPtr pCode ) const;
   };


   inline RB8515_clockRef to_rb8515( RulbusDevicePtr p )
   {
      return PROXY_CAST<RB8515_clockRef>( *p );
   }

   inline RB8515_clockPtr to_rb8515_ptr( RulbusDevicePtr p )
   {
      return PROXY_CAST<RB8515_clockPtr>( p );
   }

} // namespace Rulbus

#endif // __RB8515_CLOCK_H

/*
 * end of file
 */

---