/* SPDX-License-Identifier: LGPL-2.1-only OR BSD-3-Clause */
/******************************************************************************
 *
 * This file is provided under a dual license.  When you use or
 * distribute this software, you may choose to be licensed under
 * version 2.1 of the GNU Lesser General Public License
 * ("LGPLv2.1 License") or BSD License.
 *
 * LGPLv2.1 License
 *
 * Copyright(C) 2019 MediaTek Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2.1 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * 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 https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html for more
 * details.
 *
 * BSD LICENSE
 *
 * Copyright(C) 2019 MediaTek Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/

/*-----------------------------------------------------------------------------
 * $RCSfile: x_hamming_code.h,v $
 * $Revision: #1 $
 * $Date: 2015/05/29 $
 * $Author: brianpc.huang $
 *
 * Description: 
 *         This header file contains sorting and searching function API for
 *         the applications.
 *         
 *---------------------------------------------------------------------------*/

#ifndef _X_HAMMING_CODE_H
#define _X_HAMMING_CODE_H

/*---------------------------------------------------------------------------
                    include files
----------------------------------------------------------------------------*/

#include "u_common.h"

/*-------------------------------------------------------------------------
                    functions declarations
 --------------------------------------------------------------------------*/
typedef enum _CDSTATUS
{
    CD_SUCCESS = 0,
    CD_FAIL
} CDSTATUS; 

/*
    Invert / Reverse 
*/
extern const UINT8 g_aui1_rev_bit_order_tbl[];
extern const UINT8 g_aui1_inv_rev_bit_order_tbl[];

#define x_rev_bit_order(ui1_data) g_aui1_rev_bit_order_tbl[(ui1_data)]
#define x_inv_rev_bit_order(ui1_data) g_aui1_inv_rev_bit_order_tbl[(ui1_data)]

/*
    ODD parity Decoding
*/
#define ODD_PARITY_DECODE_ERROR         0x80

extern const UINT8 g_aui1_msb_odd_parity_tbl[];
extern const UINT8 g_aui1_lsb_odd_parity_tbl[];
extern const UINT8 g_aui1_inv_msb_odd_parity_tbl[];
extern const UINT8 g_aui1_inv_lsb_odd_parity_tbl[];

#define x_msb_odd_parity_check(ui1_data) g_aui1_msb_odd_parity_tbl[(ui1_data)] 
#define x_lsb_odd_parity_check(ui1_data) g_aui1_lsb_odd_parity_tbl[(ui1_data)] 
#define x_inv_msb_odd_parity_check(ui1_data) g_aui1_inv_msb_odd_parity_tbl[(ui1_data)] 
#define x_inv_lsb_odd_parity_check(ui1_data) g_aui1_inv_lsb_odd_parity_tbl[(ui1_data)] 

/*
    Hamming 8/4 Decoding 
*/
#define HAMMING_84_DECODE_ERROR         0x80

extern const UINT8 g_aui1_msb_hamming_84_tbl[];
extern const UINT8 g_aui1_lsb_hamming_84_tbl[];
extern const UINT8 g_aui1_inv_msb_hamming_84_tbl[];
extern const UINT8 g_aui1_inv_lsb_hamming_84_tbl[];

#define x_msb_hamming_84_decoding(ui1_data) g_aui1_msb_hamming_84_tbl[(ui1_data)]
#define x_lsb_hamming_84_decoding(ui1_data) g_aui1_lsb_hamming_84_tbl[(ui1_data)]
#define x_inv_msb_hamming_84_decoding(ui1_data) g_aui1_inv_msb_hamming_84_tbl[(ui1_data)]
#define x_inv_lsb_hamming_84_decoding(ui1_data) g_aui1_inv_lsb_hamming_84_tbl[(ui1_data)]


extern const UINT8 g_aui1_msb_hamming_84_ner_tbl[];
extern const UINT8 g_aui1_lsb_hamming_84_ner_tbl[];
extern const UINT8 g_aui1_inv_msb_hamming_84_ner_tbl[];
extern const UINT8 g_aui1_inv_lsb_hamming_84_ner_tbl[];

#define x_msb_hamming_84_ner_decoding(ui1_data) g_aui1_msb_hamming_84_ner_tbl[(ui1_data)]
#define x_lsb_hamming_84_ner_decoding(ui1_data) g_aui1_lsb_hamming_84_ner_tbl[(ui1_data)]
#define x_inv_msb_hamming_84_ner_decoding(ui1_data) g_aui1_inv_msb_hamming_84_ner_tbl[(ui1_data)]
#define x_inv_lsb_hamming_84_ner_decoding(ui1_data) g_aui1_inv_lsb_hamming_84_ner_tbl[(ui1_data)]


/*
    Hamming 24/18 Decoding 
*/
#define HAMMING_2418_DECODE_ERROR        0x80


CDSTATUS x_msb_hamming_2418_decoding_fmt1(UINT8* pui1_src, UINT8* pui1_des);
CDSTATUS x_lsb_hamming_2418_decoding_fmt1(UINT8* pui1_src, UINT8* pui1_des);
CDSTATUS x_inv_msb_hamming_2418_decoding_fmt1(UINT8* pui1_src, UINT8* pui1_des);
CDSTATUS x_inv_lsb_hamming_2418_decoding_fmt1(UINT8* pui1_src, UINT8* pui1_des);




#endif /* _X_HAMMING_CODE_H */
