[mirror_ubuntu-artful-kernel.git] / include / linux / platform_data / elm.h

/*
 * BCH Error Location Module
 *
 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
 *
 * 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 2 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.
 *
 */

#ifndef __ELM_H
#define __ELM_H

enum bch_ecc {
	BCH4_ECC = 0,
	BCH8_ECC,
};

/* ELM support 8 error syndrome process */
#define ERROR_VECTOR_MAX		8

#define BCH8_ECC_OOB_BYTES		13
#define BCH4_ECC_OOB_BYTES		7
/* RBL requires 14 byte even though BCH8 uses only 13 byte */
#define BCH8_SIZE			(BCH8_ECC_OOB_BYTES + 1)
#define BCH4_SIZE			(BCH4_ECC_OOB_BYTES)

/**
 * struct elm_errorvec - error vector for elm
 * @error_reported:		set true for vectors error is reported
 * @error_uncorrectable:	number of uncorrectable errors
 * @error_count:		number of correctable errors in the sector
 * @error_loc:			buffer for error location
 *
 */
struct elm_errorvec {
	bool error_reported;
	bool error_uncorrectable;
	int error_count;
	int error_loc[ERROR_VECTOR_MAX];
};

void elm_decode_bch_error_page(struct device *dev, u8 *ecc_calc,
		struct elm_errorvec *err_vec);
void elm_config(struct device *dev, enum bch_ecc bch_type);
#endif /* __ELM_H */
Commit	Line	Data
bf224335 PA	1	/*
	2	* BCH Error Location Module
	3	*
	4	* Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	*/
	17
	18	#ifndef __ELM_H
	19	#define __ELM_H
	20
	21	enum bch_ecc {
	22	BCH4_ECC = 0,
	23	BCH8_ECC,
	24	};
	25
	26	/* ELM support 8 error syndrome process */
	27	#define ERROR_VECTOR_MAX 8
	28
	29	#define BCH8_ECC_OOB_BYTES 13
	30	#define BCH4_ECC_OOB_BYTES 7
	31	/* RBL requires 14 byte even though BCH8 uses only 13 byte */
	32	#define BCH8_SIZE (BCH8_ECC_OOB_BYTES + 1)
	33	#define BCH4_SIZE (BCH4_ECC_OOB_BYTES)
	34
	35	/**
	36	* struct elm_errorvec - error vector for elm
	37	* @error_reported: set true for vectors error is reported
	38	* @error_uncorrectable: number of uncorrectable errors
	39	* @error_count: number of correctable errors in the sector
	40	* @error_loc: buffer for error location
	41	*
	42	*/
	43	struct elm_errorvec {
	44	bool error_reported;
	45	bool error_uncorrectable;
	46	int error_count;
	47	int error_loc[ERROR_VECTOR_MAX];
	48	};
	49
	50	void elm_decode_bch_error_page(struct device dev, u8 ecc_calc,
	51	struct elm_errorvec *err_vec);
	52	void elm_config(struct device *dev, enum bch_ecc bch_type);
	53	#endif /* __ELM_H */