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