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 {
44 struct mmc_internal_data {
48 unsigned int lba_start;
49 unsigned int lba_size;
50 unsigned int lba_blk_size;
52 /* eMMC HW partition access */
60 struct mtd_internal_data {
61 struct mtd_info *info;
66 /* for ubi partition */
70 struct nand_internal_data {
77 /* for nand/ubi use */
81 struct ram_internal_data {
86 struct sf_internal_data {
87 struct spi_flash *dev;
96 struct virt_internal_data {
100 #define DFU_NAME_SIZE 32
101 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
102 #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
104 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
105 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
107 #ifndef DFU_DEFAULT_POLL_TIMEOUT
108 #define DFU_DEFAULT_POLL_TIMEOUT 0
110 #ifndef DFU_MANIFEST_POLL_TIMEOUT
111 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
115 char name[DFU_NAME_SIZE];
118 enum dfu_device_type dev_type;
119 enum dfu_layout layout;
120 unsigned long max_buf_size;
123 struct mmc_internal_data mmc;
124 struct mtd_internal_data mtd;
125 struct nand_internal_data nand;
126 struct ram_internal_data ram;
127 struct sf_internal_data sf;
128 struct virt_internal_data virt;
131 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
133 int (*read_medium)(struct dfu_entity *dfu,
134 u64 offset, void *buf, long *len);
136 int (*write_medium)(struct dfu_entity *dfu,
137 u64 offset, void *buf, long *len);
139 int (*flush_medium)(struct dfu_entity *dfu);
140 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
142 void (*free_entity)(struct dfu_entity *dfu);
144 struct list_head list;
146 /* on the fly state */
156 u32 bad_skip; /* for nand use */
158 unsigned int inited:1;
161 #ifdef CONFIG_SET_DFU_ALT_INFO
162 void set_dfu_alt_info(char *interface, char *devstr);
164 int dfu_alt_init(int num, struct dfu_entity **dfu);
165 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
166 int dfu_config_entities(char *s, char *interface, char *devstr);
167 void dfu_free_entities(void);
168 void dfu_show_entities(void);
169 int dfu_get_alt_number(void);
170 const char *dfu_get_dev_type(enum dfu_device_type t);
171 const char *dfu_get_layout(enum dfu_layout l);
172 struct dfu_entity *dfu_get_entity(int alt);
173 char *dfu_extract_token(char** e, int *n);
174 int dfu_get_alt(char *name);
175 int dfu_init_env_entities(char *interface, char *devstr);
176 unsigned char *dfu_get_buf(struct dfu_entity *dfu);
177 unsigned char *dfu_free_buf(void);
178 unsigned long dfu_get_buf_size(void);
179 bool dfu_usb_get_reset(void);
181 #ifdef CONFIG_DFU_TIMEOUT
182 unsigned long dfu_get_timeout(void);
183 void dfu_set_timeout(unsigned long);
186 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
187 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
188 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
191 * dfu_initiated_callback - weak callback called on DFU transaction start
193 * It is a callback function called by DFU stack when a DFU transaction is
194 * initiated. This function allows to manage some board specific behavior on
197 * @param dfu - pointer to the dfu_entity, which should be initialized
200 void dfu_initiated_callback(struct dfu_entity *dfu);
202 * dfu_flush_callback - weak callback called at the end of the DFU write
204 * It is a callback function called by DFU stack after DFU manifestation.
205 * This function allows to manage some board specific behavior on DFU targets
207 * @param dfu - pointer to the dfu_entity, which should be flushed
210 void dfu_flush_callback(struct dfu_entity *dfu);
212 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
213 void dfu_transaction_cleanup(struct dfu_entity *dfu);
216 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
217 * It should be NULL when not used.
219 extern struct dfu_entity *dfu_defer_flush;
221 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
223 * @return - value of the dfu_defer_flush pointer
225 static inline struct dfu_entity *dfu_get_defer_flush(void)
227 return dfu_defer_flush;
231 * dfu_set_defer_flush - set the dfu_defer_flush pointer
233 * @param dfu - pointer to the dfu_entity, which should be written
235 static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
237 dfu_defer_flush = dfu;
241 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
243 * This function adds support for writing data starting from fixed memory
244 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
246 * @param dfu - dfu entity to which we want to store data
247 * @param buf - fixed memory addres from where data starts
248 * @param size - number of bytes to write
250 * @return - 0 on success, other value on failure
252 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
254 /* Device specific */
255 #if CONFIG_IS_ENABLED(DFU_MMC)
256 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
258 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
261 puts("MMC support not available!\n");
266 #if CONFIG_IS_ENABLED(DFU_NAND)
267 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
269 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
272 puts("NAND support not available!\n");
277 #if CONFIG_IS_ENABLED(DFU_RAM)
278 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
280 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
283 puts("RAM support not available!\n");
288 #if CONFIG_IS_ENABLED(DFU_SF)
289 extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
291 static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
294 puts("SF support not available!\n");
299 #if CONFIG_IS_ENABLED(DFU_MTD)
300 int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s);
302 static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
305 puts("MTD support not available!\n");
310 #ifdef CONFIG_DFU_VIRT
311 int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, char *s);
312 int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
313 void *buf, long *len);
314 int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
315 int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
316 void *buf, long *len);
318 static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
321 puts("VIRT support not available!\n");
327 * dfu_tftp_write - Write TFTP data to DFU medium
329 * This function is storing data received via TFTP on DFU supported medium.
331 * @param dfu_entity_name - name of DFU entity to write
332 * @param addr - address of data buffer to write
333 * @param len - number of bytes
334 * @param interface - destination DFU medium (e.g. "mmc")
335 * @param devstring - instance number of destination DFU medium (e.g. "1")
337 * @return 0 on success, otherwise error code
339 #if CONFIG_IS_ENABLED(DFU_TFTP)
340 int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
341 char *interface, char *devstring);
343 static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
344 unsigned int len, char *interface,
347 puts("TFTP write support for DFU not available!\n");
352 int dfu_add(struct usb_configuration *c);
353 #endif /* __DFU_ENTITY_H_ */