Tom Rini | 83d290c | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 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> |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 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> |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 16 | #include <spi_flash.h> |
Lukasz Majewski | a6921ad | 2013-09-17 15:58:23 +0200 | [diff] [blame] | 17 | #include <linux/usb/composite.h> |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 18 | |
| 19 | enum dfu_device_type { |
| 20 | DFU_DEV_MMC = 1, |
| 21 | DFU_DEV_ONENAND, |
| 22 | DFU_DEV_NAND, |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 23 | DFU_DEV_RAM, |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 24 | DFU_DEV_SF, |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 25 | DFU_DEV_MTD, |
Patrick Delaunay | ec44cac | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 26 | DFU_DEV_VIRT, |
Caleb Connolly | 5e602aa | 2023-12-06 22:01:30 +0000 | [diff] [blame^] | 27 | DFU_DEV_SCSI, |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 28 | }; |
| 29 | |
| 30 | enum dfu_layout { |
| 31 | DFU_RAW_ADDR = 1, |
| 32 | DFU_FS_FAT, |
| 33 | DFU_FS_EXT2, |
| 34 | DFU_FS_EXT3, |
| 35 | DFU_FS_EXT4, |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 36 | DFU_RAM_ADDR, |
Jaehoon Chung | b5f3405 | 2020-12-22 11:32:21 +0100 | [diff] [blame] | 37 | DFU_SKIP, |
Marek Szyprowski | c533f94 | 2020-12-22 11:32:22 +0100 | [diff] [blame] | 38 | DFU_SCRIPT, |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 39 | }; |
| 40 | |
Afzal Mohammed | 5a127c8 | 2013-09-18 01:14:50 +0530 | [diff] [blame] | 41 | enum dfu_op { |
| 42 | DFU_OP_READ = 1, |
| 43 | DFU_OP_WRITE, |
Stephen Warren | 0e285b5 | 2014-06-11 12:47:27 -0600 | [diff] [blame] | 44 | DFU_OP_SIZE, |
Afzal Mohammed | 5a127c8 | 2013-09-18 01:14:50 +0530 | [diff] [blame] | 45 | }; |
| 46 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 47 | struct mmc_internal_data { |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 48 | int dev_num; |
| 49 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 50 | /* RAW programming */ |
| 51 | unsigned int lba_start; |
| 52 | unsigned int lba_size; |
| 53 | unsigned int lba_blk_size; |
| 54 | |
Lukasz Majewski | c8151b4 | 2014-05-09 16:58:15 +0200 | [diff] [blame] | 55 | /* eMMC HW partition access */ |
| 56 | int hw_partition; |
| 57 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 58 | /* FAT/EXT */ |
| 59 | unsigned int dev; |
| 60 | unsigned int part; |
| 61 | }; |
| 62 | |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 63 | struct mtd_internal_data { |
| 64 | struct mtd_info *info; |
| 65 | |
| 66 | /* RAW programming */ |
| 67 | u64 start; |
| 68 | u64 size; |
Patrick Delaunay | d5640f7 | 2019-10-14 09:28:05 +0200 | [diff] [blame] | 69 | /* for ubi partition */ |
| 70 | unsigned int ubi; |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 71 | }; |
| 72 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 73 | struct nand_internal_data { |
| 74 | /* RAW programming */ |
| 75 | u64 start; |
| 76 | u64 size; |
| 77 | |
| 78 | unsigned int dev; |
| 79 | unsigned int part; |
Heiko Schocher | 815c30b | 2013-07-25 06:43:11 +0200 | [diff] [blame] | 80 | /* for nand/ubi use */ |
| 81 | unsigned int ubi; |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 82 | }; |
| 83 | |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 84 | struct ram_internal_data { |
Heinrich Schuchardt | 73f4ebb | 2020-07-22 17:46:02 +0200 | [diff] [blame] | 85 | unsigned long start; |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 86 | unsigned int size; |
| 87 | }; |
| 88 | |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 89 | struct sf_internal_data { |
| 90 | struct spi_flash *dev; |
| 91 | |
| 92 | /* RAW programming */ |
| 93 | u64 start; |
| 94 | u64 size; |
Patrick Delaunay | cb986ba | 2019-10-14 09:28:00 +0200 | [diff] [blame] | 95 | /* for sf/ubi use */ |
| 96 | unsigned int ubi; |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 97 | }; |
| 98 | |
Patrick Delaunay | ec44cac | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 99 | struct virt_internal_data { |
| 100 | int dev_num; |
| 101 | }; |
| 102 | |
Caleb Connolly | 5e602aa | 2023-12-06 22:01:30 +0000 | [diff] [blame^] | 103 | struct scsi_internal_data { |
| 104 | int lun; |
| 105 | |
| 106 | /* RAW programming */ |
| 107 | unsigned int lba_start; |
| 108 | unsigned int lba_size; |
| 109 | unsigned int lba_blk_size; |
| 110 | |
| 111 | /* FAT/EXT */ |
| 112 | unsigned int dev; // Always 0??? |
| 113 | unsigned int part; |
| 114 | }; |
| 115 | |
Tom Rini | a24c315 | 2013-03-14 05:32:49 +0000 | [diff] [blame] | 116 | #define DFU_NAME_SIZE 32 |
Lukasz Majewski | 33fac4a | 2013-12-09 16:20:14 +0100 | [diff] [blame] | 117 | #ifndef DFU_DEFAULT_POLL_TIMEOUT |
| 118 | #define DFU_DEFAULT_POLL_TIMEOUT 0 |
| 119 | #endif |
Heiko Schocher | 001a831 | 2014-03-18 08:09:56 +0100 | [diff] [blame] | 120 | #ifndef DFU_MANIFEST_POLL_TIMEOUT |
| 121 | #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT |
| 122 | #endif |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 123 | |
| 124 | struct dfu_entity { |
| 125 | char name[DFU_NAME_SIZE]; |
| 126 | int alt; |
| 127 | void *dev_private; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 128 | enum dfu_device_type dev_type; |
| 129 | enum dfu_layout layout; |
Stephen Warren | 7ac1b41 | 2014-06-11 16:03:34 -0600 | [diff] [blame] | 130 | unsigned long max_buf_size; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 131 | |
| 132 | union { |
| 133 | struct mmc_internal_data mmc; |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 134 | struct mtd_internal_data mtd; |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 135 | struct nand_internal_data nand; |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 136 | struct ram_internal_data ram; |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 137 | struct sf_internal_data sf; |
Patrick Delaunay | ec44cac | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 138 | struct virt_internal_data virt; |
Caleb Connolly | 5e602aa | 2023-12-06 22:01:30 +0000 | [diff] [blame^] | 139 | struct scsi_internal_data scsi; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 140 | } data; |
| 141 | |
Patrick Delaunay | 15970d8 | 2017-07-19 16:39:23 +0200 | [diff] [blame] | 142 | int (*get_medium_size)(struct dfu_entity *dfu, u64 *size); |
Stephen Warren | 0e285b5 | 2014-06-11 12:47:27 -0600 | [diff] [blame] | 143 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 144 | int (*read_medium)(struct dfu_entity *dfu, |
| 145 | u64 offset, void *buf, long *len); |
| 146 | |
| 147 | int (*write_medium)(struct dfu_entity *dfu, |
| 148 | u64 offset, void *buf, long *len); |
| 149 | |
| 150 | int (*flush_medium)(struct dfu_entity *dfu); |
Heiko Schocher | fc25fa2 | 2014-04-11 07:59:47 +0200 | [diff] [blame] | 151 | unsigned int (*poll_timeout)(struct dfu_entity *dfu); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 152 | |
Stephen Warren | cb7bd2e | 2014-06-11 16:03:35 -0600 | [diff] [blame] | 153 | void (*free_entity)(struct dfu_entity *dfu); |
| 154 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 155 | struct list_head list; |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 156 | |
| 157 | /* on the fly state */ |
| 158 | u32 crc; |
| 159 | u64 offset; |
| 160 | int i_blk_seq_num; |
| 161 | u8 *i_buf; |
| 162 | u8 *i_buf_start; |
| 163 | u8 *i_buf_end; |
Patrick Delaunay | 15970d8 | 2017-07-19 16:39:23 +0200 | [diff] [blame] | 164 | u64 r_left; |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 165 | long b_left; |
| 166 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 167 | u32 bad_skip; /* for nand use */ |
| 168 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 169 | unsigned int inited:1; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 170 | }; |
| 171 | |
AKASHI Takahiro | 6beaa47 | 2020-10-29 13:47:44 +0900 | [diff] [blame] | 172 | struct list_head; |
| 173 | extern struct list_head dfu_list; |
| 174 | |
Przemyslaw Marczak | 899a528 | 2015-02-17 12:24:11 +0100 | [diff] [blame] | 175 | #ifdef CONFIG_SET_DFU_ALT_INFO |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 176 | /** |
| 177 | * set_dfu_alt_info() - set dfu_alt_info environment variable |
| 178 | * |
| 179 | * If CONFIG_SET_DFU_ALT_INFO=y, this board specific function is called to set |
| 180 | * environment variable dfu_alt_info. |
| 181 | * |
| 182 | * @interface: dfu interface, e.g. "mmc" or "nand" |
| 183 | * @devstr: device number as string |
| 184 | */ |
Przemyslaw Marczak | 899a528 | 2015-02-17 12:24:11 +0100 | [diff] [blame] | 185 | void set_dfu_alt_info(char *interface, char *devstr); |
| 186 | #endif |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 187 | |
| 188 | /** |
| 189 | * dfu_alt_init() - initialize buffer for dfu entities |
| 190 | * |
| 191 | * @num: number of entities |
| 192 | * @dfu: on return allocated buffer |
| 193 | * Return: 0 on success |
| 194 | */ |
Patrick Delaunay | 9ada683 | 2019-10-14 09:28:01 +0200 | [diff] [blame] | 195 | int dfu_alt_init(int num, struct dfu_entity **dfu); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 196 | |
| 197 | /** |
| 198 | * dfu_alt_add() - add alternate to dfu entity buffer |
| 199 | * |
| 200 | * @dfu: dfu entity |
| 201 | * @interface: dfu interface, e.g. "mmc" or "nand" |
| 202 | * @devstr: device number as string |
| 203 | * @s: string description of alternate |
| 204 | * Return: 0 on success |
| 205 | */ |
Patrick Delaunay | 9ada683 | 2019-10-14 09:28:01 +0200 | [diff] [blame] | 206 | int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 207 | |
| 208 | /** |
| 209 | * dfu_config_entities() - initialize dfu entitities from envirionment |
| 210 | * |
| 211 | * Initialize the list of dfu entities from environment variable dfu_alt_info. |
| 212 | * The list must be freed by calling dfu_free_entities(). This function bypasses |
| 213 | * set_dfu_alt_info(). So typically you should use dfu_init_env_entities() |
| 214 | * instead. |
| 215 | * |
| 216 | * See function :c:func:`dfu_free_entities` |
| 217 | * See function :c:func:`dfu_init_env_entities` |
| 218 | * |
| 219 | * @s: string with alternates |
| 220 | * @interface: interface, e.g. "mmc" or "nand" |
| 221 | * @devstr: device number as string |
| 222 | * Return: 0 on success, a negative error code otherwise |
| 223 | */ |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 224 | int dfu_config_entities(char *s, char *interface, char *devstr); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 225 | |
| 226 | /** |
| 227 | * dfu_free_entities() - free the list of dfu entities |
| 228 | * |
| 229 | * Free the internal list of dfu entities. |
| 230 | * |
| 231 | * See function :c:func:`dfu_init_env_entities` |
| 232 | */ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 233 | void dfu_free_entities(void); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 234 | |
| 235 | /** |
| 236 | * dfu_show_entities() - print DFU alt settings list |
| 237 | */ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 238 | void dfu_show_entities(void); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 239 | |
| 240 | /** |
| 241 | * dfu_get_alt_number() - get number of alternates |
| 242 | * |
| 243 | * Return: number of alternates in the dfu entities list |
| 244 | */ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 245 | int dfu_get_alt_number(void); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 246 | |
| 247 | /** |
| 248 | * dfu_get_dev_type() - get string representation for dfu device type |
| 249 | * |
| 250 | * @type: device type |
| 251 | * Return: string representation for device type |
| 252 | */ |
| 253 | const char *dfu_get_dev_type(enum dfu_device_type type); |
| 254 | |
| 255 | /** |
| 256 | * dfu_get_layout() - get string describing layout |
| 257 | * |
| 258 | * Internally layouts are represented by enum dfu_device_type values. This |
| 259 | * function translates an enum value to a human readable string, e.g. DFU_FS_FAT |
| 260 | * is translated to "FAT". |
| 261 | * |
| 262 | * @layout: layout |
| 263 | * Result: string representation for the layout |
| 264 | */ |
| 265 | const char *dfu_get_layout(enum dfu_layout layout); |
| 266 | |
| 267 | /** |
| 268 | * dfu_get_entity() - get dfu entity for an alternate id |
| 269 | * |
| 270 | * @alt: alternate id |
| 271 | * Return: dfu entity |
| 272 | */ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 273 | struct dfu_entity *dfu_get_entity(int alt); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 274 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 275 | char *dfu_extract_token(char** e, int *n); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 276 | |
| 277 | /** |
| 278 | * dfu_get_alt() - get alternate id for filename |
| 279 | * |
| 280 | * Environment variable dfu_alt_info defines the write destinations (alternates) |
| 281 | * for different filenames. This function get the index of the alternate for |
| 282 | * a filename. If an absolute filename is provided (starting with '/'), the |
| 283 | * directory path is ignored. |
| 284 | * |
| 285 | * @name: filename |
| 286 | * Return: id of the alternate or negative error number (-ENODEV) |
| 287 | */ |
Lukasz Majewski | fed936e | 2013-10-08 14:30:38 +0200 | [diff] [blame] | 288 | int dfu_get_alt(char *name); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 289 | |
| 290 | /** |
| 291 | * dfu_init_env_entities() - initialize dfu entitities from envirionment |
| 292 | * |
| 293 | * Initialize the list of dfu entities from environment variable dfu_alt_info. |
| 294 | * The list must be freed by calling dfu_free_entities(). |
| 295 | * @interface and @devstr are used to select the relevant set of alternates |
| 296 | * from environment variable dfu_alt_info. |
| 297 | * |
| 298 | * If environment variable dfu_alt_info specifies the interface and the device, |
| 299 | * use NULL for @interface and @devstr. |
| 300 | * |
| 301 | * See function :c:func:`dfu_free_entities` |
| 302 | * |
| 303 | * @interface: interface, e.g. "mmc" or "nand" |
| 304 | * @devstr: device number as string |
| 305 | * Return: 0 on success, a negative error code otherwise |
| 306 | */ |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 307 | int dfu_init_env_entities(char *interface, char *devstr); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 308 | |
Stephen Warren | 7ac1b41 | 2014-06-11 16:03:34 -0600 | [diff] [blame] | 309 | unsigned char *dfu_get_buf(struct dfu_entity *dfu); |
Lukasz Majewski | d427826 | 2013-10-08 14:30:39 +0200 | [diff] [blame] | 310 | unsigned char *dfu_free_buf(void); |
Lukasz Majewski | 4fb1278 | 2013-12-09 16:20:13 +0100 | [diff] [blame] | 311 | unsigned long dfu_get_buf_size(void); |
Lukasz Majewski | 1cc03c5 | 2014-08-25 11:07:28 +0200 | [diff] [blame] | 312 | bool dfu_usb_get_reset(void); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 313 | |
Andy Shevchenko | 98a8f44 | 2019-11-27 18:12:15 +0200 | [diff] [blame] | 314 | #ifdef CONFIG_DFU_TIMEOUT |
| 315 | unsigned long dfu_get_timeout(void); |
| 316 | void dfu_set_timeout(unsigned long); |
| 317 | #endif |
| 318 | |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 319 | /** |
| 320 | * dfu_read() - read from dfu entity |
| 321 | * |
| 322 | * The block sequence number @blk_seq_num is a 16 bit counter that must be |
| 323 | * incremented with each call for the same dfu entity @de. |
| 324 | * |
| 325 | * @de: dfu entity |
| 326 | * @buf: buffer |
| 327 | * @size: size of buffer |
| 328 | * @blk_seq_num: block sequence number |
| 329 | * Return: 0 for success, -1 for error |
| 330 | */ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 331 | int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 332 | |
| 333 | /** |
| 334 | * dfu_write() - write to dfu entity |
| 335 | * |
| 336 | * Write the contents of a buffer @buf to the dfu entity @de. After writing |
| 337 | * the last block call dfu_flush(). If a file is already loaded completely |
| 338 | * into memory it is preferable to use dfu_write_from_mem_addr() which takes |
| 339 | * care of blockwise transfer and flushing. |
| 340 | * |
| 341 | * The block sequence number @blk_seq_num is a 16 bit counter that must be |
| 342 | * incremented with each call for the same dfu entity @de. |
| 343 | * |
| 344 | * See function :c:func:`dfu_flush` |
| 345 | * See function :c:func:`dfu_write_from_mem_addr` |
| 346 | * |
| 347 | * @de: dfu entity |
| 348 | * @buf: buffer |
| 349 | * @size: size of buffer |
| 350 | * @blk_seq_num: block sequence number |
| 351 | * Return: 0 for success, -1 for error |
| 352 | */ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 353 | int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 354 | |
| 355 | /** |
| 356 | * dfu_flush() - flush to dfu entity |
| 357 | * |
| 358 | * This function has to be called after writing the last block to the dfu |
| 359 | * entity @de. |
| 360 | * |
| 361 | * The block sequence number @blk_seq_num is a 16 bit counter that must be |
| 362 | * incremented with each call for the same dfu entity @de. |
| 363 | * |
| 364 | * See function :c:func:`dfu_write` |
| 365 | * |
| 366 | * @de: dfu entity |
| 367 | * @buf: ignored |
| 368 | * @size: ignored |
| 369 | * @blk_seq_num: block sequence number of last write - ignored |
| 370 | * Return: 0 for success, -1 for error |
| 371 | */ |
Heiko Schocher | a2199af | 2014-03-18 08:09:55 +0100 | [diff] [blame] | 372 | int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
Lukasz Majewski | 2092e46 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 373 | |
Patrick Delaunay | 067c13c | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 374 | /** |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 375 | * dfu_initiated_callback() - weak callback called on DFU transaction start |
Patrick Delaunay | 067c13c | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 376 | * |
| 377 | * It is a callback function called by DFU stack when a DFU transaction is |
| 378 | * initiated. This function allows to manage some board specific behavior on |
| 379 | * DFU targets. |
| 380 | * |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 381 | * @dfu: pointer to the dfu_entity, which should be initialized |
Patrick Delaunay | 067c13c | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 382 | */ |
| 383 | void dfu_initiated_callback(struct dfu_entity *dfu); |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 384 | |
Patrick Delaunay | 067c13c | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 385 | /** |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 386 | * dfu_flush_callback() - weak callback called at the end of the DFU write |
Patrick Delaunay | 067c13c | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 387 | * |
| 388 | * It is a callback function called by DFU stack after DFU manifestation. |
| 389 | * This function allows to manage some board specific behavior on DFU targets |
| 390 | * |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 391 | * @dfu: pointer to the dfu_entity, which should be flushed |
Patrick Delaunay | 067c13c | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 392 | */ |
| 393 | void dfu_flush_callback(struct dfu_entity *dfu); |
| 394 | |
Patrick Delaunay | d471032 | 2021-05-18 15:12:12 +0200 | [diff] [blame] | 395 | /** |
| 396 | * dfu_error_callback() - weak callback called at the DFU write error |
| 397 | * |
| 398 | * It is a callback function called by DFU stack after DFU write error. |
| 399 | * This function allows to manage some board specific behavior on DFU targets |
| 400 | * |
| 401 | * @dfu: pointer to the dfu_entity which cause the error |
| 402 | * @msg: the message of the error |
| 403 | */ |
| 404 | void dfu_error_callback(struct dfu_entity *dfu, const char *msg); |
| 405 | |
Patrick Delaunay | 5cf3972 | 2020-03-18 09:24:47 +0100 | [diff] [blame] | 406 | int dfu_transaction_initiate(struct dfu_entity *dfu, bool read); |
| 407 | void dfu_transaction_cleanup(struct dfu_entity *dfu); |
| 408 | |
Lukasz Majewski | fc18f8d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 409 | /* |
| 410 | * dfu_defer_flush - pointer to store dfu_entity for deferred flashing. |
| 411 | * It should be NULL when not used. |
| 412 | */ |
| 413 | extern struct dfu_entity *dfu_defer_flush; |
Heinrich Schuchardt | d181191 | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 414 | |
Lukasz Majewski | fc18f8d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 415 | /** |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 416 | * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer |
Lukasz Majewski | fc18f8d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 417 | * |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 418 | * Return: value of the dfu_defer_flush pointer |
Lukasz Majewski | fc18f8d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 419 | */ |
| 420 | static inline struct dfu_entity *dfu_get_defer_flush(void) |
| 421 | { |
| 422 | return dfu_defer_flush; |
| 423 | } |
| 424 | |
| 425 | /** |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 426 | * dfu_set_defer_flush() - set the dfu_defer_flush pointer |
Lukasz Majewski | fc18f8d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 427 | * |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 428 | * @dfu: pointer to the dfu_entity, which should be written |
Lukasz Majewski | fc18f8d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 429 | */ |
| 430 | static inline void dfu_set_defer_flush(struct dfu_entity *dfu) |
| 431 | { |
| 432 | dfu_defer_flush = dfu; |
| 433 | } |
| 434 | |
Lukasz Majewski | 2092e46 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 435 | /** |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 436 | * dfu_write_from_mem_addr() - write data from memory to DFU managed medium |
Lukasz Majewski | 2092e46 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 437 | * |
| 438 | * This function adds support for writing data starting from fixed memory |
| 439 | * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system) |
| 440 | * |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 441 | * @dfu: dfu entity to which we want to store data |
| 442 | * @buf: fixed memory address from where data starts |
| 443 | * @size: number of bytes to write |
Lukasz Majewski | 2092e46 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 444 | * |
Heinrich Schuchardt | f39c845 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 445 | * Return: 0 on success, other value on failure |
Lukasz Majewski | 2092e46 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 446 | */ |
| 447 | int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size); |
| 448 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 449 | /* Device specific */ |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 450 | /* Each entity has 5 arguments in maximum. */ |
| 451 | #define DFU_MAX_ENTITY_ARGS 5 |
| 452 | |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 453 | #if CONFIG_IS_ENABLED(DFU_MMC) |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 454 | extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, |
| 455 | char **argv, int argc); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 456 | #else |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 457 | static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 458 | char **argv, int argc) |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 459 | { |
| 460 | puts("MMC support not available!\n"); |
| 461 | return -1; |
| 462 | } |
| 463 | #endif |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 464 | |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 465 | #if CONFIG_IS_ENABLED(DFU_NAND) |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 466 | extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, |
| 467 | char **argv, int argc); |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 468 | #else |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 469 | static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 470 | char **argv, int argc) |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 471 | { |
| 472 | puts("NAND support not available!\n"); |
| 473 | return -1; |
| 474 | } |
| 475 | #endif |
| 476 | |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 477 | #if CONFIG_IS_ENABLED(DFU_RAM) |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 478 | extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, |
| 479 | char **argv, int argc); |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 480 | #else |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 481 | static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 482 | char **argv, int argc) |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 483 | { |
| 484 | puts("RAM support not available!\n"); |
| 485 | return -1; |
| 486 | } |
| 487 | #endif |
| 488 | |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 489 | #if CONFIG_IS_ENABLED(DFU_SF) |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 490 | extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, |
| 491 | char **argv, int argc); |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 492 | #else |
| 493 | static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 494 | char **argv, int argc) |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 495 | { |
| 496 | puts("SF support not available!\n"); |
| 497 | return -1; |
| 498 | } |
| 499 | #endif |
| 500 | |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 501 | #if CONFIG_IS_ENABLED(DFU_MTD) |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 502 | extern int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, |
| 503 | char **argv, int argc); |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 504 | #else |
| 505 | static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 506 | char **argv, int argc) |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 507 | { |
| 508 | puts("MTD support not available!\n"); |
| 509 | return -1; |
| 510 | } |
| 511 | #endif |
| 512 | |
Patrick Delaunay | bcd4110 | 2022-11-30 11:42:02 +0100 | [diff] [blame] | 513 | #if CONFIG_IS_ENABLED(DFU_VIRT) |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 514 | int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, |
| 515 | char **argv, int argc); |
Patrick Delaunay | ec44cac | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 516 | int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset, |
| 517 | void *buf, long *len); |
| 518 | int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size); |
| 519 | int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset, |
| 520 | void *buf, long *len); |
| 521 | #else |
| 522 | static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, |
Masami Hiramatsu | 53b4063 | 2022-01-31 11:52:37 +0900 | [diff] [blame] | 523 | char **argv, int argc) |
Patrick Delaunay | ec44cac | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 524 | { |
| 525 | puts("VIRT support not available!\n"); |
| 526 | return -1; |
| 527 | } |
| 528 | #endif |
| 529 | |
Caleb Connolly | 5e602aa | 2023-12-06 22:01:30 +0000 | [diff] [blame^] | 530 | #if CONFIG_IS_ENABLED(DFU_SCSI) |
| 531 | extern int dfu_fill_entity_scsi(struct dfu_entity *dfu, char *devstr, |
| 532 | char **argv, int argc); |
| 533 | #else |
| 534 | static inline int dfu_fill_entity_scsi(struct dfu_entity *dfu, char *devstr, |
| 535 | char **argv, int argc) |
| 536 | { |
| 537 | puts("SCSI support not available!\n"); |
| 538 | return -1; |
| 539 | } |
| 540 | #endif |
| 541 | |
Marek Szyprowski | c533f94 | 2020-12-22 11:32:22 +0100 | [diff] [blame] | 542 | extern bool dfu_reinit_needed; |
| 543 | |
AKASHI Takahiro | f234566 | 2020-10-29 13:47:52 +0900 | [diff] [blame] | 544 | #if CONFIG_IS_ENABLED(DFU_WRITE_ALT) |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 545 | /** |
AKASHI Takahiro | 045fd8b | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 546 | * dfu_write_by_name() - write data to DFU medium |
| 547 | * @dfu_entity_name: Name of DFU entity to write |
| 548 | * @addr: Address of data buffer to write |
| 549 | * @len: Number of bytes |
| 550 | * @interface: Destination DFU medium (e.g. "mmc") |
| 551 | * @devstring: Instance number of destination DFU medium (e.g. "1") |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 552 | * |
AKASHI Takahiro | 045fd8b | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 553 | * This function is storing data received on DFU supported medium which |
| 554 | * is specified by @dfu_entity_name. |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 555 | * |
AKASHI Takahiro | 045fd8b | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 556 | * Return: 0 - on success, error code - otherwise |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 557 | */ |
AKASHI Takahiro | 1c2d129 | 2020-10-29 13:47:42 +0900 | [diff] [blame] | 558 | int dfu_write_by_name(char *dfu_entity_name, void *addr, |
AKASHI Takahiro | 045fd8b | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 559 | unsigned int len, char *interface, char *devstring); |
AKASHI Takahiro | f234566 | 2020-10-29 13:47:52 +0900 | [diff] [blame] | 560 | |
| 561 | /** |
| 562 | * dfu_write_by_alt() - write data to DFU medium |
| 563 | * @dfu_alt_num: DFU alt setting number |
| 564 | * @addr: Address of data buffer to write |
| 565 | * @len: Number of bytes |
| 566 | * @interface: Destination DFU medium (e.g. "mmc") |
| 567 | * @devstring: Instance number of destination DFU medium (e.g. "1") |
| 568 | * |
| 569 | * This function is storing data received on DFU supported medium which |
| 570 | * is specified by @dfu_alt_name. |
| 571 | * |
| 572 | * Return: 0 - on success, error code - otherwise |
| 573 | */ |
| 574 | int dfu_write_by_alt(int dfu_alt_num, void *addr, unsigned int len, |
| 575 | char *interface, char *devstring); |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 576 | #else |
AKASHI Takahiro | 1c2d129 | 2020-10-29 13:47:42 +0900 | [diff] [blame] | 577 | static inline int dfu_write_by_name(char *dfu_entity_name, void *addr, |
AKASHI Takahiro | 045fd8b | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 578 | unsigned int len, char *interface, |
| 579 | char *devstring) |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 580 | { |
AKASHI Takahiro | 045fd8b | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 581 | puts("write support for DFU not available!\n"); |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 582 | return -ENOSYS; |
| 583 | } |
AKASHI Takahiro | f234566 | 2020-10-29 13:47:52 +0900 | [diff] [blame] | 584 | |
| 585 | static inline int dfu_write_by_alt(int dfu_alt_num, void *addr, |
| 586 | unsigned int len, char *interface, |
| 587 | char *devstring) |
| 588 | { |
| 589 | puts("write support for DFU not available!\n"); |
| 590 | return -ENOSYS; |
| 591 | } |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 592 | #endif |
| 593 | |
Lukasz Majewski | a6921ad | 2013-09-17 15:58:23 +0200 | [diff] [blame] | 594 | int dfu_add(struct usb_configuration *c); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 595 | #endif /* __DFU_ENTITY_H_ */ |