Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / sam / cpus / vonk / bl / lib / ecc / src / BL_HammingEcc.h
CommitLineData
920dae64
AT
1/*
2* ========== Copyright Header Begin ==========================================
3*
4* OpenSPARC T2 Processor File: BL_HammingEcc.h
5* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
6* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES.
7*
8* The above named program is free software; you can redistribute it and/or
9* modify it under the terms of the GNU General Public
10* License version 2 as published by the Free Software Foundation.
11*
12* The above named program is distributed in the hope that it will be
13* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
14* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15* General Public License for more details.
16*
17* You should have received a copy of the GNU General Public
18* License along with this work; if not, write to the Free Software
19* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
20*
21* ========== Copyright Header End ============================================
22*/
23/************************************************************************
24**
25** Copyright (C) 2006, Sun Microsystems, Inc.
26**
27** Sun considers its source code as an unpublished, proprietary
28** trade secret and it is available only under strict license provisions.
29** This copyright notice is placed here only to protect Sun in the event
30** the source is deemed a published work. Disassembly, decompilation,
31** or other means of reducing the object code to human readable form
32** is prohibited by the license agreement under which this code is
33** provided to the user or company in possession of this copy.
34**
35*************************************************************************/
36#ifndef __BL_HammingEcc_h__
37#define __BL_HammingEcc_h__
38#include "BL_BitUtility.h"
39#include "BL_BaseEcc.h"
40#include <unistd.h>
41
42class BL_HammingEcc
43{
44 public:
45
46 friend class BL_Hamming_22_6_Synd;
47 friend class BL_Hamming_32_7_Synd;
48 friend class BL_Hamming_64_8_Synd;
49
50 BL_HammingEcc() {}
51
52 ~BL_HammingEcc() {}
53
54 protected:
55
56 static BL_Hamming_22_6_Synd get_hamming_22_6_synd(uint32_t data,
57 uint32_t stored_ecc_val);
58
59 static BL_Hamming_32_7_Synd get_hamming_32_7_synd(uint32_t data,
60 uint32_t stored_ecc_val);
61
62 static BL_Hamming_64_8_Synd get_hamming_64_8_synd(uint64_t data,
63 uint64_t stored_ecc_val);
64
65 typedef enum {
66 BL_Hamming_22_6,
67 BL_Hamming_32_7,
68 BL_Hamming_64_8
69 } BL_HammingEccTypes;
70
71 static BL_EccBits calc_check_bits(BL_HammingEccTypes type,
72 uint64_t data);
73
74 static uint64_t hamming_22_6_ecc_masks[];
75 static uint64_t hamming_32_7_ecc_masks[];
76 static uint64_t hamming_64_8_ecc_masks[];
77};
78
79#endif