[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>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef __DFU_ENTITY_H_
#define __DFU_ENTITY_H_

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

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

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

enum dfu_op {
	DFU_OP_READ = 1,
	DFU_OP_WRITE,
};

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

	/* eMMC HW partition access */
	int hw_partition;

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

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

	unsigned int dev;
	unsigned int part;
	/* for nand/ubi use */
	unsigned int ubi;
};

struct ram_internal_data {
	void		*start;
	unsigned int	size;
};

#define DFU_NAME_SIZE			32
#define DFU_CMD_BUF_SIZE		128
#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
#define CONFIG_SYS_DFU_DATA_BUF_SIZE		(1024*1024*8)	/* 8 MiB */
#endif
#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
#endif
#ifndef DFU_DEFAULT_POLL_TIMEOUT
#define DFU_DEFAULT_POLL_TIMEOUT 0
#endif
#ifndef DFU_MANIFEST_POLL_TIMEOUT
#define DFU_MANIFEST_POLL_TIMEOUT	DFU_DEFAULT_POLL_TIMEOUT
#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;
		struct ram_internal_data ram;
	} 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);
	unsigned int (*poll_timeout)(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);
void dfu_trigger_reset(void);
int dfu_get_alt(char *name);
bool dfu_reset(void);
int dfu_init_env_entities(char *interface, int dev);
unsigned char *dfu_get_buf(void);
unsigned char *dfu_free_buf(void);
unsigned long dfu_get_buf_size(void);

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);
int dfu_flush(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

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

int dfu_add(struct usb_configuration *c);
#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	*
1a459660	8	* SPDX-License-Identifier: GPL-2.0+
f22b11c1 ŁM	9	*/
	10
	11	#ifndef __DFU_ENTITY_H_
	12	#define __DFU_ENTITY_H_
	13
	14	#include <common.h>
	15	#include <linux/list.h>
	16	#include <mmc.h>
a6921adc	17	#include <linux/usb/composite.h>
f22b11c1 ŁM	18
	19	enum dfu_device_type {
	20	DFU_DEV_MMC = 1,
	21	DFU_DEV_ONENAND,
	22	DFU_DEV_NAND,
a9479f04	23	DFU_DEV_RAM,
f22b11c1 ŁM	24	};
	25
	26	enum dfu_layout {
	27	DFU_RAW_ADDR = 1,
	28	DFU_FS_FAT,
	29	DFU_FS_EXT2,
	30	DFU_FS_EXT3,
	31	DFU_FS_EXT4,
a9479f04	32	DFU_RAM_ADDR,
f22b11c1 ŁM	33	};
f22b11c1 ŁM	34
5a127c84 AM	35	enum dfu_op {
	36	DFU_OP_READ = 1,
	37	DFU_OP_WRITE,
	38	};
	39
f22b11c1 ŁM	40	struct mmc_internal_data {
	41	/* RAW programming */
	42	unsigned int lba_start;
	43	unsigned int lba_size;
	44	unsigned int lba_blk_size;
	45
c8151b4a ŁM	46	/* eMMC HW partition access */
	47	int hw_partition;
	48
f22b11c1 ŁM	49	/* FAT/EXT */
	50	unsigned int dev;
	51	unsigned int part;
	52	};
	53
c6631764 PA	54	struct nand_internal_data {
	55	/* RAW programming */
	56	u64 start;
	57	u64 size;
	58
	59	unsigned int dev;
	60	unsigned int part;
815c30b2 HS	61	/* for nand/ubi use */
815c30b2 HS	62	unsigned int ubi;
c6631764 PA	63	};
c6631764 PA	64
a9479f04 AM	65	struct ram_internal_data {
	66	void *start;
	67	unsigned int size;
	68	};
	69
a24c3155 TR	70	#define DFU_NAME_SIZE 32
a24c3155 TR	71	#define DFU_CMD_BUF_SIZE 128
e7e75c70 HS	72	#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
	73	#define CONFIG_SYS_DFU_DATA_BUF_SIZE (102410248) /* 8 MiB */
	74	#endif
ea2453d5	75	#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
7a813d5b	76	#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
ea2453d5	77	#endif
33fac4a6 ŁM	78	#ifndef DFU_DEFAULT_POLL_TIMEOUT
	79	#define DFU_DEFAULT_POLL_TIMEOUT 0
	80	#endif
001a8319 HS	81	#ifndef DFU_MANIFEST_POLL_TIMEOUT
	82	#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
	83	#endif
f22b11c1 ŁM	84
	85	struct dfu_entity {
	86	char name[DFU_NAME_SIZE];
	87	int alt;
	88	void *dev_private;
	89	int dev_num;
	90	enum dfu_device_type dev_type;
	91	enum dfu_layout layout;
	92
	93	union {
	94	struct mmc_internal_data mmc;
c6631764	95	struct nand_internal_data nand;
a9479f04	96	struct ram_internal_data ram;
f22b11c1 ŁM	97	} data;
f22b11c1 ŁM	98
ea2453d5 PA	99	int (read_medium)(struct dfu_entity dfu,
	100	u64 offset, void buf, long len);
	101
	102	int (write_medium)(struct dfu_entity dfu,
	103	u64 offset, void buf, long len);
	104
	105	int (flush_medium)(struct dfu_entity dfu);
fc25fa27	106	unsigned int (poll_timeout)(struct dfu_entity dfu);
f22b11c1 ŁM	107
f22b11c1 ŁM	108	struct list_head list;
ea2453d5 PA	109
	110	/* on the fly state */
	111	u32 crc;
	112	u64 offset;
	113	int i_blk_seq_num;
	114	u8 *i_buf;
	115	u8 *i_buf_start;
	116	u8 *i_buf_end;
	117	long r_left;
	118	long b_left;
	119
c6631764 PA	120	u32 bad_skip; /* for nand use */
c6631764 PA	121
ea2453d5	122	unsigned int inited:1;
f22b11c1 ŁM	123	};
	124
	125	int dfu_config_entities(char s, char interface, int num);
	126	void dfu_free_entities(void);
	127	void dfu_show_entities(void);
	128	int dfu_get_alt_number(void);
	129	const char *dfu_get_dev_type(enum dfu_device_type t);
	130	const char *dfu_get_layout(enum dfu_layout l);
	131	struct dfu_entity *dfu_get_entity(int alt);
	132	char dfu_extract_token(char* e, int *n);
6bed7ce5	133	void dfu_trigger_reset(void);
fed936ed	134	int dfu_get_alt(char *name);
6bed7ce5	135	bool dfu_reset(void);
765c5ae5	136	int dfu_init_env_entities(char *interface, int dev);
d4278263 ŁM	137	unsigned char *dfu_get_buf(void);
d4278263 ŁM	138	unsigned char *dfu_free_buf(void);
4fb12789	139	unsigned long dfu_get_buf_size(void);
f22b11c1 ŁM	140
	141	int dfu_read(struct dfu_entity de, void buf, int size, int blk_seq_num);
	142	int dfu_write(struct dfu_entity de, void buf, int size, int blk_seq_num);
a2199afe	143	int dfu_flush(struct dfu_entity de, void buf, int size, int blk_seq_num);
f22b11c1 ŁM	144	/* Device specific */
	145	#ifdef CONFIG_DFU_MMC
	146	extern int dfu_fill_entity_mmc(struct dfu_entity dfu, char s);
	147	#else
	148	static inline int dfu_fill_entity_mmc(struct dfu_entity dfu, char s)
	149	{
	150	puts("MMC support not available!\n");
	151	return -1;
	152	}
	153	#endif
c6631764 PA	154
	155	#ifdef CONFIG_DFU_NAND
	156	extern int dfu_fill_entity_nand(struct dfu_entity dfu, char s);
	157	#else
	158	static inline int dfu_fill_entity_nand(struct dfu_entity dfu, char s)
	159	{
	160	puts("NAND support not available!\n");
	161	return -1;
	162	}
	163	#endif
	164
a9479f04 AM	165	#ifdef CONFIG_DFU_RAM
	166	extern int dfu_fill_entity_ram(struct dfu_entity dfu, char s);
	167	#else
	168	static inline int dfu_fill_entity_ram(struct dfu_entity dfu, char s)
	169	{
	170	puts("RAM support not available!\n");
	171	return -1;
	172	}
	173	#endif
	174
a6921adc	175	int dfu_add(struct usb_configuration *c);
f22b11c1	176	#endif /* __DFU_ENTITY_H_ */