/* * ***************************************************************************** * Copyright (C) 2014-2024 Dennis Sheirer * * This program 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 3 of the License, or * (at your option) any later version. * * This 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 program. If not, see * **************************************************************************** */ package io.github.dsheirer.edac; import io.github.dsheirer.bits.BinaryMessage; import io.github.dsheirer.bits.CorrectedBinaryMessage; /** * Implements Hamming(13,9,3) Error Detection algorithm */ public class Hamming13 { //DMR Checksums from generator matrix TS 102 361-1 Table B.14 private static int[] CHECKSUMS = new int[]{0xF, 0xE, 0x7, 0xA, 0x5, 0xB, 0xC, 0x6, 0x3, 0x8, 0x4, 0x2, 0x1}; private static int[] ERROR_INDEX = new int[]{-1, 12, 11, 8, 10, 4, 7, 2, 9, -1, 3, 5, 6, -1, 1, 0, -1, -1}; /** * Calculates the bit error index of the Hamming(13,9,3) protected word that is contained in the binary message * starting at the specified offset. * * @param message containing a Hamming protected word * @param offset to the start of the protected word * @return message index for an error bit, -1 if no errors are detected, or 1000 if more than one bit error is * detected. */ public static int getErrorIndex(BinaryMessage message, int offset) { int syndrome = getSyndrome(message, offset); if(syndrome > 0) { int errorIndex = ERROR_INDEX[syndrome]; return errorIndex >= 0 ? offset + errorIndex : IHamming.MULTIPLE_ERRORS; } return IHamming.NO_ERRORS; } /** * Calculates the bit error index of the Hamming(13,9,3) protected word that is contained in the binary message * at the specified indices. * * @param message containing the Hamming protected word * @param indices to the word * @return index of error bit or -1 if no errors are detected */ public static int getErrorIndex(BinaryMessage message, int[] indices) { int syndrome = getSyndrome(message, indices); if(syndrome > 0) { int errorIndex = ERROR_INDEX[syndrome]; if(errorIndex >= 0 && errorIndex < indices.length) { return indices[errorIndex]; } else { return 1000; } } return IHamming.NO_ERRORS; } /** * Calculates the parity checksum (Parity 8,4,2,1) for data (9 <> 1 ) bits. * * @param message containing Hamming(15) protected word * @param offset to the Hamming protected word * @return parity value, 0 - 15 */ private static int calculateChecksum(BinaryMessage message, int offset) { int calculated = 0; //Starting value /* Iterate the set bits and XOR running checksum with lookup value */ for(int i = message.nextSetBit(offset); i >= offset && i < offset + 9; i = message.nextSetBit(i + 1)) { calculated ^= CHECKSUMS[i - offset]; } return calculated; } private static int calculateChecksum(BinaryMessage message, int[] indices) { int calculated = 0; //Starting value for(int x = 0; x < 9; x++) { if(message.get(indices[x])) { calculated ^= CHECKSUMS[x]; } } return calculated; } public static int getSyndrome(BinaryMessage message, int[] indices) { int calculated = calculateChecksum(message, indices); int checksum = 0; for(int x = 9; x < 13; x++) { checksum = Integer.rotateLeft(checksum, 1); if(message.get(indices[x])) { checksum++; } } return calculated ^ checksum; } /** * Calculates the syndrome as the xor of the calculated checksum and the actual checksum. * * @param message containing a hamming(15,11,3) protected word * @param offset to bit 0 of the hamming protected word * @return syndrome that can be used with the ERROR_INDEX error to find the index of the bit position error */ private static int getSyndrome(BinaryMessage message, int offset) { int calculated = calculateChecksum(message, offset); int checksum = message.getInt(offset + 9, offset + 12); return (checksum ^ calculated); } public static void main(String[] args) { String transmitted = "0000010000001"; String correct = "0000000000000"; String recommended = "0001000000001"; // CorrectedBinaryMessage cbm = new CorrectedBinaryMessage(CorrectedBinaryMessage.load(transmitted)); CorrectedBinaryMessage cbm = new CorrectedBinaryMessage(CorrectedBinaryMessage.load(correct)); // CorrectedBinaryMessage cbm = new CorrectedBinaryMessage(CorrectedBinaryMessage.load(recommended)); int syndrome = getSyndrome(cbm, 0); System.out.println("Syndrome " + syndrome); } }