1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3 * dfu.h - DFU flashable area description
4 *
5 * Copyright (C) 2012 Samsung Electronics
6 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
7 * Lukasz Majewski <l.majewski@samsung.com>
8 */
9
10 #ifndef __DFU_ENTITY_H_
11 #define __DFU_ENTITY_H_
12
13 #include <common.h>
14 #include <linux/list.h>
15 #include <mmc.h>
16 #include <spi_flash.h>
17 #include <linux/usb/composite.h>
18
19 enum dfu_device_type {
20 DFU_DEV_MMC = 1,
21 DFU_DEV_ONENAND,
22 DFU_DEV_NAND,
23 DFU_DEV_RAM,
24 DFU_DEV_SF,
25 };
26
27 enum dfu_layout {
28 DFU_RAW_ADDR = 1,
29 DFU_FS_FAT,
30 DFU_FS_EXT2,
31 DFU_FS_EXT3,
32 DFU_FS_EXT4,
33 DFU_RAM_ADDR,
34 };
35
36 enum dfu_op {
37 DFU_OP_READ = 1,
38 DFU_OP_WRITE,
39 DFU_OP_SIZE,
40 };
41
42 struct mmc_internal_data {
43 int dev_num;
44
45 /* RAW programming */
46 unsigned int lba_start;
47 unsigned int lba_size;
48 unsigned int lba_blk_size;
49
50 /* eMMC HW partition access */
51 int hw_partition;
52
53 /* FAT/EXT */
54 unsigned int dev;
55 unsigned int part;
56 };
57
58 struct nand_internal_data {
59 /* RAW programming */
60 u64 start;
61 u64 size;
62
63 unsigned int dev;
64 unsigned int part;
65 /* for nand/ubi use */
66 unsigned int ubi;
67 };
68
69 struct ram_internal_data {
70 void *start;
71 unsigned int size;
72 };
73
74 struct sf_internal_data {
75 struct spi_flash *dev;
76
77 /* RAW programming */
78 u64 start;
79 u64 size;
80 };
81
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 */
85 #endif
86 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
87 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
88 #endif
89 #ifndef DFU_DEFAULT_POLL_TIMEOUT
90 #define DFU_DEFAULT_POLL_TIMEOUT 0
91 #endif
92 #ifndef DFU_MANIFEST_POLL_TIMEOUT
93 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
94 #endif
95
96 struct dfu_entity {
97 char name[DFU_NAME_SIZE];
98 int alt;
99 void *dev_private;
100 enum dfu_device_type dev_type;
101 enum dfu_layout layout;
102 unsigned long max_buf_size;
103
104 union {
105 struct mmc_internal_data mmc;
106 struct nand_internal_data nand;
107 struct ram_internal_data ram;
108 struct sf_internal_data sf;
109 } data;
110
111 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
112
113 int (*read_medium)(struct dfu_entity *dfu,
114 u64 offset, void *buf, long *len);
115
116 int (*write_medium)(struct dfu_entity *dfu,
117 u64 offset, void *buf, long *len);
118
119 int (*flush_medium)(struct dfu_entity *dfu);
120 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
121
122 void (*free_entity)(struct dfu_entity *dfu);
123
124 struct list_head list;
125
126 /* on the fly state */
127 u32 crc;
128 u64 offset;
129 int i_blk_seq_num;
130 u8 *i_buf;
131 u8 *i_buf_start;
132 u8 *i_buf_end;
133 u64 r_left;
134 long b_left;
135
136 u32 bad_skip; /* for nand use */
137
138 unsigned int inited:1;
139 };
140
141 #ifdef CONFIG_SET_DFU_ALT_INFO
142 void set_dfu_alt_info(char *interface, char *devstr);
143 #endif
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);
159
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);
163
164 /*
165 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
166 * It should be NULL when not used.
167 */
168 extern struct dfu_entity *dfu_defer_flush;
169 /**
170 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
171 *
172 * @return - value of the dfu_defer_flush pointer
173 */
dfu_get_defer_flush(void)174 static inline struct dfu_entity *dfu_get_defer_flush(void)
175 {
176 return dfu_defer_flush;
177 }
178
179 /**
180 * dfu_set_defer_flush - set the dfu_defer_flush pointer
181 *
182 * @param dfu - pointer to the dfu_entity, which should be written
183 */
dfu_set_defer_flush(struct dfu_entity * dfu)184 static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
185 {
186 dfu_defer_flush = dfu;
187 }
188
189 /**
190 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
191 *
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)
194 *
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
198 *
199 * @return - 0 on success, other value on failure
200 */
201 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
202
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);
206 #else
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,
208 char *s)
209 {
210 puts("MMC support not available!\n");
211 return -1;
212 }
213 #endif
214
215 #if CONFIG_IS_ENABLED(DFU_NAND)
216 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
217 #else
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,
219 char *s)
220 {
221 puts("NAND support not available!\n");
222 return -1;
223 }
224 #endif
225
226 #if CONFIG_IS_ENABLED(DFU_RAM)
227 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
228 #else
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,
230 char *s)
231 {
232 puts("RAM support not available!\n");
233 return -1;
234 }
235 #endif
236
237 #if CONFIG_IS_ENABLED(DFU_SF)
238 extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
239 #else
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,
241 char *s)
242 {
243 puts("SF support not available!\n");
244 return -1;
245 }
246 #endif
247
248 /**
249 * dfu_tftp_write - Write TFTP data to DFU medium
250 *
251 * This function is storing data received via TFTP on DFU supported medium.
252 *
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")
258 *
259 * @return 0 on success, otherwise error code
260 */
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);
264 #else
dfu_tftp_write(char * dfu_entity_name,unsigned int addr,unsigned int len,char * interface,char * devstring)265 static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
266 unsigned int len, char *interface,
267 char *devstring)
268 {
269 puts("TFTP write support for DFU not available!\n");
270 return -ENOSYS;
271 }
272 #endif
273
274 int dfu_add(struct usb_configuration *c);
275 #endif /* __DFU_ENTITY_H_ */
276