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 {
42 struct mmc_internal_data {
46 unsigned int lba_start;
47 unsigned int lba_size;
48 unsigned int lba_blk_size;
50 /* eMMC HW partition access */
58 struct nand_internal_data {
65 /* for nand/ubi use */
69 struct ram_internal_data {
74 struct sf_internal_data {
75 struct spi_flash *dev;
84 #define DFU_NAME_SIZE 32
85 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
86 #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
88 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
89 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
91 #ifndef DFU_DEFAULT_POLL_TIMEOUT
92 #define DFU_DEFAULT_POLL_TIMEOUT 0
94 #ifndef DFU_MANIFEST_POLL_TIMEOUT
95 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
99 char name[DFU_NAME_SIZE];
102 enum dfu_device_type dev_type;
103 enum dfu_layout layout;
104 unsigned long max_buf_size;
107 struct mmc_internal_data mmc;
108 struct nand_internal_data nand;
109 struct ram_internal_data ram;
110 struct sf_internal_data sf;
113 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
115 int (*read_medium)(struct dfu_entity *dfu,
116 u64 offset, void *buf, long *len);
118 int (*write_medium)(struct dfu_entity *dfu,
119 u64 offset, void *buf, long *len);
121 int (*flush_medium)(struct dfu_entity *dfu);
122 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
124 void (*free_entity)(struct dfu_entity *dfu);
126 struct list_head list;
128 /* on the fly state */
138 u32 bad_skip; /* for nand use */
140 unsigned int inited:1;
143 #ifdef CONFIG_SET_DFU_ALT_INFO
144 void set_dfu_alt_info(char *interface, char *devstr);
146 int dfu_alt_init(int num, struct dfu_entity **dfu);
147 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
148 int dfu_config_entities(char *s, char *interface, char *devstr);
149 void dfu_free_entities(void);
150 void dfu_show_entities(void);
151 int dfu_get_alt_number(void);
152 const char *dfu_get_dev_type(enum dfu_device_type t);
153 const char *dfu_get_layout(enum dfu_layout l);
154 struct dfu_entity *dfu_get_entity(int alt);
155 char *dfu_extract_token(char** e, int *n);
156 void dfu_trigger_reset(void);
157 int dfu_get_alt(char *name);
158 int dfu_init_env_entities(char *interface, char *devstr);
159 unsigned char *dfu_get_buf(struct dfu_entity *dfu);
160 unsigned char *dfu_free_buf(void);
161 unsigned long dfu_get_buf_size(void);
162 bool dfu_usb_get_reset(void);
164 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
165 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
166 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
169 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
170 * It should be NULL when not used.
172 extern struct dfu_entity *dfu_defer_flush;
174 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
176 * @return - value of the dfu_defer_flush pointer
178 static inline struct dfu_entity *dfu_get_defer_flush(void)
180 return dfu_defer_flush;
184 * dfu_set_defer_flush - set the dfu_defer_flush pointer
186 * @param dfu - pointer to the dfu_entity, which should be written
188 static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
190 dfu_defer_flush = dfu;
194 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
196 * This function adds support for writing data starting from fixed memory
197 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
199 * @param dfu - dfu entity to which we want to store data
200 * @param buf - fixed memory addres from where data starts
201 * @param size - number of bytes to write
203 * @return - 0 on success, other value on failure
205 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
207 /* Device specific */
208 #if CONFIG_IS_ENABLED(DFU_MMC)
209 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
211 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
214 puts("MMC support not available!\n");
219 #if CONFIG_IS_ENABLED(DFU_NAND)
220 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
222 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
225 puts("NAND support not available!\n");
230 #if CONFIG_IS_ENABLED(DFU_RAM)
231 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
233 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
236 puts("RAM support not available!\n");
241 #if CONFIG_IS_ENABLED(DFU_SF)
242 extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
244 static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
247 puts("SF support not available!\n");
253 * dfu_tftp_write - Write TFTP data to DFU medium
255 * This function is storing data received via TFTP on DFU supported medium.
257 * @param dfu_entity_name - name of DFU entity to write
258 * @param addr - address of data buffer to write
259 * @param len - number of bytes
260 * @param interface - destination DFU medium (e.g. "mmc")
261 * @param devstring - instance number of destination DFU medium (e.g. "1")
263 * @return 0 on success, otherwise error code
265 #if CONFIG_IS_ENABLED(DFU_TFTP)
266 int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
267 char *interface, char *devstring);
269 static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
270 unsigned int len, char *interface,
273 puts("TFTP write support for DFU not available!\n");
278 int dfu_add(struct usb_configuration *c);
279 #endif /* __DFU_ENTITY_H_ */