blob: dcb9cd9d799a2d5d5ebb72016434ce283ff5bf34 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Lukasz Majewskif22b11c2012-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 Majewskif22b11c2012-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 Warren6f12ebf2014-06-11 16:03:36 -060016#include <spi_flash.h>
Lukasz Majewskia6921ad2013-09-17 15:58:23 +020017#include <linux/usb/composite.h>
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020018
19enum dfu_device_type {
20 DFU_DEV_MMC = 1,
21 DFU_DEV_ONENAND,
22 DFU_DEV_NAND,
Afzal Mohammeda9479f02013-09-18 01:15:24 +053023 DFU_DEV_RAM,
Stephen Warren6f12ebf2014-06-11 16:03:36 -060024 DFU_DEV_SF,
Patrick Delaunay6015af22019-10-14 09:28:04 +020025 DFU_DEV_MTD,
Patrick Delaunayec44cac2019-10-14 09:28:06 +020026 DFU_DEV_VIRT,
Lukasz Majewskif22b11c2012-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 Mohammeda9479f02013-09-18 01:15:24 +053035 DFU_RAM_ADDR,
Jaehoon Chungb5f34052020-12-22 11:32:21 +010036 DFU_SKIP,
Marek Szyprowskic533f942020-12-22 11:32:22 +010037 DFU_SCRIPT,
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020038};
39
Afzal Mohammed5a127c82013-09-18 01:14:50 +053040enum dfu_op {
41 DFU_OP_READ = 1,
42 DFU_OP_WRITE,
Stephen Warren0e285b52014-06-11 12:47:27 -060043 DFU_OP_SIZE,
Afzal Mohammed5a127c82013-09-18 01:14:50 +053044};
45
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020046struct mmc_internal_data {
Stephen Warrendd648272014-06-11 16:03:33 -060047 int dev_num;
48
Lukasz Majewskif22b11c2012-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 Majewskic8151b42014-05-09 16:58:15 +020054 /* eMMC HW partition access */
55 int hw_partition;
56
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020057 /* FAT/EXT */
58 unsigned int dev;
59 unsigned int part;
60};
61
Patrick Delaunay6015af22019-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 Delaunayd5640f72019-10-14 09:28:05 +020068 /* for ubi partition */
69 unsigned int ubi;
Patrick Delaunay6015af22019-10-14 09:28:04 +020070};
71
Pantelis Antoniouc6631762013-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 Schocher815c30b2013-07-25 06:43:11 +020079 /* for nand/ubi use */
80 unsigned int ubi;
Pantelis Antoniouc6631762013-03-14 05:32:52 +000081};
82
Afzal Mohammeda9479f02013-09-18 01:15:24 +053083struct ram_internal_data {
Heinrich Schuchardt73f4ebb2020-07-22 17:46:02 +020084 unsigned long start;
Afzal Mohammeda9479f02013-09-18 01:15:24 +053085 unsigned int size;
86};
87
Stephen Warren6f12ebf2014-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 Delaunaycb986ba2019-10-14 09:28:00 +020094 /* for sf/ubi use */
95 unsigned int ubi;
Stephen Warren6f12ebf2014-06-11 16:03:36 -060096};
97
Patrick Delaunayec44cac2019-10-14 09:28:06 +020098struct virt_internal_data {
99 int dev_num;
100};
101
Tom Rinia24c3152013-03-14 05:32:49 +0000102#define DFU_NAME_SIZE 32
Lukasz Majewski33fac4a2013-12-09 16:20:14 +0100103#ifndef DFU_DEFAULT_POLL_TIMEOUT
104#define DFU_DEFAULT_POLL_TIMEOUT 0
105#endif
Heiko Schocher001a8312014-03-18 08:09:56 +0100106#ifndef DFU_MANIFEST_POLL_TIMEOUT
107#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
108#endif
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200109
110struct dfu_entity {
111 char name[DFU_NAME_SIZE];
112 int alt;
113 void *dev_private;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200114 enum dfu_device_type dev_type;
115 enum dfu_layout layout;
Stephen Warren7ac1b412014-06-11 16:03:34 -0600116 unsigned long max_buf_size;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200117
118 union {
119 struct mmc_internal_data mmc;
Patrick Delaunay6015af22019-10-14 09:28:04 +0200120 struct mtd_internal_data mtd;
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000121 struct nand_internal_data nand;
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530122 struct ram_internal_data ram;
Stephen Warren6f12ebf2014-06-11 16:03:36 -0600123 struct sf_internal_data sf;
Patrick Delaunayec44cac2019-10-14 09:28:06 +0200124 struct virt_internal_data virt;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200125 } data;
126
Patrick Delaunay15970d82017-07-19 16:39:23 +0200127 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
Stephen Warren0e285b52014-06-11 12:47:27 -0600128
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000129 int (*read_medium)(struct dfu_entity *dfu,
130 u64 offset, void *buf, long *len);
131
132 int (*write_medium)(struct dfu_entity *dfu,
133 u64 offset, void *buf, long *len);
134
135 int (*flush_medium)(struct dfu_entity *dfu);
Heiko Schocherfc25fa22014-04-11 07:59:47 +0200136 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200137
Stephen Warrencb7bd2e2014-06-11 16:03:35 -0600138 void (*free_entity)(struct dfu_entity *dfu);
139
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200140 struct list_head list;
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000141
142 /* on the fly state */
143 u32 crc;
144 u64 offset;
145 int i_blk_seq_num;
146 u8 *i_buf;
147 u8 *i_buf_start;
148 u8 *i_buf_end;
Patrick Delaunay15970d82017-07-19 16:39:23 +0200149 u64 r_left;
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000150 long b_left;
151
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000152 u32 bad_skip; /* for nand use */
153
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000154 unsigned int inited:1;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200155};
156
AKASHI Takahiro6beaa472020-10-29 13:47:44 +0900157struct list_head;
158extern struct list_head dfu_list;
159
Przemyslaw Marczak899a5282015-02-17 12:24:11 +0100160#ifdef CONFIG_SET_DFU_ALT_INFO
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200161/**
162 * set_dfu_alt_info() - set dfu_alt_info environment variable
163 *
164 * If CONFIG_SET_DFU_ALT_INFO=y, this board specific function is called to set
165 * environment variable dfu_alt_info.
166 *
167 * @interface: dfu interface, e.g. "mmc" or "nand"
168 * @devstr: device number as string
169 */
Przemyslaw Marczak899a5282015-02-17 12:24:11 +0100170void set_dfu_alt_info(char *interface, char *devstr);
171#endif
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200172
173/**
174 * dfu_alt_init() - initialize buffer for dfu entities
175 *
176 * @num: number of entities
177 * @dfu: on return allocated buffer
178 * Return: 0 on success
179 */
Patrick Delaunay9ada6832019-10-14 09:28:01 +0200180int dfu_alt_init(int num, struct dfu_entity **dfu);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200181
182/**
183 * dfu_alt_add() - add alternate to dfu entity buffer
184 *
185 * @dfu: dfu entity
186 * @interface: dfu interface, e.g. "mmc" or "nand"
187 * @devstr: device number as string
188 * @s: string description of alternate
189 * Return: 0 on success
190 */
Patrick Delaunay9ada6832019-10-14 09:28:01 +0200191int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200192
193/**
194 * dfu_config_entities() - initialize dfu entitities from envirionment
195 *
196 * Initialize the list of dfu entities from environment variable dfu_alt_info.
197 * The list must be freed by calling dfu_free_entities(). This function bypasses
198 * set_dfu_alt_info(). So typically you should use dfu_init_env_entities()
199 * instead.
200 *
201 * See function :c:func:`dfu_free_entities`
202 * See function :c:func:`dfu_init_env_entities`
203 *
204 * @s: string with alternates
205 * @interface: interface, e.g. "mmc" or "nand"
206 * @devstr: device number as string
207 * Return: 0 on success, a negative error code otherwise
208 */
Stephen Warrendd648272014-06-11 16:03:33 -0600209int dfu_config_entities(char *s, char *interface, char *devstr);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200210
211/**
212 * dfu_free_entities() - free the list of dfu entities
213 *
214 * Free the internal list of dfu entities.
215 *
216 * See function :c:func:`dfu_init_env_entities`
217 */
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200218void dfu_free_entities(void);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200219
220/**
221 * dfu_show_entities() - print DFU alt settings list
222 */
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200223void dfu_show_entities(void);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200224
225/**
226 * dfu_get_alt_number() - get number of alternates
227 *
228 * Return: number of alternates in the dfu entities list
229 */
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200230int dfu_get_alt_number(void);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200231
232/**
233 * dfu_get_dev_type() - get string representation for dfu device type
234 *
235 * @type: device type
236 * Return: string representation for device type
237 */
238const char *dfu_get_dev_type(enum dfu_device_type type);
239
240/**
241 * dfu_get_layout() - get string describing layout
242 *
243 * Internally layouts are represented by enum dfu_device_type values. This
244 * function translates an enum value to a human readable string, e.g. DFU_FS_FAT
245 * is translated to "FAT".
246 *
247 * @layout: layout
248 * Result: string representation for the layout
249 */
250const char *dfu_get_layout(enum dfu_layout layout);
251
252/**
253 * dfu_get_entity() - get dfu entity for an alternate id
254 *
255 * @alt: alternate id
256 * Return: dfu entity
257 */
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200258struct dfu_entity *dfu_get_entity(int alt);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200259
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200260char *dfu_extract_token(char** e, int *n);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200261
262/**
263 * dfu_get_alt() - get alternate id for filename
264 *
265 * Environment variable dfu_alt_info defines the write destinations (alternates)
266 * for different filenames. This function get the index of the alternate for
267 * a filename. If an absolute filename is provided (starting with '/'), the
268 * directory path is ignored.
269 *
270 * @name: filename
271 * Return: id of the alternate or negative error number (-ENODEV)
272 */
Lukasz Majewskifed936e2013-10-08 14:30:38 +0200273int dfu_get_alt(char *name);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200274
275/**
276 * dfu_init_env_entities() - initialize dfu entitities from envirionment
277 *
278 * Initialize the list of dfu entities from environment variable dfu_alt_info.
279 * The list must be freed by calling dfu_free_entities().
280 * @interface and @devstr are used to select the relevant set of alternates
281 * from environment variable dfu_alt_info.
282 *
283 * If environment variable dfu_alt_info specifies the interface and the device,
284 * use NULL for @interface and @devstr.
285 *
286 * See function :c:func:`dfu_free_entities`
287 *
288 * @interface: interface, e.g. "mmc" or "nand"
289 * @devstr: device number as string
290 * Return: 0 on success, a negative error code otherwise
291 */
Stephen Warrendd648272014-06-11 16:03:33 -0600292int dfu_init_env_entities(char *interface, char *devstr);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200293
Stephen Warren7ac1b412014-06-11 16:03:34 -0600294unsigned char *dfu_get_buf(struct dfu_entity *dfu);
Lukasz Majewskid4278262013-10-08 14:30:39 +0200295unsigned char *dfu_free_buf(void);
Lukasz Majewski4fb12782013-12-09 16:20:13 +0100296unsigned long dfu_get_buf_size(void);
Lukasz Majewski1cc03c52014-08-25 11:07:28 +0200297bool dfu_usb_get_reset(void);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200298
Andy Shevchenko98a8f442019-11-27 18:12:15 +0200299#ifdef CONFIG_DFU_TIMEOUT
300unsigned long dfu_get_timeout(void);
301void dfu_set_timeout(unsigned long);
302#endif
303
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200304/**
305 * dfu_read() - read from dfu entity
306 *
307 * The block sequence number @blk_seq_num is a 16 bit counter that must be
308 * incremented with each call for the same dfu entity @de.
309 *
310 * @de: dfu entity
311 * @buf: buffer
312 * @size: size of buffer
313 * @blk_seq_num: block sequence number
314 * Return: 0 for success, -1 for error
315 */
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200316int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200317
318/**
319 * dfu_write() - write to dfu entity
320 *
321 * Write the contents of a buffer @buf to the dfu entity @de. After writing
322 * the last block call dfu_flush(). If a file is already loaded completely
323 * into memory it is preferable to use dfu_write_from_mem_addr() which takes
324 * care of blockwise transfer and flushing.
325 *
326 * The block sequence number @blk_seq_num is a 16 bit counter that must be
327 * incremented with each call for the same dfu entity @de.
328 *
329 * See function :c:func:`dfu_flush`
330 * See function :c:func:`dfu_write_from_mem_addr`
331 *
332 * @de: dfu entity
333 * @buf: buffer
334 * @size: size of buffer
335 * @blk_seq_num: block sequence number
336 * Return: 0 for success, -1 for error
337 */
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200338int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200339
340/**
341 * dfu_flush() - flush to dfu entity
342 *
343 * This function has to be called after writing the last block to the dfu
344 * entity @de.
345 *
346 * The block sequence number @blk_seq_num is a 16 bit counter that must be
347 * incremented with each call for the same dfu entity @de.
348 *
349 * See function :c:func:`dfu_write`
350 *
351 * @de: dfu entity
352 * @buf: ignored
353 * @size: ignored
354 * @blk_seq_num: block sequence number of last write - ignored
355 * Return: 0 for success, -1 for error
356 */
Heiko Schochera2199af2014-03-18 08:09:55 +0100357int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Lukasz Majewski2092e462015-08-24 00:21:46 +0200358
Patrick Delaunay067c13c2019-10-14 09:28:07 +0200359/**
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200360 * dfu_initiated_callback() - weak callback called on DFU transaction start
Patrick Delaunay067c13c2019-10-14 09:28:07 +0200361 *
362 * It is a callback function called by DFU stack when a DFU transaction is
363 * initiated. This function allows to manage some board specific behavior on
364 * DFU targets.
365 *
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200366 * @dfu: pointer to the dfu_entity, which should be initialized
Patrick Delaunay067c13c2019-10-14 09:28:07 +0200367 */
368void dfu_initiated_callback(struct dfu_entity *dfu);
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200369
Patrick Delaunay067c13c2019-10-14 09:28:07 +0200370/**
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200371 * dfu_flush_callback() - weak callback called at the end of the DFU write
Patrick Delaunay067c13c2019-10-14 09:28:07 +0200372 *
373 * It is a callback function called by DFU stack after DFU manifestation.
374 * This function allows to manage some board specific behavior on DFU targets
375 *
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200376 * @dfu: pointer to the dfu_entity, which should be flushed
Patrick Delaunay067c13c2019-10-14 09:28:07 +0200377 */
378void dfu_flush_callback(struct dfu_entity *dfu);
379
Patrick Delaunayd4710322021-05-18 15:12:12 +0200380/**
381 * dfu_error_callback() - weak callback called at the DFU write error
382 *
383 * It is a callback function called by DFU stack after DFU write error.
384 * This function allows to manage some board specific behavior on DFU targets
385 *
386 * @dfu: pointer to the dfu_entity which cause the error
387 * @msg: the message of the error
388 */
389void dfu_error_callback(struct dfu_entity *dfu, const char *msg);
390
Patrick Delaunay5cf39722020-03-18 09:24:47 +0100391int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
392void dfu_transaction_cleanup(struct dfu_entity *dfu);
393
Lukasz Majewskifc18f8d2016-01-28 16:14:49 +0100394/*
395 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
396 * It should be NULL when not used.
397 */
398extern struct dfu_entity *dfu_defer_flush;
Heinrich Schuchardtd1811912020-05-23 14:24:40 +0200399
Lukasz Majewskifc18f8d2016-01-28 16:14:49 +0100400/**
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200401 * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer
Lukasz Majewskifc18f8d2016-01-28 16:14:49 +0100402 *
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200403 * Return: value of the dfu_defer_flush pointer
Lukasz Majewskifc18f8d2016-01-28 16:14:49 +0100404 */
405static inline struct dfu_entity *dfu_get_defer_flush(void)
406{
407 return dfu_defer_flush;
408}
409
410/**
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200411 * dfu_set_defer_flush() - set the dfu_defer_flush pointer
Lukasz Majewskifc18f8d2016-01-28 16:14:49 +0100412 *
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200413 * @dfu: pointer to the dfu_entity, which should be written
Lukasz Majewskifc18f8d2016-01-28 16:14:49 +0100414 */
415static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
416{
417 dfu_defer_flush = dfu;
418}
419
Lukasz Majewski2092e462015-08-24 00:21:46 +0200420/**
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200421 * dfu_write_from_mem_addr() - write data from memory to DFU managed medium
Lukasz Majewski2092e462015-08-24 00:21:46 +0200422 *
423 * This function adds support for writing data starting from fixed memory
424 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
425 *
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200426 * @dfu: dfu entity to which we want to store data
427 * @buf: fixed memory address from where data starts
428 * @size: number of bytes to write
Lukasz Majewski2092e462015-08-24 00:21:46 +0200429 *
Heinrich Schuchardtf39c8452020-05-23 12:01:08 +0200430 * Return: 0 on success, other value on failure
Lukasz Majewski2092e462015-08-24 00:21:46 +0200431 */
432int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
433
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200434/* Device specific */
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900435/* Each entity has 5 arguments in maximum. */
436#define DFU_MAX_ENTITY_ARGS 5
437
Andrew F. Davis2d59ec82019-01-17 13:43:03 -0600438#if CONFIG_IS_ENABLED(DFU_MMC)
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900439extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
440 char **argv, int argc);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200441#else
Stephen Warrendd648272014-06-11 16:03:33 -0600442static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900443 char **argv, int argc)
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200444{
445 puts("MMC support not available!\n");
446 return -1;
447}
448#endif
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000449
Andrew F. Davis2d59ec82019-01-17 13:43:03 -0600450#if CONFIG_IS_ENABLED(DFU_NAND)
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900451extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
452 char **argv, int argc);
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000453#else
Stephen Warrendd648272014-06-11 16:03:33 -0600454static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900455 char **argv, int argc)
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000456{
457 puts("NAND support not available!\n");
458 return -1;
459}
460#endif
461
Andrew F. Davis2d59ec82019-01-17 13:43:03 -0600462#if CONFIG_IS_ENABLED(DFU_RAM)
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900463extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
464 char **argv, int argc);
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530465#else
Stephen Warrendd648272014-06-11 16:03:33 -0600466static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900467 char **argv, int argc)
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530468{
469 puts("RAM support not available!\n");
470 return -1;
471}
472#endif
473
Andrew F. Davis2d59ec82019-01-17 13:43:03 -0600474#if CONFIG_IS_ENABLED(DFU_SF)
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900475extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
476 char **argv, int argc);
Stephen Warren6f12ebf2014-06-11 16:03:36 -0600477#else
478static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900479 char **argv, int argc)
Stephen Warren6f12ebf2014-06-11 16:03:36 -0600480{
481 puts("SF support not available!\n");
482 return -1;
483}
484#endif
485
Patrick Delaunay6015af22019-10-14 09:28:04 +0200486#if CONFIG_IS_ENABLED(DFU_MTD)
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900487extern int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
488 char **argv, int argc);
Patrick Delaunay6015af22019-10-14 09:28:04 +0200489#else
490static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900491 char **argv, int argc)
Patrick Delaunay6015af22019-10-14 09:28:04 +0200492{
493 puts("MTD support not available!\n");
494 return -1;
495}
496#endif
497
Patrick Delaunayec44cac2019-10-14 09:28:06 +0200498#ifdef CONFIG_DFU_VIRT
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900499int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
500 char **argv, int argc);
Patrick Delaunayec44cac2019-10-14 09:28:06 +0200501int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
502 void *buf, long *len);
503int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
504int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
505 void *buf, long *len);
506#else
507static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
Masami Hiramatsu53b40632022-01-31 11:52:37 +0900508 char **argv, int argc)
Patrick Delaunayec44cac2019-10-14 09:28:06 +0200509{
510 puts("VIRT support not available!\n");
511 return -1;
512}
513#endif
514
Marek Szyprowskic533f942020-12-22 11:32:22 +0100515extern bool dfu_reinit_needed;
516
AKASHI Takahirof2345662020-10-29 13:47:52 +0900517#if CONFIG_IS_ENABLED(DFU_WRITE_ALT)
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200518/**
AKASHI Takahiro045fd8b2020-10-29 13:47:41 +0900519 * dfu_write_by_name() - write data to DFU medium
520 * @dfu_entity_name: Name of DFU entity to write
521 * @addr: Address of data buffer to write
522 * @len: Number of bytes
523 * @interface: Destination DFU medium (e.g. "mmc")
524 * @devstring: Instance number of destination DFU medium (e.g. "1")
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200525 *
AKASHI Takahiro045fd8b2020-10-29 13:47:41 +0900526 * This function is storing data received on DFU supported medium which
527 * is specified by @dfu_entity_name.
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200528 *
AKASHI Takahiro045fd8b2020-10-29 13:47:41 +0900529 * Return: 0 - on success, error code - otherwise
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200530 */
AKASHI Takahiro1c2d1292020-10-29 13:47:42 +0900531int dfu_write_by_name(char *dfu_entity_name, void *addr,
AKASHI Takahiro045fd8b2020-10-29 13:47:41 +0900532 unsigned int len, char *interface, char *devstring);
AKASHI Takahirof2345662020-10-29 13:47:52 +0900533
534/**
535 * dfu_write_by_alt() - write data to DFU medium
536 * @dfu_alt_num: DFU alt setting number
537 * @addr: Address of data buffer to write
538 * @len: Number of bytes
539 * @interface: Destination DFU medium (e.g. "mmc")
540 * @devstring: Instance number of destination DFU medium (e.g. "1")
541 *
542 * This function is storing data received on DFU supported medium which
543 * is specified by @dfu_alt_name.
544 *
545 * Return: 0 - on success, error code - otherwise
546 */
547int dfu_write_by_alt(int dfu_alt_num, void *addr, unsigned int len,
548 char *interface, char *devstring);
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200549#else
AKASHI Takahiro1c2d1292020-10-29 13:47:42 +0900550static inline int dfu_write_by_name(char *dfu_entity_name, void *addr,
AKASHI Takahiro045fd8b2020-10-29 13:47:41 +0900551 unsigned int len, char *interface,
552 char *devstring)
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200553{
AKASHI Takahiro045fd8b2020-10-29 13:47:41 +0900554 puts("write support for DFU not available!\n");
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200555 return -ENOSYS;
556}
AKASHI Takahirof2345662020-10-29 13:47:52 +0900557
558static inline int dfu_write_by_alt(int dfu_alt_num, void *addr,
559 unsigned int len, char *interface,
560 char *devstring)
561{
562 puts("write support for DFU not available!\n");
563 return -ENOSYS;
564}
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200565#endif
566
Lukasz Majewskia6921ad2013-09-17 15:58:23 +0200567int dfu_add(struct usb_configuration *c);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200568#endif /* __DFU_ENTITY_H_ */