1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * dfu.h - DFU flashable area description
5 * Copyright (C) 2012 Samsung Electronics
6 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
7 * Lukasz Majewski <l.majewski@samsung.com>
10 #ifndef __DFU_ENTITY_H_
11 #define __DFU_ENTITY_H_
14 #include <linux/list.h>
16 #include <spi_flash.h>
17 #include <linux/usb/composite.h>
19 enum dfu_device_type {
43 struct mmc_internal_data {
47 unsigned int lba_start;
48 unsigned int lba_size;
49 unsigned int lba_blk_size;
51 /* eMMC HW partition access */
59 struct mtd_internal_data {
60 struct mtd_info *info;
67 struct nand_internal_data {
74 /* for nand/ubi use */
78 struct ram_internal_data {
83 struct sf_internal_data {
84 struct spi_flash *dev;
93 #define DFU_NAME_SIZE 32
94 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
95 #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
97 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
98 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
100 #ifndef DFU_DEFAULT_POLL_TIMEOUT
101 #define DFU_DEFAULT_POLL_TIMEOUT 0
103 #ifndef DFU_MANIFEST_POLL_TIMEOUT
104 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
108 char name[DFU_NAME_SIZE];
111 enum dfu_device_type dev_type;
112 enum dfu_layout layout;
113 unsigned long max_buf_size;
116 struct mmc_internal_data mmc;
117 struct mtd_internal_data mtd;
118 struct nand_internal_data nand;
119 struct ram_internal_data ram;
120 struct sf_internal_data sf;
123 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
125 int (*read_medium)(struct dfu_entity *dfu,
126 u64 offset, void *buf, long *len);
128 int (*write_medium)(struct dfu_entity *dfu,
129 u64 offset, void *buf, long *len);
131 int (*flush_medium)(struct dfu_entity *dfu);
132 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
134 void (*free_entity)(struct dfu_entity *dfu);
136 struct list_head list;
138 /* on the fly state */
148 u32 bad_skip; /* for nand use */
150 unsigned int inited:1;
153 #ifdef CONFIG_SET_DFU_ALT_INFO
154 void set_dfu_alt_info(char *interface, char *devstr);
156 int dfu_alt_init(int num, struct dfu_entity **dfu);
157 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
158 int dfu_config_entities(char *s, char *interface, char *devstr);
159 void dfu_free_entities(void);
160 void dfu_show_entities(void);
161 int dfu_get_alt_number(void);
162 const char *dfu_get_dev_type(enum dfu_device_type t);
163 const char *dfu_get_layout(enum dfu_layout l);
164 struct dfu_entity *dfu_get_entity(int alt);
165 char *dfu_extract_token(char** e, int *n);
166 void dfu_trigger_reset(void);
167 int dfu_get_alt(char *name);
168 int dfu_init_env_entities(char *interface, char *devstr);
169 unsigned char *dfu_get_buf(struct dfu_entity *dfu);
170 unsigned char *dfu_free_buf(void);
171 unsigned long dfu_get_buf_size(void);
172 bool dfu_usb_get_reset(void);
174 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
175 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
176 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
179 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
180 * It should be NULL when not used.
182 extern struct dfu_entity *dfu_defer_flush;
184 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
186 * @return - value of the dfu_defer_flush pointer
188 static inline struct dfu_entity *dfu_get_defer_flush(void)
190 return dfu_defer_flush;
194 * dfu_set_defer_flush - set the dfu_defer_flush pointer
196 * @param dfu - pointer to the dfu_entity, which should be written
198 static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
200 dfu_defer_flush = dfu;
204 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
206 * This function adds support for writing data starting from fixed memory
207 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
209 * @param dfu - dfu entity to which we want to store data
210 * @param buf - fixed memory addres from where data starts
211 * @param size - number of bytes to write
213 * @return - 0 on success, other value on failure
215 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
217 /* Device specific */
218 #if CONFIG_IS_ENABLED(DFU_MMC)
219 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
221 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
224 puts("MMC support not available!\n");
229 #if CONFIG_IS_ENABLED(DFU_NAND)
230 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
232 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
235 puts("NAND support not available!\n");
240 #if CONFIG_IS_ENABLED(DFU_RAM)
241 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
243 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
246 puts("RAM support not available!\n");
251 #if CONFIG_IS_ENABLED(DFU_SF)
252 extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
254 static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
257 puts("SF support not available!\n");
262 #if CONFIG_IS_ENABLED(DFU_MTD)
263 int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s);
265 static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
268 puts("MTD support not available!\n");
274 * dfu_tftp_write - Write TFTP data to DFU medium
276 * This function is storing data received via TFTP on DFU supported medium.
278 * @param dfu_entity_name - name of DFU entity to write
279 * @param addr - address of data buffer to write
280 * @param len - number of bytes
281 * @param interface - destination DFU medium (e.g. "mmc")
282 * @param devstring - instance number of destination DFU medium (e.g. "1")
284 * @return 0 on success, otherwise error code
286 #if CONFIG_IS_ENABLED(DFU_TFTP)
287 int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
288 char *interface, char *devstring);
290 static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
291 unsigned int len, char *interface,
294 puts("TFTP write support for DFU not available!\n");
299 int dfu_add(struct usb_configuration *c);
300 #endif /* __DFU_ENTITY_H_ */