blob: d18b70172829a0c17369514a17a5b7ea13ad55bb [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,
Jaehoon Chungd7cbe122020-12-22 11:32:21 +010036 DFU_SKIP,
Marek Szyprowskib1fa1ad2020-12-22 11:32:22 +010037 DFU_SCRIPT,
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020038};
39
Afzal Mohammedb9a4a6b2013-09-18 01:14:50 +053040enum dfu_op {
41 DFU_OP_READ = 1,
42 DFU_OP_WRITE,
Stephen Warren020e6f32014-06-11 12:47:27 -060043 DFU_OP_SIZE,
Afzal Mohammedb9a4a6b2013-09-18 01:14:50 +053044};
45
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020046struct mmc_internal_data {
Stephen Warren4afe50f2014-06-11 16:03:33 -060047 int dev_num;
48
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020049 /* RAW programming */
50 unsigned int lba_start;
51 unsigned int lba_size;
52 unsigned int lba_blk_size;
53
Lukasz Majewski4da65ea2014-05-09 16:58:15 +020054 /* eMMC HW partition access */
55 int hw_partition;
56
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020057 /* FAT/EXT */
58 unsigned int dev;
59 unsigned int part;
60};
61
Patrick Delaunayf7aee232019-10-14 09:28:04 +020062struct mtd_internal_data {
63 struct mtd_info *info;
64
65 /* RAW programming */
66 u64 start;
67 u64 size;
Patrick Delaunaycb47cb02019-10-14 09:28:05 +020068 /* for ubi partition */
69 unsigned int ubi;
Patrick Delaunayf7aee232019-10-14 09:28:04 +020070};
71
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +000072struct nand_internal_data {
73 /* RAW programming */
74 u64 start;
75 u64 size;
76
77 unsigned int dev;
78 unsigned int part;
Heiko Schocherad401392013-07-25 06:43:11 +020079 /* for nand/ubi use */
80 unsigned int ubi;
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +000081};
82
Afzal Mohammede3c687a2013-09-18 01:15:24 +053083struct ram_internal_data {
Heinrich Schuchardt8784b0b2020-07-22 17:46:02 +020084 unsigned long start;
Afzal Mohammede3c687a2013-09-18 01:15:24 +053085 unsigned int size;
86};
87
Stephen Warren0280af72014-06-11 16:03:36 -060088struct sf_internal_data {
89 struct spi_flash *dev;
90
91 /* RAW programming */
92 u64 start;
93 u64 size;
Patrick Delaunaybdc0f122019-10-14 09:28:00 +020094 /* for sf/ubi use */
95 unsigned int ubi;
Stephen Warren0280af72014-06-11 16:03:36 -060096};
97
Patrick Delaunay2111e3c2019-10-14 09:28:06 +020098struct virt_internal_data {
99 int dev_num;
100};
101
Tom Rini7384b5a2013-03-14 05:32:49 +0000102#define DFU_NAME_SIZE 32
Heiko Schochera2f831e2013-06-12 06:05:51 +0200103#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
104#define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
105#endif
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000106#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
Lukasz Majewski3dda2202013-09-10 15:29:23 +0200107#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000108#endif
Lukasz Majewski2bb115f2013-12-09 16:20:14 +0100109#ifndef DFU_DEFAULT_POLL_TIMEOUT
110#define DFU_DEFAULT_POLL_TIMEOUT 0
111#endif
Heiko Schochere1ba1512014-03-18 08:09:56 +0100112#ifndef DFU_MANIFEST_POLL_TIMEOUT
113#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
114#endif
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200115
116struct dfu_entity {
117 char name[DFU_NAME_SIZE];
118 int alt;
119 void *dev_private;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200120 enum dfu_device_type dev_type;
121 enum dfu_layout layout;
Stephen Warrenf9500982014-06-11 16:03:34 -0600122 unsigned long max_buf_size;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200123
124 union {
125 struct mmc_internal_data mmc;
Patrick Delaunayf7aee232019-10-14 09:28:04 +0200126 struct mtd_internal_data mtd;
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000127 struct nand_internal_data nand;
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530128 struct ram_internal_data ram;
Stephen Warren0280af72014-06-11 16:03:36 -0600129 struct sf_internal_data sf;
Patrick Delaunay2111e3c2019-10-14 09:28:06 +0200130 struct virt_internal_data virt;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200131 } data;
132
Patrick Delaunayf4e934f2017-07-19 16:39:23 +0200133 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
Stephen Warren020e6f32014-06-11 12:47:27 -0600134
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000135 int (*read_medium)(struct dfu_entity *dfu,
136 u64 offset, void *buf, long *len);
137
138 int (*write_medium)(struct dfu_entity *dfu,
139 u64 offset, void *buf, long *len);
140
141 int (*flush_medium)(struct dfu_entity *dfu);
Heiko Schocherb9488102014-04-11 07:59:47 +0200142 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200143
Stephen Warrena5f77f62014-06-11 16:03:35 -0600144 void (*free_entity)(struct dfu_entity *dfu);
145
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200146 struct list_head list;
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000147
148 /* on the fly state */
149 u32 crc;
150 u64 offset;
151 int i_blk_seq_num;
152 u8 *i_buf;
153 u8 *i_buf_start;
154 u8 *i_buf_end;
Patrick Delaunayf4e934f2017-07-19 16:39:23 +0200155 u64 r_left;
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000156 long b_left;
157
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000158 u32 bad_skip; /* for nand use */
159
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000160 unsigned int inited:1;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200161};
162
AKASHI Takahirob24b8292020-10-29 13:47:44 +0900163struct list_head;
164extern struct list_head dfu_list;
165
Przemyslaw Marczakd0dd6092015-02-17 12:24:11 +0100166#ifdef CONFIG_SET_DFU_ALT_INFO
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200167/**
168 * set_dfu_alt_info() - set dfu_alt_info environment variable
169 *
170 * If CONFIG_SET_DFU_ALT_INFO=y, this board specific function is called to set
171 * environment variable dfu_alt_info.
172 *
173 * @interface: dfu interface, e.g. "mmc" or "nand"
174 * @devstr: device number as string
175 */
Przemyslaw Marczakd0dd6092015-02-17 12:24:11 +0100176void set_dfu_alt_info(char *interface, char *devstr);
177#endif
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200178
179/**
180 * dfu_alt_init() - initialize buffer for dfu entities
181 *
182 * @num: number of entities
183 * @dfu: on return allocated buffer
184 * Return: 0 on success
185 */
Patrick Delaunay0f8fad82019-10-14 09:28:01 +0200186int dfu_alt_init(int num, struct dfu_entity **dfu);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200187
188/**
189 * dfu_alt_add() - add alternate to dfu entity buffer
190 *
191 * @dfu: dfu entity
192 * @interface: dfu interface, e.g. "mmc" or "nand"
193 * @devstr: device number as string
194 * @s: string description of alternate
195 * Return: 0 on success
196 */
Patrick Delaunay0f8fad82019-10-14 09:28:01 +0200197int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200198
199/**
200 * dfu_config_entities() - initialize dfu entitities from envirionment
201 *
202 * Initialize the list of dfu entities from environment variable dfu_alt_info.
203 * The list must be freed by calling dfu_free_entities(). This function bypasses
204 * set_dfu_alt_info(). So typically you should use dfu_init_env_entities()
205 * instead.
206 *
207 * See function :c:func:`dfu_free_entities`
208 * See function :c:func:`dfu_init_env_entities`
209 *
210 * @s: string with alternates
211 * @interface: interface, e.g. "mmc" or "nand"
212 * @devstr: device number as string
213 * Return: 0 on success, a negative error code otherwise
214 */
Stephen Warren4afe50f2014-06-11 16:03:33 -0600215int dfu_config_entities(char *s, char *interface, char *devstr);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200216
217/**
218 * dfu_free_entities() - free the list of dfu entities
219 *
220 * Free the internal list of dfu entities.
221 *
222 * See function :c:func:`dfu_init_env_entities`
223 */
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200224void dfu_free_entities(void);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200225
226/**
227 * dfu_show_entities() - print DFU alt settings list
228 */
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200229void dfu_show_entities(void);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200230
231/**
232 * dfu_get_alt_number() - get number of alternates
233 *
234 * Return: number of alternates in the dfu entities list
235 */
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200236int dfu_get_alt_number(void);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200237
238/**
239 * dfu_get_dev_type() - get string representation for dfu device type
240 *
241 * @type: device type
242 * Return: string representation for device type
243 */
244const char *dfu_get_dev_type(enum dfu_device_type type);
245
246/**
247 * dfu_get_layout() - get string describing layout
248 *
249 * Internally layouts are represented by enum dfu_device_type values. This
250 * function translates an enum value to a human readable string, e.g. DFU_FS_FAT
251 * is translated to "FAT".
252 *
253 * @layout: layout
254 * Result: string representation for the layout
255 */
256const char *dfu_get_layout(enum dfu_layout layout);
257
258/**
259 * dfu_get_entity() - get dfu entity for an alternate id
260 *
261 * @alt: alternate id
262 * Return: dfu entity
263 */
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200264struct dfu_entity *dfu_get_entity(int alt);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200265
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200266char *dfu_extract_token(char** e, int *n);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200267
268/**
269 * dfu_get_alt() - get alternate id for filename
270 *
271 * Environment variable dfu_alt_info defines the write destinations (alternates)
272 * for different filenames. This function get the index of the alternate for
273 * a filename. If an absolute filename is provided (starting with '/'), the
274 * directory path is ignored.
275 *
276 * @name: filename
277 * Return: id of the alternate or negative error number (-ENODEV)
278 */
Lukasz Majewski1737f0f2013-10-08 14:30:38 +0200279int dfu_get_alt(char *name);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200280
281/**
282 * dfu_init_env_entities() - initialize dfu entitities from envirionment
283 *
284 * Initialize the list of dfu entities from environment variable dfu_alt_info.
285 * The list must be freed by calling dfu_free_entities().
286 * @interface and @devstr are used to select the relevant set of alternates
287 * from environment variable dfu_alt_info.
288 *
289 * If environment variable dfu_alt_info specifies the interface and the device,
290 * use NULL for @interface and @devstr.
291 *
292 * See function :c:func:`dfu_free_entities`
293 *
294 * @interface: interface, e.g. "mmc" or "nand"
295 * @devstr: device number as string
296 * Return: 0 on success, a negative error code otherwise
297 */
Stephen Warren4afe50f2014-06-11 16:03:33 -0600298int dfu_init_env_entities(char *interface, char *devstr);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200299
Stephen Warrenf9500982014-06-11 16:03:34 -0600300unsigned char *dfu_get_buf(struct dfu_entity *dfu);
Lukasz Majewski34264232013-10-08 14:30:39 +0200301unsigned char *dfu_free_buf(void);
Lukasz Majewski031d4132013-12-09 16:20:13 +0100302unsigned long dfu_get_buf_size(void);
Lukasz Majewskid9eae702014-08-25 11:07:28 +0200303bool dfu_usb_get_reset(void);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200304
Andy Shevchenko1e414012019-11-27 18:12:15 +0200305#ifdef CONFIG_DFU_TIMEOUT
306unsigned long dfu_get_timeout(void);
307void dfu_set_timeout(unsigned long);
308#endif
309
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200310/**
311 * dfu_read() - read from dfu entity
312 *
313 * The block sequence number @blk_seq_num is a 16 bit counter that must be
314 * incremented with each call for the same dfu entity @de.
315 *
316 * @de: dfu entity
317 * @buf: buffer
318 * @size: size of buffer
319 * @blk_seq_num: block sequence number
320 * Return: 0 for success, -1 for error
321 */
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200322int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200323
324/**
325 * dfu_write() - write to dfu entity
326 *
327 * Write the contents of a buffer @buf to the dfu entity @de. After writing
328 * the last block call dfu_flush(). If a file is already loaded completely
329 * into memory it is preferable to use dfu_write_from_mem_addr() which takes
330 * care of blockwise transfer and flushing.
331 *
332 * The block sequence number @blk_seq_num is a 16 bit counter that must be
333 * incremented with each call for the same dfu entity @de.
334 *
335 * See function :c:func:`dfu_flush`
336 * See function :c:func:`dfu_write_from_mem_addr`
337 *
338 * @de: dfu entity
339 * @buf: buffer
340 * @size: size of buffer
341 * @blk_seq_num: block sequence number
342 * Return: 0 for success, -1 for error
343 */
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200344int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200345
346/**
347 * dfu_flush() - flush to dfu entity
348 *
349 * This function has to be called after writing the last block to the dfu
350 * entity @de.
351 *
352 * The block sequence number @blk_seq_num is a 16 bit counter that must be
353 * incremented with each call for the same dfu entity @de.
354 *
355 * See function :c:func:`dfu_write`
356 *
357 * @de: dfu entity
358 * @buf: ignored
359 * @size: ignored
360 * @blk_seq_num: block sequence number of last write - ignored
361 * Return: 0 for success, -1 for error
362 */
Heiko Schocher941b3842014-03-18 08:09:55 +0100363int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Lukasz Majewskicc2d0262015-08-24 00:21:46 +0200364
Patrick Delaunay773771f2019-10-14 09:28:07 +0200365/**
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200366 * dfu_initiated_callback() - weak callback called on DFU transaction start
Patrick Delaunay773771f2019-10-14 09:28:07 +0200367 *
368 * It is a callback function called by DFU stack when a DFU transaction is
369 * initiated. This function allows to manage some board specific behavior on
370 * DFU targets.
371 *
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200372 * @dfu: pointer to the dfu_entity, which should be initialized
Patrick Delaunay773771f2019-10-14 09:28:07 +0200373 */
374void dfu_initiated_callback(struct dfu_entity *dfu);
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200375
Patrick Delaunay773771f2019-10-14 09:28:07 +0200376/**
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200377 * dfu_flush_callback() - weak callback called at the end of the DFU write
Patrick Delaunay773771f2019-10-14 09:28:07 +0200378 *
379 * It is a callback function called by DFU stack after DFU manifestation.
380 * This function allows to manage some board specific behavior on DFU targets
381 *
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200382 * @dfu: pointer to the dfu_entity, which should be flushed
Patrick Delaunay773771f2019-10-14 09:28:07 +0200383 */
384void dfu_flush_callback(struct dfu_entity *dfu);
385
Patrick Delaunay5a9aa2f2020-03-18 09:24:47 +0100386int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
387void dfu_transaction_cleanup(struct dfu_entity *dfu);
388
Lukasz Majewski365a70d2016-01-28 16:14:49 +0100389/*
390 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
391 * It should be NULL when not used.
392 */
393extern struct dfu_entity *dfu_defer_flush;
Heinrich Schuchardtec2d3da2020-05-23 14:24:40 +0200394
Lukasz Majewski365a70d2016-01-28 16:14:49 +0100395/**
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200396 * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer
Lukasz Majewski365a70d2016-01-28 16:14:49 +0100397 *
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200398 * Return: value of the dfu_defer_flush pointer
Lukasz Majewski365a70d2016-01-28 16:14:49 +0100399 */
400static inline struct dfu_entity *dfu_get_defer_flush(void)
401{
402 return dfu_defer_flush;
403}
404
405/**
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200406 * dfu_set_defer_flush() - set the dfu_defer_flush pointer
Lukasz Majewski365a70d2016-01-28 16:14:49 +0100407 *
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200408 * @dfu: pointer to the dfu_entity, which should be written
Lukasz Majewski365a70d2016-01-28 16:14:49 +0100409 */
410static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
411{
412 dfu_defer_flush = dfu;
413}
414
Lukasz Majewskicc2d0262015-08-24 00:21:46 +0200415/**
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200416 * dfu_write_from_mem_addr() - write data from memory to DFU managed medium
Lukasz Majewskicc2d0262015-08-24 00:21:46 +0200417 *
418 * This function adds support for writing data starting from fixed memory
419 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
420 *
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200421 * @dfu: dfu entity to which we want to store data
422 * @buf: fixed memory address from where data starts
423 * @size: number of bytes to write
Lukasz Majewskicc2d0262015-08-24 00:21:46 +0200424 *
Heinrich Schuchardtd5238182020-05-23 12:01:08 +0200425 * Return: 0 on success, other value on failure
Lukasz Majewskicc2d0262015-08-24 00:21:46 +0200426 */
427int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
428
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200429/* Device specific */
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600430#if CONFIG_IS_ENABLED(DFU_MMC)
Stephen Warren4afe50f2014-06-11 16:03:33 -0600431extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200432#else
Stephen Warren4afe50f2014-06-11 16:03:33 -0600433static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
434 char *s)
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200435{
436 puts("MMC support not available!\n");
437 return -1;
438}
439#endif
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000440
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600441#if CONFIG_IS_ENABLED(DFU_NAND)
Stephen Warren4afe50f2014-06-11 16:03:33 -0600442extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000443#else
Stephen Warren4afe50f2014-06-11 16:03:33 -0600444static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
445 char *s)
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000446{
447 puts("NAND support not available!\n");
448 return -1;
449}
450#endif
451
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600452#if CONFIG_IS_ENABLED(DFU_RAM)
Stephen Warren4afe50f2014-06-11 16:03:33 -0600453extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530454#else
Stephen Warren4afe50f2014-06-11 16:03:33 -0600455static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
456 char *s)
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530457{
458 puts("RAM support not available!\n");
459 return -1;
460}
461#endif
462
Andrew F. Davis159eb4b2019-01-17 13:43:03 -0600463#if CONFIG_IS_ENABLED(DFU_SF)
Stephen Warren0280af72014-06-11 16:03:36 -0600464extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
465#else
466static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
467 char *s)
468{
469 puts("SF support not available!\n");
470 return -1;
471}
472#endif
473
Patrick Delaunayf7aee232019-10-14 09:28:04 +0200474#if CONFIG_IS_ENABLED(DFU_MTD)
475int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s);
476#else
477static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
478 char *s)
479{
480 puts("MTD support not available!\n");
481 return -1;
482}
483#endif
484
Patrick Delaunay2111e3c2019-10-14 09:28:06 +0200485#ifdef CONFIG_DFU_VIRT
486int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, char *s);
487int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
488 void *buf, long *len);
489int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
490int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
491 void *buf, long *len);
492#else
493static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
494 char *s)
495{
496 puts("VIRT support not available!\n");
497 return -1;
498}
499#endif
500
Marek Szyprowskib1fa1ad2020-12-22 11:32:22 +0100501extern bool dfu_reinit_needed;
502
AKASHI Takahiro0e84a042020-10-29 13:47:52 +0900503#if CONFIG_IS_ENABLED(DFU_WRITE_ALT)
Lukasz Majewski507375c2015-08-24 00:21:45 +0200504/**
AKASHI Takahirofb6732f2020-10-29 13:47:41 +0900505 * dfu_write_by_name() - write data to DFU medium
506 * @dfu_entity_name: Name of DFU entity to write
507 * @addr: Address of data buffer to write
508 * @len: Number of bytes
509 * @interface: Destination DFU medium (e.g. "mmc")
510 * @devstring: Instance number of destination DFU medium (e.g. "1")
Lukasz Majewski507375c2015-08-24 00:21:45 +0200511 *
AKASHI Takahirofb6732f2020-10-29 13:47:41 +0900512 * This function is storing data received on DFU supported medium which
513 * is specified by @dfu_entity_name.
Lukasz Majewski507375c2015-08-24 00:21:45 +0200514 *
AKASHI Takahirofb6732f2020-10-29 13:47:41 +0900515 * Return: 0 - on success, error code - otherwise
Lukasz Majewski507375c2015-08-24 00:21:45 +0200516 */
AKASHI Takahirobd4dc182020-10-29 13:47:42 +0900517int dfu_write_by_name(char *dfu_entity_name, void *addr,
AKASHI Takahirofb6732f2020-10-29 13:47:41 +0900518 unsigned int len, char *interface, char *devstring);
AKASHI Takahiro0e84a042020-10-29 13:47:52 +0900519
520/**
521 * dfu_write_by_alt() - write data to DFU medium
522 * @dfu_alt_num: DFU alt setting number
523 * @addr: Address of data buffer to write
524 * @len: Number of bytes
525 * @interface: Destination DFU medium (e.g. "mmc")
526 * @devstring: Instance number of destination DFU medium (e.g. "1")
527 *
528 * This function is storing data received on DFU supported medium which
529 * is specified by @dfu_alt_name.
530 *
531 * Return: 0 - on success, error code - otherwise
532 */
533int dfu_write_by_alt(int dfu_alt_num, void *addr, unsigned int len,
534 char *interface, char *devstring);
Lukasz Majewski507375c2015-08-24 00:21:45 +0200535#else
AKASHI Takahirobd4dc182020-10-29 13:47:42 +0900536static inline int dfu_write_by_name(char *dfu_entity_name, void *addr,
AKASHI Takahirofb6732f2020-10-29 13:47:41 +0900537 unsigned int len, char *interface,
538 char *devstring)
Lukasz Majewski507375c2015-08-24 00:21:45 +0200539{
AKASHI Takahirofb6732f2020-10-29 13:47:41 +0900540 puts("write support for DFU not available!\n");
Lukasz Majewski507375c2015-08-24 00:21:45 +0200541 return -ENOSYS;
542}
AKASHI Takahiro0e84a042020-10-29 13:47:52 +0900543
544static inline int dfu_write_by_alt(int dfu_alt_num, void *addr,
545 unsigned int len, char *interface,
546 char *devstring)
547{
548 puts("write support for DFU not available!\n");
549 return -ENOSYS;
550}
Lukasz Majewski507375c2015-08-24 00:21:45 +0200551#endif
552
Lukasz Majewskic4219462013-09-17 15:58:23 +0200553int dfu_add(struct usb_configuration *c);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200554#endif /* __DFU_ENTITY_H_ */