Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
Lukasz Majewski | d311c6e | 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 | d311c6e | 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 | 0280af7 | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 16 | #include <spi_flash.h> |
Lukasz Majewski | c421946 | 2013-09-17 15:58:23 +0200 | [diff] [blame] | 17 | #include <linux/usb/composite.h> |
Lukasz Majewski | d311c6e | 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 | e3c687a | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 23 | DFU_DEV_RAM, |
Stephen Warren | 0280af7 | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 24 | DFU_DEV_SF, |
Patrick Delaunay | f7aee23 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 25 | DFU_DEV_MTD, |
Patrick Delaunay | 2111e3c | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 26 | DFU_DEV_VIRT, |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 27 | }; |
| 28 | |
| 29 | enum dfu_layout { |
| 30 | DFU_RAW_ADDR = 1, |
| 31 | DFU_FS_FAT, |
| 32 | DFU_FS_EXT2, |
| 33 | DFU_FS_EXT3, |
| 34 | DFU_FS_EXT4, |
Afzal Mohammed | e3c687a | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 35 | DFU_RAM_ADDR, |
Jaehoon Chung | d7cbe12 | 2020-12-22 11:32:21 +0100 | [diff] [blame] | 36 | DFU_SKIP, |
Marek Szyprowski | b1fa1ad | 2020-12-22 11:32:22 +0100 | [diff] [blame] | 37 | DFU_SCRIPT, |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 38 | }; |
| 39 | |
Afzal Mohammed | b9a4a6b | 2013-09-18 01:14:50 +0530 | [diff] [blame] | 40 | enum dfu_op { |
| 41 | DFU_OP_READ = 1, |
| 42 | DFU_OP_WRITE, |
Stephen Warren | 020e6f3 | 2014-06-11 12:47:27 -0600 | [diff] [blame] | 43 | DFU_OP_SIZE, |
Afzal Mohammed | b9a4a6b | 2013-09-18 01:14:50 +0530 | [diff] [blame] | 44 | }; |
| 45 | |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 46 | struct mmc_internal_data { |
Stephen Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 47 | int dev_num; |
| 48 | |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 49 | /* RAW programming */ |
| 50 | unsigned int lba_start; |
| 51 | unsigned int lba_size; |
| 52 | unsigned int lba_blk_size; |
| 53 | |
Lukasz Majewski | 4da65ea | 2014-05-09 16:58:15 +0200 | [diff] [blame] | 54 | /* eMMC HW partition access */ |
| 55 | int hw_partition; |
| 56 | |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 57 | /* FAT/EXT */ |
| 58 | unsigned int dev; |
| 59 | unsigned int part; |
| 60 | }; |
| 61 | |
Patrick Delaunay | f7aee23 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 62 | struct mtd_internal_data { |
| 63 | struct mtd_info *info; |
| 64 | |
| 65 | /* RAW programming */ |
| 66 | u64 start; |
| 67 | u64 size; |
Patrick Delaunay | cb47cb0 | 2019-10-14 09:28:05 +0200 | [diff] [blame] | 68 | /* for ubi partition */ |
| 69 | unsigned int ubi; |
Patrick Delaunay | f7aee23 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 70 | }; |
| 71 | |
Pantelis Antoniou | cf14d0d | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 72 | struct nand_internal_data { |
| 73 | /* RAW programming */ |
| 74 | u64 start; |
| 75 | u64 size; |
| 76 | |
| 77 | unsigned int dev; |
| 78 | unsigned int part; |
Heiko Schocher | ad40139 | 2013-07-25 06:43:11 +0200 | [diff] [blame] | 79 | /* for nand/ubi use */ |
| 80 | unsigned int ubi; |
Pantelis Antoniou | cf14d0d | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 81 | }; |
| 82 | |
Afzal Mohammed | e3c687a | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 83 | struct ram_internal_data { |
Heinrich Schuchardt | 8784b0b | 2020-07-22 17:46:02 +0200 | [diff] [blame] | 84 | unsigned long start; |
Afzal Mohammed | e3c687a | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 85 | unsigned int size; |
| 86 | }; |
| 87 | |
Stephen Warren | 0280af7 | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 88 | struct sf_internal_data { |
| 89 | struct spi_flash *dev; |
| 90 | |
| 91 | /* RAW programming */ |
| 92 | u64 start; |
| 93 | u64 size; |
Patrick Delaunay | bdc0f12 | 2019-10-14 09:28:00 +0200 | [diff] [blame] | 94 | /* for sf/ubi use */ |
| 95 | unsigned int ubi; |
Stephen Warren | 0280af7 | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 96 | }; |
| 97 | |
Patrick Delaunay | 2111e3c | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 98 | struct virt_internal_data { |
| 99 | int dev_num; |
| 100 | }; |
| 101 | |
Tom Rini | 7384b5a | 2013-03-14 05:32:49 +0000 | [diff] [blame] | 102 | #define DFU_NAME_SIZE 32 |
Heiko Schocher | a2f831e | 2013-06-12 06:05:51 +0200 | [diff] [blame] | 103 | #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE |
| 104 | #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */ |
| 105 | #endif |
Pantelis Antoniou | a6e788d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 106 | #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE |
Lukasz Majewski | 3dda220 | 2013-09-10 15:29:23 +0200 | [diff] [blame] | 107 | #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE |
Pantelis Antoniou | a6e788d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 108 | #endif |
Lukasz Majewski | 2bb115f | 2013-12-09 16:20:14 +0100 | [diff] [blame] | 109 | #ifndef DFU_DEFAULT_POLL_TIMEOUT |
| 110 | #define DFU_DEFAULT_POLL_TIMEOUT 0 |
| 111 | #endif |
Heiko Schocher | e1ba151 | 2014-03-18 08:09:56 +0100 | [diff] [blame] | 112 | #ifndef DFU_MANIFEST_POLL_TIMEOUT |
| 113 | #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT |
| 114 | #endif |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 115 | |
| 116 | struct dfu_entity { |
| 117 | char name[DFU_NAME_SIZE]; |
| 118 | int alt; |
| 119 | void *dev_private; |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 120 | enum dfu_device_type dev_type; |
| 121 | enum dfu_layout layout; |
Stephen Warren | f950098 | 2014-06-11 16:03:34 -0600 | [diff] [blame] | 122 | unsigned long max_buf_size; |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 123 | |
| 124 | union { |
| 125 | struct mmc_internal_data mmc; |
Patrick Delaunay | f7aee23 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 126 | struct mtd_internal_data mtd; |
Pantelis Antoniou | cf14d0d | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 127 | struct nand_internal_data nand; |
Afzal Mohammed | e3c687a | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 128 | struct ram_internal_data ram; |
Stephen Warren | 0280af7 | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 129 | struct sf_internal_data sf; |
Patrick Delaunay | 2111e3c | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 130 | struct virt_internal_data virt; |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 131 | } data; |
| 132 | |
Patrick Delaunay | f4e934f | 2017-07-19 16:39:23 +0200 | [diff] [blame] | 133 | int (*get_medium_size)(struct dfu_entity *dfu, u64 *size); |
Stephen Warren | 020e6f3 | 2014-06-11 12:47:27 -0600 | [diff] [blame] | 134 | |
Pantelis Antoniou | a6e788d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 135 | 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 Schocher | b948810 | 2014-04-11 07:59:47 +0200 | [diff] [blame] | 142 | unsigned int (*poll_timeout)(struct dfu_entity *dfu); |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 143 | |
Stephen Warren | a5f77f6 | 2014-06-11 16:03:35 -0600 | [diff] [blame] | 144 | void (*free_entity)(struct dfu_entity *dfu); |
| 145 | |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 146 | struct list_head list; |
Pantelis Antoniou | a6e788d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 147 | |
| 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 Delaunay | f4e934f | 2017-07-19 16:39:23 +0200 | [diff] [blame] | 155 | u64 r_left; |
Pantelis Antoniou | a6e788d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 156 | long b_left; |
| 157 | |
Pantelis Antoniou | cf14d0d | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 158 | u32 bad_skip; /* for nand use */ |
| 159 | |
Pantelis Antoniou | a6e788d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 160 | unsigned int inited:1; |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 161 | }; |
| 162 | |
AKASHI Takahiro | b24b829 | 2020-10-29 13:47:44 +0900 | [diff] [blame] | 163 | struct list_head; |
| 164 | extern struct list_head dfu_list; |
| 165 | |
Przemyslaw Marczak | d0dd609 | 2015-02-17 12:24:11 +0100 | [diff] [blame] | 166 | #ifdef CONFIG_SET_DFU_ALT_INFO |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 167 | /** |
| 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 Marczak | d0dd609 | 2015-02-17 12:24:11 +0100 | [diff] [blame] | 176 | void set_dfu_alt_info(char *interface, char *devstr); |
| 177 | #endif |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 178 | |
| 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 Delaunay | 0f8fad8 | 2019-10-14 09:28:01 +0200 | [diff] [blame] | 186 | int dfu_alt_init(int num, struct dfu_entity **dfu); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 187 | |
| 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 Delaunay | 0f8fad8 | 2019-10-14 09:28:01 +0200 | [diff] [blame] | 197 | int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 198 | |
| 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 Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 215 | int dfu_config_entities(char *s, char *interface, char *devstr); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 216 | |
| 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 Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 224 | void dfu_free_entities(void); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 225 | |
| 226 | /** |
| 227 | * dfu_show_entities() - print DFU alt settings list |
| 228 | */ |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 229 | void dfu_show_entities(void); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 230 | |
| 231 | /** |
| 232 | * dfu_get_alt_number() - get number of alternates |
| 233 | * |
| 234 | * Return: number of alternates in the dfu entities list |
| 235 | */ |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 236 | int dfu_get_alt_number(void); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 237 | |
| 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 | */ |
| 244 | const 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 | */ |
| 256 | const 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 Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 264 | struct dfu_entity *dfu_get_entity(int alt); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 265 | |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 266 | char *dfu_extract_token(char** e, int *n); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 267 | |
| 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 Majewski | 1737f0f | 2013-10-08 14:30:38 +0200 | [diff] [blame] | 279 | int dfu_get_alt(char *name); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 280 | |
| 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 Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 298 | int dfu_init_env_entities(char *interface, char *devstr); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 299 | |
Stephen Warren | f950098 | 2014-06-11 16:03:34 -0600 | [diff] [blame] | 300 | unsigned char *dfu_get_buf(struct dfu_entity *dfu); |
Lukasz Majewski | 3426423 | 2013-10-08 14:30:39 +0200 | [diff] [blame] | 301 | unsigned char *dfu_free_buf(void); |
Lukasz Majewski | 031d413 | 2013-12-09 16:20:13 +0100 | [diff] [blame] | 302 | unsigned long dfu_get_buf_size(void); |
Lukasz Majewski | d9eae70 | 2014-08-25 11:07:28 +0200 | [diff] [blame] | 303 | bool dfu_usb_get_reset(void); |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 304 | |
Andy Shevchenko | 1e41401 | 2019-11-27 18:12:15 +0200 | [diff] [blame] | 305 | #ifdef CONFIG_DFU_TIMEOUT |
| 306 | unsigned long dfu_get_timeout(void); |
| 307 | void dfu_set_timeout(unsigned long); |
| 308 | #endif |
| 309 | |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 310 | /** |
| 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 Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 322 | int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 323 | |
| 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 Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 344 | int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 345 | |
| 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 Schocher | 941b384 | 2014-03-18 08:09:55 +0100 | [diff] [blame] | 363 | int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
Lukasz Majewski | cc2d026 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 364 | |
Patrick Delaunay | 773771f | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 365 | /** |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 366 | * dfu_initiated_callback() - weak callback called on DFU transaction start |
Patrick Delaunay | 773771f | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 367 | * |
| 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 Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 372 | * @dfu: pointer to the dfu_entity, which should be initialized |
Patrick Delaunay | 773771f | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 373 | */ |
| 374 | void dfu_initiated_callback(struct dfu_entity *dfu); |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 375 | |
Patrick Delaunay | 773771f | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 376 | /** |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 377 | * dfu_flush_callback() - weak callback called at the end of the DFU write |
Patrick Delaunay | 773771f | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 378 | * |
| 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 Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 382 | * @dfu: pointer to the dfu_entity, which should be flushed |
Patrick Delaunay | 773771f | 2019-10-14 09:28:07 +0200 | [diff] [blame] | 383 | */ |
| 384 | void dfu_flush_callback(struct dfu_entity *dfu); |
| 385 | |
Patrick Delaunay | 5a9aa2f | 2020-03-18 09:24:47 +0100 | [diff] [blame] | 386 | int dfu_transaction_initiate(struct dfu_entity *dfu, bool read); |
| 387 | void dfu_transaction_cleanup(struct dfu_entity *dfu); |
| 388 | |
Lukasz Majewski | 365a70d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 389 | /* |
| 390 | * dfu_defer_flush - pointer to store dfu_entity for deferred flashing. |
| 391 | * It should be NULL when not used. |
| 392 | */ |
| 393 | extern struct dfu_entity *dfu_defer_flush; |
Heinrich Schuchardt | ec2d3da | 2020-05-23 14:24:40 +0200 | [diff] [blame] | 394 | |
Lukasz Majewski | 365a70d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 395 | /** |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 396 | * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer |
Lukasz Majewski | 365a70d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 397 | * |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 398 | * Return: value of the dfu_defer_flush pointer |
Lukasz Majewski | 365a70d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 399 | */ |
| 400 | static inline struct dfu_entity *dfu_get_defer_flush(void) |
| 401 | { |
| 402 | return dfu_defer_flush; |
| 403 | } |
| 404 | |
| 405 | /** |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 406 | * dfu_set_defer_flush() - set the dfu_defer_flush pointer |
Lukasz Majewski | 365a70d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 407 | * |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 408 | * @dfu: pointer to the dfu_entity, which should be written |
Lukasz Majewski | 365a70d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 409 | */ |
| 410 | static inline void dfu_set_defer_flush(struct dfu_entity *dfu) |
| 411 | { |
| 412 | dfu_defer_flush = dfu; |
| 413 | } |
| 414 | |
Lukasz Majewski | cc2d026 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 415 | /** |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 416 | * dfu_write_from_mem_addr() - write data from memory to DFU managed medium |
Lukasz Majewski | cc2d026 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 417 | * |
| 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 Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 421 | * @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 Majewski | cc2d026 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 424 | * |
Heinrich Schuchardt | d523818 | 2020-05-23 12:01:08 +0200 | [diff] [blame] | 425 | * Return: 0 on success, other value on failure |
Lukasz Majewski | cc2d026 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 426 | */ |
| 427 | int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size); |
| 428 | |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 429 | /* Device specific */ |
Andrew F. Davis | 159eb4b | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 430 | #if CONFIG_IS_ENABLED(DFU_MMC) |
Stephen Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 431 | extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s); |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 432 | #else |
Stephen Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 433 | static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, |
| 434 | char *s) |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 435 | { |
| 436 | puts("MMC support not available!\n"); |
| 437 | return -1; |
| 438 | } |
| 439 | #endif |
Pantelis Antoniou | cf14d0d | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 440 | |
Andrew F. Davis | 159eb4b | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 441 | #if CONFIG_IS_ENABLED(DFU_NAND) |
Stephen Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 442 | extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s); |
Pantelis Antoniou | cf14d0d | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 443 | #else |
Stephen Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 444 | static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, |
| 445 | char *s) |
Pantelis Antoniou | cf14d0d | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 446 | { |
| 447 | puts("NAND support not available!\n"); |
| 448 | return -1; |
| 449 | } |
| 450 | #endif |
| 451 | |
Andrew F. Davis | 159eb4b | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 452 | #if CONFIG_IS_ENABLED(DFU_RAM) |
Stephen Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 453 | extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s); |
Afzal Mohammed | e3c687a | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 454 | #else |
Stephen Warren | 4afe50f | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 455 | static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, |
| 456 | char *s) |
Afzal Mohammed | e3c687a | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 457 | { |
| 458 | puts("RAM support not available!\n"); |
| 459 | return -1; |
| 460 | } |
| 461 | #endif |
| 462 | |
Andrew F. Davis | 159eb4b | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 463 | #if CONFIG_IS_ENABLED(DFU_SF) |
Stephen Warren | 0280af7 | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 464 | extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s); |
| 465 | #else |
| 466 | static 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 Delaunay | f7aee23 | 2019-10-14 09:28:04 +0200 | [diff] [blame] | 474 | #if CONFIG_IS_ENABLED(DFU_MTD) |
| 475 | int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s); |
| 476 | #else |
| 477 | static 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 Delaunay | 2111e3c | 2019-10-14 09:28:06 +0200 | [diff] [blame] | 485 | #ifdef CONFIG_DFU_VIRT |
| 486 | int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, char *s); |
| 487 | int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset, |
| 488 | void *buf, long *len); |
| 489 | int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size); |
| 490 | int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset, |
| 491 | void *buf, long *len); |
| 492 | #else |
| 493 | static 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 Szyprowski | b1fa1ad | 2020-12-22 11:32:22 +0100 | [diff] [blame] | 501 | extern bool dfu_reinit_needed; |
| 502 | |
AKASHI Takahiro | 0e84a04 | 2020-10-29 13:47:52 +0900 | [diff] [blame] | 503 | #if CONFIG_IS_ENABLED(DFU_WRITE_ALT) |
Lukasz Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 504 | /** |
AKASHI Takahiro | fb6732f | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 505 | * 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 Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 511 | * |
AKASHI Takahiro | fb6732f | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 512 | * This function is storing data received on DFU supported medium which |
| 513 | * is specified by @dfu_entity_name. |
Lukasz Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 514 | * |
AKASHI Takahiro | fb6732f | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 515 | * Return: 0 - on success, error code - otherwise |
Lukasz Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 516 | */ |
AKASHI Takahiro | bd4dc18 | 2020-10-29 13:47:42 +0900 | [diff] [blame] | 517 | int dfu_write_by_name(char *dfu_entity_name, void *addr, |
AKASHI Takahiro | fb6732f | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 518 | unsigned int len, char *interface, char *devstring); |
AKASHI Takahiro | 0e84a04 | 2020-10-29 13:47:52 +0900 | [diff] [blame] | 519 | |
| 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 | */ |
| 533 | int dfu_write_by_alt(int dfu_alt_num, void *addr, unsigned int len, |
| 534 | char *interface, char *devstring); |
Lukasz Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 535 | #else |
AKASHI Takahiro | bd4dc18 | 2020-10-29 13:47:42 +0900 | [diff] [blame] | 536 | static inline int dfu_write_by_name(char *dfu_entity_name, void *addr, |
AKASHI Takahiro | fb6732f | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 537 | unsigned int len, char *interface, |
| 538 | char *devstring) |
Lukasz Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 539 | { |
AKASHI Takahiro | fb6732f | 2020-10-29 13:47:41 +0900 | [diff] [blame] | 540 | puts("write support for DFU not available!\n"); |
Lukasz Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 541 | return -ENOSYS; |
| 542 | } |
AKASHI Takahiro | 0e84a04 | 2020-10-29 13:47:52 +0900 | [diff] [blame] | 543 | |
| 544 | static 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 Majewski | 507375c | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 551 | #endif |
| 552 | |
Lukasz Majewski | c421946 | 2013-09-17 15:58:23 +0200 | [diff] [blame] | 553 | int dfu_add(struct usb_configuration *c); |
Lukasz Majewski | d311c6e | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 554 | #endif /* __DFU_ENTITY_H_ */ |