]>
git.ipfire.org Git - people/ms/u-boot.git/blob - include/dfu.h
2 * dfu.h - DFU flashable area description
4 * Copyright (C) 2012 Samsung Electronics
5 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
6 * Lukasz Majewski <l.majewski@samsung.com>
8 * SPDX-License-Identifier: GPL-2.0+
11 #ifndef __DFU_ENTITY_H_
12 #define __DFU_ENTITY_H_
15 #include <linux/list.h>
17 #include <spi_flash.h>
18 #include <linux/usb/composite.h>
20 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 nand_internal_data
{
66 /* for nand/ubi use */
70 struct ram_internal_data
{
75 struct sf_internal_data
{
76 struct spi_flash
*dev
;
83 #define DFU_NAME_SIZE 32
84 #define DFU_CMD_BUF_SIZE 128
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 long (*get_medium_size
)(struct dfu_entity
*dfu
);
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_config_entities(char *s
, char *interface
, char *devstr
);
147 void dfu_free_entities(void);
148 void dfu_show_entities(void);
149 int dfu_get_alt_number(void);
150 const char *dfu_get_dev_type(enum dfu_device_type t
);
151 const char *dfu_get_layout(enum dfu_layout l
);
152 struct dfu_entity
*dfu_get_entity(int alt
);
153 char *dfu_extract_token(char** e
, int *n
);
154 void dfu_trigger_reset(void);
155 int dfu_get_alt(char *name
);
156 int dfu_init_env_entities(char *interface
, char *devstr
);
157 unsigned char *dfu_get_buf(struct dfu_entity
*dfu
);
158 unsigned char *dfu_free_buf(void);
159 unsigned long dfu_get_buf_size(void);
160 bool dfu_usb_get_reset(void);
162 int dfu_read(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
163 int dfu_write(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
164 int dfu_flush(struct dfu_entity
*de
, void *buf
, int size
, int blk_seq_num
);
167 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
168 * It should be NULL when not used.
170 extern struct dfu_entity
*dfu_defer_flush
;
172 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
174 * @return - value of the dfu_defer_flush pointer
176 static inline struct dfu_entity
*dfu_get_defer_flush(void)
178 return dfu_defer_flush
;
182 * dfu_set_defer_flush - set the dfu_defer_flush pointer
184 * @param dfu - pointer to the dfu_entity, which should be written
186 static inline void dfu_set_defer_flush(struct dfu_entity
*dfu
)
188 dfu_defer_flush
= dfu
;
192 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
194 * This function adds support for writing data starting from fixed memory
195 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
197 * @param dfu - dfu entity to which we want to store data
198 * @param buf - fixed memory addres from where data starts
199 * @param size - number of bytes to write
201 * @return - 0 on success, other value on failure
203 int dfu_write_from_mem_addr(struct dfu_entity
*dfu
, void *buf
, int size
);
205 /* Device specific */
206 #ifdef CONFIG_DFU_MMC
207 extern int dfu_fill_entity_mmc(struct dfu_entity
*dfu
, char *devstr
, char *s
);
209 static inline int dfu_fill_entity_mmc(struct dfu_entity
*dfu
, char *devstr
,
212 puts("MMC support not available!\n");
217 #ifdef CONFIG_DFU_NAND
218 extern int dfu_fill_entity_nand(struct dfu_entity
*dfu
, char *devstr
, char *s
);
220 static inline int dfu_fill_entity_nand(struct dfu_entity
*dfu
, char *devstr
,
223 puts("NAND support not available!\n");
228 #ifdef CONFIG_DFU_RAM
229 extern int dfu_fill_entity_ram(struct dfu_entity
*dfu
, char *devstr
, char *s
);
231 static inline int dfu_fill_entity_ram(struct dfu_entity
*dfu
, char *devstr
,
234 puts("RAM support not available!\n");
240 extern int dfu_fill_entity_sf(struct dfu_entity
*dfu
, char *devstr
, char *s
);
242 static inline int dfu_fill_entity_sf(struct dfu_entity
*dfu
, char *devstr
,
245 puts("SF support not available!\n");
251 * dfu_tftp_write - Write TFTP data to DFU medium
253 * This function is storing data received via TFTP on DFU supported medium.
255 * @param dfu_entity_name - name of DFU entity to write
256 * @param addr - address of data buffer to write
257 * @param len - number of bytes
258 * @param interface - destination DFU medium (e.g. "mmc")
259 * @param devstring - instance number of destination DFU medium (e.g. "1")
261 * @return 0 on success, otherwise error code
263 #ifdef CONFIG_DFU_TFTP
264 int dfu_tftp_write(char *dfu_entity_name
, unsigned int addr
, unsigned int len
,
265 char *interface
, char *devstring
);
267 static inline int dfu_tftp_write(char *dfu_entity_name
, unsigned int addr
,
268 unsigned int len
, char *interface
,
271 puts("TFTP write support for DFU not available!\n");
276 int dfu_add(struct usb_configuration
*c
);
277 #endif /* __DFU_ENTITY_H_ */