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 <[email protected]>
   7  *          Lukasz Majewski <[email protected]>
   8  */
   9
  10 #ifndef __DFU_ENTITY_H_
  11 #define __DFU_ENTITY_H_
  12
  13 #include <linux/list.h>
  14 #include <mmc.h>
  15 #include <spi_flash.h>
  16 #include <linux/usb/composite.h>
  17
  18 enum dfu_device_type {
  19         DFU_DEV_MMC = 1,
  20         DFU_DEV_ONENAND,
  21         DFU_DEV_NAND,
  22         DFU_DEV_RAM,
  23         DFU_DEV_SF,
  24         DFU_DEV_MTD,
  25         DFU_DEV_VIRT,
  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,
  34         DFU_RAM_ADDR,
  35         DFU_SKIP,
  36         DFU_SCRIPT,
  37 };
  38
  39 enum dfu_op {
  40         DFU_OP_READ = 1,
  41         DFU_OP_WRITE,
  42         DFU_OP_SIZE,
  43 };
  44
  45 struct mmc_internal_data {
  46         int dev_num;
  47
  48         /* RAW programming */
  49         unsigned int lba_start;
  50         unsigned int lba_size;
  51         unsigned int lba_blk_size;
  52
  53         /* eMMC HW partition access */
  54         int hw_partition;
  55
  56         /* FAT/EXT */
  57         unsigned int dev;
  58         unsigned int part;
  59 };
  60
  61 struct mtd_internal_data {
  62         struct mtd_info *info;
  63
  64         /* RAW programming */
  65         u64 start;
  66         u64 size;
  67         /* for ubi partition */
  68         unsigned int ubi;
  69 };
  70
  71 struct nand_internal_data {
  72         /* RAW programming */
  73         u64 start;
  74         u64 size;
  75
  76         unsigned int dev;
  77         unsigned int part;
  78         /* for nand/ubi use */
  79         unsigned int ubi;
  80 };
  81
  82 struct ram_internal_data {
  83         unsigned long   start;
  84         unsigned int    size;
  85 };
  86
  87 struct sf_internal_data {
  88         struct spi_flash *dev;
  89
  90         /* RAW programming */
  91         u64 start;
  92         u64 size;
  93         /* for sf/ubi use */
  94         unsigned int ubi;
  95 };
  96
  97 struct virt_internal_data {
  98         int dev_num;
  99 };
 100
 101
 102 #if defined(CONFIG_DFU_NAME_MAX_SIZE)
 103 #define DFU_NAME_SIZE                   CONFIG_DFU_NAME_MAX_SIZE
 104 #else
 105 #define DFU_NAME_SIZE                   32
 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 struct list_head;
 162 extern struct list_head dfu_list;
 163
 164 #ifdef CONFIG_SET_DFU_ALT_INFO
 165 /**
 166  * set_dfu_alt_info() - set dfu_alt_info environment variable
 167  *
 168  * If CONFIG_SET_DFU_ALT_INFO=y, this board specific function is called to set
 169  * environment variable dfu_alt_info.
 170  *
 171  * @interface:  dfu interface, e.g. "mmc" or "nand"
 172  * @devstr:     device number as string
 173  */
 174 void set_dfu_alt_info(char *interface, char *devstr);
 175 #endif
 176
 177 /**
 178  * dfu_alt_init() - initialize buffer for dfu entities
 179  *
 180  * @num:        number of entities
 181  * @dfu:        on return allocated buffer
 182  * Return:      0 on success
 183  */
 184 int dfu_alt_init(int num, struct dfu_entity **dfu);
 185
 186 /**
 187  * dfu_alt_add() - add alternate to dfu entity buffer
 188  *
 189  * @dfu:        dfu entity
 190  * @interface:  dfu interface, e.g. "mmc" or "nand"
 191  * @devstr:     device number as string
 192  * @s:          string description of alternate
 193  * Return:      0 on success
 194  */
 195 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
 196
 197 /**
 198  * dfu_config_entities() - initialize dfu entitities from envirionment
 199  *
 200  * Initialize the list of dfu entities from environment variable dfu_alt_info.
 201  * The list must be freed by calling dfu_free_entities(). This function bypasses
 202  * set_dfu_alt_info(). So typically you should use dfu_init_env_entities()
 203  * instead.
 204  *
 205  * See function :c:func:`dfu_free_entities`
 206  * See function :c:func:`dfu_init_env_entities`
 207  *
 208  * @s:          string with alternates
 209  * @interface:  interface, e.g. "mmc" or "nand"
 210  * @devstr:     device number as string
 211  * Return:      0 on success, a negative error code otherwise
 212  */
 213 int dfu_config_entities(char *s, char *interface, char *devstr);
 214
 215 /**
 216  * dfu_free_entities() - free the list of dfu entities
 217  *
 218  * Free the internal list of dfu entities.
 219  *
 220  * See function :c:func:`dfu_init_env_entities`
 221  */
 222 void dfu_free_entities(void);
 223
 224 /**
 225  * dfu_show_entities() - print DFU alt settings list
 226  */
 227 void dfu_show_entities(void);
 228
 229 /**
 230  * dfu_get_alt_number() - get number of alternates
 231  *
 232  * Return: number of alternates in the dfu entities list
 233  */
 234 int dfu_get_alt_number(void);
 235
 236 /**
 237  * dfu_get_dev_type() - get string representation for dfu device type
 238  *
 239  * @type:       device type
 240  * Return:      string representation for device type
 241  */
 242 const char *dfu_get_dev_type(enum dfu_device_type type);
 243
 244 /**
 245  * dfu_get_layout() - get string describing layout
 246  *
 247  * Internally layouts are represented by enum dfu_device_type values. This
 248  * function translates an enum value to a human readable string, e.g. DFU_FS_FAT
 249  * is translated to "FAT".
 250  *
 251  * @layout:     layout
 252  * Result:      string representation for the layout
 253  */
 254 const char *dfu_get_layout(enum dfu_layout layout);
 255
 256 /**
 257  * dfu_get_entity() - get dfu entity for an alternate id
 258  *
 259  * @alt:        alternate id
 260  * Return:      dfu entity
 261  */
 262 struct dfu_entity *dfu_get_entity(int alt);
 263
 264 char *dfu_extract_token(char** e, int *n);
 265
 266 /**
 267  * dfu_get_alt() - get alternate id for filename
 268  *
 269  * Environment variable dfu_alt_info defines the write destinations (alternates)
 270  * for different filenames. This function get the index of the alternate for
 271  * a filename. If an absolute filename is provided (starting with '/'), the
 272  * directory path is ignored.
 273  *
 274  * @name:       filename
 275  * Return:      id of the alternate or negative error number (-ENODEV)
 276  */
 277 int dfu_get_alt(char *name);
 278
 279 /**
 280  * dfu_init_env_entities() - initialize dfu entitities from envirionment
 281  *
 282  * Initialize the list of dfu entities from environment variable dfu_alt_info.
 283  * The list must be freed by calling dfu_free_entities().
 284  * @interface and @devstr are used to select the relevant set of alternates
 285  * from environment variable dfu_alt_info.
 286  *
 287  * If environment variable dfu_alt_info specifies the interface and the device,
 288  * use NULL for @interface and @devstr.
 289  *
 290  * See function :c:func:`dfu_free_entities`
 291  *
 292  * @interface:  interface, e.g. "mmc" or "nand"
 293  * @devstr:     device number as string
 294  * Return:      0 on success, a negative error code otherwise
 295  */
 296 int dfu_init_env_entities(char *interface, char *devstr);
 297
 298 unsigned char *dfu_get_buf(struct dfu_entity *dfu);
 299 unsigned char *dfu_free_buf(void);
 300 unsigned long dfu_get_buf_size(void);
 301 bool dfu_usb_get_reset(void);
 302
 303 #ifdef CONFIG_DFU_TIMEOUT
 304 unsigned long dfu_get_timeout(void);
 305 void dfu_set_timeout(unsigned long);
 306 #endif
 307
 308 /**
 309  * dfu_read() - read from dfu entity
 310  *
 311  * The block sequence number @blk_seq_num is a 16 bit counter that must be
 312  * incremented with each call for the same dfu entity @de.
 313  *
 314  * @de:                 dfu entity
 315  * @buf:                buffer
 316  * @size:               size of buffer
 317  * @blk_seq_num:        block sequence number
 318  * Return:              0 for success, -1 for error
 319  */
 320 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 321
 322 /**
 323  * dfu_write() - write to dfu entity
 324  *
 325  * Write the contents of a buffer @buf to the dfu entity @de. After writing
 326  * the last block call dfu_flush(). If a file is already loaded completely
 327  * into memory it is preferable to use dfu_write_from_mem_addr() which takes
 328  * care of blockwise transfer and flushing.
 329  *
 330  * The block sequence number @blk_seq_num is a 16 bit counter that must be
 331  * incremented with each call for the same dfu entity @de.
 332  *
 333  * See function :c:func:`dfu_flush`
 334  * See function :c:func:`dfu_write_from_mem_addr`
 335  *
 336  * @de:                 dfu entity
 337  * @buf:                buffer
 338  * @size:               size of buffer
 339  * @blk_seq_num:        block sequence number
 340  * Return:              0 for success, -1 for error
 341  */
 342 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 343
 344 /**
 345  * dfu_flush() - flush to dfu entity
 346  *
 347  * This function has to be called after writing the last block to the dfu
 348  * entity @de.
 349  *
 350  * The block sequence number @blk_seq_num is a 16 bit counter that must be
 351  * incremented with each call for the same dfu entity @de.
 352  *
 353  * See function :c:func:`dfu_write`
 354  *
 355  * @de:                 dfu entity
 356  * @buf:                ignored
 357  * @size:               ignored
 358  * @blk_seq_num:        block sequence number of last write - ignored
 359  * Return:              0 for success, -1 for error
 360  */
 361 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 362
 363 /**
 364  * dfu_initiated_callback() - weak callback called on DFU transaction start
 365  *
 366  * It is a callback function called by DFU stack when a DFU transaction is
 367  * initiated. This function allows to manage some board specific behavior on
 368  * DFU targets.
 369  *
 370  * @dfu:        pointer to the dfu_entity, which should be initialized
 371  */
 372 void dfu_initiated_callback(struct dfu_entity *dfu);
 373
 374 /**
 375  * dfu_flush_callback() - weak callback called at the end of the DFU write
 376  *
 377  * It is a callback function called by DFU stack after DFU manifestation.
 378  * This function allows to manage some board specific behavior on DFU targets
 379  *
 380  * @dfu:        pointer to the dfu_entity, which should be flushed
 381  */
 382 void dfu_flush_callback(struct dfu_entity *dfu);
 383
 384 /**
 385  * dfu_error_callback() - weak callback called at the DFU write error
 386  *
 387  * It is a callback function called by DFU stack after DFU write error.
 388  * This function allows to manage some board specific behavior on DFU targets
 389  *
 390  * @dfu:        pointer to the dfu_entity which cause the error
 391  * @msg:        the message of the error
 392  */
 393 void dfu_error_callback(struct dfu_entity *dfu, const char *msg);
 394
 395 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
 396 void dfu_transaction_cleanup(struct dfu_entity *dfu);
 397
 398 /*
 399  * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
 400  *                   It should be NULL when not used.
 401  */
 402 extern struct dfu_entity *dfu_defer_flush;
 403
 404 /**
 405  * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer
 406  *
 407  * Return:      value of the dfu_defer_flush pointer
 408  */
 409 static inline struct dfu_entity *dfu_get_defer_flush(void)
 410 {
 411         return dfu_defer_flush;
 412 }
 413
 414 /**
 415  * dfu_set_defer_flush() - set the dfu_defer_flush pointer
 416  *
 417  * @dfu:        pointer to the dfu_entity, which should be written
 418  */
 419 static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
 420 {
 421         dfu_defer_flush = dfu;
 422 }
 423
 424 /**
 425  * dfu_write_from_mem_addr() - write data from memory to DFU managed medium
 426  *
 427  * This function adds support for writing data starting from fixed memory
 428  * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
 429  *
 430  * @dfu:        dfu entity to which we want to store data
 431  * @buf:        fixed memory address from where data starts
 432  * @size:       number of bytes to write
 433  *
 434  * Return:      0 on success, other value on failure
 435  */
 436 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
 437
 438 /* Device specific */
 439 /* Each entity has 5 arguments in maximum. */
 440 #define DFU_MAX_ENTITY_ARGS     5
 441
 442 #if CONFIG_IS_ENABLED(DFU_MMC)
 443 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
 444                                char **argv, int argc);
 445 #else
 446 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
 447                                       char **argv, int argc)
 448 {
 449         puts("MMC support not available!\n");
 450         return -1;
 451 }
 452 #endif
 453
 454 #if CONFIG_IS_ENABLED(DFU_NAND)
 455 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
 456                                 char **argv, int argc);
 457 #else
 458 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
 459                                        char **argv, int argc)
 460 {
 461         puts("NAND support not available!\n");
 462         return -1;
 463 }
 464 #endif
 465
 466 #if CONFIG_IS_ENABLED(DFU_RAM)
 467 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
 468                                char **argv, int argc);
 469 #else
 470 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
 471                                       char **argv, int argc)
 472 {
 473         puts("RAM support not available!\n");
 474         return -1;
 475 }
 476 #endif
 477
 478 #if CONFIG_IS_ENABLED(DFU_SF)
 479 extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
 480                               char **argv, int argc);
 481 #else
 482 static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
 483                                      char **argv, int argc)
 484 {
 485         puts("SF support not available!\n");
 486         return -1;
 487 }
 488 #endif
 489
 490 #if CONFIG_IS_ENABLED(DFU_MTD)
 491 extern int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
 492                                char **argv, int argc);
 493 #else
 494 static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
 495                                       char **argv, int argc)
 496 {
 497         puts("MTD support not available!\n");
 498         return -1;
 499 }
 500 #endif
 501
 502 #if CONFIG_IS_ENABLED(DFU_VIRT)
 503 int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
 504                          char **argv, int argc);
 505 int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
 506                           void *buf, long *len);
 507 int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
 508 int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
 509                          void *buf, long *len);
 510 #else
 511 static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
 512                                        char **argv, int argc)
 513 {
 514         puts("VIRT support not available!\n");
 515         return -1;
 516 }
 517 #endif
 518
 519 extern bool dfu_reinit_needed;
 520
 521 #if CONFIG_IS_ENABLED(DFU_WRITE_ALT)
 522 /**
 523  * dfu_write_by_name() - write data to DFU medium
 524  * @dfu_entity_name:    Name of DFU entity to write
 525  * @addr:               Address of data buffer to write
 526  * @len:                Number of bytes
 527  * @interface:          Destination DFU medium (e.g. "mmc")
 528  * @devstring:          Instance number of destination DFU medium (e.g. "1")
 529  *
 530  * This function is storing data received on DFU supported medium which
 531  * is specified by @dfu_entity_name.
 532  *
 533  * Return:              0 - on success, error code - otherwise
 534  */
 535 int dfu_write_by_name(char *dfu_entity_name, void *addr,
 536                       unsigned int len, char *interface, char *devstring);
 537
 538 /**
 539  * dfu_write_by_alt() - write data to DFU medium
 540  * @dfu_alt_num:        DFU alt setting number
 541  * @addr:               Address of data buffer to write
 542  * @len:                Number of bytes
 543  * @interface:          Destination DFU medium (e.g. "mmc")
 544  * @devstring:          Instance number of destination DFU medium (e.g. "1")
 545  *
 546  * This function is storing data received on DFU supported medium which
 547  * is specified by @dfu_alt_name.
 548  *
 549  * Return:              0 - on success, error code - otherwise
 550  */
 551 int dfu_write_by_alt(int dfu_alt_num, void *addr, unsigned int len,
 552                      char *interface, char *devstring);
 553 #else
 554 static inline int dfu_write_by_name(char *dfu_entity_name, void *addr,
 555                                     unsigned int len, char *interface,
 556                                     char *devstring)
 557 {
 558         puts("write support for DFU not available!\n");
 559         return -ENOSYS;
 560 }
 561
 562 static inline int dfu_write_by_alt(int dfu_alt_num, void *addr,
 563                                    unsigned int len, char *interface,
 564                                    char *devstring)
 565 {
 566         puts("write support for DFU not available!\n");
 567         return -ENOSYS;
 568 }
 569 #endif
 570
 571 int dfu_add(struct usb_configuration *c);
 572 #endif /* __DFU_ENTITY_H_ */