Blame view
include/dfu.h
6.6 KB
d41ce506b Initial Release, ... |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
/* * dfu.h - DFU flashable area description * * Copyright (C) 2012 Samsung Electronics * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com> * Lukasz Majewski <l.majewski@samsung.com> * * SPDX-License-Identifier: GPL-2.0+ */ #ifndef __DFU_ENTITY_H_ #define __DFU_ENTITY_H_ #include <common.h> #include <linux/list.h> #include <mmc.h> #include <spi_flash.h> #include <linux/usb/composite.h> enum dfu_device_type { DFU_DEV_MMC = 1, DFU_DEV_ONENAND, DFU_DEV_NAND, DFU_DEV_RAM, DFU_DEV_SF, }; enum dfu_layout { DFU_RAW_ADDR = 1, DFU_FS_FAT, DFU_FS_EXT2, DFU_FS_EXT3, DFU_FS_EXT4, DFU_RAM_ADDR, }; enum dfu_op { DFU_OP_READ = 1, DFU_OP_WRITE, DFU_OP_SIZE, }; struct mmc_internal_data { int dev_num; /* RAW programming */ unsigned int lba_start; unsigned int lba_size; unsigned int lba_blk_size; /* eMMC HW partition access */ int hw_partition; /* FAT/EXT */ unsigned int dev; unsigned int part; }; struct nand_internal_data { /* RAW programming */ u64 start; u64 size; unsigned int dev; unsigned int part; /* for nand/ubi use */ unsigned int ubi; }; struct ram_internal_data { void *start; unsigned int size; }; struct sf_internal_data { struct spi_flash *dev; /* RAW programming */ u64 start; u64 size; }; #define DFU_NAME_SIZE 32 #define DFU_CMD_BUF_SIZE 128 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */ #endif #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE #endif #ifndef DFU_DEFAULT_POLL_TIMEOUT #define DFU_DEFAULT_POLL_TIMEOUT 0 #endif #ifndef DFU_MANIFEST_POLL_TIMEOUT #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT #endif struct dfu_entity { char name[DFU_NAME_SIZE]; int alt; void *dev_private; enum dfu_device_type dev_type; enum dfu_layout layout; unsigned long max_buf_size; union { struct mmc_internal_data mmc; struct nand_internal_data nand; struct ram_internal_data ram; struct sf_internal_data sf; } data; int (*get_medium_size)(struct dfu_entity *dfu, u64 *size); int (*read_medium)(struct dfu_entity *dfu, u64 offset, void *buf, long *len); int (*write_medium)(struct dfu_entity *dfu, u64 offset, void *buf, long *len); int (*flush_medium)(struct dfu_entity *dfu); unsigned int (*poll_timeout)(struct dfu_entity *dfu); void (*free_entity)(struct dfu_entity *dfu); struct list_head list; /* on the fly state */ u32 crc; u64 offset; int i_blk_seq_num; u8 *i_buf; u8 *i_buf_start; u8 *i_buf_end; u64 r_left; long b_left; u32 bad_skip; /* for nand use */ unsigned int inited:1; }; #ifdef CONFIG_SET_DFU_ALT_INFO void set_dfu_alt_info(char *interface, char *devstr); #endif int dfu_config_entities(char *s, char *interface, char *devstr); void dfu_free_entities(void); void dfu_show_entities(void); int dfu_get_alt_number(void); const char *dfu_get_dev_type(enum dfu_device_type t); const char *dfu_get_layout(enum dfu_layout l); struct dfu_entity *dfu_get_entity(int alt); char *dfu_extract_token(char** e, int *n); void dfu_trigger_reset(void); int dfu_get_alt(char *name); int dfu_init_env_entities(char *interface, char *devstr); unsigned char *dfu_get_buf(struct dfu_entity *dfu); unsigned char *dfu_free_buf(void); unsigned long dfu_get_buf_size(void); bool dfu_usb_get_reset(void); int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); /* * dfu_defer_flush - pointer to store dfu_entity for deferred flashing. * It should be NULL when not used. */ extern struct dfu_entity *dfu_defer_flush; /** * dfu_get_defer_flush - get current value of dfu_defer_flush pointer * * @return - value of the dfu_defer_flush pointer */ static inline struct dfu_entity *dfu_get_defer_flush(void) { return dfu_defer_flush; } /** * dfu_set_defer_flush - set the dfu_defer_flush pointer * * @param dfu - pointer to the dfu_entity, which should be written */ static inline void dfu_set_defer_flush(struct dfu_entity *dfu) { dfu_defer_flush = dfu; } /** * dfu_write_from_mem_addr - write data from memory to DFU managed medium * * This function adds support for writing data starting from fixed memory * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system) * * @param dfu - dfu entity to which we want to store data * @param buf - fixed memory addres from where data starts * @param size - number of bytes to write * * @return - 0 on success, other value on failure */ int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size); /* Device specific */ #ifdef CONFIG_DFU_MMC extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s); #else static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s) { puts("MMC support not available! "); return -1; } #endif #ifdef CONFIG_DFU_NAND extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s); #else static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s) { puts("NAND support not available! "); return -1; } #endif #ifdef CONFIG_DFU_RAM extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s); #else static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s) { puts("RAM support not available! "); return -1; } #endif #ifdef CONFIG_DFU_SF extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s); #else static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s) { puts("SF support not available! "); return -1; } #endif /** * dfu_tftp_write - Write TFTP data to DFU medium * * This function is storing data received via TFTP on DFU supported medium. * * @param dfu_entity_name - name of DFU entity to write * @param addr - address of data buffer to write * @param len - number of bytes * @param interface - destination DFU medium (e.g. "mmc") * @param devstring - instance number of destination DFU medium (e.g. "1") * * @return 0 on success, otherwise error code */ #ifdef CONFIG_DFU_TFTP int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len, char *interface, char *devstring); #else static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len, char *interface, char *devstring) { puts("TFTP write support for DFU not available! "); return -ENOSYS; } #endif int dfu_add(struct usb_configuration *c); #endif /* __DFU_ENTITY_H_ */ |