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         DFU_SKIP,
  37         DFU_SCRIPT,
  38 };
  39
  40 enum dfu_op {
  41         DFU_OP_READ = 1,
  42         DFU_OP_WRITE,
  43         DFU_OP_SIZE,
  44 };
  45
  46 struct mmc_internal_data {
  47         int dev_num;
  48
  49         /* RAW programming */
  50         unsigned int lba_start;
  51         unsigned int lba_size;
  52         unsigned int lba_blk_size;
  53
  54         /* eMMC HW partition access */
  55         int hw_partition;
  56
  57         /* FAT/EXT */
  58         unsigned int dev;
  59         unsigned int part;
  60 };
  61
  62 struct mtd_internal_data {
  63         struct mtd_info *info;
  64
  65         /* RAW programming */
  66         u64 start;
  67         u64 size;
  68         /* for ubi partition */
  69         unsigned int ubi;
  70 };
  71
  72 struct nand_internal_data {
  73         /* RAW programming */
  74         u64 start;
  75         u64 size;
  76
  77         unsigned int dev;
  78         unsigned int part;
  79         /* for nand/ubi use */
  80         unsigned int ubi;
  81 };
  82
  83 struct ram_internal_data {
  84         unsigned long   start;
  85         unsigned int    size;
  86 };
  87
  88 struct sf_internal_data {
  89         struct spi_flash *dev;
  90
  91         /* RAW programming */
  92         u64 start;
  93         u64 size;
  94         /* for sf/ubi use */
  95         unsigned int ubi;
  96 };
  97
  98 struct virt_internal_data {
  99         int dev_num;
 100 };
 101
 102 #define DFU_NAME_SIZE                   32
 103 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
 104 #define CONFIG_SYS_DFU_DATA_BUF_SIZE            (1024*1024*8)   /* 8 MiB */
 105 #endif
 106 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
 107 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
 108 #endif
 109 #ifndef DFU_DEFAULT_POLL_TIMEOUT
 110 #define DFU_DEFAULT_POLL_TIMEOUT 0
 111 #endif
 112 #ifndef DFU_MANIFEST_POLL_TIMEOUT
 113 #define DFU_MANIFEST_POLL_TIMEOUT       DFU_DEFAULT_POLL_TIMEOUT
 114 #endif
 115
 116 struct dfu_entity {
 117         char                    name[DFU_NAME_SIZE];
 118         int                     alt;
 119         void                    *dev_private;
 120         enum dfu_device_type    dev_type;
 121         enum dfu_layout         layout;
 122         unsigned long           max_buf_size;
 123
 124         union {
 125                 struct mmc_internal_data mmc;
 126                 struct mtd_internal_data mtd;
 127                 struct nand_internal_data nand;
 128                 struct ram_internal_data ram;
 129                 struct sf_internal_data sf;
 130                 struct virt_internal_data virt;
 131         } data;
 132
 133         int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
 134
 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);
 142         unsigned int (*poll_timeout)(struct dfu_entity *dfu);
 143
 144         void (*free_entity)(struct dfu_entity *dfu);
 145
 146         struct list_head list;
 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;
 155         u64 r_left;
 156         long b_left;
 157
 158         u32 bad_skip;   /* for nand use */
 159
 160         unsigned int inited:1;
 161 };
 162
 163 struct list_head;
 164 extern struct list_head dfu_list;
 165
 166 #ifdef CONFIG_SET_DFU_ALT_INFO
 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  */
 176 void set_dfu_alt_info(char *interface, char *devstr);
 177 #endif
 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  */
 186 int dfu_alt_init(int num, struct dfu_entity **dfu);
 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  */
 197 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
 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  */
 215 int dfu_config_entities(char *s, char *interface, char *devstr);
 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  */
 224 void dfu_free_entities(void);
 225
 226 /**
 227  * dfu_show_entities() - print DFU alt settings list
 228  */
 229 void dfu_show_entities(void);
 230
 231 /**
 232  * dfu_get_alt_number() - get number of alternates
 233  *
 234  * Return: number of alternates in the dfu entities list
 235  */
 236 int dfu_get_alt_number(void);
 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  */
 264 struct dfu_entity *dfu_get_entity(int alt);
 265
 266 char *dfu_extract_token(char** e, int *n);
 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  */
 279 int dfu_get_alt(char *name);
 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  */
 298 int dfu_init_env_entities(char *interface, char *devstr);
 299
 300 unsigned char *dfu_get_buf(struct dfu_entity *dfu);
 301 unsigned char *dfu_free_buf(void);
 302 unsigned long dfu_get_buf_size(void);
 303 bool dfu_usb_get_reset(void);
 304
 305 #ifdef CONFIG_DFU_TIMEOUT
 306 unsigned long dfu_get_timeout(void);
 307 void dfu_set_timeout(unsigned long);
 308 #endif
 309
 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  */
 322 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 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  */
 344 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 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  */
 363 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 364
 365 /**
 366  * dfu_initiated_callback() - weak callback called on DFU transaction start
 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  *
 372  * @dfu:        pointer to the dfu_entity, which should be initialized
 373  */
 374 void dfu_initiated_callback(struct dfu_entity *dfu);
 375
 376 /**
 377  * dfu_flush_callback() - weak callback called at the end of the DFU write
 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  *
 382  * @dfu:        pointer to the dfu_entity, which should be flushed
 383  */
 384 void dfu_flush_callback(struct dfu_entity *dfu);
 385
 386 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
 387 void dfu_transaction_cleanup(struct dfu_entity *dfu);
 388
 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;
 394
 395 /**
 396  * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer
 397  *
 398  * Return:      value of the dfu_defer_flush pointer
 399  */
 400 static inline struct dfu_entity *dfu_get_defer_flush(void)
 401 {
 402         return dfu_defer_flush;
 403 }
 404
 405 /**
 406  * dfu_set_defer_flush() - set the dfu_defer_flush pointer
 407  *
 408  * @dfu:        pointer to the dfu_entity, which should be written
 409  */
 410 static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
 411 {
 412         dfu_defer_flush = dfu;
 413 }
 414
 415 /**
 416  * dfu_write_from_mem_addr() - write data from memory to DFU managed medium
 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  *
 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
 424  *
 425  * Return:      0 on success, other value on failure
 426  */
 427 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
 428
 429 /* Device specific */
 430 #if CONFIG_IS_ENABLED(DFU_MMC)
 431 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
 432 #else
 433 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
 434                                       char *s)
 435 {
 436         puts("MMC support not available!\n");
 437         return -1;
 438 }
 439 #endif
 440
 441 #if CONFIG_IS_ENABLED(DFU_NAND)
 442 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
 443 #else
 444 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
 445                                        char *s)
 446 {
 447         puts("NAND support not available!\n");
 448         return -1;
 449 }
 450 #endif
 451
 452 #if CONFIG_IS_ENABLED(DFU_RAM)
 453 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
 454 #else
 455 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
 456                                       char *s)
 457 {
 458         puts("RAM support not available!\n");
 459         return -1;
 460 }
 461 #endif
 462
 463 #if CONFIG_IS_ENABLED(DFU_SF)
 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
 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
 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
 501 extern bool dfu_reinit_needed;
 502
 503 #if CONFIG_IS_ENABLED(DFU_WRITE_ALT)
 504 /**
 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")
 511  *
 512  * This function is storing data received on DFU supported medium which
 513  * is specified by @dfu_entity_name.
 514  *
 515  * Return:              0 - on success, error code - otherwise
 516  */
 517 int dfu_write_by_name(char *dfu_entity_name, void *addr,
 518                       unsigned int len, char *interface, char *devstring);
 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);
 535 #else
 536 static inline int dfu_write_by_name(char *dfu_entity_name, void *addr,
 537                                     unsigned int len, char *interface,
 538                                     char *devstring)
 539 {
 540         puts("write support for DFU not available!\n");
 541         return -ENOSYS;
 542 }
 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 }
 551 #endif
 552
 553 int dfu_add(struct usb_configuration *c);
 554 #endif /* __DFU_ENTITY_H_ */