[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 <spi_flash.h>
#include <linux/usb/composite.h>

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

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,
	DFU_OP_SIZE,
};

struct mmc_internal_data {
	int dev_num;

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

struct sf_internal_data {
	struct spi_flash *dev;

	/* RAW programming */
	u64 start;
	u64 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;
	enum dfu_device_type    dev_type;
	enum dfu_layout         layout;
	unsigned long           max_buf_size;

	union {
		struct mmc_internal_data mmc;
		struct nand_internal_data nand;
		struct ram_internal_data ram;
		struct sf_internal_data sf;
	} data;

	long (*get_medium_size)(struct dfu_entity *dfu);

	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);

	void (*free_entity)(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, char *devstr);
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_detach(void);
void dfu_trigger_detach(void);
void dfu_clear_detach(void);
int dfu_init_env_entities(char *interface, char *devstr);
unsigned char *dfu_get_buf(struct dfu_entity *dfu);
unsigned char *dfu_free_buf(void);
unsigned long dfu_get_buf_size(void);
bool dfu_usb_get_reset(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 *devstr, char *s);
#else
static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
				      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 *devstr, char *s);
#else
static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
				       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 *devstr, char *s);
#else
static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
				      char *s)
{
	puts("RAM support not available!\n");
	return -1;
}
#endif

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