Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / sam / cpus / vonk / bl / lib / ecc / src / BL_Hamming_22_6_Synd.h

/*
* ========== Copyright Header Begin ==========================================
* 
* OpenSPARC T2 Processor File: BL_Hamming_22_6_Synd.h
* Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES.
* 
* The above named program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public
* License version 2 as published by the Free Software Foundation.
* 
* The above named program 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 this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
* 
* ========== Copyright Header End ============================================
*/
/************************************************************************
**  
**  Copyright (C) 2006, Sun Microsystems, Inc.
**
**  Sun considers its source code as an unpublished, proprietary
**  trade secret and it is available only under strict license provisions.
**  This copyright notice is placed here only to protect Sun in the event 
**  the source is deemed a published work. Disassembly, decompilation,
**  or other means of reducing the object code to human readable form
**  is prohibited by the license agreement under which this code is
**  provided to the user or company in possession of this copy.
**
*************************************************************************/
#ifndef __BL_Hamming_22_6_Synd_h__
#define __BL_Hamming_22_6_Synd_h__
#include "BL_BaseSynd.h"
#include "BL_HammingEcc.h"

class BL_Hamming_22_6_Synd : public BL_BaseSynd
{
 public:       

   BL_Hamming_22_6_Synd(uint32_t syndrome) : BL_BaseSynd(syndrome) 
   {
     if (syndrome > 0x3f)
     {
       fprintf(stderr,"ERROR: Bad Syndrome!");
       exit(-1);             
     }
   }

   BL_Hamming_22_6_Synd(uint32_t data, BL_EccBits ecc) :
     BL_BaseSynd(BL_HammingEcc::
                 get_hamming_22_6_synd(data,ecc.get()).getSyndrome())
   {}

   ~BL_Hamming_22_6_Synd() {}

   bool isDoubleBitError() const { return (syndrome_ - 1) < 0x1f; }

   bool isSingleBitError() const { return (syndrome_ - 0x20) < 0x1e; }

   bool isDataBitError() const 
   { 
     return (isSingleBitError() && ((syndrome_ - 0x20) & syndrome_ - 0x21));
   }

   uint32_t getDataBit() const 
   {
     if (!isDataBitError())
     {
       fprintf(stderr,"ERROR: Not data bit error!");
       exit(-1);             
     }       
       
     uint32_t bit = syndrome_ - 0x20;
     if (bit >= 0x10)
       return bit - 6;
     else if (bit > 8)
       return bit - 5;
     else if (bit > 4)
       return bit - 4;
     else 
       return bit - 3;
   }

   bool isCheckBitError() const 
   {
     return (isSingleBitError() && !((syndrome_ - 0x20) & syndrome_ - 0x21));
   }
   
   uint32_t getCheckBit() const 
   {
     if (!isCheckBitError())
     {
       fprintf(stderr,"ERROR: Not check bit error!");
       exit(-1);             
     }         
       
     uint32_t bit = syndrome_ - 0x20;
     if (bit >= 0x10)
       return 4;
     else if (bit == 8)
       return 3;
     else if (bit == 4)
       return 2;
     else 
       return (bit == 0) ? 5 : bit - 1;
     return 0;
   }

   bool isMultipleBitError() const 
   { 
     return false;
   }

   static BL_EccBits calc_check_bits(unsigned long long data)
   {
     return BL_HammingEcc::calc_check_bits(BL_HammingEcc::BL_Hamming_22_6, data);
   }

   private:

     BL_Hamming_22_6_Synd();
};

#endif