include/dfu.h

   1 /*
   2  * dfu.h - DFU flashable area description
   3  *
   4  * Copyright (C) 2012 Samsung Electronics
   5  * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
   6  *          Lukasz Majewski <l.majewski@samsung.com>
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #ifndef __DFU_ENTITY_H_
  12 #define __DFU_ENTITY_H_
  13
  14 #include <common.h>
  15 #include <linux/list.h>
  16 #include <mmc.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 };
  25
  26 enum dfu_layout {
  27         DFU_RAW_ADDR = 1,
  28         DFU_FS_FAT,
  29         DFU_FS_EXT2,
  30         DFU_FS_EXT3,
  31         DFU_FS_EXT4,
  32         DFU_RAM_ADDR,
  33 };
  34
  35 enum dfu_op {
  36         DFU_OP_READ = 1,
  37         DFU_OP_WRITE,
  38 };
  39
  40 struct mmc_internal_data {
  41         /* RAW programming */
  42         unsigned int lba_start;
  43         unsigned int lba_size;
  44         unsigned int lba_blk_size;
  45
  46         /* FAT/EXT */
  47         unsigned int dev;
  48         unsigned int part;
  49 };
  50
  51 struct nand_internal_data {
  52         /* RAW programming */
  53         u64 start;
  54         u64 size;
  55
  56         unsigned int dev;
  57         unsigned int part;
  58         /* for nand/ubi use */
  59         unsigned int ubi;
  60 };
  61
  62 struct ram_internal_data {
  63         void            *start;
  64         unsigned int    size;
  65 };
  66
  67 #define DFU_NAME_SIZE                   32
  68 #define DFU_CMD_BUF_SIZE                128
  69 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
  70 #define CONFIG_SYS_DFU_DATA_BUF_SIZE            (1024*1024*8)   /* 8 MiB */
  71 #endif
  72 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
  73 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
  74 #endif
  75 #ifndef DFU_DEFAULT_POLL_TIMEOUT
  76 #define DFU_DEFAULT_POLL_TIMEOUT 0
  77 #endif
  78 #ifndef DFU_MANIFEST_POLL_TIMEOUT
  79 #define DFU_MANIFEST_POLL_TIMEOUT       DFU_DEFAULT_POLL_TIMEOUT
  80 #endif
  81
  82 struct dfu_entity {
  83         char                    name[DFU_NAME_SIZE];
  84         int                     alt;
  85         void                    *dev_private;
  86         int                     dev_num;
  87         enum dfu_device_type    dev_type;
  88         enum dfu_layout         layout;
  89
  90         union {
  91                 struct mmc_internal_data mmc;
  92                 struct nand_internal_data nand;
  93                 struct ram_internal_data ram;
  94         } data;
  95
  96         int (*read_medium)(struct dfu_entity *dfu,
  97                         u64 offset, void *buf, long *len);
  98
  99         int (*write_medium)(struct dfu_entity *dfu,
 100                         u64 offset, void *buf, long *len);
 101
 102         int (*flush_medium)(struct dfu_entity *dfu);
 103         unsigned int (*poll_timeout)(struct dfu_entity *dfu);
 104
 105         struct list_head list;
 106
 107         /* on the fly state */
 108         u32 crc;
 109         u64 offset;
 110         int i_blk_seq_num;
 111         u8 *i_buf;
 112         u8 *i_buf_start;
 113         u8 *i_buf_end;
 114         long r_left;
 115         long b_left;
 116
 117         u32 bad_skip;   /* for nand use */
 118
 119         unsigned int inited:1;
 120 };
 121
 122 int dfu_config_entities(char *s, char *interface, int num);
 123 void dfu_free_entities(void);
 124 void dfu_show_entities(void);
 125 int dfu_get_alt_number(void);
 126 const char *dfu_get_dev_type(enum dfu_device_type t);
 127 const char *dfu_get_layout(enum dfu_layout l);
 128 struct dfu_entity *dfu_get_entity(int alt);
 129 char *dfu_extract_token(char** e, int *n);
 130 void dfu_trigger_reset(void);
 131 int dfu_get_alt(char *name);
 132 bool dfu_reset(void);
 133 int dfu_init_env_entities(char *interface, int dev);
 134 unsigned char *dfu_get_buf(void);
 135 unsigned char *dfu_free_buf(void);
 136 unsigned long dfu_get_buf_size(void);
 137
 138 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 139 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 140 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 141 /* Device specific */
 142 #ifdef CONFIG_DFU_MMC
 143 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s);
 144 #else
 145 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s)
 146 {
 147         puts("MMC support not available!\n");
 148         return -1;
 149 }
 150 #endif
 151
 152 #ifdef CONFIG_DFU_NAND
 153 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s);
 154 #else
 155 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s)
 156 {
 157         puts("NAND support not available!\n");
 158         return -1;
 159 }
 160 #endif
 161
 162 #ifdef CONFIG_DFU_RAM
 163 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s);
 164 #else
 165 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s)
 166 {
 167         puts("RAM support not available!\n");
 168         return -1;
 169 }
 170 #endif
 171
 172 int dfu_add(struct usb_configuration *c);
 173 #endif /* __DFU_ENTITY_H_ */