]>
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
{
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
;
82 #define DFU_NAME_SIZE 32
83 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
84 #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
86 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
87 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
89 #ifndef DFU_DEFAULT_POLL_TIMEOUT
90 #define DFU_DEFAULT_POLL_TIMEOUT 0
92 #ifndef DFU_MANIFEST_POLL_TIMEOUT
93 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
97 char name
[DFU_NAME_SIZE
];
100 enum dfu_device_type dev_type
;
101 enum dfu_layout layout
;
102 unsigned long max_buf_size
;
105 struct mmc_internal_data mmc
;
106 struct nand_internal_data nand
;
107 struct ram_internal_data ram
;
108 struct sf_internal_data sf
;
111 int (*get_medium_size
)(struct dfu_entity
*dfu
, u64
*size
);
113 int (*read_medium
)(struct dfu_entity
*dfu
,
114 u64 offset
, void *buf
, long *len
);
116 int (*write_medium
)(struct dfu_entity
*dfu
,
117 u64 offset
, void *buf
, long *len
);
119 int (*flush_medium
)(struct dfu_entity
*dfu
);
120 unsigned int (*poll_timeout
)(struct dfu_entity
*dfu
);
122 void (*free_entity
)(struct dfu_entity
*dfu
);
124 struct list_head list
;
126 /* on the fly state */
136 u32 bad_skip
; /* for nand use */
138 unsigned int inited
:1;
141 #ifdef CONFIG_SET_DFU_ALT_INFO
142 void set_dfu_alt_info(char *interface
, char *devstr
);
144 int dfu_config_entities(char *s
, char *interface
, char *devstr
);
145 void dfu_free_entities(void);
146 void dfu_show_entities(void);
147 int dfu_get_alt_number(void);
148 const char *dfu_get_dev_type(enum dfu_device_type t
);
149 const char *dfu_get_layout(enum dfu_layout l
);
150 struct dfu_entity
*dfu_get_entity(int alt
);
151 char *dfu_extract_token(char** e
, int *n
);
152 void dfu_trigger_reset(void);
153 int dfu_get_alt(char *name
);
154 int dfu_init_env_entities(char *interface
, char *devstr
);
155 unsigned char *dfu_get_buf(struct dfu_entity
*dfu
);
156 unsigned char *dfu_free_buf(void);
157 unsigned long dfu_get_buf_size(void);
158 bool dfu_usb_get_reset(void);
160 int dfu_read(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
161 int dfu_write(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
162 int dfu_flush(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
165 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
166 * It should be NULL when not used.
168 extern struct dfu_entity
*dfu_defer_flush
;
170 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
172 * @return - value of the dfu_defer_flush pointer
174 static inline struct dfu_entity
*dfu_get_defer_flush(void)
176 return dfu_defer_flush
;
180 * dfu_set_defer_flush - set the dfu_defer_flush pointer
182 * @param dfu - pointer to the dfu_entity, which should be written
184 static inline void dfu_set_defer_flush(struct dfu_entity
*dfu
)
186 dfu_defer_flush
= dfu
;
190 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
192 * This function adds support for writing data starting from fixed memory
193 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
195 * @param dfu - dfu entity to which we want to store data
196 * @param buf - fixed memory addres from where data starts
197 * @param size - number of bytes to write
199 * @return - 0 on success, other value on failure
201 int dfu_write_from_mem_addr(struct dfu_entity
*dfu
, void *buf
, int size
);
203 /* Device specific */
204 #if CONFIG_IS_ENABLED(DFU_MMC)
205 extern int dfu_fill_entity_mmc(struct dfu_entity
*dfu
, char *devstr
, char *s
);
207 static inline int dfu_fill_entity_mmc(struct dfu_entity
*dfu
, char *devstr
,
210 puts("MMC support not available!\n");
215 #if CONFIG_IS_ENABLED(DFU_NAND)
216 extern int dfu_fill_entity_nand(struct dfu_entity
*dfu
, char *devstr
, char *s
);
218 static inline int dfu_fill_entity_nand(struct dfu_entity
*dfu
, char *devstr
,
221 puts("NAND support not available!\n");
226 #if CONFIG_IS_ENABLED(DFU_RAM)
227 extern int dfu_fill_entity_ram(struct dfu_entity
*dfu
, char *devstr
, char *s
);
229 static inline int dfu_fill_entity_ram(struct dfu_entity
*dfu
, char *devstr
,
232 puts("RAM support not available!\n");
237 #if CONFIG_IS_ENABLED(DFU_SF)
238 extern int dfu_fill_entity_sf(struct dfu_entity
*dfu
, char *devstr
, char *s
);
240 static inline int dfu_fill_entity_sf(struct dfu_entity
*dfu
, char *devstr
,
243 puts("SF support not available!\n");
249 * dfu_tftp_write - Write TFTP data to DFU medium
251 * This function is storing data received via TFTP on DFU supported medium.
253 * @param dfu_entity_name - name of DFU entity to write
254 * @param addr - address of data buffer to write
255 * @param len - number of bytes
256 * @param interface - destination DFU medium (e.g. "mmc")
257 * @param devstring - instance number of destination DFU medium (e.g. "1")
259 * @return 0 on success, otherwise error code
261 #if CONFIG_IS_ENABLED(DFU_TFTP)
262 int dfu_tftp_write(char *dfu_entity_name
, unsigned int addr
, unsigned int len
,
263 char *interface
, char *devstring
);
265 static inline int dfu_tftp_write(char *dfu_entity_name
, unsigned int addr
,
266 unsigned int len
, char *interface
,
269 puts("TFTP write support for DFU not available!\n");
274 int dfu_add(struct usb_configuration
*c
);
275 #endif /* __DFU_ENTITY_H_ */