blob: 2f0e335ec09f6c2d922b8e1636a12b7361741a45 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Lukasz Majewskid311c6e2012-08-06 14:41:07 +02002/*
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>
Lukasz Majewskid311c6e2012-08-06 14:41:07 +02008 */
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>
Stephen Warren0280af72014-06-11 16:03:36 -060016#include <spi_flash.h>
Lukasz Majewskic4219462013-09-17 15:58:23 +020017#include <linux/usb/composite.h>
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020018
19enum dfu_device_type {
20 DFU_DEV_MMC = 1,
21 DFU_DEV_ONENAND,
22 DFU_DEV_NAND,
Afzal Mohammede3c687a2013-09-18 01:15:24 +053023 DFU_DEV_RAM,
Stephen Warren0280af72014-06-11 16:03:36 -060024 DFU_DEV_SF,
Patrick Delaunayf7aee232019-10-14 09:28:04 +020025 DFU_DEV_MTD,
Patrick Delaunay2111e3c2019-10-14 09:28:06 +020026 DFU_DEV_VIRT,
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020027};
28
29enum dfu_layout {
30 DFU_RAW_ADDR = 1,
31 DFU_FS_FAT,
32 DFU_FS_EXT2,
33 DFU_FS_EXT3,
34 DFU_FS_EXT4,
Afzal Mohammede3c687a2013-09-18 01:15:24 +053035 DFU_RAM_ADDR,
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020036};
37
Afzal Mohammedb9a4a6b2013-09-18 01:14:50 +053038enum dfu_op {
39 DFU_OP_READ = 1,
40 DFU_OP_WRITE,
Stephen Warren020e6f32014-06-11 12:47:27 -060041 DFU_OP_SIZE,
Afzal Mohammedb9a4a6b2013-09-18 01:14:50 +053042};
43
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020044struct mmc_internal_data {
Stephen Warren4afe50f2014-06-11 16:03:33 -060045 int dev_num;
46
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020047 /* RAW programming */
48 unsigned int lba_start;
49 unsigned int lba_size;
50 unsigned int lba_blk_size;
51
Lukasz Majewski4da65ea2014-05-09 16:58:15 +020052 /* eMMC HW partition access */
53 int hw_partition;
54
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020055 /* FAT/EXT */
56 unsigned int dev;
57 unsigned int part;
58};
59
Patrick Delaunayf7aee232019-10-14 09:28:04 +020060struct mtd_internal_data {
61 struct mtd_info *info;
62
63 /* RAW programming */
64 u64 start;
65 u64 size;
Patrick Delaunaycb47cb02019-10-14 09:28:05 +020066 /* for ubi partition */
67 unsigned int ubi;
Patrick Delaunayf7aee232019-10-14 09:28:04 +020068};
69
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +000070struct nand_internal_data {
71 /* RAW programming */
72 u64 start;
73 u64 size;
74
75 unsigned int dev;
76 unsigned int part;
Heiko Schocherad401392013-07-25 06:43:11 +020077 /* for nand/ubi use */
78 unsigned int ubi;
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +000079};
80
Afzal Mohammede3c687a2013-09-18 01:15:24 +053081struct ram_internal_data {
82 void *start;
83 unsigned int size;
84};
85
Stephen Warren0280af72014-06-11 16:03:36 -060086struct sf_internal_data {
87 struct spi_flash *dev;
88
89 /* RAW programming */
90 u64 start;
91 u64 size;
Patrick Delaunaybdc0f122019-10-14 09:28:00 +020092 /* for sf/ubi use */
93 unsigned int ubi;
Stephen Warren0280af72014-06-11 16:03:36 -060094};
95
Patrick Delaunay2111e3c2019-10-14 09:28:06 +020096struct virt_internal_data {
97 int dev_num;
98};
99
Tom Rini7384b5a2013-03-14 05:32:49 +0000100#define DFU_NAME_SIZE 32
Heiko Schochera2f831e2013-06-12 06:05:51 +0200101#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
102#define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
103#endif
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000104#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
Lukasz Majewski3dda2202013-09-10 15:29:23 +0200105#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000106#endif
Lukasz Majewski2bb115f2013-12-09 16:20:14 +0100107#ifndef DFU_DEFAULT_POLL_TIMEOUT
108#define DFU_DEFAULT_POLL_TIMEOUT 0
109#endif
Heiko Schochere1ba1512014-03-18 08:09:56 +0100110#ifndef DFU_MANIFEST_POLL_TIMEOUT
111#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
112#endif
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200113
114struct dfu_entity {
115 char name[DFU_NAME_SIZE];
116 int alt;
117 void *dev_private;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200118 enum dfu_device_type dev_type;
119 enum dfu_layout layout;
Stephen Warrenf9500982014-06-11 16:03:34 -0600120 unsigned long max_buf_size;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200121
122 union {
123 struct mmc_internal_data mmc;
Patrick Delaunayf7aee232019-10-14 09:28:04 +0200124 struct mtd_internal_data mtd;
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000125 struct nand_internal_data nand;
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530126 struct ram_internal_data ram;
Stephen Warren0280af72014-06-11 16:03:36 -0600127 struct sf_internal_data sf;
Patrick Delaunay2111e3c2019-10-14 09:28:06 +0200128 struct virt_internal_data virt;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200129 } data;
130
Patrick Delaunayf4e934f2017-07-19 16:39:23 +0200131 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
Stephen Warren020e6f32014-06-11 12:47:27 -0600132
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000133 int (*read_medium)(struct dfu_entity *dfu,
134 u64 offset, void *buf, long *len);
135
136 int (*write_medium)(struct dfu_entity *dfu,
137 u64 offset, void *buf, long *len);
138
139 int (*flush_medium)(struct dfu_entity *dfu);
Heiko Schocherb9488102014-04-11 07:59:47 +0200140 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200141
Stephen Warrena5f77f62014-06-11 16:03:35 -0600142 void (*free_entity)(struct dfu_entity *dfu);
143
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200144 struct list_head list;
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000145
146 /* on the fly state */
147 u32 crc;
148 u64 offset;
149 int i_blk_seq_num;
150 u8 *i_buf;
151 u8 *i_buf_start;
152 u8 *i_buf_end;
Patrick Delaunayf4e934f2017-07-19 16:39:23 +0200153 u64 r_left;
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000154 long b_left;
155
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000156 u32 bad_skip; /* for nand use */
157
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000158 unsigned int inited:1;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200159};
160
Przemyslaw Marczakd0dd6092015-02-17 12:24:11 +0100161#ifdef CONFIG_SET_DFU_ALT_INFO
162void set_dfu_alt_info(char *interface, char *devstr);
163#endif
Patrick Delaunay0f8fad82019-10-14 09:28:01 +0200164int dfu_alt_init(int num, struct dfu_entity **dfu);
165int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
Stephen Warren4afe50f2014-06-11 16:03:33 -0600166int dfu_config_entities(char *s, char *interface, char *devstr);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200167void dfu_free_entities(void);
168void dfu_show_entities(void);
169int dfu_get_alt_number(void);
170const char *dfu_get_dev_type(enum dfu_device_type t);
171const char *dfu_get_layout(enum dfu_layout l);
172struct dfu_entity *dfu_get_entity(int alt);
173char *dfu_extract_token(char** e, int *n);
Lukasz Majewski1737f0f2013-10-08 14:30:38 +0200174int dfu_get_alt(char *name);
Stephen Warren4afe50f2014-06-11 16:03:33 -0600175int dfu_init_env_entities(char *interface, char *devstr);
Stephen Warrenf9500982014-06-11 16:03:34 -0600176unsigned char *dfu_get_buf(struct dfu_entity *dfu);
Lukasz Majewski34264232013-10-08 14:30:39 +0200177unsigned char *dfu_free_buf(void);
Lukasz Majewski031d4132013-12-09 16:20:13 +0100178unsigned long dfu_get_buf_size(void);
Lukasz Majewskid9eae702014-08-25 11:07:28 +0200179bool dfu_usb_get_reset(void);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200180
Andy Shevchenko1e414012019-11-27 18:12:15 +0200181#ifdef CONFIG_DFU_TIMEOUT
182unsigned long dfu_get_timeout(void);
183void dfu_set_timeout(unsigned long);
184#endif
185
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200186int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
187int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heiko Schocher941b3842014-03-18 08:09:55 +0100188int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Lukasz Majewskicc2d0262015-08-24 00:21:46 +0200189
Patrick Delaunay773771f2019-10-14 09:28:07 +0200190/**
191 * dfu_initiated_callback - weak callback called on DFU transaction start
192 *
193 * It is a callback function called by DFU stack when a DFU transaction is
194 * initiated. This function allows to manage some board specific behavior on
195 * DFU targets.
196 *
197 * @param dfu - pointer to the dfu_entity, which should be initialized
198 *
199 */
200void dfu_initiated_callback(struct dfu_entity *dfu);
201/**
202 * dfu_flush_callback - weak callback called at the end of the DFU write
203 *
204 * It is a callback function called by DFU stack after DFU manifestation.
205 * This function allows to manage some board specific behavior on DFU targets
206 *
207 * @param dfu - pointer to the dfu_entity, which should be flushed
208 *
209 */
210void dfu_flush_callback(struct dfu_entity *dfu);
211
Patrick Delaunay5a9aa2f2020-03-18 09:24:47 +0100212int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
213void dfu_transaction_cleanup(struct dfu_entity *dfu);
214
Lukasz Majewski365a70d2016-01-28 16:14:49 +0100215/*
216 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
217 * It should be NULL when not used.
218 */
219extern struct dfu_entity *dfu_defer_flush;
220/**
221 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
222 *
223 * @return - value of the dfu_defer_flush pointer
224 */
225static inline struct dfu_entity *dfu_get_defer_flush(void)
226{
227 return dfu_defer_flush;
228}
229
230/**
231 * dfu_set_defer_flush - set the dfu_defer_flush pointer
232 *
233 * @param dfu - pointer to the dfu_entity, which should be written
234 */
235static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
236{
237 dfu_defer_flush = dfu;
238}
239
Lukasz Majewskicc2d0262015-08-24 00:21:46 +0200240/**
241 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
242 *
243 * This function adds support for writing data starting from fixed memory
244 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
245 *
246 * @param dfu - dfu entity to which we want to store data
247 * @param buf - fixed memory addres from where data starts
248 * @param size - number of bytes to write
249 *
250 * @return - 0 on success, other value on failure
251 */
252int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
253
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200254/* Device specific */
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600255#if CONFIG_IS_ENABLED(DFU_MMC)
Stephen Warren4afe50f2014-06-11 16:03:33 -0600256extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200257#else
Stephen Warren4afe50f2014-06-11 16:03:33 -0600258static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
259 char *s)
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200260{
261 puts("MMC support not available!\n");
262 return -1;
263}
264#endif
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000265
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600266#if CONFIG_IS_ENABLED(DFU_NAND)
Stephen Warren4afe50f2014-06-11 16:03:33 -0600267extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000268#else
Stephen Warren4afe50f2014-06-11 16:03:33 -0600269static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
270 char *s)
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000271{
272 puts("NAND support not available!\n");
273 return -1;
274}
275#endif
276
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600277#if CONFIG_IS_ENABLED(DFU_RAM)
Stephen Warren4afe50f2014-06-11 16:03:33 -0600278extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530279#else
Stephen Warren4afe50f2014-06-11 16:03:33 -0600280static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
281 char *s)
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530282{
283 puts("RAM support not available!\n");
284 return -1;
285}
286#endif
287
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600288#if CONFIG_IS_ENABLED(DFU_SF)
Stephen Warren0280af72014-06-11 16:03:36 -0600289extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
290#else
291static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
292 char *s)
293{
294 puts("SF support not available!\n");
295 return -1;
296}
297#endif
298
Patrick Delaunayf7aee232019-10-14 09:28:04 +0200299#if CONFIG_IS_ENABLED(DFU_MTD)
300int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s);
301#else
302static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
303 char *s)
304{
305 puts("MTD support not available!\n");
306 return -1;
307}
308#endif
309
Patrick Delaunay2111e3c2019-10-14 09:28:06 +0200310#ifdef CONFIG_DFU_VIRT
311int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, char *s);
312int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
313 void *buf, long *len);
314int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
315int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
316 void *buf, long *len);
317#else
318static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
319 char *s)
320{
321 puts("VIRT support not available!\n");
322 return -1;
323}
324#endif
325
Lukasz Majewski507375c2015-08-24 00:21:45 +0200326/**
327 * dfu_tftp_write - Write TFTP data to DFU medium
328 *
329 * This function is storing data received via TFTP on DFU supported medium.
330 *
331 * @param dfu_entity_name - name of DFU entity to write
332 * @param addr - address of data buffer to write
333 * @param len - number of bytes
334 * @param interface - destination DFU medium (e.g. "mmc")
335 * @param devstring - instance number of destination DFU medium (e.g. "1")
336 *
337 * @return 0 on success, otherwise error code
338 */
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600339#if CONFIG_IS_ENABLED(DFU_TFTP)
Lukasz Majewski507375c2015-08-24 00:21:45 +0200340int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
341 char *interface, char *devstring);
342#else
343static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
344 unsigned int len, char *interface,
345 char *devstring)
346{
347 puts("TFTP write support for DFU not available!\n");
348 return -ENOSYS;
349}
350#endif
351
Lukasz Majewskic4219462013-09-17 15:58:23 +0200352int dfu_add(struct usb_configuration *c);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200353#endif /* __DFU_ENTITY_H_ */