[thirdparty/u-boot.git] / include / dfu.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * dfu.h - DFU flashable area description
 *
 * Copyright (C) 2012 Samsung Electronics
 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
 *	    Lukasz Majewski <l.majewski@samsung.com>
 */

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

	int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);

	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;
	u64 r_left;
	long b_left;

	u32 bad_skip;	/* for nand use */

	unsigned int inited:1;
};

#ifdef CONFIG_SET_DFU_ALT_INFO
void set_dfu_alt_info(char *interface, char *devstr);
#endif
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);
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);

/*
 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
 *		     It should be NULL when not used.
 */
extern struct dfu_entity *dfu_defer_flush;
/**
 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
 *
 * @return - value of the dfu_defer_flush pointer
 */
static inline struct dfu_entity *dfu_get_defer_flush(void)
{
	return dfu_defer_flush;
}

/**
 * dfu_set_defer_flush - set the dfu_defer_flush pointer
 *
 * @param dfu - pointer to the dfu_entity, which should be written
 */
static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
{
	dfu_defer_flush = dfu;
}

/**
 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
 *
 * This function adds support for writing data starting from fixed memory
 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
 *
 * @param dfu - dfu entity to which we want to store data
 * @param buf - fixed memory addres from where data starts
 * @param size - number of bytes to write
 *
 * @return - 0 on success, other value on failure
 */
int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);

/* Device specific */
#if CONFIG_IS_ENABLED(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

#if CONFIG_IS_ENABLED(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

#if CONFIG_IS_ENABLED(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

#if CONFIG_IS_ENABLED(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

/**
 * dfu_tftp_write - Write TFTP data to DFU medium
 *
 * This function is storing data received via TFTP on DFU supported medium.
 *
 * @param dfu_entity_name - name of DFU entity to write
 * @param addr - address of data buffer to write
 * @param len - number of bytes
 * @param interface - destination DFU medium (e.g. "mmc")
 * @param devstring - instance number of destination DFU medium (e.g. "1")
 *
 * @return 0 on success, otherwise error code
 */
#if CONFIG_IS_ENABLED(DFU_TFTP)
int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
		   char *interface, char *devstring);
#else
static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
				 unsigned int len, char *interface,
				 char *devstring)
{
	puts("TFTP write support for DFU not available!\n");
	return -ENOSYS;
}
#endif

int dfu_add(struct usb_configuration *c);
#endif /* __DFU_ENTITY_H_ */
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
f22b11c1 ŁM	2	/*
	3	* dfu.h - DFU flashable area description
	4	*
	5	* Copyright (C) 2012 Samsung Electronics
	6	* authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
	7	* Lukasz Majewski <l.majewski@samsung.com>
f22b11c1 ŁM	8	*/
	9
	10	#ifndef __DFU_ENTITY_H_
	11	#define __DFU_ENTITY_H_
	12
	13	#include <common.h>
	14	#include <linux/list.h>
	15	#include <mmc.h>
6f12ebf6	16	#include <spi_flash.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,
6f12ebf6	24	DFU_DEV_SF,
f22b11c1 ŁM	25	};
	26
	27	enum dfu_layout {
	28	DFU_RAW_ADDR = 1,
	29	DFU_FS_FAT,
	30	DFU_FS_EXT2,
	31	DFU_FS_EXT3,
	32	DFU_FS_EXT4,
a9479f04	33	DFU_RAM_ADDR,
f22b11c1 ŁM	34	};
f22b11c1 ŁM	35
5a127c84 AM	36	enum dfu_op {
	37	DFU_OP_READ = 1,
	38	DFU_OP_WRITE,
0e285b50	39	DFU_OP_SIZE,
5a127c84 AM	40	};
5a127c84 AM	41
f22b11c1	42	struct mmc_internal_data {
dd64827e SW	43	int dev_num;
dd64827e SW	44
f22b11c1 ŁM	45	/* RAW programming */
	46	unsigned int lba_start;
	47	unsigned int lba_size;
	48	unsigned int lba_blk_size;
	49
c8151b4a ŁM	50	/* eMMC HW partition access */
	51	int hw_partition;
	52
f22b11c1 ŁM	53	/* FAT/EXT */
	54	unsigned int dev;
	55	unsigned int part;
	56	};
	57
c6631764 PA	58	struct nand_internal_data {
	59	/* RAW programming */
	60	u64 start;
	61	u64 size;
	62
	63	unsigned int dev;
	64	unsigned int part;
815c30b2 HS	65	/* for nand/ubi use */
815c30b2 HS	66	unsigned int ubi;
c6631764 PA	67	};
c6631764 PA	68
a9479f04 AM	69	struct ram_internal_data {
	70	void *start;
	71	unsigned int size;
	72	};
	73
6f12ebf6 SW	74	struct sf_internal_data {
	75	struct spi_flash *dev;
	76
	77	/* RAW programming */
	78	u64 start;
	79	u64 size;
	80	};
	81
a24c3155	82	#define DFU_NAME_SIZE 32
e7e75c70 HS	83	#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
	84	#define CONFIG_SYS_DFU_DATA_BUF_SIZE (102410248) /* 8 MiB */
	85	#endif
ea2453d5	86	#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
7a813d5b	87	#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
ea2453d5	88	#endif
33fac4a6 ŁM	89	#ifndef DFU_DEFAULT_POLL_TIMEOUT
	90	#define DFU_DEFAULT_POLL_TIMEOUT 0
	91	#endif
001a8319 HS	92	#ifndef DFU_MANIFEST_POLL_TIMEOUT
	93	#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
	94	#endif
f22b11c1 ŁM	95
	96	struct dfu_entity {
	97	char name[DFU_NAME_SIZE];
	98	int alt;
	99	void *dev_private;
f22b11c1 ŁM	100	enum dfu_device_type dev_type;
f22b11c1 ŁM	101	enum dfu_layout layout;
7ac1b410	102	unsigned long max_buf_size;
f22b11c1 ŁM	103
	104	union {
	105	struct mmc_internal_data mmc;
c6631764	106	struct nand_internal_data nand;
a9479f04	107	struct ram_internal_data ram;
6f12ebf6	108	struct sf_internal_data sf;
f22b11c1 ŁM	109	} data;
f22b11c1 ŁM	110
15970d87	111	int (get_medium_size)(struct dfu_entity dfu, u64 *size);
0e285b50	112
ea2453d5 PA	113	int (read_medium)(struct dfu_entity dfu,
	114	u64 offset, void buf, long len);
	115
	116	int (write_medium)(struct dfu_entity dfu,
	117	u64 offset, void buf, long len);
	118
	119	int (flush_medium)(struct dfu_entity dfu);
fc25fa27	120	unsigned int (poll_timeout)(struct dfu_entity dfu);
f22b11c1	121
cb7bd2e0 SW	122	void (free_entity)(struct dfu_entity dfu);
cb7bd2e0 SW	123
f22b11c1	124	struct list_head list;
ea2453d5 PA	125
	126	/* on the fly state */
	127	u32 crc;
	128	u64 offset;
	129	int i_blk_seq_num;
	130	u8 *i_buf;
	131	u8 *i_buf_start;
	132	u8 *i_buf_end;
15970d87	133	u64 r_left;
ea2453d5 PA	134	long b_left;
ea2453d5 PA	135
c6631764 PA	136	u32 bad_skip; /* for nand use */
c6631764 PA	137
ea2453d5	138	unsigned int inited:1;
f22b11c1 ŁM	139	};
f22b11c1 ŁM	140
899a5282 PM	141	#ifdef CONFIG_SET_DFU_ALT_INFO
	142	void set_dfu_alt_info(char interface, char devstr);
	143	#endif
dd64827e	144	int dfu_config_entities(char s, char interface, char *devstr);
f22b11c1 ŁM	145	void dfu_free_entities(void);
	146	void dfu_show_entities(void);
	147	int dfu_get_alt_number(void);
	148	const char *dfu_get_dev_type(enum dfu_device_type t);
	149	const char *dfu_get_layout(enum dfu_layout l);
	150	struct dfu_entity *dfu_get_entity(int alt);
	151	char dfu_extract_token(char* e, int *n);
6bed7ce5	152	void dfu_trigger_reset(void);
fed936ed	153	int dfu_get_alt(char *name);
dd64827e	154	int dfu_init_env_entities(char interface, char devstr);
7ac1b410	155	unsigned char dfu_get_buf(struct dfu_entity dfu);
d4278263	156	unsigned char *dfu_free_buf(void);
4fb12789	157	unsigned long dfu_get_buf_size(void);
1cc03c5c	158	bool dfu_usb_get_reset(void);
f22b11c1 ŁM	159
	160	int dfu_read(struct dfu_entity de, void buf, int size, int blk_seq_num);
	161	int dfu_write(struct dfu_entity de, void buf, int size, int blk_seq_num);
a2199afe	162	int dfu_flush(struct dfu_entity de, void buf, int size, int blk_seq_num);
2092e461	163
fc18f8d1 ŁM	164	/*
	165	* dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
	166	* It should be NULL when not used.
	167	*/
	168	extern struct dfu_entity *dfu_defer_flush;
	169	/**
	170	* dfu_get_defer_flush - get current value of dfu_defer_flush pointer
	171	*
	172	* @return - value of the dfu_defer_flush pointer
	173	*/
	174	static inline struct dfu_entity *dfu_get_defer_flush(void)
	175	{
	176	return dfu_defer_flush;
	177	}
	178
	179	/**
	180	* dfu_set_defer_flush - set the dfu_defer_flush pointer
	181	*
	182	* @param dfu - pointer to the dfu_entity, which should be written
	183	*/
	184	static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
	185	{
	186	dfu_defer_flush = dfu;
	187	}
	188
2092e461 LM	189	/**
	190	* dfu_write_from_mem_addr - write data from memory to DFU managed medium
	191	*
	192	* This function adds support for writing data starting from fixed memory
	193	* address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
	194	*
	195	* @param dfu - dfu entity to which we want to store data
	196	* @param buf - fixed memory addres from where data starts
	197	* @param size - number of bytes to write
	198	*
	199	* @return - 0 on success, other value on failure
	200	*/
	201	int dfu_write_from_mem_addr(struct dfu_entity dfu, void buf, int size);
	202
f22b11c1	203	/* Device specific */
2d59ec84	204	#if CONFIG_IS_ENABLED(DFU_MMC)
dd64827e	205	extern int dfu_fill_entity_mmc(struct dfu_entity dfu, char devstr, char *s);
f22b11c1	206	#else
dd64827e SW	207	static inline int dfu_fill_entity_mmc(struct dfu_entity dfu, char devstr,
dd64827e SW	208	char *s)
f22b11c1 ŁM	209	{
	210	puts("MMC support not available!\n");
	211	return -1;
	212	}
	213	#endif
c6631764	214
2d59ec84	215	#if CONFIG_IS_ENABLED(DFU_NAND)
dd64827e	216	extern int dfu_fill_entity_nand(struct dfu_entity dfu, char devstr, char *s);
c6631764	217	#else
dd64827e SW	218	static inline int dfu_fill_entity_nand(struct dfu_entity dfu, char devstr,
dd64827e SW	219	char *s)
c6631764 PA	220	{
	221	puts("NAND support not available!\n");
	222	return -1;
	223	}
	224	#endif
	225
2d59ec84	226	#if CONFIG_IS_ENABLED(DFU_RAM)
dd64827e	227	extern int dfu_fill_entity_ram(struct dfu_entity dfu, char devstr, char *s);
a9479f04	228	#else
dd64827e SW	229	static inline int dfu_fill_entity_ram(struct dfu_entity dfu, char devstr,
dd64827e SW	230	char *s)
a9479f04 AM	231	{
	232	puts("RAM support not available!\n");
	233	return -1;
	234	}
	235	#endif
	236
2d59ec84	237	#if CONFIG_IS_ENABLED(DFU_SF)
6f12ebf6 SW	238	extern int dfu_fill_entity_sf(struct dfu_entity dfu, char devstr, char *s);
	239	#else
	240	static inline int dfu_fill_entity_sf(struct dfu_entity dfu, char devstr,
	241	char *s)
	242	{
	243	puts("SF support not available!\n");
	244	return -1;
	245	}
	246	#endif
	247
2d50d68a LM	248	/**
	249	* dfu_tftp_write - Write TFTP data to DFU medium
	250	*
	251	* This function is storing data received via TFTP on DFU supported medium.
	252	*
	253	* @param dfu_entity_name - name of DFU entity to write
	254	* @param addr - address of data buffer to write
	255	* @param len - number of bytes
	256	* @param interface - destination DFU medium (e.g. "mmc")
	257	* @param devstring - instance number of destination DFU medium (e.g. "1")
	258	*
	259	* @return 0 on success, otherwise error code
	260	*/
2d59ec84	261	#if CONFIG_IS_ENABLED(DFU_TFTP)
2d50d68a LM	262	int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
	263	char interface, char devstring);
	264	#else
	265	static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
	266	unsigned int len, char *interface,
	267	char *devstring)
	268	{
	269	puts("TFTP write support for DFU not available!\n");
	270	return -ENOSYS;
	271	}
	272	#endif
	273
a6921adc	274	int dfu_add(struct usb_configuration *c);
f22b11c1	275	#endif /* __DFU_ENTITY_H_ */