[J-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 <[email protected]>
 *	    Lukasz Majewski <[email protected]>
 */

#ifndef __DFU_ENTITY_H_
#define __DFU_ENTITY_H_

#include <linux/errno.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,
	DFU_DEV_MTD,
	DFU_DEV_VIRT,
};

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

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 mtd_internal_data {
	struct mtd_info *info;

	/* RAW programming */
	u64 start;
	u64 size;
	/* for ubi partition */
	unsigned int ubi;
};

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 {
	unsigned long	start;
	unsigned int	size;
};

struct sf_internal_data {
	struct spi_flash *dev;

	/* RAW programming */
	u64 start;
	u64 size;
	/* for sf/ubi use */
	unsigned int ubi;
};

struct virt_internal_data {
	int dev_num;
};


#if defined(CONFIG_DFU_NAME_MAX_SIZE)
#define DFU_NAME_SIZE			CONFIG_DFU_NAME_MAX_SIZE
#else
#define DFU_NAME_SIZE			32
#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 mtd_internal_data mtd;
		struct nand_internal_data nand;
		struct ram_internal_data ram;
		struct sf_internal_data sf;
		struct virt_internal_data virt;
	} 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;
};

struct list_head;
extern struct list_head dfu_list;

#ifdef CONFIG_SET_DFU_ALT_INFO
/**
 * set_dfu_alt_info() - set dfu_alt_info environment variable
 *
 * If CONFIG_SET_DFU_ALT_INFO=y, this board specific function is called to set
 * environment variable dfu_alt_info.
 *
 * @interface:	dfu interface, e.g. "mmc" or "nand"
 * @devstr:	device number as string
 */
void set_dfu_alt_info(char *interface, char *devstr);
#endif

/**
 * dfu_alt_init() - initialize buffer for dfu entities
 *
 * @num:	number of entities
 * @dfu:	on return allocated buffer
 * Return:	0 on success
 */
int dfu_alt_init(int num, struct dfu_entity **dfu);

/**
 * dfu_alt_add() - add alternate to dfu entity buffer
 *
 * @dfu:	dfu entity
 * @interface:	dfu interface, e.g. "mmc" or "nand"
 * @devstr:	device number as string
 * @s:		string description of alternate
 * Return:	0 on success
 */
int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);

/**
 * dfu_config_entities() - initialize dfu entitities from envirionment
 *
 * Initialize the list of dfu entities from environment variable dfu_alt_info.
 * The list must be freed by calling dfu_free_entities(). This function bypasses
 * set_dfu_alt_info(). So typically you should use dfu_init_env_entities()
 * instead.
 *
 * See function :c:func:`dfu_free_entities`
 * See function :c:func:`dfu_init_env_entities`
 *
 * @s:		string with alternates
 * @interface:	interface, e.g. "mmc" or "nand"
 * @devstr:	device number as string
 * Return:	0 on success, a negative error code otherwise
 */
int dfu_config_entities(char *s, char *interface, char *devstr);

/**
 * dfu_free_entities() - free the list of dfu entities
 *
 * Free the internal list of dfu entities.
 *
 * See function :c:func:`dfu_init_env_entities`
 */
void dfu_free_entities(void);

/**
 * dfu_show_entities() - print DFU alt settings list
 */
void dfu_show_entities(void);

/**
 * dfu_get_alt_number() - get number of alternates
 *
 * Return: number of alternates in the dfu entities list
 */
int dfu_get_alt_number(void);

/**
 * dfu_get_dev_type() - get string representation for dfu device type
 *
 * @type:	device type
 * Return:	string representation for device type
 */
const char *dfu_get_dev_type(enum dfu_device_type type);

/**
 * dfu_get_layout() - get string describing layout
 *
 * Internally layouts are represented by enum dfu_device_type values. This
 * function translates an enum value to a human readable string, e.g. DFU_FS_FAT
 * is translated to "FAT".
 *
 * @layout:	layout
 * Result:	string representation for the layout
 */
const char *dfu_get_layout(enum dfu_layout layout);

/**
 * dfu_get_entity() - get dfu entity for an alternate id
 *
 * @alt:	alternate id
 * Return:	dfu entity
 */
struct dfu_entity *dfu_get_entity(int alt);

char *dfu_extract_token(char** e, int *n);

/**
 * dfu_get_alt() - get alternate id for filename
 *
 * Environment variable dfu_alt_info defines the write destinations (alternates)
 * for different filenames. This function get the index of the alternate for
 * a filename. If an absolute filename is provided (starting with '/'), the
 * directory path is ignored.
 *
 * @name:	filename
 * Return:	id of the alternate or negative error number (-ENODEV)
 */
int dfu_get_alt(char *name);

/**
 * dfu_init_env_entities() - initialize dfu entitities from envirionment
 *
 * Initialize the list of dfu entities from environment variable dfu_alt_info.
 * The list must be freed by calling dfu_free_entities().
 * @interface and @devstr are used to select the relevant set of alternates
 * from environment variable dfu_alt_info.
 *
 * If environment variable dfu_alt_info specifies the interface and the device,
 * use NULL for @interface and @devstr.
 *
 * See function :c:func:`dfu_free_entities`
 *
 * @interface:	interface, e.g. "mmc" or "nand"
 * @devstr:	device number as string
 * Return:	0 on success, a negative error code otherwise
 */
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);

#ifdef CONFIG_DFU_TIMEOUT
unsigned long dfu_get_timeout(void);
void dfu_set_timeout(unsigned long);
#endif

/**
 * dfu_read() - read from dfu entity
 *
 * The block sequence number @blk_seq_num is a 16 bit counter that must be
 * incremented with each call for the same dfu entity @de.
 *
 * @de:			dfu entity
 * @buf:		buffer
 * @size:		size of buffer
 * @blk_seq_num:	block sequence number
 * Return:		0 for success, -1 for error
 */
int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);

/**
 * dfu_write() - write to dfu entity
 *
 * Write the contents of a buffer @buf to the dfu entity @de. After writing
 * the last block call dfu_flush(). If a file is already loaded completely
 * into memory it is preferable to use dfu_write_from_mem_addr() which takes
 * care of blockwise transfer and flushing.
 *
 * The block sequence number @blk_seq_num is a 16 bit counter that must be
 * incremented with each call for the same dfu entity @de.
 *
 * See function :c:func:`dfu_flush`
 * See function :c:func:`dfu_write_from_mem_addr`
 *
 * @de:			dfu entity
 * @buf:		buffer
 * @size:		size of buffer
 * @blk_seq_num:	block sequence number
 * Return:		0 for success, -1 for error
 */
int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);

/**
 * dfu_flush() - flush to dfu entity
 *
 * This function has to be called after writing the last block to the dfu
 * entity @de.
 *
 * The block sequence number @blk_seq_num is a 16 bit counter that must be
 * incremented with each call for the same dfu entity @de.
 *
 * See function :c:func:`dfu_write`
 *
 * @de:			dfu entity
 * @buf:		ignored
 * @size:		ignored
 * @blk_seq_num:	block sequence number of last write - ignored
 * Return:		0 for success, -1 for error
 */
int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);

/**
 * dfu_initiated_callback() - weak callback called on DFU transaction start
 *
 * It is a callback function called by DFU stack when a DFU transaction is
 * initiated. This function allows to manage some board specific behavior on
 * DFU targets.
 *
 * @dfu:	pointer to the dfu_entity, which should be initialized
 */
void dfu_initiated_callback(struct dfu_entity *dfu);

/**
 * dfu_flush_callback() - weak callback called at the end of the DFU write
 *
 * It is a callback function called by DFU stack after DFU manifestation.
 * This function allows to manage some board specific behavior on DFU targets
 *
 * @dfu:	pointer to the dfu_entity, which should be flushed
 */
void dfu_flush_callback(struct dfu_entity *dfu);

/**
 * dfu_error_callback() - weak callback called at the DFU write error
 *
 * It is a callback function called by DFU stack after DFU write error.
 * This function allows to manage some board specific behavior on DFU targets
 *
 * @dfu:	pointer to the dfu_entity which cause the error
 * @msg:	the message of the error
 */
void dfu_error_callback(struct dfu_entity *dfu, const char *msg);

int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
void dfu_transaction_cleanup(struct dfu_entity *dfu);

/*
 * 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
 *
 * @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)
 *
 * @dfu:	dfu entity to which we want to store data
 * @buf:	fixed memory address from where data starts
 * @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 */
/* Each entity has 5 arguments in maximum. */
#define DFU_MAX_ENTITY_ARGS	5

#if CONFIG_IS_ENABLED(DFU_MMC)
extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
			       char **argv, int argc);
#else
static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
				      char **argv, int argc)
{
	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 **argv, int argc);
#else
static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
				       char **argv, int argc)
{
	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 **argv, int argc);
#else
static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
				      char **argv, int argc)
{
	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 **argv, int argc);
#else
static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
				     char **argv, int argc)
{
	puts("SF support not available!\n");
	return -1;
}
#endif

#if CONFIG_IS_ENABLED(DFU_MTD)
extern int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
			       char **argv, int argc);
#else
static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
				      char **argv, int argc)
{
	puts("MTD support not available!\n");
	return -1;
}
#endif

#if CONFIG_IS_ENABLED(DFU_VIRT)
int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
			 char **argv, int argc);
int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
			  void *buf, long *len);
int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
			 void *buf, long *len);
#else
static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
				       char **argv, int argc)
{
	puts("VIRT support not available!\n");
	return -1;
}
#endif

extern bool dfu_reinit_needed;

#if CONFIG_IS_ENABLED(DFU_WRITE_ALT)
/**
 * dfu_write_by_name() - write data to DFU medium
 * @dfu_entity_name:	Name of DFU entity to write
 * @addr:		Address of data buffer to write
 * @len:		Number of bytes
 * @interface:		Destination DFU medium (e.g. "mmc")
 * @devstring:		Instance number of destination DFU medium (e.g. "1")
 *
 * This function is storing data received on DFU supported medium which
 * is specified by @dfu_entity_name.
 *
 * Return:		0 - on success, error code - otherwise
 */
int dfu_write_by_name(char *dfu_entity_name, void *addr,
		      unsigned int len, char *interface, char *devstring);

/**
 * dfu_write_by_alt() - write data to DFU medium
 * @dfu_alt_num:	DFU alt setting number
 * @addr:		Address of data buffer to write
 * @len:		Number of bytes
 * @interface:		Destination DFU medium (e.g. "mmc")
 * @devstring:		Instance number of destination DFU medium (e.g. "1")
 *
 * This function is storing data received on DFU supported medium which
 * is specified by @dfu_alt_name.
 *
 * Return:		0 - on success, error code - otherwise
 */
int dfu_write_by_alt(int dfu_alt_num, void *addr, unsigned int len,
		     char *interface, char *devstring);
#else
static inline int dfu_write_by_name(char *dfu_entity_name, void *addr,
				    unsigned int len, char *interface,
				    char *devstring)
{
	puts("write support for DFU not available!\n");
	return -ENOSYS;
}

static inline int dfu_write_by_alt(int dfu_alt_num, void *addr,
				   unsigned int len, char *interface,
				   char *devstring)
{
	puts("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 <[email protected]>
	7	* Lukasz Majewski <[email protected]>
f22b11c1 ŁM	8	*/
	9
	10	#ifndef __DFU_ENTITY_H_
	11	#define __DFU_ENTITY_H_
	12
e2e69291	13	#include <linux/errno.h>
f22b11c1 ŁM	14	#include <linux/list.h>
f22b11c1 ŁM	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,
6015af28	25	DFU_DEV_MTD,
ec44cace	26	DFU_DEV_VIRT,
f22b11c1 ŁM	27	};
	28
	29	enum dfu_layout {
	30	DFU_RAW_ADDR = 1,
	31	DFU_FS_FAT,
	32	DFU_FS_EXT2,
	33	DFU_FS_EXT3,
	34	DFU_FS_EXT4,
a9479f04	35	DFU_RAM_ADDR,
b5f3405b	36	DFU_SKIP,
c533f94c	37	DFU_SCRIPT,
f22b11c1 ŁM	38	};
f22b11c1 ŁM	39
5a127c84 AM	40	enum dfu_op {
	41	DFU_OP_READ = 1,
	42	DFU_OP_WRITE,
0e285b50	43	DFU_OP_SIZE,
5a127c84 AM	44	};
5a127c84 AM	45
f22b11c1	46	struct mmc_internal_data {
dd64827e SW	47	int dev_num;
dd64827e SW	48
f22b11c1 ŁM	49	/* RAW programming */
	50	unsigned int lba_start;
	51	unsigned int lba_size;
	52	unsigned int lba_blk_size;
	53
c8151b4a ŁM	54	/* eMMC HW partition access */
	55	int hw_partition;
	56
f22b11c1 ŁM	57	/* FAT/EXT */
	58	unsigned int dev;
	59	unsigned int part;
	60	};
	61
6015af28 PD	62	struct mtd_internal_data {
	63	struct mtd_info *info;
	64
	65	/* RAW programming */
	66	u64 start;
	67	u64 size;
d5640f70 PD	68	/* for ubi partition */
d5640f70 PD	69	unsigned int ubi;
6015af28 PD	70	};
6015af28 PD	71
c6631764 PA	72	struct nand_internal_data {
	73	/* RAW programming */
	74	u64 start;
	75	u64 size;
	76
	77	unsigned int dev;
	78	unsigned int part;
815c30b2 HS	79	/* for nand/ubi use */
815c30b2 HS	80	unsigned int ubi;
c6631764 PA	81	};
c6631764 PA	82
a9479f04	83	struct ram_internal_data {
73f4ebb6	84	unsigned long start;
a9479f04 AM	85	unsigned int size;
	86	};
	87
6f12ebf6 SW	88	struct sf_internal_data {
	89	struct spi_flash *dev;
	90
	91	/* RAW programming */
	92	u64 start;
	93	u64 size;
cb986ba0 PD	94	/* for sf/ubi use */
cb986ba0 PD	95	unsigned int ubi;
6f12ebf6 SW	96	};
6f12ebf6 SW	97
ec44cace PD	98	struct virt_internal_data {
	99	int dev_num;
	100	};
	101
f4906233 JC	102
	103	#if defined(CONFIG_DFU_NAME_MAX_SIZE)
	104	#define DFU_NAME_SIZE CONFIG_DFU_NAME_MAX_SIZE
	105	#else
a24c3155	106	#define DFU_NAME_SIZE 32
f4906233	107	#endif
33fac4a6 ŁM	108	#ifndef DFU_DEFAULT_POLL_TIMEOUT
	109	#define DFU_DEFAULT_POLL_TIMEOUT 0
	110	#endif
001a8319 HS	111	#ifndef DFU_MANIFEST_POLL_TIMEOUT
	112	#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
	113	#endif
f22b11c1 ŁM	114
	115	struct dfu_entity {
	116	char name[DFU_NAME_SIZE];
	117	int alt;
	118	void *dev_private;
f22b11c1 ŁM	119	enum dfu_device_type dev_type;
f22b11c1 ŁM	120	enum dfu_layout layout;
7ac1b410	121	unsigned long max_buf_size;
f22b11c1 ŁM	122
	123	union {
	124	struct mmc_internal_data mmc;
6015af28	125	struct mtd_internal_data mtd;
c6631764	126	struct nand_internal_data nand;
a9479f04	127	struct ram_internal_data ram;
6f12ebf6	128	struct sf_internal_data sf;
ec44cace	129	struct virt_internal_data virt;
f22b11c1 ŁM	130	} data;
f22b11c1 ŁM	131
15970d87	132	int (get_medium_size)(struct dfu_entity dfu, u64 *size);
0e285b50	133
ea2453d5 PA	134	int (read_medium)(struct dfu_entity dfu,
	135	u64 offset, void buf, long len);
	136
	137	int (write_medium)(struct dfu_entity dfu,
	138	u64 offset, void buf, long len);
	139
	140	int (flush_medium)(struct dfu_entity dfu);
fc25fa27	141	unsigned int (poll_timeout)(struct dfu_entity dfu);
f22b11c1	142
cb7bd2e0 SW	143	void (free_entity)(struct dfu_entity dfu);
cb7bd2e0 SW	144
f22b11c1	145	struct list_head list;
ea2453d5 PA	146
	147	/* on the fly state */
	148	u32 crc;
	149	u64 offset;
	150	int i_blk_seq_num;
	151	u8 *i_buf;
	152	u8 *i_buf_start;
	153	u8 *i_buf_end;
15970d87	154	u64 r_left;
ea2453d5 PA	155	long b_left;
ea2453d5 PA	156
c6631764 PA	157	u32 bad_skip; /* for nand use */
c6631764 PA	158
ea2453d5	159	unsigned int inited:1;
f22b11c1 ŁM	160	};
f22b11c1 ŁM	161
6beaa47d AT	162	struct list_head;
	163	extern struct list_head dfu_list;
	164
899a5282	165	#ifdef CONFIG_SET_DFU_ALT_INFO
d181191e HS	166	/**
	167	* set_dfu_alt_info() - set dfu_alt_info environment variable
	168	*
	169	* If CONFIG_SET_DFU_ALT_INFO=y, this board specific function is called to set
	170	* environment variable dfu_alt_info.
	171	*
	172	* @interface: dfu interface, e.g. "mmc" or "nand"
	173	* @devstr: device number as string
	174	*/
899a5282 PM	175	void set_dfu_alt_info(char interface, char devstr);
899a5282 PM	176	#endif
d181191e HS	177
	178	/**
	179	* dfu_alt_init() - initialize buffer for dfu entities
	180	*
	181	* @num: number of entities
	182	* @dfu: on return allocated buffer
	183	* Return: 0 on success
	184	*/
9ada6830	185	int dfu_alt_init(int num, struct dfu_entity **dfu);
d181191e HS	186
	187	/**
	188	* dfu_alt_add() - add alternate to dfu entity buffer
	189	*
	190	* @dfu: dfu entity
	191	* @interface: dfu interface, e.g. "mmc" or "nand"
	192	* @devstr: device number as string
	193	* @s: string description of alternate
	194	* Return: 0 on success
	195	*/
9ada6830	196	int dfu_alt_add(struct dfu_entity dfu, char interface, char devstr, char s);
d181191e HS	197
	198	/**
	199	* dfu_config_entities() - initialize dfu entitities from envirionment
	200	*
	201	* Initialize the list of dfu entities from environment variable dfu_alt_info.
	202	* The list must be freed by calling dfu_free_entities(). This function bypasses
	203	* set_dfu_alt_info(). So typically you should use dfu_init_env_entities()
	204	* instead.
	205	*
	206	* See function :c:func:`dfu_free_entities`
	207	* See function :c:func:`dfu_init_env_entities`
	208	*
	209	* @s: string with alternates
	210	* @interface: interface, e.g. "mmc" or "nand"
	211	* @devstr: device number as string
	212	* Return: 0 on success, a negative error code otherwise
	213	*/
dd64827e	214	int dfu_config_entities(char s, char interface, char *devstr);
d181191e HS	215
	216	/**
	217	* dfu_free_entities() - free the list of dfu entities
	218	*
	219	* Free the internal list of dfu entities.
	220	*
	221	* See function :c:func:`dfu_init_env_entities`
	222	*/
f22b11c1	223	void dfu_free_entities(void);
d181191e HS	224
	225	/**
	226	* dfu_show_entities() - print DFU alt settings list
	227	*/
f22b11c1	228	void dfu_show_entities(void);
d181191e HS	229
	230	/**
	231	* dfu_get_alt_number() - get number of alternates
	232	*
	233	* Return: number of alternates in the dfu entities list
	234	*/
f22b11c1	235	int dfu_get_alt_number(void);
d181191e HS	236
	237	/**
	238	* dfu_get_dev_type() - get string representation for dfu device type
	239	*
	240	* @type: device type
	241	* Return: string representation for device type
	242	*/
	243	const char *dfu_get_dev_type(enum dfu_device_type type);
	244
	245	/**
	246	* dfu_get_layout() - get string describing layout
	247	*
	248	* Internally layouts are represented by enum dfu_device_type values. This
	249	* function translates an enum value to a human readable string, e.g. DFU_FS_FAT
	250	* is translated to "FAT".
	251	*
	252	* @layout: layout
	253	* Result: string representation for the layout
	254	*/
	255	const char *dfu_get_layout(enum dfu_layout layout);
	256
	257	/**
	258	* dfu_get_entity() - get dfu entity for an alternate id
	259	*
	260	* @alt: alternate id
	261	* Return: dfu entity
	262	*/
f22b11c1	263	struct dfu_entity *dfu_get_entity(int alt);
d181191e	264
f22b11c1	265	char dfu_extract_token(char* e, int *n);
d181191e HS	266
	267	/**
	268	* dfu_get_alt() - get alternate id for filename
	269	*
	270	* Environment variable dfu_alt_info defines the write destinations (alternates)
	271	* for different filenames. This function get the index of the alternate for
	272	* a filename. If an absolute filename is provided (starting with '/'), the
	273	* directory path is ignored.
	274	*
	275	* @name: filename
	276	* Return: id of the alternate or negative error number (-ENODEV)
	277	*/
fed936ed	278	int dfu_get_alt(char *name);
d181191e HS	279
	280	/**
	281	* dfu_init_env_entities() - initialize dfu entitities from envirionment
	282	*
	283	* Initialize the list of dfu entities from environment variable dfu_alt_info.
	284	* The list must be freed by calling dfu_free_entities().
	285	* @interface and @devstr are used to select the relevant set of alternates
	286	* from environment variable dfu_alt_info.
	287	*
	288	* If environment variable dfu_alt_info specifies the interface and the device,
	289	* use NULL for @interface and @devstr.
	290	*
	291	* See function :c:func:`dfu_free_entities`
	292	*
	293	* @interface: interface, e.g. "mmc" or "nand"
	294	* @devstr: device number as string
	295	* Return: 0 on success, a negative error code otherwise
	296	*/
dd64827e	297	int dfu_init_env_entities(char interface, char devstr);
d181191e	298
7ac1b410	299	unsigned char dfu_get_buf(struct dfu_entity dfu);
d4278263	300	unsigned char *dfu_free_buf(void);
4fb12789	301	unsigned long dfu_get_buf_size(void);
1cc03c5c	302	bool dfu_usb_get_reset(void);
f22b11c1	303
98a8f445 AS	304	#ifdef CONFIG_DFU_TIMEOUT
	305	unsigned long dfu_get_timeout(void);
	306	void dfu_set_timeout(unsigned long);
	307	#endif
	308
d181191e HS	309	/**
	310	* dfu_read() - read from dfu entity
	311	*
	312	* The block sequence number @blk_seq_num is a 16 bit counter that must be
	313	* incremented with each call for the same dfu entity @de.
	314	*
	315	* @de: dfu entity
	316	* @buf: buffer
	317	* @size: size of buffer
	318	* @blk_seq_num: block sequence number
	319	* Return: 0 for success, -1 for error
	320	*/
f22b11c1	321	int dfu_read(struct dfu_entity de, void buf, int size, int blk_seq_num);
d181191e HS	322
	323	/**
	324	* dfu_write() - write to dfu entity
	325	*
	326	* Write the contents of a buffer @buf to the dfu entity @de. After writing
	327	* the last block call dfu_flush(). If a file is already loaded completely
	328	* into memory it is preferable to use dfu_write_from_mem_addr() which takes
	329	* care of blockwise transfer and flushing.
	330	*
	331	* The block sequence number @blk_seq_num is a 16 bit counter that must be
	332	* incremented with each call for the same dfu entity @de.
	333	*
	334	* See function :c:func:`dfu_flush`
	335	* See function :c:func:`dfu_write_from_mem_addr`
	336	*
	337	* @de: dfu entity
	338	* @buf: buffer
	339	* @size: size of buffer
	340	* @blk_seq_num: block sequence number
	341	* Return: 0 for success, -1 for error
	342	*/
f22b11c1	343	int dfu_write(struct dfu_entity de, void buf, int size, int blk_seq_num);
d181191e HS	344
	345	/**
	346	* dfu_flush() - flush to dfu entity
	347	*
	348	* This function has to be called after writing the last block to the dfu
	349	* entity @de.
	350	*
	351	* The block sequence number @blk_seq_num is a 16 bit counter that must be
	352	* incremented with each call for the same dfu entity @de.
	353	*
	354	* See function :c:func:`dfu_write`
	355	*
	356	* @de: dfu entity
	357	* @buf: ignored
	358	* @size: ignored
	359	* @blk_seq_num: block sequence number of last write - ignored
	360	* Return: 0 for success, -1 for error
	361	*/
a2199afe	362	int dfu_flush(struct dfu_entity de, void buf, int size, int blk_seq_num);
2092e461	363
067c13c7	364	/**
f39c8454	365	* dfu_initiated_callback() - weak callback called on DFU transaction start
067c13c7 PD	366	*
	367	* It is a callback function called by DFU stack when a DFU transaction is
	368	* initiated. This function allows to manage some board specific behavior on
	369	* DFU targets.
	370	*
f39c8454	371	* @dfu: pointer to the dfu_entity, which should be initialized
067c13c7 PD	372	*/
067c13c7 PD	373	void dfu_initiated_callback(struct dfu_entity *dfu);
d181191e	374
067c13c7	375	/**
f39c8454	376	* dfu_flush_callback() - weak callback called at the end of the DFU write
067c13c7 PD	377	*
	378	* It is a callback function called by DFU stack after DFU manifestation.
	379	* This function allows to manage some board specific behavior on DFU targets
	380	*
f39c8454	381	* @dfu: pointer to the dfu_entity, which should be flushed
067c13c7 PD	382	*/
	383	void dfu_flush_callback(struct dfu_entity *dfu);
	384
d4710326 PD	385	/**
	386	* dfu_error_callback() - weak callback called at the DFU write error
	387	*
	388	* It is a callback function called by DFU stack after DFU write error.
	389	* This function allows to manage some board specific behavior on DFU targets
	390	*
	391	* @dfu: pointer to the dfu_entity which cause the error
	392	* @msg: the message of the error
	393	*/
	394	void dfu_error_callback(struct dfu_entity dfu, const char msg);
	395
5cf39720 PD	396	int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
	397	void dfu_transaction_cleanup(struct dfu_entity *dfu);
	398
fc18f8d1 ŁM	399	/*
	400	* dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
	401	* It should be NULL when not used.
	402	*/
	403	extern struct dfu_entity *dfu_defer_flush;
d181191e	404
fc18f8d1	405	/**
f39c8454	406	* dfu_get_defer_flush() - get current value of dfu_defer_flush pointer
fc18f8d1	407	*
f39c8454	408	* Return: value of the dfu_defer_flush pointer
fc18f8d1 ŁM	409	*/
	410	static inline struct dfu_entity *dfu_get_defer_flush(void)
	411	{
	412	return dfu_defer_flush;
	413	}
	414
	415	/**
f39c8454	416	* dfu_set_defer_flush() - set the dfu_defer_flush pointer
fc18f8d1	417	*
f39c8454	418	* @dfu: pointer to the dfu_entity, which should be written
fc18f8d1 ŁM	419	*/
	420	static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
	421	{
	422	dfu_defer_flush = dfu;
	423	}
	424
2092e461	425	/**
f39c8454	426	* dfu_write_from_mem_addr() - write data from memory to DFU managed medium
2092e461 LM	427	*
	428	* This function adds support for writing data starting from fixed memory
	429	* address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
	430	*
f39c8454 HS	431	* @dfu: dfu entity to which we want to store data
	432	* @buf: fixed memory address from where data starts
	433	* @size: number of bytes to write
2092e461	434	*
f39c8454	435	* Return: 0 on success, other value on failure
2092e461 LM	436	*/
	437	int dfu_write_from_mem_addr(struct dfu_entity dfu, void buf, int size);
	438
f22b11c1	439	/* Device specific */
53b40636 MH	440	/* Each entity has 5 arguments in maximum. */
	441	#define DFU_MAX_ENTITY_ARGS 5
	442
2d59ec84	443	#if CONFIG_IS_ENABLED(DFU_MMC)
53b40636 MH	444	extern int dfu_fill_entity_mmc(struct dfu_entity dfu, char devstr,
53b40636 MH	445	char **argv, int argc);
f22b11c1	446	#else
dd64827e	447	static inline int dfu_fill_entity_mmc(struct dfu_entity dfu, char devstr,
53b40636	448	char **argv, int argc)
f22b11c1 ŁM	449	{
	450	puts("MMC support not available!\n");
	451	return -1;
	452	}
	453	#endif
c6631764	454
2d59ec84	455	#if CONFIG_IS_ENABLED(DFU_NAND)
53b40636 MH	456	extern int dfu_fill_entity_nand(struct dfu_entity dfu, char devstr,
53b40636 MH	457	char **argv, int argc);
c6631764	458	#else
dd64827e	459	static inline int dfu_fill_entity_nand(struct dfu_entity dfu, char devstr,
53b40636	460	char **argv, int argc)
c6631764 PA	461	{
	462	puts("NAND support not available!\n");
	463	return -1;
	464	}
	465	#endif
	466
2d59ec84	467	#if CONFIG_IS_ENABLED(DFU_RAM)
53b40636 MH	468	extern int dfu_fill_entity_ram(struct dfu_entity dfu, char devstr,
53b40636 MH	469	char **argv, int argc);
a9479f04	470	#else
dd64827e	471	static inline int dfu_fill_entity_ram(struct dfu_entity dfu, char devstr,
53b40636	472	char **argv, int argc)
a9479f04 AM	473	{
	474	puts("RAM support not available!\n");
	475	return -1;
	476	}
	477	#endif
	478
2d59ec84	479	#if CONFIG_IS_ENABLED(DFU_SF)
53b40636 MH	480	extern int dfu_fill_entity_sf(struct dfu_entity dfu, char devstr,
53b40636 MH	481	char **argv, int argc);
6f12ebf6 SW	482	#else
6f12ebf6 SW	483	static inline int dfu_fill_entity_sf(struct dfu_entity dfu, char devstr,
53b40636	484	char **argv, int argc)
6f12ebf6 SW	485	{
	486	puts("SF support not available!\n");
	487	return -1;
	488	}
	489	#endif
	490
6015af28	491	#if CONFIG_IS_ENABLED(DFU_MTD)
53b40636 MH	492	extern int dfu_fill_entity_mtd(struct dfu_entity dfu, char devstr,
53b40636 MH	493	char **argv, int argc);
6015af28 PD	494	#else
6015af28 PD	495	static inline int dfu_fill_entity_mtd(struct dfu_entity dfu, char devstr,
53b40636	496	char **argv, int argc)
6015af28 PD	497	{
	498	puts("MTD support not available!\n");
	499	return -1;
	500	}
	501	#endif
	502
bcd41107	503	#if CONFIG_IS_ENABLED(DFU_VIRT)
53b40636 MH	504	int dfu_fill_entity_virt(struct dfu_entity dfu, char devstr,
53b40636 MH	505	char **argv, int argc);
ec44cace PD	506	int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
	507	void buf, long len);
	508	int dfu_get_medium_size_virt(struct dfu_entity dfu, u64 size);
	509	int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
	510	void buf, long len);
	511	#else
	512	static inline int dfu_fill_entity_virt(struct dfu_entity dfu, char devstr,
53b40636	513	char **argv, int argc)
ec44cace PD	514	{
	515	puts("VIRT support not available!\n");
	516	return -1;
	517	}
	518	#endif
	519
c533f94c MS	520	extern bool dfu_reinit_needed;
c533f94c MS	521
f234566e	522	#if CONFIG_IS_ENABLED(DFU_WRITE_ALT)
2d50d68a	523	/**
045fd8b1 AT	524	* dfu_write_by_name() - write data to DFU medium
	525	* @dfu_entity_name: Name of DFU entity to write
	526	* @addr: Address of data buffer to write
	527	* @len: Number of bytes
	528	* @interface: Destination DFU medium (e.g. "mmc")
	529	* @devstring: Instance number of destination DFU medium (e.g. "1")
2d50d68a	530	*
045fd8b1 AT	531	* This function is storing data received on DFU supported medium which
045fd8b1 AT	532	* is specified by @dfu_entity_name.
2d50d68a	533	*
045fd8b1	534	* Return: 0 - on success, error code - otherwise
2d50d68a	535	*/
1c2d1293	536	int dfu_write_by_name(char dfu_entity_name, void addr,
045fd8b1	537	unsigned int len, char interface, char devstring);
f234566e AT	538
	539	/**
	540	* dfu_write_by_alt() - write data to DFU medium
	541	* @dfu_alt_num: DFU alt setting number
	542	* @addr: Address of data buffer to write
	543	* @len: Number of bytes
	544	* @interface: Destination DFU medium (e.g. "mmc")
	545	* @devstring: Instance number of destination DFU medium (e.g. "1")
	546	*
	547	* This function is storing data received on DFU supported medium which
	548	* is specified by @dfu_alt_name.
	549	*
	550	* Return: 0 - on success, error code - otherwise
	551	*/
	552	int dfu_write_by_alt(int dfu_alt_num, void *addr, unsigned int len,
	553	char interface, char devstring);
2d50d68a	554	#else
1c2d1293	555	static inline int dfu_write_by_name(char dfu_entity_name, void addr,
045fd8b1 AT	556	unsigned int len, char *interface,
045fd8b1 AT	557	char *devstring)
2d50d68a	558	{
045fd8b1	559	puts("write support for DFU not available!\n");
2d50d68a LM	560	return -ENOSYS;
2d50d68a LM	561	}
f234566e AT	562
	563	static inline int dfu_write_by_alt(int dfu_alt_num, void *addr,
	564	unsigned int len, char *interface,
	565	char *devstring)
	566	{
	567	puts("write support for DFU not available!\n");
	568	return -ENOSYS;
	569	}
2d50d68a LM	570	#endif
2d50d68a LM	571
a6921adc	572	int dfu_add(struct usb_configuration *c);
f22b11c1	573	#endif /* __DFU_ENTITY_H_ */