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, |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 26 | }; |
| 27 | |
| 28 | enum dfu_layout { |
| 29 | DFU_RAW_ADDR = 1, |
| 30 | DFU_FS_FAT, |
| 31 | DFU_FS_EXT2, |
| 32 | DFU_FS_EXT3, |
| 33 | DFU_FS_EXT4, |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 34 | DFU_RAM_ADDR, |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 35 | }; |
| 36 | |
Afzal Mohammed | 5a127c8 | 2013-09-18 01:14:50 +0530 | [diff] [blame] | 37 | enum dfu_op { |
| 38 | DFU_OP_READ = 1, |
| 39 | DFU_OP_WRITE, |
Stephen Warren | 0e285b5 | 2014-06-11 12:47:27 -0600 | [diff] [blame] | 40 | DFU_OP_SIZE, |
Afzal Mohammed | 5a127c8 | 2013-09-18 01:14:50 +0530 | [diff] [blame] | 41 | }; |
| 42 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 43 | struct mmc_internal_data { |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 44 | int dev_num; |
| 45 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 46 | /* RAW programming */ |
| 47 | unsigned int lba_start; |
| 48 | unsigned int lba_size; |
| 49 | unsigned int lba_blk_size; |
| 50 | |
Lukasz Majewski | c8151b4 | 2014-05-09 16:58:15 +0200 | [diff] [blame] | 51 | /* eMMC HW partition access */ |
| 52 | int hw_partition; |
| 53 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 54 | /* FAT/EXT */ |
| 55 | unsigned int dev; |
| 56 | unsigned int part; |
| 57 | }; |
| 58 | |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame^] | 59 | struct mtd_internal_data { |
| 60 | struct mtd_info *info; |
| 61 | |
| 62 | /* RAW programming */ |
| 63 | u64 start; |
| 64 | u64 size; |
| 65 | }; |
| 66 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 67 | struct nand_internal_data { |
| 68 | /* RAW programming */ |
| 69 | u64 start; |
| 70 | u64 size; |
| 71 | |
| 72 | unsigned int dev; |
| 73 | unsigned int part; |
Heiko Schocher | 815c30b | 2013-07-25 06:43:11 +0200 | [diff] [blame] | 74 | /* for nand/ubi use */ |
| 75 | unsigned int ubi; |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 76 | }; |
| 77 | |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 78 | struct ram_internal_data { |
| 79 | void *start; |
| 80 | unsigned int size; |
| 81 | }; |
| 82 | |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 83 | struct sf_internal_data { |
| 84 | struct spi_flash *dev; |
| 85 | |
| 86 | /* RAW programming */ |
| 87 | u64 start; |
| 88 | u64 size; |
Patrick Delaunay | cb986ba | 2019-10-14 09:28:00 +0200 | [diff] [blame] | 89 | /* for sf/ubi use */ |
| 90 | unsigned int ubi; |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 91 | }; |
| 92 | |
Tom Rini | a24c315 | 2013-03-14 05:32:49 +0000 | [diff] [blame] | 93 | #define DFU_NAME_SIZE 32 |
Heiko Schocher | e7e75c7 | 2013-06-12 06:05:51 +0200 | [diff] [blame] | 94 | #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE |
| 95 | #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */ |
| 96 | #endif |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 97 | #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE |
Lukasz Majewski | 7a813d5 | 2013-09-10 15:29:23 +0200 | [diff] [blame] | 98 | #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 99 | #endif |
Lukasz Majewski | 33fac4a | 2013-12-09 16:20:14 +0100 | [diff] [blame] | 100 | #ifndef DFU_DEFAULT_POLL_TIMEOUT |
| 101 | #define DFU_DEFAULT_POLL_TIMEOUT 0 |
| 102 | #endif |
Heiko Schocher | 001a831 | 2014-03-18 08:09:56 +0100 | [diff] [blame] | 103 | #ifndef DFU_MANIFEST_POLL_TIMEOUT |
| 104 | #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT |
| 105 | #endif |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 106 | |
| 107 | struct dfu_entity { |
| 108 | char name[DFU_NAME_SIZE]; |
| 109 | int alt; |
| 110 | void *dev_private; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 111 | enum dfu_device_type dev_type; |
| 112 | enum dfu_layout layout; |
Stephen Warren | 7ac1b41 | 2014-06-11 16:03:34 -0600 | [diff] [blame] | 113 | unsigned long max_buf_size; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 114 | |
| 115 | union { |
| 116 | struct mmc_internal_data mmc; |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame^] | 117 | struct mtd_internal_data mtd; |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 118 | struct nand_internal_data nand; |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 119 | struct ram_internal_data ram; |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 120 | struct sf_internal_data sf; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 121 | } data; |
| 122 | |
Patrick Delaunay | 15970d8 | 2017-07-19 16:39:23 +0200 | [diff] [blame] | 123 | int (*get_medium_size)(struct dfu_entity *dfu, u64 *size); |
Stephen Warren | 0e285b5 | 2014-06-11 12:47:27 -0600 | [diff] [blame] | 124 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 125 | int (*read_medium)(struct dfu_entity *dfu, |
| 126 | u64 offset, void *buf, long *len); |
| 127 | |
| 128 | int (*write_medium)(struct dfu_entity *dfu, |
| 129 | u64 offset, void *buf, long *len); |
| 130 | |
| 131 | int (*flush_medium)(struct dfu_entity *dfu); |
Heiko Schocher | fc25fa2 | 2014-04-11 07:59:47 +0200 | [diff] [blame] | 132 | unsigned int (*poll_timeout)(struct dfu_entity *dfu); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 133 | |
Stephen Warren | cb7bd2e | 2014-06-11 16:03:35 -0600 | [diff] [blame] | 134 | void (*free_entity)(struct dfu_entity *dfu); |
| 135 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 136 | struct list_head list; |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 137 | |
| 138 | /* on the fly state */ |
| 139 | u32 crc; |
| 140 | u64 offset; |
| 141 | int i_blk_seq_num; |
| 142 | u8 *i_buf; |
| 143 | u8 *i_buf_start; |
| 144 | u8 *i_buf_end; |
Patrick Delaunay | 15970d8 | 2017-07-19 16:39:23 +0200 | [diff] [blame] | 145 | u64 r_left; |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 146 | long b_left; |
| 147 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 148 | u32 bad_skip; /* for nand use */ |
| 149 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 150 | unsigned int inited:1; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 151 | }; |
| 152 | |
Przemyslaw Marczak | 899a528 | 2015-02-17 12:24:11 +0100 | [diff] [blame] | 153 | #ifdef CONFIG_SET_DFU_ALT_INFO |
| 154 | void set_dfu_alt_info(char *interface, char *devstr); |
| 155 | #endif |
Patrick Delaunay | 9ada683 | 2019-10-14 09:28:01 +0200 | [diff] [blame] | 156 | int dfu_alt_init(int num, struct dfu_entity **dfu); |
| 157 | int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s); |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 158 | int dfu_config_entities(char *s, char *interface, char *devstr); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 159 | void dfu_free_entities(void); |
| 160 | void dfu_show_entities(void); |
| 161 | int dfu_get_alt_number(void); |
| 162 | const char *dfu_get_dev_type(enum dfu_device_type t); |
| 163 | const char *dfu_get_layout(enum dfu_layout l); |
| 164 | struct dfu_entity *dfu_get_entity(int alt); |
| 165 | char *dfu_extract_token(char** e, int *n); |
Lukasz Majewski | 6bed7ce | 2013-07-18 13:19:14 +0200 | [diff] [blame] | 166 | void dfu_trigger_reset(void); |
Lukasz Majewski | fed936e | 2013-10-08 14:30:38 +0200 | [diff] [blame] | 167 | int dfu_get_alt(char *name); |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 168 | int dfu_init_env_entities(char *interface, char *devstr); |
Stephen Warren | 7ac1b41 | 2014-06-11 16:03:34 -0600 | [diff] [blame] | 169 | unsigned char *dfu_get_buf(struct dfu_entity *dfu); |
Lukasz Majewski | d427826 | 2013-10-08 14:30:39 +0200 | [diff] [blame] | 170 | unsigned char *dfu_free_buf(void); |
Lukasz Majewski | 4fb1278 | 2013-12-09 16:20:13 +0100 | [diff] [blame] | 171 | unsigned long dfu_get_buf_size(void); |
Lukasz Majewski | 1cc03c5 | 2014-08-25 11:07:28 +0200 | [diff] [blame] | 172 | bool dfu_usb_get_reset(void); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 173 | |
| 174 | int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
| 175 | int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
Heiko Schocher | a2199af | 2014-03-18 08:09:55 +0100 | [diff] [blame] | 176 | 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] | 177 | |
Lukasz Majewski | fc18f8d | 2016-01-28 16:14:49 +0100 | [diff] [blame] | 178 | /* |
| 179 | * dfu_defer_flush - pointer to store dfu_entity for deferred flashing. |
| 180 | * It should be NULL when not used. |
| 181 | */ |
| 182 | extern struct dfu_entity *dfu_defer_flush; |
| 183 | /** |
| 184 | * dfu_get_defer_flush - get current value of dfu_defer_flush pointer |
| 185 | * |
| 186 | * @return - value of the dfu_defer_flush pointer |
| 187 | */ |
| 188 | static inline struct dfu_entity *dfu_get_defer_flush(void) |
| 189 | { |
| 190 | return dfu_defer_flush; |
| 191 | } |
| 192 | |
| 193 | /** |
| 194 | * dfu_set_defer_flush - set the dfu_defer_flush pointer |
| 195 | * |
| 196 | * @param dfu - pointer to the dfu_entity, which should be written |
| 197 | */ |
| 198 | static inline void dfu_set_defer_flush(struct dfu_entity *dfu) |
| 199 | { |
| 200 | dfu_defer_flush = dfu; |
| 201 | } |
| 202 | |
Lukasz Majewski | 2092e46 | 2015-08-24 00:21:46 +0200 | [diff] [blame] | 203 | /** |
| 204 | * dfu_write_from_mem_addr - write data from memory to DFU managed medium |
| 205 | * |
| 206 | * This function adds support for writing data starting from fixed memory |
| 207 | * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system) |
| 208 | * |
| 209 | * @param dfu - dfu entity to which we want to store data |
| 210 | * @param buf - fixed memory addres from where data starts |
| 211 | * @param size - number of bytes to write |
| 212 | * |
| 213 | * @return - 0 on success, other value on failure |
| 214 | */ |
| 215 | int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size); |
| 216 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 217 | /* Device specific */ |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 218 | #if CONFIG_IS_ENABLED(DFU_MMC) |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 219 | extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 220 | #else |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 221 | static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, |
| 222 | char *s) |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 223 | { |
| 224 | puts("MMC support not available!\n"); |
| 225 | return -1; |
| 226 | } |
| 227 | #endif |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 228 | |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 229 | #if CONFIG_IS_ENABLED(DFU_NAND) |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 230 | extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s); |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 231 | #else |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 232 | static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, |
| 233 | char *s) |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 234 | { |
| 235 | puts("NAND support not available!\n"); |
| 236 | return -1; |
| 237 | } |
| 238 | #endif |
| 239 | |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 240 | #if CONFIG_IS_ENABLED(DFU_RAM) |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 241 | extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s); |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 242 | #else |
Stephen Warren | dd64827 | 2014-06-11 16:03:33 -0600 | [diff] [blame] | 243 | static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, |
| 244 | char *s) |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 245 | { |
| 246 | puts("RAM support not available!\n"); |
| 247 | return -1; |
| 248 | } |
| 249 | #endif |
| 250 | |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 251 | #if CONFIG_IS_ENABLED(DFU_SF) |
Stephen Warren | 6f12ebf | 2014-06-11 16:03:36 -0600 | [diff] [blame] | 252 | extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s); |
| 253 | #else |
| 254 | static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, |
| 255 | char *s) |
| 256 | { |
| 257 | puts("SF support not available!\n"); |
| 258 | return -1; |
| 259 | } |
| 260 | #endif |
| 261 | |
Patrick Delaunay | 6015af2 | 2019-10-14 09:28:04 +0200 | [diff] [blame^] | 262 | #if CONFIG_IS_ENABLED(DFU_MTD) |
| 263 | int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s); |
| 264 | #else |
| 265 | static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, |
| 266 | char *s) |
| 267 | { |
| 268 | puts("MTD support not available!\n"); |
| 269 | return -1; |
| 270 | } |
| 271 | #endif |
| 272 | |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 273 | /** |
| 274 | * dfu_tftp_write - Write TFTP data to DFU medium |
| 275 | * |
| 276 | * This function is storing data received via TFTP on DFU supported medium. |
| 277 | * |
| 278 | * @param dfu_entity_name - name of DFU entity to write |
| 279 | * @param addr - address of data buffer to write |
| 280 | * @param len - number of bytes |
| 281 | * @param interface - destination DFU medium (e.g. "mmc") |
| 282 | * @param devstring - instance number of destination DFU medium (e.g. "1") |
| 283 | * |
| 284 | * @return 0 on success, otherwise error code |
| 285 | */ |
Andrew F. Davis | 2d59ec8 | 2019-01-17 13:43:03 -0600 | [diff] [blame] | 286 | #if CONFIG_IS_ENABLED(DFU_TFTP) |
Lukasz Majewski | 2d50d68 | 2015-08-24 00:21:45 +0200 | [diff] [blame] | 287 | int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len, |
| 288 | char *interface, char *devstring); |
| 289 | #else |
| 290 | static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, |
| 291 | unsigned int len, char *interface, |
| 292 | char *devstring) |
| 293 | { |
| 294 | puts("TFTP write support for DFU not available!\n"); |
| 295 | return -ENOSYS; |
| 296 | } |
| 297 | #endif |
| 298 | |
Lukasz Majewski | a6921ad | 2013-09-17 15:58:23 +0200 | [diff] [blame] | 299 | int dfu_add(struct usb_configuration *c); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 300 | #endif /* __DFU_ENTITY_H_ */ |