include/dfu.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   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>
   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>
  16 #include <spi_flash.h>
  17 #include <linux/usb/composite.h>
  18
  19 enum dfu_device_type {
  20         DFU_DEV_MMC = 1,
  21         DFU_DEV_ONENAND,
  22         DFU_DEV_NAND,
  23         DFU_DEV_RAM,
  24         DFU_DEV_SF,
  25         DFU_DEV_MTD,
  26         DFU_DEV_VIRT,
  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,
  35         DFU_RAM_ADDR,
  36 };
  37
  38 enum dfu_op {
  39         DFU_OP_READ = 1,
  40         DFU_OP_WRITE,
  41         DFU_OP_SIZE,
  42 };
  43
  44 struct mmc_internal_data {
  45         int dev_num;
  46
  47         /* RAW programming */
  48         unsigned int lba_start;
  49         unsigned int lba_size;
  50         unsigned int lba_blk_size;
  51
  52         /* eMMC HW partition access */
  53         int hw_partition;
  54
  55         /* FAT/EXT */
  56         unsigned int dev;
  57         unsigned int part;
  58 };
  59
  60 struct mtd_internal_data {
  61         struct mtd_info *info;
  62
  63         /* RAW programming */
  64         u64 start;
  65         u64 size;
  66         /* for ubi partition */
  67         unsigned int ubi;
  68 };
  69
  70 struct nand_internal_data {
  71         /* RAW programming */
  72         u64 start;
  73         u64 size;
  74
  75         unsigned int dev;
  76         unsigned int part;
  77         /* for nand/ubi use */
  78         unsigned int ubi;
  79 };
  80
  81 struct ram_internal_data {
  82         void            *start;
  83         unsigned int    size;
  84 };
  85
  86 struct sf_internal_data {
  87         struct spi_flash *dev;
  88
  89         /* RAW programming */
  90         u64 start;
  91         u64 size;
  92         /* for sf/ubi use */
  93         unsigned int ubi;
  94 };
  95
  96 struct virt_internal_data {
  97         int dev_num;
  98 };
  99
 100 #define DFU_NAME_SIZE                   32
 101 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
 102 #define CONFIG_SYS_DFU_DATA_BUF_SIZE            (1024*1024*8)   /* 8 MiB */
 103 #endif
 104 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
 105 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
 106 #endif
 107 #ifndef DFU_DEFAULT_POLL_TIMEOUT
 108 #define DFU_DEFAULT_POLL_TIMEOUT 0
 109 #endif
 110 #ifndef DFU_MANIFEST_POLL_TIMEOUT
 111 #define DFU_MANIFEST_POLL_TIMEOUT       DFU_DEFAULT_POLL_TIMEOUT
 112 #endif
 113
 114 struct dfu_entity {
 115         char                    name[DFU_NAME_SIZE];
 116         int                     alt;
 117         void                    *dev_private;
 118         enum dfu_device_type    dev_type;
 119         enum dfu_layout         layout;
 120         unsigned long           max_buf_size;
 121
 122         union {
 123                 struct mmc_internal_data mmc;
 124                 struct mtd_internal_data mtd;
 125                 struct nand_internal_data nand;
 126                 struct ram_internal_data ram;
 127                 struct sf_internal_data sf;
 128                 struct virt_internal_data virt;
 129         } data;
 130
 131         int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
 132
 133         int (*read_medium)(struct dfu_entity *dfu,
 134                         u64 offset, void *buf, long *len);
 135
 136         int (*write_medium)(struct dfu_entity *dfu,
 137                         u64 offset, void *buf, long *len);
 138
 139         int (*flush_medium)(struct dfu_entity *dfu);
 140         unsigned int (*poll_timeout)(struct dfu_entity *dfu);
 141
 142         void (*free_entity)(struct dfu_entity *dfu);
 143
 144         struct list_head list;
 145
 146         /* on the fly state */
 147         u32 crc;
 148         u64 offset;
 149         int i_blk_seq_num;
 150         u8 *i_buf;
 151         u8 *i_buf_start;
 152         u8 *i_buf_end;
 153         u64 r_left;
 154         long b_left;
 155
 156         u32 bad_skip;   /* for nand use */
 157
 158         unsigned int inited:1;
 159 };
 160
 161 #ifdef CONFIG_SET_DFU_ALT_INFO
 162 void set_dfu_alt_info(char *interface, char *devstr);
 163 #endif
 164 int dfu_alt_init(int num, struct dfu_entity **dfu);
 165 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
 166 int dfu_config_entities(char *s, char *interface, char *devstr);
 167 void dfu_free_entities(void);
 168 void dfu_show_entities(void);
 169 int dfu_get_alt_number(void);
 170 const char *dfu_get_dev_type(enum dfu_device_type t);
 171 const char *dfu_get_layout(enum dfu_layout l);
 172 struct dfu_entity *dfu_get_entity(int alt);
 173 char *dfu_extract_token(char** e, int *n);
 174 int dfu_get_alt(char *name);
 175 int dfu_init_env_entities(char *interface, char *devstr);
 176 unsigned char *dfu_get_buf(struct dfu_entity *dfu);
 177 unsigned char *dfu_free_buf(void);
 178 unsigned long dfu_get_buf_size(void);
 179 bool dfu_usb_get_reset(void);
 180
 181 #ifdef CONFIG_DFU_TIMEOUT
 182 unsigned long dfu_get_timeout(void);
 183 void dfu_set_timeout(unsigned long);
 184 #endif
 185
 186 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 187 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 188 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 189
 190 /**
 191  * dfu_initiated_callback() - weak callback called on DFU transaction start
 192  *
 193  * It is a callback function called by DFU stack when a DFU transaction is
 194  * initiated. This function allows to manage some board specific behavior on
 195  * DFU targets.
 196  *
 197  * @dfu:        pointer to the dfu_entity, which should be initialized
 198  *
 199  */
 200 void dfu_initiated_callback(struct dfu_entity *dfu);
 201 /**
 202  * dfu_flush_callback() - weak callback called at the end of the DFU write
 203  *
 204  * It is a callback function called by DFU stack after DFU manifestation.
 205  * This function allows to manage some board specific behavior on DFU targets
 206  *
 207  * @dfu:        pointer to the dfu_entity, which should be flushed
 208  *
 209  */
 210 void dfu_flush_callback(struct dfu_entity *dfu);
 211
 212 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
 213 void dfu_transaction_cleanup(struct dfu_entity *dfu);
 214
 215 /*
 216  * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
 217  *                   It should be NULL when not used.
 218  */
 219 extern struct dfu_entity *dfu_defer_flush;
 220 /**
 221  * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer
 222  *
 223  * Return:      value of the dfu_defer_flush pointer
 224  */
 225 static inline struct dfu_entity *dfu_get_defer_flush(void)
 226 {
 227         return dfu_defer_flush;
 228 }
 229
 230 /**
 231  * dfu_set_defer_flush() - set the dfu_defer_flush pointer
 232  *
 233  * @dfu:        pointer to the dfu_entity, which should be written
 234  */
 235 static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
 236 {
 237         dfu_defer_flush = dfu;
 238 }
 239
 240 /**
 241  * dfu_write_from_mem_addr() - write data from memory to DFU managed medium
 242  *
 243  * This function adds support for writing data starting from fixed memory
 244  * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
 245  *
 246  * @dfu:        dfu entity to which we want to store data
 247  * @buf:        fixed memory address from where data starts
 248  * @size:       number of bytes to write
 249  *
 250  * Return:      0 on success, other value on failure
 251  */
 252 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
 253
 254 /* Device specific */
 255 #if CONFIG_IS_ENABLED(DFU_MMC)
 256 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
 257 #else
 258 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
 259                                       char *s)
 260 {
 261         puts("MMC support not available!\n");
 262         return -1;
 263 }
 264 #endif
 265
 266 #if CONFIG_IS_ENABLED(DFU_NAND)
 267 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
 268 #else
 269 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
 270                                        char *s)
 271 {
 272         puts("NAND support not available!\n");
 273         return -1;
 274 }
 275 #endif
 276
 277 #if CONFIG_IS_ENABLED(DFU_RAM)
 278 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
 279 #else
 280 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
 281                                       char *s)
 282 {
 283         puts("RAM support not available!\n");
 284         return -1;
 285 }
 286 #endif
 287
 288 #if CONFIG_IS_ENABLED(DFU_SF)
 289 extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
 290 #else
 291 static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
 292                                      char *s)
 293 {
 294         puts("SF support not available!\n");
 295         return -1;
 296 }
 297 #endif
 298
 299 #if CONFIG_IS_ENABLED(DFU_MTD)
 300 int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s);
 301 #else
 302 static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
 303                                       char *s)
 304 {
 305         puts("MTD support not available!\n");
 306         return -1;
 307 }
 308 #endif
 309
 310 #ifdef CONFIG_DFU_VIRT
 311 int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, char *s);
 312 int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
 313                           void *buf, long *len);
 314 int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
 315 int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
 316                          void *buf, long *len);
 317 #else
 318 static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
 319                                        char *s)
 320 {
 321         puts("VIRT support not available!\n");
 322         return -1;
 323 }
 324 #endif
 325
 326 /**
 327  * dfu_tftp_write() - write TFTP data to DFU medium
 328  *
 329  * This function is storing data received via TFTP on DFU supported medium.
 330  *
 331  * @dfu_entity_name:    name of DFU entity to write
 332  * @addr:               address of data buffer to write
 333  * @len:                number of bytes
 334  * @interface:          destination DFU medium (e.g. "mmc")
 335  * @devstring:          instance number of destination DFU medium (e.g. "1")
 336  *
 337  * Return:              0 on success, otherwise error code
 338  */
 339 #if CONFIG_IS_ENABLED(DFU_TFTP)
 340 int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
 341                    char *interface, char *devstring);
 342 #else
 343 static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
 344                                  unsigned int len, char *interface,
 345                                  char *devstring)
 346 {
 347         puts("TFTP write support for DFU not available!\n");
 348         return -ENOSYS;
 349 }
 350 #endif
 351
 352 int dfu_add(struct usb_configuration *c);
 353 #endif /* __DFU_ENTITY_H_ */