dfu.h 6.59 KB
Newer Older
1 2 3 4 5 6 7
/*
 * dfu.h - DFU flashable area description
 *
 * Copyright (C) 2012 Samsung Electronics
 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
 *	    Lukasz Majewski <l.majewski@samsung.com>
 *
8
 * SPDX-License-Identifier:	GPL-2.0+
9 10 11 12 13 14 15 16
 */

#ifndef __DFU_ENTITY_H_
#define __DFU_ENTITY_H_

#include <common.h>
#include <linux/list.h>
#include <mmc.h>
Stephen Warren's avatar
Stephen Warren committed
17
#include <spi_flash.h>
18
#include <linux/usb/composite.h>
19 20 21 22 23

enum dfu_device_type {
	DFU_DEV_MMC = 1,
	DFU_DEV_ONENAND,
	DFU_DEV_NAND,
Afzal Mohammed's avatar
Afzal Mohammed committed
24
	DFU_DEV_RAM,
Stephen Warren's avatar
Stephen Warren committed
25
	DFU_DEV_SF,
26 27 28 29 30 31 32 33
};

enum dfu_layout {
	DFU_RAW_ADDR = 1,
	DFU_FS_FAT,
	DFU_FS_EXT2,
	DFU_FS_EXT3,
	DFU_FS_EXT4,
Afzal Mohammed's avatar
Afzal Mohammed committed
34
	DFU_RAM_ADDR,
35 36
};

37 38 39
enum dfu_op {
	DFU_OP_READ = 1,
	DFU_OP_WRITE,
40
	DFU_OP_SIZE,
41 42
};

43
struct mmc_internal_data {
44 45
	int dev_num;

46 47 48 49 50
	/* RAW programming */
	unsigned int lba_start;
	unsigned int lba_size;
	unsigned int lba_blk_size;

51 52 53
	/* eMMC HW partition access */
	int hw_partition;

54 55 56 57 58
	/* FAT/EXT */
	unsigned int dev;
	unsigned int part;
};

59 60 61 62 63 64 65
struct nand_internal_data {
	/* RAW programming */
	u64 start;
	u64 size;

	unsigned int dev;
	unsigned int part;
66 67
	/* for nand/ubi use */
	unsigned int ubi;
68 69
};

Afzal Mohammed's avatar
Afzal Mohammed committed
70 71 72 73 74
struct ram_internal_data {
	void		*start;
	unsigned int	size;
};

Stephen Warren's avatar
Stephen Warren committed
75 76 77 78 79 80 81 82
struct sf_internal_data {
	struct spi_flash *dev;

	/* RAW programming */
	u64 start;
	u64 size;
};

83 84
#define DFU_NAME_SIZE			32
#define DFU_CMD_BUF_SIZE		128
85 86 87
#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
#define CONFIG_SYS_DFU_DATA_BUF_SIZE		(1024*1024*8)	/* 8 MiB */
#endif
88
#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
89
#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
90
#endif
91 92 93
#ifndef DFU_DEFAULT_POLL_TIMEOUT
#define DFU_DEFAULT_POLL_TIMEOUT 0
#endif
94 95 96
#ifndef DFU_MANIFEST_POLL_TIMEOUT
#define DFU_MANIFEST_POLL_TIMEOUT	DFU_DEFAULT_POLL_TIMEOUT
#endif
97 98 99 100 101 102 103

struct dfu_entity {
	char			name[DFU_NAME_SIZE];
	int                     alt;
	void                    *dev_private;
	enum dfu_device_type    dev_type;
	enum dfu_layout         layout;
104
	unsigned long           max_buf_size;
105 106 107

	union {
		struct mmc_internal_data mmc;
108
		struct nand_internal_data nand;
Afzal Mohammed's avatar
Afzal Mohammed committed
109
		struct ram_internal_data ram;
Stephen Warren's avatar
Stephen Warren committed
110
		struct sf_internal_data sf;
111 112
	} data;

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

115 116 117 118 119 120 121
	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);
122
	unsigned int (*poll_timeout)(struct dfu_entity *dfu);
123

124 125
	void (*free_entity)(struct dfu_entity *dfu);

126
	struct list_head list;
127 128 129 130 131 132 133 134 135 136 137

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

138 139
	u32 bad_skip;	/* for nand use */

140
	unsigned int inited:1;
141 142
};

143 144 145
#ifdef CONFIG_SET_DFU_ALT_INFO
void set_dfu_alt_info(char *interface, char *devstr);
#endif
146
int dfu_config_entities(char *s, char *interface, char *devstr);
147 148 149 150 151 152 153
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);
154
void dfu_trigger_reset(void);
155
int dfu_get_alt(char *name);
156
int dfu_init_env_entities(char *interface, char *devstr);
157
unsigned char *dfu_get_buf(struct dfu_entity *dfu);
158
unsigned char *dfu_free_buf(void);
159
unsigned long dfu_get_buf_size(void);
160
bool dfu_usb_get_reset(void);
161 162 163

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);
164
int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
165

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/*
 * 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;
}

191 192 193 194 195 196 197 198 199 200 201 202 203 204
/**
 * 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);

205 206
/* Device specific */
#ifdef CONFIG_DFU_MMC
207
extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
208
#else
209 210
static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
				      char *s)
211 212 213 214 215
{
	puts("MMC support not available!\n");
	return -1;
}
#endif
216 217

#ifdef CONFIG_DFU_NAND
218
extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
219
#else
220 221
static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
				       char *s)
222 223 224 225 226 227
{
	puts("NAND support not available!\n");
	return -1;
}
#endif

Afzal Mohammed's avatar
Afzal Mohammed committed
228
#ifdef CONFIG_DFU_RAM
229
extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
Afzal Mohammed's avatar
Afzal Mohammed committed
230
#else
231 232
static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
				      char *s)
Afzal Mohammed's avatar
Afzal Mohammed committed
233 234 235 236 237 238
{
	puts("RAM support not available!\n");
	return -1;
}
#endif

Stephen Warren's avatar
Stephen Warren committed
239 240 241 242 243 244 245 246 247 248 249
#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

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
/**
 * 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
 */
#ifdef CONFIG_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

276
int dfu_add(struct usb_configuration *c);
277
#endif /* __DFU_ENTITY_H_ */