]>
git.ipfire.org Git - thirdparty/u-boot.git/blob - include/dfu.h
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 void dfu_trigger_reset(void);
175 int dfu_get_alt(char *name
);
176 int dfu_init_env_entities(char *interface
, char *devstr
);
177 unsigned char *dfu_get_buf(struct dfu_entity
*dfu
);
178 unsigned char *dfu_free_buf(void);
179 unsigned long dfu_get_buf_size(void);
180 bool dfu_usb_get_reset(void);
182 int dfu_read(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
183 int dfu_write(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
184 int dfu_flush(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
187 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
188 * It should be NULL when not used.
190 extern struct dfu_entity
*dfu_defer_flush
;
192 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
194 * @return - value of the dfu_defer_flush pointer
196 static inline struct dfu_entity
*dfu_get_defer_flush(void)
198 return dfu_defer_flush
;
202 * dfu_set_defer_flush - set the dfu_defer_flush pointer
204 * @param dfu - pointer to the dfu_entity, which should be written
206 static inline void dfu_set_defer_flush(struct dfu_entity
*dfu
)
208 dfu_defer_flush
= dfu
;
212 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
214 * This function adds support for writing data starting from fixed memory
215 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
217 * @param dfu - dfu entity to which we want to store data
218 * @param buf - fixed memory addres from where data starts
219 * @param size - number of bytes to write
221 * @return - 0 on success, other value on failure
223 int dfu_write_from_mem_addr(struct dfu_entity
*dfu
, void *buf
, int size
);
225 /* Device specific */
226 #if CONFIG_IS_ENABLED(DFU_MMC)
227 extern int dfu_fill_entity_mmc(struct dfu_entity
*dfu
, char *devstr
, char *s
);
229 static inline int dfu_fill_entity_mmc(struct dfu_entity
*dfu
, char *devstr
,
232 puts("MMC support not available!\n");
237 #if CONFIG_IS_ENABLED(DFU_NAND)
238 extern int dfu_fill_entity_nand(struct dfu_entity
*dfu
, char *devstr
, char *s
);
240 static inline int dfu_fill_entity_nand(struct dfu_entity
*dfu
, char *devstr
,
243 puts("NAND support not available!\n");
248 #if CONFIG_IS_ENABLED(DFU_RAM)
249 extern int dfu_fill_entity_ram(struct dfu_entity
*dfu
, char *devstr
, char *s
);
251 static inline int dfu_fill_entity_ram(struct dfu_entity
*dfu
, char *devstr
,
254 puts("RAM support not available!\n");
259 #if CONFIG_IS_ENABLED(DFU_SF)
260 extern int dfu_fill_entity_sf(struct dfu_entity
*dfu
, char *devstr
, char *s
);
262 static inline int dfu_fill_entity_sf(struct dfu_entity
*dfu
, char *devstr
,
265 puts("SF support not available!\n");
270 #if CONFIG_IS_ENABLED(DFU_MTD)
271 int dfu_fill_entity_mtd(struct dfu_entity
*dfu
, char *devstr
, char *s
);
273 static inline int dfu_fill_entity_mtd(struct dfu_entity
*dfu
, char *devstr
,
276 puts("MTD support not available!\n");
281 #ifdef CONFIG_DFU_VIRT
282 int dfu_fill_entity_virt(struct dfu_entity
*dfu
, char *devstr
, char *s
);
283 int dfu_write_medium_virt(struct dfu_entity
*dfu
, u64 offset
,
284 void *buf
, long *len
);
285 int dfu_get_medium_size_virt(struct dfu_entity
*dfu
, u64
*size
);
286 int dfu_read_medium_virt(struct dfu_entity
*dfu
, u64 offset
,
287 void *buf
, long *len
);
289 static inline int dfu_fill_entity_virt(struct dfu_entity
*dfu
, char *devstr
,
292 puts("VIRT support not available!\n");
298 * dfu_tftp_write - Write TFTP data to DFU medium
300 * This function is storing data received via TFTP on DFU supported medium.
302 * @param dfu_entity_name - name of DFU entity to write
303 * @param addr - address of data buffer to write
304 * @param len - number of bytes
305 * @param interface - destination DFU medium (e.g. "mmc")
306 * @param devstring - instance number of destination DFU medium (e.g. "1")
308 * @return 0 on success, otherwise error code
310 #if CONFIG_IS_ENABLED(DFU_TFTP)
311 int dfu_tftp_write(char *dfu_entity_name
, unsigned int addr
, unsigned int len
,
312 char *interface
, char *devstring
);
314 static inline int dfu_tftp_write(char *dfu_entity_name
, unsigned int addr
,
315 unsigned int len
, char *interface
,
318 puts("TFTP write support for DFU not available!\n");
323 int dfu_add(struct usb_configuration
*c
);
324 #endif /* __DFU_ENTITY_H_ */