[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,
	BCH16_ECC,
};

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

/**
 * 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[16];
};

#if IS_ENABLED(CONFIG_MTD_NAND_OMAP_BCH)
void elm_decode_bch_error_page(struct device *dev, u8 *ecc_calc,
		struct elm_errorvec *err_vec);
int elm_config(struct device *dev, enum bch_ecc bch_type,
	int ecc_steps, int ecc_step_size, int ecc_syndrome_size);
#else
static inline void
elm_decode_bch_error_page(struct device *dev, u8 *ecc_calc,
			  struct elm_errorvec *err_vec)
{
}

static inline int elm_config(struct device *dev, enum bch_ecc bch_type,
			     int ecc_steps, int ecc_step_size,
			     int ecc_syndrome_size)
{
	return -ENOSYS;
}
#endif /* CONFIG_MTD_NAND_ECC_BCH */

#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,
2be589e4	24	BCH16_ECC,
bf224335 PA	25	};
	26
	27	/* ELM support 8 error syndrome process */
	28	#define ERROR_VECTOR_MAX 8
	29
bf224335 PA	30	/**
	31	* struct elm_errorvec - error vector for elm
	32	* @error_reported: set true for vectors error is reported
	33	* @error_uncorrectable: number of uncorrectable errors
	34	* @error_count: number of correctable errors in the sector
	35	* @error_loc: buffer for error location
	36	*
	37	*/
	38	struct elm_errorvec {
	39	bool error_reported;
	40	bool error_uncorrectable;
	41	int error_count;
2be589e4	42	int error_loc[16];
bf224335 PA	43	};
bf224335 PA	44
93af53b8	45	#if IS_ENABLED(CONFIG_MTD_NAND_OMAP_BCH)
bf224335 PA	46	void elm_decode_bch_error_page(struct device dev, u8 ecc_calc,
bf224335 PA	47	struct elm_errorvec *err_vec);
3f4eb14b PG	48	int elm_config(struct device *dev, enum bch_ecc bch_type,
3f4eb14b PG	49	int ecc_steps, int ecc_step_size, int ecc_syndrome_size);
93af53b8 EG	50	#else
	51	static inline void
	52	elm_decode_bch_error_page(struct device dev, u8 ecc_calc,
	53	struct elm_errorvec *err_vec)
	54	{
	55	}
	56
	57	static inline int elm_config(struct device *dev, enum bch_ecc bch_type,
	58	int ecc_steps, int ecc_step_size,
	59	int ecc_syndrome_size)
	60	{
	61	return -ENOSYS;
	62	}
	63	#endif /* CONFIG_MTD_NAND_ECC_BCH */
	64
bf224335	65	#endif /* __ELM_H */