[people/ms/u-boot.git] / include / dfu.h

/*
 * dfu.h - DFU flashable area description
 *
 * Copyright (C) 2012 Samsung Electronics
 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
 *	    Lukasz Majewski <l.majewski@samsung.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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __DFU_ENTITY_H_
#define __DFU_ENTITY_H_

#include <common.h>
#include <linux/list.h>
#include <mmc.h>

enum dfu_device_type {
	DFU_DEV_MMC = 1,
	DFU_DEV_ONENAND,
	DFU_DEV_NAND,
};

enum dfu_layout {
	DFU_RAW_ADDR = 1,
	DFU_FS_FAT,
	DFU_FS_EXT2,
	DFU_FS_EXT3,
	DFU_FS_EXT4,
};

struct mmc_internal_data {
	/* RAW programming */
	unsigned int lba_start;
	unsigned int lba_size;
	unsigned int lba_blk_size;

	/* FAT/EXT */
	unsigned int dev;
	unsigned int part;
};

struct nand_internal_data {
	/* RAW programming */
	u64 start;
	u64 size;

	unsigned int dev;
	unsigned int part;
};

static inline unsigned int get_mmc_blk_size(int dev)
{
	return find_mmc_device(dev)->read_bl_len;
}

#define DFU_NAME_SIZE			32
#define DFU_CMD_BUF_SIZE		128
#define DFU_DATA_BUF_SIZE		(1024*1024*8)	/* 8 MiB */
#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
#define CONFIG_SYS_DFU_MAX_FILE_SIZE	(4 << 20)	/* 4 MiB */
#endif

struct dfu_entity {
	char			name[DFU_NAME_SIZE];
	int                     alt;
	void                    *dev_private;
	int                     dev_num;
	enum dfu_device_type    dev_type;
	enum dfu_layout         layout;

	union {
		struct mmc_internal_data mmc;
		struct nand_internal_data nand;
	} data;

	int (*read_medium)(struct dfu_entity *dfu,
			u64 offset, void *buf, long *len);

	int (*write_medium)(struct dfu_entity *dfu,
			u64 offset, void *buf, long *len);

	int (*flush_medium)(struct dfu_entity *dfu);

	struct list_head list;

	/* on the fly state */
	u32 crc;
	u64 offset;
	int i_blk_seq_num;
	u8 *i_buf;
	u8 *i_buf_start;
	u8 *i_buf_end;
	long r_left;
	long b_left;

	u32 bad_skip;	/* for nand use */

	unsigned int inited:1;
};

int dfu_config_entities(char *s, char *interface, int num);
void dfu_free_entities(void);
void dfu_show_entities(void);
int dfu_get_alt_number(void);
const char *dfu_get_dev_type(enum dfu_device_type t);
const char *dfu_get_layout(enum dfu_layout l);
struct dfu_entity *dfu_get_entity(int alt);
char *dfu_extract_token(char** e, int *n);

int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
/* Device specific */
#ifdef CONFIG_DFU_MMC
extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s);
#else
static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s)
{
	puts("MMC support not available!\n");
	return -1;
}
#endif

#ifdef CONFIG_DFU_NAND
extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s);
#else
static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s)
{
	puts("NAND support not available!\n");
	return -1;
}
#endif

#endif /* __DFU_ENTITY_H_ */
Commit	Line	Data
f22b11c1 ŁM	1	/*
	2	* dfu.h - DFU flashable area description
	3	*
	4	* Copyright (C) 2012 Samsung Electronics
	5	* authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
	6	* Lukasz Majewski <l.majewski@samsung.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	21	*/
	22
	23	#ifndef __DFU_ENTITY_H_
	24	#define __DFU_ENTITY_H_
	25
	26	#include <common.h>
	27	#include <linux/list.h>
	28	#include <mmc.h>
	29
	30	enum dfu_device_type {
	31	DFU_DEV_MMC = 1,
	32	DFU_DEV_ONENAND,
	33	DFU_DEV_NAND,
	34	};
	35
	36	enum dfu_layout {
	37	DFU_RAW_ADDR = 1,
	38	DFU_FS_FAT,
	39	DFU_FS_EXT2,
	40	DFU_FS_EXT3,
	41	DFU_FS_EXT4,
	42	};
	43
	44	struct mmc_internal_data {
	45	/* RAW programming */
	46	unsigned int lba_start;
	47	unsigned int lba_size;
	48	unsigned int lba_blk_size;
	49
	50	/* FAT/EXT */
	51	unsigned int dev;
	52	unsigned int part;
	53	};
	54
c6631764 PA	55	struct nand_internal_data {
	56	/* RAW programming */
	57	u64 start;
	58	u64 size;
	59
	60	unsigned int dev;
	61	unsigned int part;
	62	};
	63
f22b11c1 ŁM	64	static inline unsigned int get_mmc_blk_size(int dev)
	65	{
	66	return find_mmc_device(dev)->read_bl_len;
	67	}
	68
a24c3155 TR	69	#define DFU_NAME_SIZE 32
	70	#define DFU_CMD_BUF_SIZE 128
	71	#define DFU_DATA_BUF_SIZE (102410248) /* 8 MiB */
ea2453d5 PA	72	#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
	73	#define CONFIG_SYS_DFU_MAX_FILE_SIZE (4 << 20) /* 4 MiB */
	74	#endif
f22b11c1 ŁM	75
	76	struct dfu_entity {
	77	char name[DFU_NAME_SIZE];
	78	int alt;
	79	void *dev_private;
	80	int dev_num;
	81	enum dfu_device_type dev_type;
	82	enum dfu_layout layout;
	83
	84	union {
	85	struct mmc_internal_data mmc;
c6631764	86	struct nand_internal_data nand;
f22b11c1 ŁM	87	} data;
f22b11c1 ŁM	88
ea2453d5 PA	89	int (read_medium)(struct dfu_entity dfu,
	90	u64 offset, void buf, long len);
	91
	92	int (write_medium)(struct dfu_entity dfu,
	93	u64 offset, void buf, long len);
	94
	95	int (flush_medium)(struct dfu_entity dfu);
f22b11c1 ŁM	96
f22b11c1 ŁM	97	struct list_head list;
ea2453d5 PA	98
	99	/* on the fly state */
	100	u32 crc;
	101	u64 offset;
	102	int i_blk_seq_num;
	103	u8 *i_buf;
	104	u8 *i_buf_start;
	105	u8 *i_buf_end;
	106	long r_left;
	107	long b_left;
	108
c6631764 PA	109	u32 bad_skip; /* for nand use */
c6631764 PA	110
ea2453d5	111	unsigned int inited:1;
f22b11c1 ŁM	112	};
	113
	114	int dfu_config_entities(char s, char interface, int num);
	115	void dfu_free_entities(void);
	116	void dfu_show_entities(void);
	117	int dfu_get_alt_number(void);
	118	const char *dfu_get_dev_type(enum dfu_device_type t);
	119	const char *dfu_get_layout(enum dfu_layout l);
	120	struct dfu_entity *dfu_get_entity(int alt);
	121	char dfu_extract_token(char* e, int *n);
	122
	123	int dfu_read(struct dfu_entity de, void buf, int size, int blk_seq_num);
	124	int dfu_write(struct dfu_entity de, void buf, int size, int blk_seq_num);
	125	/* Device specific */
	126	#ifdef CONFIG_DFU_MMC
	127	extern int dfu_fill_entity_mmc(struct dfu_entity dfu, char s);
	128	#else
	129	static inline int dfu_fill_entity_mmc(struct dfu_entity dfu, char s)
	130	{
	131	puts("MMC support not available!\n");
	132	return -1;
	133	}
	134	#endif
c6631764 PA	135
	136	#ifdef CONFIG_DFU_NAND
	137	extern int dfu_fill_entity_nand(struct dfu_entity dfu, char s);
	138	#else
	139	static inline int dfu_fill_entity_nand(struct dfu_entity dfu, char s)
	140	{
	141	puts("NAND support not available!\n");
	142	return -1;
	143	}
	144	#endif
	145
f22b11c1	146	#endif /* __DFU_ENTITY_H_ */